@lite-fsm/core 2.0.4 → 2.1.0-alpha.0

package/dist/types.d.cts

@@ -15,9 +15,14 @@ export type FSMEventMeta = {
     senderGroupId?: string;
     senderGroupTag?: string;
 };
-export type ManagerAction<P extends AnyEvent> = P & {
-    meta?: FSMEventMeta;
-};
+export type CoreActionMeta = FSMEventMeta;
+export type ManagerAction<P extends AnyEvent, Meta extends object = CoreActionMeta> = P & {
+    meta?: Meta;
+};
+type DeepReadonly<Value> = Value extends (...args: any[]) => unknown ? Value : Value extends object ? {
+    readonly [Key in keyof Value]: DeepReadonly<Value[Key]>;
+} : Value;
+export type ReadonlyManagerAction<Events extends AnyEvent, Meta extends object = CoreActionMeta> = DeepReadonly<ManagerAction<Events, Meta>>;
 export type ActorMeta = {
     actorId: string;
     groupId: string;
@@ -99,14 +104,14 @@ export type HydrateAction<S extends MachineStore> = {
     };
 };
 export type ManagerCommitAction<S extends MachineStore, P extends AnyEvent = AnyEvent> = P | HydrateAction<S>;
-export type MiddlewareApi<S, P extends AnyEvent = AnyEvent> = {
+export type MiddlewareApi<S, P extends AnyEvent = AnyEvent, Meta extends object = CoreActionMeta> = {
     getState: () => S;
-    transition: (action: ManagerAction<P>) => ManagerAction<P>;
-    replaceReducer: (cb: (reducer: Reducer<S, ManagerAction<P>>) => Reducer<S, ManagerAction<P>>) => void;
+    transition: (action: ManagerAction<P, Meta>) => ManagerAction<P, Meta>;
+    replaceReducer: (cb: (reducer: Reducer<S, ManagerAction<P, Meta>>) => Reducer<S, ManagerAction<P, Meta>>) => void;
     onTransition: (cb: (prevState: S, currentState: S, action: ManagerCommitAction<MachineStore, AnyEvent>) => void) => () => void;
-    condition: (predicate: (a: ManagerAction<P>) => boolean) => Promise<boolean>;
+    condition: (predicate: (a: ManagerAction<P, Meta>) => boolean) => Promise<boolean>;
 };
-export type Middleware<S = unknown, P extends AnyEvent = AnyEvent> = (api: MiddlewareApi<S, P>) => (next: (action: ManagerAction<P>) => ManagerAction<P>) => (action: ManagerAction<P>) => ManagerAction<P>;
+export type Middleware<S = unknown, P extends AnyEvent = AnyEvent, Meta extends object = CoreActionMeta> = (api: MiddlewareApi<S, P, Meta>) => (next: (action: ManagerAction<P, Meta>) => ManagerAction<P, Meta>) => (action: ManagerAction<P, Meta>) => ManagerAction<P, Meta>;
 export type GenericMiddleware = <S, P extends AnyEvent>(api: MiddlewareApi<S, P>) => (next: (action: P) => P) => (action: P) => P;
 export type VoidReducerMiddleware = GenericMiddleware & {
     __liteFsmAllowVoidReducer: true;
@@ -148,7 +153,9 @@ export type ActorDefaultDeps<N extends SType, C extends object, P extends AnyEve
 };
 export type MachineEffect<N extends SType = WILDCARD, C extends object = Record<string, never>, P extends AnyEvent = AnyEvent, D extends AnyRecord = {}> = (deps: D & (HasLiteralInit<C> extends true ? ActorDefaultDeps<N, C, P> : DefaultDeps<N, C, P>)) => Promise<void> | void;
 export type EffectStateName<C extends object> = HasLiteralInit<C> extends true ? ActorPublicState<C> | WILDCARD : StateName<C> | WILDCARD;
+type CoreStorageKind = "instance";
 type BaseMachineConfig<C extends object, T extends AnyRecord, P extends AnyEvent, D extends AnyRecord> = {
+    storage?: CoreStorageKind;
     config: C;
     initialState: StateName<C>;
     initialContext: T;
@@ -177,6 +184,7 @@ type ActorPersistenceConfig<C extends object, T extends AnyRecord, Snapshot> = {
 });
 export type MachineConfig<C extends object, T extends AnyRecord, P extends AnyEvent, D extends AnyRecord = {}, Snapshot = HasLiteralInit<C> extends true ? DefaultActorSnapshot<C, T> : StateType<C, T>> = BaseMachineConfig<C, T, P, D> & (HasLiteralInit<C> extends true ? ActorPersistenceConfig<C, T, Snapshot> : DomainPersistenceConfig<C, T, Snapshot>);
 type AnyMachineConfig = {
+    storage?: unknown;
     config: object;
     initialState: string;
     initialContext: AnyRecord;
@@ -192,13 +200,25 @@ export type IsActorTemplate<M> = M extends {
     config: infer C extends object;
 } ? HasLiteralInit<C> : false;
 type ActorRuntimeRecord<C extends object, T extends AnyRecord> = Record<string, PublicActorSlice<C, T>>;
-export type MachineSliceState<M> = M extends {
+export type MachineRuntimeMetadata<M> = M extends {
+    readonly __liteFsmRuntime?: infer Metadata;
+} ? NonNullable<Metadata> : {};
+export type MachineResultMetadata<M> = MachineRuntimeMetadata<M> extends {
+    readonly resultMetadata: infer Metadata;
+} ? Metadata : {};
+type MachinePublicStateOverride<M> = MachineRuntimeMetadata<M> extends {
+    readonly publicState: infer PublicState;
+} ? PublicState : never;
+type DefaultMachineSliceState<M> = M extends {
     config: infer C extends object;
     initialContext: infer T extends AnyRecord;
 } ? IsActorTemplate<M> extends true ? ActorRuntimeRecord<C, T> : {
     state: StateName<C>;
     context: T;
 } : never;
+export type MachineSliceState<M> = [
+    MachinePublicStateOverride<M>
+] extends [never] ? DefaultMachineSliceState<M> : MachinePublicStateOverride<M>;
 export type MachinesState<S extends MachineStore> = {
     [key in keyof S]: MachineSliceState<S[key]>;
 };
@@ -254,12 +274,14 @@ export type MachineManagerSnapshot<S extends MachineStore> = {
     machines: Partial<{
         [key in SnapshotMachineKey<S>]: SnapshotForMachine<S[key]>;
     }>;
+    storage?: Record<string, unknown>;
 };
 export type MachineManagerDehydratedSnapshot<S extends MachineStore, K extends SnapshotMachineKey<S> = SnapshotMachineKey<S>> = {
     schemaVersion?: number;
     machines: {
         [key in K]: SnapshotForMachine<S[key]>;
     };
+    storage?: Record<string, unknown>;
 };
 export type MachineManagerDehydrateResult<S extends MachineStore, Keys extends ReadonlyArray<SnapshotMachineKey<S>>> = number extends Keys["length"] ? MachineManagerSnapshot<S> : MachineManagerDehydratedSnapshot<S, Keys[number]>;
 export type MachineManagerRuntimeSnapshot<S extends MachineStore> = {
@@ -270,17 +292,20 @@ export type MachineManagerRuntimeSnapshot<S extends MachineStore> = {
 };
 export type DehydrateOptions<S extends MachineStore, K extends SnapshotMachineKey<S> = SnapshotMachineKey<S>> = {
     machines?: ReadonlyArray<K>;
+    storage?: readonly string[];
 };
 export type MachineManagerDehydrateFn<S extends MachineStore> = {
     (opts?: {
         machines?: undefined;
+        storage?: readonly string[];
     }): MachineManagerDehydratedSnapshot<S>;
     <const Keys extends ReadonlyArray<SnapshotMachineKey<S>>>(opts: {
         machines: Keys;
+        storage?: readonly string[];
     }): MachineManagerDehydrateResult<S, Keys>;
     (opts: DehydrateOptions<S>): MachineManagerSnapshot<S>;
 };
-export type TransitionSubscriber<S extends MachineStore, P extends AnyEvent = AnyEvent> = (prevState: MachinesState<S>, currentState: MachinesState<S>, action: ManagerCommitAction<S, ManagerAction<P>>) => void;
+export type TransitionSubscriber<S extends MachineStore, P extends AnyEvent = AnyEvent, Meta extends object = CoreActionMeta> = (prevState: MachinesState<S>, currentState: MachinesState<S>, action: ManagerCommitAction<S, ManagerAction<P, Meta>>) => void;
 type IsAny<T> = 0 extends 1 & T ? true : false;
 type NoPayload = {
     readonly __liteFsmNoPayload: never;

package/dist/types.d.ts

@@ -15,9 +15,14 @@ export type FSMEventMeta = {
     senderGroupId?: string;
     senderGroupTag?: string;
 };
-export type ManagerAction<P extends AnyEvent> = P & {
-    meta?: FSMEventMeta;
-};
+export type CoreActionMeta = FSMEventMeta;
+export type ManagerAction<P extends AnyEvent, Meta extends object = CoreActionMeta> = P & {
+    meta?: Meta;
+};
+type DeepReadonly<Value> = Value extends (...args: any[]) => unknown ? Value : Value extends object ? {
+    readonly [Key in keyof Value]: DeepReadonly<Value[Key]>;
+} : Value;
+export type ReadonlyManagerAction<Events extends AnyEvent, Meta extends object = CoreActionMeta> = DeepReadonly<ManagerAction<Events, Meta>>;
 export type ActorMeta = {
     actorId: string;
     groupId: string;
@@ -99,14 +104,14 @@ export type HydrateAction<S extends MachineStore> = {
     };
 };
 export type ManagerCommitAction<S extends MachineStore, P extends AnyEvent = AnyEvent> = P | HydrateAction<S>;
-export type MiddlewareApi<S, P extends AnyEvent = AnyEvent> = {
+export type MiddlewareApi<S, P extends AnyEvent = AnyEvent, Meta extends object = CoreActionMeta> = {
     getState: () => S;
-    transition: (action: ManagerAction<P>) => ManagerAction<P>;
-    replaceReducer: (cb: (reducer: Reducer<S, ManagerAction<P>>) => Reducer<S, ManagerAction<P>>) => void;
+    transition: (action: ManagerAction<P, Meta>) => ManagerAction<P, Meta>;
+    replaceReducer: (cb: (reducer: Reducer<S, ManagerAction<P, Meta>>) => Reducer<S, ManagerAction<P, Meta>>) => void;
     onTransition: (cb: (prevState: S, currentState: S, action: ManagerCommitAction<MachineStore, AnyEvent>) => void) => () => void;
-    condition: (predicate: (a: ManagerAction<P>) => boolean) => Promise<boolean>;
+    condition: (predicate: (a: ManagerAction<P, Meta>) => boolean) => Promise<boolean>;
 };
-export type Middleware<S = unknown, P extends AnyEvent = AnyEvent> = (api: MiddlewareApi<S, P>) => (next: (action: ManagerAction<P>) => ManagerAction<P>) => (action: ManagerAction<P>) => ManagerAction<P>;
+export type Middleware<S = unknown, P extends AnyEvent = AnyEvent, Meta extends object = CoreActionMeta> = (api: MiddlewareApi<S, P, Meta>) => (next: (action: ManagerAction<P, Meta>) => ManagerAction<P, Meta>) => (action: ManagerAction<P, Meta>) => ManagerAction<P, Meta>;
 export type GenericMiddleware = <S, P extends AnyEvent>(api: MiddlewareApi<S, P>) => (next: (action: P) => P) => (action: P) => P;
 export type VoidReducerMiddleware = GenericMiddleware & {
     __liteFsmAllowVoidReducer: true;
@@ -148,7 +153,9 @@ export type ActorDefaultDeps<N extends SType, C extends object, P extends AnyEve
 };
 export type MachineEffect<N extends SType = WILDCARD, C extends object = Record<string, never>, P extends AnyEvent = AnyEvent, D extends AnyRecord = {}> = (deps: D & (HasLiteralInit<C> extends true ? ActorDefaultDeps<N, C, P> : DefaultDeps<N, C, P>)) => Promise<void> | void;
 export type EffectStateName<C extends object> = HasLiteralInit<C> extends true ? ActorPublicState<C> | WILDCARD : StateName<C> | WILDCARD;
+type CoreStorageKind = "instance";
 type BaseMachineConfig<C extends object, T extends AnyRecord, P extends AnyEvent, D extends AnyRecord> = {
+    storage?: CoreStorageKind;
     config: C;
     initialState: StateName<C>;
     initialContext: T;
@@ -177,6 +184,7 @@ type ActorPersistenceConfig<C extends object, T extends AnyRecord, Snapshot> = {
 });
 export type MachineConfig<C extends object, T extends AnyRecord, P extends AnyEvent, D extends AnyRecord = {}, Snapshot = HasLiteralInit<C> extends true ? DefaultActorSnapshot<C, T> : StateType<C, T>> = BaseMachineConfig<C, T, P, D> & (HasLiteralInit<C> extends true ? ActorPersistenceConfig<C, T, Snapshot> : DomainPersistenceConfig<C, T, Snapshot>);
 type AnyMachineConfig = {
+    storage?: unknown;
     config: object;
     initialState: string;
     initialContext: AnyRecord;
@@ -192,13 +200,25 @@ export type IsActorTemplate<M> = M extends {
     config: infer C extends object;
 } ? HasLiteralInit<C> : false;
 type ActorRuntimeRecord<C extends object, T extends AnyRecord> = Record<string, PublicActorSlice<C, T>>;
-export type MachineSliceState<M> = M extends {
+export type MachineRuntimeMetadata<M> = M extends {
+    readonly __liteFsmRuntime?: infer Metadata;
+} ? NonNullable<Metadata> : {};
+export type MachineResultMetadata<M> = MachineRuntimeMetadata<M> extends {
+    readonly resultMetadata: infer Metadata;
+} ? Metadata : {};
+type MachinePublicStateOverride<M> = MachineRuntimeMetadata<M> extends {
+    readonly publicState: infer PublicState;
+} ? PublicState : never;
+type DefaultMachineSliceState<M> = M extends {
     config: infer C extends object;
     initialContext: infer T extends AnyRecord;
 } ? IsActorTemplate<M> extends true ? ActorRuntimeRecord<C, T> : {
     state: StateName<C>;
     context: T;
 } : never;
+export type MachineSliceState<M> = [
+    MachinePublicStateOverride<M>
+] extends [never] ? DefaultMachineSliceState<M> : MachinePublicStateOverride<M>;
 export type MachinesState<S extends MachineStore> = {
     [key in keyof S]: MachineSliceState<S[key]>;
 };
@@ -254,12 +274,14 @@ export type MachineManagerSnapshot<S extends MachineStore> = {
     machines: Partial<{
         [key in SnapshotMachineKey<S>]: SnapshotForMachine<S[key]>;
     }>;
+    storage?: Record<string, unknown>;
 };
 export type MachineManagerDehydratedSnapshot<S extends MachineStore, K extends SnapshotMachineKey<S> = SnapshotMachineKey<S>> = {
     schemaVersion?: number;
     machines: {
         [key in K]: SnapshotForMachine<S[key]>;
     };
+    storage?: Record<string, unknown>;
 };
 export type MachineManagerDehydrateResult<S extends MachineStore, Keys extends ReadonlyArray<SnapshotMachineKey<S>>> = number extends Keys["length"] ? MachineManagerSnapshot<S> : MachineManagerDehydratedSnapshot<S, Keys[number]>;
 export type MachineManagerRuntimeSnapshot<S extends MachineStore> = {
@@ -270,17 +292,20 @@ export type MachineManagerRuntimeSnapshot<S extends MachineStore> = {
 };
 export type DehydrateOptions<S extends MachineStore, K extends SnapshotMachineKey<S> = SnapshotMachineKey<S>> = {
     machines?: ReadonlyArray<K>;
+    storage?: readonly string[];
 };
 export type MachineManagerDehydrateFn<S extends MachineStore> = {
     (opts?: {
         machines?: undefined;
+        storage?: readonly string[];
     }): MachineManagerDehydratedSnapshot<S>;
     <const Keys extends ReadonlyArray<SnapshotMachineKey<S>>>(opts: {
         machines: Keys;
+        storage?: readonly string[];
     }): MachineManagerDehydrateResult<S, Keys>;
     (opts: DehydrateOptions<S>): MachineManagerSnapshot<S>;
 };
-export type TransitionSubscriber<S extends MachineStore, P extends AnyEvent = AnyEvent> = (prevState: MachinesState<S>, currentState: MachinesState<S>, action: ManagerCommitAction<S, ManagerAction<P>>) => void;
+export type TransitionSubscriber<S extends MachineStore, P extends AnyEvent = AnyEvent, Meta extends object = CoreActionMeta> = (prevState: MachinesState<S>, currentState: MachinesState<S>, action: ManagerCommitAction<S, ManagerAction<P, Meta>>) => void;
 type IsAny<T> = 0 extends 1 & T ? true : false;
 type NoPayload = {
     readonly __liteFsmNoPayload: never;

package/dist/utils.d.cts

@@ -11,7 +11,7 @@ export declare const HYDRATE_ACTION_TYPE = "@@lite-fsm/HYDRATE";
 export declare const VOID_REDUCER_MIDDLEWARE_MARKER = "__liteFsmAllowVoidReducer";
 export declare const VOID_REDUCER_ERROR = "Reducer returned undefined. Return the next state, or use immerMiddleware to mutate draft state without return.";
 export declare const supportsVoidReducer: (middleware: unknown) => boolean;
-export type LiteFsmErrorCode = "LITE_FSM_ACTOR_DISPOSED" | "LITE_FSM_INVALID_ACTOR_CONFIG" | "LITE_FSM_INVALID_ACTOR_SLICE" | "LITE_FSM_INVALID_GENERATED_ID" | "LITE_FSM_INVALID_HYDRATION_ENVELOPE" | "LITE_FSM_INVALID_OPTIONS" | "LITE_FSM_STANDALONE_ACTOR_TEMPLATE";
+export type LiteFsmErrorCode = "LITE_FSM_ACTOR_DISPOSED" | "LITE_FSM_AMBIGUOUS_ROUTE_META" | "LITE_FSM_DUPLICATE_MANAGER_EXTENSION_KEY" | "LITE_FSM_DUPLICATE_PLUGIN" | "LITE_FSM_DUPLICATE_ROUTE_META_KEY" | "LITE_FSM_DUPLICATE_SCOPED_EXTENSION_KEY" | "LITE_FSM_DUPLICATE_STORAGE_KIND" | "LITE_FSM_INVALID_ACTOR_CONFIG" | "LITE_FSM_INVALID_ACTOR_SLICE" | "LITE_FSM_INVALID_GENERATED_ID" | "LITE_FSM_INVALID_HYDRATION_ENVELOPE" | "LITE_FSM_INVALID_OPTIONS" | "LITE_FSM_INVALID_PLUGIN_CALLBACK_RESULT" | "LITE_FSM_INVALID_PLUGIN_DEFINITION" | "LITE_FSM_INVALID_REPLACEMENT_ACTION" | "LITE_FSM_INVALID_ROUTE_RESOLVER_RESULT" | "LITE_FSM_INVALID_SCOPED_EXTENSION" | "LITE_FSM_INVALID_STORAGE_CONFIG" | "LITE_FSM_INVALID_STORAGE_CALLBACK_RESULT" | "LITE_FSM_INVALID_STORAGE_RUNTIME" | "LITE_FSM_INVALID_STORAGE_SNAPSHOT" | "LITE_FSM_MANAGER_EXTENSION_CORE_KEY" | "LITE_FSM_MISSING_DEFAULT_STORAGE_KIND" | "LITE_FSM_MISSING_ROUTE_META_RESOLVER" | "LITE_FSM_NO_ACTIVE_DISPATCH" | "LITE_FSM_PLUGIN_REGISTRY_CLOSED" | "LITE_FSM_REENTRANT_TRANSITION_FORBIDDEN" | "LITE_FSM_SCOPED_EXTENSION_CORE_KEY" | "LITE_FSM_SCOPED_EXTENSION_OVERRIDE" | "LITE_FSM_SCOPED_EXTENSION_UNOWNED_KEY" | "LITE_FSM_UNROUTABLE_PLUGIN_ROUTE" | "LITE_FSM_UNSUPPORTED_STORAGE_SNAPSHOT" | "LITE_FSM_UNKNOWN_STORAGE_KIND" | "LITE_FSM_STANDALONE_ACTOR_TEMPLATE";
 export declare class LiteFsmError extends Error {
     readonly code: LiteFsmErrorCode;
     constructor(code: LiteFsmErrorCode, message: string);

package/dist/utils.d.ts

@@ -11,7 +11,7 @@ export declare const HYDRATE_ACTION_TYPE = "@@lite-fsm/HYDRATE";
 export declare const VOID_REDUCER_MIDDLEWARE_MARKER = "__liteFsmAllowVoidReducer";
 export declare const VOID_REDUCER_ERROR = "Reducer returned undefined. Return the next state, or use immerMiddleware to mutate draft state without return.";
 export declare const supportsVoidReducer: (middleware: unknown) => boolean;
-export type LiteFsmErrorCode = "LITE_FSM_ACTOR_DISPOSED" | "LITE_FSM_INVALID_ACTOR_CONFIG" | "LITE_FSM_INVALID_ACTOR_SLICE" | "LITE_FSM_INVALID_GENERATED_ID" | "LITE_FSM_INVALID_HYDRATION_ENVELOPE" | "LITE_FSM_INVALID_OPTIONS" | "LITE_FSM_STANDALONE_ACTOR_TEMPLATE";
+export type LiteFsmErrorCode = "LITE_FSM_ACTOR_DISPOSED" | "LITE_FSM_AMBIGUOUS_ROUTE_META" | "LITE_FSM_DUPLICATE_MANAGER_EXTENSION_KEY" | "LITE_FSM_DUPLICATE_PLUGIN" | "LITE_FSM_DUPLICATE_ROUTE_META_KEY" | "LITE_FSM_DUPLICATE_SCOPED_EXTENSION_KEY" | "LITE_FSM_DUPLICATE_STORAGE_KIND" | "LITE_FSM_INVALID_ACTOR_CONFIG" | "LITE_FSM_INVALID_ACTOR_SLICE" | "LITE_FSM_INVALID_GENERATED_ID" | "LITE_FSM_INVALID_HYDRATION_ENVELOPE" | "LITE_FSM_INVALID_OPTIONS" | "LITE_FSM_INVALID_PLUGIN_CALLBACK_RESULT" | "LITE_FSM_INVALID_PLUGIN_DEFINITION" | "LITE_FSM_INVALID_REPLACEMENT_ACTION" | "LITE_FSM_INVALID_ROUTE_RESOLVER_RESULT" | "LITE_FSM_INVALID_SCOPED_EXTENSION" | "LITE_FSM_INVALID_STORAGE_CONFIG" | "LITE_FSM_INVALID_STORAGE_CALLBACK_RESULT" | "LITE_FSM_INVALID_STORAGE_RUNTIME" | "LITE_FSM_INVALID_STORAGE_SNAPSHOT" | "LITE_FSM_MANAGER_EXTENSION_CORE_KEY" | "LITE_FSM_MISSING_DEFAULT_STORAGE_KIND" | "LITE_FSM_MISSING_ROUTE_META_RESOLVER" | "LITE_FSM_NO_ACTIVE_DISPATCH" | "LITE_FSM_PLUGIN_REGISTRY_CLOSED" | "LITE_FSM_REENTRANT_TRANSITION_FORBIDDEN" | "LITE_FSM_SCOPED_EXTENSION_CORE_KEY" | "LITE_FSM_SCOPED_EXTENSION_OVERRIDE" | "LITE_FSM_SCOPED_EXTENSION_UNOWNED_KEY" | "LITE_FSM_UNROUTABLE_PLUGIN_ROUTE" | "LITE_FSM_UNSUPPORTED_STORAGE_SNAPSHOT" | "LITE_FSM_UNKNOWN_STORAGE_KIND" | "LITE_FSM_STANDALONE_ACTOR_TEMPLATE";
 export declare class LiteFsmError extends Error {
     readonly code: LiteFsmErrorCode;
     constructor(code: LiteFsmErrorCode, message: string);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lite-fsm/core",
-  "version": "2.0.4",
+  "version": "2.1.0-alpha.0",
   "type": "module",
   "description": "Framework-agnostic runtime for lite-fsm",
   "license": "MIT",