@backblaze-labs/b2-sdk 0.2.0 → 0.4.0

package/dist/types/bucket.d.ts

@@ -1,12 +1,8 @@
-import { EncryptionSetting } from './encryption.js';
+import { NoEncryption, PublicEncryptionSetting, SseB2Setting } 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.
+ * Named constants for bucket types accepted by create/update bucket requests.
  *
  * @example
  * ```ts
@@ -23,14 +19,78 @@ export declare const BucketType: {
     /** B2-restricted bucket (e.g., for S3-compatible workflows). */
     readonly Restricted: "restricted";
 };
-/** Access level for a B2 bucket. Derived from {@link BucketType}. */
+/** Bucket access levels accepted by B2 bucket create/update requests. */
 export type BucketType = (typeof BucketType)[keyof typeof BucketType];
+/** Named constants for documented bucket response types known to the SDK. */
+export declare const KnownBucketResponseType: {
+    /** Response-only bucket type for buckets shared with the account. */
+    readonly Shared: "shared";
+    /** 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";
+};
+/** Closed union of documented bucket response types known to the SDK. */
+export type KnownBucketResponseType = (typeof KnownBucketResponseType)[keyof typeof KnownBucketResponseType];
+/** Bucket type returned by B2 bucket responses, including future B2-added values. */
+export type BucketResponseType = KnownBucketResponseType | (string & {});
+/**
+ * Bucket type value accepted by `b2_list_buckets.bucketTypes`.
+ *
+ * This includes future B2-added strings, so TypeScript cannot statically exclude
+ * the special `'all'` value from this open string type. Runtime validation still
+ * enforces that `'all'` is only valid as `['all']` and that filters are non-empty.
+ */
+export type BucketListType = BucketResponseType;
+/**
+ * Bucket type filter accepted by `b2_list_buckets`.
+ *
+ * Use `['all']` by itself to request all bucket types. Other filters may include
+ * documented response types such as `'shared'` and future B2-added type strings.
+ * Because future bucket types are modeled as an open string, TypeScript cannot
+ * reject empty arrays or mixed arrays containing `'all'`; B2 and the simulator
+ * reject them at runtime.
+ */
+export type BucketTypesFilter = readonly ['all'] | readonly BucketListType[];
+/**
+ * Named constants for option flags returned on buckets and application keys.
+ *
+ * B2 currently documents only the S3-compatible API option.
+ */
+export declare const BucketKeyOption: {
+    /** Enables the S3-compatible API surface for the bucket or key. */
+    readonly S3: "s3";
+};
+/** Documented option flag returned on bucket and application key metadata. */
+export type KnownBucketKeyOption = (typeof BucketKeyOption)[keyof typeof BucketKeyOption];
+/** Option flag returned on bucket and application key metadata, open to future B2-added strings. */
+export type BucketKeyOption = KnownBucketKeyOption | (string & {});
+/** Minimum UTF-8 byte length for each bucketInfo key. */
+export declare const BUCKET_INFO_KEY_MIN_BYTES = 1;
+/** Maximum UTF-8 byte length for each bucketInfo key. */
+export declare const BUCKET_INFO_KEY_MAX_BYTES = 50;
+/** Maximum aggregate UTF-8 byte length of all bucketInfo values. */
+export declare const BUCKET_INFO_VALUES_MAX_BYTES = 10000;
+/** Reserved bucketInfo key prefix used by Backblaze. */
+export declare const BUCKET_INFO_RESERVED_PREFIX = "b2-";
+/**
+ * BucketInfo keys must match this regular-expression source. B2 accepts
+ * letters, digits, and these characters: `. _ ~ ! # $ % ^ & * ' | + -` plus the
+ * backtick.
+ */
+export declare const BUCKET_INFO_KEY_PATTERN = "^[A-Za-z0-9._`~!#$%^&*'|+-]+$";
 /** 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;
+    readonly daysFromHidingToDeleting?: number | null;
     /** Days after upload before automatic hiding, or null to never auto-hide. */
-    readonly daysFromUploadingToHiding: number | null;
+    readonly daysFromUploadingToHiding?: number | null;
+    /** Days after starting before automatic cancellation of unfinished large files, or null to never auto-cancel. */
+    readonly daysFromStartingToCancelingUnfinishedLargeFiles?: number | null;
     /** File name prefix this rule applies to. Empty string matches all files. */
     readonly fileNamePrefix: string;
 }
@@ -60,35 +120,81 @@ export declare const CorsOperation: {
     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. */
+    /**
+     * S3-compatible POST.
+     *
+     * @deprecated B2 bucket CORS rules do not accept `s3_post`. This member is
+     * preserved so existing imports continue to compile. Use one of
+     * {@link CORS_ALLOWED_OPERATIONS} for newly validated bucket CORS rules.
+     */
     readonly S3Post: "s3_post";
     /** S3-compatible PUT. */
     readonly S3Put: "s3_put";
+    /** S3-compatible HEAD. */
+    readonly S3Head: "s3_head";
+    /** S3-compatible DELETE. */
+    readonly S3Delete: "s3_delete";
 };
 /**
  * A B2 or S3 operation that a CORS rule can permit. Derived from
  * {@link CorsOperation}.
+ *
+ * @remarks This includes the deprecated `s3_post` compatibility member. Use
+ * {@link CorsAllowedOperation} for bucket CORS rules accepted by B2.
  */
 export type CorsOperation = (typeof CorsOperation)[keyof typeof CorsOperation];
-/** Cross-Origin Resource Sharing (CORS) rule for browser-based access to a bucket. */
+/** All CORS operations accepted by B2 bucket CORS rules. */
+export declare const CORS_ALLOWED_OPERATIONS: readonly ["b2_download_file_by_name", "b2_download_file_by_id", "b2_upload_file", "b2_upload_part", "s3_get", "s3_put", "s3_head", "s3_delete"];
+/** B2 bucket CORS operation values accepted by validated CORS rules. */
+export type CorsAllowedOperation = (typeof CORS_ALLOWED_OPERATIONS)[number];
+/** Maximum number of CORS rules allowed on a bucket. */
+export declare const CORS_RULES_MAX_COUNT = 100;
+/** Minimum character length for a CORS rule name. */
+export declare const CORS_RULE_NAME_MIN_LENGTH = 6;
+/** Maximum character length for a CORS rule name. */
+export declare const CORS_RULE_NAME_MAX_LENGTH = 63;
+/** CORS rule names must match this regular-expression source. */
+export declare const CORS_RULE_NAME_PATTERN = "^[A-Za-z0-9-]+$";
+/** Reserved CORS rule-name prefix used by Backblaze. */
+export declare const CORS_RULE_NAME_RESERVED_PREFIX = "b2-";
+/** Exclusive UTF-8 byte-size ceiling for each CORS rule definition. */
+export declare const CORS_RULE_MAX_BYTES = 1000;
+/** Maximum accepted CORS preflight cache duration in seconds. */
+export declare const CORS_MAX_AGE_SECONDS_MAX = 86400;
+/**
+ * Cross-Origin Resource Sharing (CORS) rule for browser-based access to a bucket.
+ * A bucket may have up to {@link CORS_RULES_MAX_COUNT} rules, and each rule's
+ * name, allowed origins, allowed operations, allowed headers, and exposed
+ * headers must total less than {@link CORS_RULE_MAX_BYTES} UTF-8 bytes.
+ */
 export interface CorsRule {
-    /** Unique name identifying this CORS rule within the bucket. */
+    /**
+     * Unique name identifying this CORS rule within the bucket.
+     * Must be 6-63 characters, match `[A-Za-z0-9-]`, and not start with `b2-`.
+     */
     readonly corsRuleName: string;
-    /** Origins allowed to make cross-origin requests (e.g., `'https://example.com'`). */
+    /**
+     * Origins allowed to make cross-origin requests (e.g., `'https://example.com'`).
+     * At least one origin is required.
+     */
     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. */
+    /**
+     * B2 and S3 operations permitted by this rule.
+     * At least one operation is required, and every value must be from
+     * {@link CORS_ALLOWED_OPERATIONS}.
+     */
+    readonly allowedOperations: readonly CorsAllowedOperation[];
+    /**
+     * Request headers allowed in preflight requests, or null/omitted if none are allowed.
+     */
+    readonly allowedHeaders?: readonly string[] | null;
+    /**
+     * Response headers exposed to the browser, or null/omitted if none are exposed.
+     */
+    readonly exposeHeaders?: readonly string[] | null;
+    /** Maximum time (0-86400 seconds) browsers may cache the preflight response. */
     readonly maxAgeSeconds: number;
 }
 /**
@@ -121,6 +227,26 @@ export interface BucketRetentionPolicy {
     /** Retention period, or null when mode is `'none'`. */
     readonly period: RetentionPeriod | null;
 }
+/** B2 response shape for a bucket with no default Object Lock retention. */
+export interface NoBucketDefaultRetention {
+    /** B2 returns null when no bucket default retention policy is configured. */
+    readonly mode: null;
+    /** No retention period is configured. */
+    readonly period: null;
+}
+/** Default Object Lock retention as returned in bucket metadata. */
+export type BucketDefaultRetention = BucketRetentionPolicy | NoBucketDefaultRetention;
+/** Cross-region replication settings as returned by readable B2 bucket metadata. */
+export interface ReadableReplicationConfiguration {
+    /** Whether the caller is authorized to read replication settings. */
+    readonly isClientAuthorizedToRead: boolean;
+    /** Replication settings, or null when none are configured or the caller is not authorized to read them. */
+    readonly value: ReplicationConfiguration | null;
+}
+/** Bucket default server-side encryption setting returned by B2 bucket responses. */
+export type BucketDefaultServerSideEncryption = PublicEncryptionSetting;
+/** Bucket default server-side encryption setting accepted by B2 bucket requests. */
+export type BucketDefaultServerSideEncryptionSetting = SseB2Setting | NoEncryption;
 /**
  * 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`.
@@ -132,14 +258,19 @@ export interface BucketInfo {
     readonly bucketId: BucketId;
     /** Globally unique name of this bucket. */
     readonly bucketName: string;
-    /** Access level of this bucket. */
-    readonly bucketType: BucketType;
+    /** Access level or response-only type of this bucket. */
+    readonly bucketType: BucketResponseType;
     /** 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;
+    readonly defaultServerSideEncryption: {
+        /** Whether the caller is authorized to read default server-side encryption settings. */
+        readonly isClientAuthorizedToRead: boolean;
+        /** Default server-side encryption settings, or null if the caller lacks read authorization. */
+        readonly value: BucketDefaultServerSideEncryption | null;
+    };
     /** File Lock configuration including authorization status and current settings. */
     readonly fileLockConfiguration: {
         /** Whether the caller is authorized to read file lock settings. */
@@ -149,19 +280,17 @@ export interface BucketInfo {
             /** Whether Object Lock is enabled on this bucket. */
             readonly isFileLockEnabled: boolean;
             /** Default retention policy for newly uploaded files. */
-            readonly defaultRetention: BucketRetentionPolicy;
+            readonly defaultRetention: BucketDefaultRetention;
         } | 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[];
+    /** Set of options enabled on this bucket (e.g., {@link BucketKeyOption.S3}). */
+    readonly options: readonly BucketKeyOption[];
     /** 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;
+    /** Cross-region replication configuration, filtered by caller authorization. */
+    readonly replicationConfiguration: ReadableReplicationConfiguration;
 }
 /**
  * Request parameters for the `b2_create_bucket` API call.
@@ -173,12 +302,24 @@ export interface CreateBucketRequest {
     readonly bucketName: string;
     /** Access level for the bucket. */
     readonly bucketType: BucketType;
-    /** Optional user-defined key-value metadata. */
+    /**
+     * Optional user-defined key-value metadata.
+     * Keys must be 1-50 UTF-8 bytes and must not start with `b2-`; the aggregate
+     * UTF-8 byte length of all values must be at most 10,000 bytes. Keys must
+     * match {@link BUCKET_INFO_KEY_PATTERN}. BucketInfo has no documented
+     * pair-count cap.
+     */
     readonly bucketInfo?: Record<string, string>;
-    /** Optional CORS rules. */
+    /**
+     * Optional CORS rules.
+     * A bucket may have at most 100 rules. Each rule name must be unique, 6-63
+     * characters, match `[A-Za-z0-9-]`, and not start with `b2-`. Each rule's
+     * name, origins, operations, allowed headers, and exposed headers must total
+     * less than 1,000 UTF-8 bytes. `maxAgeSeconds` must be at most 86,400.
+     */
     readonly corsRules?: readonly CorsRule[];
     /** Optional default server-side encryption setting. */
-    readonly defaultServerSideEncryption?: EncryptionSetting;
+    readonly defaultServerSideEncryption?: BucketDefaultServerSideEncryptionSetting;
     /** Optional default Object Lock retention policy. */
     readonly defaultRetention?: BucketRetentionPolicy;
     /** Whether to enable Object Lock on the bucket. Cannot be changed after creation. */
@@ -198,12 +339,24 @@ export interface UpdateBucketRequest {
     readonly bucketId: BucketId;
     /** New access level for the bucket. */
     readonly bucketType?: BucketType;
-    /** Updated user-defined key-value metadata. Replaces all existing metadata. */
+    /**
+     * Updated user-defined key-value metadata. Replaces all existing metadata.
+     * Keys must be 1-50 UTF-8 bytes and must not start with `b2-`; the aggregate
+     * UTF-8 byte length of all values must be at most 10,000 bytes. Keys must
+     * match {@link BUCKET_INFO_KEY_PATTERN}. BucketInfo has no documented
+     * pair-count cap.
+     */
     readonly bucketInfo?: Record<string, string>;
-    /** Updated CORS rules. Replaces all existing rules. */
+    /**
+     * Updated CORS rules. Replaces all existing rules.
+     * A bucket may have at most 100 rules. Each rule name must be unique, 6-63
+     * characters, match `[A-Za-z0-9-]`, and not start with `b2-`. Each rule's
+     * name, origins, operations, allowed headers, and exposed headers must total
+     * less than 1,000 UTF-8 bytes. `maxAgeSeconds` must be at most 86,400.
+     */
     readonly corsRules?: readonly CorsRule[];
     /** Updated default server-side encryption setting. */
-    readonly defaultServerSideEncryption?: EncryptionSetting;
+    readonly defaultServerSideEncryption?: BucketDefaultServerSideEncryptionSetting;
     /** Updated default Object Lock retention policy. */
     readonly defaultRetention?: BucketRetentionPolicy;
     /** Whether to enable Object Lock. Can only transition from disabled to enabled. */
@@ -226,7 +379,7 @@ export interface ListBucketsRequest {
     /** 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[];
+    readonly bucketTypes?: BucketTypesFilter;
 }
 /** Response from the `b2_list_buckets` API call. */
 export interface ListBucketsResponse {

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

@@ -1 +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"}
+{"version":3,"file":"bucket.d.ts","sourceRoot":"","sources":["../../src/types/bucket.js"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,uBAAuB,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AAC1F,OAAO,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAA;AACnD,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,kBAAkB,CAAA;AAEhE;;;;;;;GAOG;AACH,eAAO,MAAM,UAAU;IACrB,oDAAoD;;IAEpD,+CAA+C;;IAE/C,iEAAiE;;IAEjE,gEAAgE;;CAExD,CAAA;AAEV,yEAAyE;AACzE,MAAM,MAAM,UAAU,GAAG,CAAC,OAAO,UAAU,CAAC,CAAC,MAAM,OAAO,UAAU,CAAC,CAAA;AAErE,6EAA6E;AAC7E,eAAO,MAAM,uBAAuB;IAElC,qEAAqE;;IAhBrE,oDAAoD;;IAEpD,+CAA+C;;IAE/C,iEAAiE;;IAEjE,gEAAgE;;CAYxD,CAAA;AAEV,yEAAyE;AACzE,MAAM,MAAM,uBAAuB,GACjC,CAAC,OAAO,uBAAuB,CAAC,CAAC,MAAM,OAAO,uBAAuB,CAAC,CAAA;AAExE,qFAAqF;AACrF,MAAM,MAAM,kBAAkB,GAAG,uBAAuB,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAA;AAExE;;;;;;GAMG;AACH,MAAM,MAAM,cAAc,GAAG,kBAAkB,CAAA;AAE/C;;;;;;;;GAQG;AACH,MAAM,MAAM,iBAAiB,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,SAAS,cAAc,EAAE,CAAA;AAE5E;;;;GAIG;AACH,eAAO,MAAM,eAAe;IAC1B,mEAAmE;;CAE3D,CAAA;AAEV,8EAA8E;AAC9E,MAAM,MAAM,oBAAoB,GAAG,CAAC,OAAO,eAAe,CAAC,CAAC,MAAM,OAAO,eAAe,CAAC,CAAA;AAEzF,oGAAoG;AACpG,MAAM,MAAM,eAAe,GAAG,oBAAoB,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAA;AAElE,yDAAyD;AACzD,eAAO,MAAM,yBAAyB,IAAI,CAAA;AAC1C,yDAAyD;AACzD,eAAO,MAAM,yBAAyB,KAAK,CAAA;AAC3C,oEAAoE;AACpE,eAAO,MAAM,4BAA4B,QAAS,CAAA;AAClD,wDAAwD;AACxD,eAAO,MAAM,2BAA2B,QAAQ,CAAA;AAChD;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,kCAAkC,CAAA;AAEtE,uFAAuF;AACvF,MAAM,WAAW,aAAa;IAC5B,8FAA8F;IAC9F,QAAQ,CAAC,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACjD,6EAA6E;IAC7E,QAAQ,CAAC,yBAAyB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAClD,iHAAiH;IACjH,QAAQ,CAAC,+CAA+C,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACxE,6EAA6E;IAC7E,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAA;CAChC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,aAAa;IACxB,0CAA0C;;IAE1C,wCAAwC;;IAExC,mCAAmC;;IAEnC,uCAAuC;;IAEvC,yBAAyB;;IAEzB;;;;;;OAMG;;IAEH,yBAAyB;;IAEzB,0BAA0B;;IAE1B,4BAA4B;;CAEpB,CAAA;AAEV;;;;;;GAMG;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,OAAO,aAAa,CAAC,CAAA;AAE9E,4DAA4D;AAC5D,eAAO,MAAM,uBAAuB,iJASS,CAAA;AAE7C,wEAAwE;AACxE,MAAM,MAAM,oBAAoB,GAAG,CAAC,OAAO,uBAAuB,CAAC,CAAC,MAAM,CAAC,CAAA;AAE3E,wDAAwD;AACxD,eAAO,MAAM,oBAAoB,MAAM,CAAA;AACvC,qDAAqD;AACrD,eAAO,MAAM,yBAAyB,IAAI,CAAA;AAC1C,qDAAqD;AACrD,eAAO,MAAM,yBAAyB,KAAK,CAAA;AAC3C,iEAAiE;AACjE,eAAO,MAAM,sBAAsB,oBAAoB,CAAA;AACvD,wDAAwD;AACxD,eAAO,MAAM,8BAA8B,QAAQ,CAAA;AACnD,uEAAuE;AACvE,eAAO,MAAM,mBAAmB,OAAQ,CAAA;AACxC,iEAAiE;AACjE,eAAO,MAAM,wBAAwB,QAAS,CAAA;AAE9C;;;;;GAKG;AACH,MAAM,WAAW,QAAQ;IACvB;;;OAGG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAA;IAC7B;;;OAGG;IACH,QAAQ,CAAC,cAAc,EAAE,SAAS,MAAM,EAAE,CAAA;IAC1C;;;;OAIG;IACH,QAAQ,CAAC,iBAAiB,EAAE,SAAS,oBAAoB,EAAE,CAAA;IAC3D;;OAEG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,SAAS,MAAM,EAAE,GAAG,IAAI,CAAA;IAClD;;OAEG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,SAAS,MAAM,EAAE,GAAG,IAAI,CAAA;IACjD,gFAAgF;IAChF,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,4EAA4E;AAC5E,MAAM,WAAW,wBAAwB;IACvC,6EAA6E;IAC7E,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAA;IACnB,yCAAyC;IACzC,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAA;CACtB;AAED,oEAAoE;AACpE,MAAM,MAAM,sBAAsB,GAAG,qBAAqB,GAAG,wBAAwB,CAAA;AAErF,oFAAoF;AACpF,MAAM,WAAW,gCAAgC;IAC/C,qEAAqE;IACrE,QAAQ,CAAC,wBAAwB,EAAE,OAAO,CAAA;IAC1C,2GAA2G;IAC3G,QAAQ,CAAC,KAAK,EAAE,wBAAwB,GAAG,IAAI,CAAA;CAChD;AAED,qFAAqF;AACrF,MAAM,MAAM,iCAAiC,GAAG,uBAAuB,CAAA;AAEvE,oFAAoF;AACpF,MAAM,MAAM,wCAAwC,GAAG,YAAY,GAAG,YAAY,CAAA;AAElF;;;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,yDAAyD;IACzD,QAAQ,CAAC,UAAU,EAAE,kBAAkB,CAAA;IACvC,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;QACpC,wFAAwF;QACxF,QAAQ,CAAC,wBAAwB,EAAE,OAAO,CAAA;QAC1C,+FAA+F;QAC/F,QAAQ,CAAC,KAAK,EAAE,iCAAiC,GAAG,IAAI,CAAA;KACzD,CAAA;IACD,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,sBAAsB,CAAA;SAClD,GAAG,IAAI,CAAA;KACT,CAAA;IACD,iDAAiD;IACjD,QAAQ,CAAC,cAAc,EAAE,SAAS,aAAa,EAAE,CAAA;IACjD,gFAAgF;IAChF,QAAQ,CAAC,OAAO,EAAE,SAAS,eAAe,EAAE,CAAA;IAC5C,mFAAmF;IACnF,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,gFAAgF;IAChF,QAAQ,CAAC,wBAAwB,EAAE,gCAAgC,CAAA;CACpE;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;;;;;;OAMG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC5C;;;;;;OAMG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,QAAQ,EAAE,CAAA;IACxC,uDAAuD;IACvD,QAAQ,CAAC,2BAA2B,CAAC,EAAE,wCAAwC,CAAA;IAC/E,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;;;;;;OAMG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC5C;;;;;;OAMG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,QAAQ,EAAE,CAAA;IACxC,sDAAsD;IACtD,QAAQ,CAAC,2BAA2B,CAAC,EAAE,wCAAwC,CAAA;IAC/E,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,iBAAiB,CAAA;CACzC;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

@@ -1,10 +1,6 @@
 //#region src/types/bucket.ts
 /**
-* 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.
+* Named constants for bucket types accepted by create/update bucket requests.
 *
 * @example
 * ```ts
@@ -21,6 +17,34 @@ var BucketType = {
 	/** B2-restricted bucket (e.g., for S3-compatible workflows). */
 	Restricted: "restricted"
 };
+/** Named constants for documented bucket response types known to the SDK. */
+var KnownBucketResponseType = {
+	...BucketType,
+	/** Response-only bucket type for buckets shared with the account. */
+	Shared: "shared"
+};
+/**
+* Named constants for option flags returned on buckets and application keys.
+*
+* B2 currently documents only the S3-compatible API option.
+*/
+var BucketKeyOption = { 
+/** Enables the S3-compatible API surface for the bucket or key. */
+S3: "s3" };
+/** Minimum UTF-8 byte length for each bucketInfo key. */
+var BUCKET_INFO_KEY_MIN_BYTES = 1;
+/** Maximum UTF-8 byte length for each bucketInfo key. */
+var BUCKET_INFO_KEY_MAX_BYTES = 50;
+/** Maximum aggregate UTF-8 byte length of all bucketInfo values. */
+var BUCKET_INFO_VALUES_MAX_BYTES = 1e4;
+/** Reserved bucketInfo key prefix used by Backblaze. */
+var BUCKET_INFO_RESERVED_PREFIX = "b2-";
+/**
+* BucketInfo keys must match this regular-expression source. B2 accepts
+* letters, digits, and these characters: `. _ ~ ! # $ % ^ & * ' | + -` plus the
+* backtick.
+*/
+var BUCKET_INFO_KEY_PATTERN = "^[A-Za-z0-9._`~!#$%^&*'|+-]+$";
 /**
 * Named constants for the B2 + S3 operations a CORS rule can permit.
 *
@@ -47,17 +71,48 @@ var CorsOperation = {
 	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. */
+	/**
+	* S3-compatible POST.
+	*
+	* @deprecated B2 bucket CORS rules do not accept `s3_post`. This member is
+	* preserved so existing imports continue to compile. Use one of
+	* {@link CORS_ALLOWED_OPERATIONS} for newly validated bucket CORS rules.
+	*/
 	S3Post: "s3_post",
 	/** S3-compatible PUT. */
-	S3Put: "s3_put"
+	S3Put: "s3_put",
+	/** S3-compatible HEAD. */
+	S3Head: "s3_head",
+	/** S3-compatible DELETE. */
+	S3Delete: "s3_delete"
 };
+/** All CORS operations accepted by B2 bucket CORS rules. */
+var CORS_ALLOWED_OPERATIONS = [
+	CorsOperation.B2DownloadFileByName,
+	CorsOperation.B2DownloadFileById,
+	CorsOperation.B2UploadFile,
+	CorsOperation.B2UploadPart,
+	CorsOperation.S3Get,
+	CorsOperation.S3Put,
+	CorsOperation.S3Head,
+	CorsOperation.S3Delete
+];
+/** Maximum number of CORS rules allowed on a bucket. */
+var CORS_RULES_MAX_COUNT = 100;
+/** Minimum character length for a CORS rule name. */
+var CORS_RULE_NAME_MIN_LENGTH = 6;
+/** Maximum character length for a CORS rule name. */
+var CORS_RULE_NAME_MAX_LENGTH = 63;
+/** CORS rule names must match this regular-expression source. */
+var CORS_RULE_NAME_PATTERN = "^[A-Za-z0-9-]+$";
+/** Reserved CORS rule-name prefix used by Backblaze. */
+var CORS_RULE_NAME_RESERVED_PREFIX = "b2-";
+/** Exclusive UTF-8 byte-size ceiling for each CORS rule definition. */
+var CORS_RULE_MAX_BYTES = 1e3;
+/** Maximum accepted CORS preflight cache duration in seconds. */
+var CORS_MAX_AGE_SECONDS_MAX = 86400;
 /**
 * Named constants for the bucket-level Object Lock retention mode.
 *
@@ -73,6 +128,6 @@ var BucketRetentionMode = {
 	None: "none"
 };
 //#endregion
-export { BucketRetentionMode, BucketType, CorsOperation };
+export { BUCKET_INFO_KEY_MAX_BYTES, BUCKET_INFO_KEY_MIN_BYTES, BUCKET_INFO_KEY_PATTERN, BUCKET_INFO_RESERVED_PREFIX, BUCKET_INFO_VALUES_MAX_BYTES, BucketKeyOption, BucketRetentionMode, BucketType, CORS_ALLOWED_OPERATIONS, CORS_MAX_AGE_SECONDS_MAX, CORS_RULES_MAX_COUNT, CORS_RULE_MAX_BYTES, CORS_RULE_NAME_MAX_LENGTH, CORS_RULE_NAME_MIN_LENGTH, CORS_RULE_NAME_PATTERN, CORS_RULE_NAME_RESERVED_PREFIX, CorsOperation, KnownBucketResponseType };
 
 //# sourceMappingURL=bucket.js.map

package/dist/types/bucket.js.map

@@ -1 +1 @@
-{"version":3,"file":"bucket.js","names":[],"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"],"mappings":";;;;;;;;;;;;;AAgBA,IAAa,aAAa;;CAExB,WAAW;;CAEX,YAAY;;CAEZ,UAAU;;CAEV,YAAY;AACd;;;;;;;;;;;;;;;;;;AAgCA,IAAa,gBAAgB;;CAE3B,sBAAsB;;CAEtB,oBAAoB;;CAEpB,cAAc;;CAEd,cAAc;;CAEd,UAAU;;CAEV,OAAO;;CAEP,QAAQ;;CAER,QAAQ;;CAER,OAAO;AACT;;;;;;;AA8BA,IAAa,sBAAsB;;CAEjC,YAAY;;CAEZ,YAAY;;CAEZ,MAAM;AACR"}
+{"version":3,"file":"bucket.js","names":[],"sources":["../../src/types/bucket.ts"],"sourcesContent":["import type { NoEncryption, PublicEncryptionSetting, SseB2Setting } from './encryption.ts'\nimport type { AccountId, BucketId } from './ids.ts'\nimport type { ReplicationConfiguration } from './replication.ts'\n\n/**\n * Named constants for bucket types accepted by create/update bucket requests.\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/** Bucket access levels accepted by B2 bucket create/update requests. */\nexport type BucketType = (typeof BucketType)[keyof typeof BucketType]\n\n/** Named constants for documented bucket response types known to the SDK. */\nexport const KnownBucketResponseType = {\n  ...BucketType,\n  /** Response-only bucket type for buckets shared with the account. */\n  Shared: 'shared',\n} as const\n\n/** Closed union of documented bucket response types known to the SDK. */\nexport type KnownBucketResponseType =\n  (typeof KnownBucketResponseType)[keyof typeof KnownBucketResponseType]\n\n/** Bucket type returned by B2 bucket responses, including future B2-added values. */\nexport type BucketResponseType = KnownBucketResponseType | (string & {})\n\n/**\n * Bucket type value accepted by `b2_list_buckets.bucketTypes`.\n *\n * This includes future B2-added strings, so TypeScript cannot statically exclude\n * the special `'all'` value from this open string type. Runtime validation still\n * enforces that `'all'` is only valid as `['all']` and that filters are non-empty.\n */\nexport type BucketListType = BucketResponseType\n\n/**\n * Bucket type filter accepted by `b2_list_buckets`.\n *\n * Use `['all']` by itself to request all bucket types. Other filters may include\n * documented response types such as `'shared'` and future B2-added type strings.\n * Because future bucket types are modeled as an open string, TypeScript cannot\n * reject empty arrays or mixed arrays containing `'all'`; B2 and the simulator\n * reject them at runtime.\n */\nexport type BucketTypesFilter = readonly ['all'] | readonly BucketListType[]\n\n/**\n * Named constants for option flags returned on buckets and application keys.\n *\n * B2 currently documents only the S3-compatible API option.\n */\nexport const BucketKeyOption = {\n  /** Enables the S3-compatible API surface for the bucket or key. */\n  S3: 's3',\n} as const\n\n/** Documented option flag returned on bucket and application key metadata. */\nexport type KnownBucketKeyOption = (typeof BucketKeyOption)[keyof typeof BucketKeyOption]\n\n/** Option flag returned on bucket and application key metadata, open to future B2-added strings. */\nexport type BucketKeyOption = KnownBucketKeyOption | (string & {})\n\n/** Minimum UTF-8 byte length for each bucketInfo key. */\nexport const BUCKET_INFO_KEY_MIN_BYTES = 1\n/** Maximum UTF-8 byte length for each bucketInfo key. */\nexport const BUCKET_INFO_KEY_MAX_BYTES = 50\n/** Maximum aggregate UTF-8 byte length of all bucketInfo values. */\nexport const BUCKET_INFO_VALUES_MAX_BYTES = 10_000\n/** Reserved bucketInfo key prefix used by Backblaze. */\nexport const BUCKET_INFO_RESERVED_PREFIX = 'b2-'\n/**\n * BucketInfo keys must match this regular-expression source. B2 accepts\n * letters, digits, and these characters: `. _ ~ ! # $ % ^ & * ' | + -` plus the\n * backtick.\n */\nexport const BUCKET_INFO_KEY_PATTERN = \"^[A-Za-z0-9._`~!#$%^&*'|+-]+$\"\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  /** Days after starting before automatic cancellation of unfinished large files, or null to never auto-cancel. */\n  readonly daysFromStartingToCancelingUnfinishedLargeFiles?: 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 GET. */\n  S3Get: 's3_get',\n  /**\n   * S3-compatible POST.\n   *\n   * @deprecated B2 bucket CORS rules do not accept `s3_post`. This member is\n   * preserved so existing imports continue to compile. Use one of\n   * {@link CORS_ALLOWED_OPERATIONS} for newly validated bucket CORS rules.\n   */\n  S3Post: 's3_post',\n  /** S3-compatible PUT. */\n  S3Put: 's3_put',\n  /** S3-compatible HEAD. */\n  S3Head: 's3_head',\n  /** S3-compatible DELETE. */\n  S3Delete: 's3_delete',\n} as const\n\n/**\n * A B2 or S3 operation that a CORS rule can permit. Derived from\n * {@link CorsOperation}.\n *\n * @remarks This includes the deprecated `s3_post` compatibility member. Use\n * {@link CorsAllowedOperation} for bucket CORS rules accepted by B2.\n */\nexport type CorsOperation = (typeof CorsOperation)[keyof typeof CorsOperation]\n\n/** All CORS operations accepted by B2 bucket CORS rules. */\nexport const CORS_ALLOWED_OPERATIONS = [\n  CorsOperation.B2DownloadFileByName,\n  CorsOperation.B2DownloadFileById,\n  CorsOperation.B2UploadFile,\n  CorsOperation.B2UploadPart,\n  CorsOperation.S3Get,\n  CorsOperation.S3Put,\n  CorsOperation.S3Head,\n  CorsOperation.S3Delete,\n] as const satisfies readonly CorsOperation[]\n\n/** B2 bucket CORS operation values accepted by validated CORS rules. */\nexport type CorsAllowedOperation = (typeof CORS_ALLOWED_OPERATIONS)[number]\n\n/** Maximum number of CORS rules allowed on a bucket. */\nexport const CORS_RULES_MAX_COUNT = 100\n/** Minimum character length for a CORS rule name. */\nexport const CORS_RULE_NAME_MIN_LENGTH = 6\n/** Maximum character length for a CORS rule name. */\nexport const CORS_RULE_NAME_MAX_LENGTH = 63\n/** CORS rule names must match this regular-expression source. */\nexport const CORS_RULE_NAME_PATTERN = '^[A-Za-z0-9-]+$'\n/** Reserved CORS rule-name prefix used by Backblaze. */\nexport const CORS_RULE_NAME_RESERVED_PREFIX = 'b2-'\n/** Exclusive UTF-8 byte-size ceiling for each CORS rule definition. */\nexport const CORS_RULE_MAX_BYTES = 1_000\n/** Maximum accepted CORS preflight cache duration in seconds. */\nexport const CORS_MAX_AGE_SECONDS_MAX = 86_400\n\n/**\n * Cross-Origin Resource Sharing (CORS) rule for browser-based access to a bucket.\n * A bucket may have up to {@link CORS_RULES_MAX_COUNT} rules, and each rule's\n * name, allowed origins, allowed operations, allowed headers, and exposed\n * headers must total less than {@link CORS_RULE_MAX_BYTES} UTF-8 bytes.\n */\nexport interface CorsRule {\n  /**\n   * Unique name identifying this CORS rule within the bucket.\n   * Must be 6-63 characters, match `[A-Za-z0-9-]`, and not start with `b2-`.\n   */\n  readonly corsRuleName: string\n  /**\n   * Origins allowed to make cross-origin requests (e.g., `'https://example.com'`).\n   * At least one origin is required.\n   */\n  readonly allowedOrigins: readonly string[]\n  /**\n   * B2 and S3 operations permitted by this rule.\n   * At least one operation is required, and every value must be from\n   * {@link CORS_ALLOWED_OPERATIONS}.\n   */\n  readonly allowedOperations: readonly CorsAllowedOperation[]\n  /**\n   * Request headers allowed in preflight requests, or null/omitted if none are allowed.\n   */\n  readonly allowedHeaders?: readonly string[] | null\n  /**\n   * Response headers exposed to the browser, or null/omitted if none are exposed.\n   */\n  readonly exposeHeaders?: readonly string[] | null\n  /** Maximum time (0-86400 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/** B2 response shape for a bucket with no default Object Lock retention. */\nexport interface NoBucketDefaultRetention {\n  /** B2 returns null when no bucket default retention policy is configured. */\n  readonly mode: null\n  /** No retention period is configured. */\n  readonly period: null\n}\n\n/** Default Object Lock retention as returned in bucket metadata. */\nexport type BucketDefaultRetention = BucketRetentionPolicy | NoBucketDefaultRetention\n\n/** Cross-region replication settings as returned by readable B2 bucket metadata. */\nexport interface ReadableReplicationConfiguration {\n  /** Whether the caller is authorized to read replication settings. */\n  readonly isClientAuthorizedToRead: boolean\n  /** Replication settings, or null when none are configured or the caller is not authorized to read them. */\n  readonly value: ReplicationConfiguration | null\n}\n\n/** Bucket default server-side encryption setting returned by B2 bucket responses. */\nexport type BucketDefaultServerSideEncryption = PublicEncryptionSetting\n\n/** Bucket default server-side encryption setting accepted by B2 bucket requests. */\nexport type BucketDefaultServerSideEncryptionSetting = SseB2Setting | NoEncryption\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 or response-only type of this bucket. */\n  readonly bucketType: BucketResponseType\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: {\n    /** Whether the caller is authorized to read default server-side encryption settings. */\n    readonly isClientAuthorizedToRead: boolean\n    /** Default server-side encryption settings, or null if the caller lacks read authorization. */\n    readonly value: BucketDefaultServerSideEncryption | null\n  }\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: BucketDefaultRetention\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., {@link BucketKeyOption.S3}). */\n  readonly options: readonly BucketKeyOption[]\n  /** Monotonically increasing revision number, incremented on each bucket update. */\n  readonly revision: number\n  /** Cross-region replication configuration, filtered by caller authorization. */\n  readonly replicationConfiguration: ReadableReplicationConfiguration\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  /**\n   * Optional user-defined key-value metadata.\n   * Keys must be 1-50 UTF-8 bytes and must not start with `b2-`; the aggregate\n   * UTF-8 byte length of all values must be at most 10,000 bytes. Keys must\n   * match {@link BUCKET_INFO_KEY_PATTERN}. BucketInfo has no documented\n   * pair-count cap.\n   */\n  readonly bucketInfo?: Record<string, string>\n  /**\n   * Optional CORS rules.\n   * A bucket may have at most 100 rules. Each rule name must be unique, 6-63\n   * characters, match `[A-Za-z0-9-]`, and not start with `b2-`. Each rule's\n   * name, origins, operations, allowed headers, and exposed headers must total\n   * less than 1,000 UTF-8 bytes. `maxAgeSeconds` must be at most 86,400.\n   */\n  readonly corsRules?: readonly CorsRule[]\n  /** Optional default server-side encryption setting. */\n  readonly defaultServerSideEncryption?: BucketDefaultServerSideEncryptionSetting\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  /**\n   * Updated user-defined key-value metadata. Replaces all existing metadata.\n   * Keys must be 1-50 UTF-8 bytes and must not start with `b2-`; the aggregate\n   * UTF-8 byte length of all values must be at most 10,000 bytes. Keys must\n   * match {@link BUCKET_INFO_KEY_PATTERN}. BucketInfo has no documented\n   * pair-count cap.\n   */\n  readonly bucketInfo?: Record<string, string>\n  /**\n   * Updated CORS rules. Replaces all existing rules.\n   * A bucket may have at most 100 rules. Each rule name must be unique, 6-63\n   * characters, match `[A-Za-z0-9-]`, and not start with `b2-`. Each rule's\n   * name, origins, operations, allowed headers, and exposed headers must total\n   * less than 1,000 UTF-8 bytes. `maxAgeSeconds` must be at most 86,400.\n   */\n  readonly corsRules?: readonly CorsRule[]\n  /** Updated default server-side encryption setting. */\n  readonly defaultServerSideEncryption?: BucketDefaultServerSideEncryptionSetting\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?: BucketTypesFilter\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"],"mappings":";;;;;;;;;AAYA,IAAa,aAAa;;CAExB,WAAW;;CAEX,YAAY;;CAEZ,UAAU;;CAEV,YAAY;AACd;;AAMA,IAAa,0BAA0B;CACrC,GAAG;;CAEH,QAAQ;AACV;;;;;;AAkCA,IAAa,kBAAkB;;AAE7B,IAAI,KACN;;AASA,IAAa,4BAA4B;;AAEzC,IAAa,4BAA4B;;AAEzC,IAAa,+BAA+B;;AAE5C,IAAa,8BAA8B;;;;;;AAM3C,IAAa,0BAA0B;;;;;;;;;;;;;;;;;;AA+BvC,IAAa,gBAAgB;;CAE3B,sBAAsB;;CAEtB,oBAAoB;;CAEpB,cAAc;;CAEd,cAAc;;CAEd,OAAO;;;;;;;;CAQP,QAAQ;;CAER,OAAO;;CAEP,QAAQ;;CAER,UAAU;AACZ;;AAYA,IAAa,0BAA0B;CACrC,cAAc;CACd,cAAc;CACd,cAAc;CACd,cAAc;CACd,cAAc;CACd,cAAc;CACd,cAAc;CACd,cAAc;AAChB;;AAMA,IAAa,uBAAuB;;AAEpC,IAAa,4BAA4B;;AAEzC,IAAa,4BAA4B;;AAEzC,IAAa,yBAAyB;;AAEtC,IAAa,iCAAiC;;AAE9C,IAAa,sBAAsB;;AAEnC,IAAa,2BAA2B;;;;;;;AA2CxC,IAAa,sBAAsB;;CAEjC,YAAY;;CAEZ,YAAY;;CAEZ,MAAM;AACR"}

package/dist/types/download.cjs

@@ -0,0 +1,62 @@
+//#region src/types/download.ts
+/** HTTP response header names returned by B2 download endpoints. */
+var DownloadHeaderName = {
+	/** Header carrying the response content disposition. */
+	ContentDisposition: "Content-Disposition",
+	/** Header carrying the response content language. */
+	ContentLanguage: "Content-Language",
+	/** Header carrying the response content encoding. */
+	ContentEncoding: "Content-Encoding",
+	/** Header carrying the response content type. */
+	ContentType: "Content-Type",
+	/** Header carrying the response cache policy. */
+	CacheControl: "Cache-Control",
+	/** Header carrying the response expiration time. */
+	Expires: "Expires",
+	/** Header carrying the byte range returned for partial downloads. */
+	ContentRange: "Content-Range",
+	/** Header carrying the response content length. */
+	ContentLength: "Content-Length",
+	/** Header carrying the B2 SHA-1 metadata value. */
+	ContentSha1: "X-Bz-Content-Sha1",
+	/** Header carrying the downloaded file version ID. */
+	FileId: "X-Bz-File-Id",
+	/** Header carrying the URL-encoded downloaded file name. */
+	FileName: "X-Bz-File-Name",
+	/** Header carrying the file upload timestamp. */
+	UploadTimestamp: "X-Bz-Upload-Timestamp",
+	/** Header carrying the B2-managed server-side encryption algorithm. */
+	ServerSideEncryption: "X-Bz-Server-Side-Encryption",
+	/** Header carrying the SSE-C algorithm echo. */
+	ServerSideEncryptionCustomerAlgorithm: "X-Bz-Server-Side-Encryption-Customer-Algorithm",
+	/** Header carrying the SSE-C customer-key MD5 echo. */
+	ServerSideEncryptionCustomerKeyMd5: "X-Bz-Server-Side-Encryption-Customer-Key-Md5",
+	/** Header carrying the Object Lock retention mode. */
+	FileRetentionMode: "X-Bz-File-Retention-Mode",
+	/** Header carrying the Object Lock retain-until timestamp. */
+	FileRetentionRetainUntilTimestamp: "X-Bz-File-Retention-Retain-Until-Timestamp",
+	/** Header carrying the Object Lock legal-hold value. */
+	FileLegalHold: "X-Bz-File-Legal-Hold",
+	/** Header carrying names of metadata headers hidden by missing capabilities. */
+	ClientUnauthorizedToRead: "X-Bz-Client-Unauthorized-To-Read"
+};
+/** Documented download metadata markers B2 may hide when the caller lacks read capabilities. */
+var DownloadClientUnauthorizedToReadMarker = {
+	/** B2-managed encryption metadata is hidden. */
+	ServerSideEncryption: DownloadHeaderName.ServerSideEncryption,
+	/** SSE-C algorithm metadata is hidden. */
+	ServerSideEncryptionCustomerAlgorithm: DownloadHeaderName.ServerSideEncryptionCustomerAlgorithm,
+	/** SSE-C customer-key MD5 metadata is hidden. */
+	ServerSideEncryptionCustomerKeyMd5: DownloadHeaderName.ServerSideEncryptionCustomerKeyMd5,
+	/** Object Lock retention mode metadata is hidden. */
+	FileRetentionMode: DownloadHeaderName.FileRetentionMode,
+	/** Object Lock retain-until timestamp metadata is hidden. */
+	FileRetentionRetainUntilTimestamp: DownloadHeaderName.FileRetentionRetainUntilTimestamp,
+	/** Object Lock legal-hold metadata is hidden. */
+	FileLegalHold: DownloadHeaderName.FileLegalHold
+};
+//#endregion
+exports.DownloadClientUnauthorizedToReadMarker = DownloadClientUnauthorizedToReadMarker;
+exports.DownloadHeaderName = DownloadHeaderName;
+
+//# sourceMappingURL=download.cjs.map

package/dist/types/download.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"download.cjs","names":[],"sources":["../../src/types/download.ts"],"sourcesContent":["import type { SseB2Setting, SseCKeyMaterial, SseCPublicSetting } from './encryption.ts'\nimport type { BucketId, FileId } from './ids.ts'\nimport type { ReadableFileRetention, ReadableLegalHold } from './lock.ts'\n\n/** HTTP response header names returned by B2 download endpoints. */\nexport const DownloadHeaderName = {\n  /** Header carrying the response content disposition. */\n  ContentDisposition: 'Content-Disposition',\n  /** Header carrying the response content language. */\n  ContentLanguage: 'Content-Language',\n  /** Header carrying the response content encoding. */\n  ContentEncoding: 'Content-Encoding',\n  /** Header carrying the response content type. */\n  ContentType: 'Content-Type',\n  /** Header carrying the response cache policy. */\n  CacheControl: 'Cache-Control',\n  /** Header carrying the response expiration time. */\n  Expires: 'Expires',\n  /** Header carrying the byte range returned for partial downloads. */\n  ContentRange: 'Content-Range',\n  /** Header carrying the response content length. */\n  ContentLength: 'Content-Length',\n  /** Header carrying the B2 SHA-1 metadata value. */\n  ContentSha1: 'X-Bz-Content-Sha1',\n  /** Header carrying the downloaded file version ID. */\n  FileId: 'X-Bz-File-Id',\n  /** Header carrying the URL-encoded downloaded file name. */\n  FileName: 'X-Bz-File-Name',\n  /** Header carrying the file upload timestamp. */\n  UploadTimestamp: 'X-Bz-Upload-Timestamp',\n  /** Header carrying the B2-managed server-side encryption algorithm. */\n  ServerSideEncryption: 'X-Bz-Server-Side-Encryption',\n  /** Header carrying the SSE-C algorithm echo. */\n  ServerSideEncryptionCustomerAlgorithm: 'X-Bz-Server-Side-Encryption-Customer-Algorithm',\n  /** Header carrying the SSE-C customer-key MD5 echo. */\n  ServerSideEncryptionCustomerKeyMd5: 'X-Bz-Server-Side-Encryption-Customer-Key-Md5',\n  /** Header carrying the Object Lock retention mode. */\n  FileRetentionMode: 'X-Bz-File-Retention-Mode',\n  /** Header carrying the Object Lock retain-until timestamp. */\n  FileRetentionRetainUntilTimestamp: 'X-Bz-File-Retention-Retain-Until-Timestamp',\n  /** Header carrying the Object Lock legal-hold value. */\n  FileLegalHold: 'X-Bz-File-Legal-Hold',\n  /** Header carrying names of metadata headers hidden by missing capabilities. */\n  ClientUnauthorizedToRead: 'X-Bz-Client-Unauthorized-To-Read',\n} as const\n\n/** HTTP response header name returned by B2 download endpoints. */\nexport type DownloadHeaderName = (typeof DownloadHeaderName)[keyof typeof DownloadHeaderName]\n\n/** Documented download metadata markers B2 may hide when the caller lacks read capabilities. */\nexport const DownloadClientUnauthorizedToReadMarker = {\n  /** B2-managed encryption metadata is hidden. */\n  ServerSideEncryption: DownloadHeaderName.ServerSideEncryption,\n  /** SSE-C algorithm metadata is hidden. */\n  ServerSideEncryptionCustomerAlgorithm: DownloadHeaderName.ServerSideEncryptionCustomerAlgorithm,\n  /** SSE-C customer-key MD5 metadata is hidden. */\n  ServerSideEncryptionCustomerKeyMd5: DownloadHeaderName.ServerSideEncryptionCustomerKeyMd5,\n  /** Object Lock retention mode metadata is hidden. */\n  FileRetentionMode: DownloadHeaderName.FileRetentionMode,\n  /** Object Lock retain-until timestamp metadata is hidden. */\n  FileRetentionRetainUntilTimestamp: DownloadHeaderName.FileRetentionRetainUntilTimestamp,\n  /** Object Lock legal-hold metadata is hidden. */\n  FileLegalHold: DownloadHeaderName.FileLegalHold,\n} as const\n\n/** Documented download metadata marker B2 may hide when the caller lacks read capabilities. */\nexport type DownloadClientUnauthorizedToReadMarker =\n  (typeof DownloadClientUnauthorizedToReadMarker)[keyof typeof DownloadClientUnauthorizedToReadMarker]\n\n/** Request parameters for downloading a file by its ID via `b2_download_file_by_id`. */\nexport interface DownloadByIdRequest {\n  /** ID of the file version to download. */\n  readonly fileId: FileId\n  /** Optional byte range to download (e.g., `'bytes=0-999'`). */\n  readonly range?: string\n  /** SSE-C decryption parameters, required if the file was uploaded with SSE-C. */\n  readonly serverSideEncryption?: SseCKeyMaterial\n  /** Override the Content-Disposition header in the download response. */\n  readonly b2ContentDisposition?: string\n  /** Override the Content-Language header in the download response. */\n  readonly b2ContentLanguage?: string\n  /** Override the Content-Encoding header in the download response. */\n  readonly b2ContentEncoding?: string\n  /** Override the Content-Type header in the download response. */\n  readonly b2ContentType?: string\n  /** Override the Cache-Control header in the download response. */\n  readonly b2CacheControl?: string\n  /** Override the Expires header in the download response. */\n  readonly b2Expires?: string\n}\n\n/** Request parameters for downloading a file by bucket name and file name via `b2_download_file_by_name`. */\nexport interface DownloadByNameRequest {\n  /** Name of the bucket containing the file. */\n  readonly bucketName: string\n  /** Full path and name of the file within the bucket. */\n  readonly fileName: string\n  /** Optional byte range to download (e.g., `'bytes=0-999'`). */\n  readonly range?: string\n  /** SSE-C decryption parameters, required if the file was uploaded with SSE-C. */\n  readonly serverSideEncryption?: SseCKeyMaterial\n  /** Override the Content-Disposition header in the download response. */\n  readonly b2ContentDisposition?: string\n  /** Override the Content-Language header in the download response. */\n  readonly b2ContentLanguage?: string\n  /** Override the Content-Encoding header in the download response. */\n  readonly b2ContentEncoding?: string\n  /** Override the Content-Type header in the download response. */\n  readonly b2ContentType?: string\n  /** Override the Cache-Control header in the download response. */\n  readonly b2CacheControl?: string\n  /** Override the Expires header in the download response. */\n  readonly b2Expires?: string\n}\n\n/**\n * Request parameters for the `b2_get_download_authorization` API call.\n * Creates a time-limited token that authorizes downloads of files matching a prefix.\n */\nexport interface DownloadAuthorizationRequest {\n  /** Bucket to authorize downloads from. */\n  readonly bucketId: BucketId\n  /** Only files with names starting with this prefix are authorized. */\n  readonly fileNamePrefix: string\n  /** Duration in seconds that the authorization token remains valid. */\n  readonly validDurationInSeconds: number\n  /** Override the Content-Disposition header in authorized download responses. */\n  readonly b2ContentDisposition?: string\n  /** Override the Content-Language header in authorized download responses. */\n  readonly b2ContentLanguage?: string\n  /** Override the Content-Encoding header in authorized download responses. */\n  readonly b2ContentEncoding?: string\n  /** Override the Content-Type header in authorized download responses. */\n  readonly b2ContentType?: string\n  /** Override the Cache-Control header in authorized download responses. */\n  readonly b2CacheControl?: string\n  /** Override the Expires header in authorized download responses. */\n  readonly b2Expires?: string\n}\n\n/** Response from the `b2_get_download_authorization` API call. */\nexport interface DownloadAuthorizationResponse {\n  /** Bucket the authorization applies to. */\n  readonly bucketId: BucketId\n  /** File name prefix the authorization is scoped to. */\n  readonly fileNamePrefix: string\n  /** Authorization token to include in download requests. */\n  readonly authorizationToken: string\n}\n\n/** Customer-managed server-side encryption metadata echoed in B2 download response headers. */\nexport interface SseCDownloadSetting extends SseCPublicSetting {\n  /** MD5 digest echoed by `X-Bz-Server-Side-Encryption-Customer-Key-Md5`. */\n  readonly customerKeyMd5: string\n}\n\n/** Server-side encryption metadata echoed in B2 download response headers. */\nexport type DownloadServerSideEncryption = SseB2Setting | SseCDownloadSetting\n\n/** Diagnostic for a present download metadata header the SDK could not parse narrowly. */\nexport interface DownloadHeaderParseIssue {\n  /** Header whose value could not be parsed into the current typed SDK model. */\n  readonly headerName: DownloadHeaderName\n  /** Raw header value that could not be parsed. */\n  readonly value: string\n}\n\n/** Parsed headers from a B2 file download response. */\nexport interface DownloadHeaders {\n  /** MIME type of the downloaded file content. */\n  readonly contentType: string\n  /** Size of the downloaded content in bytes. */\n  readonly contentLength: number\n  /** Content-Disposition value computed from upload metadata or the download request. */\n  readonly contentDisposition?: string\n  /** Content-Language value computed from upload metadata or the download request. */\n  readonly contentLanguage?: string\n  /** Content-Encoding value computed from upload metadata or the download request. */\n  readonly contentEncoding?: string\n  /** Cache-Control value computed from upload metadata, bucket defaults, or the download request. */\n  readonly cacheControl?: string\n  /** Expires value computed from upload metadata or the download request. */\n  readonly expires?: string\n  /** Content-Range value returned for satisfiable range downloads. */\n  readonly contentRange?: string\n  /** SHA-1 checksum of the full file content, or null for large files. */\n  readonly contentSha1: string | null\n  /** ID of the downloaded file version. */\n  readonly fileId: FileId\n  /** Full path and name of the downloaded file. */\n  readonly fileName: string\n  /** User-defined key-value metadata stored with the file. */\n  readonly fileInfo: Record<string, string>\n  /** UTC timestamp (milliseconds) when the file was uploaded. */\n  readonly uploadTimestamp: number\n  /** Server-side encryption metadata echoed by B2, when the caller is authorized to read it. */\n  readonly serverSideEncryption?: DownloadServerSideEncryption\n  /** Object Lock retention metadata, including whether the caller may read it. */\n  readonly fileRetention?: ReadableFileRetention\n  /** Object Lock legal hold metadata, including whether the caller may read it. */\n  readonly legalHold?: ReadableLegalHold\n  /** Header names B2 omitted because the caller lacks capability to read them. */\n  readonly clientUnauthorizedToRead?: readonly DownloadClientUnauthorizedToReadMarker[]\n  /** Present metadata headers the SDK could not parse into its current narrow typed model. */\n  readonly headerParseIssues?: readonly DownloadHeaderParseIssue[]\n}\n"],"mappings":";;AAKA,IAAa,qBAAqB;;CAEhC,oBAAoB;;CAEpB,iBAAiB;;CAEjB,iBAAiB;;CAEjB,aAAa;;CAEb,cAAc;;CAEd,SAAS;;CAET,cAAc;;CAEd,eAAe;;CAEf,aAAa;;CAEb,QAAQ;;CAER,UAAU;;CAEV,iBAAiB;;CAEjB,sBAAsB;;CAEtB,uCAAuC;;CAEvC,oCAAoC;;CAEpC,mBAAmB;;CAEnB,mCAAmC;;CAEnC,eAAe;;CAEf,0BAA0B;AAC5B;;AAMA,IAAa,yCAAyC;;CAEpD,sBAAsB,mBAAmB;;CAEzC,uCAAuC,mBAAmB;;CAE1D,oCAAoC,mBAAmB;;CAEvD,mBAAmB,mBAAmB;;CAEtC,mCAAmC,mBAAmB;;CAEtD,eAAe,mBAAmB;AACpC"}