@rxova/journey-react 0.7.0 → 1.0.0-rc.2
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/README.md +101 -170
- package/dist/client.cjs +2 -0
- package/dist/client.cjs.map +7 -0
- package/dist/client.d.cts +1 -0
- package/dist/client.d.ts +1 -0
- package/dist/client.js +2 -0
- package/dist/client.js.map +7 -0
- package/dist/createJourney.d.cts +15 -0
- package/dist/createJourney.d.ts +15 -0
- package/dist/index.cjs +1 -1
- package/dist/index.cjs.map +4 -4
- package/dist/index.d.cts +3 -4
- package/dist/index.d.ts +3 -4
- package/dist/index.js +1 -1
- package/dist/index.js.map +4 -4
- package/dist/provider.d.cts +9 -0
- package/dist/provider.d.ts +9 -0
- package/dist/runtime-hooks.d.cts +18 -0
- package/dist/runtime-hooks.d.ts +18 -0
- package/dist/types.d.cts +80 -0
- package/dist/types.d.ts +69 -45
- package/package.json +17 -8
- package/dist/bindings/Provider.d.ts +0 -8
- package/dist/bindings/StepRenderer.d.ts +0 -13
- package/dist/bindings/index.d.ts +0 -6
- package/dist/bindings/useJourneyApi.d.ts +0 -16
- package/dist/bindings/useJourneyEvent.d.ts +0 -5
- package/dist/bindings/useJourneyMachine.d.ts +0 -4
- package/dist/bindings/useJourneySelector.d.ts +0 -5
- package/dist/bindings/useJourneySnapshot.d.ts +0 -5
package/dist/types.d.ts
CHANGED
|
@@ -1,56 +1,80 @@
|
|
|
1
1
|
import type React from "react";
|
|
2
|
-
import type { JourneyDefinition, JourneyEqualityFn,
|
|
3
|
-
export type JourneyDefaultEvent =
|
|
4
|
-
export type
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
2
|
+
import type { JourneyBuilderDefinitionMetadata, JourneyBuilderCustomEventKey, JourneyComputed, JourneyDefaultEventType, JourneyDefinition, JourneyEqualityFn, JourneyJsonObject, JourneyMachinePlugin, JourneyMachineWithPlugins, JourneyObservationEvent, JourneyPayloadFor, JourneySelector, JourneySendEvent, JourneySendResult, JourneySnapshot } from "@rxova/journey-core";
|
|
3
|
+
export type JourneyDefaultEvent = JourneyDefaultEventType;
|
|
4
|
+
export type JourneyViews<TStepId extends string> = Record<TStepId, React.ComponentType>;
|
|
5
|
+
type JourneyCustomSendEventForKeys<TEventMap extends Record<string, unknown>, TAllowedEventType extends keyof TEventMap & string> = {
|
|
6
|
+
[TCurrentEventType in TAllowedEventType]: {
|
|
7
|
+
type: TCurrentEventType;
|
|
8
|
+
payload?: JourneyPayloadFor<TEventMap, TCurrentEventType>;
|
|
9
|
+
};
|
|
10
|
+
}[TAllowedEventType];
|
|
11
|
+
type JourneyTransitionsFromDefinition<TDefinition> = TDefinition extends {
|
|
12
|
+
transitions?: infer TTransitions;
|
|
13
|
+
} ? TTransitions : never;
|
|
14
|
+
type JourneyCustomEventKeysFromTransitionEntry<TEventMap extends Record<string, unknown>, TEntry> = Extract<keyof NonNullable<TEntry>, JourneyBuilderCustomEventKey<TEventMap>>;
|
|
15
|
+
type JourneyStepHandledCustomEventMapFromTransitions<TStepId extends string, TEventMap extends Record<string, unknown>, TTransitions> = {
|
|
16
|
+
[TCurrentStepId in TStepId]: JourneyCustomEventKeysFromTransitionEntry<TEventMap, TTransitions extends readonly unknown[] ? never : TTransitions extends Record<string, unknown> ? TCurrentStepId extends keyof TTransitions ? TTransitions[TCurrentStepId] : never : never>;
|
|
8
17
|
};
|
|
9
|
-
|
|
10
|
-
|
|
18
|
+
type JourneyGlobalHandledCustomEventTypeFromTransitions<TEventMap extends Record<string, unknown>, TTransitions> = JourneyCustomEventKeysFromTransitionEntry<TEventMap, TTransitions extends readonly unknown[] ? never : TTransitions extends {
|
|
19
|
+
global?: infer TGlobalTransitions;
|
|
20
|
+
} ? TGlobalTransitions : never>;
|
|
21
|
+
type JourneyStepHandledCustomEventMapFromDefinition<TDefinition, TStepId extends string, TEventMap extends Record<string, unknown>> = TDefinition extends JourneyBuilderDefinitionMetadata<TStepId, TEventMap, infer TStepHandledMap, infer TGlobalHandledCustomEventType> ? Extract<TStepHandledMap, Record<TStepId, JourneyBuilderCustomEventKey<TEventMap>>> & (Extract<TGlobalHandledCustomEventType, JourneyBuilderCustomEventKey<TEventMap>> extends never ? unknown : unknown) : JourneyStepHandledCustomEventMapFromTransitions<TStepId, TEventMap, JourneyTransitionsFromDefinition<TDefinition>>;
|
|
22
|
+
type JourneyGlobalHandledCustomEventTypeFromDefinition<TDefinition, TStepId extends string, TEventMap extends Record<string, unknown>> = TDefinition extends JourneyBuilderDefinitionMetadata<TStepId, TEventMap, Record<TStepId, JourneyBuilderCustomEventKey<TEventMap>>, infer TGlobalHandledCustomEventType> ? Extract<TGlobalHandledCustomEventType, JourneyBuilderCustomEventKey<TEventMap>> : JourneyGlobalHandledCustomEventTypeFromTransitions<TEventMap, JourneyTransitionsFromDefinition<TDefinition>>;
|
|
23
|
+
export type JourneyApi<TContext extends JourneyJsonObject, TStepId extends string, TEventMap extends Record<string, unknown> = Record<never, never>, TStepMeta = unknown> = {
|
|
24
|
+
startJourney: () => Promise<JourneySnapshot<TContext, TStepId>>;
|
|
25
|
+
send: (event: JourneySendEvent<TStepId, TEventMap>) => Promise<JourneySendResult<TContext, TStepId>>;
|
|
26
|
+
goToNextStep: () => Promise<JourneySendResult<TContext, TStepId>>;
|
|
27
|
+
goToStepById: (stepId: TStepId) => Promise<JourneySendResult<TContext, TStepId>>;
|
|
28
|
+
terminateJourney: (payload?: JourneyPayloadFor<TEventMap, "terminateJourney">) => Promise<JourneySendResult<TContext, TStepId>>;
|
|
29
|
+
completeJourney: (payload?: JourneyPayloadFor<TEventMap, "completeJourney">) => Promise<JourneySendResult<TContext, TStepId>>;
|
|
30
|
+
goToPreviousStep: (steps?: number) => Promise<JourneySendResult<TContext, TStepId>>;
|
|
31
|
+
goToLastVisitedStep: () => Promise<JourneySendResult<TContext, TStepId>>;
|
|
32
|
+
clearStepError: (stepId?: TStepId) => Promise<JourneySnapshot<TContext, TStepId>>;
|
|
33
|
+
updateContext: (updater: (context: TContext) => TContext) => Promise<JourneySnapshot<TContext, TStepId>>;
|
|
34
|
+
getStepMeta: (stepId: TStepId) => TStepMeta | undefined;
|
|
35
|
+
resetJourney: () => Promise<JourneySnapshot<TContext, TStepId>>;
|
|
11
36
|
};
|
|
12
|
-
export type
|
|
13
|
-
send: (event:
|
|
14
|
-
goToNextStep: () => Promise<JourneySendResult<TContext, TStepId, TStepMeta>>;
|
|
15
|
-
terminateJourney: (payload?: JourneyPayloadFor<JourneyEventType<TCustomEvent>, TEventPayloadMap, "terminateJourney">) => Promise<JourneySendResult<TContext, TStepId, TStepMeta>>;
|
|
16
|
-
completeJourney: (payload?: JourneyPayloadFor<JourneyEventType<TCustomEvent>, TEventPayloadMap, "completeJourney">) => Promise<JourneySendResult<TContext, TStepId, TStepMeta>>;
|
|
17
|
-
goToPreviousStep: (steps?: number) => Promise<JourneySendResult<TContext, TStepId, TStepMeta>>;
|
|
18
|
-
goToLastVisitedStep: () => Promise<JourneySendResult<TContext, TStepId, TStepMeta>>;
|
|
19
|
-
clearStepError: (stepId?: TStepId) => void;
|
|
20
|
-
updateContext: (updater: (context: TContext) => TContext) => void;
|
|
21
|
-
updateStepMetadata: (stepId: TStepId, updater: (metadata: TStepMeta) => TStepMeta) => void;
|
|
22
|
-
resetJourney: () => void;
|
|
37
|
+
export type StepScopedJourneyApi<TContext extends JourneyJsonObject, TStepId extends string, TEventMap extends Record<string, unknown> = Record<never, never>, TAllowedEventType extends keyof TEventMap & string = never, TStepMeta = unknown> = Omit<JourneyApi<TContext, TStepId, TEventMap, TStepMeta>, "send"> & {
|
|
38
|
+
send: (event: JourneyCustomSendEventForKeys<TEventMap, TAllowedEventType>) => Promise<JourneySendResult<TContext, TStepId>>;
|
|
23
39
|
};
|
|
24
|
-
export type
|
|
25
|
-
|
|
26
|
-
journey: JourneyReactDefinition<TContext, TStepId, TCustomEvent, TEventPayloadMap, TStepMeta>;
|
|
40
|
+
export type JourneyProviderErrorContext = {
|
|
41
|
+
phase: "start";
|
|
27
42
|
};
|
|
28
|
-
export type
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
completeOnNoNextStep?: boolean;
|
|
33
|
-
resetOnJourneyChange?: boolean;
|
|
34
|
-
resetOnPersistenceChange?: boolean;
|
|
35
|
-
onStart?: (event: Extract<JourneyObservationEvent<TStepId, JourneyEventType<TCustomEvent>, TEventPayloadMap, TStepMeta>, {
|
|
36
|
-
type: "journey.start";
|
|
37
|
-
}>) => void;
|
|
38
|
-
onComplete?: (event: Extract<JourneyObservationEvent<TStepId, JourneyEventType<TCustomEvent>, TEventPayloadMap, TStepMeta>, {
|
|
39
|
-
type: "journey.complete";
|
|
40
|
-
}>) => void;
|
|
41
|
-
onTerminate?: (event: Extract<JourneyObservationEvent<TStepId, JourneyEventType<TCustomEvent>, TEventPayloadMap, TStepMeta>, {
|
|
42
|
-
type: "journey.close";
|
|
43
|
-
}>) => void;
|
|
43
|
+
export type JourneyProviderProps<TStepId extends string> = {
|
|
44
|
+
views: JourneyViews<TStepId>;
|
|
45
|
+
onError?: (error: unknown, context: JourneyProviderErrorContext) => void;
|
|
46
|
+
disposeOnUnmount?: boolean;
|
|
44
47
|
children: React.ReactNode;
|
|
45
48
|
};
|
|
46
|
-
export type
|
|
47
|
-
|
|
49
|
+
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>> = {
|
|
50
|
+
machine: JourneyMachineWithPlugins<TContext, TStepId, TEventMap, TStepMeta, THandlers, TPlugins>;
|
|
51
|
+
dispose: () => void;
|
|
52
|
+
useJourneySnapshot: () => JourneySnapshot<TContext, TStepId>;
|
|
53
|
+
useJourneyComputed: () => JourneyComputed<TStepId>;
|
|
54
|
+
useJourneySelector: <TSelected>(selector: JourneySelector<TContext, TStepId, TSelected>, equalityFn?: JourneyEqualityFn<TSelected>) => TSelected;
|
|
55
|
+
useJourneyApi: () => JourneyApi<TContext, TStepId, TEventMap, TStepMeta>;
|
|
56
|
+
useJourneyEvent: (listener: (event: JourneyObservationEvent<TStepId, TEventMap>) => void) => void;
|
|
57
|
+
useJourneyStepLifecycle: (stepId: TStepId, callbacks: {
|
|
58
|
+
onEnter?: (args: {
|
|
59
|
+
context: TContext;
|
|
60
|
+
}) => void;
|
|
61
|
+
onLeave?: (args: {
|
|
62
|
+
context: TContext;
|
|
63
|
+
}) => void;
|
|
64
|
+
}) => void;
|
|
65
|
+
JourneyProvider: React.ComponentType<JourneyProviderProps<TStepId>>;
|
|
48
66
|
StepRenderer: React.ComponentType<{
|
|
49
67
|
fallback?: React.ReactNode;
|
|
50
68
|
}>;
|
|
51
|
-
useJourneyApi: () => JourneyApi<TContext, TStepId, TCustomEvent, TEventPayloadMap, TStepMeta>;
|
|
52
|
-
useJourneyMachine: () => JourneyMachine<TContext, TStepId, JourneyEventType<TCustomEvent>, TEventPayloadMap, TStepMeta>;
|
|
53
|
-
useJourneyEvent: (listener: (event: JourneyObservationEvent<TStepId, JourneyEventType<TCustomEvent>, TEventPayloadMap, TStepMeta>) => void) => void;
|
|
54
|
-
useJourneySelector: <TSelected>(selector: JourneySelector<TContext, TStepId, TStepMeta, TSelected>, equalityFn?: JourneyEqualityFn<TSelected>) => TSelected;
|
|
55
|
-
useJourneySnapshot: () => JourneySnapshot<TContext, TStepId, TStepMeta>;
|
|
56
69
|
};
|
|
70
|
+
export type JourneyRuntimeWithStepApi<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>, TStepHandledCustomEventMap extends Record<TStepId, JourneyBuilderCustomEventKey<TEventMap>> = Record<TStepId, never>, TGlobalHandledCustomEventType extends JourneyBuilderCustomEventKey<TEventMap> = never> = JourneyRuntime<TContext, TStepId, TEventMap, TStepMeta, TPlugins, THandlers> & {
|
|
71
|
+
useStepApi: <TStepKey extends TStepId>(stepId: TStepKey) => StepScopedJourneyApi<TContext, TStepId, TEventMap, Extract<TStepHandledCustomEventMap[TStepKey] | TGlobalHandledCustomEventType, keyof TEventMap & string>, TStepMeta>;
|
|
72
|
+
};
|
|
73
|
+
export type JourneyBuilderRuntime<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>, TStepHandledCustomEventMap extends Record<TStepId, JourneyBuilderCustomEventKey<TEventMap>> = Record<TStepId, never>, TGlobalHandledCustomEventType extends JourneyBuilderCustomEventKey<TEventMap> = never> = JourneyRuntimeWithStepApi<TContext, TStepId, TEventMap, TStepMeta, TPlugins, THandlers, TStepHandledCustomEventMap, TGlobalHandledCustomEventType>;
|
|
74
|
+
export type JourneyBuilderRuntimeFactory<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>, TStepHandledCustomEventMap extends Record<TStepId, JourneyBuilderCustomEventKey<TEventMap>> = Record<TStepId, never>, TGlobalHandledCustomEventType extends JourneyBuilderCustomEventKey<TEventMap> = never> = () => JourneyBuilderRuntime<TContext, TStepId, TEventMap, TStepMeta, TPlugins, THandlers, TStepHandledCustomEventMap, TGlobalHandledCustomEventType>;
|
|
75
|
+
export type JourneyRuntimeFromDefinition<TDefinition, TPlugins extends readonly JourneyMachinePlugin[] = []> = TDefinition extends JourneyDefinition<infer TContext, infer TStepId, infer TEventMap, infer TStepMeta, infer THandlers> ? JourneyRuntimeWithStepApi<Extract<TContext, JourneyJsonObject>, Extract<TStepId, string>, Extract<TEventMap, Record<string, unknown>>, TStepMeta, TPlugins, Extract<THandlers, Record<string, unknown>>, JourneyStepHandledCustomEventMapFromDefinition<TDefinition, Extract<TStepId, string>, Extract<TEventMap, Record<string, unknown>>>, JourneyGlobalHandledCustomEventTypeFromDefinition<TDefinition, Extract<TStepId, string>, Extract<TEventMap, Record<string, unknown>>>> : never;
|
|
76
|
+
export type JourneyRuntimeFactoryFromDefinition<TDefinition, TPlugins extends readonly JourneyMachinePlugin[] = []> = () => JourneyRuntimeFromDefinition<TDefinition, TPlugins>;
|
|
77
|
+
export type JourneyBuilderRuntimeFromDefinition<TDefinition, TPlugins extends readonly JourneyMachinePlugin[] = []> = JourneyRuntimeFromDefinition<TDefinition, TPlugins>;
|
|
78
|
+
export type JourneyBuilderRuntimeFactoryFromDefinition<TDefinition, TPlugins extends readonly JourneyMachinePlugin[] = []> = JourneyRuntimeFactoryFromDefinition<TDefinition, TPlugins>;
|
|
79
|
+
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>;
|
|
80
|
+
export {};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@rxova/journey-react",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "1.0.0-rc.2",
|
|
4
4
|
"description": "React bindings for journey.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"react",
|
|
@@ -38,6 +38,14 @@
|
|
|
38
38
|
},
|
|
39
39
|
"import": "./dist/index.js",
|
|
40
40
|
"require": "./dist/index.cjs"
|
|
41
|
+
},
|
|
42
|
+
"./client": {
|
|
43
|
+
"types": {
|
|
44
|
+
"import": "./dist/client.d.ts",
|
|
45
|
+
"require": "./dist/client.d.cts"
|
|
46
|
+
},
|
|
47
|
+
"import": "./dist/client.js",
|
|
48
|
+
"require": "./dist/client.cjs"
|
|
41
49
|
}
|
|
42
50
|
},
|
|
43
51
|
"files": [
|
|
@@ -46,23 +54,24 @@
|
|
|
46
54
|
"LICENSE"
|
|
47
55
|
],
|
|
48
56
|
"sideEffects": false,
|
|
49
|
-
"dependencies": {
|
|
50
|
-
"@rxova/journey-core": "^0.7.0"
|
|
51
|
-
},
|
|
52
57
|
"peerDependencies": {
|
|
53
|
-
"react": ">=18.2.0"
|
|
58
|
+
"react": ">=18.2.0",
|
|
59
|
+
"@rxova/journey-core": "^1.0.0-rc.2"
|
|
54
60
|
},
|
|
55
61
|
"peerDependenciesMeta": {
|
|
62
|
+
"@rxova/journey-core": {
|
|
63
|
+
"optional": false
|
|
64
|
+
},
|
|
56
65
|
"react": {
|
|
57
66
|
"optional": false
|
|
58
67
|
}
|
|
59
68
|
},
|
|
60
69
|
"size-limit": [
|
|
61
70
|
{
|
|
62
|
-
"name": "react/
|
|
71
|
+
"name": "react/createJourney",
|
|
63
72
|
"path": "dist/index.js",
|
|
64
|
-
"import": "{
|
|
65
|
-
"limit": "
|
|
73
|
+
"import": "{ createJourney }",
|
|
74
|
+
"limit": "2 kB"
|
|
66
75
|
}
|
|
67
76
|
],
|
|
68
77
|
"devDependencies": {
|
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
import React from "react";
|
|
2
|
-
import type { JourneyBindingsProviderProps, JourneyReactDefinition, JourneyReactEventPayloadMap, JourneyStoreValue } from "../types";
|
|
3
|
-
type ProviderFactoryProps<TContext, TStepId extends string, TCustomEvent extends string = never, TEventPayloadMap extends JourneyReactEventPayloadMap<TCustomEvent> = Record<never, never>, TStepMeta = unknown> = {
|
|
4
|
-
JourneyContext: React.Context<JourneyStoreValue<TContext, TStepId, TCustomEvent, TEventPayloadMap, TStepMeta> | null>;
|
|
5
|
-
boundJourney: JourneyReactDefinition<TContext, TStepId, TCustomEvent, TEventPayloadMap, TStepMeta>;
|
|
6
|
-
};
|
|
7
|
-
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;
|
|
8
|
-
export {};
|
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
import React from "react";
|
|
2
|
-
import type { JourneySnapshot } from "@rxova/journey-core";
|
|
3
|
-
import type { JourneyReactEventPayloadMap, JourneyStoreValue } from "../types";
|
|
4
|
-
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>;
|
|
5
|
-
type UseJourneySnapshot<TContext, TStepId extends string, TStepMeta = unknown> = () => JourneySnapshot<TContext, TStepId, TStepMeta>;
|
|
6
|
-
type StepRendererFactoryProps<TContext, TStepId extends string, TCustomEvent extends string = never, TEventPayloadMap extends JourneyReactEventPayloadMap<TCustomEvent> = Record<never, never>, TStepMeta = unknown> = {
|
|
7
|
-
useJourneySnapshot: UseJourneySnapshot<TContext, TStepId, TStepMeta>;
|
|
8
|
-
useJourneyStore: UseJourneyStore<TContext, TStepId, TCustomEvent, TEventPayloadMap, TStepMeta>;
|
|
9
|
-
};
|
|
10
|
-
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 }: {
|
|
11
|
-
fallback?: React.ReactNode;
|
|
12
|
-
}) => import("react/jsx-runtime").JSX.Element;
|
|
13
|
-
export {};
|
package/dist/bindings/index.d.ts
DELETED
|
@@ -1,6 +0,0 @@
|
|
|
1
|
-
import type { JourneyBindings, JourneyReactDefinition, JourneyReactEventPayloadMap } from "../types";
|
|
2
|
-
/**
|
|
3
|
-
* Creates a typed React integration bundle (Provider, StepRenderer, and hooks)
|
|
4
|
-
* bound to a specific journey definition.
|
|
5
|
-
*/
|
|
6
|
-
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>;
|
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
import type { JourneyPayloadFor, JourneySendEvent, JourneySendResult } from "@rxova/journey-core";
|
|
2
|
-
import type { JourneyEventType, JourneyReactEventPayloadMap, JourneyStoreValue } from "../types";
|
|
3
|
-
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>;
|
|
4
|
-
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>) => () => {
|
|
5
|
-
send: (event: JourneySendEvent<TStepId, JourneyEventType<TCustomEvent>, TEventPayloadMap>) => Promise<JourneySendResult<TContext, TStepId, TStepMeta>>;
|
|
6
|
-
goToNextStep: () => Promise<JourneySendResult<TContext, TStepId, TStepMeta>>;
|
|
7
|
-
terminateJourney: (payload?: JourneyPayloadFor<JourneyEventType<TCustomEvent>, TEventPayloadMap, "terminateJourney">) => Promise<JourneySendResult<TContext, TStepId, TStepMeta>>;
|
|
8
|
-
completeJourney: (payload?: JourneyPayloadFor<JourneyEventType<TCustomEvent>, TEventPayloadMap, "completeJourney">) => Promise<JourneySendResult<TContext, TStepId, TStepMeta>>;
|
|
9
|
-
goToPreviousStep: (steps?: number) => Promise<JourneySendResult<TContext, TStepId, TStepMeta>>;
|
|
10
|
-
goToLastVisitedStep: () => Promise<JourneySendResult<TContext, TStepId, TStepMeta>>;
|
|
11
|
-
clearStepError: (stepId?: TStepId) => void;
|
|
12
|
-
updateContext: (updater: (context: TContext) => TContext) => void;
|
|
13
|
-
updateStepMetadata: (stepId: TStepId, updater: (metadata: TStepMeta) => TStepMeta) => void;
|
|
14
|
-
resetJourney: () => void;
|
|
15
|
-
};
|
|
16
|
-
export {};
|
|
@@ -1,5 +0,0 @@
|
|
|
1
|
-
import type { JourneyObservationEvent } from "@rxova/journey-core";
|
|
2
|
-
import type { JourneyEventType, JourneyReactEventPayloadMap, JourneyStoreValue } from "../types";
|
|
3
|
-
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>;
|
|
4
|
-
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;
|
|
5
|
-
export {};
|
|
@@ -1,4 +0,0 @@
|
|
|
1
|
-
import type { JourneyReactEventPayloadMap, JourneyStoreValue } from "../types";
|
|
2
|
-
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>;
|
|
3
|
-
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>;
|
|
4
|
-
export {};
|
|
@@ -1,5 +0,0 @@
|
|
|
1
|
-
import type { JourneyEqualityFn, JourneySelector } from "@rxova/journey-core";
|
|
2
|
-
import type { JourneyReactEventPayloadMap, JourneyStoreValue } from "../types";
|
|
3
|
-
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>;
|
|
4
|
-
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;
|
|
5
|
-
export {};
|
|
@@ -1,5 +0,0 @@
|
|
|
1
|
-
import type { JourneySnapshot } from "@rxova/journey-core";
|
|
2
|
-
import type { JourneyReactEventPayloadMap, JourneyStoreValue } from "../types";
|
|
3
|
-
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>;
|
|
4
|
-
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>;
|
|
5
|
-
export {};
|