@backblaze-labs/b2-sdk 0.2.0 → 0.4.0

package/dist/types/download.d.cts

@@ -1,4 +1,66 @@
+import { SseB2Setting, SseCKeyMaterial, SseCPublicSetting } from './encryption.js';
 import { BucketId, FileId } from './ids.js';
+import { ReadableFileRetention, ReadableLegalHold } from './lock.js';
+/** HTTP response header names returned by B2 download endpoints. */
+export declare const DownloadHeaderName: {
+    /** Header carrying the response content disposition. */
+    readonly ContentDisposition: "Content-Disposition";
+    /** Header carrying the response content language. */
+    readonly ContentLanguage: "Content-Language";
+    /** Header carrying the response content encoding. */
+    readonly ContentEncoding: "Content-Encoding";
+    /** Header carrying the response content type. */
+    readonly ContentType: "Content-Type";
+    /** Header carrying the response cache policy. */
+    readonly CacheControl: "Cache-Control";
+    /** Header carrying the response expiration time. */
+    readonly Expires: "Expires";
+    /** Header carrying the byte range returned for partial downloads. */
+    readonly ContentRange: "Content-Range";
+    /** Header carrying the response content length. */
+    readonly ContentLength: "Content-Length";
+    /** Header carrying the B2 SHA-1 metadata value. */
+    readonly ContentSha1: "X-Bz-Content-Sha1";
+    /** Header carrying the downloaded file version ID. */
+    readonly FileId: "X-Bz-File-Id";
+    /** Header carrying the URL-encoded downloaded file name. */
+    readonly FileName: "X-Bz-File-Name";
+    /** Header carrying the file upload timestamp. */
+    readonly UploadTimestamp: "X-Bz-Upload-Timestamp";
+    /** Header carrying the B2-managed server-side encryption algorithm. */
+    readonly ServerSideEncryption: "X-Bz-Server-Side-Encryption";
+    /** Header carrying the SSE-C algorithm echo. */
+    readonly ServerSideEncryptionCustomerAlgorithm: "X-Bz-Server-Side-Encryption-Customer-Algorithm";
+    /** Header carrying the SSE-C customer-key MD5 echo. */
+    readonly ServerSideEncryptionCustomerKeyMd5: "X-Bz-Server-Side-Encryption-Customer-Key-Md5";
+    /** Header carrying the Object Lock retention mode. */
+    readonly FileRetentionMode: "X-Bz-File-Retention-Mode";
+    /** Header carrying the Object Lock retain-until timestamp. */
+    readonly FileRetentionRetainUntilTimestamp: "X-Bz-File-Retention-Retain-Until-Timestamp";
+    /** Header carrying the Object Lock legal-hold value. */
+    readonly FileLegalHold: "X-Bz-File-Legal-Hold";
+    /** Header carrying names of metadata headers hidden by missing capabilities. */
+    readonly ClientUnauthorizedToRead: "X-Bz-Client-Unauthorized-To-Read";
+};
+/** HTTP response header name returned by B2 download endpoints. */
+export type DownloadHeaderName = (typeof DownloadHeaderName)[keyof typeof DownloadHeaderName];
+/** Documented download metadata markers B2 may hide when the caller lacks read capabilities. */
+export declare const DownloadClientUnauthorizedToReadMarker: {
+    /** B2-managed encryption metadata is hidden. */
+    readonly ServerSideEncryption: "X-Bz-Server-Side-Encryption";
+    /** SSE-C algorithm metadata is hidden. */
+    readonly ServerSideEncryptionCustomerAlgorithm: "X-Bz-Server-Side-Encryption-Customer-Algorithm";
+    /** SSE-C customer-key MD5 metadata is hidden. */
+    readonly ServerSideEncryptionCustomerKeyMd5: "X-Bz-Server-Side-Encryption-Customer-Key-Md5";
+    /** Object Lock retention mode metadata is hidden. */
+    readonly FileRetentionMode: "X-Bz-File-Retention-Mode";
+    /** Object Lock retain-until timestamp metadata is hidden. */
+    readonly FileRetentionRetainUntilTimestamp: "X-Bz-File-Retention-Retain-Until-Timestamp";
+    /** Object Lock legal-hold metadata is hidden. */
+    readonly FileLegalHold: "X-Bz-File-Legal-Hold";
+};
+/** Documented download metadata marker B2 may hide when the caller lacks read capabilities. */
+export type DownloadClientUnauthorizedToReadMarker = (typeof DownloadClientUnauthorizedToReadMarker)[keyof typeof DownloadClientUnauthorizedToReadMarker];
 /** Request parameters for downloading a file by its ID via `b2_download_file_by_id`. */
 export interface DownloadByIdRequest {
     /** ID of the file version to download. */
@@ -6,14 +68,7 @@ export interface DownloadByIdRequest {
     /** Optional byte range to download (e.g., `'bytes=0-999'`). */
     readonly range?: string;
     /** SSE-C decryption parameters, required if the file was uploaded with SSE-C. */
-    readonly serverSideEncryption?: {
-        /** Encryption algorithm. Always `'AES256'`. */
-        readonly algorithm: 'AES256';
-        /** Base64-encoded customer-provided decryption key. */
-        readonly customerKey: string;
-        /** Base64-encoded MD5 digest of the decryption key. */
-        readonly customerKeyMd5: string;
-    };
+    readonly serverSideEncryption?: SseCKeyMaterial;
     /** Override the Content-Disposition header in the download response. */
     readonly b2ContentDisposition?: string;
     /** Override the Content-Language header in the download response. */
@@ -36,14 +91,7 @@ export interface DownloadByNameRequest {
     /** Optional byte range to download (e.g., `'bytes=0-999'`). */
     readonly range?: string;
     /** SSE-C decryption parameters, required if the file was uploaded with SSE-C. */
-    readonly serverSideEncryption?: {
-        /** Encryption algorithm. Always `'AES256'`. */
-        readonly algorithm: 'AES256';
-        /** Base64-encoded customer-provided decryption key. */
-        readonly customerKey: string;
-        /** Base64-encoded MD5 digest of the decryption key. */
-        readonly customerKeyMd5: string;
-    };
+    readonly serverSideEncryption?: SseCKeyMaterial;
     /** Override the Content-Disposition header in the download response. */
     readonly b2ContentDisposition?: string;
     /** Override the Content-Language header in the download response. */
@@ -90,12 +138,38 @@ export interface DownloadAuthorizationResponse {
     /** Authorization token to include in download requests. */
     readonly authorizationToken: string;
 }
+/** Customer-managed server-side encryption metadata echoed in B2 download response headers. */
+export interface SseCDownloadSetting extends SseCPublicSetting {
+    /** MD5 digest echoed by `X-Bz-Server-Side-Encryption-Customer-Key-Md5`. */
+    readonly customerKeyMd5: string;
+}
+/** Server-side encryption metadata echoed in B2 download response headers. */
+export type DownloadServerSideEncryption = SseB2Setting | SseCDownloadSetting;
+/** Diagnostic for a present download metadata header the SDK could not parse narrowly. */
+export interface DownloadHeaderParseIssue {
+    /** Header whose value could not be parsed into the current typed SDK model. */
+    readonly headerName: DownloadHeaderName;
+    /** Raw header value that could not be parsed. */
+    readonly value: string;
+}
 /** Parsed headers from a B2 file download response. */
 export interface DownloadHeaders {
     /** MIME type of the downloaded file content. */
     readonly contentType: string;
     /** Size of the downloaded content in bytes. */
     readonly contentLength: number;
+    /** Content-Disposition value computed from upload metadata or the download request. */
+    readonly contentDisposition?: string;
+    /** Content-Language value computed from upload metadata or the download request. */
+    readonly contentLanguage?: string;
+    /** Content-Encoding value computed from upload metadata or the download request. */
+    readonly contentEncoding?: string;
+    /** Cache-Control value computed from upload metadata, bucket defaults, or the download request. */
+    readonly cacheControl?: string;
+    /** Expires value computed from upload metadata or the download request. */
+    readonly expires?: string;
+    /** Content-Range value returned for satisfiable range downloads. */
+    readonly contentRange?: string;
     /** SHA-1 checksum of the full file content, or null for large files. */
     readonly contentSha1: string | null;
     /** ID of the downloaded file version. */
@@ -106,5 +180,15 @@ export interface DownloadHeaders {
     readonly fileInfo: Record<string, string>;
     /** UTC timestamp (milliseconds) when the file was uploaded. */
     readonly uploadTimestamp: number;
+    /** Server-side encryption metadata echoed by B2, when the caller is authorized to read it. */
+    readonly serverSideEncryption?: DownloadServerSideEncryption;
+    /** Object Lock retention metadata, including whether the caller may read it. */
+    readonly fileRetention?: ReadableFileRetention;
+    /** Object Lock legal hold metadata, including whether the caller may read it. */
+    readonly legalHold?: ReadableLegalHold;
+    /** Header names B2 omitted because the caller lacks capability to read them. */
+    readonly clientUnauthorizedToRead?: readonly DownloadClientUnauthorizedToReadMarker[];
+    /** Present metadata headers the SDK could not parse into its current narrow typed model. */
+    readonly headerParseIssues?: readonly DownloadHeaderParseIssue[];
 }
 //# sourceMappingURL=download.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"download.d.ts","sourceRoot":"","sources":["../../src/types/download.js"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAEhD,wFAAwF;AACxF,MAAM,WAAW,mBAAmB;IAClC,0CAA0C;IAC1C,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,+DAA+D;IAC/D,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;IACvB,iFAAiF;IACjF,QAAQ,CAAC,oBAAoB,CAAC,EAAE;QAC9B,+CAA+C;QAC/C,QAAQ,CAAC,SAAS,EAAE,QAAQ,CAAA;QAC5B,uDAAuD;QACvD,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;QAC5B,uDAAuD;QACvD,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAA;KAChC,CAAA;IACD,wEAAwE;IACxE,QAAQ,CAAC,oBAAoB,CAAC,EAAE,MAAM,CAAA;IACtC,qEAAqE;IACrE,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAA;IACnC,qEAAqE;IACrE,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAA;IACnC,iEAAiE;IACjE,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAA;IAC/B,kEAAkE;IAClE,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAA;IAChC,4DAA4D;IAC5D,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAA;CAC5B;AAED,6GAA6G;AAC7G,MAAM,WAAW,qBAAqB;IACpC,8CAA8C;IAC9C,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAC3B,wDAAwD;IACxD,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,+DAA+D;IAC/D,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;IACvB,iFAAiF;IACjF,QAAQ,CAAC,oBAAoB,CAAC,EAAE;QAC9B,+CAA+C;QAC/C,QAAQ,CAAC,SAAS,EAAE,QAAQ,CAAA;QAC5B,uDAAuD;QACvD,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;QAC5B,uDAAuD;QACvD,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAA;KAChC,CAAA;IACD,wEAAwE;IACxE,QAAQ,CAAC,oBAAoB,CAAC,EAAE,MAAM,CAAA;IACtC,qEAAqE;IACrE,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAA;IACnC,qEAAqE;IACrE,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAA;IACnC,iEAAiE;IACjE,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAA;IAC/B,kEAAkE;IAClE,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAA;IAChC,4DAA4D;IAC5D,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAA;CAC5B;AAED;;;GAGG;AACH,MAAM,WAAW,4BAA4B;IAC3C,0CAA0C;IAC1C,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;IAC3B,sEAAsE;IACtE,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAA;IAC/B,sEAAsE;IACtE,QAAQ,CAAC,sBAAsB,EAAE,MAAM,CAAA;IACvC,gFAAgF;IAChF,QAAQ,CAAC,oBAAoB,CAAC,EAAE,MAAM,CAAA;IACtC,6EAA6E;IAC7E,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAA;IACnC,6EAA6E;IAC7E,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAA;IACnC,yEAAyE;IACzE,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAA;IAC/B,0EAA0E;IAC1E,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAA;IAChC,oEAAoE;IACpE,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAA;CAC5B;AAED,kEAAkE;AAClE,MAAM,WAAW,6BAA6B;IAC5C,2CAA2C;IAC3C,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;IAC3B,uDAAuD;IACvD,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAA;IAC/B,2DAA2D;IAC3D,QAAQ,CAAC,kBAAkB,EAAE,MAAM,CAAA;CACpC;AAED,uDAAuD;AACvD,MAAM,WAAW,eAAe;IAC9B,gDAAgD;IAChD,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;IAC5B,+CAA+C;IAC/C,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAA;IAC9B,wEAAwE;IACxE,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IACnC,yCAAyC;IACzC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,iDAAiD;IACjD,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,4DAA4D;IAC5D,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACzC,+DAA+D;IAC/D,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAA;CACjC"}
+{"version":3,"file":"download.d.ts","sourceRoot":"","sources":["../../src/types/download.js"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAA;AACvF,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAChD,OAAO,KAAK,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAA;AAEzE,oEAAoE;AACpE,eAAO,MAAM,kBAAkB;IAC7B,wDAAwD;;IAExD,qDAAqD;;IAErD,qDAAqD;;IAErD,iDAAiD;;IAEjD,iDAAiD;;IAEjD,oDAAoD;;IAEpD,qEAAqE;;IAErE,mDAAmD;;IAEnD,mDAAmD;;IAEnD,sDAAsD;;IAEtD,4DAA4D;;IAE5D,iDAAiD;;IAEjD,uEAAuE;;IAEvE,gDAAgD;;IAEhD,uDAAuD;;IAEvD,sDAAsD;;IAEtD,8DAA8D;;IAE9D,wDAAwD;;IAExD,gFAAgF;;CAExE,CAAA;AAEV,mEAAmE;AACnE,MAAM,MAAM,kBAAkB,GAAG,CAAC,OAAO,kBAAkB,CAAC,CAAC,MAAM,OAAO,kBAAkB,CAAC,CAAA;AAE7F,gGAAgG;AAChG,eAAO,MAAM,sCAAsC;IACjD,gDAAgD;;IAEhD,0CAA0C;;IAE1C,iDAAiD;;IAEjD,qDAAqD;;IAErD,6DAA6D;;IAE7D,iDAAiD;;CAEzC,CAAA;AAEV,+FAA+F;AAC/F,MAAM,MAAM,sCAAsC,GAChD,CAAC,OAAO,sCAAsC,CAAC,CAAC,MAAM,OAAO,sCAAsC,CAAC,CAAA;AAEtG,wFAAwF;AACxF,MAAM,WAAW,mBAAmB;IAClC,0CAA0C;IAC1C,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,+DAA+D;IAC/D,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;IACvB,iFAAiF;IACjF,QAAQ,CAAC,oBAAoB,CAAC,EAAE,eAAe,CAAA;IAC/C,wEAAwE;IACxE,QAAQ,CAAC,oBAAoB,CAAC,EAAE,MAAM,CAAA;IACtC,qEAAqE;IACrE,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAA;IACnC,qEAAqE;IACrE,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAA;IACnC,iEAAiE;IACjE,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAA;IAC/B,kEAAkE;IAClE,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAA;IAChC,4DAA4D;IAC5D,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAA;CAC5B;AAED,6GAA6G;AAC7G,MAAM,WAAW,qBAAqB;IACpC,8CAA8C;IAC9C,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAC3B,wDAAwD;IACxD,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,+DAA+D;IAC/D,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;IACvB,iFAAiF;IACjF,QAAQ,CAAC,oBAAoB,CAAC,EAAE,eAAe,CAAA;IAC/C,wEAAwE;IACxE,QAAQ,CAAC,oBAAoB,CAAC,EAAE,MAAM,CAAA;IACtC,qEAAqE;IACrE,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAA;IACnC,qEAAqE;IACrE,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAA;IACnC,iEAAiE;IACjE,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAA;IAC/B,kEAAkE;IAClE,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAA;IAChC,4DAA4D;IAC5D,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAA;CAC5B;AAED;;;GAGG;AACH,MAAM,WAAW,4BAA4B;IAC3C,0CAA0C;IAC1C,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;IAC3B,sEAAsE;IACtE,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAA;IAC/B,sEAAsE;IACtE,QAAQ,CAAC,sBAAsB,EAAE,MAAM,CAAA;IACvC,gFAAgF;IAChF,QAAQ,CAAC,oBAAoB,CAAC,EAAE,MAAM,CAAA;IACtC,6EAA6E;IAC7E,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAA;IACnC,6EAA6E;IAC7E,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAA;IACnC,yEAAyE;IACzE,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAA;IAC/B,0EAA0E;IAC1E,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAA;IAChC,oEAAoE;IACpE,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAA;CAC5B;AAED,kEAAkE;AAClE,MAAM,WAAW,6BAA6B;IAC5C,2CAA2C;IAC3C,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;IAC3B,uDAAuD;IACvD,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAA;IAC/B,2DAA2D;IAC3D,QAAQ,CAAC,kBAAkB,EAAE,MAAM,CAAA;CACpC;AAED,+FAA+F;AAC/F,MAAM,WAAW,mBAAoB,SAAQ,iBAAiB;IAC5D,2EAA2E;IAC3E,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAA;CAChC;AAED,8EAA8E;AAC9E,MAAM,MAAM,4BAA4B,GAAG,YAAY,GAAG,mBAAmB,CAAA;AAE7E,0FAA0F;AAC1F,MAAM,WAAW,wBAAwB;IACvC,+EAA+E;IAC/E,QAAQ,CAAC,UAAU,EAAE,kBAAkB,CAAA;IACvC,iDAAiD;IACjD,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CACvB;AAED,uDAAuD;AACvD,MAAM,WAAW,eAAe;IAC9B,gDAAgD;IAChD,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;IAC5B,+CAA+C;IAC/C,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAA;IAC9B,uFAAuF;IACvF,QAAQ,CAAC,kBAAkB,CAAC,EAAE,MAAM,CAAA;IACpC,oFAAoF;IACpF,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,CAAA;IACjC,oFAAoF;IACpF,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,CAAA;IACjC,mGAAmG;IACnG,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAA;IAC9B,2EAA2E;IAC3E,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAA;IACzB,oEAAoE;IACpE,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAA;IAC9B,wEAAwE;IACxE,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IACnC,yCAAyC;IACzC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,iDAAiD;IACjD,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,4DAA4D;IAC5D,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACzC,+DAA+D;IAC/D,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAA;IAChC,8FAA8F;IAC9F,QAAQ,CAAC,oBAAoB,CAAC,EAAE,4BAA4B,CAAA;IAC5D,gFAAgF;IAChF,QAAQ,CAAC,aAAa,CAAC,EAAE,qBAAqB,CAAA;IAC9C,iFAAiF;IACjF,QAAQ,CAAC,SAAS,CAAC,EAAE,iBAAiB,CAAA;IACtC,gFAAgF;IAChF,QAAQ,CAAC,wBAAwB,CAAC,EAAE,SAAS,sCAAsC,EAAE,CAAA;IACrF,4FAA4F;IAC5F,QAAQ,CAAC,iBAAiB,CAAC,EAAE,SAAS,wBAAwB,EAAE,CAAA;CACjE"}

package/dist/types/download.d.ts

@@ -1,4 +1,66 @@
+import { SseB2Setting, SseCKeyMaterial, SseCPublicSetting } from './encryption.js';
 import { BucketId, FileId } from './ids.js';
+import { ReadableFileRetention, ReadableLegalHold } from './lock.js';
+/** HTTP response header names returned by B2 download endpoints. */
+export declare const DownloadHeaderName: {
+    /** Header carrying the response content disposition. */
+    readonly ContentDisposition: "Content-Disposition";
+    /** Header carrying the response content language. */
+    readonly ContentLanguage: "Content-Language";
+    /** Header carrying the response content encoding. */
+    readonly ContentEncoding: "Content-Encoding";
+    /** Header carrying the response content type. */
+    readonly ContentType: "Content-Type";
+    /** Header carrying the response cache policy. */
+    readonly CacheControl: "Cache-Control";
+    /** Header carrying the response expiration time. */
+    readonly Expires: "Expires";
+    /** Header carrying the byte range returned for partial downloads. */
+    readonly ContentRange: "Content-Range";
+    /** Header carrying the response content length. */
+    readonly ContentLength: "Content-Length";
+    /** Header carrying the B2 SHA-1 metadata value. */
+    readonly ContentSha1: "X-Bz-Content-Sha1";
+    /** Header carrying the downloaded file version ID. */
+    readonly FileId: "X-Bz-File-Id";
+    /** Header carrying the URL-encoded downloaded file name. */
+    readonly FileName: "X-Bz-File-Name";
+    /** Header carrying the file upload timestamp. */
+    readonly UploadTimestamp: "X-Bz-Upload-Timestamp";
+    /** Header carrying the B2-managed server-side encryption algorithm. */
+    readonly ServerSideEncryption: "X-Bz-Server-Side-Encryption";
+    /** Header carrying the SSE-C algorithm echo. */
+    readonly ServerSideEncryptionCustomerAlgorithm: "X-Bz-Server-Side-Encryption-Customer-Algorithm";
+    /** Header carrying the SSE-C customer-key MD5 echo. */
+    readonly ServerSideEncryptionCustomerKeyMd5: "X-Bz-Server-Side-Encryption-Customer-Key-Md5";
+    /** Header carrying the Object Lock retention mode. */
+    readonly FileRetentionMode: "X-Bz-File-Retention-Mode";
+    /** Header carrying the Object Lock retain-until timestamp. */
+    readonly FileRetentionRetainUntilTimestamp: "X-Bz-File-Retention-Retain-Until-Timestamp";
+    /** Header carrying the Object Lock legal-hold value. */
+    readonly FileLegalHold: "X-Bz-File-Legal-Hold";
+    /** Header carrying names of metadata headers hidden by missing capabilities. */
+    readonly ClientUnauthorizedToRead: "X-Bz-Client-Unauthorized-To-Read";
+};
+/** HTTP response header name returned by B2 download endpoints. */
+export type DownloadHeaderName = (typeof DownloadHeaderName)[keyof typeof DownloadHeaderName];
+/** Documented download metadata markers B2 may hide when the caller lacks read capabilities. */
+export declare const DownloadClientUnauthorizedToReadMarker: {
+    /** B2-managed encryption metadata is hidden. */
+    readonly ServerSideEncryption: "X-Bz-Server-Side-Encryption";
+    /** SSE-C algorithm metadata is hidden. */
+    readonly ServerSideEncryptionCustomerAlgorithm: "X-Bz-Server-Side-Encryption-Customer-Algorithm";
+    /** SSE-C customer-key MD5 metadata is hidden. */
+    readonly ServerSideEncryptionCustomerKeyMd5: "X-Bz-Server-Side-Encryption-Customer-Key-Md5";
+    /** Object Lock retention mode metadata is hidden. */
+    readonly FileRetentionMode: "X-Bz-File-Retention-Mode";
+    /** Object Lock retain-until timestamp metadata is hidden. */
+    readonly FileRetentionRetainUntilTimestamp: "X-Bz-File-Retention-Retain-Until-Timestamp";
+    /** Object Lock legal-hold metadata is hidden. */
+    readonly FileLegalHold: "X-Bz-File-Legal-Hold";
+};
+/** Documented download metadata marker B2 may hide when the caller lacks read capabilities. */
+export type DownloadClientUnauthorizedToReadMarker = (typeof DownloadClientUnauthorizedToReadMarker)[keyof typeof DownloadClientUnauthorizedToReadMarker];
 /** Request parameters for downloading a file by its ID via `b2_download_file_by_id`. */
 export interface DownloadByIdRequest {
     /** ID of the file version to download. */
@@ -6,14 +68,7 @@ export interface DownloadByIdRequest {
     /** Optional byte range to download (e.g., `'bytes=0-999'`). */
     readonly range?: string;
     /** SSE-C decryption parameters, required if the file was uploaded with SSE-C. */
-    readonly serverSideEncryption?: {
-        /** Encryption algorithm. Always `'AES256'`. */
-        readonly algorithm: 'AES256';
-        /** Base64-encoded customer-provided decryption key. */
-        readonly customerKey: string;
-        /** Base64-encoded MD5 digest of the decryption key. */
-        readonly customerKeyMd5: string;
-    };
+    readonly serverSideEncryption?: SseCKeyMaterial;
     /** Override the Content-Disposition header in the download response. */
     readonly b2ContentDisposition?: string;
     /** Override the Content-Language header in the download response. */
@@ -36,14 +91,7 @@ export interface DownloadByNameRequest {
     /** Optional byte range to download (e.g., `'bytes=0-999'`). */
     readonly range?: string;
     /** SSE-C decryption parameters, required if the file was uploaded with SSE-C. */
-    readonly serverSideEncryption?: {
-        /** Encryption algorithm. Always `'AES256'`. */
-        readonly algorithm: 'AES256';
-        /** Base64-encoded customer-provided decryption key. */
-        readonly customerKey: string;
-        /** Base64-encoded MD5 digest of the decryption key. */
-        readonly customerKeyMd5: string;
-    };
+    readonly serverSideEncryption?: SseCKeyMaterial;
     /** Override the Content-Disposition header in the download response. */
     readonly b2ContentDisposition?: string;
     /** Override the Content-Language header in the download response. */
@@ -90,12 +138,38 @@ export interface DownloadAuthorizationResponse {
     /** Authorization token to include in download requests. */
     readonly authorizationToken: string;
 }
+/** Customer-managed server-side encryption metadata echoed in B2 download response headers. */
+export interface SseCDownloadSetting extends SseCPublicSetting {
+    /** MD5 digest echoed by `X-Bz-Server-Side-Encryption-Customer-Key-Md5`. */
+    readonly customerKeyMd5: string;
+}
+/** Server-side encryption metadata echoed in B2 download response headers. */
+export type DownloadServerSideEncryption = SseB2Setting | SseCDownloadSetting;
+/** Diagnostic for a present download metadata header the SDK could not parse narrowly. */
+export interface DownloadHeaderParseIssue {
+    /** Header whose value could not be parsed into the current typed SDK model. */
+    readonly headerName: DownloadHeaderName;
+    /** Raw header value that could not be parsed. */
+    readonly value: string;
+}
 /** Parsed headers from a B2 file download response. */
 export interface DownloadHeaders {
     /** MIME type of the downloaded file content. */
     readonly contentType: string;
     /** Size of the downloaded content in bytes. */
     readonly contentLength: number;
+    /** Content-Disposition value computed from upload metadata or the download request. */
+    readonly contentDisposition?: string;
+    /** Content-Language value computed from upload metadata or the download request. */
+    readonly contentLanguage?: string;
+    /** Content-Encoding value computed from upload metadata or the download request. */
+    readonly contentEncoding?: string;
+    /** Cache-Control value computed from upload metadata, bucket defaults, or the download request. */
+    readonly cacheControl?: string;
+    /** Expires value computed from upload metadata or the download request. */
+    readonly expires?: string;
+    /** Content-Range value returned for satisfiable range downloads. */
+    readonly contentRange?: string;
     /** SHA-1 checksum of the full file content, or null for large files. */
     readonly contentSha1: string | null;
     /** ID of the downloaded file version. */
@@ -106,5 +180,15 @@ export interface DownloadHeaders {
     readonly fileInfo: Record<string, string>;
     /** UTC timestamp (milliseconds) when the file was uploaded. */
     readonly uploadTimestamp: number;
+    /** Server-side encryption metadata echoed by B2, when the caller is authorized to read it. */
+    readonly serverSideEncryption?: DownloadServerSideEncryption;
+    /** Object Lock retention metadata, including whether the caller may read it. */
+    readonly fileRetention?: ReadableFileRetention;
+    /** Object Lock legal hold metadata, including whether the caller may read it. */
+    readonly legalHold?: ReadableLegalHold;
+    /** Header names B2 omitted because the caller lacks capability to read them. */
+    readonly clientUnauthorizedToRead?: readonly DownloadClientUnauthorizedToReadMarker[];
+    /** Present metadata headers the SDK could not parse into its current narrow typed model. */
+    readonly headerParseIssues?: readonly DownloadHeaderParseIssue[];
 }
 //# sourceMappingURL=download.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"download.d.ts","sourceRoot":"","sources":["../../src/types/download.js"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAEhD,wFAAwF;AACxF,MAAM,WAAW,mBAAmB;IAClC,0CAA0C;IAC1C,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,+DAA+D;IAC/D,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;IACvB,iFAAiF;IACjF,QAAQ,CAAC,oBAAoB,CAAC,EAAE;QAC9B,+CAA+C;QAC/C,QAAQ,CAAC,SAAS,EAAE,QAAQ,CAAA;QAC5B,uDAAuD;QACvD,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;QAC5B,uDAAuD;QACvD,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAA;KAChC,CAAA;IACD,wEAAwE;IACxE,QAAQ,CAAC,oBAAoB,CAAC,EAAE,MAAM,CAAA;IACtC,qEAAqE;IACrE,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAA;IACnC,qEAAqE;IACrE,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAA;IACnC,iEAAiE;IACjE,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAA;IAC/B,kEAAkE;IAClE,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAA;IAChC,4DAA4D;IAC5D,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAA;CAC5B;AAED,6GAA6G;AAC7G,MAAM,WAAW,qBAAqB;IACpC,8CAA8C;IAC9C,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAC3B,wDAAwD;IACxD,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,+DAA+D;IAC/D,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;IACvB,iFAAiF;IACjF,QAAQ,CAAC,oBAAoB,CAAC,EAAE;QAC9B,+CAA+C;QAC/C,QAAQ,CAAC,SAAS,EAAE,QAAQ,CAAA;QAC5B,uDAAuD;QACvD,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;QAC5B,uDAAuD;QACvD,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAA;KAChC,CAAA;IACD,wEAAwE;IACxE,QAAQ,CAAC,oBAAoB,CAAC,EAAE,MAAM,CAAA;IACtC,qEAAqE;IACrE,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAA;IACnC,qEAAqE;IACrE,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAA;IACnC,iEAAiE;IACjE,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAA;IAC/B,kEAAkE;IAClE,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAA;IAChC,4DAA4D;IAC5D,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAA;CAC5B;AAED;;;GAGG;AACH,MAAM,WAAW,4BAA4B;IAC3C,0CAA0C;IAC1C,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;IAC3B,sEAAsE;IACtE,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAA;IAC/B,sEAAsE;IACtE,QAAQ,CAAC,sBAAsB,EAAE,MAAM,CAAA;IACvC,gFAAgF;IAChF,QAAQ,CAAC,oBAAoB,CAAC,EAAE,MAAM,CAAA;IACtC,6EAA6E;IAC7E,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAA;IACnC,6EAA6E;IAC7E,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAA;IACnC,yEAAyE;IACzE,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAA;IAC/B,0EAA0E;IAC1E,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAA;IAChC,oEAAoE;IACpE,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAA;CAC5B;AAED,kEAAkE;AAClE,MAAM,WAAW,6BAA6B;IAC5C,2CAA2C;IAC3C,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;IAC3B,uDAAuD;IACvD,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAA;IAC/B,2DAA2D;IAC3D,QAAQ,CAAC,kBAAkB,EAAE,MAAM,CAAA;CACpC;AAED,uDAAuD;AACvD,MAAM,WAAW,eAAe;IAC9B,gDAAgD;IAChD,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;IAC5B,+CAA+C;IAC/C,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAA;IAC9B,wEAAwE;IACxE,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IACnC,yCAAyC;IACzC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,iDAAiD;IACjD,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,4DAA4D;IAC5D,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACzC,+DAA+D;IAC/D,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAA;CACjC"}
+{"version":3,"file":"download.d.ts","sourceRoot":"","sources":["../../src/types/download.js"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAA;AACvF,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAChD,OAAO,KAAK,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAA;AAEzE,oEAAoE;AACpE,eAAO,MAAM,kBAAkB;IAC7B,wDAAwD;;IAExD,qDAAqD;;IAErD,qDAAqD;;IAErD,iDAAiD;;IAEjD,iDAAiD;;IAEjD,oDAAoD;;IAEpD,qEAAqE;;IAErE,mDAAmD;;IAEnD,mDAAmD;;IAEnD,sDAAsD;;IAEtD,4DAA4D;;IAE5D,iDAAiD;;IAEjD,uEAAuE;;IAEvE,gDAAgD;;IAEhD,uDAAuD;;IAEvD,sDAAsD;;IAEtD,8DAA8D;;IAE9D,wDAAwD;;IAExD,gFAAgF;;CAExE,CAAA;AAEV,mEAAmE;AACnE,MAAM,MAAM,kBAAkB,GAAG,CAAC,OAAO,kBAAkB,CAAC,CAAC,MAAM,OAAO,kBAAkB,CAAC,CAAA;AAE7F,gGAAgG;AAChG,eAAO,MAAM,sCAAsC;IACjD,gDAAgD;;IAEhD,0CAA0C;;IAE1C,iDAAiD;;IAEjD,qDAAqD;;IAErD,6DAA6D;;IAE7D,iDAAiD;;CAEzC,CAAA;AAEV,+FAA+F;AAC/F,MAAM,MAAM,sCAAsC,GAChD,CAAC,OAAO,sCAAsC,CAAC,CAAC,MAAM,OAAO,sCAAsC,CAAC,CAAA;AAEtG,wFAAwF;AACxF,MAAM,WAAW,mBAAmB;IAClC,0CAA0C;IAC1C,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,+DAA+D;IAC/D,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;IACvB,iFAAiF;IACjF,QAAQ,CAAC,oBAAoB,CAAC,EAAE,eAAe,CAAA;IAC/C,wEAAwE;IACxE,QAAQ,CAAC,oBAAoB,CAAC,EAAE,MAAM,CAAA;IACtC,qEAAqE;IACrE,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAA;IACnC,qEAAqE;IACrE,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAA;IACnC,iEAAiE;IACjE,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAA;IAC/B,kEAAkE;IAClE,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAA;IAChC,4DAA4D;IAC5D,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAA;CAC5B;AAED,6GAA6G;AAC7G,MAAM,WAAW,qBAAqB;IACpC,8CAA8C;IAC9C,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAC3B,wDAAwD;IACxD,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,+DAA+D;IAC/D,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;IACvB,iFAAiF;IACjF,QAAQ,CAAC,oBAAoB,CAAC,EAAE,eAAe,CAAA;IAC/C,wEAAwE;IACxE,QAAQ,CAAC,oBAAoB,CAAC,EAAE,MAAM,CAAA;IACtC,qEAAqE;IACrE,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAA;IACnC,qEAAqE;IACrE,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAA;IACnC,iEAAiE;IACjE,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAA;IAC/B,kEAAkE;IAClE,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAA;IAChC,4DAA4D;IAC5D,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAA;CAC5B;AAED;;;GAGG;AACH,MAAM,WAAW,4BAA4B;IAC3C,0CAA0C;IAC1C,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;IAC3B,sEAAsE;IACtE,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAA;IAC/B,sEAAsE;IACtE,QAAQ,CAAC,sBAAsB,EAAE,MAAM,CAAA;IACvC,gFAAgF;IAChF,QAAQ,CAAC,oBAAoB,CAAC,EAAE,MAAM,CAAA;IACtC,6EAA6E;IAC7E,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAA;IACnC,6EAA6E;IAC7E,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAA;IACnC,yEAAyE;IACzE,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAA;IAC/B,0EAA0E;IAC1E,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAA;IAChC,oEAAoE;IACpE,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAA;CAC5B;AAED,kEAAkE;AAClE,MAAM,WAAW,6BAA6B;IAC5C,2CAA2C;IAC3C,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;IAC3B,uDAAuD;IACvD,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAA;IAC/B,2DAA2D;IAC3D,QAAQ,CAAC,kBAAkB,EAAE,MAAM,CAAA;CACpC;AAED,+FAA+F;AAC/F,MAAM,WAAW,mBAAoB,SAAQ,iBAAiB;IAC5D,2EAA2E;IAC3E,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAA;CAChC;AAED,8EAA8E;AAC9E,MAAM,MAAM,4BAA4B,GAAG,YAAY,GAAG,mBAAmB,CAAA;AAE7E,0FAA0F;AAC1F,MAAM,WAAW,wBAAwB;IACvC,+EAA+E;IAC/E,QAAQ,CAAC,UAAU,EAAE,kBAAkB,CAAA;IACvC,iDAAiD;IACjD,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CACvB;AAED,uDAAuD;AACvD,MAAM,WAAW,eAAe;IAC9B,gDAAgD;IAChD,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;IAC5B,+CAA+C;IAC/C,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAA;IAC9B,uFAAuF;IACvF,QAAQ,CAAC,kBAAkB,CAAC,EAAE,MAAM,CAAA;IACpC,oFAAoF;IACpF,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,CAAA;IACjC,oFAAoF;IACpF,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,CAAA;IACjC,mGAAmG;IACnG,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAA;IAC9B,2EAA2E;IAC3E,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAA;IACzB,oEAAoE;IACpE,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAA;IAC9B,wEAAwE;IACxE,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IACnC,yCAAyC;IACzC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,iDAAiD;IACjD,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,4DAA4D;IAC5D,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACzC,+DAA+D;IAC/D,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAA;IAChC,8FAA8F;IAC9F,QAAQ,CAAC,oBAAoB,CAAC,EAAE,4BAA4B,CAAA;IAC5D,gFAAgF;IAChF,QAAQ,CAAC,aAAa,CAAC,EAAE,qBAAqB,CAAA;IAC9C,iFAAiF;IACjF,QAAQ,CAAC,SAAS,CAAC,EAAE,iBAAiB,CAAA;IACtC,gFAAgF;IAChF,QAAQ,CAAC,wBAAwB,CAAC,EAAE,SAAS,sCAAsC,EAAE,CAAA;IACrF,4FAA4F;IAC5F,QAAQ,CAAC,iBAAiB,CAAC,EAAE,SAAS,wBAAwB,EAAE,CAAA;CACjE"}

package/dist/types/download.js

@@ -0,0 +1,61 @@
+//#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
+export { DownloadClientUnauthorizedToReadMarker, DownloadHeaderName };
+
+//# sourceMappingURL=download.js.map

package/dist/types/download.js.map

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