@incodetech/core 2.0.0-alpha.1

package/src/flow/flowAnalyzer.test.ts

@@ -0,0 +1,266 @@
+import { describe, expect, it } from 'vitest';
+import { getRequiredWasmPipelines } from './flowAnalyzer';
+import type { Flow } from './types';
+
+describe('getRequiredWasmPipelines', () => {
+  it('should return empty array for flow with no WASM modules', () => {
+    const flow: Flow = {
+      flowId: 'test-flow',
+      name: 'Test Flow',
+      flowModules: [
+        {
+          key: 'PHONE',
+          configuration: {
+            otpVerification: true,
+            otpExpirationInMinutes: 5,
+            prefill: false,
+          },
+        },
+        {
+          key: 'EMAIL',
+          configuration: {
+            otpVerification: true,
+            otpExpirationInMinutes: 5,
+            prefill: false,
+          },
+        },
+      ],
+    };
+
+    const pipelines = getRequiredWasmPipelines(flow);
+    expect(pipelines).toEqual([]);
+  });
+
+  it('should return selfie pipeline for SELFIE module', () => {
+    const flow: Flow = {
+      flowId: 'test-flow',
+      name: 'Test Flow',
+      flowModules: [
+        {
+          key: 'SELFIE',
+          configuration: {
+            showTutorial: true,
+            showPreview: false,
+            assistedOnboarding: false,
+            enableFaceRecording: false,
+            autoCaptureTimeout: 5000,
+            captureAttempts: 3,
+            validateLenses: false,
+            validateFaceMask: false,
+            validateHeadCover: false,
+            validateClosedEyes: false,
+            validateBrightness: false,
+            deepsightLiveness: 'SINGLE_FRAME',
+          },
+        },
+      ],
+    };
+
+    const pipelines = getRequiredWasmPipelines(flow);
+    expect(pipelines).toEqual(['selfie']);
+  });
+
+  it('should return idCapture pipeline for ID module', () => {
+    const flow: Flow = {
+      flowId: 'test-flow',
+      name: 'Test Flow',
+      flowModules: [
+        {
+          key: 'ID',
+          configuration: {
+            showTutorial: true,
+            enableId: true,
+            enablePassport: false,
+            onlyFront: false,
+            onlyBack: false,
+            barcodeCapture: false,
+            fetchAdditionalPage: false,
+            secondId: false,
+            thirdId: false,
+            autoCaptureTimeout: 5000,
+            deviceIdleTimeout: 30000,
+            captureAttempts: 3,
+            manualUploadIdCapture: false,
+            digitalIdsUpload: false,
+            showDocumentChooserScreen: false,
+            enableIdRecording: false,
+            usSmartCapture: false,
+            perCountryPerDocOverrides: {},
+          },
+        },
+      ],
+    };
+
+    const pipelines = getRequiredWasmPipelines(flow);
+    expect(pipelines).toEqual(['idCapture']);
+  });
+
+  it('should return both pipelines for mixed modules', () => {
+    const flow: Flow = {
+      flowId: 'test-flow',
+      name: 'Test Flow',
+      flowModules: [
+        {
+          key: 'SELFIE',
+          configuration: {
+            showTutorial: true,
+            showPreview: false,
+            assistedOnboarding: false,
+            enableFaceRecording: false,
+            autoCaptureTimeout: 5000,
+            captureAttempts: 3,
+            validateLenses: false,
+            validateFaceMask: false,
+            validateHeadCover: false,
+            validateClosedEyes: false,
+            validateBrightness: false,
+            deepsightLiveness: 'SINGLE_FRAME',
+          },
+        },
+        {
+          key: 'ID',
+          configuration: {
+            showTutorial: true,
+            enableId: true,
+            enablePassport: false,
+            onlyFront: false,
+            onlyBack: false,
+            barcodeCapture: false,
+            fetchAdditionalPage: false,
+            secondId: false,
+            thirdId: false,
+            autoCaptureTimeout: 5000,
+            deviceIdleTimeout: 30000,
+            captureAttempts: 3,
+            manualUploadIdCapture: false,
+            digitalIdsUpload: false,
+            showDocumentChooserScreen: false,
+            enableIdRecording: false,
+            usSmartCapture: false,
+            perCountryPerDocOverrides: {},
+          },
+        },
+      ],
+    };
+
+    const pipelines = getRequiredWasmPipelines(flow);
+    expect(pipelines).toContain('selfie');
+    expect(pipelines).toContain('idCapture');
+    expect(pipelines.length).toBe(2);
+  });
+
+  it('should deduplicate pipelines', () => {
+    const flow: Flow = {
+      flowId: 'test-flow',
+      name: 'Test Flow',
+      flowModules: [
+        {
+          key: 'SELFIE',
+          configuration: {
+            showTutorial: true,
+            showPreview: false,
+            assistedOnboarding: false,
+            enableFaceRecording: false,
+            autoCaptureTimeout: 5000,
+            captureAttempts: 3,
+            validateLenses: false,
+            validateFaceMask: false,
+            validateHeadCover: false,
+            validateClosedEyes: false,
+            validateBrightness: false,
+            deepsightLiveness: 'SINGLE_FRAME',
+          },
+        },
+        {
+          key: 'AUTHENTICATION',
+          configuration: {
+            showTutorial: true,
+            autoCaptureTimeout: 5000,
+            numberOfAttempts: 3,
+            type: 'ONE_TO_ONE',
+            deepsightLiveness: 'SINGLE_FRAME',
+            validateClosedEyes: false,
+            validateFaceMask: false,
+            validateHeadCover: false,
+            validateLenses: false,
+          },
+        },
+      ],
+    };
+
+    const pipelines = getRequiredWasmPipelines(flow);
+    expect(pipelines).toEqual(['selfie']);
+  });
+
+  it('should handle empty flow modules', () => {
+    const flow: Flow = {
+      flowId: 'test-flow',
+      name: 'Test Flow',
+      flowModules: [],
+    };
+
+    const pipelines = getRequiredWasmPipelines(flow);
+    expect(pipelines).toEqual([]);
+  });
+
+  it('should handle AUTHENTICATION module', () => {
+    const flow: Flow = {
+      flowId: 'test-flow',
+      name: 'Test Flow',
+      flowModules: [
+        {
+          key: 'AUTHENTICATION',
+          configuration: {
+            showTutorial: true,
+            autoCaptureTimeout: 5000,
+            numberOfAttempts: 3,
+            type: 'ONE_TO_ONE',
+            deepsightLiveness: 'SINGLE_FRAME',
+            validateClosedEyes: false,
+            validateFaceMask: false,
+            validateHeadCover: false,
+            validateLenses: false,
+          },
+        },
+      ],
+    };
+
+    const pipelines = getRequiredWasmPipelines(flow);
+    expect(pipelines).toEqual(['selfie']);
+  });
+
+  it('should handle TUTORIAL_ID module', () => {
+    const flow: Flow = {
+      flowId: 'test-flow',
+      name: 'Test Flow',
+      flowModules: [
+        {
+          key: 'TUTORIAL_ID',
+          configuration: {
+            showTutorial: true,
+            enableId: true,
+            enablePassport: false,
+            onlyFront: false,
+            onlyBack: false,
+            barcodeCapture: false,
+            fetchAdditionalPage: false,
+            secondId: false,
+            thirdId: false,
+            autoCaptureTimeout: 5000,
+            deviceIdleTimeout: 30000,
+            captureAttempts: 3,
+            manualUploadIdCapture: false,
+            digitalIdsUpload: false,
+            showDocumentChooserScreen: false,
+            enableIdRecording: false,
+            usSmartCapture: false,
+            perCountryPerDocOverrides: {},
+          },
+        },
+      ],
+    };
+
+    const pipelines = getRequiredWasmPipelines(flow);
+    expect(pipelines).toEqual(['idCapture']);
+  });
+});

package/src/flow/flowAnalyzer.ts

@@ -0,0 +1,37 @@
+import type { WasmPipeline } from '@incodetech/infra';
+import type { Flow } from './types';
+
+const WASM_MODULE_PIPELINES: Record<string, WasmPipeline> = {
+  SELFIE: 'selfie',
+  AUTHENTICATION: 'selfie',
+  FACE_MATCH: 'selfie',
+  VIDEO_ONBOARDING: 'selfie',
+  ID: 'idCapture',
+  TUTORIAL_ID: 'idCapture',
+  SECOND_ID: 'idCapture',
+  THIRD_ID: 'idCapture',
+};
+
+/**
+ * Analyzes a flow configuration and returns the WASM pipelines needed.
+ * Use this to conditionally warmup WASM only when required by the flow.
+ *
+ * @param flow - The flow configuration from /omni/onboarding/flow
+ * @returns Array of WASM pipelines needed (e.g., ['selfie', 'idCapture'])
+ *
+ * @example
+ * ```typescript
+ * const pipelines = getRequiredWasmPipelines(flow);
+ * if (pipelines.length > 0) {
+ *   warmupWasm({ ...wasmConfig, pipelines });
+ * }
+ * ```
+ */
+export function getRequiredWasmPipelines(flow: Flow): WasmPipeline[] {
+  const pipelines = new Set<WasmPipeline>();
+  for (const module of flow.flowModules) {
+    const pipeline = WASM_MODULE_PIPELINES[module.key];
+    if (pipeline) pipelines.add(pipeline);
+  }
+  return [...pipelines];
+}

package/src/flow/flowCompletionService.ts

@@ -0,0 +1,21 @@
+import { api } from '../http/api';
+
+export type FinishStatus = {
+  redirectionUrl: string;
+  action: 'approved' | 'rejected' | 'none';
+  scoreStatus: 'OK' | 'WARN' | 'MANUAL_OK' | 'FAIL' | 'UNKNOWN' | 'MANUAL_FAIL';
+};
+
+export type GetFinishStatusFn = (
+  flowId: string | undefined | null,
+  signal?: AbortSignal,
+) => Promise<FinishStatus>;
+
+export const getFinishStatus: GetFinishStatusFn = async (flowId, signal) => {
+  const url = `/omni/finish-status${flowId ? `?flowId=${flowId}` : ''}`;
+  const res = await api.get<FinishStatus>(url, { signal });
+  if (!res.ok) {
+    throw new Error(`GET ${url} failed: ${res.status} ${res.statusText}`);
+  }
+  return res.data;
+};