@backblaze-labs/b2-sdk 0.1.0

package/dist/types/ids.d.cts

@@ -0,0 +1,84 @@
+/**
+ * Unique symbol used to brand string types, preventing accidental mixing of different ID types.
+ */
+declare const __brand: unique symbol;
+/** Compile-time brand tag interface. Never instantiated at runtime. */
+export interface BrandTag<B extends string> {
+    /** Discriminant tag that makes branded types structurally incompatible. */
+    readonly [__brand]: B;
+}
+/**
+ * Utility type that intersects a base type with a branded tag.
+ * This pattern ensures that branded types are structurally incompatible with each other
+ * even though they share the same underlying representation.
+ */
+export type Brand<T, B extends string> = T & BrandTag<B>;
+/** Unique identifier for a B2 account. Branded to prevent mixing with other string IDs. */
+export type AccountId = Brand<string, 'AccountId'>;
+/** Unique identifier for a B2 bucket. Branded to prevent mixing with other string IDs. */
+export type BucketId = Brand<string, 'BucketId'>;
+/** Unique identifier for a B2 file version. Branded to prevent mixing with other string IDs. */
+export type FileId = Brand<string, 'FileId'>;
+/** Unique identifier for a B2 application key. Branded to prevent mixing with other string IDs. */
+export type KeyId = Brand<string, 'KeyId'>;
+/** Unique identifier for a B2 application key, as returned by the API. Branded to prevent mixing with other string IDs. */
+export type ApplicationKeyId = Brand<string, 'ApplicationKeyId'>;
+/** Pre-signed URL for uploading files to a specific bucket. Branded to prevent misuse as a regular string. */
+export type UploadUrl = Brand<string, 'UploadUrl'>;
+/** Authorization token scoped to a specific upload URL. Branded to prevent mixing with other tokens. */
+export type UploadAuthToken = Brand<string, 'UploadAuthToken'>;
+/** Authorization token for B2 API requests. Branded to prevent mixing with other string values. */
+export type AuthToken = Brand<string, 'AuthToken'>;
+/** Unique identifier for a large file upload in progress. Branded to prevent mixing with regular FileId values. */
+export type LargeFileId = Brand<string, 'LargeFileId'>;
+/**
+ * Creates a branded {@link AccountId} from a raw string.
+ * @param raw - The raw account ID string from the B2 API.
+ *
+ * @returns A branded AccountId value.
+ */
+export declare function accountId(raw: string): AccountId;
+/**
+ * Creates a branded {@link BucketId} from a raw string.
+ * @param raw - The raw bucket ID string from the B2 API.
+ *
+ * @returns A branded BucketId value.
+ */
+export declare function bucketId(raw: string): BucketId;
+/**
+ * Creates a branded {@link FileId} from a raw string.
+ * @param raw - The raw file ID string from the B2 API.
+ *
+ * @returns A branded FileId value.
+ */
+export declare function fileId(raw: string): FileId;
+/**
+ * Creates a branded {@link KeyId} from a raw string.
+ * @param raw - The raw key ID string from the B2 API.
+ *
+ * @returns A branded KeyId value.
+ */
+export declare function keyId(raw: string): KeyId;
+/**
+ * Creates a branded {@link ApplicationKeyId} from a raw string.
+ * @param raw - The raw application key ID string from the B2 API.
+ *
+ * @returns A branded ApplicationKeyId value.
+ */
+export declare function applicationKeyId(raw: string): ApplicationKeyId;
+/**
+ * Creates a branded {@link LargeFileId} from a raw string.
+ *
+ * `LargeFileId` is the same wire-level shape as `FileId` but is a
+ * distinct brand so that "ID of an in-progress multipart upload" and
+ * "ID of a committed file version" don't get mixed up by accident.
+ * `b2_start_large_file` returns one; `b2_finish_large_file` consumes it
+ * and produces a regular `FileId`.
+ *
+ * @param raw - The raw large-file ID string from the B2 API.
+ *
+ * @returns A branded LargeFileId value.
+ */
+export declare function largeFileId(raw: string): LargeFileId;
+export {};
+//# sourceMappingURL=ids.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ids.d.ts","sourceRoot":"","sources":["../../src/types/ids.js"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,CAAC,MAAM,OAAO,EAAE,OAAO,MAAM,CAAA;AAEpC,uEAAuE;AACvE,MAAM,WAAW,QAAQ,CAAC,CAAC,SAAS,MAAM;IACxC,2EAA2E;IAC3E,QAAQ,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;CACtB;AAED;;;;GAIG;AACH,MAAM,MAAM,KAAK,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,IAAI,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAA;AAExD,2FAA2F;AAC3F,MAAM,MAAM,SAAS,GAAG,KAAK,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;AAElD,0FAA0F;AAC1F,MAAM,MAAM,QAAQ,GAAG,KAAK,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;AAEhD,gGAAgG;AAChG,MAAM,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAA;AAE5C,mGAAmG;AACnG,MAAM,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAE1C,2HAA2H;AAC3H,MAAM,MAAM,gBAAgB,GAAG,KAAK,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAA;AAEhE,8GAA8G;AAC9G,MAAM,MAAM,SAAS,GAAG,KAAK,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;AAElD,wGAAwG;AACxG,MAAM,MAAM,eAAe,GAAG,KAAK,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAA;AAE9D,mGAAmG;AACnG,MAAM,MAAM,SAAS,GAAG,KAAK,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;AAElD,mHAAmH;AACnH,MAAM,MAAM,WAAW,GAAG,KAAK,CAAC,MAAM,EAAE,aAAa,CAAC,CAAA;AAEtD;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,CAEhD;AAED;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,QAAQ,CAE9C;AAED;;;;;GAKG;AACH,wBAAgB,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE1C;AAED;;;;;GAKG;AACH,wBAAgB,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,KAAK,CAExC;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,gBAAgB,CAE9D;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,WAAW,CAEpD"}

package/dist/types/ids.d.ts

@@ -0,0 +1,84 @@
+/**
+ * Unique symbol used to brand string types, preventing accidental mixing of different ID types.
+ */
+declare const __brand: unique symbol;
+/** Compile-time brand tag interface. Never instantiated at runtime. */
+export interface BrandTag<B extends string> {
+    /** Discriminant tag that makes branded types structurally incompatible. */
+    readonly [__brand]: B;
+}
+/**
+ * Utility type that intersects a base type with a branded tag.
+ * This pattern ensures that branded types are structurally incompatible with each other
+ * even though they share the same underlying representation.
+ */
+export type Brand<T, B extends string> = T & BrandTag<B>;
+/** Unique identifier for a B2 account. Branded to prevent mixing with other string IDs. */
+export type AccountId = Brand<string, 'AccountId'>;
+/** Unique identifier for a B2 bucket. Branded to prevent mixing with other string IDs. */
+export type BucketId = Brand<string, 'BucketId'>;
+/** Unique identifier for a B2 file version. Branded to prevent mixing with other string IDs. */
+export type FileId = Brand<string, 'FileId'>;
+/** Unique identifier for a B2 application key. Branded to prevent mixing with other string IDs. */
+export type KeyId = Brand<string, 'KeyId'>;
+/** Unique identifier for a B2 application key, as returned by the API. Branded to prevent mixing with other string IDs. */
+export type ApplicationKeyId = Brand<string, 'ApplicationKeyId'>;
+/** Pre-signed URL for uploading files to a specific bucket. Branded to prevent misuse as a regular string. */
+export type UploadUrl = Brand<string, 'UploadUrl'>;
+/** Authorization token scoped to a specific upload URL. Branded to prevent mixing with other tokens. */
+export type UploadAuthToken = Brand<string, 'UploadAuthToken'>;
+/** Authorization token for B2 API requests. Branded to prevent mixing with other string values. */
+export type AuthToken = Brand<string, 'AuthToken'>;
+/** Unique identifier for a large file upload in progress. Branded to prevent mixing with regular FileId values. */
+export type LargeFileId = Brand<string, 'LargeFileId'>;
+/**
+ * Creates a branded {@link AccountId} from a raw string.
+ * @param raw - The raw account ID string from the B2 API.
+ *
+ * @returns A branded AccountId value.
+ */
+export declare function accountId(raw: string): AccountId;
+/**
+ * Creates a branded {@link BucketId} from a raw string.
+ * @param raw - The raw bucket ID string from the B2 API.
+ *
+ * @returns A branded BucketId value.
+ */
+export declare function bucketId(raw: string): BucketId;
+/**
+ * Creates a branded {@link FileId} from a raw string.
+ * @param raw - The raw file ID string from the B2 API.
+ *
+ * @returns A branded FileId value.
+ */
+export declare function fileId(raw: string): FileId;
+/**
+ * Creates a branded {@link KeyId} from a raw string.
+ * @param raw - The raw key ID string from the B2 API.
+ *
+ * @returns A branded KeyId value.
+ */
+export declare function keyId(raw: string): KeyId;
+/**
+ * Creates a branded {@link ApplicationKeyId} from a raw string.
+ * @param raw - The raw application key ID string from the B2 API.
+ *
+ * @returns A branded ApplicationKeyId value.
+ */
+export declare function applicationKeyId(raw: string): ApplicationKeyId;
+/**
+ * Creates a branded {@link LargeFileId} from a raw string.
+ *
+ * `LargeFileId` is the same wire-level shape as `FileId` but is a
+ * distinct brand so that "ID of an in-progress multipart upload" and
+ * "ID of a committed file version" don't get mixed up by accident.
+ * `b2_start_large_file` returns one; `b2_finish_large_file` consumes it
+ * and produces a regular `FileId`.
+ *
+ * @param raw - The raw large-file ID string from the B2 API.
+ *
+ * @returns A branded LargeFileId value.
+ */
+export declare function largeFileId(raw: string): LargeFileId;
+export {};
+//# sourceMappingURL=ids.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ids.d.ts","sourceRoot":"","sources":["../../src/types/ids.js"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,CAAC,MAAM,OAAO,EAAE,OAAO,MAAM,CAAA;AAEpC,uEAAuE;AACvE,MAAM,WAAW,QAAQ,CAAC,CAAC,SAAS,MAAM;IACxC,2EAA2E;IAC3E,QAAQ,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;CACtB;AAED;;;;GAIG;AACH,MAAM,MAAM,KAAK,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,IAAI,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAA;AAExD,2FAA2F;AAC3F,MAAM,MAAM,SAAS,GAAG,KAAK,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;AAElD,0FAA0F;AAC1F,MAAM,MAAM,QAAQ,GAAG,KAAK,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;AAEhD,gGAAgG;AAChG,MAAM,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAA;AAE5C,mGAAmG;AACnG,MAAM,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAE1C,2HAA2H;AAC3H,MAAM,MAAM,gBAAgB,GAAG,KAAK,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAA;AAEhE,8GAA8G;AAC9G,MAAM,MAAM,SAAS,GAAG,KAAK,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;AAElD,wGAAwG;AACxG,MAAM,MAAM,eAAe,GAAG,KAAK,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAA;AAE9D,mGAAmG;AACnG,MAAM,MAAM,SAAS,GAAG,KAAK,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;AAElD,mHAAmH;AACnH,MAAM,MAAM,WAAW,GAAG,KAAK,CAAC,MAAM,EAAE,aAAa,CAAC,CAAA;AAEtD;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,CAEhD;AAED;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,QAAQ,CAE9C;AAED;;;;;GAKG;AACH,wBAAgB,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE1C;AAED;;;;;GAKG;AACH,wBAAgB,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,KAAK,CAExC;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,gBAAgB,CAE9D;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,WAAW,CAEpD"}

package/dist/types/ids.js

@@ -0,0 +1,27 @@
+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;
+}
+export {
+  accountId,
+  applicationKeyId,
+  bucketId,
+  fileId,
+  keyId,
+  largeFileId
+};
+//# sourceMappingURL=ids.js.map

package/dist/types/ids.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ids.js","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;"}

package/dist/types/index.d.cts

@@ -0,0 +1,25 @@
+/**
+ * @packageDocumentation
+ * Public type definitions for the B2 SDK.
+ * Re-exports all branded IDs, request/response interfaces, and configuration types.
+ */
+export type { AccountId, ApplicationKeyId, AuthToken, Brand, BrandTag, BucketId, FileId, KeyId, LargeFileId, UploadAuthToken, UploadUrl, } from './ids.js';
+export { accountId, applicationKeyId, bucketId, fileId, keyId, largeFileId } from './ids.js';
+export type { AllowedInfo, ApiInfo, AuthorizeAccountRequest, AuthorizeAccountResponse, GroupsApiInfo, StorageApiInfo, } from './auth.js';
+export { Capability } from './auth.js';
+export type { BucketInfo, BucketRetentionPolicy, RetentionPeriod, CorsRule, CreateBucketRequest, DeleteBucketRequest, LifecycleRule, ListBucketsRequest, ListBucketsResponse, UpdateBucketRequest, } from './bucket.js';
+export { BucketRetentionMode, BucketType, CorsOperation } from './bucket.js';
+export type { CopyFileRequest, CopyPartRequest, CopyPartResponse, DeleteFileVersionRequest, DeleteFileVersionResponse, FileVersion, GetFileInfoRequest, HideFileRequest, ListFileNamesRequest, ListFileNamesResponse, ListFileVersionsRequest, ListFileVersionsResponse, } from './file.js';
+export { FileAction, MetadataDirective } from './file.js';
+export type { CancelLargeFileRequest, CancelLargeFileResponse, FinishLargeFileRequest, GetUploadPartUrlRequest, GetUploadPartUrlResponse, GetUploadUrlRequest, GetUploadUrlResponse, ListPartsRequest, ListPartsResponse, ListUnfinishedLargeFilesRequest, ListUnfinishedLargeFilesResponse, PartInfo, StartLargeFileRequest, StartLargeFileResponse, UnfinishedLargeFile, UploadFileHeaders, UploadPartHeaders, UploadPartResponse, } from './upload.js';
+export type { DownloadAuthorizationRequest, DownloadAuthorizationResponse, DownloadByIdRequest, DownloadByNameRequest, DownloadHeaders, } from './download.js';
+export type { EncryptionSetting, NoEncryption, SseB2Setting, SseCCustomerSetting, } from './encryption.js';
+export { EncryptionAlgorithm, EncryptionKey, EncryptionMode, SSE_B2, SSE_NONE, sseCustomer, } from './encryption.js';
+export type { FileRetentionValue, UpdateFileLegalHoldRequest, UpdateFileLegalHoldResponse, UpdateFileRetentionRequest, UpdateFileRetentionResponse, } from './lock.js';
+export { LegalHoldValue, RetentionMode } from './lock.js';
+export type { ApplicationKey, CreateKeyRequest, DeleteKeyRequest, FullApplicationKey, ListKeysRequest, ListKeysResponse, } from './key.js';
+export type { ReplicationConfiguration, ReplicationDestination, ReplicationRule, ReplicationSource, } from './replication.js';
+export type { EventNotificationRule, GetBucketNotificationRulesRequest, GetBucketNotificationRulesResponse, SetBucketNotificationRulesRequest, SetBucketNotificationRulesResponse, } from './notifications.js';
+export { EventType } from './notifications.js';
+export type { B2ErrorCode, B2ErrorResponse } from './errors.js';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.js"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,YAAY,EACV,SAAS,EACT,gBAAgB,EAChB,SAAS,EACT,KAAK,EACL,QAAQ,EACR,QAAQ,EACR,MAAM,EACN,KAAK,EACL,WAAW,EACX,eAAe,EACf,SAAS,GACV,MAAM,UAAU,CAAA;AACjB,OAAO,EAAE,SAAS,EAAE,gBAAgB,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,UAAU,CAAA;AAE5F,YAAY,EACV,WAAW,EACX,OAAO,EACP,uBAAuB,EACvB,wBAAwB,EACxB,aAAa,EACb,cAAc,GACf,MAAM,WAAW,CAAA;AAGlB,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA;AAEtC,YAAY,EACV,UAAU,EACV,qBAAqB,EACrB,eAAe,EACf,QAAQ,EACR,mBAAmB,EACnB,mBAAmB,EACnB,aAAa,EACb,kBAAkB,EAClB,mBAAmB,EACnB,mBAAmB,GACpB,MAAM,aAAa,CAAA;AAGpB,OAAO,EAAE,mBAAmB,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAE5E,YAAY,EACV,eAAe,EACf,eAAe,EACf,gBAAgB,EAChB,wBAAwB,EACxB,yBAAyB,EACzB,WAAW,EACX,kBAAkB,EAClB,eAAe,EACf,oBAAoB,EACpB,qBAAqB,EACrB,uBAAuB,EACvB,wBAAwB,GACzB,MAAM,WAAW,CAAA;AAElB,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAA;AAEzD,YAAY,EACV,sBAAsB,EACtB,uBAAuB,EACvB,sBAAsB,EACtB,uBAAuB,EACvB,wBAAwB,EACxB,mBAAmB,EACnB,oBAAoB,EACpB,gBAAgB,EAChB,iBAAiB,EACjB,+BAA+B,EAC/B,gCAAgC,EAChC,QAAQ,EACR,qBAAqB,EACrB,sBAAsB,EACtB,mBAAmB,EACnB,iBAAiB,EACjB,iBAAiB,EACjB,kBAAkB,GACnB,MAAM,aAAa,CAAA;AAEpB,YAAY,EACV,4BAA4B,EAC5B,6BAA6B,EAC7B,mBAAmB,EACnB,qBAAqB,EACrB,eAAe,GAChB,MAAM,eAAe,CAAA;AAEtB,YAAY,EACV,iBAAiB,EACjB,YAAY,EACZ,YAAY,EACZ,mBAAmB,GACpB,MAAM,iBAAiB,CAAA;AAExB,OAAO,EACL,mBAAmB,EACnB,aAAa,EACb,cAAc,EACd,MAAM,EACN,QAAQ,EACR,WAAW,GACZ,MAAM,iBAAiB,CAAA;AAExB,YAAY,EACV,kBAAkB,EAClB,0BAA0B,EAC1B,2BAA2B,EAC3B,0BAA0B,EAC1B,2BAA2B,GAC5B,MAAM,WAAW,CAAA;AAElB,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,WAAW,CAAA;AAEzD,YAAY,EACV,cAAc,EACd,gBAAgB,EAChB,gBAAgB,EAChB,kBAAkB,EAClB,eAAe,EACf,gBAAgB,GACjB,MAAM,UAAU,CAAA;AAEjB,YAAY,EACV,wBAAwB,EACxB,sBAAsB,EACtB,eAAe,EACf,iBAAiB,GAClB,MAAM,kBAAkB,CAAA;AAEzB,YAAY,EACV,qBAAqB,EACrB,iCAAiC,EACjC,kCAAkC,EAClC,iCAAiC,EACjC,kCAAkC,GACnC,MAAM,oBAAoB,CAAA;AAE3B,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAE9C,YAAY,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA"}

package/dist/types/index.d.ts

@@ -0,0 +1,25 @@
+/**
+ * @packageDocumentation
+ * Public type definitions for the B2 SDK.
+ * Re-exports all branded IDs, request/response interfaces, and configuration types.
+ */
+export type { AccountId, ApplicationKeyId, AuthToken, Brand, BrandTag, BucketId, FileId, KeyId, LargeFileId, UploadAuthToken, UploadUrl, } from './ids.js';
+export { accountId, applicationKeyId, bucketId, fileId, keyId, largeFileId } from './ids.js';
+export type { AllowedInfo, ApiInfo, AuthorizeAccountRequest, AuthorizeAccountResponse, GroupsApiInfo, StorageApiInfo, } from './auth.js';
+export { Capability } from './auth.js';
+export type { BucketInfo, BucketRetentionPolicy, RetentionPeriod, CorsRule, CreateBucketRequest, DeleteBucketRequest, LifecycleRule, ListBucketsRequest, ListBucketsResponse, UpdateBucketRequest, } from './bucket.js';
+export { BucketRetentionMode, BucketType, CorsOperation } from './bucket.js';
+export type { CopyFileRequest, CopyPartRequest, CopyPartResponse, DeleteFileVersionRequest, DeleteFileVersionResponse, FileVersion, GetFileInfoRequest, HideFileRequest, ListFileNamesRequest, ListFileNamesResponse, ListFileVersionsRequest, ListFileVersionsResponse, } from './file.js';
+export { FileAction, MetadataDirective } from './file.js';
+export type { CancelLargeFileRequest, CancelLargeFileResponse, FinishLargeFileRequest, GetUploadPartUrlRequest, GetUploadPartUrlResponse, GetUploadUrlRequest, GetUploadUrlResponse, ListPartsRequest, ListPartsResponse, ListUnfinishedLargeFilesRequest, ListUnfinishedLargeFilesResponse, PartInfo, StartLargeFileRequest, StartLargeFileResponse, UnfinishedLargeFile, UploadFileHeaders, UploadPartHeaders, UploadPartResponse, } from './upload.js';
+export type { DownloadAuthorizationRequest, DownloadAuthorizationResponse, DownloadByIdRequest, DownloadByNameRequest, DownloadHeaders, } from './download.js';
+export type { EncryptionSetting, NoEncryption, SseB2Setting, SseCCustomerSetting, } from './encryption.js';
+export { EncryptionAlgorithm, EncryptionKey, EncryptionMode, SSE_B2, SSE_NONE, sseCustomer, } from './encryption.js';
+export type { FileRetentionValue, UpdateFileLegalHoldRequest, UpdateFileLegalHoldResponse, UpdateFileRetentionRequest, UpdateFileRetentionResponse, } from './lock.js';
+export { LegalHoldValue, RetentionMode } from './lock.js';
+export type { ApplicationKey, CreateKeyRequest, DeleteKeyRequest, FullApplicationKey, ListKeysRequest, ListKeysResponse, } from './key.js';
+export type { ReplicationConfiguration, ReplicationDestination, ReplicationRule, ReplicationSource, } from './replication.js';
+export type { EventNotificationRule, GetBucketNotificationRulesRequest, GetBucketNotificationRulesResponse, SetBucketNotificationRulesRequest, SetBucketNotificationRulesResponse, } from './notifications.js';
+export { EventType } from './notifications.js';
+export type { B2ErrorCode, B2ErrorResponse } from './errors.js';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.js"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,YAAY,EACV,SAAS,EACT,gBAAgB,EAChB,SAAS,EACT,KAAK,EACL,QAAQ,EACR,QAAQ,EACR,MAAM,EACN,KAAK,EACL,WAAW,EACX,eAAe,EACf,SAAS,GACV,MAAM,UAAU,CAAA;AACjB,OAAO,EAAE,SAAS,EAAE,gBAAgB,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,UAAU,CAAA;AAE5F,YAAY,EACV,WAAW,EACX,OAAO,EACP,uBAAuB,EACvB,wBAAwB,EACxB,aAAa,EACb,cAAc,GACf,MAAM,WAAW,CAAA;AAGlB,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA;AAEtC,YAAY,EACV,UAAU,EACV,qBAAqB,EACrB,eAAe,EACf,QAAQ,EACR,mBAAmB,EACnB,mBAAmB,EACnB,aAAa,EACb,kBAAkB,EAClB,mBAAmB,EACnB,mBAAmB,GACpB,MAAM,aAAa,CAAA;AAGpB,OAAO,EAAE,mBAAmB,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAE5E,YAAY,EACV,eAAe,EACf,eAAe,EACf,gBAAgB,EAChB,wBAAwB,EACxB,yBAAyB,EACzB,WAAW,EACX,kBAAkB,EAClB,eAAe,EACf,oBAAoB,EACpB,qBAAqB,EACrB,uBAAuB,EACvB,wBAAwB,GACzB,MAAM,WAAW,CAAA;AAElB,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAA;AAEzD,YAAY,EACV,sBAAsB,EACtB,uBAAuB,EACvB,sBAAsB,EACtB,uBAAuB,EACvB,wBAAwB,EACxB,mBAAmB,EACnB,oBAAoB,EACpB,gBAAgB,EAChB,iBAAiB,EACjB,+BAA+B,EAC/B,gCAAgC,EAChC,QAAQ,EACR,qBAAqB,EACrB,sBAAsB,EACtB,mBAAmB,EACnB,iBAAiB,EACjB,iBAAiB,EACjB,kBAAkB,GACnB,MAAM,aAAa,CAAA;AAEpB,YAAY,EACV,4BAA4B,EAC5B,6BAA6B,EAC7B,mBAAmB,EACnB,qBAAqB,EACrB,eAAe,GAChB,MAAM,eAAe,CAAA;AAEtB,YAAY,EACV,iBAAiB,EACjB,YAAY,EACZ,YAAY,EACZ,mBAAmB,GACpB,MAAM,iBAAiB,CAAA;AAExB,OAAO,EACL,mBAAmB,EACnB,aAAa,EACb,cAAc,EACd,MAAM,EACN,QAAQ,EACR,WAAW,GACZ,MAAM,iBAAiB,CAAA;AAExB,YAAY,EACV,kBAAkB,EAClB,0BAA0B,EAC1B,2BAA2B,EAC3B,0BAA0B,EAC1B,2BAA2B,GAC5B,MAAM,WAAW,CAAA;AAElB,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,WAAW,CAAA;AAEzD,YAAY,EACV,cAAc,EACd,gBAAgB,EAChB,gBAAgB,EAChB,kBAAkB,EAClB,eAAe,EACf,gBAAgB,GACjB,MAAM,UAAU,CAAA;AAEjB,YAAY,EACV,wBAAwB,EACxB,sBAAsB,EACtB,eAAe,EACf,iBAAiB,GAClB,MAAM,kBAAkB,CAAA;AAEzB,YAAY,EACV,qBAAqB,EACrB,iCAAiC,EACjC,kCAAkC,EAClC,iCAAiC,EACjC,kCAAkC,GACnC,MAAM,oBAAoB,CAAA;AAE3B,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAE9C,YAAY,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA"}

package/dist/types/key.d.cts

@@ -0,0 +1,84 @@
+import { Capability } from './auth.js';
+import { AccountId, ApplicationKeyId, BucketId } from './ids.js';
+/** Request parameters for the `b2_create_key` API call. Creates a new application key. */
+export interface CreateKeyRequest {
+    /** Account to create the key for. */
+    readonly accountId: AccountId;
+    /** Capabilities to grant to the new key. */
+    readonly capabilities: readonly Capability[];
+    /** Human-readable name for the key (must be unique within the account). */
+    readonly keyName: string;
+    /** Optional duration in seconds before the key expires. Omit for a key that never expires. */
+    readonly validDurationInSeconds?: number;
+    /** Optional bucket restriction. When set, the key only grants access to this bucket. */
+    readonly bucketId?: BucketId;
+    /** Optional file name prefix restriction. When set, the key only grants access to files with this prefix. */
+    readonly namePrefix?: string;
+}
+/**
+ * Full application key including the secret, returned only at creation time by `b2_create_key`.
+ * The `applicationKey` secret is never returned again after this response.
+ */
+export interface FullApplicationKey {
+    /** Human-readable name of the key. */
+    readonly keyName: string;
+    /** Unique identifier for the application key. */
+    readonly applicationKeyId: ApplicationKeyId;
+    /** The secret key value. Only available in the `b2_create_key` response. */
+    readonly applicationKey: string;
+    /** Capabilities granted to this key. */
+    readonly capabilities: readonly Capability[];
+    /** Account that owns this key. */
+    readonly accountId: AccountId;
+    /** UTC timestamp (milliseconds) when this key expires, or null if it does not expire. */
+    readonly expirationTimestamp: number | null;
+    /** Bucket ID this key is restricted to, or null if unrestricted. */
+    readonly bucketId: BucketId | null;
+    /** File name prefix this key is restricted to, or null if unrestricted. */
+    readonly namePrefix: string | null;
+    /** Set of options enabled on this key. */
+    readonly options: readonly string[];
+}
+/**
+ * Application key metadata (without the secret) as returned by `b2_list_keys`.
+ */
+export interface ApplicationKey {
+    /** Human-readable name of the key. */
+    readonly keyName: string;
+    /** Unique identifier for the application key. */
+    readonly applicationKeyId: ApplicationKeyId;
+    /** Capabilities granted to this key. */
+    readonly capabilities: readonly Capability[];
+    /** Account that owns this key. */
+    readonly accountId: AccountId;
+    /** UTC timestamp (milliseconds) when this key expires, or null if it does not expire. */
+    readonly expirationTimestamp: number | null;
+    /** Bucket ID this key is restricted to, or null if unrestricted. */
+    readonly bucketId: BucketId | null;
+    /** File name prefix this key is restricted to, or null if unrestricted. */
+    readonly namePrefix: string | null;
+    /** Set of options enabled on this key. */
+    readonly options: readonly string[];
+}
+/** Request parameters for the `b2_list_keys` API call. */
+export interface ListKeysRequest {
+    /** Account whose keys to list. */
+    readonly accountId: AccountId;
+    /** Maximum number of keys to return per request. */
+    readonly maxKeyCount?: number;
+    /** Application key ID to start listing from (exclusive). Used for pagination. */
+    readonly startApplicationKeyId?: ApplicationKeyId;
+}
+/** Response from the `b2_list_keys` API call. */
+export interface ListKeysResponse {
+    /** Array of application keys (without secrets). */
+    readonly keys: readonly ApplicationKey[];
+    /** Next application key ID to use for pagination, or null if all keys have been listed. */
+    readonly nextApplicationKeyId: ApplicationKeyId | null;
+}
+/** Request parameters for the `b2_delete_key` API call. */
+export interface DeleteKeyRequest {
+    /** ID of the application key to delete. */
+    readonly applicationKeyId: ApplicationKeyId;
+}
+//# sourceMappingURL=key.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"key.d.ts","sourceRoot":"","sources":["../../src/types/key.js"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA;AAC3C,OAAO,KAAK,EAAE,SAAS,EAAE,gBAAgB,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAA;AAErE,0FAA0F;AAC1F,MAAM,WAAW,gBAAgB;IAC/B,qCAAqC;IACrC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAA;IAC7B,4CAA4C;IAC5C,QAAQ,CAAC,YAAY,EAAE,SAAS,UAAU,EAAE,CAAA;IAC5C,2EAA2E;IAC3E,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB,8FAA8F;IAC9F,QAAQ,CAAC,sBAAsB,CAAC,EAAE,MAAM,CAAA;IACxC,wFAAwF;IACxF,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAA;IAC5B,6GAA6G;IAC7G,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAA;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,sCAAsC;IACtC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB,iDAAiD;IACjD,QAAQ,CAAC,gBAAgB,EAAE,gBAAgB,CAAA;IAC3C,4EAA4E;IAC5E,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAA;IAC/B,wCAAwC;IACxC,QAAQ,CAAC,YAAY,EAAE,SAAS,UAAU,EAAE,CAAA;IAC5C,kCAAkC;IAClC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAA;IAC7B,yFAAyF;IACzF,QAAQ,CAAC,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3C,oEAAoE;IACpE,QAAQ,CAAC,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAAA;IAClC,2EAA2E;IAC3E,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAClC,0CAA0C;IAC1C,QAAQ,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,CAAA;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,sCAAsC;IACtC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB,iDAAiD;IACjD,QAAQ,CAAC,gBAAgB,EAAE,gBAAgB,CAAA;IAC3C,wCAAwC;IACxC,QAAQ,CAAC,YAAY,EAAE,SAAS,UAAU,EAAE,CAAA;IAC5C,kCAAkC;IAClC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAA;IAC7B,yFAAyF;IACzF,QAAQ,CAAC,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3C,oEAAoE;IACpE,QAAQ,CAAC,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAAA;IAClC,2EAA2E;IAC3E,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAClC,0CAA0C;IAC1C,QAAQ,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,CAAA;CACpC;AAED,0DAA0D;AAC1D,MAAM,WAAW,eAAe;IAC9B,kCAAkC;IAClC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAA;IAC7B,oDAAoD;IACpD,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAA;IAC7B,iFAAiF;IACjF,QAAQ,CAAC,qBAAqB,CAAC,EAAE,gBAAgB,CAAA;CAClD;AAED,iDAAiD;AACjD,MAAM,WAAW,gBAAgB;IAC/B,mDAAmD;IACnD,QAAQ,CAAC,IAAI,EAAE,SAAS,cAAc,EAAE,CAAA;IACxC,2FAA2F;IAC3F,QAAQ,CAAC,oBAAoB,EAAE,gBAAgB,GAAG,IAAI,CAAA;CACvD;AAED,2DAA2D;AAC3D,MAAM,WAAW,gBAAgB;IAC/B,2CAA2C;IAC3C,QAAQ,CAAC,gBAAgB,EAAE,gBAAgB,CAAA;CAC5C"}

package/dist/types/key.d.ts

@@ -0,0 +1,84 @@
+import { Capability } from './auth.js';
+import { AccountId, ApplicationKeyId, BucketId } from './ids.js';
+/** Request parameters for the `b2_create_key` API call. Creates a new application key. */
+export interface CreateKeyRequest {
+    /** Account to create the key for. */
+    readonly accountId: AccountId;
+    /** Capabilities to grant to the new key. */
+    readonly capabilities: readonly Capability[];
+    /** Human-readable name for the key (must be unique within the account). */
+    readonly keyName: string;
+    /** Optional duration in seconds before the key expires. Omit for a key that never expires. */
+    readonly validDurationInSeconds?: number;
+    /** Optional bucket restriction. When set, the key only grants access to this bucket. */
+    readonly bucketId?: BucketId;
+    /** Optional file name prefix restriction. When set, the key only grants access to files with this prefix. */
+    readonly namePrefix?: string;
+}
+/**
+ * Full application key including the secret, returned only at creation time by `b2_create_key`.
+ * The `applicationKey` secret is never returned again after this response.
+ */
+export interface FullApplicationKey {
+    /** Human-readable name of the key. */
+    readonly keyName: string;
+    /** Unique identifier for the application key. */
+    readonly applicationKeyId: ApplicationKeyId;
+    /** The secret key value. Only available in the `b2_create_key` response. */
+    readonly applicationKey: string;
+    /** Capabilities granted to this key. */
+    readonly capabilities: readonly Capability[];
+    /** Account that owns this key. */
+    readonly accountId: AccountId;
+    /** UTC timestamp (milliseconds) when this key expires, or null if it does not expire. */
+    readonly expirationTimestamp: number | null;
+    /** Bucket ID this key is restricted to, or null if unrestricted. */
+    readonly bucketId: BucketId | null;
+    /** File name prefix this key is restricted to, or null if unrestricted. */
+    readonly namePrefix: string | null;
+    /** Set of options enabled on this key. */
+    readonly options: readonly string[];
+}
+/**
+ * Application key metadata (without the secret) as returned by `b2_list_keys`.
+ */
+export interface ApplicationKey {
+    /** Human-readable name of the key. */
+    readonly keyName: string;
+    /** Unique identifier for the application key. */
+    readonly applicationKeyId: ApplicationKeyId;
+    /** Capabilities granted to this key. */
+    readonly capabilities: readonly Capability[];
+    /** Account that owns this key. */
+    readonly accountId: AccountId;
+    /** UTC timestamp (milliseconds) when this key expires, or null if it does not expire. */
+    readonly expirationTimestamp: number | null;
+    /** Bucket ID this key is restricted to, or null if unrestricted. */
+    readonly bucketId: BucketId | null;
+    /** File name prefix this key is restricted to, or null if unrestricted. */
+    readonly namePrefix: string | null;
+    /** Set of options enabled on this key. */
+    readonly options: readonly string[];
+}
+/** Request parameters for the `b2_list_keys` API call. */
+export interface ListKeysRequest {
+    /** Account whose keys to list. */
+    readonly accountId: AccountId;
+    /** Maximum number of keys to return per request. */
+    readonly maxKeyCount?: number;
+    /** Application key ID to start listing from (exclusive). Used for pagination. */
+    readonly startApplicationKeyId?: ApplicationKeyId;
+}
+/** Response from the `b2_list_keys` API call. */
+export interface ListKeysResponse {
+    /** Array of application keys (without secrets). */
+    readonly keys: readonly ApplicationKey[];
+    /** Next application key ID to use for pagination, or null if all keys have been listed. */
+    readonly nextApplicationKeyId: ApplicationKeyId | null;
+}
+/** Request parameters for the `b2_delete_key` API call. */
+export interface DeleteKeyRequest {
+    /** ID of the application key to delete. */
+    readonly applicationKeyId: ApplicationKeyId;
+}
+//# sourceMappingURL=key.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"key.d.ts","sourceRoot":"","sources":["../../src/types/key.js"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA;AAC3C,OAAO,KAAK,EAAE,SAAS,EAAE,gBAAgB,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAA;AAErE,0FAA0F;AAC1F,MAAM,WAAW,gBAAgB;IAC/B,qCAAqC;IACrC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAA;IAC7B,4CAA4C;IAC5C,QAAQ,CAAC,YAAY,EAAE,SAAS,UAAU,EAAE,CAAA;IAC5C,2EAA2E;IAC3E,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB,8FAA8F;IAC9F,QAAQ,CAAC,sBAAsB,CAAC,EAAE,MAAM,CAAA;IACxC,wFAAwF;IACxF,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAA;IAC5B,6GAA6G;IAC7G,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAA;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,sCAAsC;IACtC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB,iDAAiD;IACjD,QAAQ,CAAC,gBAAgB,EAAE,gBAAgB,CAAA;IAC3C,4EAA4E;IAC5E,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAA;IAC/B,wCAAwC;IACxC,QAAQ,CAAC,YAAY,EAAE,SAAS,UAAU,EAAE,CAAA;IAC5C,kCAAkC;IAClC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAA;IAC7B,yFAAyF;IACzF,QAAQ,CAAC,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3C,oEAAoE;IACpE,QAAQ,CAAC,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAAA;IAClC,2EAA2E;IAC3E,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAClC,0CAA0C;IAC1C,QAAQ,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,CAAA;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,sCAAsC;IACtC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB,iDAAiD;IACjD,QAAQ,CAAC,gBAAgB,EAAE,gBAAgB,CAAA;IAC3C,wCAAwC;IACxC,QAAQ,CAAC,YAAY,EAAE,SAAS,UAAU,EAAE,CAAA;IAC5C,kCAAkC;IAClC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAA;IAC7B,yFAAyF;IACzF,QAAQ,CAAC,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3C,oEAAoE;IACpE,QAAQ,CAAC,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAAA;IAClC,2EAA2E;IAC3E,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAClC,0CAA0C;IAC1C,QAAQ,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,CAAA;CACpC;AAED,0DAA0D;AAC1D,MAAM,WAAW,eAAe;IAC9B,kCAAkC;IAClC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAA;IAC7B,oDAAoD;IACpD,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAA;IAC7B,iFAAiF;IACjF,QAAQ,CAAC,qBAAqB,CAAC,EAAE,gBAAgB,CAAA;CAClD;AAED,iDAAiD;AACjD,MAAM,WAAW,gBAAgB;IAC/B,mDAAmD;IACnD,QAAQ,CAAC,IAAI,EAAE,SAAS,cAAc,EAAE,CAAA;IACxC,2FAA2F;IAC3F,QAAQ,CAAC,oBAAoB,EAAE,gBAAgB,GAAG,IAAI,CAAA;CACvD;AAED,2DAA2D;AAC3D,MAAM,WAAW,gBAAgB;IAC/B,2CAA2C;IAC3C,QAAQ,CAAC,gBAAgB,EAAE,gBAAgB,CAAA;CAC5C"}

package/dist/types/lock.cjs

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const RetentionMode = {
+  /** Locked: cannot be deleted or modified until `retainUntilTimestamp`, even by the account owner. */
+  Compliance: "compliance",
+  /** Locked: can be shortened by callers holding the `bypassGovernance` capability. */
+  Governance: "governance"
+};
+const LegalHoldValue = {
+  /** Apply the legal hold. */
+  On: "on",
+  /** Remove the legal hold. */
+  Off: "off"
+};
+exports.LegalHoldValue = LegalHoldValue;
+exports.RetentionMode = RetentionMode;
+//# sourceMappingURL=lock.cjs.map

package/dist/types/lock.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"lock.cjs","sources":["../../src/types/lock.ts"],"sourcesContent":["import type { FileId } from './ids.ts'\n\n/**\n * Named constants for the file-level Object Lock retention mode.\n *\n * @example\n * ```ts\n * await object.setRetention(fileId, {\n *   mode: RetentionMode.Compliance,\n *   retainUntilTimestamp: Date.now() + 86_400_000,\n * })\n * ```\n */\nexport const RetentionMode = {\n  /** Locked: cannot be deleted or modified until `retainUntilTimestamp`, even by the account owner. */\n  Compliance: 'compliance',\n  /** Locked: can be shortened by callers holding the `bypassGovernance` capability. */\n  Governance: 'governance',\n} as const\n\n/** File-level Object Lock retention mode. Derived from {@link RetentionMode}. */\nexport type RetentionMode = (typeof RetentionMode)[keyof typeof RetentionMode]\n\n/**\n * Named constants for the file legal-hold status.\n *\n * @example\n * ```ts\n * await object.setLegalHold(fileId, LegalHoldValue.On)\n * ```\n */\nexport const LegalHoldValue = {\n  /** Apply the legal hold. */\n  On: 'on',\n  /** Remove the legal hold. */\n  Off: 'off',\n} as const\n\n/** Legal hold status for a file. Derived from {@link LegalHoldValue}. */\nexport type LegalHoldValue = (typeof LegalHoldValue)[keyof typeof LegalHoldValue]\n\n/** Retention settings for a specific file version under Object Lock. */\nexport interface FileRetentionValue {\n  /** Retention mode, or null if no retention is set. */\n  readonly mode: RetentionMode | null\n  /** UTC timestamp (milliseconds) until which the file is retained, or null if not set. */\n  readonly retainUntilTimestamp: number | null\n}\n\n/**\n * Request parameters for the `b2_update_file_retention` API call.\n * Updates the Object Lock retention settings on a file version.\n */\nexport interface UpdateFileRetentionRequest {\n  /** Name of the file to update. */\n  readonly fileName: string\n  /** ID of the file version to update. */\n  readonly fileId: FileId\n  /** New retention settings for the file. */\n  readonly fileRetention: FileRetentionValue\n  /**\n   * When `true`, allows shortening a governance-mode retention period. Requires\n   * the `bypassGovernance` capability on the application key. Has no effect on\n   * compliance-mode retention.\n   */\n  readonly bypassGovernance?: boolean\n}\n\n/**\n * Request parameters for the `b2_update_file_legal_hold` API call.\n * Updates the legal hold status on a file version.\n */\nexport interface UpdateFileLegalHoldRequest {\n  /** Name of the file to update. */\n  readonly fileName: string\n  /** ID of the file version to update. */\n  readonly fileId: FileId\n  /** New legal hold status: `'on'` or `'off'`. */\n  readonly legalHold: LegalHoldValue\n}\n\n/** Response from the `b2_update_file_retention` API call. */\nexport interface UpdateFileRetentionResponse {\n  /** Name of the updated file. */\n  readonly fileName: string\n  /** ID of the updated file version. */\n  readonly fileId: FileId\n  /** Retention settings as applied. */\n  readonly fileRetention: FileRetentionValue\n}\n\n/** Response from the `b2_update_file_legal_hold` API call. */\nexport interface UpdateFileLegalHoldResponse {\n  /** Name of the updated file. */\n  readonly fileName: string\n  /** ID of the updated file version. */\n  readonly fileId: FileId\n  /** Legal hold status as applied. */\n  readonly legalHold: LegalHoldValue\n}\n"],"names":[],"mappings":";;AAaO,MAAM,gBAAgB;AAAA;AAAA,EAE3B,YAAY;AAAA;AAAA,EAEZ,YAAY;AACd;AAaO,MAAM,iBAAiB;AAAA;AAAA,EAE5B,IAAI;AAAA;AAAA,EAEJ,KAAK;AACP;;;"}

package/dist/types/lock.d.cts

@@ -0,0 +1,92 @@
+import { FileId } from './ids.js';
+/**
+ * Named constants for the file-level Object Lock retention mode.
+ *
+ * @example
+ * ```ts
+ * await object.setRetention(fileId, {
+ *   mode: RetentionMode.Compliance,
+ *   retainUntilTimestamp: Date.now() + 86_400_000,
+ * })
+ * ```
+ */
+export declare const RetentionMode: {
+    /** Locked: cannot be deleted or modified until `retainUntilTimestamp`, even by the account owner. */
+    readonly Compliance: "compliance";
+    /** Locked: can be shortened by callers holding the `bypassGovernance` capability. */
+    readonly Governance: "governance";
+};
+/** File-level Object Lock retention mode. Derived from {@link RetentionMode}. */
+export type RetentionMode = (typeof RetentionMode)[keyof typeof RetentionMode];
+/**
+ * Named constants for the file legal-hold status.
+ *
+ * @example
+ * ```ts
+ * await object.setLegalHold(fileId, LegalHoldValue.On)
+ * ```
+ */
+export declare const LegalHoldValue: {
+    /** Apply the legal hold. */
+    readonly On: "on";
+    /** Remove the legal hold. */
+    readonly Off: "off";
+};
+/** Legal hold status for a file. Derived from {@link LegalHoldValue}. */
+export type LegalHoldValue = (typeof LegalHoldValue)[keyof typeof LegalHoldValue];
+/** Retention settings for a specific file version under Object Lock. */
+export interface FileRetentionValue {
+    /** Retention mode, or null if no retention is set. */
+    readonly mode: RetentionMode | null;
+    /** UTC timestamp (milliseconds) until which the file is retained, or null if not set. */
+    readonly retainUntilTimestamp: number | null;
+}
+/**
+ * Request parameters for the `b2_update_file_retention` API call.
+ * Updates the Object Lock retention settings on a file version.
+ */
+export interface UpdateFileRetentionRequest {
+    /** Name of the file to update. */
+    readonly fileName: string;
+    /** ID of the file version to update. */
+    readonly fileId: FileId;
+    /** New retention settings for the file. */
+    readonly fileRetention: FileRetentionValue;
+    /**
+     * When `true`, allows shortening a governance-mode retention period. Requires
+     * the `bypassGovernance` capability on the application key. Has no effect on
+     * compliance-mode retention.
+     */
+    readonly bypassGovernance?: boolean;
+}
+/**
+ * Request parameters for the `b2_update_file_legal_hold` API call.
+ * Updates the legal hold status on a file version.
+ */
+export interface UpdateFileLegalHoldRequest {
+    /** Name of the file to update. */
+    readonly fileName: string;
+    /** ID of the file version to update. */
+    readonly fileId: FileId;
+    /** New legal hold status: `'on'` or `'off'`. */
+    readonly legalHold: LegalHoldValue;
+}
+/** Response from the `b2_update_file_retention` API call. */
+export interface UpdateFileRetentionResponse {
+    /** Name of the updated file. */
+    readonly fileName: string;
+    /** ID of the updated file version. */
+    readonly fileId: FileId;
+    /** Retention settings as applied. */
+    readonly fileRetention: FileRetentionValue;
+}
+/** Response from the `b2_update_file_legal_hold` API call. */
+export interface UpdateFileLegalHoldResponse {
+    /** Name of the updated file. */
+    readonly fileName: string;
+    /** ID of the updated file version. */
+    readonly fileId: FileId;
+    /** Legal hold status as applied. */
+    readonly legalHold: LegalHoldValue;
+}
+//# sourceMappingURL=lock.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"lock.d.ts","sourceRoot":"","sources":["../../src/types/lock.js"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAEtC;;;;;;;;;;GAUG;AACH,eAAO,MAAM,aAAa;IACxB,qGAAqG;;IAErG,qFAAqF;;CAE7E,CAAA;AAEV,iFAAiF;AACjF,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,OAAO,aAAa,CAAC,CAAA;AAE9E;;;;;;;GAOG;AACH,eAAO,MAAM,cAAc;IACzB,4BAA4B;;IAE5B,6BAA6B;;CAErB,CAAA;AAEV,yEAAyE;AACzE,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,OAAO,cAAc,CAAC,CAAA;AAEjF,wEAAwE;AACxE,MAAM,WAAW,kBAAkB;IACjC,sDAAsD;IACtD,QAAQ,CAAC,IAAI,EAAE,aAAa,GAAG,IAAI,CAAA;IACnC,yFAAyF;IACzF,QAAQ,CAAC,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAA;CAC7C;AAED;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC,kCAAkC;IAClC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,wCAAwC;IACxC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,2CAA2C;IAC3C,QAAQ,CAAC,aAAa,EAAE,kBAAkB,CAAA;IAC1C;;;;OAIG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,OAAO,CAAA;CACpC;AAED;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC,kCAAkC;IAClC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,wCAAwC;IACxC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,gDAAgD;IAChD,QAAQ,CAAC,SAAS,EAAE,cAAc,CAAA;CACnC;AAED,6DAA6D;AAC7D,MAAM,WAAW,2BAA2B;IAC1C,gCAAgC;IAChC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,sCAAsC;IACtC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,qCAAqC;IACrC,QAAQ,CAAC,aAAa,EAAE,kBAAkB,CAAA;CAC3C;AAED,8DAA8D;AAC9D,MAAM,WAAW,2BAA2B;IAC1C,gCAAgC;IAChC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,sCAAsC;IACtC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,oCAAoC;IACpC,QAAQ,CAAC,SAAS,EAAE,cAAc,CAAA;CACnC"}