@frankieone/one-sdk 1.9.42 → 1.10.0-rc

package/dist/esm/modules/journey/flows/ekycFlow.js

@@ -0,0 +1,179 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { REVIEW_VERIFY_EVENTS } from '../steps/stepTable.js';
+import { transportErrorSignal } from '../classify/transportError.js';
+import { mkScreenSequence } from './screenSequence.js';
+const ABANDONED = { alerts: [], signal: 'user_exited' };
+/**
+ * `stepTable.ts`'s REVIEW_VERIFY row: ReviewDocument.tsx's own built-in
+ * submit({verify:true})+classify is trusted as-is, not re-derived from a
+ * second submit — so this maps each outcome event straight to the
+ * ClassifierInput that produces the matching classify.ts outcome, rather
+ * than reading alerts/statusType off a CheckSummary nobody fetched here.
+ */
+const REVIEW_OUTCOME = {
+    'form:review:success': { alerts: [], statusType: 'passed' },
+    'form:review:failed': { alerts: [], statusType: 'failed' },
+    'form:review:partial': { alerts: ['partial'] },
+    'form:review:pending': { alerts: [] },
+};
+/**
+ * eKYC's own step runner — no vendor, no CAPTURE step. The whole attempt is
+ * PERSONAL → DOCUMENT → REVIEW, all human-gated form screens.
+ *
+ * REVIEW itself is where this flow genuinely diverges from idv/ocr: it does
+ * NOT call `submitAndClassify` (`individual().submit({verify:true})`) itself.
+ * ReviewDocument.tsx (the `type: 'manual'` REVIEW component) already has its
+ * own built-in submit-and-classify — `verify: true` makes it call submit
+ * itself, and `customResult: true` makes it emit
+ * `form:review:{success|failed|pending|partial}` with the outcome, instead of
+ * rendering its own `<Result>` UI. Calling submit a second time here would be
+ * redundant at best. See `stepTable.ts`'s REVIEW_VERIFY row for exactly which
+ * ReviewDocument.tsx branch produces which event.
+ *
+ * The data-correction retry (spec §6) uses the dedicated RETRY module
+ * (`Retry.tsx`), not a second plain REVIEW mount — it reads the previous
+ * submission's `retryPages` and routes the applicant straight to whichever
+ * field needs correcting, landing back on `<ReviewDocument/>` to resubmit.
+ */
+export const mkEkycStepRunner = (deps) => {
+    const { oneSdk, config, machine, firstPaint } = deps;
+    const screens = mkScreenSequence({ oneSdk, config, machine, firstPaint });
+    const logo = config.logo ? { src: config.logo } : undefined;
+    const finish = (input) => {
+        if (!machine.isPending('REVIEW_VERIFY'))
+            return;
+        machine.complete('REVIEW_VERIFY', input);
+    };
+    machine.release(() => finish(ABANDONED));
+    const failInternal = (error) => {
+        // FDEL-53728 Q2. A transport failure is not an internal fault, and the same
+        // 401 must not report one way from the verify-submit and another from
+        // `search()`. `transportErrorSignal` returns undefined for everything else,
+        // so a genuine fault keeps `unmapped_status` / `internal` as before.
+        const transport = transportErrorSignal(error);
+        if (transport) {
+            finish({
+                alerts: [],
+                signal: transport,
+                errorDetail: { code: transport, message: error.message },
+            });
+            return;
+        }
+        finish({
+            alerts: [],
+            signal: 'unmapped_status',
+            errorDetail: { code: 'internal', message: error.message },
+        });
+    };
+    /**
+     * Wires every REVIEW_VERIFY_EVENTS listener onto `screen` and settles the
+     * step with the matching outcome. Bypasses `screenSequence.ts`'s generic
+     * `present()` (built for "one event completes the step", not "any of four
+     * events completes it, and which one decides the outcome") — the same
+     * reason `idvFlow.ts`'s CAPTURE listeners wire directly rather than through
+     * it. Listeners are attached before `mount()`, so a fast auto-submit cannot
+     * be missed, and released once, on the machine's single teardown.
+     */
+    const listenForOutcome = (screen) => {
+        const emitter = screen;
+        const listener = (event) => () => finish(REVIEW_OUTCOME[event]);
+        const listeners = REVIEW_VERIFY_EVENTS.map((event) => [event, listener(event)]);
+        listeners.forEach(([event, cb]) => emitter.on(event, cb));
+        machine.release(() => listeners.forEach(([event, cb]) => { var _a; return (_a = emitter.off) === null || _a === void 0 ? void 0 : _a.call(emitter, event, cb); }));
+    };
+    /**
+     * `verify`/`customResult` are forced, not passthrough: the whole point of
+     * this step is ReviewDocument.tsx actually running its built-in
+     * submit+classify and emitting the outcome, not rendering its own
+     * `<Result>` UI, so a passed-through `config.review.verify` cannot turn
+     * either off.
+     */
+    const mountReviewVerify = () => {
+        const screen = oneSdk.component('form', Object.assign(Object.assign({ name: 'REVIEW', mode: 'individual', type: 'manual', logo }, config.review), { verify: true, customResult: true }));
+        listenForOutcome(screen);
+        // reachable as the first screen only via the startAt:'REVIEW' test seam —
+        // the normal path already fires this from presentPersonal()
+        firstPaint.watch(screen, ['form:review:loaded']);
+        return screen.mount(config.container);
+    };
+    /**
+     * The retry module reads the previous submission's `retryPages`/form data
+     * straight out of the react form vendor's shared redux store
+     * (`modules/form/vendors/react/redux/store.ts` — a module-level singleton,
+     * so this fresh `component('form', {name:'RETRY'})` instance still sees
+     * it) and routes the applicant to whichever field actually needs
+     * correcting. It renders `<ReviewDocument/>` once it lands back on REVIEW,
+     * still reading the REVIEW slot's config (`verify`/`customResult`) that
+     * `mountReviewVerify()` set — so it fires the same REVIEW_VERIFY_EVENTS.
+     */
+    const mountRetry = () => {
+        const screen = oneSdk.component('form', Object.assign({ name: 'RETRY', mode: 'individual', type: 'manual', logo }, config.retry));
+        listenForOutcome(screen);
+        return screen.mount(config.container);
+    };
+    /**
+     * PERSONAL → DOCUMENT, with DOCUMENT's "Back" link looping back to PERSONAL
+     * rather than dead-ending (`screenSequence.ts`'s `presentDocument`). Each
+     * pass re-runs both steps through the machine: they have already completed,
+     * so they are no longer in flight and `run()` opens a fresh screen for each
+     * — the react form vendor's redux store is a module-level singleton, so what
+     * the applicant already entered is still there when PERSONAL comes back.
+     */
+    const presentIdentity = () => __awaiter(void 0, void 0, void 0, function* () {
+        yield screens.presentPersonal();
+        const exit = yield screens.presentDocument();
+        if (exit === 'back')
+            yield presentIdentity();
+    });
+    const runFullSequence = () => screens
+        .presentPreCapture()
+        .then(() => presentIdentity())
+        .then(() => mountReviewVerify())
+        .catch(failInternal);
+    /** spec §6 — the data-correction retry: PARTIAL screen, then the RETRY module */
+    const retryWithCorrectedData = () => screens
+        .presentPartial()
+        .then(() => mountRetry())
+        .catch(failInternal);
+    /** TEST SEAM (idvFlow.ts) — go straight to review, mounting nothing before it */
+    const startAtReview = () => Promise.resolve(mountReviewVerify()).catch(failInternal);
+    const run = (attempt) => {
+        if (machine.isTorn())
+            return Promise.resolve(ABANDONED);
+        return machine.run('REVIEW_VERIFY', () => {
+            if (attempt === 0 && config.startAt === 'REVIEW') {
+                void startAtReview();
+                return undefined;
+            }
+            if (attempt > 0) {
+                void retryWithCorrectedData();
+                return undefined;
+            }
+            void runFullSequence();
+            return undefined;
+        });
+    };
+    /**
+     * Leave the container clear for the terminal card (FDEL-53993 QA B10) —
+     * `ocrFlow.ts`'s copy carries the full reasoning.
+     *
+     * eKYC has no vendor, so there is no `unmount()` to ask first. What it does
+     * have is its own REVIEW screen, still mounted when the journey settles: the
+     * one-screen-at-a-time rule applies to that just as much as to a vendor's
+     * modal, so the clear is the same.
+     */
+    const clearForTerminalScreen = () => {
+        screens.unmountAll();
+        config.container.innerHTML = '';
+    };
+    return { run, clearForTerminalScreen };
+};
+//# sourceMappingURL=ekycFlow.js.map

package/dist/esm/modules/journey/flows/ekycFlow.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ekycFlow.js","sourceRoot":"","sources":["../../../../../modules/journey/flows/ekycFlow.ts"],"names":[],"mappings":";;;;;;;;;AAEA,OAAO,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAE1D,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAElE,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AASpD,MAAM,SAAS,GAAoB,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,aAAa,EAAE,CAAC;AASzE;;;;;;GAMG;AACH,MAAM,cAAc,GAA+C;IACjE,qBAAqB,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,UAAU,EAAE,QAAQ,EAAE;IAC3D,oBAAoB,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,UAAU,EAAE,QAAQ,EAAE;IAC1D,qBAAqB,EAAE,EAAE,MAAM,EAAE,CAAC,SAAS,CAAC,EAAE;IAC9C,qBAAqB,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE;CACtC,CAAC;AASF;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,IAKhC,EAAkB,EAAE;IACnB,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;IACrD,MAAM,OAAO,GAAG,gBAAgB,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,CAAC;IAC1E,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;IAE5D,MAAM,MAAM,GAAG,CAAC,KAAsB,EAAE,EAAE;QACxC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,eAAe,CAAC;YAAE,OAAO;QAChD,OAAO,CAAC,QAAQ,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC;IAC3C,CAAC,CAAC;IAEF,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;IAEzC,MAAM,YAAY,GAAG,CAAC,KAAY,EAAE,EAAE;QACpC,4EAA4E;QAC5E,sEAAsE;QACtE,4EAA4E;QAC5E,qEAAqE;QACrE,MAAM,SAAS,GAAG,oBAAoB,CAAC,KAAK,CAAC,CAAC;QAC9C,IAAI,SAAS,EAAE,CAAC;YACd,MAAM,CAAC;gBACL,MAAM,EAAE,EAAE;gBACV,MAAM,EAAE,SAAS;gBACjB,WAAW,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE;aACzD,CAAC,CAAC;YACH,OAAO;QACT,CAAC;QACD,MAAM,CAAC;YACL,MAAM,EAAE,EAAE;YACV,MAAM,EAAE,iBAAiB;YACzB,WAAW,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE;SAC1D,CAAC,CAAC;IACL,CAAC,CAAC;IAEF;;;;;;;;OAQG;IACH,MAAM,gBAAgB,GAAG,CAAC,MAAkB,EAAQ,EAAE;QACpD,MAAM,OAAO,GAAG,MAAgC,CAAC;QACjD,MAAM,QAAQ,GAAG,CAAC,KAAwB,EAAE,EAAE,CAAC,GAAG,EAAE,CAClD,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC;QAChC,MAAM,SAAS,GAAG,oBAAoB,CAAC,GAAG,CACxC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAU,CAC7C,CAAC;QACF,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC;QAC1D,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,CACnB,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,EAAE,EAAE,WAAC,OAAA,MAAA,OAAO,CAAC,GAAG,wDAAG,KAAK,EAAE,EAAE,CAAC,CAAA,EAAA,CAAC,CAC7D,CAAC;IACJ,CAAC,CAAC;IAEF;;;;;;OAMG;IACH,MAAM,iBAAiB,GAAG,GAAqB,EAAE;QAC/C,MAAM,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC,MAAM,gCACpC,IAAI,EAAE,QAAQ,EACd,IAAI,EAAE,YAAY,EAClB,IAAI,EAAE,QAAQ,EACd,IAAI,IACD,MAAM,CAAC,MAAM,KAChB,MAAM,EAAE,IAAI,EACZ,YAAY,EAAE,IAAI,IACO,CAAC;QAC5B,gBAAgB,CAAC,MAAM,CAAC,CAAC;QACzB,0EAA0E;QAC1E,4DAA4D;QAC5D,UAAU,CAAC,KAAK,CAAC,MAAgC,EAAE,CAAC,oBAAoB,CAAC,CAAC,CAAC;QAC3E,OAAO,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IACxC,CAAC,CAAC;IAEF;;;;;;;;;OASG;IACH,MAAM,UAAU,GAAG,GAAqB,EAAE;QACxC,MAAM,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC,MAAM,kBACpC,IAAI,EAAE,OAAO,EACb,IAAI,EAAE,YAAY,EAClB,IAAI,EAAE,QAAQ,EACd,IAAI,IACD,MAAM,CAAC,KAAK,EACU,CAAC;QAC5B,gBAAgB,CAAC,MAAM,CAAC,CAAC;QACzB,OAAO,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IACxC,CAAC,CAAC;IAEF;;;;;;;OAOG;IACH,MAAM,eAAe,GAAG,GAAwB,EAAE;QAChD,MAAM,OAAO,CAAC,eAAe,EAAE,CAAC;QAChC,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,eAAe,EAAE,CAAC;QAC7C,IAAI,IAAI,KAAK,MAAM;YAAE,MAAM,eAAe,EAAE,CAAC;IAC/C,CAAC,CAAA,CAAC;IAEF,MAAM,eAAe,GAAG,GAAG,EAAE,CAC3B,OAAO;SACJ,iBAAiB,EAAE;SACnB,IAAI,CAAC,GAAG,EAAE,CAAC,eAAe,EAAE,CAAC;SAC7B,IAAI,CAAC,GAAG,EAAE,CAAC,iBAAiB,EAAE,CAAC;SAC/B,KAAK,CAAC,YAAY,CAAC,CAAC;IAEzB,iFAAiF;IACjF,MAAM,sBAAsB,GAAG,GAAG,EAAE,CAClC,OAAO;SACJ,cAAc,EAAE;SAChB,IAAI,CAAC,GAAG,EAAE,CAAC,UAAU,EAAE,CAAC;SACxB,KAAK,CAAC,YAAY,CAAC,CAAC;IAEzB,iFAAiF;IACjF,MAAM,aAAa,GAAG,GAAG,EAAE,CACzB,OAAO,CAAC,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;IAE3D,MAAM,GAAG,GAAe,CAAC,OAAO,EAAE,EAAE;QAClC,IAAI,OAAO,CAAC,MAAM,EAAE;YAAE,OAAO,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QACxD,OAAO,OAAO,CAAC,GAAG,CAAkB,eAAe,EAAE,GAAG,EAAE;YACxD,IAAI,OAAO,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;gBACjD,KAAK,aAAa,EAAE,CAAC;gBACrB,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,IAAI,OAAO,GAAG,CAAC,EAAE,CAAC;gBAChB,KAAK,sBAAsB,EAAE,CAAC;gBAC9B,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,KAAK,eAAe,EAAE,CAAC;YACvB,OAAO,SAAS,CAAC;QACnB,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;IAEF;;;;;;;;OAQG;IACH,MAAM,sBAAsB,GAAG,GAAS,EAAE;QACxC,OAAO,CAAC,UAAU,EAAE,CAAC;QACrB,MAAM,CAAC,SAAS,CAAC,SAAS,GAAG,EAAE,CAAC;IAClC,CAAC,CAAC;IAEF,OAAO,EAAE,GAAG,EAAE,sBAAsB,EAAE,CAAC;AACzC,CAAC,CAAC"}

package/dist/esm/modules/journey/flows/idvFlow.d.ts

@@ -0,0 +1,32 @@
+import type { OneSdkContext } from '../../sdk/types/oneSDK';
+import type { JourneyScreenConfig, ScreenSequence } from './screenSequence';
+import type { StepRunner } from '../journeyHandle';
+import type { FirstPaintSignal } from '../steps/firstPaint';
+import type { StepMachine } from '../steps/stepMachine';
+export type IdvStepRunner = {
+    run: StepRunner;
+    /** take the vendor's UI down at terminal settlement — see the implementation */
+    /** leave the container clear for the terminal card — see the implementation */
+    clearForTerminalScreen: () => void;
+};
+/**
+ * Converts engine events into a ClassifierInput. Decides nothing itself —
+ * spec §5.0.1: the IDV status is process state, never an outcome.
+ *
+ * Which engine events the capture step listens to, and which of them complete
+ * it, is declared in `steps/stepTable.ts` (row CAPTURE) — the handler map below
+ * has to cover exactly those events or it will not compile. Everything is
+ * subscribed once, through the machine, and released by its single teardown.
+ *
+ * There is deliberately **no fallback timer** on anything the applicant does.
+ * The only timer in this file waits out the idv module's own mount debounce,
+ * which guards engine behaviour rather than human action.
+ */
+export declare const mkIdvStepRunner: (deps: {
+    oneSdk: OneSdkContext;
+    config: JourneyScreenConfig;
+    machine: StepMachine;
+    firstPaint: FirstPaintSignal;
+}) => IdvStepRunner;
+export type { JourneyScreenConfig, ScreenSequence };
+//# sourceMappingURL=idvFlow.d.ts.map

package/dist/esm/modules/journey/flows/idvFlow.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"idvFlow.d.ts","sourceRoot":"","sources":["../../../../../modules/journey/flows/idvFlow.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAS9D,OAAO,KAAK,EAAE,mBAAmB,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAC5E,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AACnD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAC5D,OAAO,KAAK,EAAe,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAoCrE,MAAM,MAAM,aAAa,GAAG;IAC1B,GAAG,EAAE,UAAU,CAAC;IAChB,gFAAgF;IAChF,+EAA+E;IAC/E,sBAAsB,EAAE,MAAM,IAAI,CAAC;CACpC,CAAC;AAKF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,eAAe,SAAU;IACpC,MAAM,EAAE,aAAa,CAAC;IACtB,MAAM,EAAE,mBAAmB,CAAC;IAC5B,OAAO,EAAE,WAAW,CAAC;IACrB,UAAU,EAAE,gBAAgB,CAAC;CAC9B,KAAG,aAieH,CAAC;AAEF,YAAY,EAAE,mBAAmB,EAAE,cAAc,EAAE,CAAC"}