controlled-machine 0.1.2 → 0.2.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/README.md +197 -408
- package/dist/index.cjs +8 -5
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +118 -143
- package/dist/index.d.ts +118 -143
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +8 -5
- package/dist/index.js.map +1 -1
- package/dist/react.cjs +26 -7
- package/dist/react.cjs.map +1 -1
- package/dist/react.d.cts +17 -107
- package/dist/react.d.ts +17 -107
- package/dist/react.d.ts.map +1 -0
- package/dist/react.js +27 -8
- package/dist/react.js.map +1 -1
- package/package.json +1 -1
package/dist/index.cjs
CHANGED
|
@@ -15,13 +15,14 @@ function executeActions(actionNames, actions, context, payload) {
|
|
|
15
15
|
function isRuleArray(handler) {
|
|
16
16
|
return Array.isArray(handler) && handler.length > 0 && typeof handler[0] === "object" && "do" in handler[0];
|
|
17
17
|
}
|
|
18
|
-
function executeHandler(handler, actions, context, payload) {
|
|
18
|
+
function executeHandler(handler, actions, guards, context, payload) {
|
|
19
19
|
if (typeof handler === "string" || Array.isArray(handler) && !isRuleArray(handler)) {
|
|
20
20
|
executeActions(handler, actions, context, payload);
|
|
21
21
|
return;
|
|
22
22
|
}
|
|
23
23
|
for (const rule of handler) {
|
|
24
|
-
|
|
24
|
+
const guardFn = typeof rule.when === "string" ? guards[rule.when] : rule.when;
|
|
25
|
+
if (!guardFn || guardFn(context, payload)) {
|
|
25
26
|
executeActions(rule.do, actions, context, payload);
|
|
26
27
|
break;
|
|
27
28
|
}
|
|
@@ -109,11 +110,11 @@ function createMachine(config) {
|
|
|
109
110
|
const state = context.state;
|
|
110
111
|
if (state && config.states?.[state]?.on?.[event]) {
|
|
111
112
|
const stateHandler = config.states[state].on[event];
|
|
112
|
-
executeHandler(stateHandler, config.actions ?? {}, context, payload);
|
|
113
|
+
executeHandler(stateHandler, config.actions ?? {}, config.guards ?? {}, context, payload);
|
|
113
114
|
}
|
|
114
115
|
const globalHandler = config.on?.[event];
|
|
115
116
|
if (globalHandler) {
|
|
116
|
-
executeHandler(globalHandler, config.actions ?? {}, context, payload);
|
|
117
|
+
executeHandler(globalHandler, config.actions ?? {}, config.guards ?? {}, context, payload);
|
|
117
118
|
}
|
|
118
119
|
});
|
|
119
120
|
const createEffectHelpersWithInput = (input) => ({
|
|
@@ -126,8 +127,10 @@ function createMachine(config) {
|
|
|
126
127
|
const effectHelpers = createEffectHelpersWithInput(input);
|
|
127
128
|
if (config.always && config.actions) {
|
|
128
129
|
const actionsMap = config.actions;
|
|
130
|
+
const guardsMap = config.guards ?? {};
|
|
129
131
|
for (const rule of config.always) {
|
|
130
|
-
|
|
132
|
+
const guardFn = typeof rule.when === "string" ? guardsMap[rule.when] : rule.when;
|
|
133
|
+
if (!guardFn || guardFn(context, void 0)) {
|
|
131
134
|
executeActions(rule.do, actionsMap, context, void 0);
|
|
132
135
|
break;
|
|
133
136
|
}
|
package/dist/index.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.cjs","sources":["../src/index.ts"],"sourcesContent":["/**\n * Controlled Machine\n *\n * A controlled state machine where state lives outside the machine.\n *\n * - input: External data passed in\n * - computed: Derived values from input\n * - context: input + computed (full context available in handlers)\n * - on: Event → conditional actions\n * - effects: Watch-based side effects\n * - always: Auto-evaluated rules on context change\n */\n\n// ============================================\n// Types\n// ============================================\n\nexport type Rule<\n TContext,\n TPayload = undefined,\n TActions extends string = string,\n> = {\n when?: (context: TContext, payload: TPayload) => boolean\n do: TActions | TActions[]\n}\n\nexport type Handler<\n TContext,\n TPayload = undefined,\n TActions extends string = string,\n> = TActions | TActions[] | Rule<TContext, TPayload, TActions>[]\n\n// Effect helpers - utilities available in effect callbacks\nexport type EffectHelpers<TEvents extends EventsConfig> = {\n send: Send<TEvents>\n}\n\nexport type Cleanup = () => void\n\nexport type Effect<\n TContext,\n TEvents extends EventsConfig,\n TWatched = unknown,\n> = {\n watch: (context: TContext) => TWatched\n enter?: (\n context: TContext,\n helpers: EffectHelpers<TEvents>,\n ) => void | Cleanup | Promise<void>\n exit?: (context: TContext, helpers: EffectHelpers<TEvents>) => void | Cleanup\n change?: (\n context: TContext,\n prev: TWatched | undefined,\n curr: TWatched,\n helpers: EffectHelpers<TEvents>,\n ) => void | Cleanup\n}\n\n/** Helper for inferring prev/curr types from watch return type */\nexport function effect<TContext, TEvents extends EventsConfig, TWatched>(\n config: Effect<TContext, TEvents, TWatched>,\n): Effect<TContext, TEvents, TWatched> {\n return config\n}\n\nexport type EventsConfig = Record<string, unknown>\nexport type ComputedConfig = Record<string, unknown>\n\n// ============================================\n// Object-based Generic Types\n// ============================================\n\n/**\n * Object-based generic types - specify only needed types in any order\n *\n * @example\n * createMachine<{\n * input: MyInput\n * events: MyEvents\n * actions: 'foo' | 'bar'\n * }>({...})\n */\nexport type MachineTypes = {\n input?: unknown\n events?: EventsConfig\n computed?: ComputedConfig\n actions?: string\n state?: string\n}\n\nexport type Input<T extends MachineTypes> = T['input']\nexport type Events<T extends MachineTypes> = T['events'] extends EventsConfig\n ? T['events']\n : Record<string, undefined>\nexport type Computed<T extends MachineTypes> = T['computed'] extends ComputedConfig\n ? T['computed']\n : Record<string, never>\nexport type Actions<T extends MachineTypes> = T['actions'] extends string\n ? T['actions']\n : string\nexport type State<T extends MachineTypes> = T['state'] extends string\n ? T['state']\n : string\n\n// Context = Input + Computed (full context available in handlers)\nexport type Context<T extends MachineTypes> = Input<T> & Computed<T>\n\n// State-based handler configuration\nexport type StateConfig<\n TContext,\n TEvents extends EventsConfig,\n TActions extends string = string,\n> = {\n on?: { [K in keyof TEvents]?: Handler<TContext, TEvents[K], TActions> }\n}\n\nexport type StatesConfig<\n TState extends string,\n TContext,\n TEvents extends EventsConfig,\n TActions extends string = string,\n> = {\n [K in TState]?: StateConfig<TContext, TEvents, TActions>\n}\n\nexport type Machine<T extends MachineTypes> = {\n computed?: {\n [K in keyof Computed<T>]: (input: Input<T>) => Computed<T>[K]\n }\n on?: {\n [K in keyof Events<T>]?: Handler<Context<T>, Events<T>[K], Actions<T>>\n }\n states?: StatesConfig<State<T>, Context<T>, Events<T>, Actions<T>>\n always?: Rule<Context<T>, undefined, Actions<T>>[]\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n effects?: Effect<Context<T>, Events<T>, any>[]\n actions?: {\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [K in Actions<T>]: (context: Context<T>, payload?: any) => void\n }\n}\n\nexport type Send<TEvents extends EventsConfig> = <K extends keyof TEvents>(\n event: K,\n ...args: TEvents[K] extends undefined ? [] : [payload: TEvents[K]]\n) => void\n\n// createMachine return type\nexport type MachineInstance<T extends MachineTypes> = Machine<T> & {\n send: <K extends keyof Events<T>>(\n event: K,\n input: Input<T>,\n ...args: Events<T>[K] extends undefined ? [] : [payload: Events<T>[K]]\n ) => void\n evaluate: (input: Input<T>) => void\n getComputed: (input: Input<T>) => Computed<T>\n cleanup: () => void\n}\n\n// ============================================\n// Core Logic (Pure)\n// ============================================\n\nexport function executeActions<TContext, TPayload>(\n actionNames: string | string[],\n actions: Record<string, (context: TContext, payload?: TPayload) => void>,\n context: TContext,\n payload: TPayload,\n): void {\n if (typeof actionNames === 'string') {\n actions[actionNames]?.(context, payload)\n } else {\n for (const name of actionNames) {\n actions[name]?.(context, payload)\n }\n }\n}\n\nexport function isRuleArray<TContext, TPayload, TActions extends string>(\n handler: Handler<TContext, TPayload, TActions>,\n): handler is Rule<TContext, TPayload, TActions>[] {\n return (\n Array.isArray(handler) &&\n handler.length > 0 &&\n typeof handler[0] === 'object' &&\n 'do' in handler[0]\n )\n}\n\nexport function executeHandler<TContext, TPayload>(\n handler: Handler<TContext, TPayload>,\n actions: Record<string, (context: TContext, payload?: TPayload) => void>,\n context: TContext,\n payload: TPayload,\n): void {\n // Single action or action array\n if (typeof handler === 'string' || (Array.isArray(handler) && !isRuleArray(handler))) {\n executeActions(handler as string | string[], actions, context, payload)\n return\n }\n\n // Rule array\n for (const rule of handler as Rule<TContext, TPayload>[]) {\n if (!rule.when || rule.when(context, payload)) {\n executeActions(rule.do, actions, context, payload)\n break\n }\n }\n}\n\nexport function computeValues<TContext, TComputed extends ComputedConfig>(\n context: TContext,\n computed?: { [K in keyof TComputed]: (context: TContext) => TComputed[K] },\n): TContext & TComputed {\n if (!computed) return context as TContext & TComputed\n\n const values = {} as TComputed\n for (const key in computed) {\n values[key] = computed[key](context)\n }\n return { ...context, ...values }\n}\n\n/**\n * Shallow comparison function - for composite watch support\n *\n * Arrays: length + === comparison for each element\n * Others: === comparison\n */\nexport function shallowEqual(a: unknown, b: unknown): boolean {\n if (a === b) return true\n\n // Array comparison\n if (Array.isArray(a) && Array.isArray(b)) {\n if (a.length !== b.length) return false\n return a.every((v, i) => v === b[i])\n }\n\n return false\n}\n\n// Effect store for tracking state\nexport type EffectStore = {\n watchedValues: Map<number, unknown>\n enterCleanups: Map<number, () => void>\n changeCleanups: Map<number, () => void>\n exitCleanups: Map<number, () => void>\n}\n\nexport function createEffectStore(): EffectStore {\n return {\n watchedValues: new Map(),\n enterCleanups: new Map(),\n changeCleanups: new Map(),\n exitCleanups: new Map(),\n }\n}\n\n/**\n * Common effects processing logic\n */\nexport function processEffects<TContext, TEvents extends EventsConfig>(\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n effects: Effect<TContext, TEvents, any>[] | undefined,\n context: TContext,\n effectHelpers: EffectHelpers<TEvents>,\n store: EffectStore,\n): void {\n if (!effects) return\n\n effects.forEach((effect, i) => {\n const prev = store.watchedValues.get(i)\n const curr = effect.watch(context)\n\n if (!shallowEqual(prev, curr)) {\n // cleanup previous enter\n const enterCleanup = store.enterCleanups.get(i)\n if (enterCleanup) {\n enterCleanup()\n store.enterCleanups.delete(i)\n }\n\n // cleanup previous change\n const changeCleanup = store.changeCleanups.get(i)\n if (changeCleanup) {\n changeCleanup()\n store.changeCleanups.delete(i)\n }\n\n // change callback (can return cleanup)\n const changeResult = effect.change?.(context, prev, curr, effectHelpers)\n if (typeof changeResult === 'function') {\n store.changeCleanups.set(i, changeResult)\n }\n\n // enter (falsy → truthy)\n if (!prev && curr) {\n // cleanup previous exit\n const exitCleanup = store.exitCleanups.get(i)\n if (exitCleanup) {\n exitCleanup()\n store.exitCleanups.delete(i)\n }\n\n const enterResult = effect.enter?.(context, effectHelpers)\n if (typeof enterResult === 'function') {\n store.enterCleanups.set(i, enterResult)\n }\n }\n\n // exit (truthy → falsy)\n if (prev && !curr) {\n const exitResult = effect.exit?.(context, effectHelpers)\n if (typeof exitResult === 'function') {\n store.exitCleanups.set(i, exitResult)\n }\n }\n\n store.watchedValues.set(i, curr)\n }\n })\n}\n\n/**\n * Clear effect store\n */\nexport function clearEffectStore(store: EffectStore): void {\n store.enterCleanups.forEach((fn) => fn())\n store.enterCleanups.clear()\n store.changeCleanups.forEach((fn) => fn())\n store.changeCleanups.clear()\n store.exitCleanups.forEach((fn) => fn())\n store.exitCleanups.clear()\n store.watchedValues.clear()\n}\n\n// ============================================\n// Vanilla (non-React) + Type inference helper\n// ============================================\n\nexport function createMachine<T extends MachineTypes>(\n config: Machine<T>,\n): MachineInstance<T> {\n const effectStore = createEffectStore()\n\n const send = (<K extends keyof Events<T>>(\n event: K,\n input: Input<T>,\n ...args: Events<T>[K] extends undefined ? [] : [payload: Events<T>[K]]\n ) => {\n const context = computeValues(input, config.computed)\n const payload = args[0] as Events<T>[K]\n\n // 1. State-specific handler first\n const state = (context as { state?: State<T> }).state\n if (state && config.states?.[state]?.on?.[event]) {\n const stateHandler = config.states[state].on[event]\n executeHandler(stateHandler, config.actions ?? {}, context, payload)\n }\n\n // 2. Global handler\n const globalHandler = config.on?.[event]\n if (globalHandler) {\n executeHandler(globalHandler, config.actions ?? {}, context, payload)\n }\n }) as <K extends keyof Events<T>>(\n event: K,\n input: Input<T>,\n ...args: Events<T>[K] extends undefined ? [] : [payload: Events<T>[K]]\n ) => void\n\n // vanilla send wrapper (with input binding)\n const createEffectHelpersWithInput = (input: Input<T>): EffectHelpers<Events<T>> => ({\n send: (<K extends keyof Events<T>>(\n event: K,\n ...args: Events<T>[K] extends undefined ? [] : [payload: Events<T>[K]]\n ) => {\n send(event, input, ...args)\n }) as Send<Events<T>>,\n })\n\n const evaluate = (input: Input<T>) => {\n const context = computeValues(input, config.computed)\n const effectHelpers = createEffectHelpersWithInput(input)\n\n // always\n if (config.always && config.actions) {\n const actionsMap = config.actions as Record<\n string,\n (context: Context<T>) => void\n >\n for (const rule of config.always) {\n if (!rule.when || rule.when(context, undefined)) {\n executeActions(rule.do, actionsMap, context, undefined)\n break\n }\n }\n }\n\n // effects\n processEffects(config.effects, context, effectHelpers, effectStore)\n }\n\n const getComputed = (input: Input<T>): Computed<T> => {\n const context = computeValues(input, config.computed)\n if (!config.computed) return {} as Computed<T>\n const result = {} as Computed<T>\n for (const key in config.computed) {\n result[key] = context[key]\n }\n return result\n }\n\n const cleanup = () => clearEffectStore(effectStore)\n\n return Object.assign(config, { send, evaluate, getComputed, cleanup })\n}\n"],"names":["effect"],"mappings":";;AA2DO,SAAS,OACd,QACqC;AACrC,SAAO;AACT;AAoGO,SAAS,eACd,aACA,SACA,SACA,SACM;AACN,MAAI,OAAO,gBAAgB,UAAU;AACnC,YAAQ,WAAW,IAAI,SAAS,OAAO;AAAA,EACzC,OAAO;AACL,eAAW,QAAQ,aAAa;AAC9B,cAAQ,IAAI,IAAI,SAAS,OAAO;AAAA,IAClC;AAAA,EACF;AACF;AAEO,SAAS,YACd,SACiD;AACjD,SACE,MAAM,QAAQ,OAAO,KACrB,QAAQ,SAAS,KACjB,OAAO,QAAQ,CAAC,MAAM,YACtB,QAAQ,QAAQ,CAAC;AAErB;AAEO,SAAS,eACd,SACA,SACA,SACA,SACM;AAEN,MAAI,OAAO,YAAY,YAAa,MAAM,QAAQ,OAAO,KAAK,CAAC,YAAY,OAAO,GAAI;AACpF,mBAAe,SAA8B,SAAS,SAAS,OAAO;AACtE;AAAA,EACF;AAGA,aAAW,QAAQ,SAAuC;AACxD,QAAI,CAAC,KAAK,QAAQ,KAAK,KAAK,SAAS,OAAO,GAAG;AAC7C,qBAAe,KAAK,IAAI,SAAS,SAAS,OAAO;AACjD;AAAA,IACF;AAAA,EACF;AACF;AAEO,SAAS,cACd,SACA,UACsB;AACtB,MAAI,CAAC,SAAU,QAAO;AAEtB,QAAM,SAAS,CAAA;AACf,aAAW,OAAO,UAAU;AAC1B,WAAO,GAAG,IAAI,SAAS,GAAG,EAAE,OAAO;AAAA,EACrC;AACA,SAAO,EAAE,GAAG,SAAS,GAAG,OAAA;AAC1B;AAQO,SAAS,aAAa,GAAY,GAAqB;AAC5D,MAAI,MAAM,EAAG,QAAO;AAGpB,MAAI,MAAM,QAAQ,CAAC,KAAK,MAAM,QAAQ,CAAC,GAAG;AACxC,QAAI,EAAE,WAAW,EAAE,OAAQ,QAAO;AAClC,WAAO,EAAE,MAAM,CAAC,GAAG,MAAM,MAAM,EAAE,CAAC,CAAC;AAAA,EACrC;AAEA,SAAO;AACT;AAUO,SAAS,oBAAiC;AAC/C,SAAO;AAAA,IACL,mCAAmB,IAAA;AAAA,IACnB,mCAAmB,IAAA;AAAA,IACnB,oCAAoB,IAAA;AAAA,IACpB,kCAAkB,IAAA;AAAA,EAAI;AAE1B;AAKO,SAAS,eAEd,SACA,SACA,eACA,OACM;AACN,MAAI,CAAC,QAAS;AAEd,UAAQ,QAAQ,CAACA,SAAQ,MAAM;AAC7B,UAAM,OAAO,MAAM,cAAc,IAAI,CAAC;AACtC,UAAM,OAAOA,QAAO,MAAM,OAAO;AAEjC,QAAI,CAAC,aAAa,MAAM,IAAI,GAAG;AAE7B,YAAM,eAAe,MAAM,cAAc,IAAI,CAAC;AAC9C,UAAI,cAAc;AAChB,qBAAA;AACA,cAAM,cAAc,OAAO,CAAC;AAAA,MAC9B;AAGA,YAAM,gBAAgB,MAAM,eAAe,IAAI,CAAC;AAChD,UAAI,eAAe;AACjB,sBAAA;AACA,cAAM,eAAe,OAAO,CAAC;AAAA,MAC/B;AAGA,YAAM,eAAeA,QAAO,SAAS,SAAS,MAAM,MAAM,aAAa;AACvE,UAAI,OAAO,iBAAiB,YAAY;AACtC,cAAM,eAAe,IAAI,GAAG,YAAY;AAAA,MAC1C;AAGA,UAAI,CAAC,QAAQ,MAAM;AAEjB,cAAM,cAAc,MAAM,aAAa,IAAI,CAAC;AAC5C,YAAI,aAAa;AACf,sBAAA;AACA,gBAAM,aAAa,OAAO,CAAC;AAAA,QAC7B;AAEA,cAAM,cAAcA,QAAO,QAAQ,SAAS,aAAa;AACzD,YAAI,OAAO,gBAAgB,YAAY;AACrC,gBAAM,cAAc,IAAI,GAAG,WAAW;AAAA,QACxC;AAAA,MACF;AAGA,UAAI,QAAQ,CAAC,MAAM;AACjB,cAAM,aAAaA,QAAO,OAAO,SAAS,aAAa;AACvD,YAAI,OAAO,eAAe,YAAY;AACpC,gBAAM,aAAa,IAAI,GAAG,UAAU;AAAA,QACtC;AAAA,MACF;AAEA,YAAM,cAAc,IAAI,GAAG,IAAI;AAAA,IACjC;AAAA,EACF,CAAC;AACH;AAKO,SAAS,iBAAiB,OAA0B;AACzD,QAAM,cAAc,QAAQ,CAAC,OAAO,IAAI;AACxC,QAAM,cAAc,MAAA;AACpB,QAAM,eAAe,QAAQ,CAAC,OAAO,IAAI;AACzC,QAAM,eAAe,MAAA;AACrB,QAAM,aAAa,QAAQ,CAAC,OAAO,IAAI;AACvC,QAAM,aAAa,MAAA;AACnB,QAAM,cAAc,MAAA;AACtB;AAMO,SAAS,cACd,QACoB;AACpB,QAAM,cAAc,kBAAA;AAEpB,QAAM,QAAQ,CACZ,OACA,UACG,SACA;AACH,UAAM,UAAU,cAAc,OAAO,OAAO,QAAQ;AACpD,UAAM,UAAU,KAAK,CAAC;AAGtB,UAAM,QAAS,QAAiC;AAChD,QAAI,SAAS,OAAO,SAAS,KAAK,GAAG,KAAK,KAAK,GAAG;AAChD,YAAM,eAAe,OAAO,OAAO,KAAK,EAAE,GAAG,KAAK;AAClD,qBAAe,cAAc,OAAO,WAAW,CAAA,GAAI,SAAS,OAAO;AAAA,IACrE;AAGA,UAAM,gBAAgB,OAAO,KAAK,KAAK;AACvC,QAAI,eAAe;AACjB,qBAAe,eAAe,OAAO,WAAW,CAAA,GAAI,SAAS,OAAO;AAAA,IACtE;AAAA,EACF;AAOA,QAAM,+BAA+B,CAAC,WAA+C;AAAA,IACnF,OAAO,CACL,UACG,SACA;AACH,WAAK,OAAO,OAAO,GAAG,IAAI;AAAA,IAC5B;AAAA,EAAA;AAGF,QAAM,WAAW,CAAC,UAAoB;AACpC,UAAM,UAAU,cAAc,OAAO,OAAO,QAAQ;AACpD,UAAM,gBAAgB,6BAA6B,KAAK;AAGxD,QAAI,OAAO,UAAU,OAAO,SAAS;AACnC,YAAM,aAAa,OAAO;AAI1B,iBAAW,QAAQ,OAAO,QAAQ;AAChC,YAAI,CAAC,KAAK,QAAQ,KAAK,KAAK,SAAS,MAAS,GAAG;AAC/C,yBAAe,KAAK,IAAI,YAAY,SAAS,MAAS;AACtD;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAGA,mBAAe,OAAO,SAAS,SAAS,eAAe,WAAW;AAAA,EACpE;AAEA,QAAM,cAAc,CAAC,UAAiC;AACpD,UAAM,UAAU,cAAc,OAAO,OAAO,QAAQ;AACpD,QAAI,CAAC,OAAO,SAAU,QAAO,CAAA;AAC7B,UAAM,SAAS,CAAA;AACf,eAAW,OAAO,OAAO,UAAU;AACjC,aAAO,GAAG,IAAI,QAAQ,GAAG;AAAA,IAC3B;AACA,WAAO;AAAA,EACT;AAEA,QAAM,UAAU,MAAM,iBAAiB,WAAW;AAElD,SAAO,OAAO,OAAO,QAAQ,EAAE,MAAM,UAAU,aAAa,SAAS;AACvE;;;;;;;;;;;"}
|
|
1
|
+
{"version":3,"file":"index.cjs","sources":["../src/index.ts"],"sourcesContent":["/**\n * Controlled Machine\n *\n * A controlled state machine where state lives outside the machine.\n *\n * - input: External data passed in\n * - computed: Derived values from input\n * - context: input + computed (full context available in handlers)\n * - on: Event → conditional actions\n * - effects: Watch-based side effects\n * - always: Auto-evaluated rules on context change\n */\n\n// ============================================\n// Types\n// ============================================\n\nexport type Rule<\n TContext,\n TPayload = undefined,\n TActions extends string = string,\n TGuards extends string = string,\n> = {\n when?: ((context: TContext, payload: TPayload) => boolean) | TGuards\n do: TActions | TActions[]\n}\n\nexport type Handler<\n TContext,\n TPayload = undefined,\n TActions extends string = string,\n TGuards extends string = string,\n> = TActions | TActions[] | Rule<TContext, TPayload, TActions, TGuards>[]\n\n// Effect helpers - utilities available in effect callbacks\nexport type EffectHelpers<TEvents extends EventsConfig> = {\n send: Send<TEvents>\n}\n\nexport type Cleanup = () => void\n\nexport type Effect<\n TContext,\n TEvents extends EventsConfig,\n TWatched = unknown,\n> = {\n watch: (context: TContext) => TWatched\n enter?: (\n context: TContext,\n helpers: EffectHelpers<TEvents>,\n ) => void | Cleanup | Promise<void>\n exit?: (context: TContext, helpers: EffectHelpers<TEvents>) => void | Cleanup\n change?: (\n context: TContext,\n prev: TWatched | undefined,\n curr: TWatched,\n helpers: EffectHelpers<TEvents>,\n ) => void | Cleanup\n}\n\n/** Helper for inferring prev/curr types from watch return type */\nexport function effect<TContext, TEvents extends EventsConfig, TWatched>(\n config: Effect<TContext, TEvents, TWatched>,\n): Effect<TContext, TEvents, TWatched> {\n return config\n}\n\nexport type EventsConfig = Record<string, unknown>\nexport type ComputedConfig = Record<string, unknown>\n\n// ============================================\n// Object-based Generic Types\n// ============================================\n\n/**\n * Object-based generic types - specify only needed types in any order\n *\n * @example\n * createMachine<{\n * input: MyInput\n * events: MyEvents\n * actions: 'foo' | 'bar'\n * }>({...})\n */\nexport type MachineTypes = {\n input?: unknown\n events?: EventsConfig\n computed?: ComputedConfig\n actions?: string\n guards?: string\n state?: string\n}\n\nexport type Input<T extends MachineTypes> = T['input']\nexport type Events<T extends MachineTypes> = T['events'] extends EventsConfig\n ? T['events']\n : Record<string, undefined>\nexport type Computed<T extends MachineTypes> = T['computed'] extends ComputedConfig\n ? T['computed']\n : Record<string, never>\nexport type Actions<T extends MachineTypes> = T['actions'] extends string\n ? T['actions']\n : string\nexport type Guards<T extends MachineTypes> = T['guards'] extends string\n ? T['guards']\n : string\nexport type State<T extends MachineTypes> = T['state'] extends string\n ? T['state']\n : string\n\n// Context = Input + Computed (full context available in handlers)\nexport type Context<T extends MachineTypes> = Input<T> & Computed<T>\n\n// State-based handler configuration\nexport type StateConfig<\n TContext,\n TEvents extends EventsConfig,\n TActions extends string = string,\n> = {\n on?: { [K in keyof TEvents]?: Handler<TContext, TEvents[K], TActions> }\n}\n\nexport type StatesConfig<\n TState extends string,\n TContext,\n TEvents extends EventsConfig,\n TActions extends string = string,\n> = {\n [K in TState]?: StateConfig<TContext, TEvents, TActions>\n}\n\nexport type Machine<T extends MachineTypes> = {\n computed?: {\n [K in keyof Computed<T>]: (input: Input<T>) => Computed<T>[K]\n }\n on?: {\n [K in keyof Events<T>]?: Handler<Context<T>, Events<T>[K], Actions<T>, Guards<T>>\n }\n states?: StatesConfig<State<T>, Context<T>, Events<T>, Actions<T>>\n always?: Rule<Context<T>, undefined, Actions<T>, Guards<T>>[]\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n effects?: Effect<Context<T>, Events<T>, any>[]\n actions?: {\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [K in Actions<T>]: (context: Context<T>, payload?: any) => void\n }\n guards?: {\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [K in Guards<T>]: (context: Context<T>, payload?: any) => boolean\n }\n}\n\nexport type Send<TEvents extends EventsConfig> = <K extends keyof TEvents>(\n event: K,\n ...args: TEvents[K] extends undefined ? [] : [payload: TEvents[K]]\n) => void\n\n// createMachine return type\nexport type MachineInstance<T extends MachineTypes> = Machine<T> & {\n send: <K extends keyof Events<T>>(\n event: K,\n input: Input<T>,\n ...args: Events<T>[K] extends undefined ? [] : [payload: Events<T>[K]]\n ) => void\n evaluate: (input: Input<T>) => void\n getComputed: (input: Input<T>) => Computed<T>\n cleanup: () => void\n}\n\n// ============================================\n// Core Logic (Pure)\n// ============================================\n\nexport function executeActions<TContext, TPayload>(\n actionNames: string | string[],\n actions: Record<string, (context: TContext, payload?: TPayload) => void>,\n context: TContext,\n payload: TPayload,\n): void {\n if (typeof actionNames === 'string') {\n actions[actionNames]?.(context, payload)\n } else {\n for (const name of actionNames) {\n actions[name]?.(context, payload)\n }\n }\n}\n\nexport function isRuleArray<TContext, TPayload, TActions extends string>(\n handler: Handler<TContext, TPayload, TActions>,\n): handler is Rule<TContext, TPayload, TActions>[] {\n return (\n Array.isArray(handler) &&\n handler.length > 0 &&\n typeof handler[0] === 'object' &&\n 'do' in handler[0]\n )\n}\n\nexport function executeHandler<TContext, TPayload>(\n handler: Handler<TContext, TPayload>,\n actions: Record<string, (context: TContext, payload?: TPayload) => void>,\n guards: Record<string, (context: TContext, payload?: TPayload) => boolean>,\n context: TContext,\n payload: TPayload,\n): void {\n // Single action or action array\n if (typeof handler === 'string' || (Array.isArray(handler) && !isRuleArray(handler))) {\n executeActions(handler as string | string[], actions, context, payload)\n return\n }\n\n // Rule array\n for (const rule of handler as Rule<TContext, TPayload>[]) {\n const guardFn =\n typeof rule.when === 'string' ? guards[rule.when] : rule.when\n\n if (!guardFn || guardFn(context, payload)) {\n executeActions(rule.do, actions, context, payload)\n break\n }\n }\n}\n\nexport function computeValues<TContext, TComputed extends ComputedConfig>(\n context: TContext,\n computed?: { [K in keyof TComputed]: (context: TContext) => TComputed[K] },\n): TContext & TComputed {\n if (!computed) return context as TContext & TComputed\n\n const values = {} as TComputed\n for (const key in computed) {\n values[key] = computed[key](context)\n }\n return { ...context, ...values }\n}\n\n/**\n * Shallow comparison function - for composite watch support\n *\n * Arrays: length + === comparison for each element\n * Others: === comparison\n */\nexport function shallowEqual(a: unknown, b: unknown): boolean {\n if (a === b) return true\n\n // Array comparison\n if (Array.isArray(a) && Array.isArray(b)) {\n if (a.length !== b.length) return false\n return a.every((v, i) => v === b[i])\n }\n\n return false\n}\n\n// Effect store for tracking state\nexport type EffectStore = {\n watchedValues: Map<number, unknown>\n enterCleanups: Map<number, () => void>\n changeCleanups: Map<number, () => void>\n exitCleanups: Map<number, () => void>\n}\n\nexport function createEffectStore(): EffectStore {\n return {\n watchedValues: new Map(),\n enterCleanups: new Map(),\n changeCleanups: new Map(),\n exitCleanups: new Map(),\n }\n}\n\n/**\n * Common effects processing logic\n */\nexport function processEffects<TContext, TEvents extends EventsConfig>(\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n effects: Effect<TContext, TEvents, any>[] | undefined,\n context: TContext,\n effectHelpers: EffectHelpers<TEvents>,\n store: EffectStore,\n): void {\n if (!effects) return\n\n effects.forEach((effect, i) => {\n const prev = store.watchedValues.get(i)\n const curr = effect.watch(context)\n\n if (!shallowEqual(prev, curr)) {\n // cleanup previous enter\n const enterCleanup = store.enterCleanups.get(i)\n if (enterCleanup) {\n enterCleanup()\n store.enterCleanups.delete(i)\n }\n\n // cleanup previous change\n const changeCleanup = store.changeCleanups.get(i)\n if (changeCleanup) {\n changeCleanup()\n store.changeCleanups.delete(i)\n }\n\n // change callback (can return cleanup)\n const changeResult = effect.change?.(context, prev, curr, effectHelpers)\n if (typeof changeResult === 'function') {\n store.changeCleanups.set(i, changeResult)\n }\n\n // enter (falsy → truthy)\n if (!prev && curr) {\n // cleanup previous exit\n const exitCleanup = store.exitCleanups.get(i)\n if (exitCleanup) {\n exitCleanup()\n store.exitCleanups.delete(i)\n }\n\n const enterResult = effect.enter?.(context, effectHelpers)\n if (typeof enterResult === 'function') {\n store.enterCleanups.set(i, enterResult)\n }\n }\n\n // exit (truthy → falsy)\n if (prev && !curr) {\n const exitResult = effect.exit?.(context, effectHelpers)\n if (typeof exitResult === 'function') {\n store.exitCleanups.set(i, exitResult)\n }\n }\n\n store.watchedValues.set(i, curr)\n }\n })\n}\n\n/**\n * Clear effect store\n */\nexport function clearEffectStore(store: EffectStore): void {\n store.enterCleanups.forEach((fn) => fn())\n store.enterCleanups.clear()\n store.changeCleanups.forEach((fn) => fn())\n store.changeCleanups.clear()\n store.exitCleanups.forEach((fn) => fn())\n store.exitCleanups.clear()\n store.watchedValues.clear()\n}\n\n// ============================================\n// Vanilla (non-React) + Type inference helper\n// ============================================\n\nexport function createMachine<T extends MachineTypes>(\n config: Machine<T>,\n): MachineInstance<T> {\n const effectStore = createEffectStore()\n\n const send = (<K extends keyof Events<T>>(\n event: K,\n input: Input<T>,\n ...args: Events<T>[K] extends undefined ? [] : [payload: Events<T>[K]]\n ) => {\n const context = computeValues(input, config.computed)\n const payload = args[0] as Events<T>[K]\n\n // 1. State-specific handler first\n const state = (context as { state?: State<T> }).state\n if (state && config.states?.[state]?.on?.[event]) {\n const stateHandler = config.states[state].on[event]\n executeHandler(stateHandler, config.actions ?? {}, config.guards ?? {}, context, payload)\n }\n\n // 2. Global handler\n const globalHandler = config.on?.[event]\n if (globalHandler) {\n executeHandler(globalHandler, config.actions ?? {}, config.guards ?? {}, context, payload)\n }\n }) as <K extends keyof Events<T>>(\n event: K,\n input: Input<T>,\n ...args: Events<T>[K] extends undefined ? [] : [payload: Events<T>[K]]\n ) => void\n\n // vanilla send wrapper (with input binding)\n const createEffectHelpersWithInput = (input: Input<T>): EffectHelpers<Events<T>> => ({\n send: (<K extends keyof Events<T>>(\n event: K,\n ...args: Events<T>[K] extends undefined ? [] : [payload: Events<T>[K]]\n ) => {\n send(event, input, ...args)\n }) as Send<Events<T>>,\n })\n\n const evaluate = (input: Input<T>) => {\n const context = computeValues(input, config.computed)\n const effectHelpers = createEffectHelpersWithInput(input)\n\n // always\n if (config.always && config.actions) {\n const actionsMap = config.actions as Record<\n string,\n (context: Context<T>) => void\n >\n const guardsMap = (config.guards ?? {}) as Record<\n string,\n (context: Context<T>) => boolean\n >\n for (const rule of config.always) {\n const guardFn =\n typeof rule.when === 'string' ? guardsMap[rule.when] : rule.when\n\n if (!guardFn || guardFn(context, undefined)) {\n executeActions(rule.do, actionsMap, context, undefined)\n break\n }\n }\n }\n\n // effects\n processEffects(config.effects, context, effectHelpers, effectStore)\n }\n\n const getComputed = (input: Input<T>): Computed<T> => {\n const context = computeValues(input, config.computed)\n if (!config.computed) return {} as Computed<T>\n const result = {} as Computed<T>\n for (const key in config.computed) {\n result[key] = context[key]\n }\n return result\n }\n\n const cleanup = () => clearEffectStore(effectStore)\n\n return Object.assign(config, { send, evaluate, getComputed, cleanup })\n}\n"],"names":["effect"],"mappings":";;AA6DO,SAAS,OACd,QACqC;AACrC,SAAO;AACT;AA4GO,SAAS,eACd,aACA,SACA,SACA,SACM;AACN,MAAI,OAAO,gBAAgB,UAAU;AACnC,YAAQ,WAAW,IAAI,SAAS,OAAO;AAAA,EACzC,OAAO;AACL,eAAW,QAAQ,aAAa;AAC9B,cAAQ,IAAI,IAAI,SAAS,OAAO;AAAA,IAClC;AAAA,EACF;AACF;AAEO,SAAS,YACd,SACiD;AACjD,SACE,MAAM,QAAQ,OAAO,KACrB,QAAQ,SAAS,KACjB,OAAO,QAAQ,CAAC,MAAM,YACtB,QAAQ,QAAQ,CAAC;AAErB;AAEO,SAAS,eACd,SACA,SACA,QACA,SACA,SACM;AAEN,MAAI,OAAO,YAAY,YAAa,MAAM,QAAQ,OAAO,KAAK,CAAC,YAAY,OAAO,GAAI;AACpF,mBAAe,SAA8B,SAAS,SAAS,OAAO;AACtE;AAAA,EACF;AAGA,aAAW,QAAQ,SAAuC;AACxD,UAAM,UACJ,OAAO,KAAK,SAAS,WAAW,OAAO,KAAK,IAAI,IAAI,KAAK;AAE3D,QAAI,CAAC,WAAW,QAAQ,SAAS,OAAO,GAAG;AACzC,qBAAe,KAAK,IAAI,SAAS,SAAS,OAAO;AACjD;AAAA,IACF;AAAA,EACF;AACF;AAEO,SAAS,cACd,SACA,UACsB;AACtB,MAAI,CAAC,SAAU,QAAO;AAEtB,QAAM,SAAS,CAAA;AACf,aAAW,OAAO,UAAU;AAC1B,WAAO,GAAG,IAAI,SAAS,GAAG,EAAE,OAAO;AAAA,EACrC;AACA,SAAO,EAAE,GAAG,SAAS,GAAG,OAAA;AAC1B;AAQO,SAAS,aAAa,GAAY,GAAqB;AAC5D,MAAI,MAAM,EAAG,QAAO;AAGpB,MAAI,MAAM,QAAQ,CAAC,KAAK,MAAM,QAAQ,CAAC,GAAG;AACxC,QAAI,EAAE,WAAW,EAAE,OAAQ,QAAO;AAClC,WAAO,EAAE,MAAM,CAAC,GAAG,MAAM,MAAM,EAAE,CAAC,CAAC;AAAA,EACrC;AAEA,SAAO;AACT;AAUO,SAAS,oBAAiC;AAC/C,SAAO;AAAA,IACL,mCAAmB,IAAA;AAAA,IACnB,mCAAmB,IAAA;AAAA,IACnB,oCAAoB,IAAA;AAAA,IACpB,kCAAkB,IAAA;AAAA,EAAI;AAE1B;AAKO,SAAS,eAEd,SACA,SACA,eACA,OACM;AACN,MAAI,CAAC,QAAS;AAEd,UAAQ,QAAQ,CAACA,SAAQ,MAAM;AAC7B,UAAM,OAAO,MAAM,cAAc,IAAI,CAAC;AACtC,UAAM,OAAOA,QAAO,MAAM,OAAO;AAEjC,QAAI,CAAC,aAAa,MAAM,IAAI,GAAG;AAE7B,YAAM,eAAe,MAAM,cAAc,IAAI,CAAC;AAC9C,UAAI,cAAc;AAChB,qBAAA;AACA,cAAM,cAAc,OAAO,CAAC;AAAA,MAC9B;AAGA,YAAM,gBAAgB,MAAM,eAAe,IAAI,CAAC;AAChD,UAAI,eAAe;AACjB,sBAAA;AACA,cAAM,eAAe,OAAO,CAAC;AAAA,MAC/B;AAGA,YAAM,eAAeA,QAAO,SAAS,SAAS,MAAM,MAAM,aAAa;AACvE,UAAI,OAAO,iBAAiB,YAAY;AACtC,cAAM,eAAe,IAAI,GAAG,YAAY;AAAA,MAC1C;AAGA,UAAI,CAAC,QAAQ,MAAM;AAEjB,cAAM,cAAc,MAAM,aAAa,IAAI,CAAC;AAC5C,YAAI,aAAa;AACf,sBAAA;AACA,gBAAM,aAAa,OAAO,CAAC;AAAA,QAC7B;AAEA,cAAM,cAAcA,QAAO,QAAQ,SAAS,aAAa;AACzD,YAAI,OAAO,gBAAgB,YAAY;AACrC,gBAAM,cAAc,IAAI,GAAG,WAAW;AAAA,QACxC;AAAA,MACF;AAGA,UAAI,QAAQ,CAAC,MAAM;AACjB,cAAM,aAAaA,QAAO,OAAO,SAAS,aAAa;AACvD,YAAI,OAAO,eAAe,YAAY;AACpC,gBAAM,aAAa,IAAI,GAAG,UAAU;AAAA,QACtC;AAAA,MACF;AAEA,YAAM,cAAc,IAAI,GAAG,IAAI;AAAA,IACjC;AAAA,EACF,CAAC;AACH;AAKO,SAAS,iBAAiB,OAA0B;AACzD,QAAM,cAAc,QAAQ,CAAC,OAAO,IAAI;AACxC,QAAM,cAAc,MAAA;AACpB,QAAM,eAAe,QAAQ,CAAC,OAAO,IAAI;AACzC,QAAM,eAAe,MAAA;AACrB,QAAM,aAAa,QAAQ,CAAC,OAAO,IAAI;AACvC,QAAM,aAAa,MAAA;AACnB,QAAM,cAAc,MAAA;AACtB;AAMO,SAAS,cACd,QACoB;AACpB,QAAM,cAAc,kBAAA;AAEpB,QAAM,QAAQ,CACZ,OACA,UACG,SACA;AACH,UAAM,UAAU,cAAc,OAAO,OAAO,QAAQ;AACpD,UAAM,UAAU,KAAK,CAAC;AAGtB,UAAM,QAAS,QAAiC;AAChD,QAAI,SAAS,OAAO,SAAS,KAAK,GAAG,KAAK,KAAK,GAAG;AAChD,YAAM,eAAe,OAAO,OAAO,KAAK,EAAE,GAAG,KAAK;AAClD,qBAAe,cAAc,OAAO,WAAW,CAAA,GAAI,OAAO,UAAU,CAAA,GAAI,SAAS,OAAO;AAAA,IAC1F;AAGA,UAAM,gBAAgB,OAAO,KAAK,KAAK;AACvC,QAAI,eAAe;AACjB,qBAAe,eAAe,OAAO,WAAW,CAAA,GAAI,OAAO,UAAU,CAAA,GAAI,SAAS,OAAO;AAAA,IAC3F;AAAA,EACF;AAOA,QAAM,+BAA+B,CAAC,WAA+C;AAAA,IACnF,OAAO,CACL,UACG,SACA;AACH,WAAK,OAAO,OAAO,GAAG,IAAI;AAAA,IAC5B;AAAA,EAAA;AAGF,QAAM,WAAW,CAAC,UAAoB;AACpC,UAAM,UAAU,cAAc,OAAO,OAAO,QAAQ;AACpD,UAAM,gBAAgB,6BAA6B,KAAK;AAGxD,QAAI,OAAO,UAAU,OAAO,SAAS;AACnC,YAAM,aAAa,OAAO;AAI1B,YAAM,YAAa,OAAO,UAAU,CAAA;AAIpC,iBAAW,QAAQ,OAAO,QAAQ;AAChC,cAAM,UACJ,OAAO,KAAK,SAAS,WAAW,UAAU,KAAK,IAAI,IAAI,KAAK;AAE9D,YAAI,CAAC,WAAW,QAAQ,SAAS,MAAS,GAAG;AAC3C,yBAAe,KAAK,IAAI,YAAY,SAAS,MAAS;AACtD;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAGA,mBAAe,OAAO,SAAS,SAAS,eAAe,WAAW;AAAA,EACpE;AAEA,QAAM,cAAc,CAAC,UAAiC;AACpD,UAAM,UAAU,cAAc,OAAO,OAAO,QAAQ;AACpD,QAAI,CAAC,OAAO,SAAU,QAAO,CAAA;AAC7B,UAAM,SAAS,CAAA;AACf,eAAW,OAAO,OAAO,UAAU;AACjC,aAAO,GAAG,IAAI,QAAQ,GAAG;AAAA,IAC3B;AACA,WAAO;AAAA,EACT;AAEA,QAAM,UAAU,MAAM,iBAAiB,WAAW;AAElD,SAAO,OAAO,OAAO,QAAQ,EAAE,MAAM,UAAU,aAAa,SAAS;AACvE;;;;;;;;;;;"}
|
package/dist/index.d.cts
CHANGED
|
@@ -1,143 +1,118 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
*
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
}
|
|
17
|
-
|
|
18
|
-
export
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
export
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
export
|
|
52
|
-
|
|
53
|
-
export
|
|
54
|
-
|
|
55
|
-
export
|
|
56
|
-
|
|
57
|
-
export
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
[K in
|
|
71
|
-
};
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
export declare
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
export
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
*
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
*
|
|
115
|
-
*/
|
|
116
|
-
export declare
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
};
|
|
120
|
-
|
|
121
|
-
export declare type Send<TEvents extends EventsConfig> = <K extends keyof TEvents>(event: K, ...args: TEvents[K] extends undefined ? [] : [payload: TEvents[K]]) => void;
|
|
122
|
-
|
|
123
|
-
/**
|
|
124
|
-
* Shallow comparison function - for composite watch support
|
|
125
|
-
*
|
|
126
|
-
* Arrays: length + === comparison for each element
|
|
127
|
-
* Others: === comparison
|
|
128
|
-
*/
|
|
129
|
-
export declare function shallowEqual(a: unknown, b: unknown): boolean;
|
|
130
|
-
|
|
131
|
-
export declare type State<T extends MachineTypes> = T['state'] extends string ? T['state'] : string;
|
|
132
|
-
|
|
133
|
-
export declare type StateConfig<TContext, TEvents extends EventsConfig, TActions extends string = string> = {
|
|
134
|
-
on?: {
|
|
135
|
-
[K in keyof TEvents]?: Handler<TContext, TEvents[K], TActions>;
|
|
136
|
-
};
|
|
137
|
-
};
|
|
138
|
-
|
|
139
|
-
export declare type StatesConfig<TState extends string, TContext, TEvents extends EventsConfig, TActions extends string = string> = {
|
|
140
|
-
[K in TState]?: StateConfig<TContext, TEvents, TActions>;
|
|
141
|
-
};
|
|
142
|
-
|
|
143
|
-
export { }
|
|
1
|
+
/**
|
|
2
|
+
* Controlled Machine
|
|
3
|
+
*
|
|
4
|
+
* A controlled state machine where state lives outside the machine.
|
|
5
|
+
*
|
|
6
|
+
* - input: External data passed in
|
|
7
|
+
* - computed: Derived values from input
|
|
8
|
+
* - context: input + computed (full context available in handlers)
|
|
9
|
+
* - on: Event → conditional actions
|
|
10
|
+
* - effects: Watch-based side effects
|
|
11
|
+
* - always: Auto-evaluated rules on context change
|
|
12
|
+
*/
|
|
13
|
+
export type Rule<TContext, TPayload = undefined, TActions extends string = string, TGuards extends string = string> = {
|
|
14
|
+
when?: ((context: TContext, payload: TPayload) => boolean) | TGuards;
|
|
15
|
+
do: TActions | TActions[];
|
|
16
|
+
};
|
|
17
|
+
export type Handler<TContext, TPayload = undefined, TActions extends string = string, TGuards extends string = string> = TActions | TActions[] | Rule<TContext, TPayload, TActions, TGuards>[];
|
|
18
|
+
export type EffectHelpers<TEvents extends EventsConfig> = {
|
|
19
|
+
send: Send<TEvents>;
|
|
20
|
+
};
|
|
21
|
+
export type Cleanup = () => void;
|
|
22
|
+
export type Effect<TContext, TEvents extends EventsConfig, TWatched = unknown> = {
|
|
23
|
+
watch: (context: TContext) => TWatched;
|
|
24
|
+
enter?: (context: TContext, helpers: EffectHelpers<TEvents>) => void | Cleanup | Promise<void>;
|
|
25
|
+
exit?: (context: TContext, helpers: EffectHelpers<TEvents>) => void | Cleanup;
|
|
26
|
+
change?: (context: TContext, prev: TWatched | undefined, curr: TWatched, helpers: EffectHelpers<TEvents>) => void | Cleanup;
|
|
27
|
+
};
|
|
28
|
+
/** Helper for inferring prev/curr types from watch return type */
|
|
29
|
+
export declare function effect<TContext, TEvents extends EventsConfig, TWatched>(config: Effect<TContext, TEvents, TWatched>): Effect<TContext, TEvents, TWatched>;
|
|
30
|
+
export type EventsConfig = Record<string, unknown>;
|
|
31
|
+
export type ComputedConfig = Record<string, unknown>;
|
|
32
|
+
/**
|
|
33
|
+
* Object-based generic types - specify only needed types in any order
|
|
34
|
+
*
|
|
35
|
+
* @example
|
|
36
|
+
* createMachine<{
|
|
37
|
+
* input: MyInput
|
|
38
|
+
* events: MyEvents
|
|
39
|
+
* actions: 'foo' | 'bar'
|
|
40
|
+
* }>({...})
|
|
41
|
+
*/
|
|
42
|
+
export type MachineTypes = {
|
|
43
|
+
input?: unknown;
|
|
44
|
+
events?: EventsConfig;
|
|
45
|
+
computed?: ComputedConfig;
|
|
46
|
+
actions?: string;
|
|
47
|
+
guards?: string;
|
|
48
|
+
state?: string;
|
|
49
|
+
};
|
|
50
|
+
export type Input<T extends MachineTypes> = T['input'];
|
|
51
|
+
export type Events<T extends MachineTypes> = T['events'] extends EventsConfig ? T['events'] : Record<string, undefined>;
|
|
52
|
+
export type Computed<T extends MachineTypes> = T['computed'] extends ComputedConfig ? T['computed'] : Record<string, never>;
|
|
53
|
+
export type Actions<T extends MachineTypes> = T['actions'] extends string ? T['actions'] : string;
|
|
54
|
+
export type Guards<T extends MachineTypes> = T['guards'] extends string ? T['guards'] : string;
|
|
55
|
+
export type State<T extends MachineTypes> = T['state'] extends string ? T['state'] : string;
|
|
56
|
+
export type Context<T extends MachineTypes> = Input<T> & Computed<T>;
|
|
57
|
+
export type StateConfig<TContext, TEvents extends EventsConfig, TActions extends string = string> = {
|
|
58
|
+
on?: {
|
|
59
|
+
[K in keyof TEvents]?: Handler<TContext, TEvents[K], TActions>;
|
|
60
|
+
};
|
|
61
|
+
};
|
|
62
|
+
export type StatesConfig<TState extends string, TContext, TEvents extends EventsConfig, TActions extends string = string> = {
|
|
63
|
+
[K in TState]?: StateConfig<TContext, TEvents, TActions>;
|
|
64
|
+
};
|
|
65
|
+
export type Machine<T extends MachineTypes> = {
|
|
66
|
+
computed?: {
|
|
67
|
+
[K in keyof Computed<T>]: (input: Input<T>) => Computed<T>[K];
|
|
68
|
+
};
|
|
69
|
+
on?: {
|
|
70
|
+
[K in keyof Events<T>]?: Handler<Context<T>, Events<T>[K], Actions<T>, Guards<T>>;
|
|
71
|
+
};
|
|
72
|
+
states?: StatesConfig<State<T>, Context<T>, Events<T>, Actions<T>>;
|
|
73
|
+
always?: Rule<Context<T>, undefined, Actions<T>, Guards<T>>[];
|
|
74
|
+
effects?: Effect<Context<T>, Events<T>, any>[];
|
|
75
|
+
actions?: {
|
|
76
|
+
[K in Actions<T>]: (context: Context<T>, payload?: any) => void;
|
|
77
|
+
};
|
|
78
|
+
guards?: {
|
|
79
|
+
[K in Guards<T>]: (context: Context<T>, payload?: any) => boolean;
|
|
80
|
+
};
|
|
81
|
+
};
|
|
82
|
+
export type Send<TEvents extends EventsConfig> = <K extends keyof TEvents>(event: K, ...args: TEvents[K] extends undefined ? [] : [payload: TEvents[K]]) => void;
|
|
83
|
+
export type MachineInstance<T extends MachineTypes> = Machine<T> & {
|
|
84
|
+
send: <K extends keyof Events<T>>(event: K, input: Input<T>, ...args: Events<T>[K] extends undefined ? [] : [payload: Events<T>[K]]) => void;
|
|
85
|
+
evaluate: (input: Input<T>) => void;
|
|
86
|
+
getComputed: (input: Input<T>) => Computed<T>;
|
|
87
|
+
cleanup: () => void;
|
|
88
|
+
};
|
|
89
|
+
export declare function executeActions<TContext, TPayload>(actionNames: string | string[], actions: Record<string, (context: TContext, payload?: TPayload) => void>, context: TContext, payload: TPayload): void;
|
|
90
|
+
export declare function isRuleArray<TContext, TPayload, TActions extends string>(handler: Handler<TContext, TPayload, TActions>): handler is Rule<TContext, TPayload, TActions>[];
|
|
91
|
+
export declare function executeHandler<TContext, TPayload>(handler: Handler<TContext, TPayload>, actions: Record<string, (context: TContext, payload?: TPayload) => void>, guards: Record<string, (context: TContext, payload?: TPayload) => boolean>, context: TContext, payload: TPayload): void;
|
|
92
|
+
export declare function computeValues<TContext, TComputed extends ComputedConfig>(context: TContext, computed?: {
|
|
93
|
+
[K in keyof TComputed]: (context: TContext) => TComputed[K];
|
|
94
|
+
}): TContext & TComputed;
|
|
95
|
+
/**
|
|
96
|
+
* Shallow comparison function - for composite watch support
|
|
97
|
+
*
|
|
98
|
+
* Arrays: length + === comparison for each element
|
|
99
|
+
* Others: === comparison
|
|
100
|
+
*/
|
|
101
|
+
export declare function shallowEqual(a: unknown, b: unknown): boolean;
|
|
102
|
+
export type EffectStore = {
|
|
103
|
+
watchedValues: Map<number, unknown>;
|
|
104
|
+
enterCleanups: Map<number, () => void>;
|
|
105
|
+
changeCleanups: Map<number, () => void>;
|
|
106
|
+
exitCleanups: Map<number, () => void>;
|
|
107
|
+
};
|
|
108
|
+
export declare function createEffectStore(): EffectStore;
|
|
109
|
+
/**
|
|
110
|
+
* Common effects processing logic
|
|
111
|
+
*/
|
|
112
|
+
export declare function processEffects<TContext, TEvents extends EventsConfig>(effects: Effect<TContext, TEvents, any>[] | undefined, context: TContext, effectHelpers: EffectHelpers<TEvents>, store: EffectStore): void;
|
|
113
|
+
/**
|
|
114
|
+
* Clear effect store
|
|
115
|
+
*/
|
|
116
|
+
export declare function clearEffectStore(store: EffectStore): void;
|
|
117
|
+
export declare function createMachine<T extends MachineTypes>(config: Machine<T>): MachineInstance<T>;
|
|
118
|
+
//# sourceMappingURL=index.d.ts.map
|