@lite-fsm/persist 1.0.0
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/LICENSE +21 -0
- package/dist/index.cjs +1 -0
- package/dist/index.d.cts +68 -0
- package/dist/index.d.ts +68 -0
- package/dist/index.js +1 -0
- package/dist/react.cjs +1 -0
- package/dist/react.d.cts +3 -0
- package/dist/react.d.ts +3 -0
- package/dist/react.js +1 -0
- package/dist/taskScope.d.cts +49 -0
- package/dist/taskScope.d.ts +49 -0
- package/package.json +87 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2023 AlexanderGureev
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/dist/index.cjs
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
"use strict";var x=Object.defineProperty;var G=Object.getOwnPropertyDescriptor;var q=Object.getOwnPropertyNames;var z=Object.prototype.hasOwnProperty;var Q=(r,t)=>{for(var i in t)x(r,i,{get:t[i],enumerable:!0})},X=(r,t,i,d)=>{if(t&&typeof t=="object"||typeof t=="function")for(let a of q(t))!z.call(r,a)&&a!==i&&x(r,a,{get:()=>t[a],enumerable:!(d=G(t,a))||d.enumerable});return r};var Z=r=>X(x({},"__esModule",{value:!0}),r);var ie={};Q(ie,{createJsonStorage:()=>oe,persistManager:()=>ae});module.exports=Z(ie);var O=Symbol("lite-fsm.taskCancelled"),$=()=>Object.assign(new Error("[lite-fsm] task was cancelled."),{[O]:!0}),L=r=>r instanceof Error&&O in r,B=()=>{let r=0,t=new Set;return{latest:()=>{let d=0,a=-1,u=-1;t.add(()=>{a=-1,u=-1});let p=()=>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,y=()=>o===r&&S===d,h=()=>{if(!y())throw $()},w=async g=>{h();let M=await g();return h(),M};k(o,S);try{return await l({isCurrent:y,checkpoint:h,step:w})}finally{P(o,S)}},isActive:p}},cancelAll:()=>{r+=1;for(let d of t)d()}}};var ee="@@lite-fsm/HYDRATE",N={phase:"idle"},te={phase:"restoring"},_=r=>r!==null&&typeof r=="object"&&!Array.isArray(r),re=r=>_(r)&&typeof r.timestamp=="number"&&_(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=N,u=[],p=0,k,P,f,l=!1,o,S=!1,y=B(),h=y.latest(),w=y.latest(),g=(e,s)=>{try{t.onError?.(e,s)}catch{}},M=e=>{try{t.onRestoreSettled?.(e)}catch{}},m=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};m(b),c==="restore"&&M(b)}if(g(e,c),n==="direct")throw e}},R=()=>{l=!1,f&&(clearTimeout(f),f=void 0)},V=()=>{y.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},J=()=>{if(l=!0,i===0){v("background");return}f||(f=setTimeout(()=>{v("background")},i))},H=async(e,s,n)=>{let c=e||S;S=!1,!(!c||!s.isCurrent())&&await v(n)},Y=(e,s)=>{let n={phase:"ready",restored:e};return s.isCurrent()&&(m(n),M(n)),n},K=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"}},U=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=h.isActive();return h.run(async n=>{s||(S=!1),m(te);let c=!1,T=!1;try{let A=await n.step(()=>t.storage.get()),C=await n.step(()=>K(A));c=await n.step(()=>U(C)),T=C.kind==="hydrate"&&C.writeBack}catch(A){return E(A,n,e,"restore"),a}let b=Y(c,n);return await H(T,n,e),b})},D=()=>{I("background")},W=(e,s,n)=>{try{return t.shouldSave?.({prevState:e,currentState:s,action:n})??!0}catch(c){return m({phase:"error",error:c}),g(c,"save"),!1}},F=(e,s,n)=>{if(n.type!==ee&&W(e,s,n)){if(h.isActive()){S=!0;return}J()}};return{start:()=>{p+=1,p===1&&(k=r.onTransition((s,n,c)=>{F(s,n,c)}),P=t.storage.subscribe?.(D),D());let e=!1;return()=>{e||(e=!0,p-=1,!(p>0)&&(V(),k?.(),P?.(),k=void 0,P=void 0,m(N)))}},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(),m({phase:"ready",restored:!1})}catch(s){throw m({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
ADDED
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
import type { DehydrateOptions, HydrateStrategy, IMachineManager, MachineManagerSnapshot, MachinesState, MachineStore, ManagerCommitAction } from "@lite-fsm/core";
|
|
2
|
+
export type MaybePromise<T> = T | Promise<T>;
|
|
3
|
+
export type PersistedRecord<S extends MachineStore> = {
|
|
4
|
+
timestamp: number;
|
|
5
|
+
storageVersion?: string | number;
|
|
6
|
+
snapshot: MachineManagerSnapshot<S>;
|
|
7
|
+
};
|
|
8
|
+
export type PersistStorage<S extends MachineStore> = {
|
|
9
|
+
get(): MaybePromise<PersistedRecord<S> | undefined>;
|
|
10
|
+
set(record: PersistedRecord<S>): MaybePromise<void>;
|
|
11
|
+
remove(): MaybePromise<void>;
|
|
12
|
+
subscribe?(cb: () => void): () => void;
|
|
13
|
+
};
|
|
14
|
+
export type PersistStatus = {
|
|
15
|
+
phase: "idle";
|
|
16
|
+
} | {
|
|
17
|
+
phase: "restoring";
|
|
18
|
+
} | {
|
|
19
|
+
phase: "ready";
|
|
20
|
+
restored: boolean;
|
|
21
|
+
} | {
|
|
22
|
+
phase: "error";
|
|
23
|
+
error: unknown;
|
|
24
|
+
};
|
|
25
|
+
export type PersistRestoreSettledResult = {
|
|
26
|
+
phase: "ready";
|
|
27
|
+
restored: boolean;
|
|
28
|
+
} | {
|
|
29
|
+
phase: "error";
|
|
30
|
+
error: unknown;
|
|
31
|
+
};
|
|
32
|
+
export type PersistManagerOptions<S extends MachineStore> = {
|
|
33
|
+
storage: PersistStorage<S>;
|
|
34
|
+
machines?: DehydrateOptions<S>["machines"];
|
|
35
|
+
strategy?: HydrateStrategy;
|
|
36
|
+
storageVersion?: string | number;
|
|
37
|
+
maxAge?: number;
|
|
38
|
+
throttleMs?: number;
|
|
39
|
+
shouldSave?: (ctx: {
|
|
40
|
+
prevState: MachinesState<S>;
|
|
41
|
+
currentState: MachinesState<S>;
|
|
42
|
+
action: ManagerCommitAction<S>;
|
|
43
|
+
}) => boolean;
|
|
44
|
+
migrate?: (record: PersistedRecord<S>) => MaybePromise<MachineManagerSnapshot<S> | undefined>;
|
|
45
|
+
onRestoreSettled?: (result: PersistRestoreSettledResult) => void;
|
|
46
|
+
onError?: (err: unknown, phase: "restore" | "save" | "clear") => void;
|
|
47
|
+
};
|
|
48
|
+
export type PersistController = {
|
|
49
|
+
start(): () => void;
|
|
50
|
+
restore(): Promise<PersistStatus>;
|
|
51
|
+
save(): Promise<void>;
|
|
52
|
+
flush(): Promise<void>;
|
|
53
|
+
clear(): Promise<void>;
|
|
54
|
+
getStatus(): PersistStatus;
|
|
55
|
+
subscribeStatus(cb: () => void): () => void;
|
|
56
|
+
};
|
|
57
|
+
type PersistManagerTarget<S extends MachineStore> = Pick<IMachineManager<S, any>, "dehydrate" | "hydrate" | "onTransition">;
|
|
58
|
+
type JsonStorageLike = {
|
|
59
|
+
getItem(key: string): string | null;
|
|
60
|
+
setItem(key: string, value: string): void;
|
|
61
|
+
removeItem(key: string): void;
|
|
62
|
+
};
|
|
63
|
+
export declare const persistManager: <S extends MachineStore>(manager: PersistManagerTarget<S>, options: PersistManagerOptions<S>) => PersistController;
|
|
64
|
+
export declare const createJsonStorage: <S extends MachineStore>({ key, storage, }: {
|
|
65
|
+
key: string;
|
|
66
|
+
storage: JsonStorageLike;
|
|
67
|
+
}) => PersistStorage<S>;
|
|
68
|
+
export {};
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
import type { DehydrateOptions, HydrateStrategy, IMachineManager, MachineManagerSnapshot, MachinesState, MachineStore, ManagerCommitAction } from "@lite-fsm/core";
|
|
2
|
+
export type MaybePromise<T> = T | Promise<T>;
|
|
3
|
+
export type PersistedRecord<S extends MachineStore> = {
|
|
4
|
+
timestamp: number;
|
|
5
|
+
storageVersion?: string | number;
|
|
6
|
+
snapshot: MachineManagerSnapshot<S>;
|
|
7
|
+
};
|
|
8
|
+
export type PersistStorage<S extends MachineStore> = {
|
|
9
|
+
get(): MaybePromise<PersistedRecord<S> | undefined>;
|
|
10
|
+
set(record: PersistedRecord<S>): MaybePromise<void>;
|
|
11
|
+
remove(): MaybePromise<void>;
|
|
12
|
+
subscribe?(cb: () => void): () => void;
|
|
13
|
+
};
|
|
14
|
+
export type PersistStatus = {
|
|
15
|
+
phase: "idle";
|
|
16
|
+
} | {
|
|
17
|
+
phase: "restoring";
|
|
18
|
+
} | {
|
|
19
|
+
phase: "ready";
|
|
20
|
+
restored: boolean;
|
|
21
|
+
} | {
|
|
22
|
+
phase: "error";
|
|
23
|
+
error: unknown;
|
|
24
|
+
};
|
|
25
|
+
export type PersistRestoreSettledResult = {
|
|
26
|
+
phase: "ready";
|
|
27
|
+
restored: boolean;
|
|
28
|
+
} | {
|
|
29
|
+
phase: "error";
|
|
30
|
+
error: unknown;
|
|
31
|
+
};
|
|
32
|
+
export type PersistManagerOptions<S extends MachineStore> = {
|
|
33
|
+
storage: PersistStorage<S>;
|
|
34
|
+
machines?: DehydrateOptions<S>["machines"];
|
|
35
|
+
strategy?: HydrateStrategy;
|
|
36
|
+
storageVersion?: string | number;
|
|
37
|
+
maxAge?: number;
|
|
38
|
+
throttleMs?: number;
|
|
39
|
+
shouldSave?: (ctx: {
|
|
40
|
+
prevState: MachinesState<S>;
|
|
41
|
+
currentState: MachinesState<S>;
|
|
42
|
+
action: ManagerCommitAction<S>;
|
|
43
|
+
}) => boolean;
|
|
44
|
+
migrate?: (record: PersistedRecord<S>) => MaybePromise<MachineManagerSnapshot<S> | undefined>;
|
|
45
|
+
onRestoreSettled?: (result: PersistRestoreSettledResult) => void;
|
|
46
|
+
onError?: (err: unknown, phase: "restore" | "save" | "clear") => void;
|
|
47
|
+
};
|
|
48
|
+
export type PersistController = {
|
|
49
|
+
start(): () => void;
|
|
50
|
+
restore(): Promise<PersistStatus>;
|
|
51
|
+
save(): Promise<void>;
|
|
52
|
+
flush(): Promise<void>;
|
|
53
|
+
clear(): Promise<void>;
|
|
54
|
+
getStatus(): PersistStatus;
|
|
55
|
+
subscribeStatus(cb: () => void): () => void;
|
|
56
|
+
};
|
|
57
|
+
type PersistManagerTarget<S extends MachineStore> = Pick<IMachineManager<S, any>, "dehydrate" | "hydrate" | "onTransition">;
|
|
58
|
+
type JsonStorageLike = {
|
|
59
|
+
getItem(key: string): string | null;
|
|
60
|
+
setItem(key: string, value: string): void;
|
|
61
|
+
removeItem(key: string): void;
|
|
62
|
+
};
|
|
63
|
+
export declare const persistManager: <S extends MachineStore>(manager: PersistManagerTarget<S>, options: PersistManagerOptions<S>) => PersistController;
|
|
64
|
+
export declare const createJsonStorage: <S extends MachineStore>({ key, storage, }: {
|
|
65
|
+
key: string;
|
|
66
|
+
storage: JsonStorageLike;
|
|
67
|
+
}) => PersistStorage<S>;
|
|
68
|
+
export {};
|
package/dist/index.js
ADDED
|
@@ -0,0 +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 p=()=>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,y=()=>a===s&&u===S,h=()=>{if(!y())throw F()},w=async g=>{h();let M=await g();return h(),M};k(a,u);try{return await d({isCurrent:y,checkpoint:h,step:w})}finally{P(a,u)}},isActive:p}},cancelAll:()=>{s+=1;for(let S of r)S()}}};var G="@@lite-fsm/HYDRATE",B={phase:"idle"},q={phase:"restoring"},N=s=>s!==null&&typeof s=="object"&&!Array.isArray(s),z=s=>N(s)&&typeof s.timestamp=="number"&&N(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,ae=(s,r)=>{let l=r.throttleMs??0,S=r.strategy??"merge",i=B,c=[],p=0,k,P,f,d=!1,a,u=!1,y=L(),h=y.latest(),w=y.latest(),g=(e,t)=>{try{r.onError?.(e,t)}catch{}},M=e=>{try{r.onRestoreSettled?.(e)}catch{}},m=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};m(b),o==="restore"&&M(b)}if(g(e,o),n==="direct")throw e}},R=()=>{d=!1,f&&(clearTimeout(f),f=void 0)},E=()=>{y.cancelAll(),u=!1,a=void 0,R()},_=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=_(e).finally(()=>{a===t&&(a=void 0)});return a=t,t},j=()=>{if(d=!0,l===0){v("background");return}f||(f=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()&&(m(n),M(n)),n},Y=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"}},K=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=h.isActive();return h.run(async n=>{t||(u=!1),m(q);let o=!1,T=!1;try{let A=await n.step(()=>r.storage.get()),C=await n.step(()=>Y(A));o=await n.step(()=>K(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")},U=(e,t,n)=>{try{return r.shouldSave?.({prevState:e,currentState:t,action:n})??!0}catch(o){return m({phase:"error",error:o}),g(o,"save"),!1}},W=(e,t,n)=>{if(n.type!==G&&U(e,t,n)){if(h.isActive()){u=!0;return}j()}};return{start:()=>{p+=1,p===1&&(k=s.onTransition((t,n,o)=>{W(t,n,o)}),P=r.storage.subscribe?.(I),I());let e=!1;return()=>{e||(e=!0,p-=1,!(p>0)&&(E(),k?.(),P?.(),k=void 0,P=void 0,m(B)))}},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(),m({phase:"ready",restored:!1})}catch(t){throw m({phase:"error",error:t}),g(t,"clear"),t}},getStatus:()=>i,subscribeStatus:e=>(c.push(e),()=>{c=c.filter(t=>t!==e)})}},oe=({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{oe as createJsonStorage,ae as persistManager};
|
package/dist/react.cjs
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
"use strict";"use client";var o=Object.defineProperty;var a=Object.getOwnPropertyDescriptor;var S=Object.getOwnPropertyNames;var P=Object.prototype.hasOwnProperty;var p=(t,s)=>{for(var r in s)o(t,r,{get:s[r],enumerable:!0})},l=(t,s,r,i)=>{if(s&&typeof s=="object"||typeof s=="function")for(let e of S(s))!P.call(t,e)&&e!==r&&o(t,e,{get:()=>s[e],enumerable:!(i=a(s,e))||i.enumerable});return t};var g=t=>l(o({},"__esModule",{value:!0}),t);var x={};p(x,{useIsPersistRestoring:()=>m,usePersistStatus:()=>n});module.exports=g(x);var u=require("use-sync-external-store/shim"),n=t=>(0,u.useSyncExternalStore)(t.subscribeStatus,t.getStatus,t.getStatus),m=t=>n(t).phase==="restoring";0&&(module.exports={useIsPersistRestoring,usePersistStatus});
|
package/dist/react.d.cts
ADDED
package/dist/react.d.ts
ADDED
package/dist/react.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
"use client";import{useSyncExternalStore as s}from"use-sync-external-store/shim";var e=t=>s(t.subscribeStatus,t.getStatus,t.getStatus),o=t=>e(t).phase==="restoring";export{o as useIsPersistRestoring,e as usePersistStatus};
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
type MaybePromise<T> = T | Promise<T>;
|
|
2
|
+
declare const TASK_CANCELLED: unique symbol;
|
|
3
|
+
export type TaskCancelledError = Error & {
|
|
4
|
+
readonly [TASK_CANCELLED]: true;
|
|
5
|
+
};
|
|
6
|
+
/**
|
|
7
|
+
* Runtime-контекст одной логической task.
|
|
8
|
+
*
|
|
9
|
+
* `checkpoint()` бросает внутреннюю ошибку отмены, если task больше не актуальна
|
|
10
|
+
* в своём канале задач или если родительский scope был отменён. `step()`
|
|
11
|
+
* оборачивает одну sync/async операцию checkpoint-ами до и после выполнения.
|
|
12
|
+
*/
|
|
13
|
+
export type TaskContext = {
|
|
14
|
+
isCurrent(): boolean;
|
|
15
|
+
checkpoint(): void;
|
|
16
|
+
step<T>(fn: () => MaybePromise<T>): Promise<T>;
|
|
17
|
+
};
|
|
18
|
+
/**
|
|
19
|
+
* `takeLatest`-канал внутри task scope.
|
|
20
|
+
*
|
|
21
|
+
* Новый `run()` делает предыдущий run в этом канале устаревшим. Устаревшие runs
|
|
22
|
+
* не отменяются на уровне IO; их следующий `checkpoint()` / `step()` отклоняется,
|
|
23
|
+
* чтобы вызывающий код пропустил stale side-effects.
|
|
24
|
+
*/
|
|
25
|
+
export type LatestTask = {
|
|
26
|
+
run<T>(fn: (task: TaskContext) => MaybePromise<T>): Promise<T>;
|
|
27
|
+
isActive(): boolean;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Группирует каналы задач под одним lifecycle.
|
|
31
|
+
*
|
|
32
|
+
* `latest()` создаёт независимые `takeLatest`-каналы. `cancelAll()` разом делает
|
|
33
|
+
* все каналы устаревшими, например при stop/clear. Это только логическая отмена:
|
|
34
|
+
* underlying promises продолжают выполняться, если их собственный API не
|
|
35
|
+
* поддерживает cancellation.
|
|
36
|
+
*/
|
|
37
|
+
export type TaskScope = {
|
|
38
|
+
latest(): LatestTask;
|
|
39
|
+
cancelAll(): void;
|
|
40
|
+
};
|
|
41
|
+
export declare const isTaskCancelledError: (err: unknown) => err is TaskCancelledError;
|
|
42
|
+
/**
|
|
43
|
+
* Создаёт маленький scope логической отмены для async orchestration.
|
|
44
|
+
*
|
|
45
|
+
* Helper прячет generation-token checks за `run`, `checkpoint` и `step`, чтобы
|
|
46
|
+
* вызывающий код описывал flow операции, а не ручные stale guards.
|
|
47
|
+
*/
|
|
48
|
+
export declare const createTaskScope: () => TaskScope;
|
|
49
|
+
export {};
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
type MaybePromise<T> = T | Promise<T>;
|
|
2
|
+
declare const TASK_CANCELLED: unique symbol;
|
|
3
|
+
export type TaskCancelledError = Error & {
|
|
4
|
+
readonly [TASK_CANCELLED]: true;
|
|
5
|
+
};
|
|
6
|
+
/**
|
|
7
|
+
* Runtime-контекст одной логической task.
|
|
8
|
+
*
|
|
9
|
+
* `checkpoint()` бросает внутреннюю ошибку отмены, если task больше не актуальна
|
|
10
|
+
* в своём канале задач или если родительский scope был отменён. `step()`
|
|
11
|
+
* оборачивает одну sync/async операцию checkpoint-ами до и после выполнения.
|
|
12
|
+
*/
|
|
13
|
+
export type TaskContext = {
|
|
14
|
+
isCurrent(): boolean;
|
|
15
|
+
checkpoint(): void;
|
|
16
|
+
step<T>(fn: () => MaybePromise<T>): Promise<T>;
|
|
17
|
+
};
|
|
18
|
+
/**
|
|
19
|
+
* `takeLatest`-канал внутри task scope.
|
|
20
|
+
*
|
|
21
|
+
* Новый `run()` делает предыдущий run в этом канале устаревшим. Устаревшие runs
|
|
22
|
+
* не отменяются на уровне IO; их следующий `checkpoint()` / `step()` отклоняется,
|
|
23
|
+
* чтобы вызывающий код пропустил stale side-effects.
|
|
24
|
+
*/
|
|
25
|
+
export type LatestTask = {
|
|
26
|
+
run<T>(fn: (task: TaskContext) => MaybePromise<T>): Promise<T>;
|
|
27
|
+
isActive(): boolean;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Группирует каналы задач под одним lifecycle.
|
|
31
|
+
*
|
|
32
|
+
* `latest()` создаёт независимые `takeLatest`-каналы. `cancelAll()` разом делает
|
|
33
|
+
* все каналы устаревшими, например при stop/clear. Это только логическая отмена:
|
|
34
|
+
* underlying promises продолжают выполняться, если их собственный API не
|
|
35
|
+
* поддерживает cancellation.
|
|
36
|
+
*/
|
|
37
|
+
export type TaskScope = {
|
|
38
|
+
latest(): LatestTask;
|
|
39
|
+
cancelAll(): void;
|
|
40
|
+
};
|
|
41
|
+
export declare const isTaskCancelledError: (err: unknown) => err is TaskCancelledError;
|
|
42
|
+
/**
|
|
43
|
+
* Создаёт маленький scope логической отмены для async orchestration.
|
|
44
|
+
*
|
|
45
|
+
* Helper прячет generation-token checks за `run`, `checkpoint` и `step`, чтобы
|
|
46
|
+
* вызывающий код описывал flow операции, а не ручные stale guards.
|
|
47
|
+
*/
|
|
48
|
+
export declare const createTaskScope: () => TaskScope;
|
|
49
|
+
export {};
|
package/package.json
ADDED
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@lite-fsm/persist",
|
|
3
|
+
"version": "1.0.0",
|
|
4
|
+
"type": "module",
|
|
5
|
+
"description": "Persistence helpers for lite-fsm",
|
|
6
|
+
"license": "MIT",
|
|
7
|
+
"publishConfig": {
|
|
8
|
+
"access": "public"
|
|
9
|
+
},
|
|
10
|
+
"main": "./dist/index.cjs",
|
|
11
|
+
"module": "./dist/index.js",
|
|
12
|
+
"types": "./dist/index.d.ts",
|
|
13
|
+
"sideEffects": false,
|
|
14
|
+
"exports": {
|
|
15
|
+
"./package.json": "./package.json",
|
|
16
|
+
".": {
|
|
17
|
+
"import": {
|
|
18
|
+
"types": "./dist/index.d.ts",
|
|
19
|
+
"default": "./dist/index.js"
|
|
20
|
+
},
|
|
21
|
+
"require": {
|
|
22
|
+
"types": "./dist/index.d.cts",
|
|
23
|
+
"default": "./dist/index.cjs"
|
|
24
|
+
}
|
|
25
|
+
},
|
|
26
|
+
"./react": {
|
|
27
|
+
"import": {
|
|
28
|
+
"types": "./dist/react.d.ts",
|
|
29
|
+
"default": "./dist/react.js"
|
|
30
|
+
},
|
|
31
|
+
"require": {
|
|
32
|
+
"types": "./dist/react.d.cts",
|
|
33
|
+
"default": "./dist/react.cjs"
|
|
34
|
+
}
|
|
35
|
+
}
|
|
36
|
+
},
|
|
37
|
+
"typesVersions": {
|
|
38
|
+
"*": {
|
|
39
|
+
"*": [
|
|
40
|
+
"dist/index.d.ts"
|
|
41
|
+
],
|
|
42
|
+
"react": [
|
|
43
|
+
"dist/react.d.ts"
|
|
44
|
+
]
|
|
45
|
+
}
|
|
46
|
+
},
|
|
47
|
+
"files": [
|
|
48
|
+
"dist"
|
|
49
|
+
],
|
|
50
|
+
"keywords": [
|
|
51
|
+
"lite-fsm",
|
|
52
|
+
"fsm",
|
|
53
|
+
"finite-state-machine",
|
|
54
|
+
"persistence",
|
|
55
|
+
"storage",
|
|
56
|
+
"hydration",
|
|
57
|
+
"localstorage",
|
|
58
|
+
"react",
|
|
59
|
+
"state-management",
|
|
60
|
+
"lightweight",
|
|
61
|
+
"typescript"
|
|
62
|
+
],
|
|
63
|
+
"repository": {
|
|
64
|
+
"type": "git",
|
|
65
|
+
"url": "git+https://github.com/AlexanderGureev/lite-fsm.git",
|
|
66
|
+
"directory": "packages/persist"
|
|
67
|
+
},
|
|
68
|
+
"engines": {
|
|
69
|
+
"node": ">=16"
|
|
70
|
+
},
|
|
71
|
+
"dependencies": {
|
|
72
|
+
"use-sync-external-store": ">=1.2.0",
|
|
73
|
+
"@lite-fsm/core": "2.0.0"
|
|
74
|
+
},
|
|
75
|
+
"peerDependencies": {
|
|
76
|
+
"react": ">=18.0.0"
|
|
77
|
+
},
|
|
78
|
+
"peerDependenciesMeta": {
|
|
79
|
+
"react": {
|
|
80
|
+
"optional": true
|
|
81
|
+
}
|
|
82
|
+
},
|
|
83
|
+
"scripts": {
|
|
84
|
+
"build": "tsup --config tsup.config.ts && tsc -p tsconfig.build.json && node ../../scripts/dts-to-dcts.mjs dist",
|
|
85
|
+
"check-types": "tsc --noEmit -p tsconfig.json"
|
|
86
|
+
}
|
|
87
|
+
}
|