@waypointjs/react 0.1.0
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/LICENSE +21 -0
- package/dist/index.cjs +90 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +55 -0
- package/dist/index.d.ts +55 -0
- package/dist/index.js +87 -0
- package/dist/index.js.map +1 -0
- package/package.json +47 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Mauconduit Thomas
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/dist/index.cjs
ADDED
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
var react = require('react');
|
|
4
|
+
var zustand = require('zustand');
|
|
5
|
+
var core = require('@waypointjs/core');
|
|
6
|
+
|
|
7
|
+
// src/useWaypoint.ts
|
|
8
|
+
function useWaypoint(store) {
|
|
9
|
+
const { schema, data, externalVars, currentStepId, isSubmitting } = zustand.useStore(
|
|
10
|
+
store,
|
|
11
|
+
(s) => ({
|
|
12
|
+
schema: s.schema,
|
|
13
|
+
data: s.data,
|
|
14
|
+
externalVars: s.externalVars,
|
|
15
|
+
currentStepId: s.currentStepId,
|
|
16
|
+
isSubmitting: s.isSubmitting
|
|
17
|
+
})
|
|
18
|
+
);
|
|
19
|
+
const tree = react.useMemo(
|
|
20
|
+
() => schema ? core.resolveTree(schema, data, externalVars) : { steps: [], hiddenSteps: [], missingExternalVars: [] },
|
|
21
|
+
[schema, data, externalVars]
|
|
22
|
+
);
|
|
23
|
+
const currentStep = react.useMemo(
|
|
24
|
+
() => currentStepId ? tree.steps.find((s) => s.definition.id === currentStepId) : void 0,
|
|
25
|
+
[tree.steps, currentStepId]
|
|
26
|
+
);
|
|
27
|
+
const nextStep = react.useMemo(
|
|
28
|
+
() => currentStepId ? core.getNextStep(tree.steps, currentStepId) : void 0,
|
|
29
|
+
[tree.steps, currentStepId]
|
|
30
|
+
);
|
|
31
|
+
const previousStep = react.useMemo(
|
|
32
|
+
() => currentStepId ? core.getPreviousStep(tree.steps, currentStepId) : void 0,
|
|
33
|
+
[tree.steps, currentStepId]
|
|
34
|
+
);
|
|
35
|
+
const progress = react.useMemo(
|
|
36
|
+
() => currentStepId ? core.calculateProgress(tree.steps, currentStepId) : 0,
|
|
37
|
+
[tree.steps, currentStepId]
|
|
38
|
+
);
|
|
39
|
+
return {
|
|
40
|
+
schema,
|
|
41
|
+
data,
|
|
42
|
+
externalVars,
|
|
43
|
+
currentStepId,
|
|
44
|
+
currentStep,
|
|
45
|
+
nextStep,
|
|
46
|
+
previousStep,
|
|
47
|
+
tree,
|
|
48
|
+
progress,
|
|
49
|
+
isFirstStep: !previousStep,
|
|
50
|
+
isLastStep: !nextStep,
|
|
51
|
+
isSubmitting,
|
|
52
|
+
missingExternalVars: tree.missingExternalVars,
|
|
53
|
+
setFieldValue: (stepId, fieldId, value) => store.getState().setFieldValue(stepId, fieldId, value),
|
|
54
|
+
setStepData: (stepId, data2) => store.getState().setStepData(stepId, data2),
|
|
55
|
+
setExternalVar: (varId, value) => store.getState().setExternalVar(varId, value),
|
|
56
|
+
setCurrentStep: (stepId) => store.getState().setCurrentStep(stepId),
|
|
57
|
+
reset: () => store.getState().reset()
|
|
58
|
+
};
|
|
59
|
+
}
|
|
60
|
+
function useWaypointStep(store, stepId) {
|
|
61
|
+
const { schema, data, externalVars } = zustand.useStore(store, (s) => ({
|
|
62
|
+
schema: s.schema,
|
|
63
|
+
data: s.data,
|
|
64
|
+
externalVars: s.externalVars
|
|
65
|
+
}));
|
|
66
|
+
const tree = react.useMemo(
|
|
67
|
+
() => schema ? core.resolveTree(schema, data, externalVars) : { steps: [], hiddenSteps: [], missingExternalVars: [] },
|
|
68
|
+
[schema, data, externalVars]
|
|
69
|
+
);
|
|
70
|
+
const step = react.useMemo(
|
|
71
|
+
() => tree.steps.find((s) => s.definition.id === stepId),
|
|
72
|
+
[tree.steps, stepId]
|
|
73
|
+
);
|
|
74
|
+
const visibleFields = react.useMemo(
|
|
75
|
+
() => step?.fields.filter((f) => f.visible) ?? [],
|
|
76
|
+
[step]
|
|
77
|
+
);
|
|
78
|
+
return {
|
|
79
|
+
step,
|
|
80
|
+
fields: visibleFields,
|
|
81
|
+
stepData: data[stepId] ?? {},
|
|
82
|
+
setFieldValue: (fieldId, value) => store.getState().setFieldValue(stepId, fieldId, value),
|
|
83
|
+
setStepData: (d) => store.getState().setStepData(stepId, d)
|
|
84
|
+
};
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
exports.useWaypoint = useWaypoint;
|
|
88
|
+
exports.useWaypointStep = useWaypointStep;
|
|
89
|
+
//# sourceMappingURL=index.cjs.map
|
|
90
|
+
//# sourceMappingURL=index.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/useWaypoint.ts","../src/useWaypointStep.ts"],"names":["useStore","useMemo","resolveTree","getNextStep","getPreviousStep","calculateProgress","data"],"mappings":";;;;;;;AAoDO,SAAS,YAAY,KAAA,EAAsD;AAChF,EAAA,MAAM,EAAE,MAAA,EAAQ,IAAA,EAAM,YAAA,EAAc,aAAA,EAAe,cAAa,GAAIA,gBAAA;AAAA,IAClE,KAAA;AAAA,IACA,CAAC,CAAA,MAA6B;AAAA,MAC5B,QAAQ,CAAA,CAAE,MAAA;AAAA,MACV,MAAM,CAAA,CAAE,IAAA;AAAA,MACR,cAAc,CAAA,CAAE,YAAA;AAAA,MAChB,eAAe,CAAA,CAAE,aAAA;AAAA,MACjB,cAAc,CAAA,CAAE;AAAA,KAClB;AAAA,GACF;AAEA,EAAA,MAAM,IAAA,GAAOC,aAAA;AAAA,IACX,MACE,MAAA,GACIC,gBAAA,CAAY,MAAA,EAAQ,IAAA,EAAM,YAAY,CAAA,GACtC,EAAE,KAAA,EAAO,IAAI,WAAA,EAAa,EAAC,EAAG,mBAAA,EAAqB,EAAC,EAAE;AAAA,IAC5D,CAAC,MAAA,EAAQ,IAAA,EAAM,YAAY;AAAA,GAC7B;AAEA,EAAA,MAAM,WAAA,GAAcD,aAAA;AAAA,IAClB,MACE,aAAA,GACI,IAAA,CAAK,KAAA,CAAM,IAAA,CAAK,CAAC,CAAA,KAAM,CAAA,CAAE,UAAA,CAAW,EAAA,KAAO,aAAa,CAAA,GACxD,MAAA;AAAA,IACN,CAAC,IAAA,CAAK,KAAA,EAAO,aAAa;AAAA,GAC5B;AAEA,EAAA,MAAM,QAAA,GAAWA,aAAA;AAAA,IACf,MACE,aAAA,GAAgBE,gBAAA,CAAY,IAAA,CAAK,KAAA,EAAO,aAAa,CAAA,GAAI,MAAA;AAAA,IAC3D,CAAC,IAAA,CAAK,KAAA,EAAO,aAAa;AAAA,GAC5B;AAEA,EAAA,MAAM,YAAA,GAAeF,aAAA;AAAA,IACnB,MACE,aAAA,GAAgBG,oBAAA,CAAgB,IAAA,CAAK,KAAA,EAAO,aAAa,CAAA,GAAI,MAAA;AAAA,IAC/D,CAAC,IAAA,CAAK,KAAA,EAAO,aAAa;AAAA,GAC5B;AAEA,EAAA,MAAM,QAAA,GAAWH,aAAA;AAAA,IACf,MACE,aAAA,GAAgBI,sBAAA,CAAkB,IAAA,CAAK,KAAA,EAAO,aAAa,CAAA,GAAI,CAAA;AAAA,IACjE,CAAC,IAAA,CAAK,KAAA,EAAO,aAAa;AAAA,GAC5B;AAEA,EAAA,OAAO;AAAA,IACL,MAAA;AAAA,IACA,IAAA;AAAA,IACA,YAAA;AAAA,IACA,aAAA;AAAA,IACA,WAAA;AAAA,IACA,QAAA;AAAA,IACA,YAAA;AAAA,IACA,IAAA;AAAA,IACA,QAAA;AAAA,IACA,aAAa,CAAC,YAAA;AAAA,IACd,YAAY,CAAC,QAAA;AAAA,IACb,YAAA;AAAA,IACA,qBAAqB,IAAA,CAAK,mBAAA;AAAA,IAE1B,aAAA,EAAe,CAAC,MAAA,EAAQ,OAAA,EAAS,KAAA,KAC/B,KAAA,CAAM,QAAA,EAAS,CAAE,aAAA,CAAc,MAAA,EAAQ,OAAA,EAAS,KAAK,CAAA;AAAA,IACvD,WAAA,EAAa,CAAC,MAAA,EAAQC,KAAAA,KACpB,MAAM,QAAA,EAAS,CAAE,WAAA,CAAY,MAAA,EAAQA,KAAI,CAAA;AAAA,IAC3C,cAAA,EAAgB,CAAC,KAAA,EAAO,KAAA,KACtB,MAAM,QAAA,EAAS,CAAE,cAAA,CAAe,KAAA,EAAO,KAAK,CAAA;AAAA,IAC9C,gBAAgB,CAAC,MAAA,KAAW,MAAM,QAAA,EAAS,CAAE,eAAe,MAAM,CAAA;AAAA,IAClE,KAAA,EAAO,MAAM,KAAA,CAAM,QAAA,GAAW,KAAA;AAAM,GACtC;AACF;ACvFO,SAAS,eAAA,CACd,OACA,MAAA,EACsB;AACtB,EAAA,MAAM,EAAE,QAAQ,IAAA,EAAM,YAAA,KAAiBN,gBAAAA,CAAS,KAAA,EAAO,CAAC,CAAA,MAA6B;AAAA,IACnF,QAAQ,CAAA,CAAE,MAAA;AAAA,IACV,MAAM,CAAA,CAAE,IAAA;AAAA,IACR,cAAc,CAAA,CAAE;AAAA,GAClB,CAAE,CAAA;AAEF,EAAA,MAAM,IAAA,GAAOC,aAAAA;AAAA,IACX,MACE,MAAA,GACIC,gBAAAA,CAAY,MAAA,EAAQ,IAAA,EAAM,YAAY,CAAA,GACtC,EAAE,KAAA,EAAO,IAAI,WAAA,EAAa,EAAC,EAAG,mBAAA,EAAqB,EAAC,EAAE;AAAA,IAC5D,CAAC,MAAA,EAAQ,IAAA,EAAM,YAAY;AAAA,GAC7B;AAEA,EAAA,MAAM,IAAA,GAAOD,aAAAA;AAAA,IACX,MAAM,KAAK,KAAA,CAAM,IAAA,CAAK,CAAC,CAAA,KAAM,CAAA,CAAE,UAAA,CAAW,EAAA,KAAO,MAAM,CAAA;AAAA,IACvD,CAAC,IAAA,CAAK,KAAA,EAAO,MAAM;AAAA,GACrB;AAEA,EAAA,MAAM,aAAA,GAAgBA,aAAAA;AAAA,IACpB,MAAM,MAAM,MAAA,CAAO,MAAA,CAAO,CAAC,CAAA,KAAM,CAAA,CAAE,OAAO,CAAA,IAAK,EAAC;AAAA,IAChD,CAAC,IAAI;AAAA,GACP;AAEA,EAAA,OAAO;AAAA,IACL,IAAA;AAAA,IACA,MAAA,EAAQ,aAAA;AAAA,IACR,QAAA,EAAU,IAAA,CAAK,MAAM,CAAA,IAAK,EAAC;AAAA,IAC3B,aAAA,EAAe,CAAC,OAAA,EAAS,KAAA,KACvB,KAAA,CAAM,UAAS,CAAE,aAAA,CAAc,MAAA,EAAQ,OAAA,EAAS,KAAK,CAAA;AAAA,IACvD,WAAA,EAAa,CAAC,CAAA,KAAM,KAAA,CAAM,UAAS,CAAE,WAAA,CAAY,QAAQ,CAAC;AAAA,GAC5D;AACF","file":"index.cjs","sourcesContent":["import { useMemo } from \"react\";\nimport { useStore } from \"zustand\";\nimport type { StoreApi } from \"zustand\";\n\nimport {\n resolveTree,\n calculateProgress,\n getNextStep,\n getPreviousStep,\n} from \"@waypointjs/core\";\nimport type { WaypointRuntimeStore } from \"@waypointjs/core\";\nimport type { ResolvedStep, ResolvedTree } from \"@waypointjs/core\";\n\n// ---------------------------------------------------------------------------\n// Return type\n// ---------------------------------------------------------------------------\n\nexport interface WaypointState {\n schema: WaypointRuntimeStore[\"schema\"];\n data: WaypointRuntimeStore[\"data\"];\n externalVars: WaypointRuntimeStore[\"externalVars\"];\n currentStepId: string | null;\n currentStep: ResolvedStep | undefined;\n nextStep: ResolvedStep | undefined;\n previousStep: ResolvedStep | undefined;\n tree: ResolvedTree;\n progress: number;\n isFirstStep: boolean;\n isLastStep: boolean;\n isSubmitting: boolean;\n missingExternalVars: string[];\n // Store actions\n setFieldValue(stepId: string, fieldId: string, value: unknown): void;\n setStepData(stepId: string, data: Record<string, unknown>): void;\n setExternalVar(varId: string, value: unknown): void;\n setCurrentStep(stepId: string): void;\n reset(): void;\n}\n\n// ---------------------------------------------------------------------------\n// Hook\n// ---------------------------------------------------------------------------\n\n/**\n * Headless hook for accessing and mutating the Waypoint runtime store.\n *\n * Router-agnostic — use `@waypointjs/next`'s `useWaypointStep()` for full\n * Next.js integration with form handling and automatic navigation.\n *\n * @example\n * const { currentStep, progress, setFieldValue } = useWaypoint(store);\n */\nexport function useWaypoint(store: StoreApi<WaypointRuntimeStore>): WaypointState {\n const { schema, data, externalVars, currentStepId, isSubmitting } = useStore(\n store,\n (s: WaypointRuntimeStore) => ({\n schema: s.schema,\n data: s.data,\n externalVars: s.externalVars,\n currentStepId: s.currentStepId,\n isSubmitting: s.isSubmitting,\n })\n );\n\n const tree = useMemo(\n () =>\n schema\n ? resolveTree(schema, data, externalVars)\n : { steps: [], hiddenSteps: [], missingExternalVars: [] },\n [schema, data, externalVars]\n );\n\n const currentStep = useMemo(\n () =>\n currentStepId\n ? tree.steps.find((s) => s.definition.id === currentStepId)\n : undefined,\n [tree.steps, currentStepId]\n );\n\n const nextStep = useMemo(\n () =>\n currentStepId ? getNextStep(tree.steps, currentStepId) : undefined,\n [tree.steps, currentStepId]\n );\n\n const previousStep = useMemo(\n () =>\n currentStepId ? getPreviousStep(tree.steps, currentStepId) : undefined,\n [tree.steps, currentStepId]\n );\n\n const progress = useMemo(\n () =>\n currentStepId ? calculateProgress(tree.steps, currentStepId) : 0,\n [tree.steps, currentStepId]\n );\n\n return {\n schema,\n data,\n externalVars,\n currentStepId,\n currentStep,\n nextStep,\n previousStep,\n tree,\n progress,\n isFirstStep: !previousStep,\n isLastStep: !nextStep,\n isSubmitting,\n missingExternalVars: tree.missingExternalVars,\n\n setFieldValue: (stepId, fieldId, value) =>\n store.getState().setFieldValue(stepId, fieldId, value),\n setStepData: (stepId, data) =>\n store.getState().setStepData(stepId, data),\n setExternalVar: (varId, value) =>\n store.getState().setExternalVar(varId, value),\n setCurrentStep: (stepId) => store.getState().setCurrentStep(stepId),\n reset: () => store.getState().reset(),\n };\n}\n","import { useMemo } from \"react\";\nimport { useStore } from \"zustand\";\nimport type { StoreApi } from \"zustand\";\n\nimport { resolveTree } from \"@waypointjs/core\";\nimport type { WaypointRuntimeStore } from \"@waypointjs/core\";\nimport type { ResolvedField, ResolvedStep } from \"@waypointjs/core\";\n\n// ---------------------------------------------------------------------------\n// Return type\n// ---------------------------------------------------------------------------\n\nexport interface WaypointHeadlessStep {\n step: ResolvedStep | undefined;\n /** Visible fields for this step */\n fields: ResolvedField[];\n /** Current persisted data for this step */\n stepData: Record<string, unknown>;\n setFieldValue(fieldId: string, value: unknown): void;\n setStepData(data: Record<string, unknown>): void;\n}\n\n// ---------------------------------------------------------------------------\n// Hook\n// ---------------------------------------------------------------------------\n\n/**\n * Headless (router-agnostic) hook that resolves a specific step's fields and data.\n *\n * Use `@waypointjs/next`'s `useWaypointStep()` for full Next.js integration\n * (form, validation, navigation).\n *\n * @param store - The runtime store instance from your context\n * @param stepId - The step id to resolve\n */\nexport function useWaypointStep(\n store: StoreApi<WaypointRuntimeStore>,\n stepId: string\n): WaypointHeadlessStep {\n const { schema, data, externalVars } = useStore(store, (s: WaypointRuntimeStore) => ({\n schema: s.schema,\n data: s.data,\n externalVars: s.externalVars,\n }));\n\n const tree = useMemo(\n () =>\n schema\n ? resolveTree(schema, data, externalVars)\n : { steps: [], hiddenSteps: [], missingExternalVars: [] },\n [schema, data, externalVars]\n );\n\n const step = useMemo(\n () => tree.steps.find((s) => s.definition.id === stepId),\n [tree.steps, stepId]\n );\n\n const visibleFields = useMemo(\n () => step?.fields.filter((f) => f.visible) ?? [],\n [step]\n );\n\n return {\n step,\n fields: visibleFields,\n stepData: data[stepId] ?? {},\n setFieldValue: (fieldId, value) =>\n store.getState().setFieldValue(stepId, fieldId, value),\n setStepData: (d) => store.getState().setStepData(stepId, d),\n };\n}\n"]}
|
package/dist/index.d.cts
ADDED
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
import { StoreApi } from 'zustand';
|
|
2
|
+
import { WaypointRuntimeStore, ResolvedStep, ResolvedTree, ResolvedField } from '@waypointjs/core';
|
|
3
|
+
|
|
4
|
+
interface WaypointState {
|
|
5
|
+
schema: WaypointRuntimeStore["schema"];
|
|
6
|
+
data: WaypointRuntimeStore["data"];
|
|
7
|
+
externalVars: WaypointRuntimeStore["externalVars"];
|
|
8
|
+
currentStepId: string | null;
|
|
9
|
+
currentStep: ResolvedStep | undefined;
|
|
10
|
+
nextStep: ResolvedStep | undefined;
|
|
11
|
+
previousStep: ResolvedStep | undefined;
|
|
12
|
+
tree: ResolvedTree;
|
|
13
|
+
progress: number;
|
|
14
|
+
isFirstStep: boolean;
|
|
15
|
+
isLastStep: boolean;
|
|
16
|
+
isSubmitting: boolean;
|
|
17
|
+
missingExternalVars: string[];
|
|
18
|
+
setFieldValue(stepId: string, fieldId: string, value: unknown): void;
|
|
19
|
+
setStepData(stepId: string, data: Record<string, unknown>): void;
|
|
20
|
+
setExternalVar(varId: string, value: unknown): void;
|
|
21
|
+
setCurrentStep(stepId: string): void;
|
|
22
|
+
reset(): void;
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* Headless hook for accessing and mutating the Waypoint runtime store.
|
|
26
|
+
*
|
|
27
|
+
* Router-agnostic — use `@waypointjs/next`'s `useWaypointStep()` for full
|
|
28
|
+
* Next.js integration with form handling and automatic navigation.
|
|
29
|
+
*
|
|
30
|
+
* @example
|
|
31
|
+
* const { currentStep, progress, setFieldValue } = useWaypoint(store);
|
|
32
|
+
*/
|
|
33
|
+
declare function useWaypoint(store: StoreApi<WaypointRuntimeStore>): WaypointState;
|
|
34
|
+
|
|
35
|
+
interface WaypointHeadlessStep {
|
|
36
|
+
step: ResolvedStep | undefined;
|
|
37
|
+
/** Visible fields for this step */
|
|
38
|
+
fields: ResolvedField[];
|
|
39
|
+
/** Current persisted data for this step */
|
|
40
|
+
stepData: Record<string, unknown>;
|
|
41
|
+
setFieldValue(fieldId: string, value: unknown): void;
|
|
42
|
+
setStepData(data: Record<string, unknown>): void;
|
|
43
|
+
}
|
|
44
|
+
/**
|
|
45
|
+
* Headless (router-agnostic) hook that resolves a specific step's fields and data.
|
|
46
|
+
*
|
|
47
|
+
* Use `@waypointjs/next`'s `useWaypointStep()` for full Next.js integration
|
|
48
|
+
* (form, validation, navigation).
|
|
49
|
+
*
|
|
50
|
+
* @param store - The runtime store instance from your context
|
|
51
|
+
* @param stepId - The step id to resolve
|
|
52
|
+
*/
|
|
53
|
+
declare function useWaypointStep(store: StoreApi<WaypointRuntimeStore>, stepId: string): WaypointHeadlessStep;
|
|
54
|
+
|
|
55
|
+
export { type WaypointHeadlessStep, type WaypointState, useWaypoint, useWaypointStep };
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
import { StoreApi } from 'zustand';
|
|
2
|
+
import { WaypointRuntimeStore, ResolvedStep, ResolvedTree, ResolvedField } from '@waypointjs/core';
|
|
3
|
+
|
|
4
|
+
interface WaypointState {
|
|
5
|
+
schema: WaypointRuntimeStore["schema"];
|
|
6
|
+
data: WaypointRuntimeStore["data"];
|
|
7
|
+
externalVars: WaypointRuntimeStore["externalVars"];
|
|
8
|
+
currentStepId: string | null;
|
|
9
|
+
currentStep: ResolvedStep | undefined;
|
|
10
|
+
nextStep: ResolvedStep | undefined;
|
|
11
|
+
previousStep: ResolvedStep | undefined;
|
|
12
|
+
tree: ResolvedTree;
|
|
13
|
+
progress: number;
|
|
14
|
+
isFirstStep: boolean;
|
|
15
|
+
isLastStep: boolean;
|
|
16
|
+
isSubmitting: boolean;
|
|
17
|
+
missingExternalVars: string[];
|
|
18
|
+
setFieldValue(stepId: string, fieldId: string, value: unknown): void;
|
|
19
|
+
setStepData(stepId: string, data: Record<string, unknown>): void;
|
|
20
|
+
setExternalVar(varId: string, value: unknown): void;
|
|
21
|
+
setCurrentStep(stepId: string): void;
|
|
22
|
+
reset(): void;
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* Headless hook for accessing and mutating the Waypoint runtime store.
|
|
26
|
+
*
|
|
27
|
+
* Router-agnostic — use `@waypointjs/next`'s `useWaypointStep()` for full
|
|
28
|
+
* Next.js integration with form handling and automatic navigation.
|
|
29
|
+
*
|
|
30
|
+
* @example
|
|
31
|
+
* const { currentStep, progress, setFieldValue } = useWaypoint(store);
|
|
32
|
+
*/
|
|
33
|
+
declare function useWaypoint(store: StoreApi<WaypointRuntimeStore>): WaypointState;
|
|
34
|
+
|
|
35
|
+
interface WaypointHeadlessStep {
|
|
36
|
+
step: ResolvedStep | undefined;
|
|
37
|
+
/** Visible fields for this step */
|
|
38
|
+
fields: ResolvedField[];
|
|
39
|
+
/** Current persisted data for this step */
|
|
40
|
+
stepData: Record<string, unknown>;
|
|
41
|
+
setFieldValue(fieldId: string, value: unknown): void;
|
|
42
|
+
setStepData(data: Record<string, unknown>): void;
|
|
43
|
+
}
|
|
44
|
+
/**
|
|
45
|
+
* Headless (router-agnostic) hook that resolves a specific step's fields and data.
|
|
46
|
+
*
|
|
47
|
+
* Use `@waypointjs/next`'s `useWaypointStep()` for full Next.js integration
|
|
48
|
+
* (form, validation, navigation).
|
|
49
|
+
*
|
|
50
|
+
* @param store - The runtime store instance from your context
|
|
51
|
+
* @param stepId - The step id to resolve
|
|
52
|
+
*/
|
|
53
|
+
declare function useWaypointStep(store: StoreApi<WaypointRuntimeStore>, stepId: string): WaypointHeadlessStep;
|
|
54
|
+
|
|
55
|
+
export { type WaypointHeadlessStep, type WaypointState, useWaypoint, useWaypointStep };
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
import { useMemo } from 'react';
|
|
2
|
+
import { useStore } from 'zustand';
|
|
3
|
+
import { resolveTree, getNextStep, getPreviousStep, calculateProgress } from '@waypointjs/core';
|
|
4
|
+
|
|
5
|
+
// src/useWaypoint.ts
|
|
6
|
+
function useWaypoint(store) {
|
|
7
|
+
const { schema, data, externalVars, currentStepId, isSubmitting } = useStore(
|
|
8
|
+
store,
|
|
9
|
+
(s) => ({
|
|
10
|
+
schema: s.schema,
|
|
11
|
+
data: s.data,
|
|
12
|
+
externalVars: s.externalVars,
|
|
13
|
+
currentStepId: s.currentStepId,
|
|
14
|
+
isSubmitting: s.isSubmitting
|
|
15
|
+
})
|
|
16
|
+
);
|
|
17
|
+
const tree = useMemo(
|
|
18
|
+
() => schema ? resolveTree(schema, data, externalVars) : { steps: [], hiddenSteps: [], missingExternalVars: [] },
|
|
19
|
+
[schema, data, externalVars]
|
|
20
|
+
);
|
|
21
|
+
const currentStep = useMemo(
|
|
22
|
+
() => currentStepId ? tree.steps.find((s) => s.definition.id === currentStepId) : void 0,
|
|
23
|
+
[tree.steps, currentStepId]
|
|
24
|
+
);
|
|
25
|
+
const nextStep = useMemo(
|
|
26
|
+
() => currentStepId ? getNextStep(tree.steps, currentStepId) : void 0,
|
|
27
|
+
[tree.steps, currentStepId]
|
|
28
|
+
);
|
|
29
|
+
const previousStep = useMemo(
|
|
30
|
+
() => currentStepId ? getPreviousStep(tree.steps, currentStepId) : void 0,
|
|
31
|
+
[tree.steps, currentStepId]
|
|
32
|
+
);
|
|
33
|
+
const progress = useMemo(
|
|
34
|
+
() => currentStepId ? calculateProgress(tree.steps, currentStepId) : 0,
|
|
35
|
+
[tree.steps, currentStepId]
|
|
36
|
+
);
|
|
37
|
+
return {
|
|
38
|
+
schema,
|
|
39
|
+
data,
|
|
40
|
+
externalVars,
|
|
41
|
+
currentStepId,
|
|
42
|
+
currentStep,
|
|
43
|
+
nextStep,
|
|
44
|
+
previousStep,
|
|
45
|
+
tree,
|
|
46
|
+
progress,
|
|
47
|
+
isFirstStep: !previousStep,
|
|
48
|
+
isLastStep: !nextStep,
|
|
49
|
+
isSubmitting,
|
|
50
|
+
missingExternalVars: tree.missingExternalVars,
|
|
51
|
+
setFieldValue: (stepId, fieldId, value) => store.getState().setFieldValue(stepId, fieldId, value),
|
|
52
|
+
setStepData: (stepId, data2) => store.getState().setStepData(stepId, data2),
|
|
53
|
+
setExternalVar: (varId, value) => store.getState().setExternalVar(varId, value),
|
|
54
|
+
setCurrentStep: (stepId) => store.getState().setCurrentStep(stepId),
|
|
55
|
+
reset: () => store.getState().reset()
|
|
56
|
+
};
|
|
57
|
+
}
|
|
58
|
+
function useWaypointStep(store, stepId) {
|
|
59
|
+
const { schema, data, externalVars } = useStore(store, (s) => ({
|
|
60
|
+
schema: s.schema,
|
|
61
|
+
data: s.data,
|
|
62
|
+
externalVars: s.externalVars
|
|
63
|
+
}));
|
|
64
|
+
const tree = useMemo(
|
|
65
|
+
() => schema ? resolveTree(schema, data, externalVars) : { steps: [], hiddenSteps: [], missingExternalVars: [] },
|
|
66
|
+
[schema, data, externalVars]
|
|
67
|
+
);
|
|
68
|
+
const step = useMemo(
|
|
69
|
+
() => tree.steps.find((s) => s.definition.id === stepId),
|
|
70
|
+
[tree.steps, stepId]
|
|
71
|
+
);
|
|
72
|
+
const visibleFields = useMemo(
|
|
73
|
+
() => step?.fields.filter((f) => f.visible) ?? [],
|
|
74
|
+
[step]
|
|
75
|
+
);
|
|
76
|
+
return {
|
|
77
|
+
step,
|
|
78
|
+
fields: visibleFields,
|
|
79
|
+
stepData: data[stepId] ?? {},
|
|
80
|
+
setFieldValue: (fieldId, value) => store.getState().setFieldValue(stepId, fieldId, value),
|
|
81
|
+
setStepData: (d) => store.getState().setStepData(stepId, d)
|
|
82
|
+
};
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
export { useWaypoint, useWaypointStep };
|
|
86
|
+
//# sourceMappingURL=index.js.map
|
|
87
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/useWaypoint.ts","../src/useWaypointStep.ts"],"names":["data","useStore","useMemo","resolveTree"],"mappings":";;;;;AAoDO,SAAS,YAAY,KAAA,EAAsD;AAChF,EAAA,MAAM,EAAE,MAAA,EAAQ,IAAA,EAAM,YAAA,EAAc,aAAA,EAAe,cAAa,GAAI,QAAA;AAAA,IAClE,KAAA;AAAA,IACA,CAAC,CAAA,MAA6B;AAAA,MAC5B,QAAQ,CAAA,CAAE,MAAA;AAAA,MACV,MAAM,CAAA,CAAE,IAAA;AAAA,MACR,cAAc,CAAA,CAAE,YAAA;AAAA,MAChB,eAAe,CAAA,CAAE,aAAA;AAAA,MACjB,cAAc,CAAA,CAAE;AAAA,KAClB;AAAA,GACF;AAEA,EAAA,MAAM,IAAA,GAAO,OAAA;AAAA,IACX,MACE,MAAA,GACI,WAAA,CAAY,MAAA,EAAQ,IAAA,EAAM,YAAY,CAAA,GACtC,EAAE,KAAA,EAAO,IAAI,WAAA,EAAa,EAAC,EAAG,mBAAA,EAAqB,EAAC,EAAE;AAAA,IAC5D,CAAC,MAAA,EAAQ,IAAA,EAAM,YAAY;AAAA,GAC7B;AAEA,EAAA,MAAM,WAAA,GAAc,OAAA;AAAA,IAClB,MACE,aAAA,GACI,IAAA,CAAK,KAAA,CAAM,IAAA,CAAK,CAAC,CAAA,KAAM,CAAA,CAAE,UAAA,CAAW,EAAA,KAAO,aAAa,CAAA,GACxD,MAAA;AAAA,IACN,CAAC,IAAA,CAAK,KAAA,EAAO,aAAa;AAAA,GAC5B;AAEA,EAAA,MAAM,QAAA,GAAW,OAAA;AAAA,IACf,MACE,aAAA,GAAgB,WAAA,CAAY,IAAA,CAAK,KAAA,EAAO,aAAa,CAAA,GAAI,MAAA;AAAA,IAC3D,CAAC,IAAA,CAAK,KAAA,EAAO,aAAa;AAAA,GAC5B;AAEA,EAAA,MAAM,YAAA,GAAe,OAAA;AAAA,IACnB,MACE,aAAA,GAAgB,eAAA,CAAgB,IAAA,CAAK,KAAA,EAAO,aAAa,CAAA,GAAI,MAAA;AAAA,IAC/D,CAAC,IAAA,CAAK,KAAA,EAAO,aAAa;AAAA,GAC5B;AAEA,EAAA,MAAM,QAAA,GAAW,OAAA;AAAA,IACf,MACE,aAAA,GAAgB,iBAAA,CAAkB,IAAA,CAAK,KAAA,EAAO,aAAa,CAAA,GAAI,CAAA;AAAA,IACjE,CAAC,IAAA,CAAK,KAAA,EAAO,aAAa;AAAA,GAC5B;AAEA,EAAA,OAAO;AAAA,IACL,MAAA;AAAA,IACA,IAAA;AAAA,IACA,YAAA;AAAA,IACA,aAAA;AAAA,IACA,WAAA;AAAA,IACA,QAAA;AAAA,IACA,YAAA;AAAA,IACA,IAAA;AAAA,IACA,QAAA;AAAA,IACA,aAAa,CAAC,YAAA;AAAA,IACd,YAAY,CAAC,QAAA;AAAA,IACb,YAAA;AAAA,IACA,qBAAqB,IAAA,CAAK,mBAAA;AAAA,IAE1B,aAAA,EAAe,CAAC,MAAA,EAAQ,OAAA,EAAS,KAAA,KAC/B,KAAA,CAAM,QAAA,EAAS,CAAE,aAAA,CAAc,MAAA,EAAQ,OAAA,EAAS,KAAK,CAAA;AAAA,IACvD,WAAA,EAAa,CAAC,MAAA,EAAQA,KAAAA,KACpB,MAAM,QAAA,EAAS,CAAE,WAAA,CAAY,MAAA,EAAQA,KAAI,CAAA;AAAA,IAC3C,cAAA,EAAgB,CAAC,KAAA,EAAO,KAAA,KACtB,MAAM,QAAA,EAAS,CAAE,cAAA,CAAe,KAAA,EAAO,KAAK,CAAA;AAAA,IAC9C,gBAAgB,CAAC,MAAA,KAAW,MAAM,QAAA,EAAS,CAAE,eAAe,MAAM,CAAA;AAAA,IAClE,KAAA,EAAO,MAAM,KAAA,CAAM,QAAA,GAAW,KAAA;AAAM,GACtC;AACF;ACvFO,SAAS,eAAA,CACd,OACA,MAAA,EACsB;AACtB,EAAA,MAAM,EAAE,QAAQ,IAAA,EAAM,YAAA,KAAiBC,QAAAA,CAAS,KAAA,EAAO,CAAC,CAAA,MAA6B;AAAA,IACnF,QAAQ,CAAA,CAAE,MAAA;AAAA,IACV,MAAM,CAAA,CAAE,IAAA;AAAA,IACR,cAAc,CAAA,CAAE;AAAA,GAClB,CAAE,CAAA;AAEF,EAAA,MAAM,IAAA,GAAOC,OAAAA;AAAA,IACX,MACE,MAAA,GACIC,WAAAA,CAAY,MAAA,EAAQ,IAAA,EAAM,YAAY,CAAA,GACtC,EAAE,KAAA,EAAO,IAAI,WAAA,EAAa,EAAC,EAAG,mBAAA,EAAqB,EAAC,EAAE;AAAA,IAC5D,CAAC,MAAA,EAAQ,IAAA,EAAM,YAAY;AAAA,GAC7B;AAEA,EAAA,MAAM,IAAA,GAAOD,OAAAA;AAAA,IACX,MAAM,KAAK,KAAA,CAAM,IAAA,CAAK,CAAC,CAAA,KAAM,CAAA,CAAE,UAAA,CAAW,EAAA,KAAO,MAAM,CAAA;AAAA,IACvD,CAAC,IAAA,CAAK,KAAA,EAAO,MAAM;AAAA,GACrB;AAEA,EAAA,MAAM,aAAA,GAAgBA,OAAAA;AAAA,IACpB,MAAM,MAAM,MAAA,CAAO,MAAA,CAAO,CAAC,CAAA,KAAM,CAAA,CAAE,OAAO,CAAA,IAAK,EAAC;AAAA,IAChD,CAAC,IAAI;AAAA,GACP;AAEA,EAAA,OAAO;AAAA,IACL,IAAA;AAAA,IACA,MAAA,EAAQ,aAAA;AAAA,IACR,QAAA,EAAU,IAAA,CAAK,MAAM,CAAA,IAAK,EAAC;AAAA,IAC3B,aAAA,EAAe,CAAC,OAAA,EAAS,KAAA,KACvB,KAAA,CAAM,UAAS,CAAE,aAAA,CAAc,MAAA,EAAQ,OAAA,EAAS,KAAK,CAAA;AAAA,IACvD,WAAA,EAAa,CAAC,CAAA,KAAM,KAAA,CAAM,UAAS,CAAE,WAAA,CAAY,QAAQ,CAAC;AAAA,GAC5D;AACF","file":"index.js","sourcesContent":["import { useMemo } from \"react\";\nimport { useStore } from \"zustand\";\nimport type { StoreApi } from \"zustand\";\n\nimport {\n resolveTree,\n calculateProgress,\n getNextStep,\n getPreviousStep,\n} from \"@waypointjs/core\";\nimport type { WaypointRuntimeStore } from \"@waypointjs/core\";\nimport type { ResolvedStep, ResolvedTree } from \"@waypointjs/core\";\n\n// ---------------------------------------------------------------------------\n// Return type\n// ---------------------------------------------------------------------------\n\nexport interface WaypointState {\n schema: WaypointRuntimeStore[\"schema\"];\n data: WaypointRuntimeStore[\"data\"];\n externalVars: WaypointRuntimeStore[\"externalVars\"];\n currentStepId: string | null;\n currentStep: ResolvedStep | undefined;\n nextStep: ResolvedStep | undefined;\n previousStep: ResolvedStep | undefined;\n tree: ResolvedTree;\n progress: number;\n isFirstStep: boolean;\n isLastStep: boolean;\n isSubmitting: boolean;\n missingExternalVars: string[];\n // Store actions\n setFieldValue(stepId: string, fieldId: string, value: unknown): void;\n setStepData(stepId: string, data: Record<string, unknown>): void;\n setExternalVar(varId: string, value: unknown): void;\n setCurrentStep(stepId: string): void;\n reset(): void;\n}\n\n// ---------------------------------------------------------------------------\n// Hook\n// ---------------------------------------------------------------------------\n\n/**\n * Headless hook for accessing and mutating the Waypoint runtime store.\n *\n * Router-agnostic — use `@waypointjs/next`'s `useWaypointStep()` for full\n * Next.js integration with form handling and automatic navigation.\n *\n * @example\n * const { currentStep, progress, setFieldValue } = useWaypoint(store);\n */\nexport function useWaypoint(store: StoreApi<WaypointRuntimeStore>): WaypointState {\n const { schema, data, externalVars, currentStepId, isSubmitting } = useStore(\n store,\n (s: WaypointRuntimeStore) => ({\n schema: s.schema,\n data: s.data,\n externalVars: s.externalVars,\n currentStepId: s.currentStepId,\n isSubmitting: s.isSubmitting,\n })\n );\n\n const tree = useMemo(\n () =>\n schema\n ? resolveTree(schema, data, externalVars)\n : { steps: [], hiddenSteps: [], missingExternalVars: [] },\n [schema, data, externalVars]\n );\n\n const currentStep = useMemo(\n () =>\n currentStepId\n ? tree.steps.find((s) => s.definition.id === currentStepId)\n : undefined,\n [tree.steps, currentStepId]\n );\n\n const nextStep = useMemo(\n () =>\n currentStepId ? getNextStep(tree.steps, currentStepId) : undefined,\n [tree.steps, currentStepId]\n );\n\n const previousStep = useMemo(\n () =>\n currentStepId ? getPreviousStep(tree.steps, currentStepId) : undefined,\n [tree.steps, currentStepId]\n );\n\n const progress = useMemo(\n () =>\n currentStepId ? calculateProgress(tree.steps, currentStepId) : 0,\n [tree.steps, currentStepId]\n );\n\n return {\n schema,\n data,\n externalVars,\n currentStepId,\n currentStep,\n nextStep,\n previousStep,\n tree,\n progress,\n isFirstStep: !previousStep,\n isLastStep: !nextStep,\n isSubmitting,\n missingExternalVars: tree.missingExternalVars,\n\n setFieldValue: (stepId, fieldId, value) =>\n store.getState().setFieldValue(stepId, fieldId, value),\n setStepData: (stepId, data) =>\n store.getState().setStepData(stepId, data),\n setExternalVar: (varId, value) =>\n store.getState().setExternalVar(varId, value),\n setCurrentStep: (stepId) => store.getState().setCurrentStep(stepId),\n reset: () => store.getState().reset(),\n };\n}\n","import { useMemo } from \"react\";\nimport { useStore } from \"zustand\";\nimport type { StoreApi } from \"zustand\";\n\nimport { resolveTree } from \"@waypointjs/core\";\nimport type { WaypointRuntimeStore } from \"@waypointjs/core\";\nimport type { ResolvedField, ResolvedStep } from \"@waypointjs/core\";\n\n// ---------------------------------------------------------------------------\n// Return type\n// ---------------------------------------------------------------------------\n\nexport interface WaypointHeadlessStep {\n step: ResolvedStep | undefined;\n /** Visible fields for this step */\n fields: ResolvedField[];\n /** Current persisted data for this step */\n stepData: Record<string, unknown>;\n setFieldValue(fieldId: string, value: unknown): void;\n setStepData(data: Record<string, unknown>): void;\n}\n\n// ---------------------------------------------------------------------------\n// Hook\n// ---------------------------------------------------------------------------\n\n/**\n * Headless (router-agnostic) hook that resolves a specific step's fields and data.\n *\n * Use `@waypointjs/next`'s `useWaypointStep()` for full Next.js integration\n * (form, validation, navigation).\n *\n * @param store - The runtime store instance from your context\n * @param stepId - The step id to resolve\n */\nexport function useWaypointStep(\n store: StoreApi<WaypointRuntimeStore>,\n stepId: string\n): WaypointHeadlessStep {\n const { schema, data, externalVars } = useStore(store, (s: WaypointRuntimeStore) => ({\n schema: s.schema,\n data: s.data,\n externalVars: s.externalVars,\n }));\n\n const tree = useMemo(\n () =>\n schema\n ? resolveTree(schema, data, externalVars)\n : { steps: [], hiddenSteps: [], missingExternalVars: [] },\n [schema, data, externalVars]\n );\n\n const step = useMemo(\n () => tree.steps.find((s) => s.definition.id === stepId),\n [tree.steps, stepId]\n );\n\n const visibleFields = useMemo(\n () => step?.fields.filter((f) => f.visible) ?? [],\n [step]\n );\n\n return {\n step,\n fields: visibleFields,\n stepData: data[stepId] ?? {},\n setFieldValue: (fieldId, value) =>\n store.getState().setFieldValue(stepId, fieldId, value),\n setStepData: (d) => store.getState().setStepData(stepId, d),\n };\n}\n"]}
|
package/package.json
ADDED
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@waypointjs/react",
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"description": "React hooks for waypoint journey navigation",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"navigation",
|
|
7
|
+
"journey",
|
|
8
|
+
"wizard",
|
|
9
|
+
"react",
|
|
10
|
+
"hooks"
|
|
11
|
+
],
|
|
12
|
+
"license": "MIT",
|
|
13
|
+
"type": "module",
|
|
14
|
+
"main": "./dist/index.cjs",
|
|
15
|
+
"module": "./dist/index.js",
|
|
16
|
+
"types": "./dist/index.d.ts",
|
|
17
|
+
"exports": {
|
|
18
|
+
".": {
|
|
19
|
+
"types": "./dist/index.d.ts",
|
|
20
|
+
"import": "./dist/index.js",
|
|
21
|
+
"require": "./dist/index.cjs"
|
|
22
|
+
}
|
|
23
|
+
},
|
|
24
|
+
"files": [
|
|
25
|
+
"dist"
|
|
26
|
+
],
|
|
27
|
+
"dependencies": {
|
|
28
|
+
"zustand": "^4.5.2",
|
|
29
|
+
"@waypointjs/core": "0.1.0"
|
|
30
|
+
},
|
|
31
|
+
"devDependencies": {
|
|
32
|
+
"@types/node": "^20.19.33",
|
|
33
|
+
"@types/react": "^18.3.3",
|
|
34
|
+
"react": "^18.3.1",
|
|
35
|
+
"tsup": "^8.1.0",
|
|
36
|
+
"typescript": "^5.4.5"
|
|
37
|
+
},
|
|
38
|
+
"peerDependencies": {
|
|
39
|
+
"react": ">=18",
|
|
40
|
+
"zustand": ">=4"
|
|
41
|
+
},
|
|
42
|
+
"scripts": {
|
|
43
|
+
"build": "tsup",
|
|
44
|
+
"dev": "tsup --watch",
|
|
45
|
+
"lint": "tsc --noEmit"
|
|
46
|
+
}
|
|
47
|
+
}
|