@lite-fsm/persist 1.0.3 → 1.0.5
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 +10 -10
- package/dist/index.cjs +1 -1
- package/dist/index.d.cts +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/dist/react.cjs +1 -1
- package/dist/react.d.cts +5 -3
- package/dist/react.d.ts +5 -3
- package/dist/react.js +1 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -22,7 +22,7 @@ npm install @lite-fsm/react @lite-fsm/persist
|
|
|
22
22
|
import { createJsonStorage, persistManager } from "@lite-fsm/persist";
|
|
23
23
|
import type { PersistController, PersistStorage, PersistStatus } from "@lite-fsm/persist";
|
|
24
24
|
|
|
25
|
-
import { useIsPersistRestoring,
|
|
25
|
+
import { useIsPersistRestoring, usePersistStatuses } from "@lite-fsm/persist/react";
|
|
26
26
|
```
|
|
27
27
|
|
|
28
28
|
## Quick Example
|
|
@@ -83,7 +83,7 @@ import { FSMContextProvider } from "@lite-fsm/react";
|
|
|
83
83
|
|
|
84
84
|
export function App() {
|
|
85
85
|
return (
|
|
86
|
-
<FSMContextProvider machineManager={manager} persist={persist}>
|
|
86
|
+
<FSMContextProvider machineManager={manager} persist={[persist]}>
|
|
87
87
|
<Page />
|
|
88
88
|
</FSMContextProvider>
|
|
89
89
|
);
|
|
@@ -93,19 +93,19 @@ export function App() {
|
|
|
93
93
|
Read restore status from React with `@lite-fsm/persist/react`:
|
|
94
94
|
|
|
95
95
|
```tsx
|
|
96
|
-
import {
|
|
96
|
+
import { usePersistStatuses } from "@lite-fsm/persist/react";
|
|
97
97
|
|
|
98
98
|
function PersistStatusView() {
|
|
99
|
-
const status =
|
|
100
|
-
return <span>{status
|
|
99
|
+
const [status] = usePersistStatuses();
|
|
100
|
+
return <span>{status?.phase ?? "none"}</span>;
|
|
101
101
|
}
|
|
102
102
|
```
|
|
103
103
|
|
|
104
|
-
|
|
105
|
-
`
|
|
106
|
-
`useIsPersistRestoring()`
|
|
107
|
-
blocking UI until the first restore
|
|
108
|
-
phase as loading.
|
|
104
|
+
`usePersistStatuses()` returns an array with the same length and order as the
|
|
105
|
+
provider `persist` array. Entries without `getStatus()` and `subscribeStatus()`
|
|
106
|
+
are returned as `null`. `useIsPersistRestoring()` returns `true` when any
|
|
107
|
+
non-null status has `phase === "restoring"`; blocking UI until the first restore
|
|
108
|
+
settles should also treat the `"idle"` phase as loading.
|
|
109
109
|
|
|
110
110
|
## Documentation
|
|
111
111
|
|
package/dist/index.cjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
"use strict";var x=Object.defineProperty;var
|
|
1
|
+
"use strict";var x=Object.defineProperty;var q=Object.getOwnPropertyDescriptor;var z=Object.getOwnPropertyNames;var Q=Object.prototype.hasOwnProperty;var X=(r,t)=>{for(var i in t)x(r,i,{get:t[i],enumerable:!0})},Z=(r,t,i,d)=>{if(t&&typeof t=="object"||typeof t=="function")for(let a of z(t))!Q.call(r,a)&&a!==i&&x(r,a,{get:()=>t[a],enumerable:!(d=q(t,a))||d.enumerable});return r};var $=r=>Z(x({},"__esModule",{value:!0}),r);var ie={};X(ie,{createJsonStorage:()=>oe,persistManager:()=>ae});module.exports=$(ie);var _=require("@lite-fsm/core");var O=Symbol("lite-fsm.taskCancelled"),ee=()=>Object.assign(new Error("[lite-fsm] task was cancelled."),{[O]:!0}),L=r=>r instanceof Error&&O in r,J=()=>{let r=0,t=new Set;return{latest:()=>{let d=0,a=-1,u=-1;t.add(()=>{a=-1,u=-1});let m=()=>a===r&&u===d,k=(l,o)=>{a=l,u=o},P=(l,o)=>{a!==l||u!==o||(a=-1,u=-1)};return{run:async l=>{let o=r,S=++d,f=()=>o===r&&S===d,p=()=>{if(!f())throw ee()},w=async g=>{p();let M=await g();return p(),M};k(o,S);try{return await l({isCurrent:f,checkpoint:p,step:w})}finally{P(o,S)}},isActive:m}},cancelAll:()=>{r+=1;for(let d of t)d()}}};var B={phase:"idle"},te={phase:"restoring"},N=r=>r!==null&&typeof r=="object"&&!Array.isArray(r),re=r=>N(r)&&typeof r.timestamp=="number"&&N(r.snapshot),se=()=>new Error("[@lite-fsm/persist] restore: persisted record must be an object with numeric timestamp and object snapshot."),ne=(r,t)=>r.phase!==t.phase?!1:r.phase==="ready"&&t.phase==="ready"?r.restored===t.restored:r.phase==="error"&&t.phase==="error"?r.error===t.error:!0,ae=(r,t)=>{let i=t.throttleMs??0,d=t.strategy??"merge",a=B,u=[],m=0,k,P,y,l=!1,o,S=!1,f=J(),p=f.latest(),w=f.latest(),g=(e,s)=>{try{t.onError?.(e,s)}catch{}},M=e=>{try{t.onRestoreSettled?.(e)}catch{}},h=e=>{if(!ne(a,e)){a=e;for(let s of u)s()}},E=(e,s,n,c)=>{if(L(e))return;let T=s.isCurrent();if(!(!T&&n==="background")){if(T){let b={phase:"error",error:e};h(b),c==="restore"&&M(b)}if(g(e,c),n==="direct")throw e}},R=()=>{l=!1,y&&(clearTimeout(y),y=void 0)},V=()=>{f.cancelAll(),S=!1,o=void 0,R()},j=e=>w.run(async s=>{try{s.checkpoint();let n={timestamp:Date.now(),storageVersion:t.storageVersion,snapshot:r.dehydrate({machines:t.machines})};s.checkpoint(),await s.step(()=>t.storage.set(n))}catch(n){E(n,s,e,"save")}}),v=e=>{R();let s=j(e).finally(()=>{o===s&&(o=void 0)});return o=s,s},H=()=>{if(l=!0,i===0){v("background");return}y||(y=setTimeout(()=>{v("background")},i))},K=async(e,s,n)=>{let c=e||S;S=!1,!(!c||!s.isCurrent())&&await v(n)},U=(e,s)=>{let n={phase:"ready",restored:e};return s.isCurrent()&&(h(n),M(n)),n},W=async e=>{if(e===void 0)return{kind:"skip"};if(!re(e))return{kind:"remove",error:se()};if(t.maxAge!==void 0&&Date.now()-e.timestamp>t.maxAge)return{kind:"remove"};if(e.storageVersion===t.storageVersion)return{kind:"hydrate",snapshot:e.snapshot,writeBack:!1};if(!t.migrate)return{kind:"remove"};let s=await t.migrate(e);return s?{kind:"hydrate",snapshot:s,writeBack:!0}:{kind:"remove"}},Y=async e=>e.kind==="skip"?!1:e.kind==="remove"?(e.error!==void 0&&g(e.error,"restore"),await t.storage.remove(),!1):(r.hydrate(e.snapshot,{strategy:d}),!0),I=async e=>{let s=p.isActive();return p.run(async n=>{s||(S=!1),h(te);let c=!1,T=!1;try{let A=await n.step(()=>t.storage.get()),C=await n.step(()=>W(A));c=await n.step(()=>Y(C)),T=C.kind==="hydrate"&&C.writeBack}catch(A){return E(A,n,e,"restore"),a}let b=U(c,n);return await K(T,n,e),b})},D=()=>{I("background")},F=(e,s,n)=>{try{return t.shouldSave?.({prevState:e,currentState:s,action:n})??!0}catch(c){return h({phase:"error",error:c}),g(c,"save"),!1}},G=(e,s,n)=>{if(n.type!==_.HYDRATE_ACTION_TYPE&&F(e,s,n)){if(p.isActive()){S=!0;return}H()}};return{start:()=>{m+=1,m===1&&(k=r.onTransition((s,n,c)=>{G(s,n,c)}),P=t.storage.subscribe?.(D),D());let e=!1;return()=>{e||(e=!0,m-=1,!(m>0)&&(V(),k?.(),P?.(),k=void 0,P=void 0,h(B)))}},restore:()=>I("direct"),save:async()=>{R(),await v("direct")},flush:async()=>{if(l){await v("direct");return}await o},clear:async()=>{let e=o;V();try{await e?.catch(()=>{}),await t.storage.remove(),h({phase:"ready",restored:!1})}catch(s){throw h({phase:"error",error:s}),g(s,"clear"),s}},getStatus:()=>a,subscribeStatus:e=>(u.push(e),()=>{u=u.filter(s=>s!==e)})}},oe=({key:r,storage:t})=>({get:()=>{let i=t().getItem(r);return i==null?void 0:JSON.parse(i)},set:i=>{t().setItem(r,JSON.stringify(i))},remove:()=>{t().removeItem(r)}});0&&(module.exports={createJsonStorage,persistManager});
|
package/dist/index.d.cts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type
|
|
1
|
+
import { type DehydrateOptions, type HydrateStrategy, type IMachineManager, type MachineManagerSnapshot, type MachinesState, type MachineStore, type ManagerCommitAction } from "@lite-fsm/core";
|
|
2
2
|
export type MaybePromise<T> = T | Promise<T>;
|
|
3
3
|
export type PersistedRecord<S extends MachineStore> = {
|
|
4
4
|
timestamp: number;
|
package/dist/index.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type
|
|
1
|
+
import { type DehydrateOptions, type HydrateStrategy, type IMachineManager, type MachineManagerSnapshot, type MachinesState, type MachineStore, type ManagerCommitAction } from "@lite-fsm/core";
|
|
2
2
|
export type MaybePromise<T> = T | Promise<T>;
|
|
3
3
|
export type PersistedRecord<S extends MachineStore> = {
|
|
4
4
|
timestamp: number;
|
package/dist/index.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
var D=Symbol("lite-fsm.taskCancelled"),F=()=>Object.assign(new Error("[lite-fsm] task was cancelled."),{[D]:!0}),O=s=>s instanceof Error&&D in s,L=()=>{let s=0,r=new Set;return{latest:()=>{let S=0,i=-1,c=-1;r.add(()=>{i=-1,c=-1});let
|
|
1
|
+
import{HYDRATE_ACTION_TYPE as G}from"@lite-fsm/core";var D=Symbol("lite-fsm.taskCancelled"),F=()=>Object.assign(new Error("[lite-fsm] task was cancelled."),{[D]:!0}),O=s=>s instanceof Error&&D in s,L=()=>{let s=0,r=new Set;return{latest:()=>{let S=0,i=-1,c=-1;r.add(()=>{i=-1,c=-1});let m=()=>i===s&&c===S,k=(d,a)=>{i=d,c=a},P=(d,a)=>{i!==d||c!==a||(i=-1,c=-1)};return{run:async d=>{let a=s,u=++S,f=()=>a===s&&u===S,p=()=>{if(!f())throw F()},w=async g=>{p();let M=await g();return p(),M};k(a,u);try{return await d({isCurrent:f,checkpoint:p,step:w})}finally{P(a,u)}},isActive:m}},cancelAll:()=>{s+=1;for(let S of r)S()}}};var J={phase:"idle"},q={phase:"restoring"},B=s=>s!==null&&typeof s=="object"&&!Array.isArray(s),z=s=>B(s)&&typeof s.timestamp=="number"&&B(s.snapshot),Q=()=>new Error("[@lite-fsm/persist] restore: persisted record must be an object with numeric timestamp and object snapshot."),X=(s,r)=>s.phase!==r.phase?!1:s.phase==="ready"&&r.phase==="ready"?s.restored===r.restored:s.phase==="error"&&r.phase==="error"?s.error===r.error:!0,oe=(s,r)=>{let l=r.throttleMs??0,S=r.strategy??"merge",i=J,c=[],m=0,k,P,y,d=!1,a,u=!1,f=L(),p=f.latest(),w=f.latest(),g=(e,t)=>{try{r.onError?.(e,t)}catch{}},M=e=>{try{r.onRestoreSettled?.(e)}catch{}},h=e=>{if(!X(i,e)){i=e;for(let t of c)t()}},x=(e,t,n,o)=>{if(O(e))return;let T=t.isCurrent();if(!(!T&&n==="background")){if(T){let b={phase:"error",error:e};h(b),o==="restore"&&M(b)}if(g(e,o),n==="direct")throw e}},R=()=>{d=!1,y&&(clearTimeout(y),y=void 0)},E=()=>{f.cancelAll(),u=!1,a=void 0,R()},N=e=>w.run(async t=>{try{t.checkpoint();let n={timestamp:Date.now(),storageVersion:r.storageVersion,snapshot:s.dehydrate({machines:r.machines})};t.checkpoint(),await t.step(()=>r.storage.set(n))}catch(n){x(n,t,e,"save")}}),v=e=>{R();let t=N(e).finally(()=>{a===t&&(a=void 0)});return a=t,t},_=()=>{if(d=!0,l===0){v("background");return}y||(y=setTimeout(()=>{v("background")},l))},j=async(e,t,n)=>{let o=e||u;u=!1,!(!o||!t.isCurrent())&&await v(n)},H=(e,t)=>{let n={phase:"ready",restored:e};return t.isCurrent()&&(h(n),M(n)),n},K=async e=>{if(e===void 0)return{kind:"skip"};if(!z(e))return{kind:"remove",error:Q()};if(r.maxAge!==void 0&&Date.now()-e.timestamp>r.maxAge)return{kind:"remove"};if(e.storageVersion===r.storageVersion)return{kind:"hydrate",snapshot:e.snapshot,writeBack:!1};if(!r.migrate)return{kind:"remove"};let t=await r.migrate(e);return t?{kind:"hydrate",snapshot:t,writeBack:!0}:{kind:"remove"}},U=async e=>e.kind==="skip"?!1:e.kind==="remove"?(e.error!==void 0&&g(e.error,"restore"),await r.storage.remove(),!1):(s.hydrate(e.snapshot,{strategy:S}),!0),V=async e=>{let t=p.isActive();return p.run(async n=>{t||(u=!1),h(q);let o=!1,T=!1;try{let A=await n.step(()=>r.storage.get()),C=await n.step(()=>K(A));o=await n.step(()=>U(C)),T=C.kind==="hydrate"&&C.writeBack}catch(A){return x(A,n,e,"restore"),i}let b=H(o,n);return await j(T,n,e),b})},I=()=>{V("background")},W=(e,t,n)=>{try{return r.shouldSave?.({prevState:e,currentState:t,action:n})??!0}catch(o){return h({phase:"error",error:o}),g(o,"save"),!1}},Y=(e,t,n)=>{if(n.type!==G&&W(e,t,n)){if(p.isActive()){u=!0;return}_()}};return{start:()=>{m+=1,m===1&&(k=s.onTransition((t,n,o)=>{Y(t,n,o)}),P=r.storage.subscribe?.(I),I());let e=!1;return()=>{e||(e=!0,m-=1,!(m>0)&&(E(),k?.(),P?.(),k=void 0,P=void 0,h(J)))}},restore:()=>V("direct"),save:async()=>{R(),await v("direct")},flush:async()=>{if(d){await v("direct");return}await a},clear:async()=>{let e=a;E();try{await e?.catch(()=>{}),await r.storage.remove(),h({phase:"ready",restored:!1})}catch(t){throw h({phase:"error",error:t}),g(t,"clear"),t}},getStatus:()=>i,subscribeStatus:e=>(c.push(e),()=>{c=c.filter(t=>t!==e)})}},ie=({key:s,storage:r})=>({get:()=>{let l=r().getItem(s);return l==null?void 0:JSON.parse(l)},set:l=>{r().setItem(s,JSON.stringify(l))},remove:()=>{r().removeItem(s)}});export{ie as createJsonStorage,oe as persistManager};
|
package/dist/react.cjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
"use strict";"use client";var P=Object.create;var
|
|
1
|
+
"use strict";"use client";var P=Object.create;var u=Object.defineProperty;var h=Object.getOwnPropertyDescriptor;var y=Object.getOwnPropertyNames;var E=Object.getPrototypeOf,b=Object.prototype.hasOwnProperty;var d=(t,s)=>{for(var e in s)u(t,e,{get:s[e],enumerable:!0})},S=(t,s,e,o)=>{if(s&&typeof s=="object"||typeof s=="function")for(let r of y(s))!b.call(t,r)&&r!==e&&u(t,r,{get:()=>s[r],enumerable:!(o=h(s,r))||o.enumerable});return t};var m=(t,s,e)=>(e=t!=null?P(E(t)):{},S(s||!t||!t.__esModule?u(e,"default",{value:t,enumerable:!0}):e,t)),g=t=>S(u({},"__esModule",{value:!0}),t);var I={};d(I,{useIsPersistRestoring:()=>v,usePersistStatuses:()=>p});module.exports=g(I);var a=m(require("react"),1),f=require("use-sync-external-store/shim"),i=Symbol.for("@lite-fsm/react.persistStatusesContext"),x="Hooks from @lite-fsm/persist/react require FSMContextProvider from @lite-fsm/react.",T=[],l=globalThis,R=l[i]??(l[i]=a.default.createContext(null)),c=t=>{if(t.length===0)return T;let s=[];for(let e of t)s.push(e===null?null:e.getStatus());return s},C=(t,s)=>{if(t.length!==s.length)return!1;for(let e=0;e<t.length;e+=1)if(!Object.is(t[e],s[e]))return!1;return!0},_=t=>{let s=c(t),e=()=>{let o=c(t);return C(s,o)?!1:(s=o,!0)};return{getSnapshot:()=>s,getServerSnapshot:()=>s,subscribe:o=>{let r=[];for(let n of t)n!==null&&r.push(n.subscribeStatus(()=>{e()&&o()}));return()=>{for(let n of r)n()}}}},p=()=>{let t=a.default.useContext(R);if(t===null)throw new Error(x);let s=a.default.useMemo(()=>_(t),[t]);return(0,f.useSyncExternalStore)(s.subscribe,s.getSnapshot,s.getServerSnapshot)},v=()=>p().some(s=>s?.phase==="restoring");0&&(module.exports={useIsPersistRestoring,usePersistStatuses});
|
package/dist/react.d.cts
CHANGED
|
@@ -1,3 +1,5 @@
|
|
|
1
|
-
import type {
|
|
2
|
-
|
|
3
|
-
export declare const
|
|
1
|
+
import type { PersistStatus } from "./index";
|
|
2
|
+
type PersistStatusesSnapshot = readonly (PersistStatus | null)[];
|
|
3
|
+
export declare const usePersistStatuses: () => PersistStatusesSnapshot;
|
|
4
|
+
export declare const useIsPersistRestoring: () => boolean;
|
|
5
|
+
export {};
|
package/dist/react.d.ts
CHANGED
|
@@ -1,3 +1,5 @@
|
|
|
1
|
-
import type {
|
|
2
|
-
|
|
3
|
-
export declare const
|
|
1
|
+
import type { PersistStatus } from "./index";
|
|
2
|
+
type PersistStatusesSnapshot = readonly (PersistStatus | null)[];
|
|
3
|
+
export declare const usePersistStatuses: () => PersistStatusesSnapshot;
|
|
4
|
+
export declare const useIsPersistRestoring: () => boolean;
|
|
5
|
+
export {};
|
package/dist/react.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
"use client";import n from"react";import{useSyncExternalStore as
|
|
1
|
+
"use client";import n from"react";import{useSyncExternalStore as l}from"use-sync-external-store/shim";var a=Symbol.for("@lite-fsm/react.persistStatusesContext"),c="Hooks from @lite-fsm/persist/react require FSMContextProvider from @lite-fsm/react.",f=[],S=globalThis,p=S[a]??(S[a]=n.createContext(null)),i=s=>{if(s.length===0)return f;let t=[];for(let e of s)t.push(e===null?null:e.getStatus());return t},P=(s,t)=>{if(s.length!==t.length)return!1;for(let e=0;e<s.length;e+=1)if(!Object.is(s[e],t[e]))return!1;return!0},h=s=>{let t=i(s),e=()=>{let r=i(s);return P(t,r)?!1:(t=r,!0)};return{getSnapshot:()=>t,getServerSnapshot:()=>t,subscribe:r=>{let u=[];for(let o of s)o!==null&&u.push(o.subscribeStatus(()=>{e()&&r()}));return()=>{for(let o of u)o()}}}},y=()=>{let s=n.useContext(p);if(s===null)throw new Error(c);let t=n.useMemo(()=>h(s),[s]);return l(t.subscribe,t.getSnapshot,t.getServerSnapshot)},d=()=>y().some(t=>t?.phase==="restoring");export{d as useIsPersistRestoring,y as usePersistStatuses};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@lite-fsm/persist",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.5",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "Persistence helpers for lite-fsm",
|
|
6
6
|
"license": "MIT",
|
|
@@ -70,7 +70,7 @@
|
|
|
70
70
|
},
|
|
71
71
|
"dependencies": {
|
|
72
72
|
"use-sync-external-store": ">=1.2.0",
|
|
73
|
-
"@lite-fsm/core": "2.0.
|
|
73
|
+
"@lite-fsm/core": "2.0.5"
|
|
74
74
|
},
|
|
75
75
|
"peerDependencies": {
|
|
76
76
|
"react": ">=18.0.0"
|