@rxova/journey-react 0.7.0 → 1.0.0-rc.1

package/dist/types.d.ts

@@ -1,56 +1,58 @@
 import type React from "react";
-import type { JourneyDefinition, JourneyEqualityFn, JourneyEventPayloadMap as JourneyCoreEventPayloadMap, JourneyMachine, JourneyObservationEvent, JourneyPayloadFor, JourneyPersistenceOptions, JourneySelector, JourneySendEvent, JourneySendResult, JourneySnapshot, JourneyStepDefinition } from "@rxova/journey-core";
-export type JourneyDefaultEvent = "goToNextStep" | "goToPreviousStep" | "terminateJourney" | "completeJourney";
-export type JourneyEventType<TCustomEvent extends string = never> = JourneyDefaultEvent | TCustomEvent;
-export type JourneyReactEventPayloadMap<TCustomEvent extends string = never> = JourneyCoreEventPayloadMap<JourneyEventType<TCustomEvent>>;
-export type JourneyReactStep<TStepMeta = unknown> = JourneyStepDefinition<TStepMeta> & {
-    component: React.ComponentType;
+import type { JourneyCompleteObservationEvent, JourneyComputed, JourneyDefaultEventType, JourneyEqualityFn, JourneyJsonObject, JourneyMachinePlugin, JourneyMachineWithPlugins, JourneyObservationEvent, JourneyPayloadFor, JourneySelector, JourneySendEvent, JourneySendResult, JourneyStartObservationEvent, JourneyTerminateObservationEvent, JourneySnapshot } from "@rxova/journey-core";
+export type JourneyDefaultEvent = JourneyDefaultEventType;
+export type JourneyViews<TStepId extends string> = Record<TStepId, React.ComponentType>;
+type JourneyTypeParam<TValue> = TValue extends unknown ? unknown : never;
+type JourneyCompatEventAliasContext<TEventMap extends Record<string, unknown>, TStepMeta = unknown> = (JourneyObservationEvent<string, TEventMap> extends never ? never : unknown) & JourneyTypeParam<TStepMeta>;
+export type JourneyApi<TContext extends JourneyJsonObject, TStepId extends string, TEventMap extends Record<string, unknown> = Record<never, never>, TStepMeta = unknown> = {
+    start: () => Promise<JourneySnapshot<TContext, TStepId>>;
+    send: (event: JourneySendEvent<TStepId, TEventMap>) => Promise<JourneySendResult<TContext, TStepId>>;
+    goToNextStep: () => Promise<JourneySendResult<TContext, TStepId>>;
+    goToStepById: (stepId: TStepId) => Promise<JourneySendResult<TContext, TStepId>>;
+    terminateJourney: (payload?: JourneyPayloadFor<TEventMap, "terminateJourney">) => Promise<JourneySendResult<TContext, TStepId>>;
+    completeJourney: (payload?: JourneyPayloadFor<TEventMap, "completeJourney">) => Promise<JourneySendResult<TContext, TStepId>>;
+    goToPreviousStep: (steps?: number) => Promise<JourneySendResult<TContext, TStepId>>;
+    goToLastVisitedStep: () => Promise<JourneySendResult<TContext, TStepId>>;
+    clearStepError: (stepId?: TStepId) => Promise<JourneySnapshot<TContext, TStepId>>;
+    updateContext: (updater: (context: TContext) => TContext) => Promise<JourneySnapshot<TContext, TStepId>>;
+    getStepMeta: (stepId: TStepId) => TStepMeta | undefined;
+    resetJourney: () => Promise<JourneySnapshot<TContext, TStepId>>;
 };
-export type JourneyReactDefinition<TContext, TStepId extends string, TCustomEvent extends string = never, TEventPayloadMap extends JourneyReactEventPayloadMap<TCustomEvent> = Record<never, never>, TStepMeta = unknown> = Omit<JourneyDefinition<TContext, TStepId, JourneyEventType<TCustomEvent>, TEventPayloadMap, TStepMeta>, "steps"> & {
-    steps: Record<TStepId, JourneyReactStep<TStepMeta>>;
+export type JourneyStartEvent<TStepId extends string, TEventMap extends Record<string, unknown> = Record<never, never>, TStepMeta = unknown> = JourneyStartObservationEvent<TStepId> & JourneyCompatEventAliasContext<TEventMap, TStepMeta>;
+export type JourneyCompleteEvent<TStepId extends string, TEventMap extends Record<string, unknown> = Record<never, never>, TStepMeta = unknown> = JourneyCompleteObservationEvent<TStepId> & JourneyCompatEventAliasContext<TEventMap, TStepMeta>;
+export type JourneyTerminateEvent<TStepId extends string, TEventMap extends Record<string, unknown> = Record<never, never>, TStepMeta = unknown> = JourneyTerminateObservationEvent<TStepId> & JourneyCompatEventAliasContext<TEventMap, TStepMeta>;
+export type JourneyProviderErrorContext = {
+    phase: "start";
 };
-export type JourneyApi<TContext, TStepId extends string, TCustomEvent extends string = never, TEventPayloadMap extends JourneyReactEventPayloadMap<TCustomEvent> = Record<never, never>, TStepMeta = unknown> = {
-    send: (event: JourneySendEvent<TStepId, JourneyEventType<TCustomEvent>, TEventPayloadMap>) => Promise<JourneySendResult<TContext, TStepId, TStepMeta>>;
-    goToNextStep: () => Promise<JourneySendResult<TContext, TStepId, TStepMeta>>;
-    terminateJourney: (payload?: JourneyPayloadFor<JourneyEventType<TCustomEvent>, TEventPayloadMap, "terminateJourney">) => Promise<JourneySendResult<TContext, TStepId, TStepMeta>>;
-    completeJourney: (payload?: JourneyPayloadFor<JourneyEventType<TCustomEvent>, TEventPayloadMap, "completeJourney">) => Promise<JourneySendResult<TContext, TStepId, TStepMeta>>;
-    goToPreviousStep: (steps?: number) => Promise<JourneySendResult<TContext, TStepId, TStepMeta>>;
-    goToLastVisitedStep: () => Promise<JourneySendResult<TContext, TStepId, TStepMeta>>;
-    clearStepError: (stepId?: TStepId) => void;
-    updateContext: (updater: (context: TContext) => TContext) => void;
-    updateStepMetadata: (stepId: TStepId, updater: (metadata: TStepMeta) => TStepMeta) => void;
-    resetJourney: () => void;
-};
-export type JourneyStoreValue<TContext, TStepId extends string, TCustomEvent extends string = never, TEventPayloadMap extends JourneyReactEventPayloadMap<TCustomEvent> = Record<never, never>, TStepMeta = unknown> = {
-    machine: JourneyMachine<TContext, TStepId, JourneyEventType<TCustomEvent>, TEventPayloadMap, TStepMeta>;
-    journey: JourneyReactDefinition<TContext, TStepId, TCustomEvent, TEventPayloadMap, TStepMeta>;
-};
-export type JourneyBindingsProviderProps<TContext, TStepId extends string, TCustomEvent extends string = never, TEventPayloadMap extends JourneyReactEventPayloadMap<TCustomEvent> = Record<never, never>, TStepMeta = unknown> = {
-    journey?: JourneyReactDefinition<TContext, TStepId, TCustomEvent, TEventPayloadMap, TStepMeta>;
-    machine?: JourneyMachine<TContext, TStepId, JourneyEventType<TCustomEvent>, TEventPayloadMap, TStepMeta>;
-    persistence?: JourneyPersistenceOptions<TContext, TStepId, TStepMeta>;
-    completeOnNoNextStep?: boolean;
-    resetOnJourneyChange?: boolean;
-    resetOnPersistenceChange?: boolean;
-    onStart?: (event: Extract<JourneyObservationEvent<TStepId, JourneyEventType<TCustomEvent>, TEventPayloadMap, TStepMeta>, {
-        type: "journey.start";
-    }>) => void;
-    onComplete?: (event: Extract<JourneyObservationEvent<TStepId, JourneyEventType<TCustomEvent>, TEventPayloadMap, TStepMeta>, {
-        type: "journey.complete";
-    }>) => void;
-    onTerminate?: (event: Extract<JourneyObservationEvent<TStepId, JourneyEventType<TCustomEvent>, TEventPayloadMap, TStepMeta>, {
-        type: "journey.close";
-    }>) => void;
+export type JourneyProviderProps<TStepId extends string, TEventMap extends Record<string, unknown> = Record<never, never>, TStepMeta = unknown> = {
+    views: JourneyViews<TStepId>;
+    onStart?: (event: JourneyStartEvent<TStepId, TEventMap, TStepMeta>) => void;
+    onComplete?: (event: JourneyCompleteEvent<TStepId, TEventMap, TStepMeta>) => void;
+    onTerminate?: (event: JourneyTerminateEvent<TStepId, TEventMap, TStepMeta>) => void;
+    onError?: (error: unknown, context: JourneyProviderErrorContext) => void;
+    disposeOnUnmount?: boolean;
     children: React.ReactNode;
 };
-export type JourneyBindings<TContext, TStepId extends string, TCustomEvent extends string = never, TEventPayloadMap extends JourneyReactEventPayloadMap<TCustomEvent> = Record<never, never>, TStepMeta = unknown> = {
-    Provider: React.ComponentType<JourneyBindingsProviderProps<TContext, TStepId, TCustomEvent, TEventPayloadMap, TStepMeta>>;
+export type JourneyRuntime<TContext extends JourneyJsonObject, TStepId extends string, TEventMap extends Record<string, unknown> = Record<never, never>, TStepMeta = unknown, TPlugins extends readonly JourneyMachinePlugin[] = [], THandlers extends Record<string, unknown> = Record<never, never>> = {
+    machine: JourneyMachineWithPlugins<TContext, TStepId, TEventMap, TStepMeta, THandlers, TPlugins>;
+    dispose: () => void;
+    useJourneySnapshot: () => JourneySnapshot<TContext, TStepId>;
+    useJourneyComputed: () => JourneyComputed<TStepId>;
+    useJourneySelector: <TSelected>(selector: JourneySelector<TContext, TStepId, TSelected>, equalityFn?: JourneyEqualityFn<TSelected>) => TSelected;
+    useJourneyApi: () => JourneyApi<TContext, TStepId, TEventMap, TStepMeta>;
+    useJourneyEvent: (listener: (event: JourneyObservationEvent<TStepId, TEventMap>) => void) => void;
+    useJourneyStepLifecycle: (stepId: TStepId, callbacks: {
+        onEnter?: (args: {
+            context: TContext;
+        }) => void;
+        onLeave?: (args: {
+            context: TContext;
+        }) => void;
+    }) => void;
+    JourneyProvider: React.ComponentType<JourneyProviderProps<TStepId, TEventMap, TStepMeta>>;
     StepRenderer: React.ComponentType<{
         fallback?: React.ReactNode;
     }>;
-    useJourneyApi: () => JourneyApi<TContext, TStepId, TCustomEvent, TEventPayloadMap, TStepMeta>;
-    useJourneyMachine: () => JourneyMachine<TContext, TStepId, JourneyEventType<TCustomEvent>, TEventPayloadMap, TStepMeta>;
-    useJourneyEvent: (listener: (event: JourneyObservationEvent<TStepId, JourneyEventType<TCustomEvent>, TEventPayloadMap, TStepMeta>) => void) => void;
-    useJourneySelector: <TSelected>(selector: JourneySelector<TContext, TStepId, TStepMeta, TSelected>, equalityFn?: JourneyEqualityFn<TSelected>) => TSelected;
-    useJourneySnapshot: () => JourneySnapshot<TContext, TStepId, TStepMeta>;
 };
+export type JourneyRuntimeFactory<TContext extends JourneyJsonObject, TStepId extends string, TEventMap extends Record<string, unknown> = Record<never, never>, TStepMeta = unknown, TPlugins extends readonly JourneyMachinePlugin[] = [], THandlers extends Record<string, unknown> = Record<never, never>> = () => JourneyRuntime<TContext, TStepId, TEventMap, TStepMeta, TPlugins, THandlers>;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rxova/journey-react",
-  "version": "0.7.0",
+  "version": "1.0.0-rc.1",
   "description": "React bindings for journey.",
   "keywords": [
     "react",
@@ -38,6 +38,14 @@
       },
       "import": "./dist/index.js",
       "require": "./dist/index.cjs"
+    },
+    "./client": {
+      "types": {
+        "import": "./dist/client.d.ts",
+        "require": "./dist/client.d.cts"
+      },
+      "import": "./dist/client.js",
+      "require": "./dist/client.cjs"
     }
   },
   "files": [
@@ -46,23 +54,24 @@
     "LICENSE"
   ],
   "sideEffects": false,
-  "dependencies": {
-    "@rxova/journey-core": "^0.7.0"
-  },
   "peerDependencies": {
-    "react": ">=18.2.0"
+    "react": ">=18.2.0",
+    "@rxova/journey-core": "^1.0.0-rc.1"
   },
   "peerDependenciesMeta": {
+    "@rxova/journey-core": {
+      "optional": false
+    },
     "react": {
       "optional": false
     }
   },
   "size-limit": [
     {
-      "name": "react/createJourneyBindings",
+      "name": "react/createJourney",
       "path": "dist/index.js",
-      "import": "{ createJourneyBindings }",
-      "limit": "6 kB"
+      "import": "{ createJourney }",
+      "limit": "2 kB"
     }
   ],
   "devDependencies": {

package/dist/bindings/Provider.d.ts

@@ -1,8 +0,0 @@
-import React from "react";
-import type { JourneyBindingsProviderProps, JourneyReactDefinition, JourneyReactEventPayloadMap, JourneyStoreValue } from "../types";
-type ProviderFactoryProps<TContext, TStepId extends string, TCustomEvent extends string = never, TEventPayloadMap extends JourneyReactEventPayloadMap<TCustomEvent> = Record<never, never>, TStepMeta = unknown> = {
-    JourneyContext: React.Context<JourneyStoreValue<TContext, TStepId, TCustomEvent, TEventPayloadMap, TStepMeta> | null>;
-    boundJourney: JourneyReactDefinition<TContext, TStepId, TCustomEvent, TEventPayloadMap, TStepMeta>;
-};
-export declare const createProvider: <TContext, TStepId extends string, TCustomEvent extends string = never, TEventPayloadMap extends JourneyReactEventPayloadMap<TCustomEvent> = Record<never, never>, TStepMeta = unknown>({ JourneyContext, boundJourney }: ProviderFactoryProps<TContext, TStepId, TCustomEvent, TEventPayloadMap, TStepMeta>) => ({ journey, machine, persistence, completeOnNoNextStep, resetOnJourneyChange, resetOnPersistenceChange, onStart, onComplete, onTerminate, children }: JourneyBindingsProviderProps<TContext, TStepId, TCustomEvent, TEventPayloadMap, TStepMeta>) => import("react/jsx-runtime").JSX.Element;
-export {};

package/dist/bindings/StepRenderer.d.ts

@@ -1,13 +0,0 @@
-import React from "react";
-import type { JourneySnapshot } from "@rxova/journey-core";
-import type { JourneyReactEventPayloadMap, JourneyStoreValue } from "../types";
-type UseJourneyStore<TContext, TStepId extends string, TCustomEvent extends string = never, TEventPayloadMap extends JourneyReactEventPayloadMap<TCustomEvent> = Record<never, never>, TStepMeta = unknown> = (hookName?: string) => JourneyStoreValue<TContext, TStepId, TCustomEvent, TEventPayloadMap, TStepMeta>;
-type UseJourneySnapshot<TContext, TStepId extends string, TStepMeta = unknown> = () => JourneySnapshot<TContext, TStepId, TStepMeta>;
-type StepRendererFactoryProps<TContext, TStepId extends string, TCustomEvent extends string = never, TEventPayloadMap extends JourneyReactEventPayloadMap<TCustomEvent> = Record<never, never>, TStepMeta = unknown> = {
-    useJourneySnapshot: UseJourneySnapshot<TContext, TStepId, TStepMeta>;
-    useJourneyStore: UseJourneyStore<TContext, TStepId, TCustomEvent, TEventPayloadMap, TStepMeta>;
-};
-export declare const createStepRenderer: <TContext, TStepId extends string, TCustomEvent extends string = never, TEventPayloadMap extends JourneyReactEventPayloadMap<TCustomEvent> = Record<never, never>, TStepMeta = unknown>({ useJourneySnapshot, useJourneyStore }: StepRendererFactoryProps<TContext, TStepId, TCustomEvent, TEventPayloadMap, TStepMeta>) => ({ fallback }: {
-    fallback?: React.ReactNode;
-}) => import("react/jsx-runtime").JSX.Element;
-export {};

package/dist/bindings/index.d.ts

@@ -1,6 +0,0 @@
-import type { JourneyBindings, JourneyReactDefinition, JourneyReactEventPayloadMap } from "../types";
-/**
- * Creates a typed React integration bundle (Provider, StepRenderer, and hooks)
- * bound to a specific journey definition.
- */
-export declare const createJourneyBindings: <TContext, TStepId extends string, TCustomEvent extends string = never, TEventPayloadMap extends JourneyReactEventPayloadMap<TCustomEvent> = Record<never, never>, TStepMeta = unknown>(boundJourney: JourneyReactDefinition<TContext, TStepId, TCustomEvent, TEventPayloadMap, TStepMeta>) => JourneyBindings<TContext, TStepId, TCustomEvent, TEventPayloadMap, TStepMeta>;

package/dist/bindings/useJourneyApi.d.ts

@@ -1,16 +0,0 @@
-import type { JourneyPayloadFor, JourneySendEvent, JourneySendResult } from "@rxova/journey-core";
-import type { JourneyEventType, JourneyReactEventPayloadMap, JourneyStoreValue } from "../types";
-type UseJourneyStore<TContext, TStepId extends string, TCustomEvent extends string = never, TEventPayloadMap extends JourneyReactEventPayloadMap<TCustomEvent> = Record<never, never>, TStepMeta = unknown> = (hookName?: string) => JourneyStoreValue<TContext, TStepId, TCustomEvent, TEventPayloadMap, TStepMeta>;
-export declare const createUseJourneyApi: <TContext, TStepId extends string, TCustomEvent extends string = never, TEventPayloadMap extends JourneyReactEventPayloadMap<TCustomEvent> = Record<never, never>, TStepMeta = unknown>(useJourneyStore: UseJourneyStore<TContext, TStepId, TCustomEvent, TEventPayloadMap, TStepMeta>) => () => {
-    send: (event: JourneySendEvent<TStepId, JourneyEventType<TCustomEvent>, TEventPayloadMap>) => Promise<JourneySendResult<TContext, TStepId, TStepMeta>>;
-    goToNextStep: () => Promise<JourneySendResult<TContext, TStepId, TStepMeta>>;
-    terminateJourney: (payload?: JourneyPayloadFor<JourneyEventType<TCustomEvent>, TEventPayloadMap, "terminateJourney">) => Promise<JourneySendResult<TContext, TStepId, TStepMeta>>;
-    completeJourney: (payload?: JourneyPayloadFor<JourneyEventType<TCustomEvent>, TEventPayloadMap, "completeJourney">) => Promise<JourneySendResult<TContext, TStepId, TStepMeta>>;
-    goToPreviousStep: (steps?: number) => Promise<JourneySendResult<TContext, TStepId, TStepMeta>>;
-    goToLastVisitedStep: () => Promise<JourneySendResult<TContext, TStepId, TStepMeta>>;
-    clearStepError: (stepId?: TStepId) => void;
-    updateContext: (updater: (context: TContext) => TContext) => void;
-    updateStepMetadata: (stepId: TStepId, updater: (metadata: TStepMeta) => TStepMeta) => void;
-    resetJourney: () => void;
-};
-export {};

package/dist/bindings/useJourneyEvent.d.ts

@@ -1,5 +0,0 @@
-import type { JourneyObservationEvent } from "@rxova/journey-core";
-import type { JourneyEventType, JourneyReactEventPayloadMap, JourneyStoreValue } from "../types";
-type UseJourneyStore<TContext, TStepId extends string, TCustomEvent extends string = never, TEventPayloadMap extends JourneyReactEventPayloadMap<TCustomEvent> = Record<never, never>, TStepMeta = unknown> = (hookName?: string) => JourneyStoreValue<TContext, TStepId, TCustomEvent, TEventPayloadMap, TStepMeta>;
-export declare const createUseJourneyEvent: <TContext, TStepId extends string, TCustomEvent extends string = never, TEventPayloadMap extends JourneyReactEventPayloadMap<TCustomEvent> = Record<never, never>, TStepMeta = unknown>(useJourneyStore: UseJourneyStore<TContext, TStepId, TCustomEvent, TEventPayloadMap, TStepMeta>) => (listener: (event: JourneyObservationEvent<TStepId, JourneyEventType<TCustomEvent>, TEventPayloadMap, TStepMeta>) => void) => void;
-export {};

package/dist/bindings/useJourneyMachine.d.ts

@@ -1,4 +0,0 @@
-import type { JourneyReactEventPayloadMap, JourneyStoreValue } from "../types";
-type UseJourneyStore<TContext, TStepId extends string, TCustomEvent extends string = never, TEventPayloadMap extends JourneyReactEventPayloadMap<TCustomEvent> = Record<never, never>, TStepMeta = unknown> = (hookName?: string) => JourneyStoreValue<TContext, TStepId, TCustomEvent, TEventPayloadMap, TStepMeta>;
-export declare const createUseJourneyMachine: <TContext, TStepId extends string, TCustomEvent extends string = never, TEventPayloadMap extends JourneyReactEventPayloadMap<TCustomEvent> = Record<never, never>, TStepMeta = unknown>(useJourneyStore: UseJourneyStore<TContext, TStepId, TCustomEvent, TEventPayloadMap, TStepMeta>) => () => import("packages/core/dist").JourneyMachine<TContext, TStepId, import("..").JourneyEventType<TCustomEvent>, TEventPayloadMap, TStepMeta>;
-export {};

package/dist/bindings/useJourneySelector.d.ts

@@ -1,5 +0,0 @@
-import type { JourneyEqualityFn, JourneySelector } from "@rxova/journey-core";
-import type { JourneyReactEventPayloadMap, JourneyStoreValue } from "../types";
-type UseJourneyStore<TContext, TStepId extends string, TCustomEvent extends string = never, TEventPayloadMap extends JourneyReactEventPayloadMap<TCustomEvent> = Record<never, never>, TStepMeta = unknown> = (hookName?: string) => JourneyStoreValue<TContext, TStepId, TCustomEvent, TEventPayloadMap, TStepMeta>;
-export declare const createUseJourneySelector: <TContext, TStepId extends string, TCustomEvent extends string = never, TEventPayloadMap extends JourneyReactEventPayloadMap<TCustomEvent> = Record<never, never>, TStepMeta = unknown>(useJourneyStore: UseJourneyStore<TContext, TStepId, TCustomEvent, TEventPayloadMap, TStepMeta>) => <TSelected>(selector: JourneySelector<TContext, TStepId, TStepMeta, TSelected>, equalityFn?: JourneyEqualityFn<TSelected>) => TSelected;
-export {};

package/dist/bindings/useJourneySnapshot.d.ts

@@ -1,5 +0,0 @@
-import type { JourneySnapshot } from "@rxova/journey-core";
-import type { JourneyReactEventPayloadMap, JourneyStoreValue } from "../types";
-type UseJourneyStore<TContext, TStepId extends string, TCustomEvent extends string = never, TEventPayloadMap extends JourneyReactEventPayloadMap<TCustomEvent> = Record<never, never>, TStepMeta = unknown> = (hookName?: string) => JourneyStoreValue<TContext, TStepId, TCustomEvent, TEventPayloadMap, TStepMeta>;
-export declare const createUseJourneySnapshot: <TContext, TStepId extends string, TCustomEvent extends string = never, TEventPayloadMap extends JourneyReactEventPayloadMap<TCustomEvent> = Record<never, never>, TStepMeta = unknown>(useJourneyStore: UseJourneyStore<TContext, TStepId, TCustomEvent, TEventPayloadMap, TStepMeta>) => () => JourneySnapshot<TContext, TStepId, TStepMeta>;
-export {};