xstate 4.36.0 → 4.37.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/es/actions.d.ts CHANGED
@@ -74,7 +74,7 @@ export declare function respond<TContext, TEvent extends EventObject, TSentEvent
74
74
  * - `event` - the event that caused this action to be executed.
75
75
  * @param label The label to give to the logged expression.
76
76
  */
77
- export declare function log<TContext, TEvent extends EventObject>(expr?: string | LogExpr<TContext, TEvent>, label?: string): LogAction<TContext, TEvent>;
77
+ export declare function log<TContext, TExpressionEvent extends EventObject, TEvent extends EventObject = TExpressionEvent>(expr?: string | LogExpr<TContext, TExpressionEvent>, label?: string): LogAction<TContext, TExpressionEvent, TEvent>;
78
78
  export declare const resolveLog: <TContext, TEvent extends EventObject>(action: LogAction<TContext, TEvent, TEvent>, ctx: TContext, _event: SCXML.Event<TEvent>) => LogActionObject<TContext, TEvent>;
79
79
  /**
80
80
  * Cancels an in-flight `send(...)` action. A canceled sent action will not
@@ -83,7 +83,7 @@ export declare const resolveLog: <TContext, TEvent extends EventObject>(action:
83
83
  *
84
84
  * @param sendId The `id` of the `send(...)` action to cancel.
85
85
  */
86
- export declare const cancel: <TContext, TEvent extends EventObject>(sendId: string | number) => CancelAction<TContext, TEvent, TEvent>;
86
+ export declare const cancel: <TContext, TExpressionEvent extends EventObject, TEvent extends EventObject>(sendId: string | number) => CancelAction<TContext, TExpressionEvent, TEvent>;
87
87
  /**
88
88
  * Starts an activity.
89
89
  *
@@ -95,9 +95,9 @@ export declare function start<TContext, TEvent extends EventObject>(activity: st
95
95
  *
96
96
  * @param actorRef The activity to stop.
97
97
  */
98
- export declare function stop<TContext, TEvent extends EventObject>(actorRef: string | Expr<TContext, TEvent, string | {
98
+ export declare function stop<TContext, TExpressionEvent extends EventObject, TEvent extends EventObject = TExpressionEvent>(actorRef: string | Expr<TContext, TExpressionEvent, string | {
99
99
  id: string;
100
- }>): StopAction<TContext, TEvent>;
100
+ }>): StopAction<TContext, TExpressionEvent, TEvent>;
101
101
  export declare function resolveStop<TContext, TEvent extends EventObject>(action: StopAction<TContext, TEvent>, context: TContext, _event: SCXML.Event<TEvent>): StopActionObject;
102
102
  /**
103
103
  * Updates the current context of the machine.
@@ -133,7 +133,7 @@ export declare function done(id: string, data?: any): DoneEventObject;
133
133
  */
134
134
  export declare function doneInvoke(id: string, data?: any): DoneEvent;
135
135
  export declare function error(id: string, data?: any): ErrorPlatformEvent & string;
136
- export declare function pure<TContext, TEvent extends EventObject>(getActions: (context: TContext, event: TEvent) => SingleOrArray<BaseActionObject | BaseActionObject['type'] | ActionObject<TContext, TEvent>> | undefined): PureAction<TContext, TEvent>;
136
+ export declare function pure<TContext, TExpressionEvent extends EventObject, TEvent extends EventObject = TExpressionEvent>(getActions: (context: TContext, event: TExpressionEvent) => SingleOrArray<BaseActionObject | BaseActionObject['type'] | ActionObject<TContext, TExpressionEvent, TEvent>> | undefined): PureAction<TContext, TExpressionEvent, TEvent>;
137
137
  /**
138
138
  * Forwards (sends) an event to a specified service.
139
139
  *
@@ -149,7 +149,7 @@ export declare function forwardTo<TContext, TEvent extends EventObject>(target:
149
149
  * @param options Options to pass into the send action creator.
150
150
  */
151
151
  export declare function escalate<TContext, TEvent extends EventObject, TErrorData = any>(errorData: TErrorData | ExprWithMeta<TContext, TEvent, TErrorData>, options?: SendActionOptions<TContext, TEvent>): SendAction<TContext, TEvent, AnyEventObject>;
152
- export declare function choose<TContext, TEvent extends EventObject>(conds: Array<ChooseCondition<TContext, TEvent>>): ChooseAction<TContext, TEvent>;
152
+ export declare function choose<TContext, TExpressionEvent extends EventObject, TEvent extends EventObject = TExpressionEvent>(conds: Array<ChooseCondition<TContext, TExpressionEvent, TEvent>>): ChooseAction<TContext, TExpressionEvent, TEvent>;
153
153
  export declare function resolveActions<TContext, TEvent extends EventObject>(machine: StateNode<TContext, any, TEvent, any, any, any>, currentState: State<TContext, TEvent, any, any, any> | undefined, currentContext: TContext, _event: SCXML.Event<TEvent>, actionBlocks: Array<{
154
154
  type: string;
155
155
  actions: Array<ActionObject<TContext, TEvent>>;
package/es/types.d.ts CHANGED
@@ -78,9 +78,9 @@ export interface AssignMeta<TContext, TEvent extends EventObject> {
78
78
  export declare type ActionFunction<TContext, TExpressionEvent extends EventObject, TAction extends BaseActionObject = BaseActionObject, TEvent extends EventObject = TExpressionEvent> = {
79
79
  bivarianceHack(context: TContext, event: TExpressionEvent, meta: ActionMeta<TContext, TEvent, TAction>): void;
80
80
  }['bivarianceHack'];
81
- export interface ChooseCondition<TContext, TEvent extends EventObject> {
82
- cond?: Condition<TContext, TEvent>;
83
- actions: Actions<TContext, TEvent>;
81
+ export interface ChooseCondition<TContext, TExpressionEvent extends EventObject, TEvent extends EventObject = TExpressionEvent> {
82
+ cond?: Condition<TContext, TExpressionEvent>;
83
+ actions: Actions<TContext, TExpressionEvent, TEvent>;
84
84
  }
85
85
  export declare type Action<TContext, TExpressionEvent extends EventObject, TEvent extends EventObject = TExpressionEvent> = ActionType | BaseActionObject | ActionObject<TContext, TExpressionEvent, TEvent> | ActionFunction<TContext, TExpressionEvent, BaseActionObject, TEvent>;
86
86
  /**
@@ -1049,5 +1049,6 @@ declare type Matches<TypegenEnabledArg, TypegenDisabledArg> = {
1049
1049
  };
1050
1050
  export declare type StateValueFrom<TMachine extends AnyStateMachine> = StateFrom<TMachine>['matches'] extends Matches<infer TypegenEnabledArg, infer TypegenDisabledArg> ? TMachine['__TResolvedTypesMeta'] extends TypegenEnabled ? TypegenEnabledArg : TypegenDisabledArg : never;
1051
1051
  export declare type PredictableActionArgumentsExec = (action: ActionObject<unknown, EventObject>, context: unknown, _event: SCXML.Event<EventObject>) => void;
1052
+ export declare type TagsFrom<TMachine extends AnyStateMachine> = Parameters<StateFrom<TMachine>['hasTag']>[0];
1052
1053
  export {};
1053
1054
  //# sourceMappingURL=types.d.ts.map
package/lib/actions.d.ts CHANGED
@@ -74,7 +74,7 @@ export declare function respond<TContext, TEvent extends EventObject, TSentEvent
74
74
  * - `event` - the event that caused this action to be executed.
75
75
  * @param label The label to give to the logged expression.
76
76
  */
77
- export declare function log<TContext, TEvent extends EventObject>(expr?: string | LogExpr<TContext, TEvent>, label?: string): LogAction<TContext, TEvent>;
77
+ export declare function log<TContext, TExpressionEvent extends EventObject, TEvent extends EventObject = TExpressionEvent>(expr?: string | LogExpr<TContext, TExpressionEvent>, label?: string): LogAction<TContext, TExpressionEvent, TEvent>;
78
78
  export declare const resolveLog: <TContext, TEvent extends EventObject>(action: LogAction<TContext, TEvent, TEvent>, ctx: TContext, _event: SCXML.Event<TEvent>) => LogActionObject<TContext, TEvent>;
79
79
  /**
80
80
  * Cancels an in-flight `send(...)` action. A canceled sent action will not
@@ -83,7 +83,7 @@ export declare const resolveLog: <TContext, TEvent extends EventObject>(action:
83
83
  *
84
84
  * @param sendId The `id` of the `send(...)` action to cancel.
85
85
  */
86
- export declare const cancel: <TContext, TEvent extends EventObject>(sendId: string | number) => CancelAction<TContext, TEvent, TEvent>;
86
+ export declare const cancel: <TContext, TExpressionEvent extends EventObject, TEvent extends EventObject>(sendId: string | number) => CancelAction<TContext, TExpressionEvent, TEvent>;
87
87
  /**
88
88
  * Starts an activity.
89
89
  *
@@ -95,9 +95,9 @@ export declare function start<TContext, TEvent extends EventObject>(activity: st
95
95
  *
96
96
  * @param actorRef The activity to stop.
97
97
  */
98
- export declare function stop<TContext, TEvent extends EventObject>(actorRef: string | Expr<TContext, TEvent, string | {
98
+ export declare function stop<TContext, TExpressionEvent extends EventObject, TEvent extends EventObject = TExpressionEvent>(actorRef: string | Expr<TContext, TExpressionEvent, string | {
99
99
  id: string;
100
- }>): StopAction<TContext, TEvent>;
100
+ }>): StopAction<TContext, TExpressionEvent, TEvent>;
101
101
  export declare function resolveStop<TContext, TEvent extends EventObject>(action: StopAction<TContext, TEvent>, context: TContext, _event: SCXML.Event<TEvent>): StopActionObject;
102
102
  /**
103
103
  * Updates the current context of the machine.
@@ -133,7 +133,7 @@ export declare function done(id: string, data?: any): DoneEventObject;
133
133
  */
134
134
  export declare function doneInvoke(id: string, data?: any): DoneEvent;
135
135
  export declare function error(id: string, data?: any): ErrorPlatformEvent & string;
136
- export declare function pure<TContext, TEvent extends EventObject>(getActions: (context: TContext, event: TEvent) => SingleOrArray<BaseActionObject | BaseActionObject['type'] | ActionObject<TContext, TEvent>> | undefined): PureAction<TContext, TEvent>;
136
+ export declare function pure<TContext, TExpressionEvent extends EventObject, TEvent extends EventObject = TExpressionEvent>(getActions: (context: TContext, event: TExpressionEvent) => SingleOrArray<BaseActionObject | BaseActionObject['type'] | ActionObject<TContext, TExpressionEvent, TEvent>> | undefined): PureAction<TContext, TExpressionEvent, TEvent>;
137
137
  /**
138
138
  * Forwards (sends) an event to a specified service.
139
139
  *
@@ -149,7 +149,7 @@ export declare function forwardTo<TContext, TEvent extends EventObject>(target:
149
149
  * @param options Options to pass into the send action creator.
150
150
  */
151
151
  export declare function escalate<TContext, TEvent extends EventObject, TErrorData = any>(errorData: TErrorData | ExprWithMeta<TContext, TEvent, TErrorData>, options?: SendActionOptions<TContext, TEvent>): SendAction<TContext, TEvent, AnyEventObject>;
152
- export declare function choose<TContext, TEvent extends EventObject>(conds: Array<ChooseCondition<TContext, TEvent>>): ChooseAction<TContext, TEvent>;
152
+ export declare function choose<TContext, TExpressionEvent extends EventObject, TEvent extends EventObject = TExpressionEvent>(conds: Array<ChooseCondition<TContext, TExpressionEvent, TEvent>>): ChooseAction<TContext, TExpressionEvent, TEvent>;
153
153
  export declare function resolveActions<TContext, TEvent extends EventObject>(machine: StateNode<TContext, any, TEvent, any, any, any>, currentState: State<TContext, TEvent, any, any, any> | undefined, currentContext: TContext, _event: SCXML.Event<TEvent>, actionBlocks: Array<{
154
154
  type: string;
155
155
  actions: Array<ActionObject<TContext, TEvent>>;
package/lib/types.d.ts CHANGED
@@ -78,9 +78,9 @@ export interface AssignMeta<TContext, TEvent extends EventObject> {
78
78
  export declare type ActionFunction<TContext, TExpressionEvent extends EventObject, TAction extends BaseActionObject = BaseActionObject, TEvent extends EventObject = TExpressionEvent> = {
79
79
  bivarianceHack(context: TContext, event: TExpressionEvent, meta: ActionMeta<TContext, TEvent, TAction>): void;
80
80
  }['bivarianceHack'];
81
- export interface ChooseCondition<TContext, TEvent extends EventObject> {
82
- cond?: Condition<TContext, TEvent>;
83
- actions: Actions<TContext, TEvent>;
81
+ export interface ChooseCondition<TContext, TExpressionEvent extends EventObject, TEvent extends EventObject = TExpressionEvent> {
82
+ cond?: Condition<TContext, TExpressionEvent>;
83
+ actions: Actions<TContext, TExpressionEvent, TEvent>;
84
84
  }
85
85
  export declare type Action<TContext, TExpressionEvent extends EventObject, TEvent extends EventObject = TExpressionEvent> = ActionType | BaseActionObject | ActionObject<TContext, TExpressionEvent, TEvent> | ActionFunction<TContext, TExpressionEvent, BaseActionObject, TEvent>;
86
86
  /**
@@ -1049,5 +1049,6 @@ declare type Matches<TypegenEnabledArg, TypegenDisabledArg> = {
1049
1049
  };
1050
1050
  export declare type StateValueFrom<TMachine extends AnyStateMachine> = StateFrom<TMachine>['matches'] extends Matches<infer TypegenEnabledArg, infer TypegenDisabledArg> ? TMachine['__TResolvedTypesMeta'] extends TypegenEnabled ? TypegenEnabledArg : TypegenDisabledArg : never;
1051
1051
  export declare type PredictableActionArgumentsExec = (action: ActionObject<unknown, EventObject>, context: unknown, _event: SCXML.Event<EventObject>) => void;
1052
+ export declare type TagsFrom<TMachine extends AnyStateMachine> = Parameters<StateFrom<TMachine>['hasTag']>[0];
1052
1053
  export {};
1053
1054
  //# sourceMappingURL=types.d.ts.map
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "xstate",
3
- "version": "4.36.0",
3
+ "version": "4.37.0",
4
4
  "description": "Finite State Machines and Statecharts for the Modern Web.",
5
5
  "main": "lib/index.js",
6
6
  "module": "es/index.js",