# ORM Client

## Setup ```typescript import { createClient } from './orm'; const db = createClient({ endpoint: 'https://api.example.com/graphql', headers: { Authorization: 'Bearer ' }, }); ``` ## Models | Model | Operations | |-------|------------| | `bucket` | findMany, findOne, create, update, delete | | `file` | findMany, findOne, update, delete | | `platformBucket` | findMany, findOne, create, update, delete | | `platformFile` | findMany, findOne, update, delete | ## Table Operations ### `db.bucket` CRUD operations for Bucket records. **Fields:** | Field | Type | Editable | |-------|------|----------| | `actorId` | UUID | Yes | | `allowCustomKeys` | Boolean | Yes | | `allowedMimeTypes` | String | Yes | | `allowedOrigins` | String | Yes | | `createdAt` | Datetime | No | | `databaseId` | UUID | Yes | | `description` | String | Yes | | `destinationBucketId` | UUID | Yes | | `id` | UUID | No | | `isPublic` | Boolean | Yes | | `key` | String | Yes | | `maxBulkFiles` | Int | No | | `maxFileSize` | BigInt | Yes | | `physicalName` | String | Yes | | `provisionRequestedAt` | Datetime | Yes | | `stagingTtl` | Interval | Yes | | `tags` | String | Yes | | `type` | BucketType | Yes | | `updatedAt` | Datetime | No | **Operations:** ```typescript // List all bucket records const items = await db.bucket.findMany({ select: { actorId: true, allowCustomKeys: true, allowedMimeTypes: true, allowedOrigins: true, createdAt: true, databaseId: true, description: true, destinationBucketId: true, id: true, isPublic: true, key: true, maxBulkFiles: true, maxFileSize: true, physicalName: true, provisionRequestedAt: true, stagingTtl: true, tags: true, type: true, updatedAt: true } }).execute(); // Get one by id const item = await db.bucket.findOne({ id: '', select: { actorId: true, allowCustomKeys: true, allowedMimeTypes: true, allowedOrigins: true, createdAt: true, databaseId: true, description: true, destinationBucketId: true, id: true, isPublic: true, key: true, maxBulkFiles: true, maxFileSize: true, physicalName: true, provisionRequestedAt: true, stagingTtl: true, tags: true, type: true, updatedAt: true } }).execute(); // Create const created = await db.bucket.create({ data: { actorId: '', allowCustomKeys: '', allowedMimeTypes: '', allowedOrigins: '', databaseId: '', description: '', destinationBucketId: '', isPublic: '', key: '', maxFileSize: '', physicalName: '', provisionRequestedAt: '', stagingTtl: '', tags: '', type: '' }, select: { id: true } }).execute(); // Update const updated = await db.bucket.update({ where: { id: '' }, data: { actorId: '' }, select: { id: true } }).execute(); // Delete const deleted = await db.bucket.delete({ where: { id: '' } }).execute(); ``` ### `db.file` CRUD operations for File records. **Fields:** | Field | Type | Editable | |-------|------|----------| | `actorId` | UUID | Yes | | `bucketId` | UUID | Yes | | `contentHash` | String | Yes | | `createdAt` | Datetime | No | | `databaseId` | UUID | Yes | | `description` | String | Yes | | `downloadUrl` | String | No | | `expiryEnqueuedAt` | Datetime | Yes | | `filePath` | String | No | | `filename` | String | Yes | | `id` | UUID | No | | `isPublic` | Boolean | Yes | | `key` | String | Yes | | `mimeType` | String | Yes | | `promotedAt` | Datetime | Yes | | `rejectionReason` | String | Yes | | `size` | BigInt | Yes | | `status` | FileStatus | Yes | | `tags` | String | Yes | | `updatedAt` | Datetime | No | | `upload` | ConstructiveInternalTypeUpload | Yes | | `uploadUrl` | String | No | | `uploadVersions` | FileVersion | No | **Operations:** ```typescript // List all file records const items = await db.file.findMany({ select: { actorId: true, bucketId: true, contentHash: true, createdAt: true, databaseId: true, description: true, downloadUrl: true, expiryEnqueuedAt: true, filePath: true, filename: true, id: true, isPublic: true, key: true, mimeType: true, promotedAt: true, rejectionReason: true, size: true, status: true, tags: true, updatedAt: true, upload: true } }).execute(); // Get one by id const item = await db.file.findOne({ id: '', select: { actorId: true, bucketId: true, contentHash: true, createdAt: true, databaseId: true, description: true, downloadUrl: true, expiryEnqueuedAt: true, filePath: true, filename: true, id: true, isPublic: true, key: true, mimeType: true, promotedAt: true, rejectionReason: true, size: true, status: true, tags: true, updatedAt: true, upload: true } }).execute(); // Update const updated = await db.file.update({ where: { id: '' }, data: { actorId: '' }, select: { id: true } }).execute(); // Delete const deleted = await db.file.delete({ where: { id: '' } }).execute(); ``` ### `db.platformBucket` CRUD operations for PlatformBucket records. **Fields:** | Field | Type | Editable | |-------|------|----------| | `actorId` | UUID | Yes | | `allowCustomKeys` | Boolean | Yes | | `allowedMimeTypes` | String | Yes | | `allowedOrigins` | String | Yes | | `createdAt` | Datetime | No | | `description` | String | Yes | | `destinationBucketId` | UUID | Yes | | `id` | UUID | No | | `isPublic` | Boolean | Yes | | `key` | String | Yes | | `maxBulkFiles` | Int | No | | `maxFileSize` | BigInt | Yes | | `physicalName` | String | Yes | | `provisionRequestedAt` | Datetime | Yes | | `stagingTtl` | Interval | Yes | | `tags` | String | Yes | | `type` | BucketType | Yes | | `updatedAt` | Datetime | No | **Operations:** ```typescript // List all platformBucket records const items = await db.platformBucket.findMany({ select: { actorId: true, allowCustomKeys: true, allowedMimeTypes: true, allowedOrigins: true, createdAt: true, description: true, destinationBucketId: true, id: true, isPublic: true, key: true, maxBulkFiles: true, maxFileSize: true, physicalName: true, provisionRequestedAt: true, stagingTtl: true, tags: true, type: true, updatedAt: true } }).execute(); // Get one by id const item = await db.platformBucket.findOne({ id: '', select: { actorId: true, allowCustomKeys: true, allowedMimeTypes: true, allowedOrigins: true, createdAt: true, description: true, destinationBucketId: true, id: true, isPublic: true, key: true, maxBulkFiles: true, maxFileSize: true, physicalName: true, provisionRequestedAt: true, stagingTtl: true, tags: true, type: true, updatedAt: true } }).execute(); // Create const created = await db.platformBucket.create({ data: { actorId: '', allowCustomKeys: '', allowedMimeTypes: '', allowedOrigins: '', description: '', destinationBucketId: '', isPublic: '', key: '', maxFileSize: '', physicalName: '', provisionRequestedAt: '', stagingTtl: '', tags: '', type: '' }, select: { id: true } }).execute(); // Update const updated = await db.platformBucket.update({ where: { id: '' }, data: { actorId: '' }, select: { id: true } }).execute(); // Delete const deleted = await db.platformBucket.delete({ where: { id: '' } }).execute(); ``` ### `db.platformFile` CRUD operations for PlatformFile records. **Fields:** | Field | Type | Editable | |-------|------|----------| | `actorId` | UUID | Yes | | `bucketId` | UUID | Yes | | `contentHash` | String | Yes | | `createdAt` | Datetime | No | | `description` | String | Yes | | `downloadUrl` | String | No | | `expiryEnqueuedAt` | Datetime | Yes | | `filePath` | String | No | | `filename` | String | Yes | | `id` | UUID | No | | `isPublic` | Boolean | Yes | | `key` | String | Yes | | `mimeType` | String | Yes | | `promotedAt` | Datetime | Yes | | `rejectionReason` | String | Yes | | `size` | BigInt | Yes | | `status` | FileStatus | Yes | | `tags` | String | Yes | | `updatedAt` | Datetime | No | | `upload` | ConstructiveInternalTypeUpload | Yes | | `uploadUrl` | String | No | | `uploadVersions` | FileVersion | No | **Operations:** ```typescript // List all platformFile records const items = await db.platformFile.findMany({ select: { actorId: true, bucketId: true, contentHash: true, createdAt: true, description: true, downloadUrl: true, expiryEnqueuedAt: true, filePath: true, filename: true, id: true, isPublic: true, key: true, mimeType: true, promotedAt: true, rejectionReason: true, size: true, status: true, tags: true, updatedAt: true, upload: true } }).execute(); // Get one by id const item = await db.platformFile.findOne({ id: '', select: { actorId: true, bucketId: true, contentHash: true, createdAt: true, description: true, downloadUrl: true, expiryEnqueuedAt: true, filePath: true, filename: true, id: true, isPublic: true, key: true, mimeType: true, promotedAt: true, rejectionReason: true, size: true, status: true, tags: true, updatedAt: true, upload: true } }).execute(); // Update const updated = await db.platformFile.update({ where: { id: '' }, data: { actorId: '' }, select: { id: true } }).execute(); // Delete const deleted = await db.platformFile.delete({ where: { id: '' } }).execute(); ``` ## Custom Operations ### `db.mutation.filesRename` filesRename - **Type:** mutation - **Arguments:** | Argument | Type | |----------|------| | `input` | FilesRenameInput (required) | ```typescript const result = await db.mutation.filesRename({ input: { fileId: '', newFilename: '' } }).execute(); ``` ### `db.mutation.platformFilesRename` platformFilesRename - **Type:** mutation - **Arguments:** | Argument | Type | |----------|------| | `input` | PlatformFilesRenameInput (required) | ```typescript const result = await db.mutation.platformFilesRename({ input: { fileId: '', newFilename: '' } }).execute(); ``` ### `db.mutation.provisionBucket` Reconcile an S3 bucket for a logical bucket in the database. Records the request on the bucket row via RLS; the bucket's job trigger then enqueues the same storage:provision_bucket job used on INSERT, and repeated requests collapse into one pending job. This is idempotent for an already-reconciled bucket; failures become GraphQL errors. - **Type:** mutation - **Arguments:** | Argument | Type | |----------|------| | `input` | ProvisionBucketInput (required) | ```typescript const result = await db.mutation.provisionBucket({ input: { bucketKey: '', ownerId: '' } }).execute(); ``` ### `db.mutation.uploadFile` Upload a file: resolves the bucket by key, creates the file row, and returns a presigned PUT URL. - **Type:** mutation - **Arguments:** | Argument | Type | |----------|------| | `input` | UploadFileInput (required) | ```typescript const result = await db.mutation.uploadFile({ input: '' }).execute(); ``` ### `db.mutation.uploadFiles` Upload multiple files: resolves the bucket by key, creates file rows, and returns presigned PUT URLs for each. Accepts at most the bucket's `maxBulkFiles` files per call. - **Type:** mutation - **Arguments:** | Argument | Type | |----------|------| | `input` | UploadFileBulkInput (required) | ```typescript const result = await db.mutation.uploadFiles({ input: { bucketKey: '', databaseId: '', files: '', isPublic: '' } }).execute(); ``` ### `db.mutation.uploadPlatformFile` Upload a file: resolves the bucket by key, creates the file row, and returns a presigned PUT URL. - **Type:** mutation - **Arguments:** | Argument | Type | |----------|------| | `input` | UploadPlatformFileInput (required) | ```typescript const result = await db.mutation.uploadPlatformFile({ input: '' }).execute(); ``` ### `db.mutation.uploadPlatformFiles` Upload multiple files: resolves the bucket by key, creates file rows, and returns presigned PUT URLs for each. Accepts at most the bucket's `maxBulkFiles` files per call. - **Type:** mutation - **Arguments:** | Argument | Type | |----------|------| | `input` | UploadPlatformFileBulkInput (required) | ```typescript const result = await db.mutation.uploadPlatformFiles({ input: { bucketKey: '', files: '', isPublic: '' } }).execute(); ```