@zeniai/client-epic-state 5.2.84 → 5.2.85-beta0KB

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (42) hide show
  1. package/lib/entity/snackbar/snackbarTypes.d.ts +1 -1
  2. package/lib/entity/snackbar/snackbarTypes.js +1 -0
  3. package/lib/entity/transaction/stateTypes/paymentType.d.ts +2 -2
  4. package/lib/entity/transaction/stateTypes/paymentType.js +9 -1
  5. package/lib/entity/transaction/stateTypes/printStatus.d.ts +4 -0
  6. package/lib/entity/transaction/stateTypes/printStatus.js +11 -0
  7. package/lib/epic.d.ts +4 -1
  8. package/lib/epic.js +6 -0
  9. package/lib/esm/entity/snackbar/snackbarTypes.js +1 -0
  10. package/lib/esm/entity/transaction/stateTypes/paymentType.js +9 -1
  11. package/lib/esm/entity/transaction/stateTypes/printStatus.js +7 -0
  12. package/lib/esm/epic.js +6 -0
  13. package/lib/esm/index.js +5 -2
  14. package/lib/esm/view/transactionDetail/createTransaction/createTransactionLocalDataHelper.js +145 -0
  15. package/lib/esm/view/transactionDetail/createTransaction/createTransactionPayload.js +162 -0
  16. package/lib/esm/view/transactionDetail/createTransaction/createTransactionSelector.js +47 -0
  17. package/lib/esm/view/transactionDetail/createTransaction/createTransactionState.js +11 -0
  18. package/lib/esm/view/transactionDetail/createTransaction/epics/createTransactionEpic.js +80 -0
  19. package/lib/esm/view/transactionDetail/createTransaction/epics/fetchVendorRecommendationsForCreateTransactionEpic.js +53 -0
  20. package/lib/esm/view/transactionDetail/createTransaction/epics/initializeCreateTransactionLocalDataEpic.js +14 -0
  21. package/lib/esm/view/transactionDetail/transactionDetailReducer.js +176 -1
  22. package/lib/index.d.ts +6 -2
  23. package/lib/index.js +57 -37
  24. package/lib/view/expenseAutomationView/helpers/transactionCategorizationLocalDataHelper.d.ts +1 -1
  25. package/lib/view/transactionDetail/createTransaction/createTransactionLocalDataHelper.d.ts +52 -0
  26. package/lib/view/transactionDetail/createTransaction/createTransactionLocalDataHelper.js +160 -0
  27. package/lib/view/transactionDetail/createTransaction/createTransactionPayload.d.ts +95 -0
  28. package/lib/view/transactionDetail/createTransaction/createTransactionPayload.js +167 -0
  29. package/lib/view/transactionDetail/createTransaction/createTransactionSelector.d.ts +44 -0
  30. package/lib/view/transactionDetail/createTransaction/createTransactionSelector.js +53 -0
  31. package/lib/view/transactionDetail/createTransaction/createTransactionState.d.ts +82 -0
  32. package/lib/view/transactionDetail/createTransaction/createTransactionState.js +14 -0
  33. package/lib/view/transactionDetail/createTransaction/epics/createTransactionEpic.d.ts +9 -0
  34. package/lib/view/transactionDetail/createTransaction/epics/createTransactionEpic.js +84 -0
  35. package/lib/view/transactionDetail/createTransaction/epics/fetchVendorRecommendationsForCreateTransactionEpic.d.ts +20 -0
  36. package/lib/view/transactionDetail/createTransaction/epics/fetchVendorRecommendationsForCreateTransactionEpic.js +57 -0
  37. package/lib/view/transactionDetail/createTransaction/epics/initializeCreateTransactionLocalDataEpic.d.ts +12 -0
  38. package/lib/view/transactionDetail/createTransaction/epics/initializeCreateTransactionLocalDataEpic.js +18 -0
  39. package/lib/view/transactionDetail/transactionDetailReducer.d.ts +37 -1
  40. package/lib/view/transactionDetail/transactionDetailReducer.js +178 -2
  41. package/lib/view/transactionDetail/transactionDetailState.d.ts +12 -0
  42. package/package.json +1 -1
@@ -0,0 +1,162 @@
1
+ import { DEFAULT_DATE_FORMAT } from '../../../commonStateTypes/timePeriod';
2
+ import { getAccountBaseForTransferAccounts } from '../../../entity/account/accountSelector';
3
+ import { getClassById } from '../../../entity/class/classSelector';
4
+ import { toProjectBasePayload, } from '../../../entity/project/projectPayload';
5
+ import { getProjectById } from '../../../entity/project/projectSelector';
6
+ import { getVendorByVendorId } from '../../../entity/vendor/vendorSelector';
7
+ const toRemitToAddressPayload = (address) => {
8
+ if (address == null) {
9
+ return undefined;
10
+ }
11
+ return {
12
+ line1: address.line1,
13
+ city: address.city,
14
+ state: address.state,
15
+ postal_code: address.postalCode,
16
+ country: address.country,
17
+ };
18
+ };
19
+ const toLinePayload = (state, line, transactionType) => {
20
+ const lineDetail = {};
21
+ if (line.accountQboId != null) {
22
+ lineDetail.account = {
23
+ qbo_id: line.accountQboId,
24
+ account_name: line.accountName,
25
+ };
26
+ }
27
+ // An empty object is what the confirmed payloads send when no class is chosen; sending the
28
+ // key with a qbo_id only once one is picked.
29
+ const classQboId = toQboClassId(state, line.classId);
30
+ lineDetail.class = classQboId != null ? { qbo_id: classQboId } : {};
31
+ if (line.projectId != null) {
32
+ lineDetail.project = toProjectBasePayload(getProjectById(state.projectState, line.projectId) ?? {
33
+ projectId: line.projectId,
34
+ projectName: '',
35
+ });
36
+ }
37
+ if (transactionType === 'journal_entry') {
38
+ lineDetail.posting_type = line.postingType;
39
+ if (line.vendorQboId != null) {
40
+ lineDetail.vendor = { qbo_id: line.vendorQboId };
41
+ }
42
+ }
43
+ return {
44
+ // The backend rejects a bool here, so this is always coerced to a number.
45
+ amount: line.amount?.amount ?? 0,
46
+ line_description: line.lineDescription,
47
+ line_detail_type: transactionType === 'journal_entry'
48
+ ? 'journal_entry_line_detail'
49
+ : 'account_based_expense_line_detail',
50
+ line_detail: lineDetail,
51
+ };
52
+ };
53
+ /**
54
+ * Thrown when a picked id has no QBO id to send. Sending the Zeni id instead would reach QBO as
55
+ * an unknown reference and come back as an opaque error, so the create is stopped here and the
56
+ * epic shows this message instead.
57
+ */
58
+ export class UnresolvedCreateTransactionIdError extends Error {
59
+ }
60
+ /**
61
+ * Resolves a transfer account (the Zeni account id from the transfer pools) to its QBO id. The
62
+ * header and line account dropdowns already hold the QBO id, so they are sent as-is.
63
+ */
64
+ const toQboTransferAccountId = (state, accountId) => {
65
+ if (accountId == null) {
66
+ return undefined;
67
+ }
68
+ const qboId = getAccountBaseForTransferAccounts(state.accountState, accountId)?.qboId;
69
+ if (qboId == null || qboId === '') {
70
+ throw new UnresolvedCreateTransactionIdError('The selected transfer account could not be found in QuickBooks.');
71
+ }
72
+ return qboId;
73
+ };
74
+ /** Resolves a Zeni class id (`class_<uuid>`) to the QBO id `line_detail.class.qbo_id` expects. */
75
+ const toQboClassId = (state, classId) => {
76
+ if (classId == null) {
77
+ return undefined;
78
+ }
79
+ const qboId = getClassById(state.classState, {
80
+ classId,
81
+ reportId: 'class_list',
82
+ })?.qboId;
83
+ if (qboId == null || qboId === '') {
84
+ throw new UnresolvedCreateTransactionIdError('The selected class could not be found in QuickBooks.');
85
+ }
86
+ return qboId;
87
+ };
88
+ /**
89
+ * Resolves a Zeni vendor id to its QBO id -- `vendor_id` on the wire is a QBO id. A vendor not
90
+ * yet synced to QBO carries `qboId === name`, which QBO would reject, so it is refused here.
91
+ */
92
+ const toQboVendorId = (state, vendorId) => {
93
+ if (vendorId == null) {
94
+ return undefined;
95
+ }
96
+ const vendor = getVendorByVendorId(state.vendorState, vendorId);
97
+ if (vendor == null || vendor.qboId === '' || vendor.qboId === vendor.name) {
98
+ throw new UnresolvedCreateTransactionIdError('The selected vendor is not synced to QuickBooks yet.');
99
+ }
100
+ return vendor.qboId;
101
+ };
102
+ /**
103
+ * Builds the request body for one transaction type. One branch per type rather than a shared
104
+ * body with optional keys, because the types genuinely diverge -- transfer carries no lines at
105
+ * all, and journal_entry carries no header account.
106
+ *
107
+ * Throws UnresolvedCreateTransactionIdError when a picked vendor, class or transfer account has
108
+ * no QBO id.
109
+ */
110
+ export const prepareCreateTransactionPayload = (state, localData) => {
111
+ const { transactionType } = localData;
112
+ const base = {
113
+ transaction_type: transactionType,
114
+ transaction_date: localData.transactionDate?.format(DEFAULT_DATE_FORMAT) ?? '',
115
+ transaction_memo: localData.transactionMemo,
116
+ };
117
+ if (transactionType === 'transfer') {
118
+ return {
119
+ ...base,
120
+ from_account_id: toQboTransferAccountId(state, localData.fromAccountId),
121
+ to_account_id: toQboTransferAccountId(state, localData.toAccountId),
122
+ total_amount: localData.totalAmount?.amount ?? 0,
123
+ };
124
+ }
125
+ const lines = localData.lines.map((line) => toLinePayload(state, line, transactionType));
126
+ if (transactionType === 'journal_entry') {
127
+ return {
128
+ ...base,
129
+ document_id: localData.documentId,
130
+ lines,
131
+ };
132
+ }
133
+ const purchaseBase = {
134
+ ...base,
135
+ payment_type: localData.paymentType,
136
+ qbo_account_id: localData.qboAccountId,
137
+ vendor_id: toQboVendorId(state, localData.vendorId),
138
+ lines,
139
+ };
140
+ if (transactionType === 'check') {
141
+ return {
142
+ ...purchaseBase,
143
+ document_number: localData.documentNumber,
144
+ print_status: localData.printStatus,
145
+ remit_to_address: toRemitToAddressPayload(localData.remitToAddress),
146
+ };
147
+ }
148
+ if (transactionType === 'credit_card_credit') {
149
+ // credit_card_credit is not in the backend's SUPPORTED_TRANSACTION_WRITE_TYPES. QBO models
150
+ // it as a Purchase with Credit: true and qbo_purchase.py already honours is_credit for
151
+ // card payment types, so this sends `expense` + is_credit rather than a type the validator
152
+ // rejects outright. Confirm with backend before enabling the menu item. The seed sets
153
+ // payment_type to credit_card, since qbo_purchase.py raises on is_credit without a card type.
154
+ return {
155
+ ...purchaseBase,
156
+ transaction_type: 'expense',
157
+ is_credit: true,
158
+ document_number: localData.documentNumber,
159
+ };
160
+ }
161
+ return purchaseBase;
162
+ };
@@ -0,0 +1,47 @@
1
+ import { createSelector } from '@reduxjs/toolkit';
2
+ import { getNestedAccountListHierarchy } from '../../accountList/accountListSelector';
3
+ import { getNestedClassListHierarchy } from '../../classList/classListSelector';
4
+ import { getResolvedTransferAccounts } from '../../createTransferEntry/createTransferEntrySelector';
5
+ import { getRecommendationsForEntity } from '../../recommendation/recommendationSelector';
6
+ export const getCreateTransactionLocalData = (state, transactionType) => state.transactionDetailState.createTransactionsState.newTransactionState[transactionType];
7
+ export const getCreateTransactionStatus = (state) => state.transactionDetailState.createTransactionsState.createStatus;
8
+ /**
9
+ * The vendor recommendations backing the category/class dropdowns on the create page.
10
+ *
11
+ * No new state field is needed for this: getRecommendationsForEntity already returns
12
+ * fetchState alongside recommendations, so composing it here is enough for the page to show a
13
+ * line skeleton and hold Save while a fetch is in flight.
14
+ */
15
+ export const getCreateTransactionVendorRecommendations = (state, vendorQboId) => {
16
+ if (vendorQboId == null || vendorQboId === '') {
17
+ return { fetchState: 'Not-Started' };
18
+ }
19
+ const view = getRecommendationsForEntity(state, vendorQboId, 'vendor');
20
+ return {
21
+ fetchState: view.fetchState,
22
+ recommendations: view.recommendations,
23
+ };
24
+ };
25
+ /**
26
+ * Memoized: app-ui reads this straight from useSelector, and the vendor list and hierarchies are
27
+ * rebuilt on every call, so an unmemoized version re-renders the page on every store action.
28
+ */
29
+ export const getCreateTransactionView = createSelector([
30
+ (state) => state.transactionDetailState.createTransactionsState,
31
+ (state) => state.vendorState.vendorByID,
32
+ (state) => state.accountListState,
33
+ (state) => state.classListState,
34
+ (state) => getResolvedTransferAccounts(state).transferAccountsList,
35
+ (_state, transactionType) => transactionType,
36
+ ], (createTransactionsState, vendorByID, accountListState, classListState, transferAccountsList, transactionType) => ({
37
+ transactionType,
38
+ localData: createTransactionsState.newTransactionState[transactionType],
39
+ createStatus: createTransactionsState.createStatus,
40
+ createdTransactionId: createTransactionsState.createdTransactionId,
41
+ vendorList: Object.values(vendorByID),
42
+ accountListNestedAccountHierarchy: getNestedAccountListHierarchy(accountListState, 'accountList'),
43
+ classListNestedAccountHierarchy: getNestedClassListHierarchy(classListState),
44
+ transferAccountsList: transactionType === 'transfer' ? transferAccountsList : [],
45
+ fetchState: createTransactionsState.createStatus.fetchState,
46
+ error: createTransactionsState.createStatus.error,
47
+ }));
@@ -0,0 +1,11 @@
1
+ /**
2
+ * The transaction types the Create Transaction flow can originate. A narrow subset of
3
+ * TransactionType -- everything else is read-only and arrives via sync.
4
+ */
5
+ export const ALL_CREATABLE_TRANSACTION_TYPES = [
6
+ 'expense',
7
+ 'check',
8
+ 'credit_card_credit',
9
+ 'transfer',
10
+ 'journal_entry',
11
+ ];
@@ -0,0 +1,80 @@
1
+ import { defer, from } from 'rxjs';
2
+ import { catchError, exhaustMap, filter, mergeMap } from 'rxjs/operators';
3
+ import { openSnackbar } from '../../../../entity/snackbar/snackbarReducer';
4
+ import { toTransactionID } from '../../../../entity/transaction/payloadTypes/transactionIDPayload';
5
+ import { updateTransaction } from '../../../../entity/transaction/transactionReducer';
6
+ import { createZeniAPIStatus, isSuccessResponse, } from '../../../../responsePayload';
7
+ import { createTransaction, createTransactionSuccessOrFailure, initializeTransactionDetailLocalData, } from '../../transactionDetailReducer';
8
+ import { getTransactionDetailKey } from '../../transactionDetailState';
9
+ import { UnresolvedCreateTransactionIdError, prepareCreateTransactionPayload, } from '../createTransactionPayload';
10
+ export const createTransactionEpic = (actions$, state$, zeniAPI) => actions$.pipe(filter(createTransaction.match),
11
+ // exhaustMap, not mergeMap: a second submit while one is in flight is dropped here rather
12
+ // than relying only on the disabled Save button, so it cannot create a duplicate in QBO.
13
+ exhaustMap((action) => {
14
+ const { transactionType } = action.payload;
15
+ const state = state$.value;
16
+ const localData = state.transactionDetailState.createTransactionsState
17
+ .newTransactionState[transactionType];
18
+ // Deferred so a payload that cannot be built (an id with no QBO id) lands in catchError
19
+ // below as a failure, instead of throwing out of the epic.
20
+ return defer(() => zeniAPI.postAndGetJSON(`${zeniAPI.apiEndPoints.accountMicroServiceBaseUrl}/1.0/transactions/manage`, prepareCreateTransactionPayload(state, localData))).pipe(mergeMap((response) => {
21
+ const created = isSuccessResponse(response)
22
+ ? response.data?.transactions[0]
23
+ : undefined;
24
+ if (created == null) {
25
+ const status = isSuccessResponse(response)
26
+ ? createZeniAPIStatus('Unexpected Error', 'Transaction was created but returned no details.')
27
+ : response.status;
28
+ return from([
29
+ createTransactionSuccessOrFailure('Error', undefined, status),
30
+ openSnackbar({
31
+ messageSection: 'create_transaction',
32
+ messageText: 'failed',
33
+ type: 'error',
34
+ // This variable is how the server's own message reaches the user. Per-type
35
+ // required fields live in the QBO entity classes, so a rejection comes back as a
36
+ // QBO error with no field name -- the message text is the only useful content.
37
+ variables: [
38
+ { variableName: '_api-error_', variableValue: status.message },
39
+ ],
40
+ }),
41
+ ]);
42
+ }
43
+ const newTransactionId = toTransactionID(created);
44
+ // The write is QBO-only: transaction_write_handler.py touches no local storage, and
45
+ // Zeni's mirror is populated by the delta sync that runs afterwards. Refetching here
46
+ // would come back without the new row, so the 200 body is inserted optimistically
47
+ // instead -- the same approach createTransferEntryEpic takes.
48
+ return from([
49
+ updateTransaction(getTransactionDetailKey(newTransactionId), created),
50
+ initializeTransactionDetailLocalData({
51
+ transactionId: newTransactionId,
52
+ vendorId: created.vendor_id ?? undefined,
53
+ }),
54
+ // No reset here: it would clear createdTransactionId in the same tick, before the
55
+ // screen renders it to upload pending attachments and navigate. The screen resets
56
+ // the working copy on unmount instead.
57
+ createTransactionSuccessOrFailure('Completed', newTransactionId),
58
+ openSnackbar({
59
+ messageSection: 'create_transaction',
60
+ messageText: 'success',
61
+ type: 'success',
62
+ }),
63
+ ]);
64
+ }), catchError((error) => {
65
+ const message = error instanceof UnresolvedCreateTransactionIdError
66
+ ? error.message
67
+ : JSON.stringify(error);
68
+ return from([
69
+ createTransactionSuccessOrFailure('Error', undefined, createZeniAPIStatus('Unexpected Error', `Create Transaction REST API call errored out ${message}`)),
70
+ openSnackbar({
71
+ messageSection: 'create_transaction',
72
+ messageText: 'failed',
73
+ type: 'error',
74
+ variables: [
75
+ { variableName: '_api-error_', variableValue: message },
76
+ ],
77
+ }),
78
+ ]);
79
+ }));
80
+ }));
@@ -0,0 +1,53 @@
1
+ import { concat, from, of } from 'rxjs';
2
+ import { filter, mergeMap, switchMap, take } from 'rxjs/operators';
3
+ import { getIsAccountingClassesEnabled } from '../../../../entity/tenant/tenantSelector';
4
+ import { fetchRecommendationByEntityId, fetchRecommendationByEntityName, indicateReadyToInitializeRecommendation, } from '../../../recommendation/recommendationReducer';
5
+ import { getRecommendationsForEntity } from '../../../recommendation/recommendationSelector';
6
+ import { clearRecommendationsForCreateTransactionLines, fetchVendorRecommendationsForCreateTransaction, setRecommendationsForCreateTransactionLines, } from '../../transactionDetailReducer';
7
+ /**
8
+ * The entity-level recommendation fetch, keyed by whatever identifier the endpoint can resolve.
9
+ *
10
+ * A vendor that has not synced to QBO carries `qboId === name`; the id endpoint has nothing to
11
+ * look up in that case, so the by-name variant is used instead.
12
+ */
13
+ const toEntityIdOrName = (entity) => entity.qboId && entity.qboId !== entity.name ? entity.qboId : entity.name;
14
+ const isUnsyncedVendor = (entity) => !entity.qboId || entity.qboId === entity.name;
15
+ /**
16
+ * On vendor select, populates the category/class dropdowns from that vendor's recommendations.
17
+ *
18
+ * Deliberately NOT the detail page's fetchEntityRecommendationsForLineUpdate: that one sends
19
+ * transaction_id / line_ids and writes into transactionDetailById[key], which no-ops when the
20
+ * entry does not exist. A transaction being created has neither.
21
+ *
22
+ * Two differences from the reimbursement epic this is modelled on:
23
+ * 1. the wait filters on the matching entityIdOrName before take(1), so an unrelated
24
+ * recommendation landing first cannot satisfy this request, and
25
+ * 2. switchMap, so changing the vendor again cancels the earlier wait rather than letting a
26
+ * stale result overwrite the newer vendor's prefill.
27
+ */
28
+ export const fetchVendorRecommendationsForCreateTransactionEpic = (actions$, state$) => actions$.pipe(filter(fetchVendorRecommendationsForCreateTransaction.match), switchMap((action) => {
29
+ const { transactionType, entity, lineIds } = action.payload;
30
+ if (entity == null) {
31
+ return of(clearRecommendationsForCreateTransactionLines(transactionType, lineIds));
32
+ }
33
+ const entityIdOrName = toEntityIdOrName(entity);
34
+ const state = state$.value;
35
+ const isAccountingClassesEnabled = getIsAccountingClassesEnabled(state);
36
+ const cached = getRecommendationsForEntity(state, entityIdOrName, 'vendor');
37
+ // Cache hit: apply straight away, no request and no wait.
38
+ if (cached.fetchState === 'Completed') {
39
+ return of(setRecommendationsForCreateTransactionLines(transactionType, lineIds, cached.recommendations ?? [], isAccountingClassesEnabled));
40
+ }
41
+ const waitThenApply = actions$.pipe(filter(indicateReadyToInitializeRecommendation.match), filter((ready) => ready.payload.entityType === 'vendor' &&
42
+ ready.payload.entityIdOrName === entityIdOrName), take(1), // don't listen forever! IMPORTANT!
43
+ mergeMap(() => from([
44
+ setRecommendationsForCreateTransactionLines(transactionType, lineIds, getRecommendationsForEntity(state$.value, entityIdOrName, 'vendor').recommendations ?? [], getIsAccountingClassesEnabled(state$.value)),
45
+ ])));
46
+ // A fetch already in flight needs no second request, only the wait.
47
+ if (cached.fetchState === 'In-Progress') {
48
+ return waitThenApply;
49
+ }
50
+ return concat(of((isUnsyncedVendor(entity)
51
+ ? fetchRecommendationByEntityName(entityIdOrName, 'vendor')
52
+ : fetchRecommendationByEntityId(entityIdOrName, 'vendor'))), waitThenApply);
53
+ }));
@@ -0,0 +1,14 @@
1
+ import { filter, map } from 'rxjs/operators';
2
+ import { initializeCreateTransactionLocalData, updateCreateTransactionLocalData, } from '../../transactionDetailReducer';
3
+ import { getSeededCreateTransactionLocalData } from '../createTransactionLocalDataHelper';
4
+ /**
5
+ * Seeds the working copy when the Create form opens: today's date, the default line set for the
6
+ * type, and a check's mandatory payment_type.
7
+ *
8
+ * Mirrors the `else` branch of initializeScheduleDetailLocalDataEpic -- a create has no
9
+ * existing entity to read from, so there is nothing to merge, only defaults to apply.
10
+ */
11
+ export const initializeCreateTransactionLocalDataEpic = (actions$) => actions$.pipe(filter(initializeCreateTransactionLocalData.match), map((action) => {
12
+ const { transactionType } = action.payload;
13
+ return updateCreateTransactionLocalData(transactionType, getSeededCreateTransactionLocalData(transactionType));
14
+ }));
@@ -2,6 +2,7 @@ import { createSlice } from '@reduxjs/toolkit';
2
2
  import recordGet from 'lodash/get';
3
3
  import { toEntityType, } from '../../entity/genericEntity/entity';
4
4
  import { clearAll } from '../../rootActions';
5
+ import { applyRecommendationsToCreateTransactionLine, clearRecommendationsFromCreateTransactionLine, getInitialCreateTransactionLocalDataByType, getSeededCreateTransactionLocalData, mergeCreateTransactionLocalData, nextCreateTransactionLineId, updateCreateTransactionLine, } from './createTransaction/createTransactionLocalDataHelper';
5
6
  import { removeEntityRecommendationForLineIdInLocalData, setEntityRecommendationForLineIdInLocalData, toSetAllLineItemsLocalDataIsUpdateAllChecked, toSetAllLineItemsToCategoryClass, toSetAllLineItemsToVendor, toUpdateLineItemsOriginalCategoryClass, toUpdateLineItemsToOriginalVendor, } from './transactionDetailLocalDataHelper';
6
7
  import { getTransactionDetailKey, initialSupportedTransactionDetail, } from './transactionDetailState';
7
8
  export const initialState = {
@@ -10,6 +11,10 @@ export const initialState = {
10
11
  fetchState: 'Not-Started',
11
12
  attachmentDataByID: {},
12
13
  },
14
+ createTransactionsState: {
15
+ createStatus: { fetchState: 'Not-Started' },
16
+ newTransactionState: getInitialCreateTransactionLocalDataByType(),
17
+ },
13
18
  };
14
19
  const transactionDetail = createSlice({
15
20
  name: 'transactionDetail',
@@ -829,6 +834,176 @@ const transactionDetail = createSlice({
829
834
  };
830
835
  },
831
836
  },
837
+ // ---------------------------------------------------------------------------------
838
+ // Create Transaction
839
+ //
840
+ // These live on the transactionDetail slice rather than in createTransaction/ because a
841
+ // createSlice owns exactly one state object, and createTransactionsState is nested inside
842
+ // TransactionDetailState. The derivation itself stays in the folder -- each body below
843
+ // delegates to createTransactionLocalDataHelper.ts.
844
+ //
845
+ // They need no clearAll case of their own: the slice already resets to initialState on
846
+ // tenant switch, and createTransactionsState is part of it.
847
+ // ---------------------------------------------------------------------------------
848
+ /** Trigger only -- initializeCreateTransactionLocalDataEpic does the seeding. */
849
+ initializeCreateTransactionLocalData: {
850
+ reducer(
851
+ // eslint-disable-next-line @typescript-eslint/no-unused-vars
852
+ _draft,
853
+ // eslint-disable-next-line @typescript-eslint/no-unused-vars
854
+ _action) {
855
+ // no-op
856
+ },
857
+ prepare(transactionType) {
858
+ return { payload: { transactionType } };
859
+ },
860
+ },
861
+ updateCreateTransactionLocalData: {
862
+ reducer(draft, action) {
863
+ const { transactionType, localData } = action.payload;
864
+ const current = draft.createTransactionsState.newTransactionState[transactionType];
865
+ draft.createTransactionsState.newTransactionState[transactionType] =
866
+ mergeCreateTransactionLocalData(current, localData);
867
+ },
868
+ prepare(transactionType, localData) {
869
+ return { payload: { transactionType, localData } };
870
+ },
871
+ },
872
+ updateCreateTransactionLineLocalData: {
873
+ reducer(draft, action) {
874
+ const { transactionType, lineId, lineUpdates } = action.payload;
875
+ const current = draft.createTransactionsState.newTransactionState[transactionType];
876
+ current.lines = updateCreateTransactionLine(current.lines, lineId, lineUpdates);
877
+ },
878
+ prepare(transactionType, lineId, lineUpdates) {
879
+ return { payload: { transactionType, lineId, lineUpdates } };
880
+ },
881
+ },
882
+ /**
883
+ * `line` is supplied by the caller rather than built here, so a row added after a vendor is
884
+ * already chosen can arrive pre-populated from the cached recommendations instead of blank.
885
+ */
886
+ addCreateTransactionLine: {
887
+ reducer(draft, action) {
888
+ const { transactionType, line } = action.payload;
889
+ draft.createTransactionsState.newTransactionState[transactionType].lines.push({
890
+ ...line,
891
+ id: nextCreateTransactionLineId(),
892
+ });
893
+ },
894
+ prepare(transactionType, line) {
895
+ return { payload: { transactionType, line } };
896
+ },
897
+ },
898
+ removeCreateTransactionLine: {
899
+ reducer(draft, action) {
900
+ const { transactionType, lineId } = action.payload;
901
+ const current = draft.createTransactionsState.newTransactionState[transactionType];
902
+ current.lines = current.lines.filter((line) => line.id !== lineId);
903
+ },
904
+ prepare(transactionType, lineId) {
905
+ return { payload: { transactionType, lineId } };
906
+ },
907
+ },
908
+ /**
909
+ * Restores the blank working copy AND re-seeds it, so reopening Create starts from a fresh
910
+ * form rather than the previous transaction's values.
911
+ */
912
+ resetCreateTransactionLocalData: {
913
+ reducer(draft, action) {
914
+ const { transactionType } = action.payload;
915
+ draft.createTransactionsState.newTransactionState[transactionType] =
916
+ getSeededCreateTransactionLocalData(transactionType);
917
+ draft.createTransactionsState.createStatus = {
918
+ fetchState: 'Not-Started',
919
+ };
920
+ draft.createTransactionsState.createdTransactionId = undefined;
921
+ },
922
+ prepare(transactionType) {
923
+ return { payload: { transactionType } };
924
+ },
925
+ },
926
+ /** Submit trigger -- createTransactionEpic builds the payload from localData. */
927
+ createTransaction: {
928
+ reducer(draft,
929
+ // eslint-disable-next-line @typescript-eslint/no-unused-vars
930
+ _action) {
931
+ draft.createTransactionsState.createStatus = {
932
+ fetchState: 'In-Progress',
933
+ };
934
+ draft.createTransactionsState.createdTransactionId = undefined;
935
+ },
936
+ prepare(transactionType) {
937
+ return { payload: { transactionType } };
938
+ },
939
+ },
940
+ /**
941
+ * Trigger only -- fetchVendorRecommendationsForCreateTransactionEpic does the work.
942
+ * A null entity means the vendor was cleared.
943
+ */
944
+ fetchVendorRecommendationsForCreateTransaction: {
945
+ reducer(
946
+ // eslint-disable-next-line @typescript-eslint/no-unused-vars
947
+ _draft,
948
+ // eslint-disable-next-line @typescript-eslint/no-unused-vars
949
+ _action) {
950
+ // no-op
951
+ },
952
+ prepare(transactionType, lineIds, entity) {
953
+ return { payload: { transactionType, lineIds, entity } };
954
+ },
955
+ },
956
+ /**
957
+ * Writes a vendor's recommendations into the named lines. `lineIds` is explicit rather than
958
+ * "all lines" because a journal entry recommends per line, from that line's own entity.
959
+ */
960
+ setRecommendationsForCreateTransactionLines: {
961
+ reducer(draft, action) {
962
+ const { transactionType, lineIds, recommendations, isAccountingClassesEnabled, } = action.payload;
963
+ const current = draft.createTransactionsState.newTransactionState[transactionType];
964
+ // Clear first: on vendor A -> B, A's prefill is no longer empty, so B's would never
965
+ // replace it. Fields the user picked carry no prefill flag and survive the clear.
966
+ current.lines = current.lines.map((line) => lineIds.includes(line.id)
967
+ ? applyRecommendationsToCreateTransactionLine(clearRecommendationsFromCreateTransactionLine(line), recommendations, isAccountingClassesEnabled)
968
+ : line);
969
+ },
970
+ prepare(transactionType, lineIds, recommendations, isAccountingClassesEnabled) {
971
+ return {
972
+ payload: {
973
+ transactionType,
974
+ lineIds,
975
+ recommendations,
976
+ isAccountingClassesEnabled,
977
+ },
978
+ };
979
+ },
980
+ },
981
+ /** Vendor cleared: drop the dropdown group and undo only what the prefill wrote. */
982
+ clearRecommendationsForCreateTransactionLines: {
983
+ reducer(draft, action) {
984
+ const { transactionType, lineIds } = action.payload;
985
+ const current = draft.createTransactionsState.newTransactionState[transactionType];
986
+ current.lines = current.lines.map((line) => lineIds.includes(line.id)
987
+ ? clearRecommendationsFromCreateTransactionLine(line)
988
+ : line);
989
+ },
990
+ prepare(transactionType, lineIds) {
991
+ return { payload: { transactionType, lineIds } };
992
+ },
993
+ },
994
+ createTransactionSuccessOrFailure: {
995
+ reducer(draft, action) {
996
+ const { fetchState, error, createdTransactionId } = action.payload;
997
+ draft.createTransactionsState.createStatus = { fetchState, error };
998
+ if (createdTransactionId != null) {
999
+ draft.createTransactionsState.createdTransactionId =
1000
+ createdTransactionId;
1001
+ }
1002
+ },
1003
+ prepare(fetchState, createdTransactionId, error) {
1004
+ return { payload: { fetchState, createdTransactionId, error } };
1005
+ },
1006
+ },
832
1007
  },
833
1008
  extraReducers: (builder) => {
834
1009
  builder.addCase(clearAll, (draft) => {
@@ -836,7 +1011,7 @@ const transactionDetail = createSlice({
836
1011
  });
837
1012
  },
838
1013
  });
839
- 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;
1014
+ 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, } = transactionDetail.actions;
840
1015
  export default transactionDetail.reducer;
841
1016
  function getUpdatedEntityLocalData(detail, updates, entity, resetRecommendations, type) {
842
1017
  const key = type === 'customer' ? 'customerUpdates' : 'vendorUpdates';
package/lib/index.d.ts CHANGED
@@ -641,10 +641,13 @@ import { TopExAccount, TopExReport, TopExTimePeriodWithMetaData, TopExpenses } f
641
641
  * Expense Automation Exports ends
642
642
  */
643
643
  import { TOP_EX_TIME_PERIODS, TopExTimePeriod, TopExpense } from './view/topEx/topExState';
644
+ import { CreateTransactionRequest, prepareCreateTransactionPayload } from './view/transactionDetail/createTransaction/createTransactionPayload';
645
+ import { CreateTransactionView, getCreateTransactionLocalData, getCreateTransactionStatus, getCreateTransactionVendorRecommendations, getCreateTransactionView } from './view/transactionDetail/createTransaction/createTransactionSelector';
646
+ import { ALL_CREATABLE_TRANSACTION_TYPES, CreatableTransactionType, CreateTransactionLineLocalData, CreateTransactionLocalData, RemitToAddress } from './view/transactionDetail/createTransaction/createTransactionState';
644
647
  import { AccountingProviderAttachmentSelector, getAccountingProviderAttachment } from './view/transactionDetail/getAccountingProviderAttachmentSelector';
645
648
  import { JOURNAL_ENTRY_SORT_KEYS, JournalEntryRowSortConfig, JournalEntrySortAccessors, JournalEntrySortKey, filterJournalEntryLinesExcludingLinked, journalEntryDefaultSortConfig, journalEntrySplitReconciliation, journalEntryTotalsByPostingSide, sortJournalEntryLines, sumJournalEntryAmounts, toJournalEntrySortKey } from './view/transactionDetail/journalEntryLinesViewModel';
646
649
  import { getChangedLineItemCountFromLocalData, isAccountUncategorized } from './view/transactionDetail/transactionDetailLocalDataHelper';
647
- 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';
650
+ import { addCreateTransactionLine, addSplitLine, clearRecommendationsForCreateTransactionLines, clearTransactionDetailSaveStatus, createTransaction, 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';
648
651
  import { TransactionDetailReport, VendorDetailsView, getInitialUpdatablePeriodsForTransactionRecommendations, getTransactionDetail, getTransactionDetailForTransaction } from './view/transactionDetail/transactionDetailSelector';
649
652
  import { TransactionUpdates, getThirdPartyIdFromTransactionId } from './view/transactionDetail/transactionDetailState';
650
653
  import { TransactionDetailLineItemData, TransactionDetailLocalData, TransactionVendorUpdates } from './view/transactionDetail/transactionDetailTypes';
@@ -811,7 +814,7 @@ export { MatchedTransaction };
811
814
  export { SupportedTransaction, SupportedTransactionWithCOT, SupportedTransactionPayload, getScheduleTransactionById, getSupportedTransactionById, };
812
815
  export { updateLatestTransactionId, parallelFetchAccountTransactionList, parallelFetchEntityTransactionList, fetchAccountTransactionList, updateTransactionListByAccount, updateTransactionListByAccountFailure, updateTransactionListByAccountUIState, parallelFetchClassTransactionList, updateTransactionListByClassUIState, updateTransactionListByClass, parallelFetchProjectTransactionList, updateTransactionListByProjectUIState, updateTransactionListByProject, updateTransactionListUIStateByCategoryType, parallelFetchTransactionListByCategoryType, };
813
816
  export { TransactionListByAccountReport, getTransactionListByAccount, getTransactionListUIStateByAccountKey, };
814
- 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, };
817
+ export { ALL_CREATABLE_TRANSACTION_TYPES, initializeCreateTransactionLocalData, updateCreateTransactionLocalData, updateCreateTransactionLineLocalData, addCreateTransactionLine, removeCreateTransactionLine, resetCreateTransactionLocalData, createTransaction, createTransactionSuccessOrFailure, fetchVendorRecommendationsForCreateTransaction, setRecommendationsForCreateTransactionLines, clearRecommendationsForCreateTransactionLines, getCreateTransactionView, getCreateTransactionLocalData, getCreateTransactionStatus, getCreateTransactionVendorRecommendations, prepareCreateTransactionPayload, 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, };
815
818
  export { TransactionUpdates, downloadAccountingProviderAttachment, downloadAccountingProviderAttachmentSuccess, downloadAccountingProviderAttachmentFailure, fetchTransactionDetail, updateTransactionDetail, uploadMissingAttachmentSuccess, deleteTransactionAttachment, getThirdPartyIdFromTransactionId, };
816
819
  export { TransactionListByEntityView, getTransactionListByEntity };
817
820
  export { TransactionListByClassReport, getTransactionListByClass, getTransactionListUIStateByClassKey, TransactionListByProjectReport, getTransactionListByProject, getTransactionListUIStateByProjectKey, getTransactionListByEntityForSinglePeriod, };
@@ -910,6 +913,7 @@ export { CustomerSatisfactionInfo };
910
913
  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, };
911
914
  export { TransactionListByCategoryType, getTransactionsListByCategoryType, getTransactionListUIStateByCategoryType, TransactionCategoryType, };
912
915
  export { TransactionDetailLocalData, TransactionDetailLineItemData, TransactionVendorUpdates, };
916
+ export { CreatableTransactionType, CreateTransactionLocalData, CreateTransactionLineLocalData, CreateTransactionView, CreateTransactionRequest, RemitToAddress, };
913
917
  export { getChangedLineItemCountFromLocalData, isAccountUncategorized };
914
918
  export { JOURNAL_ENTRY_SORT_KEYS, filterJournalEntryLinesExcludingLinked, journalEntryDefaultSortConfig, journalEntryTotalsByPostingSide, journalEntrySplitReconciliation, sortJournalEntryLines, sumJournalEntryAmounts, toJournalEntrySortKey, };
915
919
  export type { JournalEntryRowSortConfig, JournalEntrySortAccessors, JournalEntrySortKey, };