@incodetech/core 2.1.1 → 2.2.0-rc.1

package/dist/flow.esm.js

@@ -1,29 +1,15 @@
-import "./BrowserTimerProvider-CHloo0eQ.esm.js";
-import "./api-DsbUi7TO.esm.js";
-import { g as addEvent } from "./events-1wxZ97yf.esm.js";
-import "./endpoints-CwrFQfW7.esm.js";
-import "./stats-BVy52wLy.esm.js";
-import "./sessionInitializer-Dj7-aJaP.esm.js";
-import "./browserSimulation-DZwEy9bu.esm.js";
-import "./platform-0Ot-bF_a.esm.js";
-import "./getBrowser-1yNcfFZR.esm.js";
-import "./tri-CFAPtAUM.esm.js";
-import { a as fromPromise, l as createManager, r as assign, s as createActor, t as setup } from "./xstate.esm-nY3M5UYm.esm.js";
-import "./apiError-DkOXfFBu.esm.js";
-import "./types-BKLb3C42.esm.js";
-import "./session-CLsU2Jnb.esm.js";
-import "./videoSelfieSteps-Djpv7cjb.esm.js";
-import { n as getRequiredWasmPipelines, r as normalizeFlowModules, t as getFlow } from "./flowServices-DkQmOkLV.esm.js";
-import { n as getFinishStatus, r as getTotalScoreStatus, t as classifyScoreStatus } from "./flowCompletionService-B6P6_EF3.esm.js";
-import { n as isAdvanceableError, r as attachFlowEventEmitter, t as runChildModule } from "./runChildModule-kojSv3MH.esm.js";
-
+import { v as addEvent } from "./events-CxfNJVZW.esm.js";
+import { a as enrichFlowModuleConfig, c as resolveFlowModuleConfig, i as resolveDashboardModuleConfig, k as mergeDashboardConfig, n as preloadDashboardFlow, o as getRequiredWasmPipelines, s as normalizeFlowModules, t as getFlow } from "./flowServices-b0Pd4F1K.esm.js";
+import { c as createManager, o as createActor, r as assign, t as setup } from "./xstate.esm-Cf4e0Cfd.esm.js";
+import { n as fromPromise } from "./xstate-actors.esm-CtI5S0f4.esm.js";
+import { n as getFinishStatus, r as getTotalScoreStatus, t as classifyScoreStatus } from "./flowCompletionService-Bt3wD28k.esm.js";
+import { n as isAdvanceableError, r as attachFlowEventEmitter, t as runChildModule } from "./runChildModule-DpRmKWV0.esm.js";
 //#region src/modules/flow/noOpFlowModuleMachine.ts
 const noOpFlowModuleMachine = setup({}).createMachine({
 	id: "noOpFlowModule",
 	initial: "finished",
 	states: { finished: { type: "final" } }
 });
-
 //#endregion
 //#region src/modules/flow/flowStateMachine.ts
 /**
@@ -158,13 +144,11 @@ const flowMachine = setup({
 		} } }
 	}
 });
-
 //#endregion
 //#region src/modules/flow/flowActor.ts
 function createFlowActor(options) {
 	return createActor(flowMachine, { input: { getFlow: options?.getFlow ?? getFlow } }).start();
 }
-
 //#endregion
 //#region src/modules/flow/flowManager.ts
 function mapState(snapshot) {
@@ -201,7 +185,7 @@ function createApi({ actor, getSnapshot, trackElementClicked }) {
 		const snapshot = getSnapshot();
 		return snapshot.matches("ready") && snapshot.context.currentStepIndex > 0;
 	}
-	function getModuleConfig$1(moduleKey) {
+	function getModuleConfig(moduleKey) {
 		const snapshot = getSnapshot();
 		if (!snapshot.matches("ready")) return;
 		return (snapshot.context.flow?.flowModules.find((m) => m.key === moduleKey))?.configuration;
@@ -212,31 +196,73 @@ function createApi({ actor, getSnapshot, trackElementClicked }) {
 		return !!snapshot.context.flow?.flowModules.some((m) => m.key === moduleKey);
 	}
 	return {
+		/**
+		* Loads the flow from the server.
+		* Transitions the state from `idle` to `loading`, then to `ready` on success or `error` on failure.
+		* Requires setup() to have been called with a token first.
+		*/
 		load() {
 			actor.send({ type: "LOAD" });
 		},
+		/**
+		* Cancels the current loading operation and returns to `idle` state.
+		* Only effective when in `loading` state.
+		*/
 		cancel() {
 			trackElementClicked?.("cancel");
 			actor.send({ type: "CANCEL" });
 		},
+		/**
+		* Resets the flow manager to its initial `idle` state.
+		* Can be called from `ready`, `finished`, or `error` states.
+		*/
 		reset() {
 			actor.send({ type: "RESET" });
 		},
+		/**
+		* Advances to the next step in the flow.
+		* If on the last step, transitions to `finished` state.
+		* Only effective when in `ready` state.
+		*/
 		nextStep() {
 			trackElementClicked?.("nextStep");
 			actor.send({ type: "NEXT_STEP" });
 		},
+		/**
+		* Goes back to the previous step in the flow.
+		* Does nothing if already on the first step.
+		* Only effective when in `ready` state.
+		*/
 		prevStep() {
 			trackElementClicked?.("prevStep");
 			actor.send({ type: "PREV_STEP" });
 		},
+		/**
+		* Whether the flow can advance to the next step.
+		* Returns `true` if in `ready` state and not on the last step.
+		*/
 		get canNext() {
 			return getCanNext();
 		},
+		/**
+		* Whether the flow can go back to the previous step.
+		* Returns `true` if in `ready` state and not on the first step.
+		*/
 		get canPrev() {
 			return getCanPrev();
 		},
-		getModuleConfig: getModuleConfig$1,
+		/**
+		* Gets the configuration for a specific module by its key.
+		* Useful for accessing config of modules other than the current one.
+		* @param moduleKey - The unique key identifier of the module
+		* @returns The module configuration or `undefined` if not found or not in `ready` state
+		*/
+		getModuleConfig,
+		/**
+		* Checks if a module is enabled in the current flow.
+		* @param moduleKey - The unique key identifier of the module
+		* @returns `true` if the module exists in the flow, `false` otherwise or if not in `ready` state
+		*/
 		isModuleEnabled
 	};
 }
@@ -273,7 +299,6 @@ function createFlowManager(options) {
 		createApi
 	}));
 }
-
 //#endregion
 //#region src/modules/flow/moduleLoader.ts
 var ModuleLoaderImpl = class {
@@ -313,19 +338,11 @@ var ModuleLoaderImpl = class {
 function createModuleLoader(registry) {
 	return new ModuleLoaderImpl(registry);
 }
-
 //#endregion
 //#region src/modules/flow/orchestratedFlowStateMachine.ts
 function getModuleConfig(module, flow) {
-	const config = {
-		...module?.configuration,
-		ds: flow?.ds
-	};
-	if (module?.key === "ID" || module?.key === "TUTORIAL_ID" || module?.key === "SECOND_ID" || module?.key === "SELFIE") return {
-		...config,
-		ageAssurance: config.ageAssurance ?? flow?.ageAssurance
-	};
-	return config;
+	if (!module || !flow) return {};
+	return resolveFlowModuleConfig(module, flow);
 }
 function createBaseContext(context, isHomeContinueLoading) {
 	return {
@@ -344,7 +361,8 @@ function createBaseContext(context, isHomeContinueLoading) {
 		getFinishStatus: context.getFinishStatus,
 		enableHome: context.enableHome,
 		finishStatus: void 0,
-		isHomeContinueLoading
+		isHomeContinueLoading,
+		skipFaceMatch: false
 	};
 }
 function createInitialContext(input) {
@@ -423,13 +441,18 @@ const orchestratedFlowMachine = setup({
 			const err = event.error;
 			return {
 				error: err?.message ?? String(err),
-				errorCode: err?.status
+				errorCode: err?.status,
+				moduleErrorCode: err?.moduleErrorCode
 			};
 		}),
 		incrementStep: assign(({ context }) => {
 			const nextIndex = context.currentStepIndex + 1;
 			const module = context.flow?.flowModules?.[nextIndex];
-			const config = getModuleConfig(module, context.flow);
+			const baseConfig = getModuleConfig(module, context.flow);
+			const config = module?.key === "FACE_MATCH" && context.skipFaceMatch === true ? {
+				...baseConfig,
+				skipFaceMatch: true
+			} : baseConfig;
 			return {
 				currentStepIndex: nextIndex,
 				currentStep: module?.key,
@@ -437,6 +460,12 @@ const orchestratedFlowMachine = setup({
 				currentModuleMachine: void 0
 			};
 		}),
+		persistSkipFaceMatch: assign(({ context, event }) => {
+			const isPrimaryIdStep = context.currentStep === "ID" || context.currentStep === "TUTORIAL_ID";
+			const out = event.output;
+			if (!isPrimaryIdStep) return {};
+			return { skipFaceMatch: out?.skipFaceMatch ?? context.skipFaceMatch };
+		}),
 		setCurrentModuleMachine: assign(({ event }) => ({ currentModuleMachine: event.output })),
 		prefetchNextModule: ({ context }) => {
 			prefetchNextLazyModule(context);
@@ -598,7 +627,7 @@ const orchestratedFlowMachine = setup({
 					},
 					{
 						target: "resolvingModule",
-						actions: "incrementStep"
+						actions: ["persistSkipFaceMatch", "incrementStep"]
 					}
 				],
 				MODULE_ERROR: [
@@ -661,7 +690,6 @@ const orchestratedFlowMachine = setup({
 		}
 	}
 });
-
 //#endregion
 //#region src/modules/flow/orchestratedFlowManager.ts
 function deriveUiModel(snapshot, mappedStatus, isHomePhase, options) {
@@ -753,9 +781,9 @@ function mapOrchestratedFlowState(snapshot, uiOptions) {
 		presentation: uiModel.presentation
 	};
 }
-function waitForOrchestratorReadyFromActor(actor, mapState$1, isResolved) {
+function waitForOrchestratorReadyFromActor(actor, mapState, isResolved) {
 	return new Promise((resolve, reject) => {
-		const initial = mapState$1(actor.getSnapshot());
+		const initial = mapState(actor.getSnapshot());
 		if (isResolved(initial)) {
 			resolve();
 			return;
@@ -769,7 +797,7 @@ function waitForOrchestratorReadyFromActor(actor, mapState$1, isResolved) {
 			return;
 		}
 		const subscription = actor.subscribe(() => {
-			const next = mapState$1(actor.getSnapshot());
+			const next = mapState(actor.getSnapshot());
 			if (isResolved(next)) {
 				subscription.unsubscribe();
 				resolve();
@@ -793,7 +821,7 @@ function createOrchestratedFlowApi({ actor, getSnapshot, trackElementClicked },
 		const { currentStepIndex, steps } = snapshot.context;
 		return snapshot.value === "runningModule" && currentStepIndex >= 0 && currentStepIndex < steps.length - 1;
 	}
-	function getModuleConfig$1(moduleKey) {
+	function getModuleConfig(moduleKey) {
 		const snapshot = getSnapshot();
 		if (snapshot.value !== "runningModule") return;
 		return (snapshot.context.flow?.flowModules.find((m) => m.key === moduleKey))?.configuration;
@@ -804,28 +832,75 @@ function createOrchestratedFlowApi({ actor, getSnapshot, trackElementClicked },
 		return !!snapshot.context.flow?.flowModules.some((m) => m.key === moduleKey);
 	}
 	return {
+		/**
+		* Start loading the flow configuration from the backend.
+		*/
 		load() {
 			actor.send({ type: "LOAD" });
 		},
+		/**
+		* Cancel an in-progress flow load.
+		*/
 		cancel() {
 			trackElementClicked?.("cancel");
 			actor.send({ type: "CANCEL" });
 		},
+		/**
+		* Reset the flow to its initial idle state.
+		*/
 		reset() {
 			actor.send({ type: "RESET" });
 		},
-		completeModule() {
+		/**
+		* Signal that the current module has completed successfully.
+		* Call this from your UI component's `onFinish` callback.
+		*
+		* @example
+		* ```tsx
+		* <Phone
+		*   config={config}
+		*   onFinish={() => flowManager.completeModule()}
+		* />
+		* ```
+		*/
+		completeModule(output) {
 			trackElementClicked?.("completeModule");
-			actor.send({ type: "MODULE_COMPLETE" });
+			actor.send({
+				type: "MODULE_COMPLETE",
+				output
+			});
 		},
+		/**
+		* Skip all remaining modules and complete the flow now, notifying the
+		* backend (getFinishStatus) on the way to the completion step.
+		*/
 		completeFlow() {
 			trackElementClicked?.("completeFlow");
 			actor.send({ type: "COMPLETE_FLOW" });
 		},
+		/**
+		* Finish the flow because the onboarding was already completed externally —
+		* e.g. the REDIRECT_TO_MOBILE handoff finished end-to-end on mobile. Lands
+		* on the completion screen WITHOUT calling getFinishStatus: mobile already
+		* notified the backend, and the desktop never reached its own finish.
+		* Use this (not `completeFlow`) from REDIRECT_TO_MOBILE's `onFinish`.
+		*/
 		finishFlow() {
 			trackElementClicked?.("finishFlow");
 			actor.send({ type: "FINISH_FLOW" });
 		},
+		/**
+		* Signal that the current module encountered a terminal error, optionally
+		* with its machine-readable `moduleErrorCode`. The flow machine decides what
+		* to do: an advanceable terminal error (e.g. `NONEXISTENT_CUSTOMER`,
+		* `HINT_NOT_PROVIDED`) advances to the next step; any other error transitions
+		* to the terminal error state. Callers always forward the code and let core
+		* classify — no per-module branching in the UI.
+		*
+		* @param error - Error message describing what went wrong
+		* @param moduleErrorCode - Optional machine-readable error code (a
+		*   `FaceErrorCode`) used by the flow machine to decide advance vs terminate
+		*/
 		errorModule(error, moduleErrorCode) {
 			actor.send({
 				type: "MODULE_ERROR",
@@ -833,17 +908,26 @@ function createOrchestratedFlowApi({ actor, getSnapshot, trackElementClicked },
 				moduleErrorCode
 			});
 		},
+		/**
+		* Send a raw event to the flow state machine.
+		* Prefer using the typed methods (completeModule, errorModule) when possible.
+		*/
 		send(event) {
 			actor.send(event);
 		},
 		get canNext() {
 			return getCanNext();
 		},
-		getModuleConfig: getModuleConfig$1,
+		getModuleConfig,
 		isModuleEnabled,
 		isAwaitingOrchestratorReady() {
 			return mapSnapshot().presentation.isAwaitingReady;
 		},
+		/**
+		* Resolve once the orchestrator has finished loading the flow and the first
+		* module is ready to render. Useful for gating an initialization spinner
+		* alongside other parallel async work (e.g. theme fetching).
+		*/
 		async waitForReady() {
 			return waitForOrchestratorReadyFromActor(actor, (snap) => mapOrchestratedFlowState(snap, { enableHome }), (next) => next.status === "ready" && next.presentation.isAwaitingReady === false);
 		},
@@ -892,6 +976,5 @@ function createOrchestratedFlowManager(options) {
 		createApi: (apiOpts) => createOrchestratedFlowApi(apiOpts, { enableHome })
 	}));
 }
-
 //#endregion
-export { classifyScoreStatus, createFlowManager, createModuleLoader, createOrchestratedFlowManager, getFlow, getRequiredWasmPipelines, getTotalScoreStatus, noOpFlowModuleMachine, normalizeFlowModules };
+export { classifyScoreStatus, createFlowManager, createModuleLoader, createOrchestratedFlowManager, enrichFlowModuleConfig, getFlow, getRequiredWasmPipelines, getTotalScoreStatus, mergeDashboardConfig, noOpFlowModuleMachine, normalizeFlowModules, preloadDashboardFlow, resolveDashboardModuleConfig };

package/dist/{flowCompletionService-B6P6_EF3.esm.js → flowCompletionService-Bt3wD28k.esm.js}

@@ -1,7 +1,6 @@
-import { t as api } from "./api-DsbUi7TO.esm.js";
-import { t as endpoints } from "./endpoints-CwrFQfW7.esm.js";
-import { n as toIncodeApiError } from "./apiError-DkOXfFBu.esm.js";
-
+import { t as api } from "./api-Bx3gKW_y.esm.js";
+import { t as endpoints } from "./endpoints-CCzL3XD_.esm.js";
+import { r as toIncodeApiError } from "./apiError-oiEnJIlk.esm.js";
 //#region src/modules/flow/flowCompletionService.ts
 const getFinishStatus = async (flowId, signal) => {
 	const url = `${endpoints.finishStatus}${flowId ? `?flowId=${flowId}` : ""}`;
@@ -37,6 +36,5 @@ async function getTotalScoreStatus(signal) {
 		toIncodeApiError(endpoints.sessionTotalScoreStatus, error);
 	}
 }
-
 //#endregion
-export { getFinishStatus as n, getTotalScoreStatus as r, classifyScoreStatus as t };
+export { getFinishStatus as n, getTotalScoreStatus as r, classifyScoreStatus as t };