xstate 5.0.0-alpha.0 → 5.0.0-alpha.1

package/dist/declarations/src/utils.d.ts

@@ -1,56 +1,54 @@
-import { NULL_EVENT } from './constants';
-import type { StateNode } from './StateNode';
-import type { Behavior, BehaviorCreator, Event, EventObject, EventType, InvokeConfig, InvokeSourceDefinition, MachineContext, Mapper, Observer, PropertyMapper, SCXML, SCXMLErrorEvent, SingleOrArray, StateLike, StateValue, Subscribable, TransitionConfig, TransitionConfigTarget } from './types';
-import { AnyStateMachine } from './types';
-export declare function keys<T extends object>(value: T): Array<keyof T & string>;
-export declare function matchesState(parentStateId: StateValue, childStateId: StateValue, delimiter?: string): boolean;
-export declare function getEventType<TEvent extends EventObject = EventObject>(event: Event<TEvent>): TEvent['type'];
-export declare function toStatePath(stateId: string | string[], delimiter: string): string[];
-export declare function isStateLike(state: any): state is StateLike<any>;
-export declare function toStateValue(stateValue: StateLike<any> | StateValue | string[], delimiter: string): StateValue;
-export declare function pathToStateValue(statePath: string[]): StateValue;
-export declare function mapValues<P, O extends Record<string, unknown>>(collection: O, iteratee: (item: O[keyof O], key: keyof O, collection: O, i: number) => P): {
-    [key in keyof O]: P;
-};
-export declare function mapFilterValues<T, P>(collection: {
-    [key: string]: T;
-}, iteratee: (item: T, key: string, collection: {
-    [key: string]: T;
-}) => P, predicate: (item: T) => boolean): {
-    [key: string]: P;
-};
-/**
- * Retrieves a value at the given path.
- * @param props The deep path to the prop of the desired value
- */
-export declare function path<T extends Record<string, any>>(props: string[]): any;
-export declare function toStatePaths(stateValue: StateValue | undefined): string[][];
-export declare function flatten<T>(array: Array<T | T[]>): T[];
-export declare function toArrayStrict<T>(value: T[] | T): T[];
-export declare function toArray<T>(value: T[] | T | undefined): T[];
-export declare function mapContext<TContext extends MachineContext, TEvent extends EventObject>(mapper: Mapper<TContext, TEvent, any> | PropertyMapper<TContext, TEvent, any>, context: TContext, _event: SCXML.Event<TEvent>): any;
-export declare function isBuiltInEvent(eventType: EventType): boolean;
-export declare function isPromiseLike(value: any): value is PromiseLike<any>;
-export declare function isBehavior(value: any): value is Behavior<any, any>;
-export declare function partition<T, A extends T, B extends T>(items: T[], predicate: (item: T) => item is A): [A[], B[]];
-export declare let warn: (condition: boolean | Error, message: string) => void;
-export declare function isArray(value: any): value is any[];
-export declare function isFunction(value: any): value is Function;
-export declare function isString(value: any): value is string;
-export declare function isObservable<T>(value: any): value is Subscribable<T>;
-export declare const symbolObservable: typeof Symbol.observable;
-export declare function isStateMachine(value: any): value is AnyStateMachine;
-export declare const uniqueId: () => string;
-export declare function toEventObject<TEvent extends EventObject>(event: Event<TEvent>, payload?: Record<string, any>): TEvent;
-export declare function isSCXMLEvent<TEvent extends EventObject>(event: Event<TEvent> | SCXML.Event<TEvent>): event is SCXML.Event<TEvent>;
-export declare function isSCXMLErrorEvent(event: SCXML.Event<any>): event is SCXMLErrorEvent;
-export declare function toSCXMLEvent<TEvent extends EventObject>(event: Event<TEvent> | SCXML.Event<TEvent>, scxmlEvent?: Partial<SCXML.Event<TEvent>>): SCXML.Event<TEvent>;
-export declare function toTransitionConfigArray<TContext extends MachineContext, TEvent extends EventObject>(event: TEvent['type'] | typeof NULL_EVENT | '*', configLike: SingleOrArray<TransitionConfig<TContext, TEvent> | TransitionConfigTarget<TContext, TEvent>>): Array<TransitionConfig<TContext, TEvent> & {
-    event: TEvent['type'] | typeof NULL_EVENT | '*';
-}>;
-export declare function normalizeTarget<TContext extends MachineContext, TEvent extends EventObject>(target: SingleOrArray<string | StateNode<TContext, TEvent>> | undefined): Array<string | StateNode<TContext, TEvent>> | undefined;
-export declare function reportUnhandledExceptionOnInvocation(originalError: any, currentError: any, id: string): void;
-export declare function toInvokeConfig<TContext extends MachineContext, TEvent extends EventObject>(invocable: InvokeConfig<TContext, TEvent> | string | BehaviorCreator<TContext, TEvent> | Behavior<any, any>, id: string): InvokeConfig<TContext, TEvent>;
-export declare function toInvokeSource(src: string | InvokeSourceDefinition): InvokeSourceDefinition;
-export declare function toObserver<T>(nextHandler: Observer<T> | ((value: T) => void), errorHandler?: (error: any) => void, completionHandler?: () => void): Observer<T>;
-export declare function createInvokeId(stateNodeId: string, index: number): string;
+import { AnyState } from '.';
+import { NULL_EVENT } from './constants';
+import type { StateNode } from './StateNode';
+import type { Behavior, BehaviorCreator, EventObject, EventType, InvokeConfig, InvokeSourceDefinition, MachineContext, Mapper, Observer, PropertyMapper, SCXML, SCXMLErrorEvent, SingleOrArray, StateLike, StateValue, Subscribable, TransitionConfig, TransitionConfigTarget } from './types';
+import { AnyStateMachine } from './types';
+export declare function keys<T extends object>(value: T): Array<keyof T & string>;
+export declare function matchesState(parentStateId: StateValue, childStateId: StateValue, delimiter?: string): boolean;
+export declare function toStatePath(stateId: string | string[], delimiter: string): string[];
+export declare function isStateLike(state: any): state is AnyState;
+export declare function toStateValue(stateValue: StateLike<any> | StateValue | string[], delimiter: string): StateValue;
+export declare function pathToStateValue(statePath: string[]): StateValue;
+export declare function mapValues<P, O extends Record<string, unknown>>(collection: O, iteratee: (item: O[keyof O], key: keyof O, collection: O, i: number) => P): {
+    [key in keyof O]: P;
+};
+export declare function mapFilterValues<T, P>(collection: {
+    [key: string]: T;
+}, iteratee: (item: T, key: string, collection: {
+    [key: string]: T;
+}) => P, predicate: (item: T) => boolean): {
+    [key: string]: P;
+};
+/**
+ * Retrieves a value at the given path.
+ * @param props The deep path to the prop of the desired value
+ */
+export declare function path<T extends Record<string, any>>(props: string[]): any;
+export declare function toStatePaths(stateValue: StateValue | undefined): string[][];
+export declare function flatten<T>(array: Array<T | T[]>): T[];
+export declare function toArrayStrict<T>(value: T[] | T): T[];
+export declare function toArray<T>(value: T[] | T | undefined): T[];
+export declare function mapContext<TContext extends MachineContext, TEvent extends EventObject>(mapper: Mapper<TContext, TEvent, any> | PropertyMapper<TContext, TEvent, any>, context: TContext, _event: SCXML.Event<TEvent>): any;
+export declare function isBuiltInEvent(eventType: EventType): boolean;
+export declare function isPromiseLike(value: any): value is PromiseLike<any>;
+export declare function isBehavior(value: any): value is Behavior<any, any>;
+export declare function partition<T, A extends T, B extends T>(items: T[], predicate: (item: T) => item is A): [A[], B[]];
+export declare let warn: (condition: boolean | Error, message: string) => void;
+export declare function isArray(value: any): value is any[];
+export declare function isFunction(value: any): value is Function;
+export declare function isString(value: any): value is string;
+export declare function isObservable<T>(value: any): value is Subscribable<T>;
+export declare function isStateMachine(value: any): value is AnyStateMachine;
+export declare const uniqueId: () => string;
+export declare function isSCXMLEvent<TEvent extends EventObject>(event: TEvent | SCXML.Event<TEvent>): event is SCXML.Event<TEvent>;
+export declare function isSCXMLErrorEvent(event: SCXML.Event<any>): event is SCXMLErrorEvent;
+export declare function toSCXMLEvent<TEvent extends EventObject>(event: TEvent | SCXML.Event<TEvent>, scxmlEvent?: Partial<SCXML.Event<TEvent>>): SCXML.Event<TEvent>;
+export declare function toTransitionConfigArray<TContext extends MachineContext, TEvent extends EventObject>(event: TEvent['type'] | typeof NULL_EVENT | '*', configLike: SingleOrArray<TransitionConfig<TContext, TEvent> | TransitionConfigTarget<TContext, TEvent>>): Array<TransitionConfig<TContext, TEvent> & {
+    event: TEvent['type'] | typeof NULL_EVENT | '*';
+}>;
+export declare function normalizeTarget<TContext extends MachineContext, TEvent extends EventObject>(target: SingleOrArray<string | StateNode<TContext, TEvent>> | undefined): Array<string | StateNode<TContext, TEvent>> | undefined;
+export declare function reportUnhandledExceptionOnInvocation(originalError: any, currentError: any, id: string): void;
+export declare function toInvokeConfig<TContext extends MachineContext, TEvent extends EventObject>(invocable: InvokeConfig<TContext, TEvent> | string | BehaviorCreator<TContext, TEvent> | Behavior<any, any>, id: string): InvokeConfig<TContext, TEvent>;
+export declare function toInvokeSource(src: string | InvokeSourceDefinition): InvokeSourceDefinition;
+export declare function toObserver<T>(nextHandler?: Observer<T> | ((value: T) => void), errorHandler?: (error: any) => void, completionHandler?: () => void): Observer<T>;
+export declare function createInvokeId(stateNodeId: string, index: number): string;