@tailor-platform/sdk 1.52.0 → 1.53.0

package/dist/file-umdycPAF.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"file-umdycPAF.mjs","names":[],"sources":["../src/runtime/file.ts"],"sourcesContent":["/**\n * TailorDB file (BLOB) utilities.\n *\n * Thin typed wrapper around the platform-provided `tailordb.file` runtime API.\n * At runtime this delegates to `globalThis.tailordb.file`. Use `fileMock` from\n * `@tailor-platform/sdk/vitest` to mock these calls in unit tests.\n * @example\n * import { file } from \"@tailor-platform/sdk/runtime\";\n *\n * const { metadata } = await file.upload(\n *   \"my-namespace\",\n *   \"Document\",\n *   \"attachment\",\n *   recordId,\n *   bytes,\n * );\n */\n\n/** Upload response metadata. */\nexport interface UploadMetadata {\n  fileSize: number;\n  sha256sum: string;\n}\n\n/** Download response metadata. */\nexport interface DownloadMetadata {\n  contentType: string;\n  fileSize: number;\n  sha256sum: string;\n  lastUploadedAt: string;\n}\n\n/** File metadata (for {@link getMetadata}). */\nexport interface FileMetadata {\n  contentType: string;\n  fileSize: number;\n  sha256sum: string;\n  urlPath: string;\n  lastUploadedAt?: string;\n}\n\n/** Stream metadata (first chunk emitted by {@link openDownloadStream}). */\nexport interface StreamMetadata {\n  contentType: string;\n  fileSize: number;\n  sha256sum: string;\n}\n\n/** Upload options. */\nexport interface FileUploadOptions {\n  contentType?: string;\n}\n\n/** Upload response. */\nexport interface FileUploadResponse {\n  metadata: UploadMetadata;\n}\n\n/** Download response. */\nexport interface FileDownloadResponse {\n  data: Uint8Array;\n  metadata: DownloadMetadata;\n}\n\n/** Download-as-Base64 response. */\nexport interface FileDownloadAsBase64Response {\n  data: string;\n  metadata: DownloadMetadata;\n}\n\n/** Stream chunk types emitted by {@link FileStreamIterator}. */\nexport type StreamValue =\n  | { type: \"metadata\"; metadata: StreamMetadata }\n  | { type: \"chunk\"; data: Uint8Array; position: number }\n  | { type: \"complete\" };\n\n/** Stream iterator returned by {@link openDownloadStream}. */\nexport interface FileStreamIterator extends AsyncIterableIterator<StreamValue> {\n  next(): Promise<IteratorResult<StreamValue>>;\n  close(): Promise<void>;\n}\n\n/** Error code emitted by {@link TailorDBFileError}. */\nexport type TailorDBFileErrorCode =\n  | \"INVALID_PARAMS\"\n  | \"INVALID_DATA_TYPE\"\n  | \"OPERATION_FAILED\"\n  | \"DELETE_FAILED\"\n  | \"STREAM_OPEN_FAILED\"\n  | \"STREAM_READ_ERROR\"\n  | \"STREAM_ERROR\"\n  | \"FILE_TOO_LARGE\";\n\n/**\n * Type-only shape of the `TailorDBFileError` runtime class. The class itself\n * is provided by the platform runtime (and by `injectMocks` in tests); this\n * interface mirrors it so callers can `import type { TailorDBFileError }` from\n * the wrapper module without depending on any ambient declaration.\n */\nexport interface TailorDBFileError extends Error {\n  name: \"TailorDBFileError\";\n  code?: TailorDBFileErrorCode;\n  cause?: unknown;\n}\n\n/**\n * Platform API surface for `tailordb.file`. Describes the shape the platform\n * runtime injects on `globalThis.tailordb.file`.\n *\n * Each method below is also re-exported as a top-level named export from this\n * module (e.g. `upload`, `download`, `deleteFile`) so callers can either\n * `import * as file from \"@tailor-platform/sdk/runtime/file\"` or pick\n * individual methods.\n */\nexport interface TailorDBFileAPI {\n  /**\n   * Upload a file to TailorDB.\n   * @param namespace - TailorDB namespace\n   * @param typeName - TailorDB type name\n   * @param fieldName - File field name on the type\n   * @param recordId - Record ID owning the field\n   * @param data - File contents\n   * @param options - Upload options (e.g. `contentType`)\n   * @returns Upload response containing the file metadata\n   */\n  upload(\n    namespace: string,\n    typeName: string,\n    fieldName: string,\n    recordId: string,\n    data: string | ArrayBuffer | Uint8Array | number[],\n    options?: FileUploadOptions,\n  ): Promise<FileUploadResponse>;\n\n  /**\n   * Download a file from TailorDB.\n   *\n   * Throws `TailorDBFileError` with code `FILE_TOO_LARGE` when the file\n   * exceeds 10MB — use {@link openDownloadStream} for large files.\n   * @param namespace - TailorDB namespace\n   * @param typeName - TailorDB type name\n   * @param fieldName - File field name on the type\n   * @param recordId - Record ID owning the field\n   * @returns Bytes and metadata for the file\n   */\n  download(\n    namespace: string,\n    typeName: string,\n    fieldName: string,\n    recordId: string,\n  ): Promise<FileDownloadResponse>;\n\n  /**\n   * Download a file from TailorDB as a Base64-encoded string.\n   *\n   * Throws `TailorDBFileError` with code `FILE_TOO_LARGE` when the file\n   * exceeds 10MB — use {@link openDownloadStream} for large files.\n   * @param namespace - TailorDB namespace\n   * @param typeName - TailorDB type name\n   * @param fieldName - File field name on the type\n   * @param recordId - Record ID owning the field\n   * @returns Base64-encoded contents and metadata for the file\n   */\n  downloadAsBase64(\n    namespace: string,\n    typeName: string,\n    fieldName: string,\n    recordId: string,\n  ): Promise<FileDownloadAsBase64Response>;\n\n  /**\n   * Delete a file from TailorDB. Exported as `deleteFile` (and aliased as\n   * `delete`) so it can be used both with named and namespace imports.\n   * @param namespace - TailorDB namespace\n   * @param typeName - TailorDB type name\n   * @param fieldName - File field name on the type\n   * @param recordId - Record ID owning the field\n   * @returns Resolves once the file has been deleted\n   */\n  delete(namespace: string, typeName: string, fieldName: string, recordId: string): Promise<void>;\n\n  /**\n   * Get file metadata from TailorDB.\n   * @param namespace - TailorDB namespace\n   * @param typeName - TailorDB type name\n   * @param fieldName - File field name on the type\n   * @param recordId - Record ID owning the field\n   * @returns Metadata for the stored file\n   */\n  getMetadata(\n    namespace: string,\n    typeName: string,\n    fieldName: string,\n    recordId: string,\n  ): Promise<FileMetadata>;\n\n  /**\n   * Open a download stream for large files.\n   * @param namespace - TailorDB namespace\n   * @param typeName - TailorDB type name\n   * @param fieldName - File field name on the type\n   * @param recordId - Record ID owning the field\n   * @returns Async iterator yielding file chunks; call `close()` to release resources\n   */\n  openDownloadStream(\n    namespace: string,\n    typeName: string,\n    fieldName: string,\n    recordId: string,\n  ): Promise<FileStreamIterator>;\n}\n\nconst api = (): TailorDBFileAPI =>\n  (globalThis as { tailordb: { file: TailorDBFileAPI } }).tailordb.file;\n\n/**\n * See {@link TailorDBFileAPI.upload}.\n * @param args - Forwarded to {@link TailorDBFileAPI.upload}\n * @returns Upload response containing the file metadata\n */\nexport const upload: TailorDBFileAPI[\"upload\"] = (...args) => api().upload(...args);\n\n/**\n * See {@link TailorDBFileAPI.download}.\n * @param args - Forwarded to {@link TailorDBFileAPI.download}\n * @returns Bytes and metadata for the file\n */\nexport const download: TailorDBFileAPI[\"download\"] = (...args) => api().download(...args);\n\n/**\n * See {@link TailorDBFileAPI.downloadAsBase64}.\n * @param args - Forwarded to {@link TailorDBFileAPI.downloadAsBase64}\n * @returns Base64-encoded contents and metadata for the file\n */\nexport const downloadAsBase64: TailorDBFileAPI[\"downloadAsBase64\"] = (...args) =>\n  api().downloadAsBase64(...args);\n\n/**\n * See {@link TailorDBFileAPI.delete}.\n * @param args - Forwarded to {@link TailorDBFileAPI.delete}\n * @returns Resolves once the file has been deleted\n */\nexport const deleteFile: TailorDBFileAPI[\"delete\"] = (...args) => api().delete(...args);\n\n/**\n * See {@link TailorDBFileAPI.getMetadata}.\n * @param args - Forwarded to {@link TailorDBFileAPI.getMetadata}\n * @returns Metadata for the stored file\n */\nexport const getMetadata: TailorDBFileAPI[\"getMetadata\"] = (...args) => api().getMetadata(...args);\n\n/**\n * See {@link TailorDBFileAPI.openDownloadStream}.\n * @param args - Forwarded to {@link TailorDBFileAPI.openDownloadStream}\n * @returns Async iterator yielding file chunks; call `close()` to release resources\n */\nexport const openDownloadStream: TailorDBFileAPI[\"openDownloadStream\"] = (...args) =>\n  api().openDownloadStream(...args);\n\nexport { deleteFile as delete };\n"],"mappings":";;;;;;;;;;;;;AAoNA,MAAM,YACH,WAAuD,SAAS;;;;;;AAOnE,MAAa,UAAqC,GAAG,SAAS,IAAI,EAAE,OAAO,GAAG,IAAI;;;;;;AAOlF,MAAa,YAAyC,GAAG,SAAS,IAAI,EAAE,SAAS,GAAG,IAAI;;;;;;AAOxF,MAAa,oBAAyD,GAAG,SACvE,IAAI,EAAE,iBAAiB,GAAG,IAAI;;;;;;AAOhC,MAAa,cAAyC,GAAG,SAAS,IAAI,EAAE,OAAO,GAAG,IAAI;;;;;;AAOtF,MAAa,eAA+C,GAAG,SAAS,IAAI,EAAE,YAAY,GAAG,IAAI;;;;;;AAOjG,MAAa,sBAA6D,GAAG,SAC3E,IAAI,EAAE,mBAAmB,GAAG,IAAI"}