@bayonai/offline 0.8.0 → 0.10.0

package/dist-cjs/recoveryPolicy.d.ts

@@ -0,0 +1,20 @@
+/** Shared product decision: recovery is application work, never a retry prompt. */
+export declare const offlineRecoveryCopy: {
+    readonly reload: "Reload";
+    readonly reloading: "Reconnecting…";
+    readonly preservedChanges: "Some changes could not be saved. Your edits are preserved.";
+};
+export type PendingChangesGuidanceState = {
+    hasReadyChanges: boolean;
+    hasDrafts: boolean;
+    hasErrors: boolean;
+    isOffline: boolean;
+};
+/** Hosts project domain records to flags; payloads never enter shared guidance. */
+export declare function getPendingChangesGuidance({ hasReadyChanges, hasDrafts, hasErrors, isOffline, }: PendingChangesGuidanceState): string;
+/**
+ * Recognize known transient transport/service failures without a provider SDK.
+ * Hosts still own domain validation, idempotency, account scope and replay selection.
+ * Unknown failures are not permission to blindly repeat a mutation.
+ */
+export declare function isTransientOfflineError(error: unknown): boolean;

package/dist-cjs/recoveryPolicy.js

@@ -0,0 +1,78 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.offlineRecoveryCopy = void 0;
+exports.getPendingChangesGuidance = getPendingChangesGuidance;
+exports.isTransientOfflineError = isTransientOfflineError;
+/** Shared product decision: recovery is application work, never a retry prompt. */
+exports.offlineRecoveryCopy = {
+    reload: "Reload",
+    reloading: "Reconnecting…",
+    preservedChanges: "Some changes could not be saved. Your edits are preserved.",
+};
+/** Hosts project domain records to flags; payloads never enter shared guidance. */
+function getPendingChangesGuidance({ hasReadyChanges, hasDrafts, hasErrors, isOffline, }) {
+    if (!hasReadyChanges)
+        return hasDrafts
+            ? "Finish editing these drafts to save them."
+            : exports.offlineRecoveryCopy.preservedChanges;
+    if (!hasDrafts && !hasErrors)
+        return isOffline
+            ? "We’ll sync when you’re back online."
+            : "We’ll sync automatically.";
+    const sync = isOffline
+        ? "Changes ready to send will sync when you’re back online."
+        : "Changes ready to send will sync automatically.";
+    return hasDrafts ? `${sync} Finish editing drafts to save them.` : sync;
+}
+const terminalCodes = new Set([
+    "unauthenticated",
+    "permission-denied",
+    "resource-exhausted",
+    "invalid-argument",
+    "failed-precondition",
+    "not-found",
+    "already-exists",
+]);
+const transientCodes = new Set([
+    "unavailable",
+    "deadline-exceeded",
+    "cancelled",
+    "network-request-failed",
+    "internal",
+    "aborted",
+]);
+// Exact transport diagnostics are safe fallbacks only when no structured code
+// exists. Domain messages mentioning a network/offline setting are not signals.
+const connectivityMessages = new Set([
+    "failed to fetch",
+    "fetch failed",
+    "network request failed",
+    "load failed",
+    "offline",
+    "network unavailable",
+    "failed to get documents from server. these documents may exist in the local cache",
+    "failed to get document because the client is offline",
+]);
+/**
+ * Recognize known transient transport/service failures without a provider SDK.
+ * Hosts still own domain validation, idempotency, account scope and replay selection.
+ * Unknown failures are not permission to blindly repeat a mutation.
+ */
+function isTransientOfflineError(error) {
+    const record = error && typeof error === "object" ? error : {};
+    const rawCode = "code" in record ? record.code : undefined;
+    const code = typeof rawCode === "string" ? rawCode.toLowerCase().split("/").at(-1) : "";
+    if (terminalCodes.has(code))
+        return false;
+    if (transientCodes.has(code))
+        return true;
+    if (code)
+        return false;
+    const rawMessage = typeof error === "string"
+        ? error
+        : "message" in record
+            ? record.message
+            : undefined;
+    const message = typeof rawMessage === "string" ? rawMessage.toLowerCase() : "";
+    return connectivityMessages.has(message.trim().replace(/[.!]$/, ""));
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bayonai/offline",
-  "version": "0.8.0",
+  "version": "0.10.0",
   "description": "Reusable offline read-cache, pending-write, and silent recovery primitives.",
   "license": "MIT",
   "author": "Bayon AI",
@@ -21,6 +21,9 @@
     "idb",
     "typescript"
   ],
+  "engines": {
+    "node": ">=22"
+  },
   "sideEffects": false,
   "type": "module",
   "main": "./dist-cjs/index.js",
@@ -28,9 +31,14 @@
   "types": "./dist/index.d.ts",
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.js",
-      "require": "./dist-cjs/index.js"
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist-cjs/index.d.ts",
+        "default": "./dist-cjs/index.js"
+      }
     }
   },
   "files": [
@@ -38,13 +46,14 @@
     "dist-cjs",
     "CHANGELOG.md",
     "LICENSE",
-    "README.md"
+    "README.md",
+    "RECOVERY.md"
   ],
   "publishConfig": {
     "access": "public"
   },
   "scripts": {
-    "build": "tsc -p tsconfig.json && node scripts/write-esm-extensions.mjs && tsc -p tsconfig.cjs.json && node scripts/write-cjs.mjs",
+    "build": "tsc -p tsconfig.json && node scripts/write-esm-extensions.mjs && tsc -p tsconfig.cjs.json && node scripts/write-cjs.mjs && node scripts/verify-dist.mjs",
     "lint": "tsc --noEmit -p tsconfig.json",
     "pack:smoke": "corepack pnpm run build && npm pack --dry-run --access public",
     "prepack": "corepack pnpm run build",
@@ -55,7 +64,7 @@
     "idb": "^8.0.3"
   },
   "devDependencies": {
-    "fake-indexeddb": "^6.2.5",
+    "fake-indexeddb": "^6.2.6",
     "typescript": "^6.0.3",
     "vitest": "^5.0.1"
   }