@backblaze-labs/b2-sdk 0.1.0 → 0.2.0

package/dist/upload/finish.d.cts

@@ -0,0 +1,26 @@
+import { AccountInfo } from '../auth/account-info.js';
+import { RetryOptions } from '../http/retry.js';
+import { RawClient } from '../raw/index.js';
+import { FileVersion } from '../types/file.js';
+import { BucketId, LargeFileId } from '../types/ids.js';
+/** Context for safely finalizing a large file. */
+export interface FinishLargeFileContext {
+    readonly fileId: LargeFileId;
+    readonly bucketId: BucketId;
+    readonly fileName: string;
+    readonly partSha1s: readonly string[];
+    readonly signal?: AbortSignal;
+    readonly retry?: Partial<RetryOptions>;
+}
+/**
+ * Calls `b2_finish_large_file` and classifies failures after dispatch that can
+ * hide an already-committed file as ambiguous finish failures.
+ *
+ * @param raw - Low-level B2 API client.
+ * @param accountInfo - Authorized account state.
+ * @param context - Finish request data and reconciliation metadata.
+ *
+ * @returns The completed file version metadata.
+ */
+export declare function finishLargeFileWithAbortReconciliation(raw: RawClient, accountInfo: AccountInfo, context: FinishLargeFileContext): Promise<FileVersion>;
+//# sourceMappingURL=finish.d.ts.map

package/dist/upload/finish.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"finish.d.ts","sourceRoot":"","sources":["../../src/upload/finish.js"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AAE1D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAA;AACpD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAChD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AACnD,OAAO,KAAK,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAA;AAE5D,kDAAkD;AAClD,MAAM,WAAW,sBAAsB;IACrC,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAA;IAC5B,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;IAC3B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,SAAS,EAAE,SAAS,MAAM,EAAE,CAAA;IACrC,QAAQ,CAAC,MAAM,CAAC,EAAE,WAAW,CAAA;IAC7B,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC,CAAA;CACvC;AAED;;;;;;;;;GASG;AACH,wBAAsB,sCAAsC,CAC1D,GAAG,EAAE,SAAS,EACd,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,sBAAsB,GAC9B,OAAO,CAAC,WAAW,CAAC,CAkCtB"}

package/dist/upload/finish.d.ts

@@ -0,0 +1,26 @@
+import { AccountInfo } from '../auth/account-info.js';
+import { RetryOptions } from '../http/retry.js';
+import { RawClient } from '../raw/index.js';
+import { FileVersion } from '../types/file.js';
+import { BucketId, LargeFileId } from '../types/ids.js';
+/** Context for safely finalizing a large file. */
+export interface FinishLargeFileContext {
+    readonly fileId: LargeFileId;
+    readonly bucketId: BucketId;
+    readonly fileName: string;
+    readonly partSha1s: readonly string[];
+    readonly signal?: AbortSignal;
+    readonly retry?: Partial<RetryOptions>;
+}
+/**
+ * Calls `b2_finish_large_file` and classifies failures after dispatch that can
+ * hide an already-committed file as ambiguous finish failures.
+ *
+ * @param raw - Low-level B2 API client.
+ * @param accountInfo - Authorized account state.
+ * @param context - Finish request data and reconciliation metadata.
+ *
+ * @returns The completed file version metadata.
+ */
+export declare function finishLargeFileWithAbortReconciliation(raw: RawClient, accountInfo: AccountInfo, context: FinishLargeFileContext): Promise<FileVersion>;
+//# sourceMappingURL=finish.d.ts.map

package/dist/upload/finish.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"finish.d.ts","sourceRoot":"","sources":["../../src/upload/finish.js"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AAE1D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAA;AACpD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAChD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AACnD,OAAO,KAAK,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAA;AAE5D,kDAAkD;AAClD,MAAM,WAAW,sBAAsB;IACrC,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAA;IAC5B,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;IAC3B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,SAAS,EAAE,SAAS,MAAM,EAAE,CAAA;IACrC,QAAQ,CAAC,MAAM,CAAC,EAAE,WAAW,CAAA;IAC7B,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC,CAAA;CACvC;AAED;;;;;;;;;GASG;AACH,wBAAsB,sCAAsC,CAC1D,GAAG,EAAE,SAAS,EACd,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,sBAAsB,GAC9B,OAAO,CAAC,WAAW,CAAC,CAkCtB"}

package/dist/upload/finish.js

@@ -0,0 +1,59 @@
+import { FinishLargeFileResponseBodyError, NetworkError } from "../errors/index.js";
+//#region src/upload/finish.ts
+/**
+* Calls `b2_finish_large_file` and classifies failures after dispatch that can
+* hide an already-committed file as ambiguous finish failures.
+*
+* @param raw - Low-level B2 API client.
+* @param accountInfo - Authorized account state.
+* @param context - Finish request data and reconciliation metadata.
+*
+* @returns The completed file version metadata.
+*/
+async function finishLargeFileWithAbortReconciliation(raw, accountInfo, context) {
+	context.signal?.throwIfAborted();
+	try {
+		return await raw.finishLargeFile(accountInfo.getApiUrl(), accountInfo.getAuthToken(), {
+			fileId: context.fileId,
+			partSha1Array: context.partSha1s
+		}, context.signal === void 0 && context.retry === void 0 ? void 0 : {
+			...context.signal !== void 0 ? { signal: context.signal } : {},
+			...context.retry !== void 0 ? { retry: context.retry } : {}
+		});
+	} catch (err) {
+		if (err instanceof FinishLargeFileResponseBodyError) throw finishLargeFileResponseBodyErrorWithContext(err, context);
+		if (isAmbiguousFinishDispatchFailure(err, context.signal)) throw new FinishLargeFileResponseBodyError("b2_finish_large_file failed after dispatch; final file state is ambiguous.", {
+			cause: err,
+			fileId: context.fileId,
+			bucketId: context.bucketId,
+			fileName: context.fileName
+		});
+		throw err;
+	}
+}
+function finishLargeFileResponseBodyErrorWithContext(err, context) {
+	if (err.fileId === context.fileId && err.bucketId === context.bucketId && err.fileName === context.fileName) return err;
+	return new FinishLargeFileResponseBodyError(err.message, {
+		cause: err.cause ?? err,
+		fileId: context.fileId,
+		bucketId: context.bucketId,
+		fileName: context.fileName
+	});
+}
+function isAmbiguousFinishDispatchFailure(err, signal) {
+	if (err instanceof NetworkError) return true;
+	if (isTimeoutError(err)) return true;
+	if (signal?.aborted !== true) return false;
+	if (signal.reason !== void 0 && Object.is(err, signal.reason)) return true;
+	return isAbortError(err);
+}
+function isAbortError(err) {
+	return err instanceof DOMException && err.name === "AbortError" || err instanceof Error && err.name === "AbortError";
+}
+function isTimeoutError(err) {
+	return err instanceof DOMException && err.name === "TimeoutError" || err instanceof Error && err.name === "TimeoutError";
+}
+//#endregion
+export { finishLargeFileWithAbortReconciliation };
+
+//# sourceMappingURL=finish.js.map

package/dist/upload/finish.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"finish.js","names":[],"sources":["../../src/upload/finish.ts"],"sourcesContent":["import type { AccountInfo } from '../auth/account-info.ts'\nimport { FinishLargeFileResponseBodyError, NetworkError } from '../errors/index.ts'\nimport type { RetryOptions } from '../http/retry.ts'\nimport type { RawClient } from '../raw/index.ts'\nimport type { FileVersion } from '../types/file.ts'\nimport type { BucketId, LargeFileId } from '../types/ids.ts'\n\n/** Context for safely finalizing a large file. */\nexport interface FinishLargeFileContext {\n  readonly fileId: LargeFileId\n  readonly bucketId: BucketId\n  readonly fileName: string\n  readonly partSha1s: readonly string[]\n  readonly signal?: AbortSignal\n  readonly retry?: Partial<RetryOptions>\n}\n\n/**\n * Calls `b2_finish_large_file` and classifies failures after dispatch that can\n * hide an already-committed file as ambiguous finish failures.\n *\n * @param raw - Low-level B2 API client.\n * @param accountInfo - Authorized account state.\n * @param context - Finish request data and reconciliation metadata.\n *\n * @returns The completed file version metadata.\n */\nexport async function finishLargeFileWithAbortReconciliation(\n  raw: RawClient,\n  accountInfo: AccountInfo,\n  context: FinishLargeFileContext,\n): Promise<FileVersion> {\n  context.signal?.throwIfAborted()\n  try {\n    return await raw.finishLargeFile(\n      accountInfo.getApiUrl(),\n      accountInfo.getAuthToken(),\n      {\n        fileId: context.fileId,\n        partSha1Array: context.partSha1s,\n      },\n      context.signal === undefined && context.retry === undefined\n        ? undefined\n        : {\n            ...(context.signal !== undefined ? { signal: context.signal } : {}),\n            ...(context.retry !== undefined ? { retry: context.retry } : {}),\n          },\n    )\n  } catch (err) {\n    if (err instanceof FinishLargeFileResponseBodyError) {\n      throw finishLargeFileResponseBodyErrorWithContext(err, context)\n    }\n    if (isAmbiguousFinishDispatchFailure(err, context.signal)) {\n      throw new FinishLargeFileResponseBodyError(\n        'b2_finish_large_file failed after dispatch; final file state is ambiguous.',\n        {\n          cause: err,\n          fileId: context.fileId,\n          bucketId: context.bucketId,\n          fileName: context.fileName,\n        },\n      )\n    }\n    throw err\n  }\n}\n\nfunction finishLargeFileResponseBodyErrorWithContext(\n  err: FinishLargeFileResponseBodyError,\n  context: FinishLargeFileContext,\n): FinishLargeFileResponseBodyError {\n  if (\n    err.fileId === context.fileId &&\n    err.bucketId === context.bucketId &&\n    err.fileName === context.fileName\n  ) {\n    return err\n  }\n  return new FinishLargeFileResponseBodyError(err.message, {\n    cause: err.cause ?? err,\n    fileId: context.fileId,\n    bucketId: context.bucketId,\n    fileName: context.fileName,\n  })\n}\n\nfunction isAmbiguousFinishDispatchFailure(err: unknown, signal: AbortSignal | undefined): boolean {\n  if (err instanceof NetworkError) return true\n  if (isTimeoutError(err)) return true\n  if (signal?.aborted !== true) return false\n  if (signal.reason !== undefined && Object.is(err, signal.reason)) return true\n  return isAbortError(err)\n}\n\nfunction isAbortError(err: unknown): boolean {\n  return (\n    (err instanceof DOMException && err.name === 'AbortError') ||\n    (err instanceof Error && err.name === 'AbortError')\n  )\n}\n\nfunction isTimeoutError(err: unknown): boolean {\n  return (\n    (err instanceof DOMException && err.name === 'TimeoutError') ||\n    (err instanceof Error && err.name === 'TimeoutError')\n  )\n}\n"],"mappings":";;;;;;;;;;;;AA2BA,eAAsB,uCACpB,KACA,aACA,SACsB;CACtB,QAAQ,QAAQ,eAAe;CAC/B,IAAI;EACF,OAAO,MAAM,IAAI,gBACf,YAAY,UAAU,GACtB,YAAY,aAAa,GACzB;GACE,QAAQ,QAAQ;GAChB,eAAe,QAAQ;EACzB,GACA,QAAQ,WAAW,KAAA,KAAa,QAAQ,UAAU,KAAA,IAC9C,KAAA,IACA;GACE,GAAI,QAAQ,WAAW,KAAA,IAAY,EAAE,QAAQ,QAAQ,OAAO,IAAI,CAAC;GACjE,GAAI,QAAQ,UAAU,KAAA,IAAY,EAAE,OAAO,QAAQ,MAAM,IAAI,CAAC;EAChE,CACN;CACF,SAAS,KAAK;EACZ,IAAI,eAAe,kCACjB,MAAM,4CAA4C,KAAK,OAAO;EAEhE,IAAI,iCAAiC,KAAK,QAAQ,MAAM,GACtD,MAAM,IAAI,iCACR,8EACA;GACE,OAAO;GACP,QAAQ,QAAQ;GAChB,UAAU,QAAQ;GAClB,UAAU,QAAQ;EACpB,CACF;EAEF,MAAM;CACR;AACF;AAEA,SAAS,4CACP,KACA,SACkC;CAClC,IACE,IAAI,WAAW,QAAQ,UACvB,IAAI,aAAa,QAAQ,YACzB,IAAI,aAAa,QAAQ,UAEzB,OAAO;CAET,OAAO,IAAI,iCAAiC,IAAI,SAAS;EACvD,OAAO,IAAI,SAAS;EACpB,QAAQ,QAAQ;EAChB,UAAU,QAAQ;EAClB,UAAU,QAAQ;CACpB,CAAC;AACH;AAEA,SAAS,iCAAiC,KAAc,QAA0C;CAChG,IAAI,eAAe,cAAc,OAAO;CACxC,IAAI,eAAe,GAAG,GAAG,OAAO;CAChC,IAAI,QAAQ,YAAY,MAAM,OAAO;CACrC,IAAI,OAAO,WAAW,KAAA,KAAa,OAAO,GAAG,KAAK,OAAO,MAAM,GAAG,OAAO;CACzE,OAAO,aAAa,GAAG;AACzB;AAEA,SAAS,aAAa,KAAuB;CAC3C,OACG,eAAe,gBAAgB,IAAI,SAAS,gBAC5C,eAAe,SAAS,IAAI,SAAS;AAE1C;AAEA,SAAS,eAAe,KAAuB;CAC7C,OACG,eAAe,gBAAgB,IAAI,SAAS,kBAC5C,eAAe,SAAS,IAAI,SAAS;AAE1C"}