@zeniai/client-epic-state 5.2.90 → 5.2.92

package/lib/esm/view/transactionDetail/transactionDetailReducer.js

@@ -2,6 +2,7 @@ import { createSlice } from '@reduxjs/toolkit';
 import recordGet from 'lodash/get';
 import { toEntityType, } from '../../entity/genericEntity/entity';
 import { clearAll } from '../../rootActions';
+import { applyRecommendationsToCreateTransactionLine, clearRecommendationsFromCreateTransactionLine, getInitialCreateTransactionLocalDataByType, getSeededCreateTransactionLocalData, mergeCreateTransactionLocalData, nextCreateTransactionLineId, updateCreateTransactionLine, } from './createTransaction/createTransactionLocalDataHelper';
 import { removeEntityRecommendationForLineIdInLocalData, setEntityRecommendationForLineIdInLocalData, toSetAllLineItemsLocalDataIsUpdateAllChecked, toSetAllLineItemsToCategoryClass, toSetAllLineItemsToVendor, toUpdateLineItemsOriginalCategoryClass, toUpdateLineItemsToOriginalVendor, } from './transactionDetailLocalDataHelper';
 import { getTransactionDetailKey, initialSupportedTransactionDetail, } from './transactionDetailState';
 export const initialState = {
@@ -10,6 +11,10 @@ export const initialState = {
         fetchState: 'Not-Started',
         attachmentDataByID: {},
     },
+    createTransactionsState: {
+        createStatus: { fetchState: 'Not-Started' },
+        newTransactionState: getInitialCreateTransactionLocalDataByType(),
+    },
 };
 const transactionDetail = createSlice({
     name: 'transactionDetail',
@@ -829,6 +834,196 @@ const transactionDetail = createSlice({
                 };
             },
         },
+        // ---------------------------------------------------------------------------------
+        // Create Transaction
+        //
+        // These live on the transactionDetail slice rather than in createTransaction/ because a
+        // createSlice owns exactly one state object, and createTransactionsState is nested inside
+        // TransactionDetailState. The derivation itself stays in the folder -- each body below
+        // delegates to createTransactionLocalDataHelper.ts.
+        //
+        // They need no clearAll case of their own: the slice already resets to initialState on
+        // tenant switch, and createTransactionsState is part of it.
+        // ---------------------------------------------------------------------------------
+        /** Trigger only -- initializeCreateTransactionLocalDataEpic does the seeding. */
+        initializeCreateTransactionLocalData: {
+            reducer(
+            // eslint-disable-next-line @typescript-eslint/no-unused-vars
+            _draft, 
+            // eslint-disable-next-line @typescript-eslint/no-unused-vars
+            _action) {
+                // no-op
+            },
+            prepare(transactionType) {
+                return { payload: { transactionType } };
+            },
+        },
+        updateCreateTransactionLocalData: {
+            reducer(draft, action) {
+                const { transactionType, localData } = action.payload;
+                const current = draft.createTransactionsState.newTransactionState[transactionType];
+                draft.createTransactionsState.newTransactionState[transactionType] =
+                    mergeCreateTransactionLocalData(current, localData);
+            },
+            prepare(transactionType, localData) {
+                return { payload: { transactionType, localData } };
+            },
+        },
+        updateCreateTransactionLineLocalData: {
+            reducer(draft, action) {
+                const { transactionType, lineId, lineUpdates } = action.payload;
+                const current = draft.createTransactionsState.newTransactionState[transactionType];
+                current.lines = updateCreateTransactionLine(current.lines, lineId, lineUpdates);
+            },
+            prepare(transactionType, lineId, lineUpdates) {
+                return { payload: { transactionType, lineId, lineUpdates } };
+            },
+        },
+        /**
+         * `line` is supplied by the caller rather than built here, so a row added after a vendor is
+         * already chosen can arrive pre-populated from the cached recommendations instead of blank.
+         */
+        addCreateTransactionLine: {
+            reducer(draft, action) {
+                const { transactionType, line } = action.payload;
+                draft.createTransactionsState.newTransactionState[transactionType].lines.push({
+                    ...line,
+                    id: nextCreateTransactionLineId(),
+                });
+            },
+            prepare(transactionType, line) {
+                return { payload: { transactionType, line } };
+            },
+        },
+        removeCreateTransactionLine: {
+            reducer(draft, action) {
+                const { transactionType, lineId } = action.payload;
+                const current = draft.createTransactionsState.newTransactionState[transactionType];
+                current.lines = current.lines.filter((line) => line.id !== lineId);
+            },
+            prepare(transactionType, lineId) {
+                return { payload: { transactionType, lineId } };
+            },
+        },
+        /**
+         * Restores the blank working copy AND re-seeds it, so reopening Create starts from a fresh
+         * form rather than the previous transaction's values.
+         */
+        resetCreateTransactionLocalData: {
+            reducer(draft, action) {
+                const { transactionType } = action.payload;
+                draft.createTransactionsState.newTransactionState[transactionType] =
+                    getSeededCreateTransactionLocalData(transactionType);
+                draft.createTransactionsState.createStatus = {
+                    fetchState: 'Not-Started',
+                };
+                draft.createTransactionsState.createdTransactionId = undefined;
+            },
+            prepare(transactionType) {
+                return { payload: { transactionType } };
+            },
+        },
+        /** Submit trigger -- createTransactionEpic builds the payload from localData. */
+        createTransaction: {
+            reducer(draft, 
+            // eslint-disable-next-line @typescript-eslint/no-unused-vars
+            _action) {
+                draft.createTransactionsState.createStatus = {
+                    fetchState: 'In-Progress',
+                };
+                draft.createTransactionsState.createdTransactionId = undefined;
+            },
+            prepare(transactionType) {
+                return { payload: { transactionType } };
+            },
+        },
+        /**
+         * Trigger only -- fetchVendorRecommendationsForCreateTransactionEpic does the work.
+         * A null entity means the vendor was cleared.
+         */
+        fetchVendorRecommendationsForCreateTransaction: {
+            reducer(
+            // eslint-disable-next-line @typescript-eslint/no-unused-vars
+            _draft, 
+            // eslint-disable-next-line @typescript-eslint/no-unused-vars
+            _action) {
+                // no-op
+            },
+            prepare(transactionType, lineIds, entity) {
+                return { payload: { transactionType, lineIds, entity } };
+            },
+        },
+        /** Trigger only -- createTransactionAttachmentUploadFailureEpic raises the snackbar. */
+        createTransactionAttachmentUploadFailure: {
+            reducer(
+            // eslint-disable-next-line @typescript-eslint/no-unused-vars
+            _draft, 
+            // eslint-disable-next-line @typescript-eslint/no-unused-vars
+            _action) {
+                // no-op
+            },
+            prepare(failedAttachmentFileNames) {
+                return { payload: { failedAttachmentFileNames } };
+            },
+        },
+        /**
+         * Writes a vendor's recommendations into the named lines. `lineIds` is explicit rather than
+         * "all lines" because a journal entry recommends per line, from that line's own entity.
+         */
+        setRecommendationsForCreateTransactionLines: {
+            reducer(draft, action) {
+                const { transactionType, lineIds, recommendations, isAccountingClassesEnabled, } = action.payload;
+                const current = draft.createTransactionsState.newTransactionState[transactionType];
+                // Clear first: on vendor A -> B, A's prefill is no longer empty, so B's would never
+                // replace it. Fields the user picked carry no prefill flag and survive the clear.
+                current.lines = current.lines.map((line) => lineIds.includes(line.id)
+                    ? applyRecommendationsToCreateTransactionLine(clearRecommendationsFromCreateTransactionLine(line), recommendations, isAccountingClassesEnabled)
+                    : line);
+            },
+            prepare(transactionType, lineIds, recommendations, isAccountingClassesEnabled) {
+                return {
+                    payload: {
+                        transactionType,
+                        lineIds,
+                        recommendations,
+                        isAccountingClassesEnabled,
+                    },
+                };
+            },
+        },
+        /** Vendor cleared: drop the dropdown group and undo only what the prefill wrote. */
+        clearRecommendationsForCreateTransactionLines: {
+            reducer(draft, action) {
+                const { transactionType, lineIds } = action.payload;
+                const current = draft.createTransactionsState.newTransactionState[transactionType];
+                current.lines = current.lines.map((line) => lineIds.includes(line.id)
+                    ? clearRecommendationsFromCreateTransactionLine(line)
+                    : line);
+            },
+            prepare(transactionType, lineIds) {
+                return { payload: { transactionType, lineIds } };
+            },
+        },
+        createTransactionSuccessOrFailure: {
+            reducer(draft, action) {
+                const { fetchState, error, createdTransactionId } = action.payload;
+                draft.createTransactionsState.createStatus = { fetchState, error };
+                if (createdTransactionId != null) {
+                    draft.createTransactionsState.createdTransactionId =
+                        createdTransactionId;
+                    // The API will not return a QBO-only row until delta sync, so the optimistic insert
+                    // is marked fetched: detail local data can be saved and a fetch is a cache hit.
+                    draft.transactionDetailById[getTransactionDetailKey(createdTransactionId)] = {
+                        ...initialSupportedTransactionDetail,
+                        fetchState: 'Completed',
+                        transactionId: createdTransactionId,
+                    };
+                }
+            },
+            prepare(fetchState, createdTransactionId, error) {
+                return { payload: { fetchState, createdTransactionId, error } };
+            },
+        },
     },
     extraReducers: (builder) => {
         builder.addCase(clearAll, (draft) => {
@@ -836,7 +1031,7 @@ const transactionDetail = createSlice({
         });
     },
 });
-export const { downloadAccountingProviderAttachment, downloadAccountingProviderAttachmentSuccess, downloadAccountingProviderAttachmentFailure, fetchTransactionDetail, updateTransactionDetailFetchState, removeTransactionDetail, uploadMissingAttachmentSuccess, updateTransactionDetail, updateTransactionDetailSaveStatus, clearTransactionDetailSaveStatus, markTransactionAsNotMiscategorized, deleteTransactionAttachment, deleteTransactionAttachmentFailure, deleteTransactionAttachmentSuccess, updateStatusForTransactionNotMiscategorizedUpdate, updateStatusConsolidatedSaveTransactionDetail, updateTransactionStateIfUpdateActionNotAllowed, saveTransactionDetail, initializeTransactionDetailLocalData, saveTransactionDetailLocalData, clearTransactionDetailLocalData, resetLineItemsCategoryClassInLocalData, setAllLineItemsToCategoryClassInLocalData, setAllLineItemsLocalDataIsUpdateAllChecked, setEntityRecommendationForLineIdsForTransactionDetail, markCategoryClassRecommendationsInProgressForTransactionDetail, markCategoryClassRecommendationsCompletedForTransactionDetail, markCategoryClassRecommendationsFailureForTransactionDetail, removeEntityRecommendationForLineIdForTransactionDetail, updateSelectedVendor, updateSelectedCustomer, resetVendor, resetSelectedCustomer, updateLocalDataWithTransactionsUpdateWithVendorCheckbox, updateVendorToAllLineItems, resetAllLineItemsToVendor, updateLatestSelectedEntity, updateVendorBulkRecommendationsFetchStatus, setIsVendorUpdateAllChecked, addSplitLine, deleteSplitLine, toggleSplitEditMode, } = transactionDetail.actions;
+export const { downloadAccountingProviderAttachment, downloadAccountingProviderAttachmentSuccess, downloadAccountingProviderAttachmentFailure, fetchTransactionDetail, updateTransactionDetailFetchState, removeTransactionDetail, uploadMissingAttachmentSuccess, updateTransactionDetail, updateTransactionDetailSaveStatus, clearTransactionDetailSaveStatus, markTransactionAsNotMiscategorized, deleteTransactionAttachment, deleteTransactionAttachmentFailure, deleteTransactionAttachmentSuccess, updateStatusForTransactionNotMiscategorizedUpdate, updateStatusConsolidatedSaveTransactionDetail, updateTransactionStateIfUpdateActionNotAllowed, saveTransactionDetail, initializeTransactionDetailLocalData, saveTransactionDetailLocalData, clearTransactionDetailLocalData, resetLineItemsCategoryClassInLocalData, setAllLineItemsToCategoryClassInLocalData, setAllLineItemsLocalDataIsUpdateAllChecked, setEntityRecommendationForLineIdsForTransactionDetail, markCategoryClassRecommendationsInProgressForTransactionDetail, markCategoryClassRecommendationsCompletedForTransactionDetail, markCategoryClassRecommendationsFailureForTransactionDetail, removeEntityRecommendationForLineIdForTransactionDetail, updateSelectedVendor, updateSelectedCustomer, resetVendor, resetSelectedCustomer, updateLocalDataWithTransactionsUpdateWithVendorCheckbox, updateVendorToAllLineItems, resetAllLineItemsToVendor, updateLatestSelectedEntity, updateVendorBulkRecommendationsFetchStatus, setIsVendorUpdateAllChecked, addSplitLine, deleteSplitLine, toggleSplitEditMode, initializeCreateTransactionLocalData, updateCreateTransactionLocalData, updateCreateTransactionLineLocalData, addCreateTransactionLine, removeCreateTransactionLine, resetCreateTransactionLocalData, createTransaction, createTransactionSuccessOrFailure, setRecommendationsForCreateTransactionLines, clearRecommendationsForCreateTransactionLines, fetchVendorRecommendationsForCreateTransaction, createTransactionAttachmentUploadFailure, } = transactionDetail.actions;
 export default transactionDetail.reducer;
 function getUpdatedEntityLocalData(detail, updates, entity, resetRecommendations, type) {
     const key = type === 'customer' ? 'customerUpdates' : 'vendorUpdates';

package/lib/index.d.ts

@@ -644,10 +644,13 @@ import { TopExAccount, TopExReport, TopExTimePeriodWithMetaData, TopExpenses } f
  * Expense Automation Exports ends
  */
 import { TOP_EX_TIME_PERIODS, TopExTimePeriod, TopExpense } from './view/topEx/topExState';
+import { CreateTransactionRequest } from './view/transactionDetail/createTransaction/createTransactionPayload';
+import { CreateTransactionView, getCreateTransactionLocalData, getCreateTransactionStatus, getCreateTransactionVendorRecommendations, getCreateTransactionView } from './view/transactionDetail/createTransaction/createTransactionSelector';
+import { ALL_CREATABLE_TRANSACTION_TYPES, CreatableTransactionType, CreateTransactionLineLocalData, CreateTransactionLocalData, RemitToAddress } from './view/transactionDetail/createTransaction/createTransactionState';
 import { AccountingProviderAttachmentSelector, getAccountingProviderAttachment } from './view/transactionDetail/getAccountingProviderAttachmentSelector';
 import { JOURNAL_ENTRY_SORT_KEYS, JournalEntryRowSortConfig, JournalEntrySortAccessors, JournalEntrySortKey, filterJournalEntryLinesExcludingLinked, journalEntryDefaultSortConfig, journalEntrySplitReconciliation, journalEntryTotalsByPostingSide, sortJournalEntryLines, sumJournalEntryAmounts, toJournalEntrySortKey } from './view/transactionDetail/journalEntryLinesViewModel';
 import { getChangedLineItemCountFromLocalData, isAccountUncategorized } from './view/transactionDetail/transactionDetailLocalDataHelper';
-import { addSplitLine, clearTransactionDetailSaveStatus, deleteSplitLine, deleteTransactionAttachment, downloadAccountingProviderAttachment, downloadAccountingProviderAttachmentFailure, downloadAccountingProviderAttachmentSuccess, fetchTransactionDetail, initializeTransactionDetailLocalData, markCategoryClassRecommendationsFailureForTransactionDetail, removeEntityRecommendationForLineIdForTransactionDetail, resetAllLineItemsToVendor, resetLineItemsCategoryClassInLocalData, resetSelectedCustomer, resetVendor, saveTransactionDetail, saveTransactionDetailLocalData, setAllLineItemsLocalDataIsUpdateAllChecked, setAllLineItemsToCategoryClassInLocalData, setIsVendorUpdateAllChecked, toggleSplitEditMode, updateLatestSelectedEntity, updateLocalDataWithTransactionsUpdateWithVendorCheckbox, updateSelectedCustomer, updateSelectedVendor, updateTransactionDetail, updateVendorBulkRecommendationsFetchStatus, updateVendorToAllLineItems, uploadMissingAttachmentSuccess } from './view/transactionDetail/transactionDetailReducer';
+import { addCreateTransactionLine, addSplitLine, clearRecommendationsForCreateTransactionLines, clearTransactionDetailSaveStatus, createTransaction, createTransactionAttachmentUploadFailure, createTransactionSuccessOrFailure, deleteSplitLine, deleteTransactionAttachment, downloadAccountingProviderAttachment, downloadAccountingProviderAttachmentFailure, downloadAccountingProviderAttachmentSuccess, fetchTransactionDetail, fetchVendorRecommendationsForCreateTransaction, initializeCreateTransactionLocalData, initializeTransactionDetailLocalData, markCategoryClassRecommendationsFailureForTransactionDetail, removeCreateTransactionLine, removeEntityRecommendationForLineIdForTransactionDetail, resetAllLineItemsToVendor, resetCreateTransactionLocalData, resetLineItemsCategoryClassInLocalData, resetSelectedCustomer, resetVendor, saveTransactionDetail, saveTransactionDetailLocalData, setAllLineItemsLocalDataIsUpdateAllChecked, setAllLineItemsToCategoryClassInLocalData, setIsVendorUpdateAllChecked, setRecommendationsForCreateTransactionLines, toggleSplitEditMode, updateCreateTransactionLineLocalData, updateCreateTransactionLocalData, updateLatestSelectedEntity, updateLocalDataWithTransactionsUpdateWithVendorCheckbox, updateSelectedCustomer, updateSelectedVendor, updateTransactionDetail, updateVendorBulkRecommendationsFetchStatus, updateVendorToAllLineItems, uploadMissingAttachmentSuccess } from './view/transactionDetail/transactionDetailReducer';
 import { TransactionDetailReport, VendorDetailsView, getInitialUpdatablePeriodsForTransactionRecommendations, getTransactionDetail, getTransactionDetailForTransaction } from './view/transactionDetail/transactionDetailSelector';
 import { TransactionUpdates, getThirdPartyIdFromTransactionId } from './view/transactionDetail/transactionDetailState';
 import { TransactionDetailLineItemData, TransactionDetailLocalData, TransactionVendorUpdates } from './view/transactionDetail/transactionDetailTypes';
@@ -814,7 +817,7 @@ export { MatchedTransaction };
 export { SupportedTransaction, SupportedTransactionWithCOT, SupportedTransactionPayload, getScheduleTransactionById, getSupportedTransactionById, };
 export { updateLatestTransactionId, parallelFetchAccountTransactionList, parallelFetchEntityTransactionList, fetchAccountTransactionList, updateTransactionListByAccount, updateTransactionListByAccountFailure, updateTransactionListByAccountUIState, parallelFetchClassTransactionList, updateTransactionListByClassUIState, updateTransactionListByClass, parallelFetchProjectTransactionList, updateTransactionListByProjectUIState, updateTransactionListByProject, updateTransactionListUIStateByCategoryType, parallelFetchTransactionListByCategoryType, };
 export { TransactionListByAccountReport, getTransactionListByAccount, getTransactionListUIStateByAccountKey, };
-export { fetchEntityTransactionList, updateTransactionListByEntity, saveTransactionDetailLocalData, clearTransactionDetailSaveStatus, updateTransactionListByEntityFailure, resetLineItemsCategoryClassInLocalData, setAllLineItemsToCategoryClassInLocalData, saveTransactionDetail, setAllLineItemsLocalDataIsUpdateAllChecked, initializeTransactionDetailLocalData, markCategoryClassRecommendationsFailureForTransactionDetail, removeEntityRecommendationForLineIdForTransactionDetail, updateSelectedVendor, updateSelectedCustomer, resetSelectedCustomer, resetVendor, updateLocalDataWithTransactionsUpdateWithVendorCheckbox, updateVendorToAllLineItems, resetAllLineItemsToVendor, updateLatestSelectedEntity, updateVendorBulkRecommendationsFetchStatus, setIsVendorUpdateAllChecked, addSplitLine, deleteSplitLine, toggleSplitEditMode, };
+export { ALL_CREATABLE_TRANSACTION_TYPES, initializeCreateTransactionLocalData, updateCreateTransactionLocalData, updateCreateTransactionLineLocalData, addCreateTransactionLine, removeCreateTransactionLine, resetCreateTransactionLocalData, createTransaction, createTransactionAttachmentUploadFailure, createTransactionSuccessOrFailure, fetchVendorRecommendationsForCreateTransaction, setRecommendationsForCreateTransactionLines, clearRecommendationsForCreateTransactionLines, getCreateTransactionView, getCreateTransactionLocalData, getCreateTransactionStatus, getCreateTransactionVendorRecommendations, fetchEntityTransactionList, updateTransactionListByEntity, saveTransactionDetailLocalData, clearTransactionDetailSaveStatus, updateTransactionListByEntityFailure, resetLineItemsCategoryClassInLocalData, setAllLineItemsToCategoryClassInLocalData, saveTransactionDetail, setAllLineItemsLocalDataIsUpdateAllChecked, initializeTransactionDetailLocalData, markCategoryClassRecommendationsFailureForTransactionDetail, removeEntityRecommendationForLineIdForTransactionDetail, updateSelectedVendor, updateSelectedCustomer, resetSelectedCustomer, resetVendor, updateLocalDataWithTransactionsUpdateWithVendorCheckbox, updateVendorToAllLineItems, resetAllLineItemsToVendor, updateLatestSelectedEntity, updateVendorBulkRecommendationsFetchStatus, setIsVendorUpdateAllChecked, addSplitLine, deleteSplitLine, toggleSplitEditMode, };
 export { TransactionUpdates, downloadAccountingProviderAttachment, downloadAccountingProviderAttachmentSuccess, downloadAccountingProviderAttachmentFailure, fetchTransactionDetail, updateTransactionDetail, uploadMissingAttachmentSuccess, deleteTransactionAttachment, getThirdPartyIdFromTransactionId, };
 export { TransactionListByEntityView, getTransactionListByEntity };
 export { TransactionListByClassReport, getTransactionListByClass, getTransactionListUIStateByClassKey, TransactionListByProjectReport, getTransactionListByProject, getTransactionListUIStateByProjectKey, getTransactionListByEntityForSinglePeriod, };
@@ -914,6 +917,7 @@ export { CustomerSatisfactionInfo };
 export { fetchCompanyOnboardingView, fetchQBOConnectionPool, updateQBOConnectionPoolExternalConnection, fetchOnboardingCompletedCompanies, saveOnboardingCustomerCompletedStatus, ProductType, ProductGroupType, toProductType, toProductTypeStrict, ProductInfo, getOnboardingCockpitView, getNewOnboardingCustomerView, getOnboardingEmailGroup, initializeOnboardingCustomerViewUpdateData, clearOnboardingCustomerViewUpdateData, saveOnboardingCustomerViewUpdateData, updateOnboardingCustomerListUIState, updateCustomerCreationStatus, updateStatusAfterOnboardingCompleted, saveOnboardingCustomerViewUpdates, saveOnboardingCustomerNotes, saveOnboardingCustomerDataInLocalStore, updateOnboardingCustomerDataInLocalStore, NewOnboardingCustomer, OnboardingCustomer, OnboardingCockpitView, NewOnboardingCustomerView, NewOnboardingCustomerLocalData, OnboardingCustomerCompletedStatus, OnboardingCustomerListUIState, QBOConnectionPool, CustomerCreationStatus, OnboardingCompanyDetails, resetNewOnboardedCustomerId, sendOnboardingCustomerViewInvite, retryBankAccountConnectionForOnboarding, };
 export { TransactionListByCategoryType, getTransactionsListByCategoryType, getTransactionListUIStateByCategoryType, TransactionCategoryType, };
 export { TransactionDetailLocalData, TransactionDetailLineItemData, TransactionVendorUpdates, };
+export { CreatableTransactionType, CreateTransactionLocalData, CreateTransactionLineLocalData, CreateTransactionView, CreateTransactionRequest, RemitToAddress, };
 export { getChangedLineItemCountFromLocalData, isAccountUncategorized };
 export { JOURNAL_ENTRY_SORT_KEYS, filterJournalEntryLinesExcludingLinked, journalEntryDefaultSortConfig, journalEntryTotalsByPostingSide, journalEntrySplitReconciliation, sortJournalEntryLines, sumJournalEntryAmounts, toJournalEntrySortKey, };
 export type { JournalEntryRowSortConfig, JournalEntrySortAccessors, JournalEntrySortKey, };