@unofficialbox/box-open-sdk 0.7.0 → 0.7.1

package/dist/cjs/errors.js

@@ -2,6 +2,7 @@
 // Code generated by box-gantry (vendored from runtimes/typescript/gantryruntime/src/errors.ts). DO NOT EDIT.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BoxApiError = void 0;
+exports.isPreconditionFailed = isPreconditionFailed;
 exports.apiErrorFromResponse = apiErrorFromResponse;
 /**
  * A runtime error: a failed request, auth acquisition, or body decode. The
@@ -31,6 +32,12 @@ class BoxApiError extends Error {
     }
 }
 exports.BoxApiError = BoxApiError;
+/** Whether `err` is Box's 412 Precondition Failed: an `If-Match` write whose
+ * etag no longer matches, because the item changed since it was read. Re-read
+ * the item and retry with its new etag. */
+function isPreconditionFailed(err) {
+    return err instanceof BoxApiError && err.status === 412;
+}
 /** The error for a non-2xx response: `Client.fetch` throws it once the retry
  * budget and the single 401 refresh are spent, so a caller never mistakes an
  * error body for a result. Box's error fields are read from the body when it

package/dist/cjs/runtime.js

@@ -15,7 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Client = exports.Stream = exports.Response = exports.Request = exports.BoxApiError = void 0;
+exports.Client = exports.Stream = exports.Response = exports.Request = exports.isPreconditionFailed = exports.BoxApiError = void 0;
 exports.withHeader = withHeader;
 exports.withQuery = withQuery;
 exports.withJsonBody = withJsonBody;
@@ -29,6 +29,7 @@ exports.statusCode = statusCode;
 const errors_js_1 = require("./errors.js");
 var errors_js_2 = require("./errors.js");
 Object.defineProperty(exports, "BoxApiError", { enumerable: true, get: function () { return errors_js_2.BoxApiError; } });
+Object.defineProperty(exports, "isPreconditionFailed", { enumerable: true, get: function () { return errors_js_2.isPreconditionFailed; } });
 __exportStar(require("./auth.js"), exports);
 /** The default base URLs for the D-106 URL classes. */
 const DEFAULT_BASE_URLS = {

package/dist/esm/errors.js

@@ -26,6 +26,12 @@ export class BoxApiError extends Error {
         this.body = options.body;
     }
 }
+/** Whether `err` is Box's 412 Precondition Failed: an `If-Match` write whose
+ * etag no longer matches, because the item changed since it was read. Re-read
+ * the item and retry with its new etag. */
+export function isPreconditionFailed(err) {
+    return err instanceof BoxApiError && err.status === 412;
+}
 /** The error for a non-2xx response: `Client.fetch` throws it once the retry
  * budget and the single 401 refresh are spent, so a caller never mistakes an
  * error body for a result. Box's error fields are read from the body when it

package/dist/esm/runtime.js

@@ -1,6 +1,6 @@
 // Code generated by box-gantry (vendored from runtimes/typescript/gantryruntime/src/runtime.ts). DO NOT EDIT.
 import { BoxApiError, apiErrorFromResponse } from './errors.js';
-export { BoxApiError } from './errors.js';
+export { BoxApiError, isPreconditionFailed } from './errors.js';
 export * from './auth.js';
 /** The default base URLs for the D-106 URL classes. */
 const DEFAULT_BASE_URLS = {

package/dist/types/errors.d.ts

@@ -33,6 +33,10 @@ export declare class BoxApiError extends Error {
     readonly body?: Uint8Array;
     constructor(message: string, options?: BoxApiErrorOptions);
 }
+/** Whether `err` is Box's 412 Precondition Failed: an `If-Match` write whose
+ * etag no longer matches, because the item changed since it was read. Re-read
+ * the item and retry with its new etag. */
+export declare function isPreconditionFailed(err: unknown): err is BoxApiError;
 /** The error for a non-2xx response: `Client.fetch` throws it once the retry
  * budget and the single 401 refresh are spent, so a caller never mistakes an
  * error body for a result. Box's error fields are read from the body when it

package/dist/types/runtime.d.ts

@@ -1,5 +1,5 @@
 import type { Auth } from './auth.js';
-export { BoxApiError } from './errors.js';
+export { BoxApiError, isPreconditionFailed } from './errors.js';
 export * from './auth.js';
 /** The runtime-owned HTTP request envelope, assembled by the `with*` builders
  * before `fetch` executes it. */

package/docs/errors.md

@@ -34,18 +34,24 @@ guide):
 - **Writes** — pass the etag as `'if-match'` on a file or folder update or
   delete, or a new file version upload. Box answers `412 Precondition
   Failed` (code `precondition_failed`) when the item changed since you read
-  it: read it again, reapply your change, retry. `If-Match` can't block a move.
+  it, and `runtime.isPreconditionFailed(err)` reports it: read it again,
+  reapply your change, retry. `If-Match` can't block a move.
 
 ```ts
 const file = await client.files.getIfModified(fileId, etag);
 if (file === undefined) {
   // unchanged since etag
 }
-try {
-  await client.files.update(fileId, body, { 'if-match': etag });
-} catch (err) {
-  if (err instanceof runtime.BoxApiError && err.status === 412) {
-    // changed since etag: re-read and retry
+
+// Re-read and retry: the update lands only on the version it was made from.
+for (let attempt = 1; ; attempt++) {
+  try {
+    await client.files.update(fileId, body, { 'if-match': etag });
+    break;
+  } catch (err) {
+    if (!runtime.isPreconditionFailed(err) || attempt === 3) throw err;
+    const current = await client.files.get(fileId);
+    etag = current.etag ?? undefined; // reapply your change to current here
   }
 }
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unofficialbox/box-open-sdk",
-  "version": "0.7.0",
+  "version": "0.7.1",
   "description": "Box API client for TypeScript (open source, community, punk rock) — typed models, async managers, and a fetch runtime with retry, backoff, and token refresh.",
   "keywords": ["box", "box-api", "sdk", "api-client", "typescript", "unofficial"],
   "license": "MIT",