@zeniai/client-epic-state 5.0.92-betaNB2 → 5.0.93-beta0ND

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

@@ -0,0 +1,142 @@
+/**
+ * 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';
+/**
+ * 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;

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

@@ -0,0 +1,32 @@
+"use strict";
+/**
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+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;

package/lib/view/taskManager/taskListView/taskListReducer.d.ts

@@ -14,7 +14,7 @@ export declare const fetchTaskListPage: import("@reduxjs/toolkit").ActionCreator
     archived?: TaskPayload[];
     deleted?: TaskPayload[];
     snoozed?: TaskPayload[];
-}, "taskList/updateTaskList">, updateTaskListTab: import("@reduxjs/toolkit").ActionCreatorWithPayload<"deleted" | "live" | "archived" | "snoozed", "taskList/updateTaskListTab">, updateTaskListFetchStatus: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+}, "taskList/updateTaskList">, updateTaskListTab: import("@reduxjs/toolkit").ActionCreatorWithPayload<"deleted" | "archived" | "live" | "snoozed", "taskList/updateTaskListTab">, updateTaskListFetchStatus: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
     fetchState: FetchState;
     error?: ZeniAPIStatus;
 }, "taskList/updateTaskListFetchStatus">, updateTaskListSearchText: import("@reduxjs/toolkit").ActionCreatorWithPayload<{

package/lib/view/transactionDetail/journalEntryLinesViewModel.d.ts

@@ -8,7 +8,7 @@ import { JournalEntryTransactionLine, Line, TransactionLineBase } from '../../en
  * is testable and reusable.
  */
 export declare const JOURNAL_ENTRY_SORT_KEYS: readonly ["description", "name", "category", "class", "debit", "credit"];
-export declare const toJournalEntrySortKey: (v: string) => "name" | "description" | "category" | "class" | "credit" | "debit";
+export declare const toJournalEntrySortKey: (v: string) => "category" | "class" | "description" | "name" | "credit" | "debit";
 export type JournalEntrySortKey = ReturnType<typeof toJournalEntrySortKey>;
 export interface JournalEntryRowSortConfig {
     sortKey: JournalEntrySortKey;

package/lib/view/vendorFiling1099/vendorFiling1099List/vendorFiling1099ListState.d.ts

@@ -20,7 +20,7 @@ export interface VendorFiling1099ListQuery {
     sortKey: VendorFiling1099ListViewSortKey;
     sortOrder: SortOrder;
 }
-declare const toVendorFiling1099ListViewSortKey: (v: string) => "status" | "w9" | "total" | "legal_name" | "tax_classification" | "filing1099type";
+declare const toVendorFiling1099ListViewSortKey: (v: string) => "status" | "w9" | "legal_name" | "total" | "tax_classification" | "filing1099type";
 export type VendorFiling1099ListViewSortKey = ReturnType<typeof toVendorFiling1099ListViewSortKey>;
 export type Type1099Download = 'nec' | 'misc' | 'int';
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zeniai/client-epic-state",
-  "version": "5.0.92-betaNB2",
+  "version": "5.0.93-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",

package/lib/esm/view/expenseAutomationView/epics/accountRecon/parseStatementEpic.js

@@ -1,34 +0,0 @@
-import { from, of } from 'rxjs';
-import { catchError, filter, mergeMap } from 'rxjs/operators';
-import { createZeniAPIStatus, isSuccessResponse, } from '../../../../responsePayload';
-import { transformParseStatementPayloadToState, } from '../../payload/reconciliationPayload';
-import { parseStatement, parseStatementFailure, parseStatementSuccess, updateParsedStatementData, } from '../../reducers/reconciliationViewReducer';
-export const parseStatementEpic = (actions$, _state$, zeniAPI) => actions$.pipe(filter(parseStatement.match), mergeMap((action) => {
-    const { accountId, selectedPeriod, statementUploadId } = action.payload;
-    const parseStatementApi$ = zeniAPI.getJSON(`${zeniAPI.apiEndPoints.reconciliationMicroServiceBaseUrl}/2.0/statement-uploads/${statementUploadId}`);
-    return parseStatementApi$.pipe(mergeMap((response) => {
-        if (isSuccessResponse(response) === true && response.data != null) {
-            const actions = [];
-            const transformedData = transformParseStatementPayloadToState(response.data);
-            actions.push(updateParsedStatementData({
-                accountId,
-                selectedPeriod,
-                parsedStatementData: transformedData,
-            }));
-            actions.push(parseStatementSuccess({ accountId, selectedPeriod }));
-            return from(actions);
-        }
-        else {
-            return of(parseStatementFailure({
-                accountId,
-                selectedPeriod,
-                error: response.status,
-            }));
-        }
-    }), catchError((error) => of(parseStatementFailure({
-        accountId,
-        selectedPeriod,
-        error: createZeniAPIStatus('Unexpected Error', 'Parse Statement REST API call errored out ' +
-            JSON.stringify(error)),
-    }))));
-}));

package/lib/esm/view/expenseAutomationView/epics/accountRecon/updateStatementInfoEpic.js

@@ -1,42 +0,0 @@
-import { of } from 'rxjs';
-import { catchError, filter, mergeMap } from 'rxjs/operators';
-import { toMonthYearPeriodId } from '../../../../commonStateTypes/timePeriod';
-import { createZeniAPIStatus, isSuccessResponse, } from '../../../../responsePayload';
-import { transformStatementUpdateStateToPayload, } from '../../payload/reconciliationPayload';
-import { submitStatementUpdate, submitStatementUpdateFailure, submitStatementUpdateSuccess, } from '../../reducers/reconciliationViewReducer';
-export const updateStatementInfoEpic = (actions$, state$, zeniAPI) => actions$.pipe(filter(submitStatementUpdate.match), mergeMap((action) => {
-    const { accountId, selectedPeriod, statementUploadId } = action.payload;
-    const state = state$.value;
-    const reconciliationView = state.expenseAutomationReconciliationViewState;
-    const accountRecon = reconciliationView.accountReconciliationRecordsBySelectedPeriod[toMonthYearPeriodId(selectedPeriod)]?.reconciliationByAccountID[accountId];
-    const localData = accountRecon?.localData?.statementUpdateLocalData;
-    if (!localData) {
-        return of(submitStatementUpdateFailure({
-            accountId,
-            selectedPeriod,
-            error: createZeniAPIStatus('Missing Data', 'No statement update data found'),
-        }));
-    }
-    const payload = transformStatementUpdateStateToPayload(localData);
-    const updateStatementApi$ = zeniAPI.putAndGetJSON(`${zeniAPI.apiEndPoints.reconciliationMicroServiceBaseUrl}/2.0/statement-uploads/${statementUploadId}`, payload);
-    return updateStatementApi$.pipe(mergeMap((response) => {
-        if (isSuccessResponse(response) === true && response.data != null) {
-            return of(submitStatementUpdateSuccess({
-                accountId,
-                selectedPeriod,
-            }));
-        }
-        else {
-            return of(submitStatementUpdateFailure({
-                accountId,
-                selectedPeriod,
-                error: response.status,
-            }));
-        }
-    }), catchError((error) => of(submitStatementUpdateFailure({
-        accountId,
-        selectedPeriod,
-        error: createZeniAPIStatus('Unexpected Error', 'Update Statement REST API call errored out ' +
-            JSON.stringify(error)),
-    }))));
-}));

package/lib/view/expenseAutomationView/epics/accountRecon/parseStatementEpic.d.ts

@@ -1,6 +0,0 @@
-import { ActionsObservable, StateObservable } from 'redux-observable';
-import { RootState } from '../../../../reducer';
-import { ZeniAPI } from '../../../../zeniAPI';
-import { parseStatement, parseStatementFailure, parseStatementSuccess, updateParsedStatementData } from '../../reducers/reconciliationViewReducer';
-export type ActionType = ReturnType<typeof parseStatement> | ReturnType<typeof parseStatementSuccess> | ReturnType<typeof parseStatementFailure> | ReturnType<typeof updateParsedStatementData>;
-export declare const parseStatementEpic: (actions$: ActionsObservable<ActionType>, _state$: StateObservable<RootState>, zeniAPI: ZeniAPI) => import("rxjs").Observable<ActionType>;

package/lib/view/expenseAutomationView/epics/accountRecon/parseStatementEpic.js

@@ -1,38 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseStatementEpic = void 0;
-const rxjs_1 = require("rxjs");
-const operators_1 = require("rxjs/operators");
-const responsePayload_1 = require("../../../../responsePayload");
-const reconciliationPayload_1 = require("../../payload/reconciliationPayload");
-const reconciliationViewReducer_1 = require("../../reducers/reconciliationViewReducer");
-const parseStatementEpic = (actions$, _state$, zeniAPI) => actions$.pipe((0, operators_1.filter)(reconciliationViewReducer_1.parseStatement.match), (0, operators_1.mergeMap)((action) => {
-    const { accountId, selectedPeriod, statementUploadId } = action.payload;
-    const parseStatementApi$ = zeniAPI.getJSON(`${zeniAPI.apiEndPoints.reconciliationMicroServiceBaseUrl}/2.0/statement-uploads/${statementUploadId}`);
-    return parseStatementApi$.pipe((0, operators_1.mergeMap)((response) => {
-        if ((0, responsePayload_1.isSuccessResponse)(response) === true && response.data != null) {
-            const actions = [];
-            const transformedData = (0, reconciliationPayload_1.transformParseStatementPayloadToState)(response.data);
-            actions.push((0, reconciliationViewReducer_1.updateParsedStatementData)({
-                accountId,
-                selectedPeriod,
-                parsedStatementData: transformedData,
-            }));
-            actions.push((0, reconciliationViewReducer_1.parseStatementSuccess)({ accountId, selectedPeriod }));
-            return (0, rxjs_1.from)(actions);
-        }
-        else {
-            return (0, rxjs_1.of)((0, reconciliationViewReducer_1.parseStatementFailure)({
-                accountId,
-                selectedPeriod,
-                error: response.status,
-            }));
-        }
-    }), (0, operators_1.catchError)((error) => (0, rxjs_1.of)((0, reconciliationViewReducer_1.parseStatementFailure)({
-        accountId,
-        selectedPeriod,
-        error: (0, responsePayload_1.createZeniAPIStatus)('Unexpected Error', 'Parse Statement REST API call errored out ' +
-            JSON.stringify(error)),
-    }))));
-}));
-exports.parseStatementEpic = parseStatementEpic;

package/lib/view/expenseAutomationView/epics/accountRecon/updateStatementInfoEpic.d.ts

@@ -1,19 +0,0 @@
-import { ActionsObservable, StateObservable } from 'redux-observable';
-import { RootState } from '../../../../reducer';
-import { ZeniAPI } from '../../../../zeniAPI';
-import { submitStatementUpdate, submitStatementUpdateFailure, submitStatementUpdateSuccess } from '../../reducers/reconciliationViewReducer';
-export type ActionType = ReturnType<typeof submitStatementUpdate> | ReturnType<typeof submitStatementUpdateSuccess> | ReturnType<typeof submitStatementUpdateFailure>;
-export declare const updateStatementInfoEpic: (actions$: ActionsObservable<ActionType>, state$: StateObservable<RootState>, zeniAPI: ZeniAPI) => import("rxjs").Observable<{
-    payload: {
-        accountId: import("../../../..").ID;
-        selectedPeriod: import("../../../../commonStateTypes/timePeriod").MonthYearPeriod;
-    };
-    type: "expenseAutomationReconciliationView/submitStatementUpdateSuccess";
-} | {
-    payload: {
-        accountId: import("../../../..").ID;
-        error: import("../../../../responsePayload").ZeniAPIStatus;
-        selectedPeriod: import("../../../../commonStateTypes/timePeriod").MonthYearPeriod;
-    };
-    type: "expenseAutomationReconciliationView/submitStatementUpdateFailure";
-}>;

package/lib/view/expenseAutomationView/epics/accountRecon/updateStatementInfoEpic.js

@@ -1,46 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.updateStatementInfoEpic = void 0;
-const rxjs_1 = require("rxjs");
-const operators_1 = require("rxjs/operators");
-const timePeriod_1 = require("../../../../commonStateTypes/timePeriod");
-const responsePayload_1 = require("../../../../responsePayload");
-const reconciliationPayload_1 = require("../../payload/reconciliationPayload");
-const reconciliationViewReducer_1 = require("../../reducers/reconciliationViewReducer");
-const updateStatementInfoEpic = (actions$, state$, zeniAPI) => actions$.pipe((0, operators_1.filter)(reconciliationViewReducer_1.submitStatementUpdate.match), (0, operators_1.mergeMap)((action) => {
-    const { accountId, selectedPeriod, statementUploadId } = action.payload;
-    const state = state$.value;
-    const reconciliationView = state.expenseAutomationReconciliationViewState;
-    const accountRecon = reconciliationView.accountReconciliationRecordsBySelectedPeriod[(0, timePeriod_1.toMonthYearPeriodId)(selectedPeriod)]?.reconciliationByAccountID[accountId];
-    const localData = accountRecon?.localData?.statementUpdateLocalData;
-    if (!localData) {
-        return (0, rxjs_1.of)((0, reconciliationViewReducer_1.submitStatementUpdateFailure)({
-            accountId,
-            selectedPeriod,
-            error: (0, responsePayload_1.createZeniAPIStatus)('Missing Data', 'No statement update data found'),
-        }));
-    }
-    const payload = (0, reconciliationPayload_1.transformStatementUpdateStateToPayload)(localData);
-    const updateStatementApi$ = zeniAPI.putAndGetJSON(`${zeniAPI.apiEndPoints.reconciliationMicroServiceBaseUrl}/2.0/statement-uploads/${statementUploadId}`, payload);
-    return updateStatementApi$.pipe((0, operators_1.mergeMap)((response) => {
-        if ((0, responsePayload_1.isSuccessResponse)(response) === true && response.data != null) {
-            return (0, rxjs_1.of)((0, reconciliationViewReducer_1.submitStatementUpdateSuccess)({
-                accountId,
-                selectedPeriod,
-            }));
-        }
-        else {
-            return (0, rxjs_1.of)((0, reconciliationViewReducer_1.submitStatementUpdateFailure)({
-                accountId,
-                selectedPeriod,
-                error: response.status,
-            }));
-        }
-    }), (0, operators_1.catchError)((error) => (0, rxjs_1.of)((0, reconciliationViewReducer_1.submitStatementUpdateFailure)({
-        accountId,
-        selectedPeriod,
-        error: (0, responsePayload_1.createZeniAPIStatus)('Unexpected Error', 'Update Statement REST API call errored out ' +
-            JSON.stringify(error)),
-    }))));
-}));
-exports.updateStatementInfoEpic = updateStatementInfoEpic;