@backblaze-labs/b2-sdk 0.1.0

package/dist/types/bucket.d.cts

@@ -0,0 +1,245 @@
+import { EncryptionSetting } from './encryption.js';
+import { AccountId, BucketId } from './ids.js';
+import { ReplicationConfiguration } from './replication.js';
+/**
+ * Named constants for the bucket access level.
+ *
+ * The {@link BucketType} type alias is derived from the values of this
+ * object, so the const is the single source of truth: adding a key here
+ * automatically widens the type union.
+ *
+ * @example
+ * ```ts
+ * await client.createBucket({ bucketName: 'my-app-logs', bucketType: BucketType.AllPrivate })
+ * ```
+ */
+export declare const BucketType: {
+    /** Publicly downloadable without authentication. */
+    readonly AllPublic: "allPublic";
+    /** Requires a valid auth token to download. */
+    readonly AllPrivate: "allPrivate";
+    /** Internal snapshot bucket type, generally not user-created. */
+    readonly Snapshot: "snapshot";
+    /** B2-restricted bucket (e.g., for S3-compatible workflows). */
+    readonly Restricted: "restricted";
+};
+/** Access level for a B2 bucket. Derived from {@link BucketType}. */
+export type BucketType = (typeof BucketType)[keyof typeof BucketType];
+/** Rule that automatically hides or deletes files after a specified number of days. */
+export interface LifecycleRule {
+    /** Days after hiding before automatic deletion, or null to never auto-delete hidden files. */
+    readonly daysFromHidingToDeleting: number | null;
+    /** Days after upload before automatic hiding, or null to never auto-hide. */
+    readonly daysFromUploadingToHiding: number | null;
+    /** File name prefix this rule applies to. Empty string matches all files. */
+    readonly fileNamePrefix: string;
+}
+/**
+ * Named constants for the B2 + S3 operations a CORS rule can permit.
+ *
+ * @example
+ * ```ts
+ * await bucket.update({
+ *   corsRules: [{
+ *     corsRuleName: 'browser-downloads',
+ *     allowedOrigins: ['https://example.com'],
+ *     allowedOperations: [CorsOperation.B2DownloadFileByName, CorsOperation.S3Get],
+ *     allowedHeaders: null,
+ *     exposeHeaders: null,
+ *     maxAgeSeconds: 3600,
+ *   }],
+ * })
+ * ```
+ */
+export declare const CorsOperation: {
+    /** Native B2 download-by-name request. */
+    readonly B2DownloadFileByName: "b2_download_file_by_name";
+    /** Native B2 download-by-id request. */
+    readonly B2DownloadFileById: "b2_download_file_by_id";
+    /** Native B2 small-file upload. */
+    readonly B2UploadFile: "b2_upload_file";
+    /** Native B2 multipart-part upload. */
+    readonly B2UploadPart: "b2_upload_part";
+    /** S3-compatible DELETE. */
+    readonly S3Delete: "s3_delete";
+    /** S3-compatible GET. */
+    readonly S3Get: "s3_get";
+    /** S3-compatible HEAD. */
+    readonly S3Head: "s3_head";
+    /** S3-compatible POST. */
+    readonly S3Post: "s3_post";
+    /** S3-compatible PUT. */
+    readonly S3Put: "s3_put";
+};
+/**
+ * A B2 or S3 operation that a CORS rule can permit. Derived from
+ * {@link CorsOperation}.
+ */
+export type CorsOperation = (typeof CorsOperation)[keyof typeof CorsOperation];
+/** Cross-Origin Resource Sharing (CORS) rule for browser-based access to a bucket. */
+export interface CorsRule {
+    /** Unique name identifying this CORS rule within the bucket. */
+    readonly corsRuleName: string;
+    /** Origins allowed to make cross-origin requests (e.g., `'https://example.com'`). */
+    readonly allowedOrigins: readonly string[];
+    /** B2 and S3 operations permitted by this rule. */
+    readonly allowedOperations: readonly CorsOperation[];
+    /** Request headers allowed in preflight requests, or null if none are allowed. */
+    readonly allowedHeaders: readonly string[] | null;
+    /** Response headers exposed to the browser, or null if none are exposed. */
+    readonly exposeHeaders: readonly string[] | null;
+    /** Maximum time (in seconds) browsers may cache the preflight response. */
+    readonly maxAgeSeconds: number;
+}
+/**
+ * Named constants for the bucket-level Object Lock retention mode.
+ *
+ * Pair with {@link BucketRetentionPolicy} when setting a bucket's default
+ * retention: `{ mode: BucketRetentionMode.Compliance, period: { duration: 30, unit: 'days' } }`.
+ */
+export declare const BucketRetentionMode: {
+    /** Files cannot be deleted or modified during the retention period, even by the account owner. */
+    readonly Compliance: "compliance";
+    /** Files cannot be deleted during retention except by callers with the `bypassGovernance` capability. */
+    readonly Governance: "governance";
+    /** No default retention is applied to new uploads. */
+    readonly None: "none";
+};
+/** Bucket-level Object Lock retention mode. Derived from {@link BucketRetentionMode}. */
+export type BucketRetentionMode = (typeof BucketRetentionMode)[keyof typeof BucketRetentionMode];
+/** Duration and unit for a retention period. */
+export interface RetentionPeriod {
+    /** Length of the retention period. */
+    readonly duration: number;
+    /** Time unit for the retention period. */
+    readonly unit: 'days' | 'years';
+}
+/** Default Object Lock retention policy applied to new files in a bucket. */
+export interface BucketRetentionPolicy {
+    /** Retention mode for the policy. */
+    readonly mode: BucketRetentionMode;
+    /** Retention period, or null when mode is `'none'`. */
+    readonly period: RetentionPeriod | null;
+}
+/**
+ * Complete bucket metadata as returned by the B2 API.
+ * Corresponds to the bucket object in responses from `b2_list_buckets`, `b2_create_bucket`, and `b2_update_bucket`.
+ */
+export interface BucketInfo {
+    /** Account that owns this bucket. */
+    readonly accountId: AccountId;
+    /** Unique identifier for this bucket. */
+    readonly bucketId: BucketId;
+    /** Globally unique name of this bucket. */
+    readonly bucketName: string;
+    /** Access level of this bucket. */
+    readonly bucketType: BucketType;
+    /** User-defined key-value metadata stored on the bucket. */
+    readonly bucketInfo: Record<string, string>;
+    /** CORS rules configured on this bucket. */
+    readonly corsRules: readonly CorsRule[];
+    /** Default server-side encryption setting for new files in this bucket. */
+    readonly defaultServerSideEncryption: EncryptionSetting;
+    /** File Lock configuration including authorization status and current settings. */
+    readonly fileLockConfiguration: {
+        /** Whether the caller is authorized to read file lock settings. */
+        readonly isClientAuthorizedToRead: boolean;
+        /** File lock settings, or null if the caller lacks read authorization. */
+        readonly value: {
+            /** Whether Object Lock is enabled on this bucket. */
+            readonly isFileLockEnabled: boolean;
+            /** Default retention policy for newly uploaded files. */
+            readonly defaultRetention: BucketRetentionPolicy;
+        } | null;
+    };
+    /** Lifecycle rules configured on this bucket. */
+    readonly lifecycleRules: readonly LifecycleRule[];
+    /** Set of options enabled on this bucket (e.g., `'s3'`). */
+    readonly options: readonly string[];
+    /** Monotonically increasing revision number, incremented on each bucket update. */
+    readonly revision: number;
+    /** Default retention policy for newly uploaded files. */
+    readonly defaultRetention: BucketRetentionPolicy;
+    /** Cross-region replication configuration for this bucket. */
+    readonly replicationConfiguration: ReplicationConfiguration;
+}
+/**
+ * Request parameters for the `b2_create_bucket` API call.
+ */
+export interface CreateBucketRequest {
+    /** Account that will own the new bucket. */
+    readonly accountId: AccountId;
+    /** Globally unique name for the bucket. */
+    readonly bucketName: string;
+    /** Access level for the bucket. */
+    readonly bucketType: BucketType;
+    /** Optional user-defined key-value metadata. */
+    readonly bucketInfo?: Record<string, string>;
+    /** Optional CORS rules. */
+    readonly corsRules?: readonly CorsRule[];
+    /** Optional default server-side encryption setting. */
+    readonly defaultServerSideEncryption?: EncryptionSetting;
+    /** Optional default Object Lock retention policy. */
+    readonly defaultRetention?: BucketRetentionPolicy;
+    /** Whether to enable Object Lock on the bucket. Cannot be changed after creation. */
+    readonly fileLockEnabled?: boolean;
+    /** Optional lifecycle rules. */
+    readonly lifecycleRules?: readonly LifecycleRule[];
+    /** Optional replication configuration. */
+    readonly replicationConfiguration?: ReplicationConfiguration;
+}
+/**
+ * Request parameters for the `b2_update_bucket` API call.
+ */
+export interface UpdateBucketRequest {
+    /** Account that owns the bucket. */
+    readonly accountId: AccountId;
+    /** ID of the bucket to update. */
+    readonly bucketId: BucketId;
+    /** New access level for the bucket. */
+    readonly bucketType?: BucketType;
+    /** Updated user-defined key-value metadata. Replaces all existing metadata. */
+    readonly bucketInfo?: Record<string, string>;
+    /** Updated CORS rules. Replaces all existing rules. */
+    readonly corsRules?: readonly CorsRule[];
+    /** Updated default server-side encryption setting. */
+    readonly defaultServerSideEncryption?: EncryptionSetting;
+    /** Updated default Object Lock retention policy. */
+    readonly defaultRetention?: BucketRetentionPolicy;
+    /** Whether to enable Object Lock. Can only transition from disabled to enabled. */
+    readonly fileLockEnabled?: boolean;
+    /** Updated lifecycle rules. Replaces all existing rules. */
+    readonly lifecycleRules?: readonly LifecycleRule[];
+    /** Updated replication configuration. */
+    readonly replicationConfiguration?: ReplicationConfiguration;
+    /** Optimistic locking: only update if the bucket's current revision matches this value. */
+    readonly ifRevisionIs?: number;
+}
+/**
+ * Request parameters for the `b2_list_buckets` API call.
+ */
+export interface ListBucketsRequest {
+    /** Account whose buckets to list. */
+    readonly accountId: AccountId;
+    /** Optional filter to return only the bucket with this ID. */
+    readonly bucketId?: BucketId;
+    /** Optional filter to return only the bucket with this name. */
+    readonly bucketName?: string;
+    /** Optional filter to return only buckets of these types. */
+    readonly bucketTypes?: readonly BucketType[];
+}
+/** Response from the `b2_list_buckets` API call. */
+export interface ListBucketsResponse {
+    /** Array of buckets matching the request filters. */
+    readonly buckets: readonly BucketInfo[];
+}
+/**
+ * Request parameters for the `b2_delete_bucket` API call.
+ */
+export interface DeleteBucketRequest {
+    /** Account that owns the bucket. */
+    readonly accountId: AccountId;
+    /** ID of the bucket to delete. The bucket must be empty. */
+    readonly bucketId: BucketId;
+}
+//# sourceMappingURL=bucket.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"bucket.d.ts","sourceRoot":"","sources":["../../src/types/bucket.js"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAA;AACxD,OAAO,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAA;AACnD,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,kBAAkB,CAAA;AAEhE;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,UAAU;IACrB,oDAAoD;;IAEpD,+CAA+C;;IAE/C,iEAAiE;;IAEjE,gEAAgE;;CAExD,CAAA;AAEV,qEAAqE;AACrE,MAAM,MAAM,UAAU,GAAG,CAAC,OAAO,UAAU,CAAC,CAAC,MAAM,OAAO,UAAU,CAAC,CAAA;AAErE,uFAAuF;AACvF,MAAM,WAAW,aAAa;IAC5B,8FAA8F;IAC9F,QAAQ,CAAC,wBAAwB,EAAE,MAAM,GAAG,IAAI,CAAA;IAChD,6EAA6E;IAC7E,QAAQ,CAAC,yBAAyB,EAAE,MAAM,GAAG,IAAI,CAAA;IACjD,6EAA6E;IAC7E,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAA;CAChC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,aAAa;IACxB,0CAA0C;;IAE1C,wCAAwC;;IAExC,mCAAmC;;IAEnC,uCAAuC;;IAEvC,4BAA4B;;IAE5B,yBAAyB;;IAEzB,0BAA0B;;IAE1B,0BAA0B;;IAE1B,yBAAyB;;CAEjB,CAAA;AAEV;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,OAAO,aAAa,CAAC,CAAA;AAE9E,sFAAsF;AACtF,MAAM,WAAW,QAAQ;IACvB,gEAAgE;IAChE,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAA;IAC7B,qFAAqF;IACrF,QAAQ,CAAC,cAAc,EAAE,SAAS,MAAM,EAAE,CAAA;IAC1C,mDAAmD;IACnD,QAAQ,CAAC,iBAAiB,EAAE,SAAS,aAAa,EAAE,CAAA;IACpD,kFAAkF;IAClF,QAAQ,CAAC,cAAc,EAAE,SAAS,MAAM,EAAE,GAAG,IAAI,CAAA;IACjD,4EAA4E;IAC5E,QAAQ,CAAC,aAAa,EAAE,SAAS,MAAM,EAAE,GAAG,IAAI,CAAA;IAChD,2EAA2E;IAC3E,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAA;CAC/B;AAED;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB;IAC9B,kGAAkG;;IAElG,yGAAyG;;IAEzG,sDAAsD;;CAE9C,CAAA;AAEV,yFAAyF;AACzF,MAAM,MAAM,mBAAmB,GAAG,CAAC,OAAO,mBAAmB,CAAC,CAAC,MAAM,OAAO,mBAAmB,CAAC,CAAA;AAEhG,gDAAgD;AAChD,MAAM,WAAW,eAAe;IAC9B,sCAAsC;IACtC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,0CAA0C;IAC1C,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAA;CAChC;AAED,6EAA6E;AAC7E,MAAM,WAAW,qBAAqB;IACpC,qCAAqC;IACrC,QAAQ,CAAC,IAAI,EAAE,mBAAmB,CAAA;IAClC,uDAAuD;IACvD,QAAQ,CAAC,MAAM,EAAE,eAAe,GAAG,IAAI,CAAA;CACxC;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB,qCAAqC;IACrC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAA;IAC7B,yCAAyC;IACzC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;IAC3B,2CAA2C;IAC3C,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAC3B,mCAAmC;IACnC,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAA;IAC/B,4DAA4D;IAC5D,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC3C,4CAA4C;IAC5C,QAAQ,CAAC,SAAS,EAAE,SAAS,QAAQ,EAAE,CAAA;IACvC,2EAA2E;IAC3E,QAAQ,CAAC,2BAA2B,EAAE,iBAAiB,CAAA;IACvD,mFAAmF;IACnF,QAAQ,CAAC,qBAAqB,EAAE;QAC9B,mEAAmE;QACnE,QAAQ,CAAC,wBAAwB,EAAE,OAAO,CAAA;QAC1C,0EAA0E;QAC1E,QAAQ,CAAC,KAAK,EAAE;YACd,qDAAqD;YACrD,QAAQ,CAAC,iBAAiB,EAAE,OAAO,CAAA;YACnC,yDAAyD;YACzD,QAAQ,CAAC,gBAAgB,EAAE,qBAAqB,CAAA;SACjD,GAAG,IAAI,CAAA;KACT,CAAA;IACD,iDAAiD;IACjD,QAAQ,CAAC,cAAc,EAAE,SAAS,aAAa,EAAE,CAAA;IACjD,4DAA4D;IAC5D,QAAQ,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,CAAA;IACnC,mFAAmF;IACnF,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,yDAAyD;IACzD,QAAQ,CAAC,gBAAgB,EAAE,qBAAqB,CAAA;IAChD,8DAA8D;IAC9D,QAAQ,CAAC,wBAAwB,EAAE,wBAAwB,CAAA;CAC5D;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,4CAA4C;IAC5C,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAA;IAC7B,2CAA2C;IAC3C,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAC3B,mCAAmC;IACnC,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAA;IAC/B,gDAAgD;IAChD,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC5C,2BAA2B;IAC3B,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,QAAQ,EAAE,CAAA;IACxC,uDAAuD;IACvD,QAAQ,CAAC,2BAA2B,CAAC,EAAE,iBAAiB,CAAA;IACxD,qDAAqD;IACrD,QAAQ,CAAC,gBAAgB,CAAC,EAAE,qBAAqB,CAAA;IACjD,qFAAqF;IACrF,QAAQ,CAAC,eAAe,CAAC,EAAE,OAAO,CAAA;IAClC,gCAAgC;IAChC,QAAQ,CAAC,cAAc,CAAC,EAAE,SAAS,aAAa,EAAE,CAAA;IAClD,0CAA0C;IAC1C,QAAQ,CAAC,wBAAwB,CAAC,EAAE,wBAAwB,CAAA;CAC7D;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,oCAAoC;IACpC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAA;IAC7B,kCAAkC;IAClC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;IAC3B,uCAAuC;IACvC,QAAQ,CAAC,UAAU,CAAC,EAAE,UAAU,CAAA;IAChC,+EAA+E;IAC/E,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC5C,uDAAuD;IACvD,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,QAAQ,EAAE,CAAA;IACxC,sDAAsD;IACtD,QAAQ,CAAC,2BAA2B,CAAC,EAAE,iBAAiB,CAAA;IACxD,oDAAoD;IACpD,QAAQ,CAAC,gBAAgB,CAAC,EAAE,qBAAqB,CAAA;IACjD,mFAAmF;IACnF,QAAQ,CAAC,eAAe,CAAC,EAAE,OAAO,CAAA;IAClC,4DAA4D;IAC5D,QAAQ,CAAC,cAAc,CAAC,EAAE,SAAS,aAAa,EAAE,CAAA;IAClD,yCAAyC;IACzC,QAAQ,CAAC,wBAAwB,CAAC,EAAE,wBAAwB,CAAA;IAC5D,2FAA2F;IAC3F,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAA;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,qCAAqC;IACrC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAA;IAC7B,8DAA8D;IAC9D,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAA;IAC5B,gEAAgE;IAChE,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAA;IAC5B,6DAA6D;IAC7D,QAAQ,CAAC,WAAW,CAAC,EAAE,SAAS,UAAU,EAAE,CAAA;CAC7C;AAED,oDAAoD;AACpD,MAAM,WAAW,mBAAmB;IAClC,qDAAqD;IACrD,QAAQ,CAAC,OAAO,EAAE,SAAS,UAAU,EAAE,CAAA;CACxC;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,oCAAoC;IACpC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAA;IAC7B,4DAA4D;IAC5D,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;CAC5B"}

package/dist/types/bucket.d.ts

@@ -0,0 +1,245 @@
+import { EncryptionSetting } from './encryption.js';
+import { AccountId, BucketId } from './ids.js';
+import { ReplicationConfiguration } from './replication.js';
+/**
+ * Named constants for the bucket access level.
+ *
+ * The {@link BucketType} type alias is derived from the values of this
+ * object, so the const is the single source of truth: adding a key here
+ * automatically widens the type union.
+ *
+ * @example
+ * ```ts
+ * await client.createBucket({ bucketName: 'my-app-logs', bucketType: BucketType.AllPrivate })
+ * ```
+ */
+export declare const BucketType: {
+    /** Publicly downloadable without authentication. */
+    readonly AllPublic: "allPublic";
+    /** Requires a valid auth token to download. */
+    readonly AllPrivate: "allPrivate";
+    /** Internal snapshot bucket type, generally not user-created. */
+    readonly Snapshot: "snapshot";
+    /** B2-restricted bucket (e.g., for S3-compatible workflows). */
+    readonly Restricted: "restricted";
+};
+/** Access level for a B2 bucket. Derived from {@link BucketType}. */
+export type BucketType = (typeof BucketType)[keyof typeof BucketType];
+/** Rule that automatically hides or deletes files after a specified number of days. */
+export interface LifecycleRule {
+    /** Days after hiding before automatic deletion, or null to never auto-delete hidden files. */
+    readonly daysFromHidingToDeleting: number | null;
+    /** Days after upload before automatic hiding, or null to never auto-hide. */
+    readonly daysFromUploadingToHiding: number | null;
+    /** File name prefix this rule applies to. Empty string matches all files. */
+    readonly fileNamePrefix: string;
+}
+/**
+ * Named constants for the B2 + S3 operations a CORS rule can permit.
+ *
+ * @example
+ * ```ts
+ * await bucket.update({
+ *   corsRules: [{
+ *     corsRuleName: 'browser-downloads',
+ *     allowedOrigins: ['https://example.com'],
+ *     allowedOperations: [CorsOperation.B2DownloadFileByName, CorsOperation.S3Get],
+ *     allowedHeaders: null,
+ *     exposeHeaders: null,
+ *     maxAgeSeconds: 3600,
+ *   }],
+ * })
+ * ```
+ */
+export declare const CorsOperation: {
+    /** Native B2 download-by-name request. */
+    readonly B2DownloadFileByName: "b2_download_file_by_name";
+    /** Native B2 download-by-id request. */
+    readonly B2DownloadFileById: "b2_download_file_by_id";
+    /** Native B2 small-file upload. */
+    readonly B2UploadFile: "b2_upload_file";
+    /** Native B2 multipart-part upload. */
+    readonly B2UploadPart: "b2_upload_part";
+    /** S3-compatible DELETE. */
+    readonly S3Delete: "s3_delete";
+    /** S3-compatible GET. */
+    readonly S3Get: "s3_get";
+    /** S3-compatible HEAD. */
+    readonly S3Head: "s3_head";
+    /** S3-compatible POST. */
+    readonly S3Post: "s3_post";
+    /** S3-compatible PUT. */
+    readonly S3Put: "s3_put";
+};
+/**
+ * A B2 or S3 operation that a CORS rule can permit. Derived from
+ * {@link CorsOperation}.
+ */
+export type CorsOperation = (typeof CorsOperation)[keyof typeof CorsOperation];
+/** Cross-Origin Resource Sharing (CORS) rule for browser-based access to a bucket. */
+export interface CorsRule {
+    /** Unique name identifying this CORS rule within the bucket. */
+    readonly corsRuleName: string;
+    /** Origins allowed to make cross-origin requests (e.g., `'https://example.com'`). */
+    readonly allowedOrigins: readonly string[];
+    /** B2 and S3 operations permitted by this rule. */
+    readonly allowedOperations: readonly CorsOperation[];
+    /** Request headers allowed in preflight requests, or null if none are allowed. */
+    readonly allowedHeaders: readonly string[] | null;
+    /** Response headers exposed to the browser, or null if none are exposed. */
+    readonly exposeHeaders: readonly string[] | null;
+    /** Maximum time (in seconds) browsers may cache the preflight response. */
+    readonly maxAgeSeconds: number;
+}
+/**
+ * Named constants for the bucket-level Object Lock retention mode.
+ *
+ * Pair with {@link BucketRetentionPolicy} when setting a bucket's default
+ * retention: `{ mode: BucketRetentionMode.Compliance, period: { duration: 30, unit: 'days' } }`.
+ */
+export declare const BucketRetentionMode: {
+    /** Files cannot be deleted or modified during the retention period, even by the account owner. */
+    readonly Compliance: "compliance";
+    /** Files cannot be deleted during retention except by callers with the `bypassGovernance` capability. */
+    readonly Governance: "governance";
+    /** No default retention is applied to new uploads. */
+    readonly None: "none";
+};
+/** Bucket-level Object Lock retention mode. Derived from {@link BucketRetentionMode}. */
+export type BucketRetentionMode = (typeof BucketRetentionMode)[keyof typeof BucketRetentionMode];
+/** Duration and unit for a retention period. */
+export interface RetentionPeriod {
+    /** Length of the retention period. */
+    readonly duration: number;
+    /** Time unit for the retention period. */
+    readonly unit: 'days' | 'years';
+}
+/** Default Object Lock retention policy applied to new files in a bucket. */
+export interface BucketRetentionPolicy {
+    /** Retention mode for the policy. */
+    readonly mode: BucketRetentionMode;
+    /** Retention period, or null when mode is `'none'`. */
+    readonly period: RetentionPeriod | null;
+}
+/**
+ * Complete bucket metadata as returned by the B2 API.
+ * Corresponds to the bucket object in responses from `b2_list_buckets`, `b2_create_bucket`, and `b2_update_bucket`.
+ */
+export interface BucketInfo {
+    /** Account that owns this bucket. */
+    readonly accountId: AccountId;
+    /** Unique identifier for this bucket. */
+    readonly bucketId: BucketId;
+    /** Globally unique name of this bucket. */
+    readonly bucketName: string;
+    /** Access level of this bucket. */
+    readonly bucketType: BucketType;
+    /** User-defined key-value metadata stored on the bucket. */
+    readonly bucketInfo: Record<string, string>;
+    /** CORS rules configured on this bucket. */
+    readonly corsRules: readonly CorsRule[];
+    /** Default server-side encryption setting for new files in this bucket. */
+    readonly defaultServerSideEncryption: EncryptionSetting;
+    /** File Lock configuration including authorization status and current settings. */
+    readonly fileLockConfiguration: {
+        /** Whether the caller is authorized to read file lock settings. */
+        readonly isClientAuthorizedToRead: boolean;
+        /** File lock settings, or null if the caller lacks read authorization. */
+        readonly value: {
+            /** Whether Object Lock is enabled on this bucket. */
+            readonly isFileLockEnabled: boolean;
+            /** Default retention policy for newly uploaded files. */
+            readonly defaultRetention: BucketRetentionPolicy;
+        } | null;
+    };
+    /** Lifecycle rules configured on this bucket. */
+    readonly lifecycleRules: readonly LifecycleRule[];
+    /** Set of options enabled on this bucket (e.g., `'s3'`). */
+    readonly options: readonly string[];
+    /** Monotonically increasing revision number, incremented on each bucket update. */
+    readonly revision: number;
+    /** Default retention policy for newly uploaded files. */
+    readonly defaultRetention: BucketRetentionPolicy;
+    /** Cross-region replication configuration for this bucket. */
+    readonly replicationConfiguration: ReplicationConfiguration;
+}
+/**
+ * Request parameters for the `b2_create_bucket` API call.
+ */
+export interface CreateBucketRequest {
+    /** Account that will own the new bucket. */
+    readonly accountId: AccountId;
+    /** Globally unique name for the bucket. */
+    readonly bucketName: string;
+    /** Access level for the bucket. */
+    readonly bucketType: BucketType;
+    /** Optional user-defined key-value metadata. */
+    readonly bucketInfo?: Record<string, string>;
+    /** Optional CORS rules. */
+    readonly corsRules?: readonly CorsRule[];
+    /** Optional default server-side encryption setting. */
+    readonly defaultServerSideEncryption?: EncryptionSetting;
+    /** Optional default Object Lock retention policy. */
+    readonly defaultRetention?: BucketRetentionPolicy;
+    /** Whether to enable Object Lock on the bucket. Cannot be changed after creation. */
+    readonly fileLockEnabled?: boolean;
+    /** Optional lifecycle rules. */
+    readonly lifecycleRules?: readonly LifecycleRule[];
+    /** Optional replication configuration. */
+    readonly replicationConfiguration?: ReplicationConfiguration;
+}
+/**
+ * Request parameters for the `b2_update_bucket` API call.
+ */
+export interface UpdateBucketRequest {
+    /** Account that owns the bucket. */
+    readonly accountId: AccountId;
+    /** ID of the bucket to update. */
+    readonly bucketId: BucketId;
+    /** New access level for the bucket. */
+    readonly bucketType?: BucketType;
+    /** Updated user-defined key-value metadata. Replaces all existing metadata. */
+    readonly bucketInfo?: Record<string, string>;
+    /** Updated CORS rules. Replaces all existing rules. */
+    readonly corsRules?: readonly CorsRule[];
+    /** Updated default server-side encryption setting. */
+    readonly defaultServerSideEncryption?: EncryptionSetting;
+    /** Updated default Object Lock retention policy. */
+    readonly defaultRetention?: BucketRetentionPolicy;
+    /** Whether to enable Object Lock. Can only transition from disabled to enabled. */
+    readonly fileLockEnabled?: boolean;
+    /** Updated lifecycle rules. Replaces all existing rules. */
+    readonly lifecycleRules?: readonly LifecycleRule[];
+    /** Updated replication configuration. */
+    readonly replicationConfiguration?: ReplicationConfiguration;
+    /** Optimistic locking: only update if the bucket's current revision matches this value. */
+    readonly ifRevisionIs?: number;
+}
+/**
+ * Request parameters for the `b2_list_buckets` API call.
+ */
+export interface ListBucketsRequest {
+    /** Account whose buckets to list. */
+    readonly accountId: AccountId;
+    /** Optional filter to return only the bucket with this ID. */
+    readonly bucketId?: BucketId;
+    /** Optional filter to return only the bucket with this name. */
+    readonly bucketName?: string;
+    /** Optional filter to return only buckets of these types. */
+    readonly bucketTypes?: readonly BucketType[];
+}
+/** Response from the `b2_list_buckets` API call. */
+export interface ListBucketsResponse {
+    /** Array of buckets matching the request filters. */
+    readonly buckets: readonly BucketInfo[];
+}
+/**
+ * Request parameters for the `b2_delete_bucket` API call.
+ */
+export interface DeleteBucketRequest {
+    /** Account that owns the bucket. */
+    readonly accountId: AccountId;
+    /** ID of the bucket to delete. The bucket must be empty. */
+    readonly bucketId: BucketId;
+}
+//# sourceMappingURL=bucket.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"bucket.d.ts","sourceRoot":"","sources":["../../src/types/bucket.js"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAA;AACxD,OAAO,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAA;AACnD,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,kBAAkB,CAAA;AAEhE;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,UAAU;IACrB,oDAAoD;;IAEpD,+CAA+C;;IAE/C,iEAAiE;;IAEjE,gEAAgE;;CAExD,CAAA;AAEV,qEAAqE;AACrE,MAAM,MAAM,UAAU,GAAG,CAAC,OAAO,UAAU,CAAC,CAAC,MAAM,OAAO,UAAU,CAAC,CAAA;AAErE,uFAAuF;AACvF,MAAM,WAAW,aAAa;IAC5B,8FAA8F;IAC9F,QAAQ,CAAC,wBAAwB,EAAE,MAAM,GAAG,IAAI,CAAA;IAChD,6EAA6E;IAC7E,QAAQ,CAAC,yBAAyB,EAAE,MAAM,GAAG,IAAI,CAAA;IACjD,6EAA6E;IAC7E,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAA;CAChC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,aAAa;IACxB,0CAA0C;;IAE1C,wCAAwC;;IAExC,mCAAmC;;IAEnC,uCAAuC;;IAEvC,4BAA4B;;IAE5B,yBAAyB;;IAEzB,0BAA0B;;IAE1B,0BAA0B;;IAE1B,yBAAyB;;CAEjB,CAAA;AAEV;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,OAAO,aAAa,CAAC,CAAA;AAE9E,sFAAsF;AACtF,MAAM,WAAW,QAAQ;IACvB,gEAAgE;IAChE,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAA;IAC7B,qFAAqF;IACrF,QAAQ,CAAC,cAAc,EAAE,SAAS,MAAM,EAAE,CAAA;IAC1C,mDAAmD;IACnD,QAAQ,CAAC,iBAAiB,EAAE,SAAS,aAAa,EAAE,CAAA;IACpD,kFAAkF;IAClF,QAAQ,CAAC,cAAc,EAAE,SAAS,MAAM,EAAE,GAAG,IAAI,CAAA;IACjD,4EAA4E;IAC5E,QAAQ,CAAC,aAAa,EAAE,SAAS,MAAM,EAAE,GAAG,IAAI,CAAA;IAChD,2EAA2E;IAC3E,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAA;CAC/B;AAED;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB;IAC9B,kGAAkG;;IAElG,yGAAyG;;IAEzG,sDAAsD;;CAE9C,CAAA;AAEV,yFAAyF;AACzF,MAAM,MAAM,mBAAmB,GAAG,CAAC,OAAO,mBAAmB,CAAC,CAAC,MAAM,OAAO,mBAAmB,CAAC,CAAA;AAEhG,gDAAgD;AAChD,MAAM,WAAW,eAAe;IAC9B,sCAAsC;IACtC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,0CAA0C;IAC1C,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAA;CAChC;AAED,6EAA6E;AAC7E,MAAM,WAAW,qBAAqB;IACpC,qCAAqC;IACrC,QAAQ,CAAC,IAAI,EAAE,mBAAmB,CAAA;IAClC,uDAAuD;IACvD,QAAQ,CAAC,MAAM,EAAE,eAAe,GAAG,IAAI,CAAA;CACxC;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB,qCAAqC;IACrC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAA;IAC7B,yCAAyC;IACzC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;IAC3B,2CAA2C;IAC3C,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAC3B,mCAAmC;IACnC,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAA;IAC/B,4DAA4D;IAC5D,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC3C,4CAA4C;IAC5C,QAAQ,CAAC,SAAS,EAAE,SAAS,QAAQ,EAAE,CAAA;IACvC,2EAA2E;IAC3E,QAAQ,CAAC,2BAA2B,EAAE,iBAAiB,CAAA;IACvD,mFAAmF;IACnF,QAAQ,CAAC,qBAAqB,EAAE;QAC9B,mEAAmE;QACnE,QAAQ,CAAC,wBAAwB,EAAE,OAAO,CAAA;QAC1C,0EAA0E;QAC1E,QAAQ,CAAC,KAAK,EAAE;YACd,qDAAqD;YACrD,QAAQ,CAAC,iBAAiB,EAAE,OAAO,CAAA;YACnC,yDAAyD;YACzD,QAAQ,CAAC,gBAAgB,EAAE,qBAAqB,CAAA;SACjD,GAAG,IAAI,CAAA;KACT,CAAA;IACD,iDAAiD;IACjD,QAAQ,CAAC,cAAc,EAAE,SAAS,aAAa,EAAE,CAAA;IACjD,4DAA4D;IAC5D,QAAQ,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,CAAA;IACnC,mFAAmF;IACnF,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,yDAAyD;IACzD,QAAQ,CAAC,gBAAgB,EAAE,qBAAqB,CAAA;IAChD,8DAA8D;IAC9D,QAAQ,CAAC,wBAAwB,EAAE,wBAAwB,CAAA;CAC5D;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,4CAA4C;IAC5C,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAA;IAC7B,2CAA2C;IAC3C,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAC3B,mCAAmC;IACnC,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAA;IAC/B,gDAAgD;IAChD,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC5C,2BAA2B;IAC3B,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,QAAQ,EAAE,CAAA;IACxC,uDAAuD;IACvD,QAAQ,CAAC,2BAA2B,CAAC,EAAE,iBAAiB,CAAA;IACxD,qDAAqD;IACrD,QAAQ,CAAC,gBAAgB,CAAC,EAAE,qBAAqB,CAAA;IACjD,qFAAqF;IACrF,QAAQ,CAAC,eAAe,CAAC,EAAE,OAAO,CAAA;IAClC,gCAAgC;IAChC,QAAQ,CAAC,cAAc,CAAC,EAAE,SAAS,aAAa,EAAE,CAAA;IAClD,0CAA0C;IAC1C,QAAQ,CAAC,wBAAwB,CAAC,EAAE,wBAAwB,CAAA;CAC7D;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,oCAAoC;IACpC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAA;IAC7B,kCAAkC;IAClC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;IAC3B,uCAAuC;IACvC,QAAQ,CAAC,UAAU,CAAC,EAAE,UAAU,CAAA;IAChC,+EAA+E;IAC/E,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC5C,uDAAuD;IACvD,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,QAAQ,EAAE,CAAA;IACxC,sDAAsD;IACtD,QAAQ,CAAC,2BAA2B,CAAC,EAAE,iBAAiB,CAAA;IACxD,oDAAoD;IACpD,QAAQ,CAAC,gBAAgB,CAAC,EAAE,qBAAqB,CAAA;IACjD,mFAAmF;IACnF,QAAQ,CAAC,eAAe,CAAC,EAAE,OAAO,CAAA;IAClC,4DAA4D;IAC5D,QAAQ,CAAC,cAAc,CAAC,EAAE,SAAS,aAAa,EAAE,CAAA;IAClD,yCAAyC;IACzC,QAAQ,CAAC,wBAAwB,CAAC,EAAE,wBAAwB,CAAA;IAC5D,2FAA2F;IAC3F,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAA;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,qCAAqC;IACrC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAA;IAC7B,8DAA8D;IAC9D,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAA;IAC5B,gEAAgE;IAChE,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAA;IAC5B,6DAA6D;IAC7D,QAAQ,CAAC,WAAW,CAAC,EAAE,SAAS,UAAU,EAAE,CAAA;CAC7C;AAED,oDAAoD;AACpD,MAAM,WAAW,mBAAmB;IAClC,qDAAqD;IACrD,QAAQ,CAAC,OAAO,EAAE,SAAS,UAAU,EAAE,CAAA;CACxC;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,oCAAoC;IACpC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAA;IAC7B,4DAA4D;IAC5D,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;CAC5B"}

package/dist/types/bucket.js

@@ -0,0 +1,44 @@
+const BucketType = {
+  /** Publicly downloadable without authentication. */
+  AllPublic: "allPublic",
+  /** Requires a valid auth token to download. */
+  AllPrivate: "allPrivate",
+  /** Internal snapshot bucket type, generally not user-created. */
+  Snapshot: "snapshot",
+  /** B2-restricted bucket (e.g., for S3-compatible workflows). */
+  Restricted: "restricted"
+};
+const CorsOperation = {
+  /** Native B2 download-by-name request. */
+  B2DownloadFileByName: "b2_download_file_by_name",
+  /** Native B2 download-by-id request. */
+  B2DownloadFileById: "b2_download_file_by_id",
+  /** Native B2 small-file upload. */
+  B2UploadFile: "b2_upload_file",
+  /** Native B2 multipart-part upload. */
+  B2UploadPart: "b2_upload_part",
+  /** S3-compatible DELETE. */
+  S3Delete: "s3_delete",
+  /** S3-compatible GET. */
+  S3Get: "s3_get",
+  /** S3-compatible HEAD. */
+  S3Head: "s3_head",
+  /** S3-compatible POST. */
+  S3Post: "s3_post",
+  /** S3-compatible PUT. */
+  S3Put: "s3_put"
+};
+const BucketRetentionMode = {
+  /** Files cannot be deleted or modified during the retention period, even by the account owner. */
+  Compliance: "compliance",
+  /** Files cannot be deleted during retention except by callers with the `bypassGovernance` capability. */
+  Governance: "governance",
+  /** No default retention is applied to new uploads. */
+  None: "none"
+};
+export {
+  BucketRetentionMode,
+  BucketType,
+  CorsOperation
+};
+//# sourceMappingURL=bucket.js.map

package/dist/types/bucket.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bucket.js","sources":["../../src/types/bucket.ts"],"sourcesContent":["import type { EncryptionSetting } from './encryption.ts'\nimport type { AccountId, BucketId } from './ids.ts'\nimport type { ReplicationConfiguration } from './replication.ts'\n\n/**\n * Named constants for the bucket access level.\n *\n * The {@link BucketType} type alias is derived from the values of this\n * object, so the const is the single source of truth: adding a key here\n * automatically widens the type union.\n *\n * @example\n * ```ts\n * await client.createBucket({ bucketName: 'my-app-logs', bucketType: BucketType.AllPrivate })\n * ```\n */\nexport const BucketType = {\n  /** Publicly downloadable without authentication. */\n  AllPublic: 'allPublic',\n  /** Requires a valid auth token to download. */\n  AllPrivate: 'allPrivate',\n  /** Internal snapshot bucket type, generally not user-created. */\n  Snapshot: 'snapshot',\n  /** B2-restricted bucket (e.g., for S3-compatible workflows). */\n  Restricted: 'restricted',\n} as const\n\n/** Access level for a B2 bucket. Derived from {@link BucketType}. */\nexport type BucketType = (typeof BucketType)[keyof typeof BucketType]\n\n/** Rule that automatically hides or deletes files after a specified number of days. */\nexport interface LifecycleRule {\n  /** Days after hiding before automatic deletion, or null to never auto-delete hidden files. */\n  readonly daysFromHidingToDeleting: number | null\n  /** Days after upload before automatic hiding, or null to never auto-hide. */\n  readonly daysFromUploadingToHiding: number | null\n  /** File name prefix this rule applies to. Empty string matches all files. */\n  readonly fileNamePrefix: string\n}\n\n/**\n * Named constants for the B2 + S3 operations a CORS rule can permit.\n *\n * @example\n * ```ts\n * await bucket.update({\n *   corsRules: [{\n *     corsRuleName: 'browser-downloads',\n *     allowedOrigins: ['https://example.com'],\n *     allowedOperations: [CorsOperation.B2DownloadFileByName, CorsOperation.S3Get],\n *     allowedHeaders: null,\n *     exposeHeaders: null,\n *     maxAgeSeconds: 3600,\n *   }],\n * })\n * ```\n */\nexport const CorsOperation = {\n  /** Native B2 download-by-name request. */\n  B2DownloadFileByName: 'b2_download_file_by_name',\n  /** Native B2 download-by-id request. */\n  B2DownloadFileById: 'b2_download_file_by_id',\n  /** Native B2 small-file upload. */\n  B2UploadFile: 'b2_upload_file',\n  /** Native B2 multipart-part upload. */\n  B2UploadPart: 'b2_upload_part',\n  /** S3-compatible DELETE. */\n  S3Delete: 's3_delete',\n  /** S3-compatible GET. */\n  S3Get: 's3_get',\n  /** S3-compatible HEAD. */\n  S3Head: 's3_head',\n  /** S3-compatible POST. */\n  S3Post: 's3_post',\n  /** S3-compatible PUT. */\n  S3Put: 's3_put',\n} as const\n\n/**\n * A B2 or S3 operation that a CORS rule can permit. Derived from\n * {@link CorsOperation}.\n */\nexport type CorsOperation = (typeof CorsOperation)[keyof typeof CorsOperation]\n\n/** Cross-Origin Resource Sharing (CORS) rule for browser-based access to a bucket. */\nexport interface CorsRule {\n  /** Unique name identifying this CORS rule within the bucket. */\n  readonly corsRuleName: string\n  /** Origins allowed to make cross-origin requests (e.g., `'https://example.com'`). */\n  readonly allowedOrigins: readonly string[]\n  /** B2 and S3 operations permitted by this rule. */\n  readonly allowedOperations: readonly CorsOperation[]\n  /** Request headers allowed in preflight requests, or null if none are allowed. */\n  readonly allowedHeaders: readonly string[] | null\n  /** Response headers exposed to the browser, or null if none are exposed. */\n  readonly exposeHeaders: readonly string[] | null\n  /** Maximum time (in seconds) browsers may cache the preflight response. */\n  readonly maxAgeSeconds: number\n}\n\n/**\n * Named constants for the bucket-level Object Lock retention mode.\n *\n * Pair with {@link BucketRetentionPolicy} when setting a bucket's default\n * retention: `{ mode: BucketRetentionMode.Compliance, period: { duration: 30, unit: 'days' } }`.\n */\nexport const BucketRetentionMode = {\n  /** Files cannot be deleted or modified during the retention period, even by the account owner. */\n  Compliance: 'compliance',\n  /** Files cannot be deleted during retention except by callers with the `bypassGovernance` capability. */\n  Governance: 'governance',\n  /** No default retention is applied to new uploads. */\n  None: 'none',\n} as const\n\n/** Bucket-level Object Lock retention mode. Derived from {@link BucketRetentionMode}. */\nexport type BucketRetentionMode = (typeof BucketRetentionMode)[keyof typeof BucketRetentionMode]\n\n/** Duration and unit for a retention period. */\nexport interface RetentionPeriod {\n  /** Length of the retention period. */\n  readonly duration: number\n  /** Time unit for the retention period. */\n  readonly unit: 'days' | 'years'\n}\n\n/** Default Object Lock retention policy applied to new files in a bucket. */\nexport interface BucketRetentionPolicy {\n  /** Retention mode for the policy. */\n  readonly mode: BucketRetentionMode\n  /** Retention period, or null when mode is `'none'`. */\n  readonly period: RetentionPeriod | null\n}\n\n/**\n * Complete bucket metadata as returned by the B2 API.\n * Corresponds to the bucket object in responses from `b2_list_buckets`, `b2_create_bucket`, and `b2_update_bucket`.\n */\nexport interface BucketInfo {\n  /** Account that owns this bucket. */\n  readonly accountId: AccountId\n  /** Unique identifier for this bucket. */\n  readonly bucketId: BucketId\n  /** Globally unique name of this bucket. */\n  readonly bucketName: string\n  /** Access level of this bucket. */\n  readonly bucketType: BucketType\n  /** User-defined key-value metadata stored on the bucket. */\n  readonly bucketInfo: Record<string, string>\n  /** CORS rules configured on this bucket. */\n  readonly corsRules: readonly CorsRule[]\n  /** Default server-side encryption setting for new files in this bucket. */\n  readonly defaultServerSideEncryption: EncryptionSetting\n  /** File Lock configuration including authorization status and current settings. */\n  readonly fileLockConfiguration: {\n    /** Whether the caller is authorized to read file lock settings. */\n    readonly isClientAuthorizedToRead: boolean\n    /** File lock settings, or null if the caller lacks read authorization. */\n    readonly value: {\n      /** Whether Object Lock is enabled on this bucket. */\n      readonly isFileLockEnabled: boolean\n      /** Default retention policy for newly uploaded files. */\n      readonly defaultRetention: BucketRetentionPolicy\n    } | null\n  }\n  /** Lifecycle rules configured on this bucket. */\n  readonly lifecycleRules: readonly LifecycleRule[]\n  /** Set of options enabled on this bucket (e.g., `'s3'`). */\n  readonly options: readonly string[]\n  /** Monotonically increasing revision number, incremented on each bucket update. */\n  readonly revision: number\n  /** Default retention policy for newly uploaded files. */\n  readonly defaultRetention: BucketRetentionPolicy\n  /** Cross-region replication configuration for this bucket. */\n  readonly replicationConfiguration: ReplicationConfiguration\n}\n\n/**\n * Request parameters for the `b2_create_bucket` API call.\n */\nexport interface CreateBucketRequest {\n  /** Account that will own the new bucket. */\n  readonly accountId: AccountId\n  /** Globally unique name for the bucket. */\n  readonly bucketName: string\n  /** Access level for the bucket. */\n  readonly bucketType: BucketType\n  /** Optional user-defined key-value metadata. */\n  readonly bucketInfo?: Record<string, string>\n  /** Optional CORS rules. */\n  readonly corsRules?: readonly CorsRule[]\n  /** Optional default server-side encryption setting. */\n  readonly defaultServerSideEncryption?: EncryptionSetting\n  /** Optional default Object Lock retention policy. */\n  readonly defaultRetention?: BucketRetentionPolicy\n  /** Whether to enable Object Lock on the bucket. Cannot be changed after creation. */\n  readonly fileLockEnabled?: boolean\n  /** Optional lifecycle rules. */\n  readonly lifecycleRules?: readonly LifecycleRule[]\n  /** Optional replication configuration. */\n  readonly replicationConfiguration?: ReplicationConfiguration\n}\n\n/**\n * Request parameters for the `b2_update_bucket` API call.\n */\nexport interface UpdateBucketRequest {\n  /** Account that owns the bucket. */\n  readonly accountId: AccountId\n  /** ID of the bucket to update. */\n  readonly bucketId: BucketId\n  /** New access level for the bucket. */\n  readonly bucketType?: BucketType\n  /** Updated user-defined key-value metadata. Replaces all existing metadata. */\n  readonly bucketInfo?: Record<string, string>\n  /** Updated CORS rules. Replaces all existing rules. */\n  readonly corsRules?: readonly CorsRule[]\n  /** Updated default server-side encryption setting. */\n  readonly defaultServerSideEncryption?: EncryptionSetting\n  /** Updated default Object Lock retention policy. */\n  readonly defaultRetention?: BucketRetentionPolicy\n  /** Whether to enable Object Lock. Can only transition from disabled to enabled. */\n  readonly fileLockEnabled?: boolean\n  /** Updated lifecycle rules. Replaces all existing rules. */\n  readonly lifecycleRules?: readonly LifecycleRule[]\n  /** Updated replication configuration. */\n  readonly replicationConfiguration?: ReplicationConfiguration\n  /** Optimistic locking: only update if the bucket's current revision matches this value. */\n  readonly ifRevisionIs?: number\n}\n\n/**\n * Request parameters for the `b2_list_buckets` API call.\n */\nexport interface ListBucketsRequest {\n  /** Account whose buckets to list. */\n  readonly accountId: AccountId\n  /** Optional filter to return only the bucket with this ID. */\n  readonly bucketId?: BucketId\n  /** Optional filter to return only the bucket with this name. */\n  readonly bucketName?: string\n  /** Optional filter to return only buckets of these types. */\n  readonly bucketTypes?: readonly BucketType[]\n}\n\n/** Response from the `b2_list_buckets` API call. */\nexport interface ListBucketsResponse {\n  /** Array of buckets matching the request filters. */\n  readonly buckets: readonly BucketInfo[]\n}\n\n/**\n * Request parameters for the `b2_delete_bucket` API call.\n */\nexport interface DeleteBucketRequest {\n  /** Account that owns the bucket. */\n  readonly accountId: AccountId\n  /** ID of the bucket to delete. The bucket must be empty. */\n  readonly bucketId: BucketId\n}\n"],"names":[],"mappings":"AAgBO,MAAM,aAAa;AAAA;AAAA,EAExB,WAAW;AAAA;AAAA,EAEX,YAAY;AAAA;AAAA,EAEZ,UAAU;AAAA;AAAA,EAEV,YAAY;AACd;AAgCO,MAAM,gBAAgB;AAAA;AAAA,EAE3B,sBAAsB;AAAA;AAAA,EAEtB,oBAAoB;AAAA;AAAA,EAEpB,cAAc;AAAA;AAAA,EAEd,cAAc;AAAA;AAAA,EAEd,UAAU;AAAA;AAAA,EAEV,OAAO;AAAA;AAAA,EAEP,QAAQ;AAAA;AAAA,EAER,QAAQ;AAAA;AAAA,EAER,OAAO;AACT;AA8BO,MAAM,sBAAsB;AAAA;AAAA,EAEjC,YAAY;AAAA;AAAA,EAEZ,YAAY;AAAA;AAAA,EAEZ,MAAM;AACR;"}