@backblaze-labs/b2-sdk 0.1.0

package/dist/types/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/types/errors.js"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,MAAM,WAAW,GACnB,oBAAoB,GACpB,gBAAgB,GAChB,cAAc,GACd,aAAa,GACb,eAAe,GACf,WAAW,GACX,oBAAoB,GACpB,iBAAiB,GACjB,UAAU,GACV,uBAAuB,GACvB,kBAAkB,GAClB,gBAAgB,GAChB,cAAc,GACd,sBAAsB,GACtB,0BAA0B,GAC1B,eAAe,GACf,qBAAqB,GACrB,gBAAgB,GAChB,UAAU,GACV,mBAAmB,GACnB,kBAAkB,GAClB,cAAc,GACd,cAAc,GACd,uBAAuB,GACvB,iBAAiB,GACjB,qBAAqB,GACrB,mBAAmB,GACnB,uBAAuB,GACvB,CAAC,MAAM,GAAG,EAAE,CAAC,CAAA;AAEjB,sEAAsE;AACtE,MAAM,WAAW,eAAe;IAC9B,iDAAiD;IACjD,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,oEAAoE;IACpE,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAA;IAC1B,+CAA+C;IAC/C,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;CACzB"}

package/dist/types/file.cjs

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const FileAction = {
+  /** Large file upload started but not yet finished. */
+  Start: "start",
+  /** Normal upload (small or finished large file). */
+  Upload: "upload",
+  /** Hide marker (soft delete). */
+  Hide: "hide",
+  /** Virtual folder marker. */
+  Folder: "folder",
+  /** Created via server-side copy. */
+  Copy: "copy"
+};
+const MetadataDirective = {
+  /** Preserve the source file's contentType and fileInfo. */
+  Copy: "COPY",
+  /** Use the values provided in the copy request. */
+  Replace: "REPLACE"
+};
+exports.FileAction = FileAction;
+exports.MetadataDirective = MetadataDirective;
+//# sourceMappingURL=file.cjs.map

package/dist/types/file.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"file.cjs","sources":["../../src/types/file.ts"],"sourcesContent":["import type { EncryptionSetting } from './encryption.ts'\nimport type { AccountId, BucketId, FileId } from './ids.ts'\nimport type { FileRetentionValue, LegalHoldValue } from './lock.ts'\n\n/**\n * Named constants for the action that created a file version.\n *\n * @example\n * ```ts\n * if (file.action === FileAction.Hide) { ... }\n * ```\n */\nexport const FileAction = {\n  /** Large file upload started but not yet finished. */\n  Start: 'start',\n  /** Normal upload (small or finished large file). */\n  Upload: 'upload',\n  /** Hide marker (soft delete). */\n  Hide: 'hide',\n  /** Virtual folder marker. */\n  Folder: 'folder',\n  /** Created via server-side copy. */\n  Copy: 'copy',\n} as const\n\n/**\n * The action that created a file version. Derived from {@link FileAction}.\n *\n * - `'start'`: large file upload started but not yet finished.\n * - `'upload'`: file was uploaded normally.\n * - `'hide'`: file was hidden (soft-deleted).\n * - `'folder'`: virtual folder marker.\n * - `'copy'`: file was created via server-side copy.\n */\nexport type FileAction = (typeof FileAction)[keyof typeof FileAction]\n\n/**\n * Complete metadata for a single file version in B2.\n * Returned by `b2_get_file_info`, `b2_list_file_names`, `b2_list_file_versions`,\n * `b2_upload_file`, `b2_copy_file`, and other file-related endpoints.\n */\nexport interface FileVersion {\n  /** Account that owns this file. */\n  readonly accountId: AccountId\n  /** Action that created this file version. */\n  readonly action: FileAction\n  /** Bucket containing this file. */\n  readonly bucketId: BucketId\n  /** Size of the file content in bytes. */\n  readonly contentLength: number\n  /** MD5 checksum of the content, or null if not available. */\n  readonly contentMd5: string | null\n  /** SHA-1 checksum of the content, or null if not available (e.g., large files). */\n  readonly contentSha1: string | null\n  /** MIME type of the file content. */\n  readonly contentType: string\n  /** Unique identifier for this file version. */\n  readonly fileId: FileId\n  /** User-defined key-value metadata stored with the file. */\n  readonly fileInfo: Record<string, string>\n  /** Full path and name of the file within the bucket. */\n  readonly fileName: string\n  /** Object Lock retention settings for this file version. */\n  readonly fileRetention: {\n    /** Whether the caller is authorized to read retention settings. */\n    readonly isClientAuthorizedToRead: boolean\n    /** Retention settings, or null if the caller lacks read authorization. */\n    readonly value: FileRetentionValue | null\n  }\n  /** Legal hold status for this file version. */\n  readonly legalHold: {\n    /** Whether the caller is authorized to read legal hold status. */\n    readonly isClientAuthorizedToRead: boolean\n    /** Legal hold value, or null if the caller lacks read authorization. */\n    readonly value: LegalHoldValue | null\n  }\n  /** Replication status, or null if replication is not configured. */\n  readonly replicationStatus: 'pending' | 'completed' | 'failed' | 'replica' | null\n  /** Server-side encryption settings applied to this file version. */\n  readonly serverSideEncryption: EncryptionSetting\n  /** UTC timestamp (milliseconds) when this version was uploaded. */\n  readonly uploadTimestamp: number\n}\n\n/** Request parameters for the `b2_list_file_names` API call. Lists the most recent version of each file in a bucket. */\nexport interface ListFileNamesRequest {\n  /** Bucket to list files from. */\n  readonly bucketId: BucketId\n  /** Return files starting after this name (exclusive). Used for pagination. */\n  readonly startFileName?: string\n  /** Maximum number of files to return (1 to 10000). */\n  readonly maxFileCount?: number\n  /** Only return files whose names start with this prefix. */\n  readonly prefix?: string\n  /** Delimiter for virtual folder grouping (typically `'/'`). */\n  readonly delimiter?: string\n}\n\n/** Response from the `b2_list_file_names` API call. */\nexport interface ListFileNamesResponse {\n  /** Array of file versions matching the request. */\n  readonly files: readonly FileVersion[]\n  /** Next file name to use for pagination, or null if all files have been listed. */\n  readonly nextFileName: string | null\n}\n\n/** Request parameters for the `b2_list_file_versions` API call. Lists all versions of files in a bucket. */\nexport interface ListFileVersionsRequest {\n  /** Bucket to list file versions from. */\n  readonly bucketId: BucketId\n  /** Return files starting after this name (exclusive). Used for pagination. */\n  readonly startFileName?: string\n  /** Return file versions starting after this ID. Used with startFileName for pagination. */\n  readonly startFileId?: FileId\n  /** Maximum number of file versions to return (1 to 10000). */\n  readonly maxFileCount?: number\n  /** Only return files whose names start with this prefix. */\n  readonly prefix?: string\n  /** Delimiter for virtual folder grouping (typically `'/'`). */\n  readonly delimiter?: string\n}\n\n/** Response from the `b2_list_file_versions` API call. */\nexport interface ListFileVersionsResponse {\n  /** Array of file versions matching the request. */\n  readonly files: readonly FileVersion[]\n  /** Next file name to use for pagination, or null if all versions have been listed. */\n  readonly nextFileName: string | null\n  /** Next file ID to use for pagination, or null if all versions have been listed. */\n  readonly nextFileId: FileId | null\n}\n\n/** Request parameters for the `b2_get_file_info` API call. */\nexport interface GetFileInfoRequest {\n  /** ID of the file version to retrieve info for. */\n  readonly fileId: FileId\n}\n\n/** Request parameters for the `b2_hide_file` API call. Hides a file so it no longer appears in `b2_list_file_names`. */\nexport interface HideFileRequest {\n  /** Bucket containing the file to hide. */\n  readonly bucketId: BucketId\n  /** Name of the file to hide. */\n  readonly fileName: string\n}\n\n/** Request parameters for the `b2_delete_file_version` API call. */\nexport interface DeleteFileVersionRequest {\n  /** Name of the file version to delete. */\n  readonly fileName: string\n  /** ID of the file version to delete. */\n  readonly fileId: FileId\n  /** If true, bypass governance-mode retention. Requires the `bypassGovernance` capability. */\n  readonly bypassGovernance?: boolean\n}\n\n/** Response from the `b2_delete_file_version` API call. */\nexport interface DeleteFileVersionResponse {\n  /** ID of the deleted file version. */\n  readonly fileId: FileId\n  /** Name of the deleted file. */\n  readonly fileName: string\n}\n\n/**\n * Named constants for how metadata is handled during a file copy.\n *\n * @example\n * ```ts\n * await bucket.copyFile({ ..., metadataDirective: MetadataDirective.Replace })\n * ```\n */\nexport const MetadataDirective = {\n  /** Preserve the source file's contentType and fileInfo. */\n  Copy: 'COPY',\n  /** Use the values provided in the copy request. */\n  Replace: 'REPLACE',\n} as const\n\n/** Controls how metadata is handled during a file copy. Derived from {@link MetadataDirective}. */\nexport type MetadataDirective = (typeof MetadataDirective)[keyof typeof MetadataDirective]\n\n/** Request parameters for the `b2_copy_file` API call. Performs a server-side file copy. */\nexport interface CopyFileRequest {\n  /** ID of the source file version to copy from. */\n  readonly sourceFileId: FileId\n  /** Destination bucket ID. Defaults to the source bucket if omitted. */\n  readonly destinationBucketId?: BucketId\n  /** Name for the destination file. */\n  readonly fileName: string\n  /** Byte range to copy (e.g., `'bytes=0-999'`). Omit to copy the entire file. */\n  readonly range?: string\n  /** Whether to copy or replace the source file's metadata. */\n  readonly metadataDirective?: MetadataDirective\n  /** MIME type for the destination file (only used when metadataDirective is `'REPLACE'`). */\n  readonly contentType?: string\n  /** User-defined metadata for the destination file (only used when metadataDirective is `'REPLACE'`). */\n  readonly fileInfo?: Record<string, string>\n  /** Object Lock retention for the destination file. */\n  readonly fileRetention?: FileRetentionValue\n  /** Legal hold for the destination file. */\n  readonly legalHold?: LegalHoldValue\n  /** SSE-C settings for reading the source file, if the source is encrypted with SSE-C. */\n  readonly sourceServerSideEncryption?: EncryptionSetting\n  /** Server-side encryption to apply to the destination file. */\n  readonly destinationServerSideEncryption?: EncryptionSetting\n}\n\n/** Request parameters for the `b2_copy_part` API call. Copies a byte range into a large file part. */\nexport interface CopyPartRequest {\n  /** ID of the source file version to copy from. */\n  readonly sourceFileId: FileId\n  /** ID of the large file being assembled. */\n  readonly largeFileId: FileId\n  /** Part number (1-based) for this part within the large file. */\n  readonly partNumber: number\n  /** Byte range to copy from the source (e.g., `'bytes=0-999'`). Omit to copy the entire source. */\n  readonly range?: string\n  /** SSE-C settings for reading the source file, if the source is encrypted with SSE-C. */\n  readonly sourceServerSideEncryption?: EncryptionSetting\n  /** Server-side encryption to apply to the destination part. */\n  readonly destinationServerSideEncryption?: EncryptionSetting\n}\n\n/** Response from the `b2_copy_part` API call. */\nexport interface CopyPartResponse {\n  /** ID of the large file this part belongs to. */\n  readonly fileId: FileId\n  /** Part number within the large file. */\n  readonly partNumber: number\n  /** Size of the copied part in bytes. */\n  readonly contentLength: number\n  /** SHA-1 checksum of the copied part content. */\n  readonly contentSha1: string\n}\n"],"names":[],"mappings":";;AAYO,MAAM,aAAa;AAAA;AAAA,EAExB,OAAO;AAAA;AAAA,EAEP,QAAQ;AAAA;AAAA,EAER,MAAM;AAAA;AAAA,EAEN,QAAQ;AAAA;AAAA,EAER,MAAM;AACR;AAqJO,MAAM,oBAAoB;AAAA;AAAA,EAE/B,MAAM;AAAA;AAAA,EAEN,SAAS;AACX;;;"}

package/dist/types/file.d.cts

@@ -0,0 +1,220 @@
+import { EncryptionSetting } from './encryption.js';
+import { AccountId, BucketId, FileId } from './ids.js';
+import { FileRetentionValue, LegalHoldValue } from './lock.js';
+/**
+ * Named constants for the action that created a file version.
+ *
+ * @example
+ * ```ts
+ * if (file.action === FileAction.Hide) { ... }
+ * ```
+ */
+export declare const FileAction: {
+    /** Large file upload started but not yet finished. */
+    readonly Start: "start";
+    /** Normal upload (small or finished large file). */
+    readonly Upload: "upload";
+    /** Hide marker (soft delete). */
+    readonly Hide: "hide";
+    /** Virtual folder marker. */
+    readonly Folder: "folder";
+    /** Created via server-side copy. */
+    readonly Copy: "copy";
+};
+/**
+ * The action that created a file version. Derived from {@link FileAction}.
+ *
+ * - `'start'`: large file upload started but not yet finished.
+ * - `'upload'`: file was uploaded normally.
+ * - `'hide'`: file was hidden (soft-deleted).
+ * - `'folder'`: virtual folder marker.
+ * - `'copy'`: file was created via server-side copy.
+ */
+export type FileAction = (typeof FileAction)[keyof typeof FileAction];
+/**
+ * Complete metadata for a single file version in B2.
+ * Returned by `b2_get_file_info`, `b2_list_file_names`, `b2_list_file_versions`,
+ * `b2_upload_file`, `b2_copy_file`, and other file-related endpoints.
+ */
+export interface FileVersion {
+    /** Account that owns this file. */
+    readonly accountId: AccountId;
+    /** Action that created this file version. */
+    readonly action: FileAction;
+    /** Bucket containing this file. */
+    readonly bucketId: BucketId;
+    /** Size of the file content in bytes. */
+    readonly contentLength: number;
+    /** MD5 checksum of the content, or null if not available. */
+    readonly contentMd5: string | null;
+    /** SHA-1 checksum of the content, or null if not available (e.g., large files). */
+    readonly contentSha1: string | null;
+    /** MIME type of the file content. */
+    readonly contentType: string;
+    /** Unique identifier for this file version. */
+    readonly fileId: FileId;
+    /** User-defined key-value metadata stored with the file. */
+    readonly fileInfo: Record<string, string>;
+    /** Full path and name of the file within the bucket. */
+    readonly fileName: string;
+    /** Object Lock retention settings for this file version. */
+    readonly fileRetention: {
+        /** Whether the caller is authorized to read retention settings. */
+        readonly isClientAuthorizedToRead: boolean;
+        /** Retention settings, or null if the caller lacks read authorization. */
+        readonly value: FileRetentionValue | null;
+    };
+    /** Legal hold status for this file version. */
+    readonly legalHold: {
+        /** Whether the caller is authorized to read legal hold status. */
+        readonly isClientAuthorizedToRead: boolean;
+        /** Legal hold value, or null if the caller lacks read authorization. */
+        readonly value: LegalHoldValue | null;
+    };
+    /** Replication status, or null if replication is not configured. */
+    readonly replicationStatus: 'pending' | 'completed' | 'failed' | 'replica' | null;
+    /** Server-side encryption settings applied to this file version. */
+    readonly serverSideEncryption: EncryptionSetting;
+    /** UTC timestamp (milliseconds) when this version was uploaded. */
+    readonly uploadTimestamp: number;
+}
+/** Request parameters for the `b2_list_file_names` API call. Lists the most recent version of each file in a bucket. */
+export interface ListFileNamesRequest {
+    /** Bucket to list files from. */
+    readonly bucketId: BucketId;
+    /** Return files starting after this name (exclusive). Used for pagination. */
+    readonly startFileName?: string;
+    /** Maximum number of files to return (1 to 10000). */
+    readonly maxFileCount?: number;
+    /** Only return files whose names start with this prefix. */
+    readonly prefix?: string;
+    /** Delimiter for virtual folder grouping (typically `'/'`). */
+    readonly delimiter?: string;
+}
+/** Response from the `b2_list_file_names` API call. */
+export interface ListFileNamesResponse {
+    /** Array of file versions matching the request. */
+    readonly files: readonly FileVersion[];
+    /** Next file name to use for pagination, or null if all files have been listed. */
+    readonly nextFileName: string | null;
+}
+/** Request parameters for the `b2_list_file_versions` API call. Lists all versions of files in a bucket. */
+export interface ListFileVersionsRequest {
+    /** Bucket to list file versions from. */
+    readonly bucketId: BucketId;
+    /** Return files starting after this name (exclusive). Used for pagination. */
+    readonly startFileName?: string;
+    /** Return file versions starting after this ID. Used with startFileName for pagination. */
+    readonly startFileId?: FileId;
+    /** Maximum number of file versions to return (1 to 10000). */
+    readonly maxFileCount?: number;
+    /** Only return files whose names start with this prefix. */
+    readonly prefix?: string;
+    /** Delimiter for virtual folder grouping (typically `'/'`). */
+    readonly delimiter?: string;
+}
+/** Response from the `b2_list_file_versions` API call. */
+export interface ListFileVersionsResponse {
+    /** Array of file versions matching the request. */
+    readonly files: readonly FileVersion[];
+    /** Next file name to use for pagination, or null if all versions have been listed. */
+    readonly nextFileName: string | null;
+    /** Next file ID to use for pagination, or null if all versions have been listed. */
+    readonly nextFileId: FileId | null;
+}
+/** Request parameters for the `b2_get_file_info` API call. */
+export interface GetFileInfoRequest {
+    /** ID of the file version to retrieve info for. */
+    readonly fileId: FileId;
+}
+/** Request parameters for the `b2_hide_file` API call. Hides a file so it no longer appears in `b2_list_file_names`. */
+export interface HideFileRequest {
+    /** Bucket containing the file to hide. */
+    readonly bucketId: BucketId;
+    /** Name of the file to hide. */
+    readonly fileName: string;
+}
+/** Request parameters for the `b2_delete_file_version` API call. */
+export interface DeleteFileVersionRequest {
+    /** Name of the file version to delete. */
+    readonly fileName: string;
+    /** ID of the file version to delete. */
+    readonly fileId: FileId;
+    /** If true, bypass governance-mode retention. Requires the `bypassGovernance` capability. */
+    readonly bypassGovernance?: boolean;
+}
+/** Response from the `b2_delete_file_version` API call. */
+export interface DeleteFileVersionResponse {
+    /** ID of the deleted file version. */
+    readonly fileId: FileId;
+    /** Name of the deleted file. */
+    readonly fileName: string;
+}
+/**
+ * Named constants for how metadata is handled during a file copy.
+ *
+ * @example
+ * ```ts
+ * await bucket.copyFile({ ..., metadataDirective: MetadataDirective.Replace })
+ * ```
+ */
+export declare const MetadataDirective: {
+    /** Preserve the source file's contentType and fileInfo. */
+    readonly Copy: "COPY";
+    /** Use the values provided in the copy request. */
+    readonly Replace: "REPLACE";
+};
+/** Controls how metadata is handled during a file copy. Derived from {@link MetadataDirective}. */
+export type MetadataDirective = (typeof MetadataDirective)[keyof typeof MetadataDirective];
+/** Request parameters for the `b2_copy_file` API call. Performs a server-side file copy. */
+export interface CopyFileRequest {
+    /** ID of the source file version to copy from. */
+    readonly sourceFileId: FileId;
+    /** Destination bucket ID. Defaults to the source bucket if omitted. */
+    readonly destinationBucketId?: BucketId;
+    /** Name for the destination file. */
+    readonly fileName: string;
+    /** Byte range to copy (e.g., `'bytes=0-999'`). Omit to copy the entire file. */
+    readonly range?: string;
+    /** Whether to copy or replace the source file's metadata. */
+    readonly metadataDirective?: MetadataDirective;
+    /** MIME type for the destination file (only used when metadataDirective is `'REPLACE'`). */
+    readonly contentType?: string;
+    /** User-defined metadata for the destination file (only used when metadataDirective is `'REPLACE'`). */
+    readonly fileInfo?: Record<string, string>;
+    /** Object Lock retention for the destination file. */
+    readonly fileRetention?: FileRetentionValue;
+    /** Legal hold for the destination file. */
+    readonly legalHold?: LegalHoldValue;
+    /** SSE-C settings for reading the source file, if the source is encrypted with SSE-C. */
+    readonly sourceServerSideEncryption?: EncryptionSetting;
+    /** Server-side encryption to apply to the destination file. */
+    readonly destinationServerSideEncryption?: EncryptionSetting;
+}
+/** Request parameters for the `b2_copy_part` API call. Copies a byte range into a large file part. */
+export interface CopyPartRequest {
+    /** ID of the source file version to copy from. */
+    readonly sourceFileId: FileId;
+    /** ID of the large file being assembled. */
+    readonly largeFileId: FileId;
+    /** Part number (1-based) for this part within the large file. */
+    readonly partNumber: number;
+    /** Byte range to copy from the source (e.g., `'bytes=0-999'`). Omit to copy the entire source. */
+    readonly range?: string;
+    /** SSE-C settings for reading the source file, if the source is encrypted with SSE-C. */
+    readonly sourceServerSideEncryption?: EncryptionSetting;
+    /** Server-side encryption to apply to the destination part. */
+    readonly destinationServerSideEncryption?: EncryptionSetting;
+}
+/** Response from the `b2_copy_part` API call. */
+export interface CopyPartResponse {
+    /** ID of the large file this part belongs to. */
+    readonly fileId: FileId;
+    /** Part number within the large file. */
+    readonly partNumber: number;
+    /** Size of the copied part in bytes. */
+    readonly contentLength: number;
+    /** SHA-1 checksum of the copied part content. */
+    readonly contentSha1: string;
+}
+//# sourceMappingURL=file.d.ts.map

package/dist/types/file.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"file.d.ts","sourceRoot":"","sources":["../../src/types/file.js"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAA;AACxD,OAAO,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAC3D,OAAO,KAAK,EAAE,kBAAkB,EAAE,cAAc,EAAE,MAAM,WAAW,CAAA;AAEnE;;;;;;;GAOG;AACH,eAAO,MAAM,UAAU;IACrB,sDAAsD;;IAEtD,oDAAoD;;IAEpD,iCAAiC;;IAEjC,6BAA6B;;IAE7B,oCAAoC;;CAE5B,CAAA;AAEV;;;;;;;;GAQG;AACH,MAAM,MAAM,UAAU,GAAG,CAAC,OAAO,UAAU,CAAC,CAAC,MAAM,OAAO,UAAU,CAAC,CAAA;AAErE;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAC1B,mCAAmC;IACnC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAA;IAC7B,6CAA6C;IAC7C,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAA;IAC3B,mCAAmC;IACnC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;IAC3B,yCAAyC;IACzC,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAA;IAC9B,6DAA6D;IAC7D,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAClC,mFAAmF;IACnF,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IACnC,qCAAqC;IACrC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;IAC5B,+CAA+C;IAC/C,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,4DAA4D;IAC5D,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACzC,wDAAwD;IACxD,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,4DAA4D;IAC5D,QAAQ,CAAC,aAAa,EAAE;QACtB,mEAAmE;QACnE,QAAQ,CAAC,wBAAwB,EAAE,OAAO,CAAA;QAC1C,0EAA0E;QAC1E,QAAQ,CAAC,KAAK,EAAE,kBAAkB,GAAG,IAAI,CAAA;KAC1C,CAAA;IACD,+CAA+C;IAC/C,QAAQ,CAAC,SAAS,EAAE;QAClB,kEAAkE;QAClE,QAAQ,CAAC,wBAAwB,EAAE,OAAO,CAAA;QAC1C,wEAAwE;QACxE,QAAQ,CAAC,KAAK,EAAE,cAAc,GAAG,IAAI,CAAA;KACtC,CAAA;IACD,oEAAoE;IACpE,QAAQ,CAAC,iBAAiB,EAAE,SAAS,GAAG,WAAW,GAAG,QAAQ,GAAG,SAAS,GAAG,IAAI,CAAA;IACjF,oEAAoE;IACpE,QAAQ,CAAC,oBAAoB,EAAE,iBAAiB,CAAA;IAChD,mEAAmE;IACnE,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAA;CACjC;AAED,wHAAwH;AACxH,MAAM,WAAW,oBAAoB;IACnC,iCAAiC;IACjC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;IAC3B,8EAA8E;IAC9E,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAA;IAC/B,sDAAsD;IACtD,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAA;IAC9B,4DAA4D;IAC5D,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IACxB,+DAA+D;IAC/D,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAA;CAC5B;AAED,uDAAuD;AACvD,MAAM,WAAW,qBAAqB;IACpC,mDAAmD;IACnD,QAAQ,CAAC,KAAK,EAAE,SAAS,WAAW,EAAE,CAAA;IACtC,mFAAmF;IACnF,QAAQ,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;CACrC;AAED,4GAA4G;AAC5G,MAAM,WAAW,uBAAuB;IACtC,yCAAyC;IACzC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;IAC3B,8EAA8E;IAC9E,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAA;IAC/B,2FAA2F;IAC3F,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAA;IAC7B,8DAA8D;IAC9D,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAA;IAC9B,4DAA4D;IAC5D,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IACxB,+DAA+D;IAC/D,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAA;CAC5B;AAED,0DAA0D;AAC1D,MAAM,WAAW,wBAAwB;IACvC,mDAAmD;IACnD,QAAQ,CAAC,KAAK,EAAE,SAAS,WAAW,EAAE,CAAA;IACtC,sFAAsF;IACtF,QAAQ,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IACpC,oFAAoF;IACpF,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;CACnC;AAED,8DAA8D;AAC9D,MAAM,WAAW,kBAAkB;IACjC,mDAAmD;IACnD,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;CACxB;AAED,wHAAwH;AACxH,MAAM,WAAW,eAAe;IAC9B,0CAA0C;IAC1C,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;IAC3B,gCAAgC;IAChC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;CAC1B;AAED,oEAAoE;AACpE,MAAM,WAAW,wBAAwB;IACvC,0CAA0C;IAC1C,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,wCAAwC;IACxC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,6FAA6F;IAC7F,QAAQ,CAAC,gBAAgB,CAAC,EAAE,OAAO,CAAA;CACpC;AAED,2DAA2D;AAC3D,MAAM,WAAW,yBAAyB;IACxC,sCAAsC;IACtC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,gCAAgC;IAChC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;CAC1B;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,iBAAiB;IAC5B,2DAA2D;;IAE3D,mDAAmD;;CAE3C,CAAA;AAEV,mGAAmG;AACnG,MAAM,MAAM,iBAAiB,GAAG,CAAC,OAAO,iBAAiB,CAAC,CAAC,MAAM,OAAO,iBAAiB,CAAC,CAAA;AAE1F,4FAA4F;AAC5F,MAAM,WAAW,eAAe;IAC9B,kDAAkD;IAClD,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAA;IAC7B,uEAAuE;IACvE,QAAQ,CAAC,mBAAmB,CAAC,EAAE,QAAQ,CAAA;IACvC,qCAAqC;IACrC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,gFAAgF;IAChF,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;IACvB,6DAA6D;IAC7D,QAAQ,CAAC,iBAAiB,CAAC,EAAE,iBAAiB,CAAA;IAC9C,4FAA4F;IAC5F,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAA;IAC7B,wGAAwG;IACxG,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC1C,sDAAsD;IACtD,QAAQ,CAAC,aAAa,CAAC,EAAE,kBAAkB,CAAA;IAC3C,2CAA2C;IAC3C,QAAQ,CAAC,SAAS,CAAC,EAAE,cAAc,CAAA;IACnC,yFAAyF;IACzF,QAAQ,CAAC,0BAA0B,CAAC,EAAE,iBAAiB,CAAA;IACvD,+DAA+D;IAC/D,QAAQ,CAAC,+BAA+B,CAAC,EAAE,iBAAiB,CAAA;CAC7D;AAED,sGAAsG;AACtG,MAAM,WAAW,eAAe;IAC9B,kDAAkD;IAClD,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAA;IAC7B,4CAA4C;IAC5C,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;IAC5B,iEAAiE;IACjE,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAC3B,kGAAkG;IAClG,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;IACvB,yFAAyF;IACzF,QAAQ,CAAC,0BAA0B,CAAC,EAAE,iBAAiB,CAAA;IACvD,+DAA+D;IAC/D,QAAQ,CAAC,+BAA+B,CAAC,EAAE,iBAAiB,CAAA;CAC7D;AAED,iDAAiD;AACjD,MAAM,WAAW,gBAAgB;IAC/B,iDAAiD;IACjD,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,yCAAyC;IACzC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAC3B,wCAAwC;IACxC,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAA;IAC9B,iDAAiD;IACjD,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;CAC7B"}

package/dist/types/file.d.ts

@@ -0,0 +1,220 @@
+import { EncryptionSetting } from './encryption.js';
+import { AccountId, BucketId, FileId } from './ids.js';
+import { FileRetentionValue, LegalHoldValue } from './lock.js';
+/**
+ * Named constants for the action that created a file version.
+ *
+ * @example
+ * ```ts
+ * if (file.action === FileAction.Hide) { ... }
+ * ```
+ */
+export declare const FileAction: {
+    /** Large file upload started but not yet finished. */
+    readonly Start: "start";
+    /** Normal upload (small or finished large file). */
+    readonly Upload: "upload";
+    /** Hide marker (soft delete). */
+    readonly Hide: "hide";
+    /** Virtual folder marker. */
+    readonly Folder: "folder";
+    /** Created via server-side copy. */
+    readonly Copy: "copy";
+};
+/**
+ * The action that created a file version. Derived from {@link FileAction}.
+ *
+ * - `'start'`: large file upload started but not yet finished.
+ * - `'upload'`: file was uploaded normally.
+ * - `'hide'`: file was hidden (soft-deleted).
+ * - `'folder'`: virtual folder marker.
+ * - `'copy'`: file was created via server-side copy.
+ */
+export type FileAction = (typeof FileAction)[keyof typeof FileAction];
+/**
+ * Complete metadata for a single file version in B2.
+ * Returned by `b2_get_file_info`, `b2_list_file_names`, `b2_list_file_versions`,
+ * `b2_upload_file`, `b2_copy_file`, and other file-related endpoints.
+ */
+export interface FileVersion {
+    /** Account that owns this file. */
+    readonly accountId: AccountId;
+    /** Action that created this file version. */
+    readonly action: FileAction;
+    /** Bucket containing this file. */
+    readonly bucketId: BucketId;
+    /** Size of the file content in bytes. */
+    readonly contentLength: number;
+    /** MD5 checksum of the content, or null if not available. */
+    readonly contentMd5: string | null;
+    /** SHA-1 checksum of the content, or null if not available (e.g., large files). */
+    readonly contentSha1: string | null;
+    /** MIME type of the file content. */
+    readonly contentType: string;
+    /** Unique identifier for this file version. */
+    readonly fileId: FileId;
+    /** User-defined key-value metadata stored with the file. */
+    readonly fileInfo: Record<string, string>;
+    /** Full path and name of the file within the bucket. */
+    readonly fileName: string;
+    /** Object Lock retention settings for this file version. */
+    readonly fileRetention: {
+        /** Whether the caller is authorized to read retention settings. */
+        readonly isClientAuthorizedToRead: boolean;
+        /** Retention settings, or null if the caller lacks read authorization. */
+        readonly value: FileRetentionValue | null;
+    };
+    /** Legal hold status for this file version. */
+    readonly legalHold: {
+        /** Whether the caller is authorized to read legal hold status. */
+        readonly isClientAuthorizedToRead: boolean;
+        /** Legal hold value, or null if the caller lacks read authorization. */
+        readonly value: LegalHoldValue | null;
+    };
+    /** Replication status, or null if replication is not configured. */
+    readonly replicationStatus: 'pending' | 'completed' | 'failed' | 'replica' | null;
+    /** Server-side encryption settings applied to this file version. */
+    readonly serverSideEncryption: EncryptionSetting;
+    /** UTC timestamp (milliseconds) when this version was uploaded. */
+    readonly uploadTimestamp: number;
+}
+/** Request parameters for the `b2_list_file_names` API call. Lists the most recent version of each file in a bucket. */
+export interface ListFileNamesRequest {
+    /** Bucket to list files from. */
+    readonly bucketId: BucketId;
+    /** Return files starting after this name (exclusive). Used for pagination. */
+    readonly startFileName?: string;
+    /** Maximum number of files to return (1 to 10000). */
+    readonly maxFileCount?: number;
+    /** Only return files whose names start with this prefix. */
+    readonly prefix?: string;
+    /** Delimiter for virtual folder grouping (typically `'/'`). */
+    readonly delimiter?: string;
+}
+/** Response from the `b2_list_file_names` API call. */
+export interface ListFileNamesResponse {
+    /** Array of file versions matching the request. */
+    readonly files: readonly FileVersion[];
+    /** Next file name to use for pagination, or null if all files have been listed. */
+    readonly nextFileName: string | null;
+}
+/** Request parameters for the `b2_list_file_versions` API call. Lists all versions of files in a bucket. */
+export interface ListFileVersionsRequest {
+    /** Bucket to list file versions from. */
+    readonly bucketId: BucketId;
+    /** Return files starting after this name (exclusive). Used for pagination. */
+    readonly startFileName?: string;
+    /** Return file versions starting after this ID. Used with startFileName for pagination. */
+    readonly startFileId?: FileId;
+    /** Maximum number of file versions to return (1 to 10000). */
+    readonly maxFileCount?: number;
+    /** Only return files whose names start with this prefix. */
+    readonly prefix?: string;
+    /** Delimiter for virtual folder grouping (typically `'/'`). */
+    readonly delimiter?: string;
+}
+/** Response from the `b2_list_file_versions` API call. */
+export interface ListFileVersionsResponse {
+    /** Array of file versions matching the request. */
+    readonly files: readonly FileVersion[];
+    /** Next file name to use for pagination, or null if all versions have been listed. */
+    readonly nextFileName: string | null;
+    /** Next file ID to use for pagination, or null if all versions have been listed. */
+    readonly nextFileId: FileId | null;
+}
+/** Request parameters for the `b2_get_file_info` API call. */
+export interface GetFileInfoRequest {
+    /** ID of the file version to retrieve info for. */
+    readonly fileId: FileId;
+}
+/** Request parameters for the `b2_hide_file` API call. Hides a file so it no longer appears in `b2_list_file_names`. */
+export interface HideFileRequest {
+    /** Bucket containing the file to hide. */
+    readonly bucketId: BucketId;
+    /** Name of the file to hide. */
+    readonly fileName: string;
+}
+/** Request parameters for the `b2_delete_file_version` API call. */
+export interface DeleteFileVersionRequest {
+    /** Name of the file version to delete. */
+    readonly fileName: string;
+    /** ID of the file version to delete. */
+    readonly fileId: FileId;
+    /** If true, bypass governance-mode retention. Requires the `bypassGovernance` capability. */
+    readonly bypassGovernance?: boolean;
+}
+/** Response from the `b2_delete_file_version` API call. */
+export interface DeleteFileVersionResponse {
+    /** ID of the deleted file version. */
+    readonly fileId: FileId;
+    /** Name of the deleted file. */
+    readonly fileName: string;
+}
+/**
+ * Named constants for how metadata is handled during a file copy.
+ *
+ * @example
+ * ```ts
+ * await bucket.copyFile({ ..., metadataDirective: MetadataDirective.Replace })
+ * ```
+ */
+export declare const MetadataDirective: {
+    /** Preserve the source file's contentType and fileInfo. */
+    readonly Copy: "COPY";
+    /** Use the values provided in the copy request. */
+    readonly Replace: "REPLACE";
+};
+/** Controls how metadata is handled during a file copy. Derived from {@link MetadataDirective}. */
+export type MetadataDirective = (typeof MetadataDirective)[keyof typeof MetadataDirective];
+/** Request parameters for the `b2_copy_file` API call. Performs a server-side file copy. */
+export interface CopyFileRequest {
+    /** ID of the source file version to copy from. */
+    readonly sourceFileId: FileId;
+    /** Destination bucket ID. Defaults to the source bucket if omitted. */
+    readonly destinationBucketId?: BucketId;
+    /** Name for the destination file. */
+    readonly fileName: string;
+    /** Byte range to copy (e.g., `'bytes=0-999'`). Omit to copy the entire file. */
+    readonly range?: string;
+    /** Whether to copy or replace the source file's metadata. */
+    readonly metadataDirective?: MetadataDirective;
+    /** MIME type for the destination file (only used when metadataDirective is `'REPLACE'`). */
+    readonly contentType?: string;
+    /** User-defined metadata for the destination file (only used when metadataDirective is `'REPLACE'`). */
+    readonly fileInfo?: Record<string, string>;
+    /** Object Lock retention for the destination file. */
+    readonly fileRetention?: FileRetentionValue;
+    /** Legal hold for the destination file. */
+    readonly legalHold?: LegalHoldValue;
+    /** SSE-C settings for reading the source file, if the source is encrypted with SSE-C. */
+    readonly sourceServerSideEncryption?: EncryptionSetting;
+    /** Server-side encryption to apply to the destination file. */
+    readonly destinationServerSideEncryption?: EncryptionSetting;
+}
+/** Request parameters for the `b2_copy_part` API call. Copies a byte range into a large file part. */
+export interface CopyPartRequest {
+    /** ID of the source file version to copy from. */
+    readonly sourceFileId: FileId;
+    /** ID of the large file being assembled. */
+    readonly largeFileId: FileId;
+    /** Part number (1-based) for this part within the large file. */
+    readonly partNumber: number;
+    /** Byte range to copy from the source (e.g., `'bytes=0-999'`). Omit to copy the entire source. */
+    readonly range?: string;
+    /** SSE-C settings for reading the source file, if the source is encrypted with SSE-C. */
+    readonly sourceServerSideEncryption?: EncryptionSetting;
+    /** Server-side encryption to apply to the destination part. */
+    readonly destinationServerSideEncryption?: EncryptionSetting;
+}
+/** Response from the `b2_copy_part` API call. */
+export interface CopyPartResponse {
+    /** ID of the large file this part belongs to. */
+    readonly fileId: FileId;
+    /** Part number within the large file. */
+    readonly partNumber: number;
+    /** Size of the copied part in bytes. */
+    readonly contentLength: number;
+    /** SHA-1 checksum of the copied part content. */
+    readonly contentSha1: string;
+}
+//# sourceMappingURL=file.d.ts.map

package/dist/types/file.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"file.d.ts","sourceRoot":"","sources":["../../src/types/file.js"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAA;AACxD,OAAO,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAC3D,OAAO,KAAK,EAAE,kBAAkB,EAAE,cAAc,EAAE,MAAM,WAAW,CAAA;AAEnE;;;;;;;GAOG;AACH,eAAO,MAAM,UAAU;IACrB,sDAAsD;;IAEtD,oDAAoD;;IAEpD,iCAAiC;;IAEjC,6BAA6B;;IAE7B,oCAAoC;;CAE5B,CAAA;AAEV;;;;;;;;GAQG;AACH,MAAM,MAAM,UAAU,GAAG,CAAC,OAAO,UAAU,CAAC,CAAC,MAAM,OAAO,UAAU,CAAC,CAAA;AAErE;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAC1B,mCAAmC;IACnC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAA;IAC7B,6CAA6C;IAC7C,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAA;IAC3B,mCAAmC;IACnC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;IAC3B,yCAAyC;IACzC,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAA;IAC9B,6DAA6D;IAC7D,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAClC,mFAAmF;IACnF,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IACnC,qCAAqC;IACrC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;IAC5B,+CAA+C;IAC/C,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,4DAA4D;IAC5D,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACzC,wDAAwD;IACxD,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,4DAA4D;IAC5D,QAAQ,CAAC,aAAa,EAAE;QACtB,mEAAmE;QACnE,QAAQ,CAAC,wBAAwB,EAAE,OAAO,CAAA;QAC1C,0EAA0E;QAC1E,QAAQ,CAAC,KAAK,EAAE,kBAAkB,GAAG,IAAI,CAAA;KAC1C,CAAA;IACD,+CAA+C;IAC/C,QAAQ,CAAC,SAAS,EAAE;QAClB,kEAAkE;QAClE,QAAQ,CAAC,wBAAwB,EAAE,OAAO,CAAA;QAC1C,wEAAwE;QACxE,QAAQ,CAAC,KAAK,EAAE,cAAc,GAAG,IAAI,CAAA;KACtC,CAAA;IACD,oEAAoE;IACpE,QAAQ,CAAC,iBAAiB,EAAE,SAAS,GAAG,WAAW,GAAG,QAAQ,GAAG,SAAS,GAAG,IAAI,CAAA;IACjF,oEAAoE;IACpE,QAAQ,CAAC,oBAAoB,EAAE,iBAAiB,CAAA;IAChD,mEAAmE;IACnE,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAA;CACjC;AAED,wHAAwH;AACxH,MAAM,WAAW,oBAAoB;IACnC,iCAAiC;IACjC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;IAC3B,8EAA8E;IAC9E,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAA;IAC/B,sDAAsD;IACtD,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAA;IAC9B,4DAA4D;IAC5D,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IACxB,+DAA+D;IAC/D,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAA;CAC5B;AAED,uDAAuD;AACvD,MAAM,WAAW,qBAAqB;IACpC,mDAAmD;IACnD,QAAQ,CAAC,KAAK,EAAE,SAAS,WAAW,EAAE,CAAA;IACtC,mFAAmF;IACnF,QAAQ,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;CACrC;AAED,4GAA4G;AAC5G,MAAM,WAAW,uBAAuB;IACtC,yCAAyC;IACzC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;IAC3B,8EAA8E;IAC9E,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAA;IAC/B,2FAA2F;IAC3F,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAA;IAC7B,8DAA8D;IAC9D,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAA;IAC9B,4DAA4D;IAC5D,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IACxB,+DAA+D;IAC/D,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAA;CAC5B;AAED,0DAA0D;AAC1D,MAAM,WAAW,wBAAwB;IACvC,mDAAmD;IACnD,QAAQ,CAAC,KAAK,EAAE,SAAS,WAAW,EAAE,CAAA;IACtC,sFAAsF;IACtF,QAAQ,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IACpC,oFAAoF;IACpF,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;CACnC;AAED,8DAA8D;AAC9D,MAAM,WAAW,kBAAkB;IACjC,mDAAmD;IACnD,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;CACxB;AAED,wHAAwH;AACxH,MAAM,WAAW,eAAe;IAC9B,0CAA0C;IAC1C,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;IAC3B,gCAAgC;IAChC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;CAC1B;AAED,oEAAoE;AACpE,MAAM,WAAW,wBAAwB;IACvC,0CAA0C;IAC1C,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,wCAAwC;IACxC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,6FAA6F;IAC7F,QAAQ,CAAC,gBAAgB,CAAC,EAAE,OAAO,CAAA;CACpC;AAED,2DAA2D;AAC3D,MAAM,WAAW,yBAAyB;IACxC,sCAAsC;IACtC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,gCAAgC;IAChC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;CAC1B;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,iBAAiB;IAC5B,2DAA2D;;IAE3D,mDAAmD;;CAE3C,CAAA;AAEV,mGAAmG;AACnG,MAAM,MAAM,iBAAiB,GAAG,CAAC,OAAO,iBAAiB,CAAC,CAAC,MAAM,OAAO,iBAAiB,CAAC,CAAA;AAE1F,4FAA4F;AAC5F,MAAM,WAAW,eAAe;IAC9B,kDAAkD;IAClD,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAA;IAC7B,uEAAuE;IACvE,QAAQ,CAAC,mBAAmB,CAAC,EAAE,QAAQ,CAAA;IACvC,qCAAqC;IACrC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,gFAAgF;IAChF,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;IACvB,6DAA6D;IAC7D,QAAQ,CAAC,iBAAiB,CAAC,EAAE,iBAAiB,CAAA;IAC9C,4FAA4F;IAC5F,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAA;IAC7B,wGAAwG;IACxG,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC1C,sDAAsD;IACtD,QAAQ,CAAC,aAAa,CAAC,EAAE,kBAAkB,CAAA;IAC3C,2CAA2C;IAC3C,QAAQ,CAAC,SAAS,CAAC,EAAE,cAAc,CAAA;IACnC,yFAAyF;IACzF,QAAQ,CAAC,0BAA0B,CAAC,EAAE,iBAAiB,CAAA;IACvD,+DAA+D;IAC/D,QAAQ,CAAC,+BAA+B,CAAC,EAAE,iBAAiB,CAAA;CAC7D;AAED,sGAAsG;AACtG,MAAM,WAAW,eAAe;IAC9B,kDAAkD;IAClD,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAA;IAC7B,4CAA4C;IAC5C,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;IAC5B,iEAAiE;IACjE,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAC3B,kGAAkG;IAClG,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;IACvB,yFAAyF;IACzF,QAAQ,CAAC,0BAA0B,CAAC,EAAE,iBAAiB,CAAA;IACvD,+DAA+D;IAC/D,QAAQ,CAAC,+BAA+B,CAAC,EAAE,iBAAiB,CAAA;CAC7D;AAED,iDAAiD;AACjD,MAAM,WAAW,gBAAgB;IAC/B,iDAAiD;IACjD,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,yCAAyC;IACzC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAC3B,wCAAwC;IACxC,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAA;IAC9B,iDAAiD;IACjD,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;CAC7B"}

package/dist/types/file.js

@@ -0,0 +1,23 @@
+const FileAction = {
+  /** Large file upload started but not yet finished. */
+  Start: "start",
+  /** Normal upload (small or finished large file). */
+  Upload: "upload",
+  /** Hide marker (soft delete). */
+  Hide: "hide",
+  /** Virtual folder marker. */
+  Folder: "folder",
+  /** Created via server-side copy. */
+  Copy: "copy"
+};
+const MetadataDirective = {
+  /** Preserve the source file's contentType and fileInfo. */
+  Copy: "COPY",
+  /** Use the values provided in the copy request. */
+  Replace: "REPLACE"
+};
+export {
+  FileAction,
+  MetadataDirective
+};
+//# sourceMappingURL=file.js.map

package/dist/types/file.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"file.js","sources":["../../src/types/file.ts"],"sourcesContent":["import type { EncryptionSetting } from './encryption.ts'\nimport type { AccountId, BucketId, FileId } from './ids.ts'\nimport type { FileRetentionValue, LegalHoldValue } from './lock.ts'\n\n/**\n * Named constants for the action that created a file version.\n *\n * @example\n * ```ts\n * if (file.action === FileAction.Hide) { ... }\n * ```\n */\nexport const FileAction = {\n  /** Large file upload started but not yet finished. */\n  Start: 'start',\n  /** Normal upload (small or finished large file). */\n  Upload: 'upload',\n  /** Hide marker (soft delete). */\n  Hide: 'hide',\n  /** Virtual folder marker. */\n  Folder: 'folder',\n  /** Created via server-side copy. */\n  Copy: 'copy',\n} as const\n\n/**\n * The action that created a file version. Derived from {@link FileAction}.\n *\n * - `'start'`: large file upload started but not yet finished.\n * - `'upload'`: file was uploaded normally.\n * - `'hide'`: file was hidden (soft-deleted).\n * - `'folder'`: virtual folder marker.\n * - `'copy'`: file was created via server-side copy.\n */\nexport type FileAction = (typeof FileAction)[keyof typeof FileAction]\n\n/**\n * Complete metadata for a single file version in B2.\n * Returned by `b2_get_file_info`, `b2_list_file_names`, `b2_list_file_versions`,\n * `b2_upload_file`, `b2_copy_file`, and other file-related endpoints.\n */\nexport interface FileVersion {\n  /** Account that owns this file. */\n  readonly accountId: AccountId\n  /** Action that created this file version. */\n  readonly action: FileAction\n  /** Bucket containing this file. */\n  readonly bucketId: BucketId\n  /** Size of the file content in bytes. */\n  readonly contentLength: number\n  /** MD5 checksum of the content, or null if not available. */\n  readonly contentMd5: string | null\n  /** SHA-1 checksum of the content, or null if not available (e.g., large files). */\n  readonly contentSha1: string | null\n  /** MIME type of the file content. */\n  readonly contentType: string\n  /** Unique identifier for this file version. */\n  readonly fileId: FileId\n  /** User-defined key-value metadata stored with the file. */\n  readonly fileInfo: Record<string, string>\n  /** Full path and name of the file within the bucket. */\n  readonly fileName: string\n  /** Object Lock retention settings for this file version. */\n  readonly fileRetention: {\n    /** Whether the caller is authorized to read retention settings. */\n    readonly isClientAuthorizedToRead: boolean\n    /** Retention settings, or null if the caller lacks read authorization. */\n    readonly value: FileRetentionValue | null\n  }\n  /** Legal hold status for this file version. */\n  readonly legalHold: {\n    /** Whether the caller is authorized to read legal hold status. */\n    readonly isClientAuthorizedToRead: boolean\n    /** Legal hold value, or null if the caller lacks read authorization. */\n    readonly value: LegalHoldValue | null\n  }\n  /** Replication status, or null if replication is not configured. */\n  readonly replicationStatus: 'pending' | 'completed' | 'failed' | 'replica' | null\n  /** Server-side encryption settings applied to this file version. */\n  readonly serverSideEncryption: EncryptionSetting\n  /** UTC timestamp (milliseconds) when this version was uploaded. */\n  readonly uploadTimestamp: number\n}\n\n/** Request parameters for the `b2_list_file_names` API call. Lists the most recent version of each file in a bucket. */\nexport interface ListFileNamesRequest {\n  /** Bucket to list files from. */\n  readonly bucketId: BucketId\n  /** Return files starting after this name (exclusive). Used for pagination. */\n  readonly startFileName?: string\n  /** Maximum number of files to return (1 to 10000). */\n  readonly maxFileCount?: number\n  /** Only return files whose names start with this prefix. */\n  readonly prefix?: string\n  /** Delimiter for virtual folder grouping (typically `'/'`). */\n  readonly delimiter?: string\n}\n\n/** Response from the `b2_list_file_names` API call. */\nexport interface ListFileNamesResponse {\n  /** Array of file versions matching the request. */\n  readonly files: readonly FileVersion[]\n  /** Next file name to use for pagination, or null if all files have been listed. */\n  readonly nextFileName: string | null\n}\n\n/** Request parameters for the `b2_list_file_versions` API call. Lists all versions of files in a bucket. */\nexport interface ListFileVersionsRequest {\n  /** Bucket to list file versions from. */\n  readonly bucketId: BucketId\n  /** Return files starting after this name (exclusive). Used for pagination. */\n  readonly startFileName?: string\n  /** Return file versions starting after this ID. Used with startFileName for pagination. */\n  readonly startFileId?: FileId\n  /** Maximum number of file versions to return (1 to 10000). */\n  readonly maxFileCount?: number\n  /** Only return files whose names start with this prefix. */\n  readonly prefix?: string\n  /** Delimiter for virtual folder grouping (typically `'/'`). */\n  readonly delimiter?: string\n}\n\n/** Response from the `b2_list_file_versions` API call. */\nexport interface ListFileVersionsResponse {\n  /** Array of file versions matching the request. */\n  readonly files: readonly FileVersion[]\n  /** Next file name to use for pagination, or null if all versions have been listed. */\n  readonly nextFileName: string | null\n  /** Next file ID to use for pagination, or null if all versions have been listed. */\n  readonly nextFileId: FileId | null\n}\n\n/** Request parameters for the `b2_get_file_info` API call. */\nexport interface GetFileInfoRequest {\n  /** ID of the file version to retrieve info for. */\n  readonly fileId: FileId\n}\n\n/** Request parameters for the `b2_hide_file` API call. Hides a file so it no longer appears in `b2_list_file_names`. */\nexport interface HideFileRequest {\n  /** Bucket containing the file to hide. */\n  readonly bucketId: BucketId\n  /** Name of the file to hide. */\n  readonly fileName: string\n}\n\n/** Request parameters for the `b2_delete_file_version` API call. */\nexport interface DeleteFileVersionRequest {\n  /** Name of the file version to delete. */\n  readonly fileName: string\n  /** ID of the file version to delete. */\n  readonly fileId: FileId\n  /** If true, bypass governance-mode retention. Requires the `bypassGovernance` capability. */\n  readonly bypassGovernance?: boolean\n}\n\n/** Response from the `b2_delete_file_version` API call. */\nexport interface DeleteFileVersionResponse {\n  /** ID of the deleted file version. */\n  readonly fileId: FileId\n  /** Name of the deleted file. */\n  readonly fileName: string\n}\n\n/**\n * Named constants for how metadata is handled during a file copy.\n *\n * @example\n * ```ts\n * await bucket.copyFile({ ..., metadataDirective: MetadataDirective.Replace })\n * ```\n */\nexport const MetadataDirective = {\n  /** Preserve the source file's contentType and fileInfo. */\n  Copy: 'COPY',\n  /** Use the values provided in the copy request. */\n  Replace: 'REPLACE',\n} as const\n\n/** Controls how metadata is handled during a file copy. Derived from {@link MetadataDirective}. */\nexport type MetadataDirective = (typeof MetadataDirective)[keyof typeof MetadataDirective]\n\n/** Request parameters for the `b2_copy_file` API call. Performs a server-side file copy. */\nexport interface CopyFileRequest {\n  /** ID of the source file version to copy from. */\n  readonly sourceFileId: FileId\n  /** Destination bucket ID. Defaults to the source bucket if omitted. */\n  readonly destinationBucketId?: BucketId\n  /** Name for the destination file. */\n  readonly fileName: string\n  /** Byte range to copy (e.g., `'bytes=0-999'`). Omit to copy the entire file. */\n  readonly range?: string\n  /** Whether to copy or replace the source file's metadata. */\n  readonly metadataDirective?: MetadataDirective\n  /** MIME type for the destination file (only used when metadataDirective is `'REPLACE'`). */\n  readonly contentType?: string\n  /** User-defined metadata for the destination file (only used when metadataDirective is `'REPLACE'`). */\n  readonly fileInfo?: Record<string, string>\n  /** Object Lock retention for the destination file. */\n  readonly fileRetention?: FileRetentionValue\n  /** Legal hold for the destination file. */\n  readonly legalHold?: LegalHoldValue\n  /** SSE-C settings for reading the source file, if the source is encrypted with SSE-C. */\n  readonly sourceServerSideEncryption?: EncryptionSetting\n  /** Server-side encryption to apply to the destination file. */\n  readonly destinationServerSideEncryption?: EncryptionSetting\n}\n\n/** Request parameters for the `b2_copy_part` API call. Copies a byte range into a large file part. */\nexport interface CopyPartRequest {\n  /** ID of the source file version to copy from. */\n  readonly sourceFileId: FileId\n  /** ID of the large file being assembled. */\n  readonly largeFileId: FileId\n  /** Part number (1-based) for this part within the large file. */\n  readonly partNumber: number\n  /** Byte range to copy from the source (e.g., `'bytes=0-999'`). Omit to copy the entire source. */\n  readonly range?: string\n  /** SSE-C settings for reading the source file, if the source is encrypted with SSE-C. */\n  readonly sourceServerSideEncryption?: EncryptionSetting\n  /** Server-side encryption to apply to the destination part. */\n  readonly destinationServerSideEncryption?: EncryptionSetting\n}\n\n/** Response from the `b2_copy_part` API call. */\nexport interface CopyPartResponse {\n  /** ID of the large file this part belongs to. */\n  readonly fileId: FileId\n  /** Part number within the large file. */\n  readonly partNumber: number\n  /** Size of the copied part in bytes. */\n  readonly contentLength: number\n  /** SHA-1 checksum of the copied part content. */\n  readonly contentSha1: string\n}\n"],"names":[],"mappings":"AAYO,MAAM,aAAa;AAAA;AAAA,EAExB,OAAO;AAAA;AAAA,EAEP,QAAQ;AAAA;AAAA,EAER,MAAM;AAAA;AAAA,EAEN,QAAQ;AAAA;AAAA,EAER,MAAM;AACR;AAqJO,MAAM,oBAAoB;AAAA;AAAA,EAE/B,MAAM;AAAA;AAAA,EAEN,SAAS;AACX;"}

package/dist/types/ids.cjs

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+function accountId(raw) {
+  return raw;
+}
+function bucketId(raw) {
+  return raw;
+}
+function fileId(raw) {
+  return raw;
+}
+function keyId(raw) {
+  return raw;
+}
+function applicationKeyId(raw) {
+  return raw;
+}
+function largeFileId(raw) {
+  return raw;
+}
+exports.accountId = accountId;
+exports.applicationKeyId = applicationKeyId;
+exports.bucketId = bucketId;
+exports.fileId = fileId;
+exports.keyId = keyId;
+exports.largeFileId = largeFileId;
+//# sourceMappingURL=ids.cjs.map

package/dist/types/ids.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ids.cjs","sources":["../../src/types/ids.ts"],"sourcesContent":["/**\n * Unique symbol used to brand string types, preventing accidental mixing of different ID types.\n */\ndeclare const __brand: unique symbol\n\n/** Compile-time brand tag interface. Never instantiated at runtime. */\nexport interface BrandTag<B extends string> {\n  /** Discriminant tag that makes branded types structurally incompatible. */\n  readonly [__brand]: B\n}\n\n/**\n * Utility type that intersects a base type with a branded tag.\n * This pattern ensures that branded types are structurally incompatible with each other\n * even though they share the same underlying representation.\n */\nexport type Brand<T, B extends string> = T & BrandTag<B>\n\n/** Unique identifier for a B2 account. Branded to prevent mixing with other string IDs. */\nexport type AccountId = Brand<string, 'AccountId'>\n\n/** Unique identifier for a B2 bucket. Branded to prevent mixing with other string IDs. */\nexport type BucketId = Brand<string, 'BucketId'>\n\n/** Unique identifier for a B2 file version. Branded to prevent mixing with other string IDs. */\nexport type FileId = Brand<string, 'FileId'>\n\n/** Unique identifier for a B2 application key. Branded to prevent mixing with other string IDs. */\nexport type KeyId = Brand<string, 'KeyId'>\n\n/** Unique identifier for a B2 application key, as returned by the API. Branded to prevent mixing with other string IDs. */\nexport type ApplicationKeyId = Brand<string, 'ApplicationKeyId'>\n\n/** Pre-signed URL for uploading files to a specific bucket. Branded to prevent misuse as a regular string. */\nexport type UploadUrl = Brand<string, 'UploadUrl'>\n\n/** Authorization token scoped to a specific upload URL. Branded to prevent mixing with other tokens. */\nexport type UploadAuthToken = Brand<string, 'UploadAuthToken'>\n\n/** Authorization token for B2 API requests. Branded to prevent mixing with other string values. */\nexport type AuthToken = Brand<string, 'AuthToken'>\n\n/** Unique identifier for a large file upload in progress. Branded to prevent mixing with regular FileId values. */\nexport type LargeFileId = Brand<string, 'LargeFileId'>\n\n/**\n * Creates a branded {@link AccountId} from a raw string.\n * @param raw - The raw account ID string from the B2 API.\n *\n * @returns A branded AccountId value.\n */\nexport function accountId(raw: string): AccountId {\n  return raw as AccountId\n}\n\n/**\n * Creates a branded {@link BucketId} from a raw string.\n * @param raw - The raw bucket ID string from the B2 API.\n *\n * @returns A branded BucketId value.\n */\nexport function bucketId(raw: string): BucketId {\n  return raw as BucketId\n}\n\n/**\n * Creates a branded {@link FileId} from a raw string.\n * @param raw - The raw file ID string from the B2 API.\n *\n * @returns A branded FileId value.\n */\nexport function fileId(raw: string): FileId {\n  return raw as FileId\n}\n\n/**\n * Creates a branded {@link KeyId} from a raw string.\n * @param raw - The raw key ID string from the B2 API.\n *\n * @returns A branded KeyId value.\n */\nexport function keyId(raw: string): KeyId {\n  return raw as KeyId\n}\n\n/**\n * Creates a branded {@link ApplicationKeyId} from a raw string.\n * @param raw - The raw application key ID string from the B2 API.\n *\n * @returns A branded ApplicationKeyId value.\n */\nexport function applicationKeyId(raw: string): ApplicationKeyId {\n  return raw as ApplicationKeyId\n}\n\n/**\n * Creates a branded {@link LargeFileId} from a raw string.\n *\n * `LargeFileId` is the same wire-level shape as `FileId` but is a\n * distinct brand so that \"ID of an in-progress multipart upload\" and\n * \"ID of a committed file version\" don't get mixed up by accident.\n * `b2_start_large_file` returns one; `b2_finish_large_file` consumes it\n * and produces a regular `FileId`.\n *\n * @param raw - The raw large-file ID string from the B2 API.\n *\n * @returns A branded LargeFileId value.\n */\nexport function largeFileId(raw: string): LargeFileId {\n  return raw as LargeFileId\n}\n"],"names":[],"mappings":";;AAmDO,SAAS,UAAU,KAAwB;AAChD,SAAO;AACT;AAQO,SAAS,SAAS,KAAuB;AAC9C,SAAO;AACT;AAQO,SAAS,OAAO,KAAqB;AAC1C,SAAO;AACT;AAQO,SAAS,MAAM,KAAoB;AACxC,SAAO;AACT;AAQO,SAAS,iBAAiB,KAA+B;AAC9D,SAAO;AACT;AAeO,SAAS,YAAY,KAA0B;AACpD,SAAO;AACT;;;;;;;"}