@zeniai/client-epic-state 5.2.41 → 5.2.42

package/lib/view/expenseAutomationView/types/actualMatchingViewState.d.ts

@@ -0,0 +1,106 @@
+import { FetchStateAndError, FetchedState, ID } from '../../../commonStateTypes/common';
+import { SortOrder } from '../../../commonStateTypes/selectorTypes/sortOrderTypes';
+import { MonthYearPeriodId } from '../../../commonStateTypes/timePeriod';
+import { ActualMatchingMatchId } from '../../../entity/actualMatching/actualMatchingTypes';
+import { JEOneTimeAccrualKey } from '../../../entity/jeSchedules/jeSchedulesTypes';
+export declare const toActualMatchingSortKey: (v: string) => "type" | "date" | "vendor" | "category" | "class" | "amount" | "variance" | "lifecycle" | "service" | "accrued" | "actual";
+export type ActualMatchingSortKey = ReturnType<typeof toActualMatchingSortKey>;
+export declare const MATCH_TRANSACTION_SEARCH_PAGE_SIZE = 50;
+export declare const MATCH_ACCRUAL_SEARCH_LIMIT = 50;
+export declare const MATCH_SEARCH_DEBOUNCE_MS = 300;
+export declare const toMatchAndReverseResultStatus: (v: string) => "error" | "reversed" | "noop" | "conflict" | "claim_lost";
+export type MatchAndReverseResultStatus = ReturnType<typeof toMatchAndReverseResultStatus>;
+export interface ActualMatchingViewUIState {
+    scrollPosition: {
+        scrollTop: number;
+        scrollLeft?: number;
+    } | undefined;
+    searchString: string;
+    sortKey: ActualMatchingSortKey;
+    sortOrder: SortOrder;
+}
+/**
+ * Sibling of Missing Receipts `MatchCandidate`. Confirm needs `lineId` and
+ * `transactionIntegrationId` on every row — those fields are required here.
+ */
+export interface ActualMatchingTransactionSearchResult {
+    amount: number;
+    currencyCode: string;
+    currencySymbol: string;
+    lineId: string;
+    syncToken: string;
+    transactionDate: string;
+    transactionId: ID;
+    transactionIntegrationId: string;
+    transactionType: string;
+    vendorName: string;
+    accountDescription?: string;
+    accountId?: ID;
+    accountingClassId?: ID;
+    accountingClassName?: string;
+    accountName?: string;
+    transactionDescription?: string;
+    transactionMemo?: string;
+    transactionTypeName?: string;
+    vendorId?: ID;
+}
+export interface MatchAndReverseResult {
+    accrualId: ID;
+    status: MatchAndReverseResultStatus;
+    reason?: string;
+}
+export declare function isMatchAndReverseCompleteStatus(status: MatchAndReverseResultStatus): boolean;
+export interface MatchAndReverseAccrualsParams {
+    accrualIds: ID[];
+    lineIds: ID[];
+    transactionId: ID;
+    transactionIntegrationId: string;
+    transactionSyncToken: string;
+    transactionType: string;
+}
+export declare const toUndoReversalResultStatus: (v: string) => "error" | "claim_lost" | "undone";
+export type UndoReversalResultStatus = ReturnType<typeof toUndoReversalResultStatus>;
+export interface UndoReversalResult {
+    accrualId: ID;
+    status: UndoReversalResultStatus;
+    reason?: string;
+}
+export interface UndoReversalAccrualsParams {
+    accrualIds: ID[];
+    matchId: ActualMatchingMatchId;
+}
+export interface ActualMatchingTransactionSearchState extends FetchStateAndError {
+    isLoadingMore: boolean;
+    nextPageToken: string | null;
+    query: string;
+    results: ActualMatchingTransactionSearchResult[];
+}
+export interface ActualMatchingAccrualSearchState extends FetchStateAndError {
+    isLoadingMore: boolean;
+    nextPageToken: string | null;
+    query: string;
+    results: JEOneTimeAccrualKey[];
+}
+export interface ActualMatchingMatchModalState {
+    accrualSearch: ActualMatchingAccrualSearchState;
+    confirmStatus: FetchStateAndError;
+    didPinPrefillTransactions: boolean;
+    isOpen: boolean;
+    pinnedTransactionResults: ActualMatchingTransactionSearchResult[];
+    transactionSearch: ActualMatchingTransactionSearchState;
+    lastBatchResults?: MatchAndReverseResult[];
+    openedFromMatchId?: ActualMatchingMatchId;
+}
+export declare function actualMatchingTransactionLineKey(transactionType: string, transactionIntegrationId: string, lineId: string): string;
+export interface ActualMatchingViewState extends FetchedState {
+    closeMatchAfterUndo: boolean;
+    detailFetchStateByMatchId: Record<ActualMatchingMatchId, FetchStateAndError>;
+    detailRefreshStatusByMatchId: Record<ActualMatchingMatchId, FetchStateAndError>;
+    lastMatchResultsByMatchId: Record<ActualMatchingMatchId, MatchAndReverseResult[]>;
+    lastUndoResultsByMatchId: Record<ActualMatchingMatchId, UndoReversalResult[]>;
+    matchIdsByPeriod: Record<MonthYearPeriodId, ActualMatchingMatchId[]>;
+    matchModal: ActualMatchingMatchModalState;
+    refreshStatus: FetchStateAndError;
+    uiState: ActualMatchingViewUIState;
+    undoReversalStatusByMatchId: Record<ActualMatchingMatchId, FetchStateAndError>;
+}

package/lib/view/expenseAutomationView/types/actualMatchingViewState.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toUndoReversalResultStatus = exports.toMatchAndReverseResultStatus = exports.MATCH_SEARCH_DEBOUNCE_MS = exports.MATCH_ACCRUAL_SEARCH_LIMIT = exports.MATCH_TRANSACTION_SEARCH_PAGE_SIZE = exports.toActualMatchingSortKey = void 0;
+exports.isMatchAndReverseCompleteStatus = isMatchAndReverseCompleteStatus;
+exports.actualMatchingTransactionLineKey = actualMatchingTransactionLineKey;
+const stringToUnion_1 = require("../../../commonStateTypes/stringToUnion");
+const ACTUAL_MATCHING_SORT_KEYS = [
+    'vendor',
+    'date',
+    'amount',
+    'category',
+    'class',
+    'type',
+    'lifecycle',
+    'service',
+    'accrued',
+    'actual',
+    'variance',
+];
+const toActualMatchingSortKey = (v) => (0, stringToUnion_1.stringToUnion)(v, ACTUAL_MATCHING_SORT_KEYS);
+exports.toActualMatchingSortKey = toActualMatchingSortKey;
+exports.MATCH_TRANSACTION_SEARCH_PAGE_SIZE = 50;
+exports.MATCH_ACCRUAL_SEARCH_LIMIT = 50;
+exports.MATCH_SEARCH_DEBOUNCE_MS = 300;
+const MATCH_AND_REVERSE_RESULT_STATUSES = [
+    'reversed',
+    'noop',
+    'conflict',
+    'claim_lost',
+    'error',
+];
+const toMatchAndReverseResultStatus = (v) => (0, stringToUnion_1.stringToUnion)(v, MATCH_AND_REVERSE_RESULT_STATUSES);
+exports.toMatchAndReverseResultStatus = toMatchAndReverseResultStatus;
+function isMatchAndReverseCompleteStatus(status) {
+    return status === 'reversed' || status === 'noop';
+}
+const UNDO_REVERSAL_RESULT_STATUSES = [
+    'undone',
+    'claim_lost',
+    'error',
+];
+const toUndoReversalResultStatus = (v) => (0, stringToUnion_1.stringToUnion)(v, UNDO_REVERSAL_RESULT_STATUSES);
+exports.toUndoReversalResultStatus = toUndoReversalResultStatus;
+function actualMatchingTransactionLineKey(transactionType, transactionIntegrationId, lineId) {
+    return `${transactionType}:${transactionIntegrationId}:${lineId}`;
+}

package/lib/view/expenseAutomationView/types/jeSchedulesViewState.d.ts

@@ -12,7 +12,7 @@ import { ZeniDate } from '../../../zeniDayJS';
 import { JETransactionLink } from '../../scheduleView/scheduleDetailView/scheduleDetailState';
 export declare const toJEScheduleSortKey: (v: string) => "type" | "vendor" | "category" | "class" | "memo" | "jePostingDate" | "runningBalance" | "depCategory" | "scheduleCategory" | "startMonth" | "amortizationPeriod" | "remainingMonths" | "totalAmount" | "transactionDate";
 export type JEScheduleSortKey = ReturnType<typeof toJEScheduleSortKey>;
-export declare const toJEPageTab: (v: string) => "schedules" | "existing_schedules";
+export declare const toJEPageTab: (v: string) => "schedules" | "actual_matching" | "existing_schedules";
 export type JEPageTab = ReturnType<typeof toJEPageTab>;
 export declare const ALL_JE_PAGE_TABS: readonly JEPageTab[];
 export type JESchedulePeriodTabKey = `${JEPageTab}_${MonthYearPeriodId}`;

package/lib/view/expenseAutomationView/types/jeSchedulesViewState.js

@@ -20,7 +20,14 @@ const JE_SCHEDULE_SORT_KEYS = [
 ];
 const toJEScheduleSortKey = (v) => (0, stringToUnion_1.stringToUnion)(v, JE_SCHEDULE_SORT_KEYS);
 exports.toJEScheduleSortKey = toJEScheduleSortKey;
-const JE_PAGE_TABS = ['schedules', 'existing_schedules'];
+// `actual_matching` is chrome only: the JE tab bar includes it, but AM data is
+// `expenseAutomationActualMatchingViewState`, not the schedules period-tab
+// cache below. Walks of ALL_JE_PAGE_TABS that read schedule keys must skip it.
+const JE_PAGE_TABS = [
+    'schedules',
+    'actual_matching',
+    'existing_schedules',
+];
 const toJEPageTab = (v) => (0, stringToUnion_1.stringToUnion)(v, JE_PAGE_TABS);
 exports.toJEPageTab = toJEPageTab;
 exports.ALL_JE_PAGE_TABS = JE_PAGE_TABS;

package/package.json

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