@xstate/effect 1.0.0-beta.1 → 1.0.0-beta.2

package/README.md

@@ -264,12 +264,13 @@ See [atoms and React](docs/atoms-and-react.md) for complete examples with import
 
 ## Testing and errors
 
-<!-- error types from src/errors.ts; timeout failure from src/actor.ts -->
+<!-- error types and causeFromError from src/errors.ts; timeout failure from src/actor.ts -->
 
 - Use `sendAndAwait` from `@xstate/effect` to acknowledge one event after its transition and immediate effects. It does not wait for child replies, invoked work, background actions or future timers.
 - Use `TestClock` to drive deadlines without waiting for real time.
 - `ActorStoppedError` reports a stop before an awaited result.
 - `EffectFailure<E>` carries the original `Cause<E>` in task and stream error snapshots, including defects and self-interruption.
+- Use `causeFromError(error)` to obtain the original Cause from `EffectFailure` or wrap an ordinary error. Use `Cause.findErrorOption` to inspect its typed failure.
 - Timed waits fail with Effect's `Cause.TimeoutError`.
 - `join` replays the original Cause and preserves a task's typed failure. Unexpected machine errors have type `unknown`.
 

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

@@ -53,6 +53,18 @@ declare const NotReadyError_base: new <A extends Record<string, any> = {}>(args:
 export declare class NotReadyError extends NotReadyError_base {
     get message(): string;
 }
+/**
+ * Returns an EffectFailure's original Cause, or wraps an ordinary error with
+ * Cause.fail. Defects and interruption in an existing Cause are preserved.
+ *
+ * @experimental
+ */
+export declare function causeFromError<E>(error: E): Cause.Cause<UnwrapEffectFailure<E>>;
+/**
+ * Extracts the typed failure from EffectFailure while retaining ordinary errors.
+ *
+ * @experimental
+ */
 export type UnwrapEffectFailure<E> = E extends EffectFailure<infer Failure> ? Failure : E;
 declare const EventRejectedError_base: new <A extends Record<string, any> = {}>(args: import("effect/Types").VoidIfEmpty<{ readonly [P in keyof A as P extends "_tag" ? never : P]: A[P]; }>) => Cause.YieldableError & {
     readonly _tag: "EventRejectedError";

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

@@ -4,7 +4,7 @@ export { EffectActor } from "./effectActor.js";
 export { sendAndAwait } from "./sendAndAwait.js";
 export { ActorScope, withActorScope } from "./actorScope.js";
 export { deadLetters, emitted, inspect, join, send, snapshots, waitFor, type EmittedEventFrom, type SendableEventFrom, type WaitForOptions } from "./actor.js";
-export { ActorStoppedError, EventRejectedError, EffectFailure, EffectInterruptedError } from "./errors.js";
+export { ActorStoppedError, EventRejectedError, EffectFailure, EffectInterruptedError, causeFromError, type UnwrapEffectFailure } from "./errors.js";
 export { setupEffect, type EffectAction, type EffectActionArgs, type EffectSetupReturn } from "./setupEffect.js";
 export { type RequirementsFrom } from "./types.js";
 export { taggedState, type StateTag, type TaggedState, type TaggedStateFrom } from "./state.js";

package/dist/{state-83513b45.js → state-54c1cda0.js}

@@ -79,10 +79,22 @@ class NotReadyError extends Data.TaggedError('NotReadyError') {
   }
 }
 
-/** @internal */
+/**
+ * Returns an EffectFailure's original Cause, or wraps an ordinary error with
+ * Cause.fail. Defects and interruption in an existing Cause are preserved.
+ *
+ * @experimental
+ */
 function causeFromError(error) {
   return error instanceof EffectFailure ? error.cause : Cause.fail(error);
 }
+
+/**
+ * Extracts the typed failure from EffectFailure while retaining ordinary errors.
+ *
+ * @experimental
+ */
+
 /**
  * An event rejected at the actor's delivery boundary.
  *
@@ -576,15 +588,16 @@ function closeEffectHost(host) {
     discard: true
   }).pipe(Effect.andThen(Scope.close(host.scope, Exit.void))));
 }
+const EFFECT_FORWARD = 'xstate.effect.forward';
 
-/**
- * Delivers a stream item to the parent as an event. This runs outside a
- * transition, so it uses the system relay like core's observable logic does.
- */
+/** Queues a stream item for the source actor to forward in its transition. */
 function relayToParent(actor, event) {
   const actorWithParent = actor;
   if (actorWithParent._parent) {
-    actor.system._relay(actorWithParent, actorWithParent._parent, event);
+    actor.system._relay(actorWithParent, actorWithParent, {
+      type: EFFECT_FORWARD,
+      event
+    });
   }
 }
 
@@ -987,4 +1000,4 @@ function taggedState(snapshot) {
   };
 }
 
-export { ActorStoppedError as A, EffectFailure as E, NotReadyError as N, causeFromError as a, runHostedEffect as b, createEffectActor as c, EffectActor as d, ActorScope as e, EventRejectedError as f, EffectInterruptedError as g, relayToParent as r, startHostedEffect as s, taggedState as t, withActorScope as w };
+export { ActorStoppedError as A, EFFECT_FORWARD as E, NotReadyError as N, causeFromError as a, EffectFailure as b, createEffectActor as c, runHostedEffect as d, EffectActor as e, ActorScope as f, EventRejectedError as g, EffectInterruptedError as h, relayToParent as r, startHostedEffect as s, taggedState as t, withActorScope as w };

package/dist/xstate-effect-atom.js

@@ -1,8 +1,8 @@
 import { Cause } from 'effect';
 import { Atom, AsyncResult } from 'effect/reactivity';
 import { StateMachine } from 'xstate';
-import { c as createEffectActor, a as causeFromError, N as NotReadyError, t as taggedState } from './state-83513b45.js';
-export { N as NotReadyError } from './state-83513b45.js';
+import { c as createEffectActor, a as causeFromError, N as NotReadyError, t as taggedState } from './state-54c1cda0.js';
+export { N as NotReadyError } from './state-54c1cda0.js';
 import 'xstate/durable';
 
 /**

package/dist/xstate-effect.js

@@ -1,7 +1,7 @@
 import { Schema, Effect, Stream, Cause, Exit, Queue, Data } from 'effect';
 import { createStepLogic, setup } from 'xstate';
-import { s as startHostedEffect, r as relayToParent, E as EffectFailure, A as ActorStoppedError, a as causeFromError, b as runHostedEffect } from './state-83513b45.js';
-export { e as ActorScope, A as ActorStoppedError, d as EffectActor, E as EffectFailure, g as EffectInterruptedError, f as EventRejectedError, c as createEffectActor, t as taggedState, w as withActorScope } from './state-83513b45.js';
+import { s as startHostedEffect, E as EFFECT_FORWARD, r as relayToParent, b as EffectFailure, A as ActorStoppedError, a as causeFromError, d as runHostedEffect } from './state-54c1cda0.js';
+export { f as ActorScope, A as ActorStoppedError, e as EffectActor, b as EffectFailure, h as EffectInterruptedError, g as EventRejectedError, a as causeFromError, c as createEffectActor, t as taggedState, w as withActorScope } from './state-54c1cda0.js';
 export { s as sendAndAwait } from './sendAndAwait-bf1d4117.js';
 import { dual } from 'effect/Function';
 import 'xstate/durable';
@@ -390,7 +390,9 @@ function createEffectEventStreamLogic(sourceOrConfig) {
   const stream = config.stream;
   const logic = createStepLogic({
     id: config.id,
-    validator: config.validator,
+    validator: config.validator && {
+      check: request => request.kind === 'event' && request.event.type === EFFECT_FORWARD ? undefined : config.validator.check(request)
+    },
     schemas: toLogicSchemas(config.schemas),
     context: undefined,
     run: ({
@@ -399,6 +401,10 @@ function createEffectEventStreamLogic(sourceOrConfig) {
       self,
       system
     }, enq) => {
+      if (event.type === EFFECT_FORWARD) {
+        enq.sendBack(event.event);
+        return;
+      }
       if (event.type === EFFECT_COMPLETE) {
         return {
           status: 'done',
@@ -434,6 +440,9 @@ function createEffectEventStreamLogic(sourceOrConfig) {
       }));
     }
   });
+  Object.assign(logic, {
+    isInternalEventType: eventType => eventType === EFFECT_FORWARD
+  });
   return brandLogic(logic, undefined, undefined);
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xstate/effect",
-  "version": "1.0.0-beta.1",
+  "version": "1.0.0-beta.2",
   "type": "module",
   "description": "Effect integration for XState",
   "keywords": [
@@ -33,14 +33,14 @@
   "peerDependencies": {
     "@oxlint/plugins": "^1.76.0",
     "effect": "^4.0.0",
-    "xstate": "^6.0.0-beta.2"
+    "xstate": "^6.0.0-beta.3"
   },
   "devDependencies": {
     "@oxlint/plugins": "^1.76.0",
     "effect": "4.0.6",
     "fast-check": "4.10.2",
     "@xstate/test": "^2.0.0-beta.1",
-    "xstate": "^6.0.0-beta.2"
+    "xstate": "^6.0.0-beta.3"
   },
   "preconstruct": {
     "entrypoints": [