@backblaze-labs/b2-sdk 0.1.0

package/dist/types/auth.d.cts

@@ -0,0 +1,150 @@
+import { AccountId, AuthToken, BucketId } from './ids.js';
+/**
+ * Named constants for the B2 API capabilities that can be granted to an
+ * application key. Each capability controls access to a specific set of
+ * API operations.
+ *
+ * Use these when constructing the `capabilities` array for an application
+ * key request, or when checking required capabilities via
+ * `B2Client.hasCapabilities`.
+ *
+ * @example
+ * ```ts
+ * const check = client.hasCapabilities([Capability.WriteFiles, Capability.ReadFiles])
+ * if (!check.ok) throw new Error(`missing: ${check.missing.join(', ')}`)
+ * ```
+ */
+export declare const Capability: {
+    /** List application keys. */
+    readonly ListKeys: "listKeys";
+    /** Create new application keys. */
+    readonly WriteKeys: "writeKeys";
+    /** Delete application keys. */
+    readonly DeleteKeys: "deleteKeys";
+    /** List buckets (subject to key restrictions). */
+    readonly ListBuckets: "listBuckets";
+    /** List bucket names without other metadata. */
+    readonly ListAllBucketNames: "listAllBucketNames";
+    /** Read bucket settings. */
+    readonly ReadBuckets: "readBuckets";
+    /** Create and update buckets. */
+    readonly WriteBuckets: "writeBuckets";
+    /** Remove existing buckets from the account. */
+    readonly DeleteBuckets: "deleteBuckets";
+    /** Read bucket-level Object Lock retention settings. */
+    readonly ReadBucketRetentions: "readBucketRetentions";
+    /** Modify bucket-level Object Lock retention settings. */
+    readonly WriteBucketRetentions: "writeBucketRetentions";
+    /** Read default bucket encryption settings. */
+    readonly ReadBucketEncryption: "readBucketEncryption";
+    /** Modify default bucket encryption settings. */
+    readonly WriteBucketEncryption: "writeBucketEncryption";
+    /** Read bucket replication configuration. */
+    readonly ReadBucketReplications: "readBucketReplications";
+    /** Modify bucket replication configuration. */
+    readonly WriteBucketReplications: "writeBucketReplications";
+    /** Read bucket event-notification rules. */
+    readonly ReadBucketNotifications: "readBucketNotifications";
+    /** Modify bucket event-notification rules. */
+    readonly WriteBucketNotifications: "writeBucketNotifications";
+    /** List file names and versions. */
+    readonly ListFiles: "listFiles";
+    /** Download files. */
+    readonly ReadFiles: "readFiles";
+    /** Mint download authorisation tokens. */
+    readonly ShareFiles: "shareFiles";
+    /** Upload files. */
+    readonly WriteFiles: "writeFiles";
+    /** Delete file versions. */
+    readonly DeleteFiles: "deleteFiles";
+    /** Read per-file legal hold flags. */
+    readonly ReadFileLegalHolds: "readFileLegalHolds";
+    /** Modify per-file legal hold flags. */
+    readonly WriteFileLegalHolds: "writeFileLegalHolds";
+    /** Read per-file Object Lock retention settings. */
+    readonly ReadFileRetentions: "readFileRetentions";
+    /** Modify per-file Object Lock retention settings. */
+    readonly WriteFileRetentions: "writeFileRetentions";
+    /** Shorten governance-mode retention. */
+    readonly BypassGovernance: "bypassGovernance";
+};
+/**
+ * A B2 API capability that can be granted to an application key. Derived
+ * from {@link Capability}.
+ */
+export type Capability = (typeof Capability)[keyof typeof Capability];
+/** Describes the capabilities and scope restrictions of an authorized application key. */
+export interface AllowedInfo {
+    /** List of capabilities granted to this key. */
+    readonly capabilities: readonly Capability[];
+    /** Bucket ID this key is restricted to, or null if unrestricted. */
+    readonly bucketId: BucketId | null;
+    /** Bucket name this key is restricted to, or null if unrestricted. */
+    readonly bucketName: string | null;
+    /** File name prefix this key is restricted to, or null if unrestricted. */
+    readonly namePrefix: string | null;
+}
+/** Configuration for the B2 Cloud Storage API returned during authorization. */
+export interface StorageApiInfo {
+    /** Minimum allowed part size for large file uploads, in bytes. */
+    readonly absoluteMinimumPartSize: number;
+    /** Base URL for B2 API calls. */
+    readonly apiUrl: string;
+    /** Bucket ID this key is restricted to, or null if unrestricted. */
+    readonly bucketId: BucketId | null;
+    /** Bucket name this key is restricted to, or null if unrestricted. */
+    readonly bucketName: string | null;
+    /** Base URL for file downloads. */
+    readonly downloadUrl: string;
+    /** Discriminator indicating this is storage API info. Always `'storageApi'`. */
+    readonly infoType: 'storageApi';
+    /** File name prefix this key is restricted to, or null if unrestricted. */
+    readonly namePrefix: string | null;
+    /** Recommended part size for large file uploads, in bytes. */
+    readonly recommendedPartSize: number;
+    /** Base URL for the S3-compatible API. */
+    readonly s3ApiUrl: string;
+    /** Capabilities and scope of the authorized key. */
+    readonly allowed: AllowedInfo;
+}
+/** Configuration for the B2 Groups API returned during authorization. */
+export interface GroupsApiInfo {
+    /** Base URL for Groups API calls. */
+    readonly groupsApiUrl: string;
+    /** Discriminator indicating this is groups API info. Always `'groupsApi'`. */
+    readonly infoType: 'groupsApi';
+}
+/** Container for all API-specific configuration returned by `b2_authorize_account`. */
+export interface ApiInfo {
+    /** Storage API configuration (always present). */
+    readonly storageApi: StorageApiInfo;
+    /** Groups API configuration (present only when the account has groups enabled). */
+    readonly groupsApi?: GroupsApiInfo;
+}
+/**
+ * Response from the `b2_authorize_account` API call.
+ * Contains the authorization token and API endpoint URLs needed for subsequent requests.
+ */
+export interface AuthorizeAccountResponse {
+    /** The account ID for the authorized account. */
+    readonly accountId: AccountId;
+    /** Authorization token to use in subsequent API calls. */
+    readonly authorizationToken: AuthToken;
+    /** API-specific configuration including endpoint URLs and key scope. */
+    readonly apiInfo: ApiInfo;
+    /** Expiration timestamp of the application key in milliseconds, or null if the key does not expire. */
+    readonly applicationKeyExpirationTimestamp: number | null;
+}
+/**
+ * Request parameters for the `b2_authorize_account` API call.
+ * Credentials are sent via HTTP Basic auth in the raw API, but represented here as fields.
+ */
+export interface AuthorizeAccountRequest {
+    /** The application key ID (account ID or app key ID). */
+    readonly applicationKeyId: string;
+    /** The application key secret. */
+    readonly applicationKey: string;
+    /** Optional realm override (e.g., `'production'`, `'staging'`). Defaults to production. */
+    readonly realm?: string;
+}
+//# sourceMappingURL=auth.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["../../src/types/auth.js"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAA;AAE9D;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,UAAU;IACrB,6BAA6B;;IAE7B,mCAAmC;;IAEnC,+BAA+B;;IAE/B,kDAAkD;;IAElD,gDAAgD;;IAEhD,4BAA4B;;IAE5B,iCAAiC;;IAEjC,gDAAgD;;IAEhD,wDAAwD;;IAExD,0DAA0D;;IAE1D,+CAA+C;;IAE/C,iDAAiD;;IAEjD,6CAA6C;;IAE7C,+CAA+C;;IAE/C,4CAA4C;;IAE5C,8CAA8C;;IAE9C,oCAAoC;;IAEpC,sBAAsB;;IAEtB,0CAA0C;;IAE1C,oBAAoB;;IAEpB,4BAA4B;;IAE5B,sCAAsC;;IAEtC,wCAAwC;;IAExC,oDAAoD;;IAEpD,sDAAsD;;IAEtD,yCAAyC;;CAEjC,CAAA;AAEV;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,CAAC,OAAO,UAAU,CAAC,CAAC,MAAM,OAAO,UAAU,CAAC,CAAA;AAErE,0FAA0F;AAC1F,MAAM,WAAW,WAAW;IAC1B,gDAAgD;IAChD,QAAQ,CAAC,YAAY,EAAE,SAAS,UAAU,EAAE,CAAA;IAC5C,oEAAoE;IACpE,QAAQ,CAAC,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAAA;IAClC,sEAAsE;IACtE,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAClC,2EAA2E;IAC3E,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;CACnC;AAED,gFAAgF;AAChF,MAAM,WAAW,cAAc;IAC7B,kEAAkE;IAClE,QAAQ,CAAC,uBAAuB,EAAE,MAAM,CAAA;IACxC,iCAAiC;IACjC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,oEAAoE;IACpE,QAAQ,CAAC,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAAA;IAClC,sEAAsE;IACtE,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAClC,mCAAmC;IACnC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;IAC5B,gFAAgF;IAChF,QAAQ,CAAC,QAAQ,EAAE,YAAY,CAAA;IAC/B,2EAA2E;IAC3E,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAClC,8DAA8D;IAC9D,QAAQ,CAAC,mBAAmB,EAAE,MAAM,CAAA;IACpC,0CAA0C;IAC1C,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,oDAAoD;IACpD,QAAQ,CAAC,OAAO,EAAE,WAAW,CAAA;CAC9B;AAED,yEAAyE;AACzE,MAAM,WAAW,aAAa;IAC5B,qCAAqC;IACrC,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAA;IAC7B,8EAA8E;IAC9E,QAAQ,CAAC,QAAQ,EAAE,WAAW,CAAA;CAC/B;AAED,uFAAuF;AACvF,MAAM,WAAW,OAAO;IACtB,kDAAkD;IAClD,QAAQ,CAAC,UAAU,EAAE,cAAc,CAAA;IACnC,mFAAmF;IACnF,QAAQ,CAAC,SAAS,CAAC,EAAE,aAAa,CAAA;CACnC;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC,iDAAiD;IACjD,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAA;IAC7B,0DAA0D;IAC1D,QAAQ,CAAC,kBAAkB,EAAE,SAAS,CAAA;IACtC,wEAAwE;IACxE,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;IACzB,uGAAuG;IACvG,QAAQ,CAAC,iCAAiC,EAAE,MAAM,GAAG,IAAI,CAAA;CAC1D;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC,yDAAyD;IACzD,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAA;IACjC,kCAAkC;IAClC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAA;IAC/B,2FAA2F;IAC3F,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CACxB"}

package/dist/types/auth.d.ts

@@ -0,0 +1,150 @@
+import { AccountId, AuthToken, BucketId } from './ids.js';
+/**
+ * Named constants for the B2 API capabilities that can be granted to an
+ * application key. Each capability controls access to a specific set of
+ * API operations.
+ *
+ * Use these when constructing the `capabilities` array for an application
+ * key request, or when checking required capabilities via
+ * `B2Client.hasCapabilities`.
+ *
+ * @example
+ * ```ts
+ * const check = client.hasCapabilities([Capability.WriteFiles, Capability.ReadFiles])
+ * if (!check.ok) throw new Error(`missing: ${check.missing.join(', ')}`)
+ * ```
+ */
+export declare const Capability: {
+    /** List application keys. */
+    readonly ListKeys: "listKeys";
+    /** Create new application keys. */
+    readonly WriteKeys: "writeKeys";
+    /** Delete application keys. */
+    readonly DeleteKeys: "deleteKeys";
+    /** List buckets (subject to key restrictions). */
+    readonly ListBuckets: "listBuckets";
+    /** List bucket names without other metadata. */
+    readonly ListAllBucketNames: "listAllBucketNames";
+    /** Read bucket settings. */
+    readonly ReadBuckets: "readBuckets";
+    /** Create and update buckets. */
+    readonly WriteBuckets: "writeBuckets";
+    /** Remove existing buckets from the account. */
+    readonly DeleteBuckets: "deleteBuckets";
+    /** Read bucket-level Object Lock retention settings. */
+    readonly ReadBucketRetentions: "readBucketRetentions";
+    /** Modify bucket-level Object Lock retention settings. */
+    readonly WriteBucketRetentions: "writeBucketRetentions";
+    /** Read default bucket encryption settings. */
+    readonly ReadBucketEncryption: "readBucketEncryption";
+    /** Modify default bucket encryption settings. */
+    readonly WriteBucketEncryption: "writeBucketEncryption";
+    /** Read bucket replication configuration. */
+    readonly ReadBucketReplications: "readBucketReplications";
+    /** Modify bucket replication configuration. */
+    readonly WriteBucketReplications: "writeBucketReplications";
+    /** Read bucket event-notification rules. */
+    readonly ReadBucketNotifications: "readBucketNotifications";
+    /** Modify bucket event-notification rules. */
+    readonly WriteBucketNotifications: "writeBucketNotifications";
+    /** List file names and versions. */
+    readonly ListFiles: "listFiles";
+    /** Download files. */
+    readonly ReadFiles: "readFiles";
+    /** Mint download authorisation tokens. */
+    readonly ShareFiles: "shareFiles";
+    /** Upload files. */
+    readonly WriteFiles: "writeFiles";
+    /** Delete file versions. */
+    readonly DeleteFiles: "deleteFiles";
+    /** Read per-file legal hold flags. */
+    readonly ReadFileLegalHolds: "readFileLegalHolds";
+    /** Modify per-file legal hold flags. */
+    readonly WriteFileLegalHolds: "writeFileLegalHolds";
+    /** Read per-file Object Lock retention settings. */
+    readonly ReadFileRetentions: "readFileRetentions";
+    /** Modify per-file Object Lock retention settings. */
+    readonly WriteFileRetentions: "writeFileRetentions";
+    /** Shorten governance-mode retention. */
+    readonly BypassGovernance: "bypassGovernance";
+};
+/**
+ * A B2 API capability that can be granted to an application key. Derived
+ * from {@link Capability}.
+ */
+export type Capability = (typeof Capability)[keyof typeof Capability];
+/** Describes the capabilities and scope restrictions of an authorized application key. */
+export interface AllowedInfo {
+    /** List of capabilities granted to this key. */
+    readonly capabilities: readonly Capability[];
+    /** Bucket ID this key is restricted to, or null if unrestricted. */
+    readonly bucketId: BucketId | null;
+    /** Bucket name this key is restricted to, or null if unrestricted. */
+    readonly bucketName: string | null;
+    /** File name prefix this key is restricted to, or null if unrestricted. */
+    readonly namePrefix: string | null;
+}
+/** Configuration for the B2 Cloud Storage API returned during authorization. */
+export interface StorageApiInfo {
+    /** Minimum allowed part size for large file uploads, in bytes. */
+    readonly absoluteMinimumPartSize: number;
+    /** Base URL for B2 API calls. */
+    readonly apiUrl: string;
+    /** Bucket ID this key is restricted to, or null if unrestricted. */
+    readonly bucketId: BucketId | null;
+    /** Bucket name this key is restricted to, or null if unrestricted. */
+    readonly bucketName: string | null;
+    /** Base URL for file downloads. */
+    readonly downloadUrl: string;
+    /** Discriminator indicating this is storage API info. Always `'storageApi'`. */
+    readonly infoType: 'storageApi';
+    /** File name prefix this key is restricted to, or null if unrestricted. */
+    readonly namePrefix: string | null;
+    /** Recommended part size for large file uploads, in bytes. */
+    readonly recommendedPartSize: number;
+    /** Base URL for the S3-compatible API. */
+    readonly s3ApiUrl: string;
+    /** Capabilities and scope of the authorized key. */
+    readonly allowed: AllowedInfo;
+}
+/** Configuration for the B2 Groups API returned during authorization. */
+export interface GroupsApiInfo {
+    /** Base URL for Groups API calls. */
+    readonly groupsApiUrl: string;
+    /** Discriminator indicating this is groups API info. Always `'groupsApi'`. */
+    readonly infoType: 'groupsApi';
+}
+/** Container for all API-specific configuration returned by `b2_authorize_account`. */
+export interface ApiInfo {
+    /** Storage API configuration (always present). */
+    readonly storageApi: StorageApiInfo;
+    /** Groups API configuration (present only when the account has groups enabled). */
+    readonly groupsApi?: GroupsApiInfo;
+}
+/**
+ * Response from the `b2_authorize_account` API call.
+ * Contains the authorization token and API endpoint URLs needed for subsequent requests.
+ */
+export interface AuthorizeAccountResponse {
+    /** The account ID for the authorized account. */
+    readonly accountId: AccountId;
+    /** Authorization token to use in subsequent API calls. */
+    readonly authorizationToken: AuthToken;
+    /** API-specific configuration including endpoint URLs and key scope. */
+    readonly apiInfo: ApiInfo;
+    /** Expiration timestamp of the application key in milliseconds, or null if the key does not expire. */
+    readonly applicationKeyExpirationTimestamp: number | null;
+}
+/**
+ * Request parameters for the `b2_authorize_account` API call.
+ * Credentials are sent via HTTP Basic auth in the raw API, but represented here as fields.
+ */
+export interface AuthorizeAccountRequest {
+    /** The application key ID (account ID or app key ID). */
+    readonly applicationKeyId: string;
+    /** The application key secret. */
+    readonly applicationKey: string;
+    /** Optional realm override (e.g., `'production'`, `'staging'`). Defaults to production. */
+    readonly realm?: string;
+}
+//# sourceMappingURL=auth.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["../../src/types/auth.js"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAA;AAE9D;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,UAAU;IACrB,6BAA6B;;IAE7B,mCAAmC;;IAEnC,+BAA+B;;IAE/B,kDAAkD;;IAElD,gDAAgD;;IAEhD,4BAA4B;;IAE5B,iCAAiC;;IAEjC,gDAAgD;;IAEhD,wDAAwD;;IAExD,0DAA0D;;IAE1D,+CAA+C;;IAE/C,iDAAiD;;IAEjD,6CAA6C;;IAE7C,+CAA+C;;IAE/C,4CAA4C;;IAE5C,8CAA8C;;IAE9C,oCAAoC;;IAEpC,sBAAsB;;IAEtB,0CAA0C;;IAE1C,oBAAoB;;IAEpB,4BAA4B;;IAE5B,sCAAsC;;IAEtC,wCAAwC;;IAExC,oDAAoD;;IAEpD,sDAAsD;;IAEtD,yCAAyC;;CAEjC,CAAA;AAEV;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,CAAC,OAAO,UAAU,CAAC,CAAC,MAAM,OAAO,UAAU,CAAC,CAAA;AAErE,0FAA0F;AAC1F,MAAM,WAAW,WAAW;IAC1B,gDAAgD;IAChD,QAAQ,CAAC,YAAY,EAAE,SAAS,UAAU,EAAE,CAAA;IAC5C,oEAAoE;IACpE,QAAQ,CAAC,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAAA;IAClC,sEAAsE;IACtE,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAClC,2EAA2E;IAC3E,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;CACnC;AAED,gFAAgF;AAChF,MAAM,WAAW,cAAc;IAC7B,kEAAkE;IAClE,QAAQ,CAAC,uBAAuB,EAAE,MAAM,CAAA;IACxC,iCAAiC;IACjC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,oEAAoE;IACpE,QAAQ,CAAC,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAAA;IAClC,sEAAsE;IACtE,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAClC,mCAAmC;IACnC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;IAC5B,gFAAgF;IAChF,QAAQ,CAAC,QAAQ,EAAE,YAAY,CAAA;IAC/B,2EAA2E;IAC3E,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAClC,8DAA8D;IAC9D,QAAQ,CAAC,mBAAmB,EAAE,MAAM,CAAA;IACpC,0CAA0C;IAC1C,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,oDAAoD;IACpD,QAAQ,CAAC,OAAO,EAAE,WAAW,CAAA;CAC9B;AAED,yEAAyE;AACzE,MAAM,WAAW,aAAa;IAC5B,qCAAqC;IACrC,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAA;IAC7B,8EAA8E;IAC9E,QAAQ,CAAC,QAAQ,EAAE,WAAW,CAAA;CAC/B;AAED,uFAAuF;AACvF,MAAM,WAAW,OAAO;IACtB,kDAAkD;IAClD,QAAQ,CAAC,UAAU,EAAE,cAAc,CAAA;IACnC,mFAAmF;IACnF,QAAQ,CAAC,SAAS,CAAC,EAAE,aAAa,CAAA;CACnC;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC,iDAAiD;IACjD,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAA;IAC7B,0DAA0D;IAC1D,QAAQ,CAAC,kBAAkB,EAAE,SAAS,CAAA;IACtC,wEAAwE;IACxE,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;IACzB,uGAAuG;IACvG,QAAQ,CAAC,iCAAiC,EAAE,MAAM,GAAG,IAAI,CAAA;CAC1D;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC,yDAAyD;IACzD,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAA;IACjC,kCAAkC;IAClC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAA;IAC/B,2FAA2F;IAC3F,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CACxB"}

package/dist/types/auth.js

@@ -0,0 +1,58 @@
+const Capability = {
+  /** List application keys. */
+  ListKeys: "listKeys",
+  /** Create new application keys. */
+  WriteKeys: "writeKeys",
+  /** Delete application keys. */
+  DeleteKeys: "deleteKeys",
+  /** List buckets (subject to key restrictions). */
+  ListBuckets: "listBuckets",
+  /** List bucket names without other metadata. */
+  ListAllBucketNames: "listAllBucketNames",
+  /** Read bucket settings. */
+  ReadBuckets: "readBuckets",
+  /** Create and update buckets. */
+  WriteBuckets: "writeBuckets",
+  /** Remove existing buckets from the account. */
+  DeleteBuckets: "deleteBuckets",
+  /** Read bucket-level Object Lock retention settings. */
+  ReadBucketRetentions: "readBucketRetentions",
+  /** Modify bucket-level Object Lock retention settings. */
+  WriteBucketRetentions: "writeBucketRetentions",
+  /** Read default bucket encryption settings. */
+  ReadBucketEncryption: "readBucketEncryption",
+  /** Modify default bucket encryption settings. */
+  WriteBucketEncryption: "writeBucketEncryption",
+  /** Read bucket replication configuration. */
+  ReadBucketReplications: "readBucketReplications",
+  /** Modify bucket replication configuration. */
+  WriteBucketReplications: "writeBucketReplications",
+  /** Read bucket event-notification rules. */
+  ReadBucketNotifications: "readBucketNotifications",
+  /** Modify bucket event-notification rules. */
+  WriteBucketNotifications: "writeBucketNotifications",
+  /** List file names and versions. */
+  ListFiles: "listFiles",
+  /** Download files. */
+  ReadFiles: "readFiles",
+  /** Mint download authorisation tokens. */
+  ShareFiles: "shareFiles",
+  /** Upload files. */
+  WriteFiles: "writeFiles",
+  /** Delete file versions. */
+  DeleteFiles: "deleteFiles",
+  /** Read per-file legal hold flags. */
+  ReadFileLegalHolds: "readFileLegalHolds",
+  /** Modify per-file legal hold flags. */
+  WriteFileLegalHolds: "writeFileLegalHolds",
+  /** Read per-file Object Lock retention settings. */
+  ReadFileRetentions: "readFileRetentions",
+  /** Modify per-file Object Lock retention settings. */
+  WriteFileRetentions: "writeFileRetentions",
+  /** Shorten governance-mode retention. */
+  BypassGovernance: "bypassGovernance"
+};
+export {
+  Capability
+};
+//# sourceMappingURL=auth.js.map

package/dist/types/auth.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth.js","sources":["../../src/types/auth.ts"],"sourcesContent":["import type { AccountId, AuthToken, BucketId } from './ids.ts'\n\n/**\n * Named constants for the B2 API capabilities that can be granted to an\n * application key. Each capability controls access to a specific set of\n * API operations.\n *\n * Use these when constructing the `capabilities` array for an application\n * key request, or when checking required capabilities via\n * `B2Client.hasCapabilities`.\n *\n * @example\n * ```ts\n * const check = client.hasCapabilities([Capability.WriteFiles, Capability.ReadFiles])\n * if (!check.ok) throw new Error(`missing: ${check.missing.join(', ')}`)\n * ```\n */\nexport const Capability = {\n  /** List application keys. */\n  ListKeys: 'listKeys',\n  /** Create new application keys. */\n  WriteKeys: 'writeKeys',\n  /** Delete application keys. */\n  DeleteKeys: 'deleteKeys',\n  /** List buckets (subject to key restrictions). */\n  ListBuckets: 'listBuckets',\n  /** List bucket names without other metadata. */\n  ListAllBucketNames: 'listAllBucketNames',\n  /** Read bucket settings. */\n  ReadBuckets: 'readBuckets',\n  /** Create and update buckets. */\n  WriteBuckets: 'writeBuckets',\n  /** Remove existing buckets from the account. */\n  DeleteBuckets: 'deleteBuckets',\n  /** Read bucket-level Object Lock retention settings. */\n  ReadBucketRetentions: 'readBucketRetentions',\n  /** Modify bucket-level Object Lock retention settings. */\n  WriteBucketRetentions: 'writeBucketRetentions',\n  /** Read default bucket encryption settings. */\n  ReadBucketEncryption: 'readBucketEncryption',\n  /** Modify default bucket encryption settings. */\n  WriteBucketEncryption: 'writeBucketEncryption',\n  /** Read bucket replication configuration. */\n  ReadBucketReplications: 'readBucketReplications',\n  /** Modify bucket replication configuration. */\n  WriteBucketReplications: 'writeBucketReplications',\n  /** Read bucket event-notification rules. */\n  ReadBucketNotifications: 'readBucketNotifications',\n  /** Modify bucket event-notification rules. */\n  WriteBucketNotifications: 'writeBucketNotifications',\n  /** List file names and versions. */\n  ListFiles: 'listFiles',\n  /** Download files. */\n  ReadFiles: 'readFiles',\n  /** Mint download authorisation tokens. */\n  ShareFiles: 'shareFiles',\n  /** Upload files. */\n  WriteFiles: 'writeFiles',\n  /** Delete file versions. */\n  DeleteFiles: 'deleteFiles',\n  /** Read per-file legal hold flags. */\n  ReadFileLegalHolds: 'readFileLegalHolds',\n  /** Modify per-file legal hold flags. */\n  WriteFileLegalHolds: 'writeFileLegalHolds',\n  /** Read per-file Object Lock retention settings. */\n  ReadFileRetentions: 'readFileRetentions',\n  /** Modify per-file Object Lock retention settings. */\n  WriteFileRetentions: 'writeFileRetentions',\n  /** Shorten governance-mode retention. */\n  BypassGovernance: 'bypassGovernance',\n} as const\n\n/**\n * A B2 API capability that can be granted to an application key. Derived\n * from {@link Capability}.\n */\nexport type Capability = (typeof Capability)[keyof typeof Capability]\n\n/** Describes the capabilities and scope restrictions of an authorized application key. */\nexport interface AllowedInfo {\n  /** List of capabilities granted to this key. */\n  readonly capabilities: readonly Capability[]\n  /** Bucket ID this key is restricted to, or null if unrestricted. */\n  readonly bucketId: BucketId | null\n  /** Bucket name this key is restricted to, or null if unrestricted. */\n  readonly bucketName: string | null\n  /** File name prefix this key is restricted to, or null if unrestricted. */\n  readonly namePrefix: string | null\n}\n\n/** Configuration for the B2 Cloud Storage API returned during authorization. */\nexport interface StorageApiInfo {\n  /** Minimum allowed part size for large file uploads, in bytes. */\n  readonly absoluteMinimumPartSize: number\n  /** Base URL for B2 API calls. */\n  readonly apiUrl: string\n  /** Bucket ID this key is restricted to, or null if unrestricted. */\n  readonly bucketId: BucketId | null\n  /** Bucket name this key is restricted to, or null if unrestricted. */\n  readonly bucketName: string | null\n  /** Base URL for file downloads. */\n  readonly downloadUrl: string\n  /** Discriminator indicating this is storage API info. Always `'storageApi'`. */\n  readonly infoType: 'storageApi'\n  /** File name prefix this key is restricted to, or null if unrestricted. */\n  readonly namePrefix: string | null\n  /** Recommended part size for large file uploads, in bytes. */\n  readonly recommendedPartSize: number\n  /** Base URL for the S3-compatible API. */\n  readonly s3ApiUrl: string\n  /** Capabilities and scope of the authorized key. */\n  readonly allowed: AllowedInfo\n}\n\n/** Configuration for the B2 Groups API returned during authorization. */\nexport interface GroupsApiInfo {\n  /** Base URL for Groups API calls. */\n  readonly groupsApiUrl: string\n  /** Discriminator indicating this is groups API info. Always `'groupsApi'`. */\n  readonly infoType: 'groupsApi'\n}\n\n/** Container for all API-specific configuration returned by `b2_authorize_account`. */\nexport interface ApiInfo {\n  /** Storage API configuration (always present). */\n  readonly storageApi: StorageApiInfo\n  /** Groups API configuration (present only when the account has groups enabled). */\n  readonly groupsApi?: GroupsApiInfo\n}\n\n/**\n * Response from the `b2_authorize_account` API call.\n * Contains the authorization token and API endpoint URLs needed for subsequent requests.\n */\nexport interface AuthorizeAccountResponse {\n  /** The account ID for the authorized account. */\n  readonly accountId: AccountId\n  /** Authorization token to use in subsequent API calls. */\n  readonly authorizationToken: AuthToken\n  /** API-specific configuration including endpoint URLs and key scope. */\n  readonly apiInfo: ApiInfo\n  /** Expiration timestamp of the application key in milliseconds, or null if the key does not expire. */\n  readonly applicationKeyExpirationTimestamp: number | null\n}\n\n/**\n * Request parameters for the `b2_authorize_account` API call.\n * Credentials are sent via HTTP Basic auth in the raw API, but represented here as fields.\n */\nexport interface AuthorizeAccountRequest {\n  /** The application key ID (account ID or app key ID). */\n  readonly applicationKeyId: string\n  /** The application key secret. */\n  readonly applicationKey: string\n  /** Optional realm override (e.g., `'production'`, `'staging'`). Defaults to production. */\n  readonly realm?: string\n}\n"],"names":[],"mappings":"AAiBO,MAAM,aAAa;AAAA;AAAA,EAExB,UAAU;AAAA;AAAA,EAEV,WAAW;AAAA;AAAA,EAEX,YAAY;AAAA;AAAA,EAEZ,aAAa;AAAA;AAAA,EAEb,oBAAoB;AAAA;AAAA,EAEpB,aAAa;AAAA;AAAA,EAEb,cAAc;AAAA;AAAA,EAEd,eAAe;AAAA;AAAA,EAEf,sBAAsB;AAAA;AAAA,EAEtB,uBAAuB;AAAA;AAAA,EAEvB,sBAAsB;AAAA;AAAA,EAEtB,uBAAuB;AAAA;AAAA,EAEvB,wBAAwB;AAAA;AAAA,EAExB,yBAAyB;AAAA;AAAA,EAEzB,yBAAyB;AAAA;AAAA,EAEzB,0BAA0B;AAAA;AAAA,EAE1B,WAAW;AAAA;AAAA,EAEX,WAAW;AAAA;AAAA,EAEX,YAAY;AAAA;AAAA,EAEZ,YAAY;AAAA;AAAA,EAEZ,aAAa;AAAA;AAAA,EAEb,oBAAoB;AAAA;AAAA,EAEpB,qBAAqB;AAAA;AAAA,EAErB,oBAAoB;AAAA;AAAA,EAEpB,qBAAqB;AAAA;AAAA,EAErB,kBAAkB;AACpB;"}

package/dist/types/bucket.cjs

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+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"
+};
+exports.BucketRetentionMode = BucketRetentionMode;
+exports.BucketType = BucketType;
+exports.CorsOperation = CorsOperation;
+//# sourceMappingURL=bucket.cjs.map

package/dist/types/bucket.cjs.map

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