@zeniai/client-epic-state 5.1.0 → 5.1.1-beta0ND

package/lib/view/spendManagement/commonSetup/setupViewSelector.js

@@ -92,15 +92,17 @@ function getBusinessVerificationDetails(state, companyId) {
     const { setupViewState, countryListState } = state;
     const { companyDetails, companyOfficerUpdateStatus, primaryContactDetails, updateStatus, } = setupViewState;
     const companyView = (0, getCompanyView_1.getCompanyView)(state, companyId, []);
-    const { companyDetailsLocalData, companyOfficerLocalData } = (0, exports.getCompanyAndIdentityDetails)(state, companyId, {
+    const { companyDetailsLocalData, companyOfficerLocalData, parsingDocumentFileIds, } = (0, exports.getCompanyAndIdentityDetails)(state, companyId, {
         companyDetails,
         companyOfficerUpdateStatus,
         primaryContactDetails,
+        parsingDocumentFileIds: setupViewState.parsingDocumentFileIds,
     });
     const allNationalityCountries = countryListState.byCountryListCode.nationalityCountryList.countries;
     return {
         companyDetailsLocalData,
         companyOfficerLocalData,
+        parsingDocumentFileIds,
         companyView,
         updateStatus,
         allNationalityCountries,
@@ -124,6 +126,7 @@ const getCompanyAndIdentityDetails = (state, companyId, companyAndIdentityDetail
         const companyAddress = addressViewState.newAddressState?.company_address;
         const registeredCompanyAddress = addressViewState.newAddressState?.company_registered_address;
         companyDetailsLocalData = {
+            autoFilledFields: companyDetails.autoFilledFields,
             companyId,
             companyDescription,
             companyLegalName,
@@ -196,6 +199,7 @@ const getCompanyAndIdentityDetails = (state, companyId, companyAndIdentityDetail
             const companyOfficerAddress = addressViewState.newAddressState?.[addressType];
             companyOfficerLocalData[officerType] = {
                 ...companyOfficer.localData,
+                autoFilledFields: companyOfficer.autoFilledFields,
                 userFiles: (0, fileSelector_1.getFilesByFileIds)(fileState, fileIds),
                 additionalFiles: (0, fileSelector_1.getFilesByFileIds)(fileState, additionalSubmittedDocumentsForVerificationFileIds),
                 deleteFileStatusById,
@@ -209,6 +213,7 @@ const getCompanyAndIdentityDetails = (state, companyId, companyAndIdentityDetail
     return {
         companyDetailsLocalData,
         companyOfficerLocalData,
+        parsingDocumentFileIds: companyAndIdentityDetails.parsingDocumentFileIds,
     };
 };
 exports.getCompanyAndIdentityDetails = getCompanyAndIdentityDetails;

package/lib/view/spendManagement/commonSetup/setupViewState.d.ts

@@ -81,9 +81,21 @@ export interface SetupViewLocalData {
  */
 export interface CompanyAndIdentityDetails {
     companyDetails: {
+        /**
+         * Field names from {@link CompanyDetailsLocalData} that were populated by AI
+         * autofill from an uploaded KYB document. Drives the ✦ sparkle in the form.
+         * Always present (empty when no autofill has run yet).
+         */
+        autoFilledFields: string[];
         localData?: CompanyDetailsLocalData;
     };
     companyOfficerUpdateStatus: Record<CompanyOfficerType, {
+        /**
+         * Field names from {@link CompanyOfficerLocalData} populated by AI autofill
+         * from an uploaded KYC identity document. Drives the ✦ sparkle in the form.
+         * Always present (empty when no autofill has run yet).
+         */
+        autoFilledFields: string[];
         otpverificationStatus: FetchStateAndError;
         sendOtpStatus: FetchStateAndError;
         localData?: CompanyOfficerLocalData;
@@ -93,6 +105,13 @@ export interface CompanyAndIdentityDetails {
     };
 }
 export interface SetupViewState extends CompanyAndIdentityDetails {
+    /**
+     * File IDs currently being parsed by the AI autofill epic. Populated when
+     * `parseUploadedKyc/KybDocument` dispatches and cleared when the
+     * corresponding apply / failure action fires. Drives the "AI is reading
+     * your document" overlay on the document upload field.
+     */
+    parsingDocumentFileIds: ID[];
     updateStatus: FetchStateAndError;
 }
 export {};

package/lib/view/spendManagement/commonSetup/types/kycKybAutofill.d.ts

@@ -0,0 +1,154 @@
+/**
+ * Shared types for the KYC / KYB document autofill flow that lives inside the
+ * commonSetup feature (Setup pages + Onboarding both consume it via the same
+ * selector view; there is no separate state slice).
+ *
+ * Backed by document-communication-agent `POST /1.0/documents/process/sync`,
+ * which proxies document-service ExtendAI parsers and returns one of the
+ * parser payloads below — each value shaped as `{value, confidence}` per field.
+ */
+import { ID } from '../../../../commonStateTypes/common';
+import { AllowedDocumentType } from '../../../../entity/file/fileState';
+/**
+ * Form-side identity document types as picked in `SelectDocumentField`.
+ * These are camelCase per the web-components convention.
+ */
+export type KycSelectDocumentType = 'driverLicense' | 'passport' | 'ssnCard' | 'stateId';
+/**
+ * KYC document types accepted by the document-service parsers (snake_case).
+ * Subset of {@link KycKybProvidedDocumentType}. `stateId` from the form maps
+ * to no parser today and is skipped at dispatch time.
+ */
+export type KycProvidedDocumentType = 'passport' | 'driving_license' | 'social_security_card';
+/** KYB document types accepted by the document-service parsers. */
+export type KybProvidedDocumentType = 'certificate_of_incorporation' | 'tax_ein';
+/** All KYC / KYB document types accepted by document-communication-agent. */
+export type KycKybProvidedDocumentType = KycProvidedDocumentType | KybProvidedDocumentType;
+/** Field value with model confidence (0..1) as returned by ExtendAI parsers. */
+export interface FieldWithConfidence<T = string | null> {
+    confidence: number;
+    value: T | null;
+}
+/**
+ * Parser payloads — keep in sync with document-service
+ * `processors/parsers/extend_*_parser.py`.
+ */
+export interface ExtendPassportParsed {
+    date_of_birth?: FieldWithConfidence;
+    date_of_expiry?: FieldWithConfidence;
+    date_of_issue?: FieldWithConfidence;
+    first_name?: FieldWithConfidence;
+    gender?: FieldWithConfidence;
+    issuing_authority?: FieldWithConfidence;
+    last_name?: FieldWithConfidence;
+    mrz_line_1?: FieldWithConfidence;
+    mrz_line_2?: FieldWithConfidence;
+    nationality?: FieldWithConfidence;
+    passport_number?: FieldWithConfidence;
+    place_of_birth?: FieldWithConfidence;
+}
+export interface ExtendDrivingLicenseParsed {
+    address_city?: FieldWithConfidence;
+    address_state?: FieldWithConfidence;
+    address_street?: FieldWithConfidence;
+    address_zip?: FieldWithConfidence;
+    date_of_birth?: FieldWithConfidence;
+    date_of_expiry?: FieldWithConfidence;
+    date_of_issue?: FieldWithConfidence;
+    first_name?: FieldWithConfidence;
+    issuing_state?: FieldWithConfidence;
+    last_name?: FieldWithConfidence;
+    license_number?: FieldWithConfidence;
+    middle_name?: FieldWithConfidence;
+}
+export interface ExtendSsnCardParsed {
+    full_name?: FieldWithConfidence;
+}
+export interface ExtendCertificateOfIncorporationParsed {
+    company_address?: FieldWithConfidence;
+    company_legal_name?: FieldWithConfidence;
+    countries_of_operations?: FieldWithConfidence<string[]>;
+    date_of_incorporation?: FieldWithConfidence;
+    ein?: FieldWithConfidence;
+    industry?: FieldWithConfidence;
+    phone_number?: FieldWithConfidence;
+    product_description?: FieldWithConfidence;
+    purpose_of_account?: FieldWithConfidence;
+    registered_address?: FieldWithConfidence;
+    regulated_status?: FieldWithConfidence;
+    source_of_funds?: FieldWithConfidence;
+    state_of_incorporation?: FieldWithConfidence;
+    sub_industry?: FieldWithConfidence;
+    sub_us_nexus?: FieldWithConfidence;
+    transaction_volume_expectations?: FieldWithConfidence;
+    type_of_incorporation?: FieldWithConfidence;
+    us_nexus?: FieldWithConfidence;
+    website?: FieldWithConfidence;
+}
+export interface ExtendTaxEinParsed {
+    ein?: FieldWithConfidence;
+    irs_address?: FieldWithConfidence;
+    legal_business_name?: FieldWithConfidence;
+    trade_name?: FieldWithConfidence;
+}
+/** POST /1.0/documents/process/sync request body. */
+export interface SyncDocumentsProcessRequest {
+    files: Array<{
+        file_id: ID;
+    }>;
+    provided_document_type: KycKybProvidedDocumentType;
+    metadata?: {
+        source?: string;
+    } & Record<string, unknown>;
+    processing_priority?: number;
+}
+/** Parser payload union — `data.files[0].extracted_data` for any document type. */
+export type ExtendExtractedData = ExtendPassportParsed | ExtendDrivingLicenseParsed | ExtendSsnCardParsed | ExtendCertificateOfIncorporationParsed | ExtendTaxEinParsed;
+/** Per-file row inside the batch response. */
+export interface SyncDocumentsProcessFileResult {
+    extracted_data: ExtendExtractedData | null;
+    file_id: ID;
+    status: string;
+    filename?: string | null;
+    processing_metadata?: Record<string, unknown>;
+}
+/** POST /1.0/documents/process/sync response body. */
+export interface SyncDocumentsProcessResponse {
+    data: {
+        files: SyncDocumentsProcessFileResult[];
+        provided_document_type: KycKybProvidedDocumentType;
+        request_id: string;
+        status: string;
+        tenant_id: string;
+        metadata?: Record<string, unknown>;
+    } | null;
+    status: {
+        code: number;
+        message: string;
+    };
+}
+/**
+ * Discriminator for which Redux slice to apply the autofill to — setup pages
+ * (`spendManagement/commonSetup`) and onboarding (`onboardingView/customerView`)
+ * share the same field shapes but live in separate slices.
+ */
+export type KycKybAutofillTarget = 'setup' | 'onboarding';
+/** Confidence floor below which we drop an autofill candidate. */
+export declare const KYC_KYB_AUTOFILL_MIN_CONFIDENCE = 0.5;
+/**
+ * Maps the form-side {@link KycSelectDocumentType} (camelCase) to the
+ * parser-side {@link KycProvidedDocumentType} (snake_case). Returns `null` for
+ * `stateId`, which has no parser today.
+ */
+export declare const toKycProvidedDocumentType: (selectType: KycSelectDocumentType) => KycProvidedDocumentType | null;
+/**
+ * Maps a persisted {@link AllowedDocumentType} (snake_case — the value stored on
+ * an officer's `documentTypeSelectedForVerification`) to the parser-side
+ * {@link KycProvidedDocumentType}. Returns `null` for document types with no KYC
+ * parser today (e.g. `id_document` / state ID, and any non-identity doc).
+ *
+ * The officer's stored selection is an `AllowedDocumentType`, not a
+ * {@link KycSelectDocumentType}; use this — not {@link toKycProvidedDocumentType}
+ * — when triggering autofill off that field.
+ */
+export declare const toKycProvidedDocumentTypeFromAllowed: (allowedType: AllowedDocumentType) => KycProvidedDocumentType | null;

package/lib/view/spendManagement/commonSetup/types/kycKybAutofill.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toKycProvidedDocumentTypeFromAllowed = exports.toKycProvidedDocumentType = exports.KYC_KYB_AUTOFILL_MIN_CONFIDENCE = void 0;
+/** Confidence floor below which we drop an autofill candidate. */
+exports.KYC_KYB_AUTOFILL_MIN_CONFIDENCE = 0.5;
+/**
+ * Maps the form-side {@link KycSelectDocumentType} (camelCase) to the
+ * parser-side {@link KycProvidedDocumentType} (snake_case). Returns `null` for
+ * `stateId`, which has no parser today.
+ */
+const toKycProvidedDocumentType = (selectType) => {
+    switch (selectType) {
+        case 'driverLicense':
+            return 'driving_license';
+        case 'passport':
+            return 'passport';
+        case 'ssnCard':
+            return 'social_security_card';
+        case 'stateId':
+            return null;
+    }
+};
+exports.toKycProvidedDocumentType = toKycProvidedDocumentType;
+/**
+ * Maps a persisted {@link AllowedDocumentType} (snake_case — the value stored on
+ * an officer's `documentTypeSelectedForVerification`) to the parser-side
+ * {@link KycProvidedDocumentType}. Returns `null` for document types with no KYC
+ * parser today (e.g. `id_document` / state ID, and any non-identity doc).
+ *
+ * The officer's stored selection is an `AllowedDocumentType`, not a
+ * {@link KycSelectDocumentType}; use this — not {@link toKycProvidedDocumentType}
+ * — when triggering autofill off that field.
+ */
+const toKycProvidedDocumentTypeFromAllowed = (allowedType) => {
+    switch (allowedType) {
+        case 'passport':
+            return 'passport';
+        case 'driving_license':
+            return 'driving_license';
+        case 'social_security_card':
+            return 'social_security_card';
+        default:
+            return null;
+    }
+};
+exports.toKycProvidedDocumentTypeFromAllowed = toKycProvidedDocumentTypeFromAllowed;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zeniai/client-epic-state",
-  "version": "5.1.0",
+  "version": "5.1.1-beta0ND",
   "description": "Shared module between Web & Mobile containing required abstractions for state management, async network communication. ",
   "main": "lib/index.js",
   "module": "lib/esm/index.js",