@sweidos/eidos 2.1.0 → 2.3.0

package/dist/testing.cjs

@@ -144,13 +144,14 @@ async function resetEidos() {
 * expect(getEidosState().queue).toHaveLength(1)
 */
 function getEidosState() {
-	const { isOnline, swStatus, swError, resources, queue } = _sweidos_eidos.useEidosStore.getState();
+	const { isOnline, swStatus, swError, resources, queue, reliability } = _sweidos_eidos.useEidosStore.getState();
 	return {
 		isOnline,
 		swStatus,
 		swError,
 		resources,
-		queue
+		queue,
+		reliability
 	};
 }
 //#endregion

package/dist/testing.d.ts

@@ -1,5 +1,4 @@
-import { EidosState, ReplayResult } from '@sweidos/eidos';
-
+import { EidosState, ReplayResult } from './index.ts';
 export interface MockOfflineOptions {
     /**
      * Also stub `globalThis.fetch` to throw a TypeError (simulates a hard

package/dist/testing.js

@@ -143,13 +143,14 @@ async function resetEidos() {
 * expect(getEidosState().queue).toHaveLength(1)
 */
 function getEidosState() {
-	const { isOnline, swStatus, swError, resources, queue } = useEidosStore.getState();
+	const { isOnline, swStatus, swError, resources, queue, reliability } = useEidosStore.getState();
 	return {
 		isOnline,
 		swStatus,
 		swError,
 		resources,
-		queue
+		queue,
+		reliability
 	};
 }
 //#endregion

package/dist/types.d.ts

@@ -0,0 +1,305 @@
+export type CacheStrategy = 'cache-first' | 'stale-while-revalidate' | 'network-first';
+export interface ResourceConfig {
+    /** Make this resource available when the device is offline. */
+    offline: boolean;
+    /** Override the auto-selected caching strategy. */
+    strategy?: CacheStrategy;
+    /** Custom cache bucket name. Defaults to 'eidos-resources-v1'. */
+    cacheName?: string;
+    /**
+     * Cache schema version. Bump when the response shape changes so old
+     * cached entries (a different shape) aren't served from a stale bucket.
+     * Appended to `cacheName` as a suffix (e.g. `eidos-resources-v1-v2`).
+     * Old-versioned buckets are left in Cache Storage — clear them via
+     * `caches.delete()` if needed.
+     */
+    version?: string | number;
+    /** Max age of cached response in milliseconds. Expired entries trigger a network fetch. */
+    maxAge?: number;
+    /**
+     * Maximum number of entries to keep in this resource's cache bucket.
+     * When the limit is exceeded after a `cache.put()`, the oldest entry is evicted (FIFO).
+     * Useful for list/image endpoints that grow unbounded.
+     */
+    maxEntries?: number;
+}
+export interface GeneratedStrategy {
+    name: string;
+    swStrategy: CacheStrategy;
+    cacheName: string;
+    /** One-line rationale for why this strategy was chosen. */
+    reasoning: string;
+    /** Human-readable description of each behavioral step. */
+    behavior: string[];
+    /** Pseudocode showing the equivalent Workbox config. */
+    equivalentCode: string;
+}
+export interface ResourceEntry {
+    url: string;
+    config: ResourceConfig;
+    strategy: GeneratedStrategy;
+    status: 'idle' | 'fetching' | 'fresh' | 'stale' | 'error' | 'offline';
+    cachedAt?: number;
+    fetchedAt?: number;
+    cacheHits: number;
+    cacheMisses: number;
+    lastEvent?: 'cache-hit' | 'cache-updated' | 'network-error' | 'cache-cleared';
+}
+export interface ResourceHandle<T = unknown> {
+    readonly url: string;
+    readonly config: ResourceConfig;
+    readonly strategy: GeneratedStrategy;
+    fetch: () => Promise<Response>;
+    json: () => Promise<T>;
+    /** Returns a TanStack Query-compatible options object. */
+    query: () => {
+        queryKey: [string, string];
+        queryFn: () => Promise<T>;
+    };
+    prefetch: () => Promise<void>;
+    invalidate: () => Promise<void>;
+    /** Remove from registry and SW. Required before re-registering the same URL with different config. */
+    unregister: () => void;
+}
+/**
+ * Handle for a URL pattern (`/api/products/*`, `/api/users/:id`, `**`).
+ * The SW intercepts all matching requests automatically — there is no single
+ * URL to fetch/cache directly, so only cache-management methods are exposed.
+ * Returned by `resourcePattern()`.
+ */
+export interface PatternResourceHandle {
+    readonly url: string;
+    readonly config: ResourceConfig;
+    readonly strategy: GeneratedStrategy;
+    /** Clears all cache entries matching this pattern. */
+    invalidate: () => Promise<void>;
+    /** Remove from registry and SW. Required before re-registering the same pattern with different config. */
+    unregister: () => void;
+}
+/** A handle returned by either `resource()` or `resourcePattern()`. */
+export type AnyResourceHandle = ResourceHandle<any> | PatternResourceHandle;
+/** Summary returned by warmCache(). */
+export interface WarmCacheResult {
+    /** Resources that were prefetched successfully. */
+    warmed: number;
+    /** Resources whose prefetch threw (network error, offline, etc.). */
+    failed: number;
+    /** The raw errors, in input order, for failed handles. */
+    errors: unknown[];
+}
+interface ActionConfigBase<TArgs extends any[] = any[]> {
+    /** Max retry attempts before marking as failed. Default: 3. */
+    maxRetries?: number;
+    /** Human-readable name for the action (used in devtools). */
+    name?: string;
+    /**
+     * Prefixes the registered action id (`namespace::name`). Use to avoid
+     * collisions when two actions share a name (e.g. across micro-frontends,
+     * or two `createOrder` actions in different modules) — without a
+     * namespace, the second registration silently overwrites the first.
+     */
+    namespace?: string;
+    /**
+     * Replay order when multiple queued actions are pending.
+     * `'high'` items replay before `'normal'`, which replay before `'low'`.
+     * Each tier completes fully before the next tier begins.
+     * Default: `'normal'`.
+     */
+    priority?: 'high' | 'normal' | 'low';
+    /**
+     * Called immediately before the async function executes, with the same args
+     * plus a trailing `ActionContext`. Use to apply an optimistic UI update (add
+     * item, mark as pending, etc.) and to capture `idempotencyKey` for later
+     * `handle.cancel(idempotencyKey)` calls. Called on every invocation —
+     * online, offline, and during queue replay.
+     */
+    onOptimistic?: (...args: [...TArgs, ActionContext]) => void;
+    /**
+     * Called when the action permanently fails and will not be retried.
+     * - `best-effort`: called on first throw.
+     * - `neverLose`: called when `maxRetries` is exhausted (status → `'failed'`).
+     * Use to revert the optimistic update.
+     */
+    onRollback?: (...args: [...TArgs, ActionContext]) => void;
+    /**
+     * Declarative conflict-resolution strategy used during queue replay when
+     * the server responds with a 4xx status (conflict, gone, unprocessable,
+     * etc.). If not provided, 4xx errors are treated identically to other
+     * errors (retried until `maxRetries` is exhausted, then `onRollback` is
+     * called). See `ConflictConfig`.
+     */
+    conflict?: ConflictConfig;
+    /**
+     * When `true`, each invocation gets an `AbortController` whose `signal` is
+     * passed via `ActionContext.signal`. Forward it to `fetch`/etc. so
+     * `handle.cancel(idempotencyKey)` can abort an in-flight call, or remove a
+     * not-yet-replayed queued item.
+     */
+    cancellable?: boolean;
+}
+export type ActionConfig<TArgs extends any[] = any[]> = (ActionConfigBase<TArgs> & {
+    /** Call directly, no persistence on failure. */
+    reliability: 'best-effort';
+}) | (ActionConfigBase<TArgs> & {
+    /** Persist to IndexedDB before executing; replay on reconnect. */
+    reliability: 'neverLose';
+    /**
+     * Required for `neverLose` — queued items must survive a page reload
+     * and be matched back to this action on replay. `fn.name` is not
+     * reliable (minifiers rename it, arrow functions may be anonymous).
+     */
+    name: string;
+});
+/**
+ * Passed to `ConflictConfig.resolve` (for `'merge'`/`'custom'` strategies)
+ * when a queued action's replay receives a 4xx response.
+ */
+export interface ConflictContext {
+    /** Whatever `fn` threw — typically a `Response` or an error with `.status`. */
+    error: unknown;
+    /** The original arguments the action was queued with. */
+    args: any[];
+    /** Number of replay attempts so far (0 on first replay). */
+    attempt: number;
+    idempotencyKey: string;
+}
+/**
+ * Outcome of `ConflictConfig.resolve`:
+ * - `'retry'`: keep the item queued, retry per normal backoff.
+ * - `'skip'`: silently remove the item (no `onRollback`).
+ * - `{ resolved: args }`: replace the queued args and retry immediately
+ *   on the next replay pass.
+ */
+export type ConflictResolution = 'retry' | 'skip' | {
+    resolved: any[];
+};
+export interface ConflictConfig {
+    /**
+     * - `'serverWins'`: drop the queued item, keeping the server's state.
+     * - `'clientWins'`: keep retrying — the client's write should eventually
+     *   be accepted (e.g. once the server-side conflict is cleared).
+     * - `'merge'` / `'custom'`: call `resolve` to decide.
+     */
+    strategy: 'serverWins' | 'clientWins' | 'merge' | 'custom';
+    /** Required for `'merge'` and `'custom'`. */
+    resolve?: (ctx: ConflictContext) => ConflictResolution;
+}
+/** Bump when ActionQueueItem's shape changes. Used to migrate items persisted by older versions. */
+export declare const CURRENT_QUEUE_SCHEMA_VERSION = 2;
+export interface ActionQueueItem {
+    /** Shape version this item was persisted with. Items from before v2 are migrated on load. */
+    schemaVersion: number;
+    id: string;
+    /** ID of the registered action (maps to the function in the registry). */
+    actionId: string;
+    actionName: string;
+    /**
+     * Stable per-invocation key, generated once and reused across every retry/replay
+     * of this item. Pass to your server as an idempotency key so retries that reach
+     * the server after a dropped response don't double-execute.
+     */
+    idempotencyKey: string;
+    args: unknown[];
+    queuedAt: number;
+    retryCount: number;
+    maxRetries: number;
+    status: 'pending' | 'replaying' | 'succeeded' | 'failed';
+    /** Replay priority. High items replay before normal, normal before low. Default: 'normal'. */
+    priority?: 'high' | 'normal' | 'low';
+    error?: string;
+    completedAt?: number;
+    /** Earliest timestamp at which this item should be retried (exponential backoff). */
+    nextRetryAt?: number;
+}
+export interface QueuedResult {
+    readonly queued: true;
+    readonly id: string;
+    readonly message: string;
+}
+/** Summary returned by replayQueue(). */
+export interface ReplayResult {
+    /** Items where the registered function was found and called. */
+    attempted: number;
+    /** Items that resolved successfully. */
+    succeeded: number;
+    /** Items that failed and have no retries remaining (status: 'failed'). */
+    failed: number;
+    /** Items that failed but will be retried later (nextRetryAt set). */
+    retrying: number;
+    /** Items whose actionId had no registered function — likely not yet imported. */
+    skipped: number;
+    /** Items that received a 4xx response and were dropped via `conflict: { strategy: 'serverWins' }` (or `resolve()` returning `'skip'`). */
+    conflicted: number;
+    /** Items removed via `handle.cancel(idempotencyKey)` before/during replay. */
+    cancelled: number;
+}
+/**
+ * Passed as an extra argument after the declared params to `neverLose` actions,
+ * on every invocation (initial call, offline queue, and replay). The same
+ * `idempotencyKey` is reused across all retries of one logical invocation —
+ * forward it to your server (e.g. as an `Idempotency-Key` header) so a retry
+ * that reaches the server after a dropped response doesn't double-execute.
+ */
+export interface ActionContext {
+    idempotencyKey: string;
+    /** 0 on the first attempt, incremented on each replay retry. */
+    attempt: number;
+    /** Set when `config.cancellable` is true. Forward to `fetch`/etc. for cancellation support. */
+    signal?: AbortSignal;
+}
+/**
+ * Every action function receives its declared args plus a trailing
+ * `ActionContext` — on every invocation (online, offline, and replay).
+ */
+export type ActionFn<TArgs extends unknown[], TReturn> = (...args: [...TArgs, ActionContext]) => Promise<TReturn>;
+export interface ActionHandle<TArgs extends any[], TReturn> {
+    (...args: TArgs): Promise<TReturn | QueuedResult>;
+    readonly id: string;
+    readonly config: ActionConfig;
+    /**
+     * Cancel an invocation by its `idempotencyKey` (from `ActionContext` /
+     * `onOptimistic`). Aborts the in-flight call if `cancellable: true` and
+     * still running, otherwise removes a not-yet-replayed queued item.
+     * Returns `true` if something was cancelled/removed.
+     */
+    cancel: (idempotencyKey: string) => Promise<boolean>;
+}
+export interface EidosState {
+    isOnline: boolean;
+    swStatus: 'idle' | 'registering' | 'active' | 'error' | 'unsupported';
+    swError?: string;
+    resources: Record<string, ResourceEntry>;
+    queue: ActionQueueItem[];
+    reliability: ReliabilityStats;
+}
+/**
+ * Cumulative, session-scoped counters for `neverLose` queue outcomes — opt-in
+ * telemetry surfaced via `eidosReliabilityStats` / `useEidosReliabilityStats()`
+ * and `EidosConfig.onReliabilityReport`. Reset on page reload (not persisted).
+ */
+export interface ReliabilityStats {
+    [key: string]: number;
+    /** Actions persisted to the queue (offline, or online call that threw). */
+    queued: number;
+    /** Queue items that executed successfully (first attempt or a retry). */
+    succeeded: number;
+    /** Queue items that exhausted `maxRetries` and moved to `'failed'`. */
+    failed: number;
+    /** Replay attempts that failed but will retry (haven't exhausted `maxRetries`). */
+    retried: number;
+    /** Queue items dropped by a `serverWins`/`merge`/`custom` conflict resolution. */
+    conflicted: number;
+    /** Queue items removed via `handle.cancel(idempotencyKey)` before replay completed. */
+    cancelled: number;
+}
+export declare function emptyReliabilityStats(): ReliabilityStats;
+export interface QueueStatusCounts {
+    [key: string]: number;
+    pending: number;
+    failed: number;
+    replaying: number;
+    total: number;
+}
+/** Single pass over the queue — avoids separate .filter() calls per status. */
+export declare function countQueueByStatus(queue: ActionQueueItem[]): QueueStatusCounts;
+export {};

package/dist/types.js

@@ -1,15 +1,26 @@
-function a(e) {
-  let n = 0, i = 0, s = 0;
-  for (const t of e) t.status === "pending" ? n++ : t.status === "failed" ? i++ : t.status === "replaying" && s++;
+function a() {
   return {
-    pending: n,
-    failed: i,
-    replaying: s,
-    total: e.length
+    queued: 0,
+    succeeded: 0,
+    failed: 0,
+    retried: 0,
+    conflicted: 0,
+    cancelled: 0
+  };
+}
+function s(t) {
+  let i = 0, n = 0, l = 0;
+  for (const e of t) e.status === "pending" ? i++ : e.status === "failed" ? n++ : e.status === "replaying" && l++;
+  return {
+    pending: i,
+    failed: n,
+    replaying: l,
+    total: t.length
   };
 }
 export {
-  a as countQueueByStatus
+  s as countQueueByStatus,
+  a as emptyReliabilityStats
 };
 
 //# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","names":[],"sources":["../src/types.ts"],"sourcesContent":["// ─────────────────────────────────────────────────────────────────────────────\n// Eidos Core Types\n// ─────────────────────────────────────────────────────────────────────────────\n\nexport type CacheStrategy = 'cache-first' | 'stale-while-revalidate' | 'network-first';\n\n// ── Resource ─────────────────────────────────────────────────────────────────\n\nexport interface ResourceConfig {\n  /** Make this resource available when the device is offline. */\n  offline: boolean;\n  /** Override the auto-selected caching strategy. */\n  strategy?: CacheStrategy;\n  /** Custom cache bucket name. Defaults to 'eidos-resources-v1'. */\n  cacheName?: string;\n  /**\n   * Cache schema version. Bump when the response shape changes so old\n   * cached entries (a different shape) aren't served from a stale bucket.\n   * Appended to `cacheName` as a suffix (e.g. `eidos-resources-v1-v2`).\n   * Old-versioned buckets are left in Cache Storage — clear them via\n   * `caches.delete()` if needed.\n   */\n  version?: string | number;\n  /** Max age of cached response in milliseconds. Expired entries trigger a network fetch. */\n  maxAge?: number;\n}\n\nexport interface GeneratedStrategy {\n  name: string;\n  swStrategy: CacheStrategy;\n  cacheName: string;\n  /** One-line rationale for why this strategy was chosen. */\n  reasoning: string;\n  /** Human-readable description of each behavioral step. */\n  behavior: string[];\n  /** Pseudocode showing the equivalent Workbox config. */\n  equivalentCode: string;\n}\n\nexport interface ResourceEntry {\n  url: string;\n  config: ResourceConfig;\n  strategy: GeneratedStrategy;\n  status: 'idle' | 'fetching' | 'fresh' | 'stale' | 'error' | 'offline';\n  cachedAt?: number;\n  fetchedAt?: number;\n  cacheHits: number;\n  cacheMisses: number;\n  lastEvent?: 'cache-hit' | 'cache-updated' | 'network-error' | 'cache-cleared';\n}\n\nexport interface ResourceHandle<T = unknown> {\n  readonly url: string;\n  readonly config: ResourceConfig;\n  readonly strategy: GeneratedStrategy;\n  fetch: () => Promise<Response>;\n  json: () => Promise<T>;\n  /** Returns a TanStack Query-compatible options object. */\n  query: () => { queryKey: [string, string]; queryFn: () => Promise<T> };\n  prefetch: () => Promise<void>;\n  invalidate: () => Promise<void>;\n  /** Remove from registry and SW. Required before re-registering the same URL with different config. */\n  unregister: () => void;\n}\n\n/**\n * Handle for a URL pattern (`/api/products/*`, `/api/users/:id`, `**`).\n * The SW intercepts all matching requests automatically — there is no single\n * URL to fetch/cache directly, so only cache-management methods are exposed.\n * Returned by `resourcePattern()`.\n */\nexport interface PatternResourceHandle {\n  readonly url: string;\n  readonly config: ResourceConfig;\n  readonly strategy: GeneratedStrategy;\n  /** Clears all cache entries matching this pattern. */\n  invalidate: () => Promise<void>;\n  /** Remove from registry and SW. Required before re-registering the same pattern with different config. */\n  unregister: () => void;\n}\n\n/** A handle returned by either `resource()` or `resourcePattern()`. */\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport type AnyResourceHandle = ResourceHandle<any> | PatternResourceHandle;\n\n/** Summary returned by warmCache(). */\nexport interface WarmCacheResult {\n  /** Resources that were prefetched successfully. */\n  warmed: number;\n  /** Resources whose prefetch threw (network error, offline, etc.). */\n  failed: number;\n  /** The raw errors, in input order, for failed handles. */\n  errors: unknown[];\n}\n\n// ── Action ───────────────────────────────────────────────────────────────────\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\ninterface ActionConfigBase<TArgs extends any[] = any[]> {\n  /** Max retry attempts before marking as failed. Default: 3. */\n  maxRetries?: number;\n  /** Human-readable name for the action (used in devtools). */\n  name?: string;\n  /**\n   * Prefixes the registered action id (`namespace::name`). Use to avoid\n   * collisions when two actions share a name (e.g. across micro-frontends,\n   * or two `createOrder` actions in different modules) — without a\n   * namespace, the second registration silently overwrites the first.\n   */\n  namespace?: string;\n  /**\n   * Replay order when multiple queued actions are pending.\n   * `'high'` items replay before `'normal'`, which replay before `'low'`.\n   * Each tier completes fully before the next tier begins.\n   * Default: `'normal'`.\n   */\n  priority?: 'high' | 'normal' | 'low';\n  /**\n   * Called immediately before the async function executes, with the same args\n   * plus a trailing `ActionContext`. Use to apply an optimistic UI update (add\n   * item, mark as pending, etc.) and to capture `idempotencyKey` for later\n   * `handle.cancel(idempotencyKey)` calls. Called on every invocation —\n   * online, offline, and during queue replay.\n   */\n  onOptimistic?: (...args: [...TArgs, ActionContext]) => void;\n  /**\n   * Called when the action permanently fails and will not be retried.\n   * - `best-effort`: called on first throw.\n   * - `neverLose`: called when `maxRetries` is exhausted (status → `'failed'`).\n   * Use to revert the optimistic update.\n   */\n  onRollback?: (...args: [...TArgs, ActionContext]) => void;\n  /**\n   * Declarative conflict-resolution strategy used during queue replay when\n   * the server responds with a 4xx status (conflict, gone, unprocessable,\n   * etc.). If not provided, 4xx errors are treated identically to other\n   * errors (retried until `maxRetries` is exhausted, then `onRollback` is\n   * called). See `ConflictConfig`.\n   */\n  conflict?: ConflictConfig;\n  /**\n   * When `true`, each invocation gets an `AbortController` whose `signal` is\n   * passed via `ActionContext.signal`. Forward it to `fetch`/etc. so\n   * `handle.cancel(idempotencyKey)` can abort an in-flight call, or remove a\n   * not-yet-replayed queued item.\n   */\n  cancellable?: boolean;\n}\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport type ActionConfig<TArgs extends any[] = any[]> =\n  | (ActionConfigBase<TArgs> & {\n      /** Call directly, no persistence on failure. */\n      reliability: 'best-effort';\n    })\n  | (ActionConfigBase<TArgs> & {\n      /** Persist to IndexedDB before executing; replay on reconnect. */\n      reliability: 'neverLose';\n      /**\n       * Required for `neverLose` — queued items must survive a page reload\n       * and be matched back to this action on replay. `fn.name` is not\n       * reliable (minifiers rename it, arrow functions may be anonymous).\n       */\n      name: string;\n    });\n\n/**\n * Passed to `ConflictConfig.resolve` (for `'merge'`/`'custom'` strategies)\n * when a queued action's replay receives a 4xx response.\n */\nexport interface ConflictContext {\n  /** Whatever `fn` threw — typically a `Response` or an error with `.status`. */\n  error: unknown;\n  /** The original arguments the action was queued with. */\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  args: any[];\n  /** Number of replay attempts so far (0 on first replay). */\n  attempt: number;\n  idempotencyKey: string;\n}\n\n/**\n * Outcome of `ConflictConfig.resolve`:\n * - `'retry'`: keep the item queued, retry per normal backoff.\n * - `'skip'`: silently remove the item (no `onRollback`).\n * - `{ resolved: args }`: replace the queued args and retry immediately\n *   on the next replay pass.\n */\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport type ConflictResolution = 'retry' | 'skip' | { resolved: any[] };\n\nexport interface ConflictConfig {\n  /**\n   * - `'serverWins'`: drop the queued item, keeping the server's state.\n   * - `'clientWins'`: keep retrying — the client's write should eventually\n   *   be accepted (e.g. once the server-side conflict is cleared).\n   * - `'merge'` / `'custom'`: call `resolve` to decide.\n   */\n  strategy: 'serverWins' | 'clientWins' | 'merge' | 'custom';\n  /** Required for `'merge'` and `'custom'`. */\n  resolve?: (ctx: ConflictContext) => ConflictResolution;\n}\n\n/** Bump when ActionQueueItem's shape changes. Used to migrate items persisted by older versions. */\nexport const CURRENT_QUEUE_SCHEMA_VERSION = 2;\n\nexport interface ActionQueueItem {\n  /** Shape version this item was persisted with. Items from before v2 are migrated on load. */\n  schemaVersion: number;\n  id: string;\n  /** ID of the registered action (maps to the function in the registry). */\n  actionId: string;\n  actionName: string;\n  /**\n   * Stable per-invocation key, generated once and reused across every retry/replay\n   * of this item. Pass to your server as an idempotency key so retries that reach\n   * the server after a dropped response don't double-execute.\n   */\n  idempotencyKey: string;\n  args: unknown[];\n  queuedAt: number;\n  retryCount: number;\n  maxRetries: number;\n  status: 'pending' | 'replaying' | 'succeeded' | 'failed';\n  /** Replay priority. High items replay before normal, normal before low. Default: 'normal'. */\n  priority?: 'high' | 'normal' | 'low';\n  error?: string;\n  completedAt?: number;\n  /** Earliest timestamp at which this item should be retried (exponential backoff). */\n  nextRetryAt?: number;\n}\n\nexport interface QueuedResult {\n  readonly queued: true;\n  readonly id: string;\n  readonly message: string;\n}\n\n/** Summary returned by replayQueue(). */\nexport interface ReplayResult {\n  /** Items where the registered function was found and called. */\n  attempted: number;\n  /** Items that resolved successfully. */\n  succeeded: number;\n  /** Items that failed and have no retries remaining (status: 'failed'). */\n  failed: number;\n  /** Items that failed but will be retried later (nextRetryAt set). */\n  retrying: number;\n  /** Items whose actionId had no registered function — likely not yet imported. */\n  skipped: number;\n  /** Items that received a 4xx response and were dropped via `conflict: { strategy: 'serverWins' }` (or `resolve()` returning `'skip'`). */\n  conflicted: number;\n  /** Items removed via `handle.cancel(idempotencyKey)` before/during replay. */\n  cancelled: number;\n}\n\n/**\n * Passed as an extra argument after the declared params to `neverLose` actions,\n * on every invocation (initial call, offline queue, and replay). The same\n * `idempotencyKey` is reused across all retries of one logical invocation —\n * forward it to your server (e.g. as an `Idempotency-Key` header) so a retry\n * that reaches the server after a dropped response doesn't double-execute.\n */\nexport interface ActionContext {\n  idempotencyKey: string;\n  /** 0 on the first attempt, incremented on each replay retry. */\n  attempt: number;\n  /** Set when `config.cancellable` is true. Forward to `fetch`/etc. for cancellation support. */\n  signal?: AbortSignal;\n}\n\n/**\n * Every action function receives its declared args plus a trailing\n * `ActionContext` — on every invocation (online, offline, and replay).\n */\nexport type ActionFn<TArgs extends unknown[], TReturn> = (\n  ...args: [...TArgs, ActionContext]\n) => Promise<TReturn>;\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport interface ActionHandle<TArgs extends any[], TReturn> {\n  (...args: TArgs): Promise<TReturn | QueuedResult>;\n  readonly id: string;\n  readonly config: ActionConfig;\n  /**\n   * Cancel an invocation by its `idempotencyKey` (from `ActionContext` /\n   * `onOptimistic`). Aborts the in-flight call if `cancellable: true` and\n   * still running, otherwise removes a not-yet-replayed queued item.\n   * Returns `true` if something was cancelled/removed.\n   */\n  cancel: (idempotencyKey: string) => Promise<boolean>;\n}\n\n// ── Global State ─────────────────────────────────────────────────────────────\n\nexport interface EidosState {\n  isOnline: boolean;\n  swStatus: 'idle' | 'registering' | 'active' | 'error' | 'unsupported';\n  swError?: string;\n  resources: Record<string, ResourceEntry>;\n  queue: ActionQueueItem[];\n}\n\nexport interface QueueStatusCounts {\n  [key: string]: number;\n  pending: number;\n  failed: number;\n  replaying: number;\n  total: number;\n}\n\n/** Single pass over the queue — avoids separate .filter() calls per status. */\nexport function countQueueByStatus(queue: ActionQueueItem[]): QueueStatusCounts {\n  let pending = 0,\n    failed = 0,\n    replaying = 0;\n  for (const q of queue) {\n    if (q.status === 'pending') pending++;\n    else if (q.status === 'failed') failed++;\n    else if (q.status === 'replaying') replaying++;\n  }\n  return { pending, failed, replaying, total: queue.length };\n}\n"],"mappings":"AAwTA,SAAgB,EAAmB,GAA6C;AAC9E,MAAI,IAAU,GACZ,IAAS,GACT,IAAY;AACd,aAAW,KAAK,EACd,CAAI,EAAE,WAAW,YAAW,MACnB,EAAE,WAAW,WAAU,MACvB,EAAE,WAAW,eAAa;AAErC,SAAO;AAAA,IAAE,SAAA;AAAA,IAAS,QAAA;AAAA,IAAQ,WAAA;AAAA,IAAW,OAAO,EAAM;AAAA,EAAO;AAC3D"}
+{"version":3,"file":"types.js","names":[],"sources":["../src/types.ts"],"sourcesContent":["// ─────────────────────────────────────────────────────────────────────────────\n// Eidos Core Types\n// ─────────────────────────────────────────────────────────────────────────────\n\nexport type CacheStrategy = 'cache-first' | 'stale-while-revalidate' | 'network-first';\n\n// ── Resource ─────────────────────────────────────────────────────────────────\n\nexport interface ResourceConfig {\n  /** Make this resource available when the device is offline. */\n  offline: boolean;\n  /** Override the auto-selected caching strategy. */\n  strategy?: CacheStrategy;\n  /** Custom cache bucket name. Defaults to 'eidos-resources-v1'. */\n  cacheName?: string;\n  /**\n   * Cache schema version. Bump when the response shape changes so old\n   * cached entries (a different shape) aren't served from a stale bucket.\n   * Appended to `cacheName` as a suffix (e.g. `eidos-resources-v1-v2`).\n   * Old-versioned buckets are left in Cache Storage — clear them via\n   * `caches.delete()` if needed.\n   */\n  version?: string | number;\n  /** Max age of cached response in milliseconds. Expired entries trigger a network fetch. */\n  maxAge?: number;\n  /**\n   * Maximum number of entries to keep in this resource's cache bucket.\n   * When the limit is exceeded after a `cache.put()`, the oldest entry is evicted (FIFO).\n   * Useful for list/image endpoints that grow unbounded.\n   */\n  maxEntries?: number;\n}\n\nexport interface GeneratedStrategy {\n  name: string;\n  swStrategy: CacheStrategy;\n  cacheName: string;\n  /** One-line rationale for why this strategy was chosen. */\n  reasoning: string;\n  /** Human-readable description of each behavioral step. */\n  behavior: string[];\n  /** Pseudocode showing the equivalent Workbox config. */\n  equivalentCode: string;\n}\n\nexport interface ResourceEntry {\n  url: string;\n  config: ResourceConfig;\n  strategy: GeneratedStrategy;\n  status: 'idle' | 'fetching' | 'fresh' | 'stale' | 'error' | 'offline';\n  cachedAt?: number;\n  fetchedAt?: number;\n  cacheHits: number;\n  cacheMisses: number;\n  lastEvent?: 'cache-hit' | 'cache-updated' | 'network-error' | 'cache-cleared';\n}\n\nexport interface ResourceHandle<T = unknown> {\n  readonly url: string;\n  readonly config: ResourceConfig;\n  readonly strategy: GeneratedStrategy;\n  fetch: () => Promise<Response>;\n  json: () => Promise<T>;\n  /** Returns a TanStack Query-compatible options object. */\n  query: () => { queryKey: [string, string]; queryFn: () => Promise<T> };\n  prefetch: () => Promise<void>;\n  invalidate: () => Promise<void>;\n  /** Remove from registry and SW. Required before re-registering the same URL with different config. */\n  unregister: () => void;\n}\n\n/**\n * Handle for a URL pattern (`/api/products/*`, `/api/users/:id`, `**`).\n * The SW intercepts all matching requests automatically — there is no single\n * URL to fetch/cache directly, so only cache-management methods are exposed.\n * Returned by `resourcePattern()`.\n */\nexport interface PatternResourceHandle {\n  readonly url: string;\n  readonly config: ResourceConfig;\n  readonly strategy: GeneratedStrategy;\n  /** Clears all cache entries matching this pattern. */\n  invalidate: () => Promise<void>;\n  /** Remove from registry and SW. Required before re-registering the same pattern with different config. */\n  unregister: () => void;\n}\n\n/** A handle returned by either `resource()` or `resourcePattern()`. */\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport type AnyResourceHandle = ResourceHandle<any> | PatternResourceHandle;\n\n/** Summary returned by warmCache(). */\nexport interface WarmCacheResult {\n  /** Resources that were prefetched successfully. */\n  warmed: number;\n  /** Resources whose prefetch threw (network error, offline, etc.). */\n  failed: number;\n  /** The raw errors, in input order, for failed handles. */\n  errors: unknown[];\n}\n\n// ── Action ───────────────────────────────────────────────────────────────────\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\ninterface ActionConfigBase<TArgs extends any[] = any[]> {\n  /** Max retry attempts before marking as failed. Default: 3. */\n  maxRetries?: number;\n  /** Human-readable name for the action (used in devtools). */\n  name?: string;\n  /**\n   * Prefixes the registered action id (`namespace::name`). Use to avoid\n   * collisions when two actions share a name (e.g. across micro-frontends,\n   * or two `createOrder` actions in different modules) — without a\n   * namespace, the second registration silently overwrites the first.\n   */\n  namespace?: string;\n  /**\n   * Replay order when multiple queued actions are pending.\n   * `'high'` items replay before `'normal'`, which replay before `'low'`.\n   * Each tier completes fully before the next tier begins.\n   * Default: `'normal'`.\n   */\n  priority?: 'high' | 'normal' | 'low';\n  /**\n   * Called immediately before the async function executes, with the same args\n   * plus a trailing `ActionContext`. Use to apply an optimistic UI update (add\n   * item, mark as pending, etc.) and to capture `idempotencyKey` for later\n   * `handle.cancel(idempotencyKey)` calls. Called on every invocation —\n   * online, offline, and during queue replay.\n   */\n  onOptimistic?: (...args: [...TArgs, ActionContext]) => void;\n  /**\n   * Called when the action permanently fails and will not be retried.\n   * - `best-effort`: called on first throw.\n   * - `neverLose`: called when `maxRetries` is exhausted (status → `'failed'`).\n   * Use to revert the optimistic update.\n   */\n  onRollback?: (...args: [...TArgs, ActionContext]) => void;\n  /**\n   * Declarative conflict-resolution strategy used during queue replay when\n   * the server responds with a 4xx status (conflict, gone, unprocessable,\n   * etc.). If not provided, 4xx errors are treated identically to other\n   * errors (retried until `maxRetries` is exhausted, then `onRollback` is\n   * called). See `ConflictConfig`.\n   */\n  conflict?: ConflictConfig;\n  /**\n   * When `true`, each invocation gets an `AbortController` whose `signal` is\n   * passed via `ActionContext.signal`. Forward it to `fetch`/etc. so\n   * `handle.cancel(idempotencyKey)` can abort an in-flight call, or remove a\n   * not-yet-replayed queued item.\n   */\n  cancellable?: boolean;\n}\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport type ActionConfig<TArgs extends any[] = any[]> =\n  | (ActionConfigBase<TArgs> & {\n      /** Call directly, no persistence on failure. */\n      reliability: 'best-effort';\n    })\n  | (ActionConfigBase<TArgs> & {\n      /** Persist to IndexedDB before executing; replay on reconnect. */\n      reliability: 'neverLose';\n      /**\n       * Required for `neverLose` — queued items must survive a page reload\n       * and be matched back to this action on replay. `fn.name` is not\n       * reliable (minifiers rename it, arrow functions may be anonymous).\n       */\n      name: string;\n    });\n\n/**\n * Passed to `ConflictConfig.resolve` (for `'merge'`/`'custom'` strategies)\n * when a queued action's replay receives a 4xx response.\n */\nexport interface ConflictContext {\n  /** Whatever `fn` threw — typically a `Response` or an error with `.status`. */\n  error: unknown;\n  /** The original arguments the action was queued with. */\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  args: any[];\n  /** Number of replay attempts so far (0 on first replay). */\n  attempt: number;\n  idempotencyKey: string;\n}\n\n/**\n * Outcome of `ConflictConfig.resolve`:\n * - `'retry'`: keep the item queued, retry per normal backoff.\n * - `'skip'`: silently remove the item (no `onRollback`).\n * - `{ resolved: args }`: replace the queued args and retry immediately\n *   on the next replay pass.\n */\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport type ConflictResolution = 'retry' | 'skip' | { resolved: any[] };\n\nexport interface ConflictConfig {\n  /**\n   * - `'serverWins'`: drop the queued item, keeping the server's state.\n   * - `'clientWins'`: keep retrying — the client's write should eventually\n   *   be accepted (e.g. once the server-side conflict is cleared).\n   * - `'merge'` / `'custom'`: call `resolve` to decide.\n   */\n  strategy: 'serverWins' | 'clientWins' | 'merge' | 'custom';\n  /** Required for `'merge'` and `'custom'`. */\n  resolve?: (ctx: ConflictContext) => ConflictResolution;\n}\n\n/** Bump when ActionQueueItem's shape changes. Used to migrate items persisted by older versions. */\nexport const CURRENT_QUEUE_SCHEMA_VERSION = 2;\n\nexport interface ActionQueueItem {\n  /** Shape version this item was persisted with. Items from before v2 are migrated on load. */\n  schemaVersion: number;\n  id: string;\n  /** ID of the registered action (maps to the function in the registry). */\n  actionId: string;\n  actionName: string;\n  /**\n   * Stable per-invocation key, generated once and reused across every retry/replay\n   * of this item. Pass to your server as an idempotency key so retries that reach\n   * the server after a dropped response don't double-execute.\n   */\n  idempotencyKey: string;\n  args: unknown[];\n  queuedAt: number;\n  retryCount: number;\n  maxRetries: number;\n  status: 'pending' | 'replaying' | 'succeeded' | 'failed';\n  /** Replay priority. High items replay before normal, normal before low. Default: 'normal'. */\n  priority?: 'high' | 'normal' | 'low';\n  error?: string;\n  completedAt?: number;\n  /** Earliest timestamp at which this item should be retried (exponential backoff). */\n  nextRetryAt?: number;\n}\n\nexport interface QueuedResult {\n  readonly queued: true;\n  readonly id: string;\n  readonly message: string;\n}\n\n/** Summary returned by replayQueue(). */\nexport interface ReplayResult {\n  /** Items where the registered function was found and called. */\n  attempted: number;\n  /** Items that resolved successfully. */\n  succeeded: number;\n  /** Items that failed and have no retries remaining (status: 'failed'). */\n  failed: number;\n  /** Items that failed but will be retried later (nextRetryAt set). */\n  retrying: number;\n  /** Items whose actionId had no registered function — likely not yet imported. */\n  skipped: number;\n  /** Items that received a 4xx response and were dropped via `conflict: { strategy: 'serverWins' }` (or `resolve()` returning `'skip'`). */\n  conflicted: number;\n  /** Items removed via `handle.cancel(idempotencyKey)` before/during replay. */\n  cancelled: number;\n}\n\n/**\n * Passed as an extra argument after the declared params to `neverLose` actions,\n * on every invocation (initial call, offline queue, and replay). The same\n * `idempotencyKey` is reused across all retries of one logical invocation —\n * forward it to your server (e.g. as an `Idempotency-Key` header) so a retry\n * that reaches the server after a dropped response doesn't double-execute.\n */\nexport interface ActionContext {\n  idempotencyKey: string;\n  /** 0 on the first attempt, incremented on each replay retry. */\n  attempt: number;\n  /** Set when `config.cancellable` is true. Forward to `fetch`/etc. for cancellation support. */\n  signal?: AbortSignal;\n}\n\n/**\n * Every action function receives its declared args plus a trailing\n * `ActionContext` — on every invocation (online, offline, and replay).\n */\nexport type ActionFn<TArgs extends unknown[], TReturn> = (\n  ...args: [...TArgs, ActionContext]\n) => Promise<TReturn>;\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport interface ActionHandle<TArgs extends any[], TReturn> {\n  (...args: TArgs): Promise<TReturn | QueuedResult>;\n  readonly id: string;\n  readonly config: ActionConfig;\n  /**\n   * Cancel an invocation by its `idempotencyKey` (from `ActionContext` /\n   * `onOptimistic`). Aborts the in-flight call if `cancellable: true` and\n   * still running, otherwise removes a not-yet-replayed queued item.\n   * Returns `true` if something was cancelled/removed.\n   */\n  cancel: (idempotencyKey: string) => Promise<boolean>;\n}\n\n// ── Global State ─────────────────────────────────────────────────────────────\n\nexport interface EidosState {\n  isOnline: boolean;\n  swStatus: 'idle' | 'registering' | 'active' | 'error' | 'unsupported';\n  swError?: string;\n  resources: Record<string, ResourceEntry>;\n  queue: ActionQueueItem[];\n  reliability: ReliabilityStats;\n}\n\n/**\n * Cumulative, session-scoped counters for `neverLose` queue outcomes — opt-in\n * telemetry surfaced via `eidosReliabilityStats` / `useEidosReliabilityStats()`\n * and `EidosConfig.onReliabilityReport`. Reset on page reload (not persisted).\n */\nexport interface ReliabilityStats {\n  [key: string]: number;\n  /** Actions persisted to the queue (offline, or online call that threw). */\n  queued: number;\n  /** Queue items that executed successfully (first attempt or a retry). */\n  succeeded: number;\n  /** Queue items that exhausted `maxRetries` and moved to `'failed'`. */\n  failed: number;\n  /** Replay attempts that failed but will retry (haven't exhausted `maxRetries`). */\n  retried: number;\n  /** Queue items dropped by a `serverWins`/`merge`/`custom` conflict resolution. */\n  conflicted: number;\n  /** Queue items removed via `handle.cancel(idempotencyKey)` before replay completed. */\n  cancelled: number;\n}\n\nexport function emptyReliabilityStats(): ReliabilityStats {\n  return { queued: 0, succeeded: 0, failed: 0, retried: 0, conflicted: 0, cancelled: 0 };\n}\n\nexport interface QueueStatusCounts {\n  [key: string]: number;\n  pending: number;\n  failed: number;\n  replaying: number;\n  total: number;\n}\n\n/** Single pass over the queue — avoids separate .filter() calls per status. */\nexport function countQueueByStatus(queue: ActionQueueItem[]): QueueStatusCounts {\n  let pending = 0,\n    failed = 0,\n    replaying = 0;\n  for (const q of queue) {\n    if (q.status === 'pending') pending++;\n    else if (q.status === 'failed') failed++;\n    else if (q.status === 'replaying') replaying++;\n  }\n  return { pending, failed, replaying, total: queue.length };\n}\n"],"mappings":"AA2UA,SAAgB,IAA0C;AACxD,SAAO;AAAA,IAAE,QAAQ;AAAA,IAAG,WAAW;AAAA,IAAG,QAAQ;AAAA,IAAG,SAAS;AAAA,IAAG,YAAY;AAAA,IAAG,WAAW;AAAA,EAAE;AACvF;AAWA,SAAgB,EAAmB,GAA6C;AAC9E,MAAI,IAAU,GACZ,IAAS,GACT,IAAY;AACd,aAAW,KAAK,EACd,CAAI,EAAE,WAAW,YAAW,MACnB,EAAE,WAAW,WAAU,MACvB,EAAE,WAAW,eAAa;AAErC,SAAO;AAAA,IAAE,SAAA;AAAA,IAAS,QAAA;AAAA,IAAQ,WAAA;AAAA,IAAW,OAAO,EAAM;AAAA,EAAO;AAC3D"}

package/dist/version.d.ts

@@ -0,0 +1 @@
+export declare const VERSION = "2.3.0";

package/dist/version.js

@@ -1,4 +1,4 @@
-var r = "2.1.0";
+var r = "2.3.0";
 export {
   r as VERSION
 };

package/dist/version.js.map

@@ -1 +1 @@
-{"version":3,"file":"version.js","names":[],"sources":["../src/version.ts"],"sourcesContent":["export const VERSION = '2.1.0';\n"],"mappings":"AAAA,IAAa,IAAU"}
+{"version":3,"file":"version.js","names":[],"sources":["../src/version.ts"],"sourcesContent":["export const VERSION = '2.3.0';\n"],"mappings":"AAAA,IAAa,IAAU"}

package/dist/vite.d.ts

@@ -1,5 +1,4 @@
 import { Plugin } from 'vite';
-
 export interface EidosPluginOptions {
     /**
      * Destination path for the service worker, relative to the project root.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sweidos/eidos",
-  "version": "2.1.0",
+  "version": "2.3.0",
   "description": "Describe intent. The runtime figures out how. An abstraction layer for offline-first web apps.",
   "author": "Aditya Raj",
   "license": "MIT",
@@ -25,7 +25,7 @@
   ],
   "homepage": "https://sweidos.vercel.app/overview",
   "bugs": {
-    "url": "https://github.com/iamadi11/eidos/issues"
+    "url": "https://github.com/sweidos/eidos/issues"
   },
   "funding": {
     "type": "github",
@@ -36,7 +36,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/iamadi11/eidos.git",
+    "url": "https://github.com/sweidos/eidos.git",
     "directory": "packages/core"
   },
   "main": "./dist/eidos.cjs",
@@ -138,14 +138,14 @@
     "@types/react": "^19.2.17",
     "@types/react-dom": "^19.2.3",
     "@vitejs/plugin-react": "^6.0.2",
-    "@vitest/coverage-v8": "^4.1.8",
+    "@vitest/coverage-v8": "^4.1.9",
     "fake-indexeddb": "^6.2.5",
     "jsdom": "^29.1.1",
     "size-limit": "^12.1.0",
     "typescript": "^6.0.3",
     "vite": "^8.0.16",
-    "vite-plugin-dts": "^3.9.1",
-    "vitest": "^4.1.8"
+    "vite-plugin-dts": "^5.0.2",
+    "vitest": "^4.1.9"
   },
   "scripts": {
     "build": "vite build && vite build --config vite.cjs.config.ts && vite build --config vite.plugin.config.ts && vite build --config vite.query.config.ts && vite build --config vite.push.config.ts && vite build --config vite.testing.config.ts && vite build --config vite.nextjs.config.ts && vite build --config vite.sveltekit.config.ts && vite build --config vite.devtools.config.ts && vite build --config vite.react-native.config.ts && vite build --config vite.cli.config.ts && node scripts/copy-sw.mjs",
@@ -153,7 +153,9 @@
     "type-check": "tsc --noEmit",
     "test": "vitest run",
     "test:watch": "vitest",
+    "bench": "vitest bench run",
     "test:coverage": "vitest run --coverage",
-    "size": "size-limit"
+    "size": "size-limit",
+    "size:check-docs": "node scripts/check-bundle-size-doc.mjs"
   }
 }