@sweidos/eidos 1.0.20 → 1.0.23
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +81 -4
- package/dist/action.js +103 -0
- package/dist/action.js.map +1 -0
- package/dist/eidos.cjs.js +2 -2
- package/dist/eidos.cjs.js.map +1 -1
- package/dist/idb.js +87 -0
- package/dist/idb.js.map +1 -0
- package/dist/index.d.ts +3 -1
- package/dist/index.js +37 -0
- package/dist/index.js.map +1 -0
- package/dist/react/Provider.js +12 -0
- package/dist/react/Provider.js.map +1 -0
- package/dist/react/hooks.js +42 -0
- package/dist/react/hooks.js.map +1 -0
- package/dist/resource.js +200 -0
- package/dist/resource.js.map +1 -0
- package/dist/runtime.js +38 -0
- package/dist/runtime.js.map +1 -0
- package/dist/store.js +55 -0
- package/dist/store.js.map +1 -0
- package/dist/stores.js +36 -0
- package/dist/stores.js.map +1 -0
- package/dist/sw-bridge.js +105 -0
- package/dist/sw-bridge.js.map +1 -0
- package/dist/testing.cjs.js +86 -0
- package/dist/testing.d.ts +98 -0
- package/dist/testing.js +86 -0
- package/dist/version.js +5 -0
- package/dist/version.js.map +1 -0
- package/package.json +9 -4
- package/dist/eidos.es.js +0 -621
- package/dist/eidos.es.js.map +0 -1
package/README.md
CHANGED
|
@@ -419,13 +419,15 @@ Performance is a first-class concern in Eidos. Every design decision optimises f
|
|
|
419
419
|
| **Network timeout** | 3 s | `NetworkFirst` strategy aborts fetch after 3 s and falls back to cache — no hanging requests |
|
|
420
420
|
| **Pre-activation buffer** | Zero drops | Messages sent before the SW is active are buffered and flushed on activation |
|
|
421
421
|
| **Concurrency safety** | Lock-guarded | `_replaying` flag prevents duplicate replay passes from concurrent online events |
|
|
422
|
+
| **Request deduplication** | 1 request / N callers | Concurrent `handle.fetch()` calls for the same URL share one in-flight network request; each caller gets a cloned `Response` |
|
|
422
423
|
|
|
423
424
|
### Bundle comparison
|
|
424
425
|
|
|
425
426
|
| Version | Raw | Gzip | Change |
|
|
426
427
|
|---------|-----|------|--------|
|
|
427
428
|
| 1.0.5 (with zustand) | 35.0 kB | 7.9 kB | — |
|
|
428
|
-
|
|
|
429
|
+
| 1.0.6 (zero deps) | 18.6 kB | 5.0 kB | −47% |
|
|
430
|
+
| **1.0.21** (minified + dedup) | **19.0 kB** | **5.8 kB** | +0.5% raw vs 1.0.6 (dedup code), smaller than zustand baseline |
|
|
429
431
|
|
|
430
432
|
---
|
|
431
433
|
|
|
@@ -600,6 +602,81 @@ Registers a `QueryClient` with Eidos. After calling this:
|
|
|
600
602
|
|
|
601
603
|
---
|
|
602
604
|
|
|
605
|
+
## Testing Utilities
|
|
606
|
+
|
|
607
|
+
`@sweidos/eidos/testing` provides first-class helpers for Vitest, Jest, and Playwright. Import only in test files.
|
|
608
|
+
|
|
609
|
+
```ts
|
|
610
|
+
import {
|
|
611
|
+
mockOffline, mockOnline,
|
|
612
|
+
drainQueue, waitForQueueDrain,
|
|
613
|
+
getCachedEntry, clearEidosCache,
|
|
614
|
+
resetEidos, getEidosState,
|
|
615
|
+
} from '@sweidos/eidos/testing'
|
|
616
|
+
```
|
|
617
|
+
|
|
618
|
+
### `resetEidos()` — `beforeEach` cleanup
|
|
619
|
+
|
|
620
|
+
```ts
|
|
621
|
+
beforeEach(async () => {
|
|
622
|
+
await resetEidos()
|
|
623
|
+
// ✓ queue cleared, resources cleared, online restored, _initialized reset
|
|
624
|
+
})
|
|
625
|
+
```
|
|
626
|
+
|
|
627
|
+
### Testing offline queuing
|
|
628
|
+
|
|
629
|
+
```ts
|
|
630
|
+
it('queues action while offline', async () => {
|
|
631
|
+
mockOffline()
|
|
632
|
+
await savePost({ title: 'Draft' })
|
|
633
|
+
|
|
634
|
+
expect(getEidosState().queue).toHaveLength(1)
|
|
635
|
+
expect(getEidosState().isOnline).toBe(false)
|
|
636
|
+
})
|
|
637
|
+
```
|
|
638
|
+
|
|
639
|
+
### Testing queue replay
|
|
640
|
+
|
|
641
|
+
```ts
|
|
642
|
+
it('replays queue on reconnect', async () => {
|
|
643
|
+
mockOffline()
|
|
644
|
+
await savePost({ title: 'Draft' })
|
|
645
|
+
|
|
646
|
+
const result = await drainQueue() // forces online + replays
|
|
647
|
+
expect(result.succeeded).toBe(1)
|
|
648
|
+
})
|
|
649
|
+
```
|
|
650
|
+
|
|
651
|
+
### Testing cache state
|
|
652
|
+
|
|
653
|
+
```ts
|
|
654
|
+
it('caches the resource after first fetch', async () => {
|
|
655
|
+
const products = resource('/api/products', { offline: true })
|
|
656
|
+
await products.fetch()
|
|
657
|
+
|
|
658
|
+
const cached = await getCachedEntry('/api/products')
|
|
659
|
+
expect(cached).toBeDefined()
|
|
660
|
+
const body = await cached!.json()
|
|
661
|
+
expect(body).toEqual([...])
|
|
662
|
+
})
|
|
663
|
+
```
|
|
664
|
+
|
|
665
|
+
### API summary
|
|
666
|
+
|
|
667
|
+
| Helper | Description |
|
|
668
|
+
|--------|-------------|
|
|
669
|
+
| `mockOffline(opts?)` | Set `isOnline = false`. Pass `{ stubFetch: true }` to also make `fetch()` throw. |
|
|
670
|
+
| `mockOnline()` | Restore `isOnline = true`. Removes fetch stub if present. |
|
|
671
|
+
| `drainQueue()` | Force-replay queue now. Returns `ReplayResult`. |
|
|
672
|
+
| `waitForQueueDrain(opts?)` | Wait until no pending/replaying items. Timeout default 5s. |
|
|
673
|
+
| `getCachedEntry(url, name?)` | Read a `Response` from Cache Storage. Returns `undefined` if missing. |
|
|
674
|
+
| `clearEidosCache(name?)` | Delete an entire cache namespace (default: `eidos-resources-v1`). |
|
|
675
|
+
| `resetEidos()` | Full teardown: queue, resources, SW status, online state, runtime flag. |
|
|
676
|
+
| `getEidosState()` | Plain-object snapshot of store state (no store methods). |
|
|
677
|
+
|
|
678
|
+
---
|
|
679
|
+
|
|
603
680
|
## Known Limitations
|
|
604
681
|
|
|
605
682
|
| Limitation | Detail |
|
|
@@ -608,7 +685,7 @@ Registers a `QueryClient` with Eidos. After calling this:
|
|
|
608
685
|
| Query string ignored | Resources match by pathname (or full URL for cross-origin). `/api/products?page=2` and `/api/products` share the same SW rule but are cached as separate entries. |
|
|
609
686
|
| Module-scope actions | `action()` must be called at module scope so functions are registered before a page reload triggers queue replay. |
|
|
610
687
|
| Single SW | `EidosProvider` assumes one SW at `/eidos-sw.js`. Multiple registrations are unsupported. |
|
|
611
|
-
| React in main bundle |
|
|
688
|
+
| React in main bundle | ~~Fixed in v1.0.22~~ — ESM output uses `preserveModules`; Vue/Svelte/vanilla consumers only pull in the modules they import. React is isolated to `dist/react/hooks.js` and `dist/react/Provider.js`. |
|
|
612
689
|
|
|
613
690
|
---
|
|
614
691
|
|
|
@@ -632,11 +709,11 @@ Registers a `QueryClient` with Eidos. After calling this:
|
|
|
632
709
|
|
|
633
710
|
**DX / Tooling**
|
|
634
711
|
- [ ] Devtools panel component — drop-in `<EidosDevtools />` showing cache entries, queue state, replay status, and offline toggle
|
|
635
|
-
- [
|
|
712
|
+
- [x] Testing utilities (`@sweidos/eidos/testing`) — `mockOffline()`, `mockOnline()`, `drainQueue()`, `waitForQueueDrain()`, `getCachedEntry(url)`, `clearEidosCache()`, `resetEidos()`, `getEidosState()` for Vitest / Playwright
|
|
636
713
|
- [ ] SvelteKit / Next.js adapters — SSR-aware init helpers that skip SW registration server-side
|
|
637
714
|
|
|
638
715
|
**Performance**
|
|
639
|
-
- [
|
|
716
|
+
- [x] Request deduplication — multiple simultaneous `resource.fetch()` calls share one in-flight network request; each caller gets an independent cloned `Response`
|
|
640
717
|
- [ ] Cache warming — `warmCache(handles[])` bulk-prefetches a list of resources on init (e.g. on login)
|
|
641
718
|
|
|
642
719
|
**Ecosystem**
|
package/dist/action.js
ADDED
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
import { useEidosStore as l } from "./store.js";
|
|
2
|
+
import { getSwRegistration as g } from "./sw-bridge.js";
|
|
3
|
+
import { idbClearQueue as Q, idbGetPendingItems as b, idbUpdateQueueItem as c, idbRemoveFromQueue as I, idbAddToQueue as R } from "./idb.js";
|
|
4
|
+
const w = /* @__PURE__ */ new Map();
|
|
5
|
+
function m() {
|
|
6
|
+
return crypto.randomUUID();
|
|
7
|
+
}
|
|
8
|
+
function v(t, n) {
|
|
9
|
+
const r = n.name || t.name || m();
|
|
10
|
+
w.set(r, t);
|
|
11
|
+
const u = async (...a) => {
|
|
12
|
+
const { isOnline: i } = l.getState();
|
|
13
|
+
if (n.reliability === "neverLose") {
|
|
14
|
+
if (!i)
|
|
15
|
+
return f(r, r, a, n);
|
|
16
|
+
try {
|
|
17
|
+
return await t(...a);
|
|
18
|
+
} catch {
|
|
19
|
+
return f(r, r, a, n);
|
|
20
|
+
}
|
|
21
|
+
}
|
|
22
|
+
return t(...a);
|
|
23
|
+
};
|
|
24
|
+
return Object.defineProperty(u, "id", { value: r, writable: !1 }), Object.defineProperty(u, "config", { value: n, writable: !1 }), u;
|
|
25
|
+
}
|
|
26
|
+
async function f(t, n, r, u) {
|
|
27
|
+
const a = m(), i = {
|
|
28
|
+
id: a,
|
|
29
|
+
actionId: t,
|
|
30
|
+
actionName: n,
|
|
31
|
+
args: r,
|
|
32
|
+
queuedAt: Date.now(),
|
|
33
|
+
retryCount: 0,
|
|
34
|
+
maxRetries: u.maxRetries ?? 3,
|
|
35
|
+
status: "pending"
|
|
36
|
+
};
|
|
37
|
+
await R(i), l.getState().addQueueItem(i);
|
|
38
|
+
try {
|
|
39
|
+
const e = g();
|
|
40
|
+
e && "sync" in e && await e.sync.register("eidos-queue-replay");
|
|
41
|
+
} catch {
|
|
42
|
+
}
|
|
43
|
+
return {
|
|
44
|
+
queued: !0,
|
|
45
|
+
id: a,
|
|
46
|
+
message: `"${n}" queued — will execute when online`
|
|
47
|
+
};
|
|
48
|
+
}
|
|
49
|
+
function S(t) {
|
|
50
|
+
return Math.min(2e3 * 2 ** t, 3e5) * (0.8 + Math.random() * 0.4);
|
|
51
|
+
}
|
|
52
|
+
let p = !1;
|
|
53
|
+
async function D() {
|
|
54
|
+
const t = l.getState();
|
|
55
|
+
if (!t.isOnline || p)
|
|
56
|
+
return { attempted: 0, succeeded: 0, failed: 0, retrying: 0, skipped: 0 };
|
|
57
|
+
p = !0;
|
|
58
|
+
try {
|
|
59
|
+
return await x(t);
|
|
60
|
+
} finally {
|
|
61
|
+
p = !1;
|
|
62
|
+
}
|
|
63
|
+
}
|
|
64
|
+
async function x(t) {
|
|
65
|
+
const n = await b(), r = Date.now(), u = n.filter(
|
|
66
|
+
(e) => !e.nextRetryAt || e.nextRetryAt <= r
|
|
67
|
+
), a = { attempted: 0, succeeded: 0, failed: 0, retrying: 0, skipped: 0 }, i = await Promise.allSettled(
|
|
68
|
+
u.map(async (e) => {
|
|
69
|
+
const d = w.get(e.actionId);
|
|
70
|
+
if (!d) return "skipped";
|
|
71
|
+
t.updateQueueItem(e.id, { status: "replaying" }), await c(e.id, { status: "replaying" });
|
|
72
|
+
try {
|
|
73
|
+
await d(...e.args);
|
|
74
|
+
const o = Date.now();
|
|
75
|
+
return t.updateQueueItem(e.id, { status: "succeeded", completedAt: o }), await c(e.id, { status: "succeeded", completedAt: o }), setTimeout(() => {
|
|
76
|
+
t.removeQueueItem(e.id), I(e.id);
|
|
77
|
+
}, 3e3), "succeeded";
|
|
78
|
+
} catch (o) {
|
|
79
|
+
const s = e.retryCount + 1;
|
|
80
|
+
if (s >= e.maxRetries)
|
|
81
|
+
return t.updateQueueItem(e.id, { status: "failed", error: String(o), retryCount: s }), await c(e.id, { status: "failed", error: String(o), retryCount: s }), "failed";
|
|
82
|
+
{
|
|
83
|
+
const y = Date.now() + S(s);
|
|
84
|
+
return t.updateQueueItem(e.id, { status: "pending", retryCount: s, nextRetryAt: y }), await c(e.id, { status: "pending", retryCount: s, nextRetryAt: y }), "retrying";
|
|
85
|
+
}
|
|
86
|
+
}
|
|
87
|
+
})
|
|
88
|
+
);
|
|
89
|
+
for (const e of i) {
|
|
90
|
+
const d = e.status === "fulfilled" ? e.value : "failed";
|
|
91
|
+
d === "skipped" ? a.skipped++ : (a.attempted++, a[d]++);
|
|
92
|
+
}
|
|
93
|
+
return a;
|
|
94
|
+
}
|
|
95
|
+
async function q() {
|
|
96
|
+
await Q(), l.getState().hydrateQueue([]);
|
|
97
|
+
}
|
|
98
|
+
export {
|
|
99
|
+
v as action,
|
|
100
|
+
q as clearQueue,
|
|
101
|
+
D as replayQueue
|
|
102
|
+
};
|
|
103
|
+
//# sourceMappingURL=action.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"action.js","sources":["../src/action.ts"],"sourcesContent":["import { useEidosStore } from './store'\nimport { getSwRegistration } from './sw-bridge'\nimport {\n idbAddToQueue,\n idbGetPendingItems,\n idbUpdateQueueItem,\n idbRemoveFromQueue,\n idbClearQueue,\n} from './idb'\nimport type {\n ActionConfig,\n ActionHandle,\n ActionFn,\n ActionQueueItem,\n QueuedResult,\n ReplayResult,\n} from './types'\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nconst _actionRegistry = new Map<string, ActionFn<any[], any>>()\n\nfunction uid() {\n return crypto.randomUUID()\n}\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport function action<TArgs extends any[], TReturn>(\n fn: ActionFn<TArgs, TReturn>,\n config: ActionConfig,\n): ActionHandle<TArgs, TReturn> {\n // || not ?? — fn.name can be '' (anonymous arrow fn) which ?? treats as a\n // valid value, causing all anonymous actions to share actionId ''.\n const actionId = config.name || fn.name || uid()\n\n if (import.meta.env.DEV && config.reliability === 'neverLose' && !config.name && !fn.name) {\n console.warn(\n `[eidos] action() registered with neverLose but no stable name was found (fn.name=\"${fn.name}\"). Pass config.name so queued items survive a page reload and can be replayed.`,\n )\n }\n\n // Registering here means the function is available for replay after\n // the user refreshes the page (actions are defined at module scope).\n _actionRegistry.set(actionId, fn as ActionFn<unknown[], unknown>)\n\n const wrapped = async (...args: TArgs): Promise<TReturn | QueuedResult> => {\n const { isOnline } = useEidosStore.getState()\n\n if (config.reliability === 'neverLose') {\n if (!isOnline) {\n return persistAndQueue(actionId, actionId, args, config)\n }\n // Online + neverLose: execute, queue on failure\n try {\n return await fn(...args)\n } catch {\n return persistAndQueue(actionId, actionId, args, config)\n }\n }\n\n // best-effort: execute directly, no queuing\n return fn(...args)\n }\n\n Object.defineProperty(wrapped, 'id', { value: actionId, writable: false })\n Object.defineProperty(wrapped, 'config', { value: config, writable: false })\n\n return wrapped as unknown as ActionHandle<TArgs, TReturn>\n}\n\nfunction isJsonSerializable(value: unknown): boolean {\n try {\n JSON.stringify(value)\n return true\n } catch {\n return false\n }\n}\n\nasync function persistAndQueue(\n actionId: string,\n actionName: string,\n args: unknown[],\n config: ActionConfig,\n): Promise<QueuedResult> {\n if (import.meta.env.DEV && !isJsonSerializable(args)) {\n console.warn(\n `[eidos] action \"${actionName}\" queued with non-JSON-serializable args. These args will be lost after a page reload. Use plain JSON values for neverLose actions.`,\n args,\n )\n }\n\n const id = uid()\n const item: ActionQueueItem = {\n id,\n actionId,\n actionName,\n args,\n queuedAt: Date.now(),\n retryCount: 0,\n maxRetries: config.maxRetries ?? 3,\n status: 'pending',\n }\n\n await idbAddToQueue(item)\n useEidosStore.getState().addQueueItem(item)\n\n // Register Background Sync tag so the browser can wake up open clients\n // when connectivity returns, even if the user navigated away briefly.\n // Graceful no-op when Background Sync is unsupported.\n try {\n const reg = getSwRegistration()\n if (reg && 'sync' in reg) {\n await (reg as unknown as { sync: { register(tag: string): Promise<void> } }).sync.register('eidos-queue-replay')\n }\n } catch {\n // Background Sync not available — online-event replay remains the fallback\n }\n\n return {\n queued: true,\n id,\n message: `\"${actionName}\" queued — will execute when online`,\n }\n}\n\n// Base delay 2s, doubles per retry, capped at 5 minutes, ±20% jitter\nfunction backoffMs(retryCount: number): number {\n const base = Math.min(2000 * 2 ** retryCount, 300_000)\n return base * (0.8 + Math.random() * 0.4)\n}\n\nlet _replaying = false\n\nexport async function replayQueue(): Promise<ReplayResult> {\n const store = useEidosStore.getState()\n if (!store.isOnline || _replaying) {\n return { attempted: 0, succeeded: 0, failed: 0, retrying: 0, skipped: 0 }\n }\n _replaying = true\n try {\n return await _doReplayQueue(store)\n } finally {\n _replaying = false\n }\n}\n\nasync function _doReplayQueue(store: ReturnType<typeof useEidosStore.getState>): Promise<ReplayResult> {\n\n const candidates = await idbGetPendingItems()\n const now = Date.now()\n const pending = candidates.filter(\n (item) => !item.nextRetryAt || item.nextRetryAt <= now,\n )\n\n const result: ReplayResult = { attempted: 0, succeeded: 0, failed: 0, retrying: 0, skipped: 0 }\n\n const outcomes = await Promise.allSettled(\n pending.map(async (item): Promise<'succeeded' | 'failed' | 'retrying' | 'skipped'> => {\n const fn = _actionRegistry.get(item.actionId)\n if (!fn) return 'skipped'\n\n store.updateQueueItem(item.id, { status: 'replaying' })\n await idbUpdateQueueItem(item.id, { status: 'replaying' })\n\n try {\n await fn(...(item.args as unknown[]))\n const completedAt = Date.now()\n store.updateQueueItem(item.id, { status: 'succeeded', completedAt })\n await idbUpdateQueueItem(item.id, { status: 'succeeded', completedAt })\n\n // Remove from queue after a delay so the UI can show the success state\n setTimeout(() => {\n store.removeQueueItem(item.id)\n idbRemoveFromQueue(item.id)\n }, 3000)\n return 'succeeded'\n } catch (err) {\n const retryCount = item.retryCount + 1\n if (retryCount >= item.maxRetries) {\n store.updateQueueItem(item.id, { status: 'failed', error: String(err), retryCount })\n await idbUpdateQueueItem(item.id, { status: 'failed', error: String(err), retryCount })\n return 'failed'\n } else {\n const nextRetryAt = Date.now() + backoffMs(retryCount)\n store.updateQueueItem(item.id, { status: 'pending', retryCount, nextRetryAt })\n await idbUpdateQueueItem(item.id, { status: 'pending', retryCount, nextRetryAt })\n return 'retrying'\n }\n }\n }),\n )\n\n for (const o of outcomes) {\n const outcome = o.status === 'fulfilled' ? o.value : 'failed'\n if (outcome === 'skipped') { result.skipped++ }\n else { result.attempted++; result[outcome]++ }\n }\n\n return result\n}\n\n/** Remove all items from the action queue (IDB + in-memory store). */\nexport async function clearQueue(): Promise<void> {\n await idbClearQueue()\n useEidosStore.getState().hydrateQueue([])\n}\n"],"names":["_actionRegistry","uid","action","fn","config","actionId","wrapped","args","isOnline","useEidosStore","persistAndQueue","actionName","id","item","idbAddToQueue","reg","getSwRegistration","backoffMs","retryCount","_replaying","replayQueue","store","_doReplayQueue","candidates","idbGetPendingItems","now","pending","result","outcomes","idbUpdateQueueItem","completedAt","idbRemoveFromQueue","err","nextRetryAt","o","outcome","clearQueue","idbClearQueue"],"mappings":";;;AAmBA,MAAMA,wBAAsB,IAAA;AAE5B,SAASC,IAAM;AACb,SAAO,OAAO,WAAA;AAChB;AAGO,SAASC,EACdC,GACAC,GAC8B;AAG9B,QAAMC,IAAWD,EAAO,QAAQD,EAAG,QAAQF,EAAA;AAU3C,EAAAD,EAAgB,IAAIK,GAAUF,CAAkC;AAEhE,QAAMG,IAAU,UAAUC,MAAiD;AACzE,UAAM,EAAE,UAAAC,EAAA,IAAaC,EAAc,SAAA;AAEnC,QAAIL,EAAO,gBAAgB,aAAa;AACtC,UAAI,CAACI;AACH,eAAOE,EAAgBL,GAAUA,GAAUE,GAAMH,CAAM;AAGzD,UAAI;AACF,eAAO,MAAMD,EAAG,GAAGI,CAAI;AAAA,MACzB,QAAQ;AACN,eAAOG,EAAgBL,GAAUA,GAAUE,GAAMH,CAAM;AAAA,MACzD;AAAA,IACF;AAGA,WAAOD,EAAG,GAAGI,CAAI;AAAA,EACnB;AAEA,gBAAO,eAAeD,GAAS,MAAM,EAAE,OAAOD,GAAU,UAAU,IAAO,GACzE,OAAO,eAAeC,GAAS,UAAU,EAAE,OAAOF,GAAQ,UAAU,IAAO,GAEpEE;AACT;AAWA,eAAeI,EACbL,GACAM,GACAJ,GACAH,GACuB;AAQvB,QAAMQ,IAAKX,EAAA,GACLY,IAAwB;AAAA,IAC5B,IAAAD;AAAA,IACA,UAAAP;AAAA,IACA,YAAAM;AAAA,IACA,MAAAJ;AAAA,IACA,UAAU,KAAK,IAAA;AAAA,IACf,YAAY;AAAA,IACZ,YAAYH,EAAO,cAAc;AAAA,IACjC,QAAQ;AAAA,EAAA;AAGV,QAAMU,EAAcD,CAAI,GACxBJ,EAAc,SAAA,EAAW,aAAaI,CAAI;AAK1C,MAAI;AACF,UAAME,IAAMC,EAAA;AACZ,IAAID,KAAO,UAAUA,KACnB,MAAOA,EAAsE,KAAK,SAAS,oBAAoB;AAAA,EAEnH,QAAQ;AAAA,EAER;AAEA,SAAO;AAAA,IACL,QAAQ;AAAA,IACR,IAAAH;AAAA,IACA,SAAS,IAAID,CAAU;AAAA,EAAA;AAE3B;AAGA,SAASM,EAAUC,GAA4B;AAE7C,SADa,KAAK,IAAI,MAAO,KAAKA,GAAY,GAAO,KACtC,MAAM,KAAK,OAAA,IAAW;AACvC;AAEA,IAAIC,IAAa;AAEjB,eAAsBC,IAAqC;AACzD,QAAMC,IAAQZ,EAAc,SAAA;AAC5B,MAAI,CAACY,EAAM,YAAYF;AACrB,WAAO,EAAE,WAAW,GAAG,WAAW,GAAG,QAAQ,GAAG,UAAU,GAAG,SAAS,EAAA;AAExE,EAAAA,IAAa;AACb,MAAI;AACF,WAAO,MAAMG,EAAeD,CAAK;AAAA,EACnC,UAAA;AACE,IAAAF,IAAa;AAAA,EACf;AACF;AAEA,eAAeG,EAAeD,GAAyE;AAErG,QAAME,IAAa,MAAMC,EAAA,GACnBC,IAAM,KAAK,IAAA,GACXC,IAAUH,EAAW;AAAA,IACzB,CAACV,MAAS,CAACA,EAAK,eAAeA,EAAK,eAAeY;AAAA,EAAA,GAG/CE,IAAuB,EAAE,WAAW,GAAG,WAAW,GAAG,QAAQ,GAAG,UAAU,GAAG,SAAS,EAAA,GAEtFC,IAAW,MAAM,QAAQ;AAAA,IAC7BF,EAAQ,IAAI,OAAOb,MAAmE;AACpF,YAAMV,IAAKH,EAAgB,IAAIa,EAAK,QAAQ;AAC5C,UAAI,CAACV,EAAI,QAAO;AAEhB,MAAAkB,EAAM,gBAAgBR,EAAK,IAAI,EAAE,QAAQ,aAAa,GACtD,MAAMgB,EAAmBhB,EAAK,IAAI,EAAE,QAAQ,aAAa;AAEzD,UAAI;AACF,cAAMV,EAAG,GAAIU,EAAK,IAAkB;AACpC,cAAMiB,IAAc,KAAK,IAAA;AACzB,eAAAT,EAAM,gBAAgBR,EAAK,IAAI,EAAE,QAAQ,aAAa,aAAAiB,GAAa,GACnE,MAAMD,EAAmBhB,EAAK,IAAI,EAAE,QAAQ,aAAa,aAAAiB,GAAa,GAGtE,WAAW,MAAM;AACf,UAAAT,EAAM,gBAAgBR,EAAK,EAAE,GAC7BkB,EAAmBlB,EAAK,EAAE;AAAA,QAC5B,GAAG,GAAI,GACA;AAAA,MACT,SAASmB,GAAK;AACZ,cAAMd,IAAaL,EAAK,aAAa;AACrC,YAAIK,KAAcL,EAAK;AACrB,iBAAAQ,EAAM,gBAAgBR,EAAK,IAAI,EAAE,QAAQ,UAAU,OAAO,OAAOmB,CAAG,GAAG,YAAAd,EAAA,CAAY,GACnF,MAAMW,EAAmBhB,EAAK,IAAI,EAAE,QAAQ,UAAU,OAAO,OAAOmB,CAAG,GAAG,YAAAd,EAAA,CAAY,GAC/E;AACF;AACL,gBAAMe,IAAc,KAAK,IAAA,IAAQhB,EAAUC,CAAU;AACrD,iBAAAG,EAAM,gBAAgBR,EAAK,IAAI,EAAE,QAAQ,WAAW,YAAAK,GAAY,aAAAe,GAAa,GAC7E,MAAMJ,EAAmBhB,EAAK,IAAI,EAAE,QAAQ,WAAW,YAAAK,GAAY,aAAAe,GAAa,GACzE;AAAA,QACT;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EAAA;AAGH,aAAWC,KAAKN,GAAU;AACxB,UAAMO,IAAUD,EAAE,WAAW,cAAcA,EAAE,QAAQ;AACrD,IAAIC,MAAY,YAAaR,EAAO,aAC7BA,EAAO,aAAaA,EAAOQ,CAAO;AAAA,EAC3C;AAEA,SAAOR;AACT;AAGA,eAAsBS,IAA4B;AAChD,QAAMC,EAAA,GACN5B,EAAc,SAAA,EAAW,aAAa,EAAE;AAC1C;"}
|
package/dist/eidos.cjs.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const
|
|
1
|
+
"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const j=require("react/jsx-runtime"),R=require("react");let y;const D=new Set;function W(){D.forEach(e=>e())}function g(e){y={...y,...e(y)},W()}y={isOnline:typeof navigator<"u"?navigator.onLine:!0,swStatus:"idle",swError:void 0,resources:{},queue:[],setOnline:e=>g(()=>({isOnline:e})),setSwStatus:(e,t)=>g(()=>({swStatus:e,swError:t})),registerResource:(e,t)=>g(s=>({resources:{...s.resources,[e]:t}})),updateResource:(e,t)=>g(s=>({resources:{...s.resources,[e]:s.resources[e]?{...s.resources[e],...t}:s.resources[e]}})),unregisterResource:e=>g(t=>{const{[e]:s,...r}=t.resources;return{resources:r}}),addQueueItem:e=>g(t=>({queue:[...t.queue,e]})),updateQueueItem:(e,t)=>g(s=>({queue:s.queue.map(r=>r.id===e?{...r,...t}:r)})),removeQueueItem:e=>g(t=>({queue:t.queue.filter(s=>s.id!==e)})),hydrateQueue:e=>g(()=>({queue:e}))};function F(){return y}function $(e){return D.add(e),()=>{D.delete(e)}}const c={getState:F,subscribe:$,setState:e=>{const t=typeof e=="function"?e(y):e;y={...y,...t},W()}};let w=null,P=[];function G(){return w}async function K(e){if(typeof navigator>"u"||!("serviceWorker"in navigator)){c.getState().setSwStatus("unsupported");return}const t=c.getState();t.setSwStatus("registering");try{w=await navigator.serviceWorker.register(e,{scope:"/"}),await V(w),t.setSwStatus("active"),navigator.serviceWorker.addEventListener("message",X),window.addEventListener("online",()=>t.setOnline(!0)),window.addEventListener("offline",()=>t.setOnline(!1)),Z()}catch(s){t.setSwStatus("error",String(s))}}function V(e){return new Promise(t=>{if(e.active){t();return}const s=e.installing??e.waiting;if(!s){t();return}const r=setTimeout(t,1e4);s.addEventListener("statechange",function n(){s.state==="activated"&&(clearTimeout(r),s.removeEventListener("statechange",n),t())})})}function k(e){const t=w==null?void 0:w.active;t?t.postMessage(e):P.push(e)}let x=null;function Y(e){x=e}function z(){try{return typeof navigator<"u"&&"serviceWorker"in navigator&&w!==null&&"sync"in w}catch{return!1}}function X(e){const t=e.data;if(!(t!=null&&t.type))return;const s=c.getState(),{type:r,url:n}=t;if(r==="EIDOS_BACKGROUND_SYNC"){x==null||x();return}if(n)switch(r){case"EIDOS_CACHE_HIT":{const i=s.resources[n];s.updateResource(n,{status:"fresh",lastEvent:"cache-hit",cacheHits:((i==null?void 0:i.cacheHits)??0)+1});break}case"EIDOS_CACHE_UPDATED":{s.updateResource(n,{status:"fresh",lastEvent:"cache-updated",cachedAt:Date.now()});break}case"EIDOS_NETWORK_ERROR":{s.updateResource(n,{status:"error",lastEvent:"network-error"});break}}}function J(e){k({type:"EIDOS_SIMULATE_OFFLINE",enabled:e}),c.getState().setOnline(!e)}function Z(){const e=w==null?void 0:w.active;if(e){for(const t of P)e.postMessage(t);P=[]}}const b=new Map,_=new Map;let I=null;function ee(e){I=e}function S(e){return e.includes("*")||/:[^/]+/.test(e)}function te(e){return"^"+e.replace(/[.+?^${}()|[\]\\]/g,"\\$&").replace(/\*\*/g,".+").replace(/\*/g,"[^/]+").replace(/:[^/]+/g,"[^/]+")+"$"}function O(e,t){return new Error(`[eidos] resource('${e}') is a URL pattern — ${t}() is not supported on pattern handles. The SW intercepts matching requests automatically; call fetch(specificUrl) directly in your app code.`)}function se(e,t){if(b.has(e))return b.get(e);const s=re(e,t),r=S(e)?te(e):void 0,n={url:e,config:t,strategy:s,status:"idle",cacheHits:0,cacheMisses:0};c.getState().registerResource(e,n),k({type:"EIDOS_REGISTER_RESOURCE",url:e,strategy:s.swStrategy,cacheName:s.cacheName,...r!==void 0&&{pattern:r}});const i={url:e,config:t,strategy:s,fetch:async()=>{if(S(e))throw O(e,"fetch");const a=_.get(e);if(a)return a.then(u=>u.clone());const o=ne(e,t,s);return _.set(e,o),o.finally(()=>_.delete(e)),o.then(u=>u.clone())},json:async()=>{if(S(e))throw O(e,"json");return(await i.fetch()).json()},query:()=>{if(S(e))throw O(e,"query");return{queryKey:["eidos",e],queryFn:()=>i.json()}},prefetch:async()=>{if(S(e))throw O(e,"prefetch");await i.fetch()},invalidate:async()=>{k({type:"EIDOS_CLEAR_CACHE",url:e});const a=await caches.open(s.cacheName).catch(()=>null);if(a){const o=await a.keys(),u=r?new RegExp(r):null,f=e.startsWith("http");await Promise.all(o.filter(d=>{const l=d.url,T=new URL(l).pathname;return u?u.test(f?l:T):f?l===e:l===e||T===e}).map(d=>a.delete(d)))}S(e)||c.getState().updateResource(e,{status:"stale",cachedAt:void 0,lastEvent:"cache-cleared",cacheHits:0,cacheMisses:0}),I==null||I(["eidos",e])},unregister:()=>{b.delete(e),k({type:"EIDOS_UNREGISTER_RESOURCE",url:e}),c.getState().unregisterResource(e)}};return b.set(e,i),i}async function ne(e,t,s){const r=c.getState();r.updateResource(e,{status:"fetching",fetchedAt:Date.now()});const n=await caches.open(s.cacheName).catch(()=>null);try{if(s.swStrategy!=="network-first"){const o=n?await n.match(e).catch(()=>null):null,u=c.getState().resources[e],f=t.maxAge!==void 0&&(u==null?void 0:u.cachedAt)!==void 0&&Date.now()-u.cachedAt>t.maxAge;if(o&&!f)return r.updateResource(e,{status:"fresh",lastEvent:"cache-hit",cacheHits:((u==null?void 0:u.cacheHits)??0)+1}),s.swStrategy==="stale-while-revalidate"&&fetch(e).then(async l=>{l.ok&&n&&(await n.put(e,l.clone()),c.getState().updateResource(e,{cachedAt:Date.now(),lastEvent:"cache-updated"}))}).catch(()=>{}),o;const d=c.getState().resources[e];r.updateResource(e,{cacheMisses:((d==null?void 0:d.cacheMisses)??0)+1})}const i=await fetch(e);if(i.ok)return n&&await n.put(e,i.clone()),r.updateResource(e,{status:"fresh",cachedAt:Date.now(),lastEvent:"cache-updated"}),i;r.updateResource(e,{status:i.status===503?"offline":"error"});const a=i.headers.get("X-Eidos-Offline")==="true";throw new Error(a?`offline: no cached response for ${e}`:`${i.status} ${i.statusText}`)}catch(i){const a=n?await n.match(e).catch(()=>null):null;if(a){const o=c.getState().resources[e];return r.updateResource(e,{status:"fresh",lastEvent:"cache-hit",cacheHits:((o==null?void 0:o.cacheHits)??0)+1}),a}throw r.updateResource(e,{status:"error"}),i}}function re(e,t){const s=t.strategy;return t.offline?M(s??"stale-while-revalidate",e,t.cacheName):M(s??"network-first",e,t.cacheName)}const ae={"stale-while-revalidate":{name:"StaleWhileRevalidate",reasoning:"offline: true signals resilience. SWR returns cached data instantly while revalidating in the background — the best tradeoff between speed and freshness for offline-capable resources.",behavior:["Cache hit → return immediately, kick off background revalidation","Cache miss → fetch from network, cache the response, return it","Offline → return cached version if available, 503 if not","Reconnect → next request triggers a background refresh"],equivalentCode:`// Workbox equivalent
|
|
2
2
|
new StaleWhileRevalidate({
|
|
3
3
|
cacheName: 'eidos-resources-v1',
|
|
4
4
|
plugins: [new ExpirationPlugin({ maxEntries: 60 })],
|
|
@@ -10,5 +10,5 @@ new CacheFirst({
|
|
|
10
10
|
new NetworkFirst({
|
|
11
11
|
cacheName: 'eidos-resources-v1',
|
|
12
12
|
networkTimeoutSeconds: 3,
|
|
13
|
-
})`}};function
|
|
13
|
+
})`}};function M(e,t,s){return{...ae[e],swStrategy:e,cacheName:s??"eidos-resources-v1"}}const ie="eidos",oe=1,h="action-queue";let A=null;function m(){return A?Promise.resolve(A):new Promise((e,t)=>{const s=indexedDB.open(ie,oe);s.onupgradeneeded=r=>{const n=r.target.result;if(!n.objectStoreNames.contains(h)){const i=n.createObjectStore(h,{keyPath:"id"});i.createIndex("status","status",{unique:!1}),i.createIndex("actionId","actionId",{unique:!1})}},s.onsuccess=()=>{A=s.result,e(s.result)},s.onerror=()=>t(s.error)})}async function ce(e){const t=await m();return new Promise((s,r)=>{const n=t.transaction(h,"readwrite");n.objectStore(h).add(e),n.oncomplete=()=>s(),n.onerror=()=>r(n.error)})}async function ue(){const e=await m();return new Promise((t,s)=>{const n=e.transaction(h,"readonly").objectStore(h).getAll();n.onsuccess=()=>t(n.result),n.onerror=()=>s(n.error)})}async function q(e,t){const s=await m();return new Promise((r,n)=>{const i=s.transaction(h,"readwrite"),a=i.objectStore(h),o=a.get(e);o.onsuccess=()=>{o.result&&a.put({...o.result,...t})},i.oncomplete=()=>r(),i.onerror=()=>n(i.error)})}async function de(e){const t=await m();return new Promise((s,r)=>{const n=t.transaction(h,"readwrite");n.objectStore(h).delete(e),n.oncomplete=()=>s(),n.onerror=()=>r(n.error)})}async function fe(){const e=await m();return new Promise((t,s)=>{const n=e.transaction(h,"readonly").objectStore(h).index("status"),i=[];let a=0;function o(d){if(d){s(d);return}++a===2&&t(i)}const u=n.openCursor(IDBKeyRange.only("pending"));u.onsuccess=d=>{const l=d.target.result;l?(i.push(l.value),l.continue()):o()},u.onerror=()=>o(u.error);const f=n.openCursor(IDBKeyRange.only("failed"));f.onsuccess=d=>{const l=d.target.result;l?(i.push(l.value),l.continue()):o()},f.onerror=()=>o(f.error)})}async function le(){const e=await m();return new Promise((t,s)=>{const r=e.transaction(h,"readwrite");r.objectStore(h).clear(),r.oncomplete=()=>t(),r.onerror=()=>s(r.error)})}const B=new Map;function H(){return crypto.randomUUID()}function he(e,t){const s=t.name||e.name||H();B.set(s,e);const r=async(...n)=>{const{isOnline:i}=c.getState();if(t.reliability==="neverLose"){if(!i)return U(s,s,n,t);try{return await e(...n)}catch{return U(s,s,n,t)}}return e(...n)};return Object.defineProperty(r,"id",{value:s,writable:!1}),Object.defineProperty(r,"config",{value:t,writable:!1}),r}async function U(e,t,s,r){const n=H(),i={id:n,actionId:e,actionName:t,args:s,queuedAt:Date.now(),retryCount:0,maxRetries:r.maxRetries??3,status:"pending"};await ce(i),c.getState().addQueueItem(i);try{const a=G();a&&"sync"in a&&await a.sync.register("eidos-queue-replay")}catch{}return{queued:!0,id:n,message:`"${t}" queued — will execute when online`}}function pe(e){return Math.min(2e3*2**e,3e5)*(.8+Math.random()*.4)}let C=!1;async function Q(){const e=c.getState();if(!e.isOnline||C)return{attempted:0,succeeded:0,failed:0,retrying:0,skipped:0};C=!0;try{return await we(e)}finally{C=!1}}async function we(e){const t=await fe(),s=Date.now(),r=t.filter(a=>!a.nextRetryAt||a.nextRetryAt<=s),n={attempted:0,succeeded:0,failed:0,retrying:0,skipped:0},i=await Promise.allSettled(r.map(async a=>{const o=B.get(a.actionId);if(!o)return"skipped";e.updateQueueItem(a.id,{status:"replaying"}),await q(a.id,{status:"replaying"});try{await o(...a.args);const u=Date.now();return e.updateQueueItem(a.id,{status:"succeeded",completedAt:u}),await q(a.id,{status:"succeeded",completedAt:u}),setTimeout(()=>{e.removeQueueItem(a.id),de(a.id)},3e3),"succeeded"}catch(u){const f=a.retryCount+1;if(f>=a.maxRetries)return e.updateQueueItem(a.id,{status:"failed",error:String(u),retryCount:f}),await q(a.id,{status:"failed",error:String(u),retryCount:f}),"failed";{const d=Date.now()+pe(f);return e.updateQueueItem(a.id,{status:"pending",retryCount:f,nextRetryAt:d}),await q(a.id,{status:"pending",retryCount:f,nextRetryAt:d}),"retrying"}}}));for(const a of i){const o=a.status==="fulfilled"?a.value:"failed";o==="skipped"?n.skipped++:(n.attempted++,n[o]++)}return n}async function ge(){await le(),c.getState().hydrateQueue([])}let N=!1,v=null;async function L(e={}){if(N)return;N=!0;const t=e.swPath??"/eidos-sw.js",s=e.autoReplay??!0;try{const r=await ue();r.length>0&&c.getState().hydrateQueue(r)}catch{}try{await K(t)}catch{}if(Y(()=>{c.getState().isOnline&&setTimeout(Q,200)}),s){let r=c.getState().isOnline;v=c.subscribe(()=>{const{isOnline:a}=c.getState(),o=a&&!r;r=a,o&&setTimeout(Q,600)});const n=c.getState(),i=n.queue.some(a=>a.status==="pending"||a.status==="failed");n.isOnline&&i&&setTimeout(Q,1200)}}function ye(){v==null||v(),v=null,N=!1}function Se({children:e,swPath:t,autoReplay:s}){return R.useEffect(()=>{L({swPath:t,autoReplay:s})},[]),j.jsx(j.Fragment,{children:e})}function p(e){const t=e??(s=>s);return R.useSyncExternalStore(c.subscribe,()=>t(c.getState()))}function me(){return p()}function Ee(e){return p(t=>t.resources[e])}function ve(){return p(e=>e.queue)}function Re(e){return p(t=>t.queue.find(s=>s.id===e))}function be(){const e=p(r=>r.isOnline),t=p(r=>r.swStatus),s=p(r=>r.swError);return{isOnline:e,swStatus:t,swError:s}}function Oe(){const e=p(n=>n.queue.filter(i=>i.status==="pending").length),t=p(n=>n.queue.filter(i=>i.status==="failed").length),s=p(n=>n.queue.filter(i=>i.status==="replaying").length),r=p(n=>n.queue.length);return{pending:e,failed:t,replaying:s,total:r}}function qe(e){const t=p(n=>n.queue.length),s=R.useRef(0),r=R.useRef(e);r.current=e,R.useEffect(()=>{s.current>0&&t===0&&r.current(),s.current=t},[t])}const ke="1.0.23";function E(e){return{subscribe(t){return t(e(c.getState())),c.subscribe(()=>t(e(c.getState())))},getState(){return e(c.getState())}}}const xe=E(e=>e),Ie=E(e=>e.queue),Qe=E(e=>({isOnline:e.isOnline,swStatus:e.swStatus,swError:e.swError})),_e=E(e=>{let t=0,s=0,r=0;for(const n of e.queue)n.status==="pending"?t++:n.status==="failed"?s++:n.status==="replaying"&&r++;return{pending:t,failed:s,replaying:r,total:e.queue.length}});function Ae(e){return E(t=>t.resources[e])}function Ce(e){return E(t=>t.queue.find(s=>s.id===e))}exports.EidosProvider=Se;exports.VERSION=ke;exports._resetEidos=ye;exports.action=he;exports.clearQueue=ge;exports.eidosAction=Ce;exports.eidosQueue=Ie;exports.eidosQueueStats=_e;exports.eidosResource=Ae;exports.eidosStatus=Qe;exports.eidosStore=xe;exports.initEidos=L;exports.isBgSyncSupported=z;exports.replayQueue=Q;exports.resource=se;exports.setOfflineSimulation=J;exports.setQueryInvalidator=ee;exports.useEidos=me;exports.useEidosAction=Re;exports.useEidosOnDrain=qe;exports.useEidosQueue=ve;exports.useEidosQueueStats=Oe;exports.useEidosResource=Ee;exports.useEidosStatus=be;exports.useEidosStore=c;
|
|
14
14
|
//# sourceMappingURL=eidos.cjs.js.map
|