@xstate/effect 0.1.0-alpha.7 → 1.0.0-alpha.11

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

@@ -1,6 +1,5 @@
 import { Effect } from 'effect';
-import { type ActorLogicValidator, type AnyActorRef, type EventObject, type MachineContext, type SetupConfig, type SetupReturn, type SetupSchemas, type SetupStateSchema, type Sources, type SystemRegistry, type SystemRuntime } from 'xstate';
-import { effectActionBrand } from "./brands.js";
+import { type ActorLogicValidator, type AnyActorRef, type EventObject, type MachineContext, type InferEvents, type StandardSchemaV1, type SetupConfig, type SetupReturn, type SetupSchemas, type SetupStateSchema, type Sources, type SystemRegistry, type SystemRuntime } from 'xstate';
 import type { EffectRequirements } from "./types.js";
 import { type EffectSetupSchemas, type EffectSetupStateSchema, type ToStandardSetupSchemas, type ToStandardSetupStates, type ValidateEffectSetupSchemas, type ValidateEffectSetupStates } from "./schema.js";
 /**
@@ -33,19 +32,53 @@ export type EffectActionArgs<TContext extends MachineContext = MachineContext, T
  */
 export type EffectAction<TContext extends MachineContext = MachineContext, TEvent extends EventObject = EventObject, TError = unknown, TRequirements = never> = (args: EffectActionArgs<TContext, TEvent>) => Effect.Effect<void, TError, TRequirements>;
 type AnyEffectAction = EffectAction<any, any, any, any>;
+type EffectActionSource = (...args: never[]) => Effect.Effect<void, any, any>;
+type ActionContext<TSchemas> = TSchemas extends {
+    context: infer TContext extends StandardSchemaV1;
+} ? Extract<StandardSchemaV1.InferOutput<TContext>, MachineContext> : Record<string, unknown>;
+type ActionEvents<TSchemas> = (TSchemas extends {
+    events: infer TEvents extends Record<string, StandardSchemaV1>;
+} ? InferEvents<TEvents> : EventObject) | (TSchemas extends {
+    internalEvents: infer TEvents extends Record<string, StandardSchemaV1>;
+} ? string extends keyof TEvents ? never : InferEvents<TEvents> : never);
+type ActionInput<TSchemas, TKey extends PropertyKey> = TSchemas extends {
+    actions: {
+        [K in TKey]: {
+            params: infer TParams extends StandardSchemaV1;
+        };
+    };
+} ? StandardSchemaV1.InferOutput<TParams> & Pick<EffectActionArgs, 'self'> : EffectActionArgs<ActionContext<TSchemas>, ActionEvents<TSchemas>>;
+type ActionSources<TSchemas, TActionMap> = {
+    [K in keyof TActionMap]: (args: ActionInput<TSchemas, K>) => Effect.Effect<void, any, any>;
+};
+type AnnotatedActionSources<TSchemas, TActionMap> = TActionMap extends {
+    [K in keyof TActionMap]: TSchemas extends {
+        actions: {
+            [P in K]: {
+                params: StandardSchemaV1;
+            };
+        };
+    } ? ActionSources<TSchemas, TActionMap>[K] : AnyEffectAction;
+} ? unknown : never;
 type EffectActionRequirements<TAction> = TAction extends (...args: any[]) => infer TResult ? EffectRequirements<TResult> : never;
-type CoreEffectAction<TAction> = TAction extends (...args: infer TArgs) => any ? ((...args: TArgs) => void) & {
-    readonly [effectActionBrand]?: EffectActionRequirements<TAction>;
+type CoreEffectAction<TAction, TInput = never> = TAction extends (...args: infer TArgs) => any ? ((...args: [TInput] extends [never] ? TArgs : [args: TInput]) => void) & {
+    readonly '~effectRequirements'?: EffectActionRequirements<TAction>;
 } : never;
-type CoreEffectActionMap<TActionMap> = {
-    [K in keyof TActionMap]: CoreEffectAction<TActionMap[K]>;
+type CoreEffectActionMap<TActionMap, TSchemas> = {
+    [K in keyof TActionMap]: CoreEffectAction<TActionMap[K], TSchemas extends {
+        actions: {
+            [P in K]: {
+                params: StandardSchemaV1;
+            };
+        };
+    } ? ActionInput<TSchemas, K> : never>;
 };
-type EffectSetupConfig<TSchemas extends EffectSetupSchemas, TStates extends Record<string, EffectSetupStateSchema>, TActionMap extends Record<string, AnyEffectAction>, TActorMap extends Sources['actors'], TGuardMap extends Sources['guards'], TDelayMap extends Sources['delays'], TValidator extends ActorLogicValidator | undefined, TSourceSchemas extends SetupSchemas = ToStandardSetupSchemas<TSchemas>> = {
+type EffectSetupConfig<TSchemas extends EffectSetupSchemas, TStates extends Record<string, EffectSetupStateSchema>, TActionMap extends Record<string, EffectActionSource>, TActorMap extends Sources['actors'], TGuardMap extends Sources['guards'], TDelayMap extends Sources['delays'], TValidator extends ActorLogicValidator | undefined, TSourceSchemas extends SetupSchemas = ToStandardSetupSchemas<TSchemas>, TContextualActions extends boolean = true> = {
     validator?: TValidator;
-    actions?: TActionMap & Record<string, AnyEffectAction>;
+    actions?: TActionMap & (TContextualActions extends true ? ActionSources<NoInfer<TSourceSchemas>, TActionMap> : AnnotatedActionSources<NoInfer<TSourceSchemas>, TActionMap>);
     actors?: TActorMap;
-    guards?: NonNullable<SetupConfig<TSourceSchemas, ToStandardSetupStates<TStates>, CoreEffectActionMap<TActionMap>, TActorMap, TGuardMap, TDelayMap, TValidator>['guards']>;
-    delays?: NonNullable<SetupConfig<TSourceSchemas, ToStandardSetupStates<TStates>, CoreEffectActionMap<TActionMap>, TActorMap, TGuardMap, TDelayMap, TValidator>['delays']>;
+    guards?: NonNullable<SetupConfig<TSourceSchemas, ToStandardSetupStates<TStates>, CoreEffectActionMap<TActionMap, TSourceSchemas>, TActorMap, TGuardMap, TDelayMap, TValidator>['guards']>;
+    delays?: NonNullable<SetupConfig<TSourceSchemas, ToStandardSetupStates<TStates>, CoreEffectActionMap<TActionMap, TSourceSchemas>, TActorMap, TGuardMap, TDelayMap, TValidator>['delays']>;
     schemas?: TSchemas & ([TValidator] extends [ActorLogicValidator] ? ValidateEffectSetupSchemas<TSchemas> : unknown);
     states?: TStates & ([TValidator] extends [ActorLogicValidator] ? ValidateEffectSetupStates<TStates> : unknown);
 };
@@ -71,7 +104,7 @@ type ExtendValidatorConfig<TExtension> = [TExtension] extends [
 } : {
     validator: TExtension;
 };
-type EffectSetupExtensionConfig<TBaseSchemas extends SetupSchemas, TBaseStates extends Record<string, SetupStateSchema>, TBaseValidator extends ActorLogicValidator | undefined, TExtensionSchemas extends EffectSetupSchemas, TExtensionStates extends Record<string, EffectSetupStateSchema>, TExtensionActionMap extends Record<string, AnyEffectAction>, TExtensionActorMap extends Sources['actors'], TExtensionGuardMap extends Sources['guards'], TExtensionDelayMap extends Sources['delays'], TExtensionValidator extends ActorLogicValidator | undefined | InheritedEffectValidator> = EffectSetupConfig<TExtensionSchemas, TExtensionStates, TExtensionActionMap, TExtensionActorMap, TExtensionGuardMap, TExtensionDelayMap, ResolveExtendedValidator<TBaseValidator, TExtensionValidator>, MergeSetupSchemas<TBaseSchemas, ToStandardSetupSchemas<TExtensionSchemas>>> & ExtendValidatorConfig<TExtensionValidator> & RuntimeValidationCompatibility<NoInfer<TBaseSchemas>, NoInfer<TBaseStates>, ResolveExtendedValidator<TBaseValidator, TExtensionValidator>>;
+type EffectSetupExtensionConfig<TBaseSchemas extends SetupSchemas, TBaseStates extends Record<string, SetupStateSchema>, TBaseValidator extends ActorLogicValidator | undefined, TExtensionSchemas extends EffectSetupSchemas, TExtensionStates extends Record<string, EffectSetupStateSchema>, TExtensionActionMap extends Record<string, EffectActionSource>, TExtensionActorMap extends Sources['actors'], TExtensionGuardMap extends Sources['guards'], TExtensionDelayMap extends Sources['delays'], TExtensionValidator extends ActorLogicValidator | undefined | InheritedEffectValidator, TContextualActions extends boolean = true> = EffectSetupConfig<TExtensionSchemas, TExtensionStates, TExtensionActionMap, TExtensionActorMap, TExtensionGuardMap, TExtensionDelayMap, ResolveExtendedValidator<TBaseValidator, TExtensionValidator>, MergeSetupSchemas<TBaseSchemas, ToStandardSetupSchemas<TExtensionSchemas>>, TContextualActions> & ExtendValidatorConfig<TExtensionValidator> & RuntimeValidationCompatibility<NoInfer<TBaseSchemas>, NoInfer<TBaseStates>, ResolveExtendedValidator<TBaseValidator, TExtensionValidator>>;
 /**
  * What `setupEffect` returns: the XState `SetupReturn` with an `extend` method
  * that also accepts Effect schemas and Effect-returning actions. Call
@@ -79,7 +112,8 @@ type EffectSetupExtensionConfig<TBaseSchemas extends SetupSchemas, TBaseStates e
  * contribute to `RequirementsFrom`.
  */
 export type EffectSetupReturn<TStates extends Record<string, SetupStateSchema> = Record<string, SetupStateSchema>, TSchemas extends SetupSchemas = {}, TSetupActionMap extends Sources['actions'] = {}, TSetupActorMap extends Sources['actors'] = {}, TSetupGuardMap extends Sources['guards'] = {}, TSetupDelayMap extends Sources['delays'] = {}, TSetupDelays extends string = Extract<keyof TSetupDelayMap, string>, TValidator extends ActorLogicValidator | undefined = undefined> = Omit<SetupReturn<TStates, TSchemas, TSetupActionMap, TSetupActorMap, TSetupGuardMap, TSetupDelayMap, TSetupDelays, SystemRegistry, TValidator>, 'extend'> & {
-    extend<const TExtensionSchemas extends EffectSetupSchemas = {}, const TExtensionStates extends Record<string, EffectSetupStateSchema> = {}, TExtensionActionMap extends Record<string, AnyEffectAction> = {}, TExtensionActorMap extends Sources['actors'] = {}, TExtensionGuardMap extends Sources['guards'] = {}, TExtensionDelayMap extends Sources['delays'] = {}, const TExtensionValidator extends ActorLogicValidator | undefined | InheritedEffectValidator = InheritedEffectValidator>(config: EffectSetupExtensionConfig<TSchemas, TStates, TValidator, TExtensionSchemas, TExtensionStates, TExtensionActionMap, TExtensionActorMap, TExtensionGuardMap, TExtensionDelayMap, TExtensionValidator>): EffectSetupReturn<MergeRecord<TStates, ToStandardSetupStates<TExtensionStates>>, MergeSetupSchemas<TSchemas, ToStandardSetupSchemas<TExtensionSchemas>>, MergeRecord<TSetupActionMap, CoreEffectActionMap<TExtensionActionMap>>, MergeRecord<TSetupActorMap, TExtensionActorMap>, MergeRecord<TSetupGuardMap, TExtensionGuardMap>, MergeRecord<TSetupDelayMap, TExtensionDelayMap>, TSetupDelays | Extract<keyof TExtensionDelayMap, string>, ResolveExtendedValidator<TValidator, TExtensionValidator>>;
+    extend<const TExtensionSchemas extends EffectSetupSchemas = {}, const TExtensionStates extends Record<string, EffectSetupStateSchema> = {}, TExtensionActionMap extends Record<string, EffectActionSource> = {}, TExtensionActorMap extends Sources['actors'] = {}, TExtensionGuardMap extends Sources['guards'] = {}, TExtensionDelayMap extends Sources['delays'] = {}, const TExtensionValidator extends ActorLogicValidator | undefined | InheritedEffectValidator = InheritedEffectValidator>(config: EffectSetupExtensionConfig<TSchemas, TStates, TValidator, TExtensionSchemas, TExtensionStates, TExtensionActionMap, TExtensionActorMap, TExtensionGuardMap, TExtensionDelayMap, TExtensionValidator>): EffectSetupReturn<MergeRecord<TStates, ToStandardSetupStates<TExtensionStates>>, MergeSetupSchemas<TSchemas, ToStandardSetupSchemas<TExtensionSchemas>>, MergeRecord<TSetupActionMap, CoreEffectActionMap<TExtensionActionMap, MergeSetupSchemas<TSchemas, ToStandardSetupSchemas<TExtensionSchemas>>>>, MergeRecord<TSetupActorMap, TExtensionActorMap>, MergeRecord<TSetupGuardMap, TExtensionGuardMap>, MergeRecord<TSetupDelayMap, TExtensionDelayMap>, TSetupDelays | Extract<keyof TExtensionDelayMap, string>, ResolveExtendedValidator<TValidator, TExtensionValidator>>;
+    extend<const TExtensionSchemas extends EffectSetupSchemas = {}, const TExtensionStates extends Record<string, EffectSetupStateSchema> = {}, TExtensionActionMap extends Record<string, EffectActionSource> = {}, TExtensionActorMap extends Sources['actors'] = {}, TExtensionGuardMap extends Sources['guards'] = {}, TExtensionDelayMap extends Sources['delays'] = {}, const TExtensionValidator extends ActorLogicValidator | undefined | InheritedEffectValidator = InheritedEffectValidator>(config: EffectSetupExtensionConfig<TSchemas, TStates, TValidator, TExtensionSchemas, TExtensionStates, TExtensionActionMap, TExtensionActorMap, TExtensionGuardMap, TExtensionDelayMap, TExtensionValidator, false>): EffectSetupReturn<MergeRecord<TStates, ToStandardSetupStates<TExtensionStates>>, MergeSetupSchemas<TSchemas, ToStandardSetupSchemas<TExtensionSchemas>>, MergeRecord<TSetupActionMap, CoreEffectActionMap<TExtensionActionMap, MergeSetupSchemas<TSchemas, ToStandardSetupSchemas<TExtensionSchemas>>>>, MergeRecord<TSetupActorMap, TExtensionActorMap>, MergeRecord<TSetupGuardMap, TExtensionGuardMap>, MergeRecord<TSetupDelayMap, TExtensionDelayMap>, TSetupDelays | Extract<keyof TExtensionDelayMap, string>, ResolveExtendedValidator<TValidator, TExtensionValidator>>;
 };
 /**
  * The Effect-aware form of XState's `setup`. It accepts Effect `Schema` values
@@ -90,5 +124,6 @@ export type EffectSetupReturn<TStates extends Record<string, SetupStateSchema> =
  * it must be started with `createEffectActor`.
  */
 export declare function setupEffect(): EffectSetupReturn;
-export declare function setupEffect<const TSchemas extends EffectSetupSchemas = {}, const TStates extends Record<string, EffectSetupStateSchema> = Record<string, EffectSetupStateSchema>, TActionMap extends Record<string, AnyEffectAction> = {}, TActorMap extends Sources['actors'] = {}, TGuardMap extends Sources['guards'] = {}, TDelayMap extends Sources['delays'] = {}, const TValidator extends ActorLogicValidator | undefined = undefined>(config: EffectSetupConfig<TSchemas, TStates, TActionMap, TActorMap, TGuardMap, TDelayMap, TValidator>): EffectSetupReturn<ToStandardSetupStates<TStates>, ToStandardSetupSchemas<TSchemas>, CoreEffectActionMap<TActionMap>, TActorMap, TGuardMap, TDelayMap, Extract<keyof TDelayMap, string>, TValidator>;
+export declare function setupEffect<const TSchemas extends EffectSetupSchemas = {}, const TStates extends Record<string, EffectSetupStateSchema> = Record<string, EffectSetupStateSchema>, TActionMap extends Record<string, EffectActionSource> = {}, TActorMap extends Sources['actors'] = {}, TGuardMap extends Sources['guards'] = {}, TDelayMap extends Sources['delays'] = {}, const TValidator extends ActorLogicValidator | undefined = undefined>(config: EffectSetupConfig<TSchemas, TStates, TActionMap, TActorMap, TGuardMap, TDelayMap, TValidator>): EffectSetupReturn<ToStandardSetupStates<TStates>, ToStandardSetupSchemas<TSchemas>, CoreEffectActionMap<TActionMap, ToStandardSetupSchemas<TSchemas>>, TActorMap, TGuardMap, TDelayMap, Extract<keyof TDelayMap, string>, TValidator>;
+export declare function setupEffect<const TSchemas extends EffectSetupSchemas = {}, const TStates extends Record<string, EffectSetupStateSchema> = Record<string, EffectSetupStateSchema>, TActionMap extends Record<string, EffectActionSource> = {}, TActorMap extends Sources['actors'] = {}, TGuardMap extends Sources['guards'] = {}, TDelayMap extends Sources['delays'] = {}, const TValidator extends ActorLogicValidator | undefined = undefined>(config: EffectSetupConfig<TSchemas, TStates, TActionMap, TActorMap, TGuardMap, TDelayMap, TValidator, ToStandardSetupSchemas<TSchemas>, false>): EffectSetupReturn<ToStandardSetupStates<TStates>, ToStandardSetupSchemas<TSchemas>, CoreEffectActionMap<TActionMap, ToStandardSetupSchemas<TSchemas>>, TActorMap, TGuardMap, TDelayMap, Extract<keyof TDelayMap, string>, TValidator>;
 export {};

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

@@ -1,18 +1,19 @@
 import type { AnyMachineSnapshot, AnyStateMachine, MachineContext, MachineSnapshot, SnapshotFrom, StateContextFromStateValue, StateSchema, StateValueFromStateSchema } from 'xstate';
 type IsUnion<T, U = T> = T extends unknown ? [U] extends [T] ? false : true : never;
 type Join<TPrefix extends string, TKey extends string> = TPrefix extends '' ? TKey : `${TPrefix}.${TKey}`;
-/** The tag of the machine itself, used when the root state is parallel. */
-declare const MACHINE_TAG = "(machine)";
 /**
  * The dotted path of a state value: `'idle'`, `'form.editing'`. A parallel
- * state has no single path, so its tag stops at the parallel state, or is
- * `'(machine)'` when the machine itself is parallel.
+ * state has no single path, so its tag stops at the parallel state. When the
+ * machine itself is parallel, the tag is `TRootTag`: the machine id, or `''`
+ * for a machine without one.
  */
-export type StateTag<TValue, TPrefix extends string = ''> = string extends TValue ? string : TValue extends string ? Join<TPrefix, TValue> : TValue extends object ? string extends keyof TValue ? string : IsUnion<keyof TValue & string> extends true ? TPrefix extends '' ? typeof MACHINE_TAG : TPrefix : {
-    [K in keyof TValue & string]: StateTag<TValue[K], Join<TPrefix, K>>;
+export type StateTag<TValue, TPrefix extends string = '', TRootTag extends string = ''> = string extends TValue ? string : TValue extends string ? Join<TPrefix, TValue> : TValue extends object ? string extends keyof TValue ? string : IsUnion<keyof TValue & string> extends true ? TPrefix extends '' ? TRootTag : TPrefix : {
+    [K in keyof TValue & string]: StateTag<TValue[K], Join<TPrefix, K>, TRootTag>;
 }[keyof TValue & string] : never;
 type TaggedStateOf<TSnapshot, TValue, TContext extends MachineContext, TSchema extends StateSchema> = TValue extends unknown ? {
-    readonly _tag: StateTag<TValue>;
+    readonly _tag: StateTag<TValue, '', TSchema extends {
+        id: infer TId extends string;
+    } ? TId : ''>;
     readonly value: TValue;
     readonly context: StateContextFromStateValue<TSchema, TContext, TValue>;
     readonly snapshot: TSnapshot;

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

@@ -0,0 +1,11 @@
+import type { Effect } from 'effect';
+import type { AnyActorLogic, EventFromLogic, SnapshotFrom } from 'xstate';
+import type { EffectActor } from "./effectActor.js";
+import type { ActorStoppedError, EventRejectedError } from "./errors.js";
+/**
+ * Sends one mailbox item and awaits its macrostep publication and immediate
+ * effect scheduling. Ignored events are acknowledged too. Does not await
+ * invoked work, background actions or future timers. Interrupting the waiter
+ * detaches its receipt without retracting the event.
+ */
+export declare function sendAndAwait<TLogic extends AnyActorLogic>(actor: EffectActor<TLogic>, event: EventFromLogic<TLogic>): Effect.Effect<SnapshotFrom<TLogic>, ActorStoppedError | EventRejectedError>;

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

@@ -1,11 +1,10 @@
 import type { Effect, Scope } from 'effect';
-import type { EffectLogicBrand } from "./fromEffect.js";
-import { effectActionBrand } from "./brands.js";
+import type { EffectLogicBrand } from "./effectLogic.js";
 import type { ActorScope } from "./actorScope.js";
 /** The `R` channel of an Effect type, or `never` for anything else. */
 export type EffectRequirements<T> = T extends Effect.Effect<any, any, infer R> ? R : never;
 type RequirementsFromActions<T> = T extends Record<string, (...args: any[]) => any> ? T[keyof T] extends infer TAction ? TAction extends {
-    readonly [effectActionBrand]?: infer R;
+    readonly '~effectRequirements'?: infer R;
 } ? unknown extends R ? EffectRequirements<TAction extends (...args: any[]) => infer TResult ? TResult : never> : Exclude<R, undefined> : EffectRequirements<TAction extends (...args: any[]) => infer TResult ? TResult : never> : never : never;
 /**
  * Recursion budget for walking registered child machines. A machine cannot