@zeniai/client-epic-state 5.2.62-beta0KB → 5.2.62-beta0MM

package/lib/view/transactionDetail/createTransaction/createTransactionState.d.ts

@@ -1,81 +0,0 @@
-import { Amount } from '../../../commonStateTypes/amount';
-import { ID } from '../../../commonStateTypes/common';
-import { RecommendationWithCOT } from '../../../commonStateTypes/recommendationBase';
-import { PaymentType } from '../../../entity/transaction/stateTypes/paymentType';
-import { PrintStatus } from '../../../entity/transaction/stateTypes/printStatus';
-import { TransactionCategory, TransactionType } from '../../../entity/transaction/stateTypes/transactionType';
-import { ZeniDate } from '../../../zeniDayJS';
-/**
- * The transaction types the Create Transaction flow can originate. A narrow subset of
- * TransactionType -- everything else is read-only and arrives via sync.
- */
-export declare const ALL_CREATABLE_TRANSACTION_TYPES: readonly ["expense", "check", "credit_card_credit", "transfer", "journal_entry"];
-export type CreatableTransactionType = (typeof ALL_CREATABLE_TRANSACTION_TYPES)[number];
-/**
- * The wire shape the create endpoint expects for a check's remit-to address. Deliberately not
- * the CES AddressPayload, which carries `street: string[]` plus address_id/create_time/
- * update_time that the create endpoint does not accept.
- */
-export interface RemitToAddress {
-    city?: string;
-    country?: string;
-    line1?: string;
-    postalCode?: string;
-    state?: string;
-}
-export interface CreateTransactionLineLocalData {
-    /** Client-side row key only -- never sent. */
-    id: string;
-    accountName?: string;
-    accountQboId?: ID;
-    amount?: Amount;
-    classId?: ID;
-    /**
-     * Tracked per field, not per line. A line can have a hand-picked account and a prefilled
-     * class at the same time, and clearing the vendor must undo only the latter.
-     */
-    isAccountPreFilled?: boolean;
-    isClassPreFilled?: boolean;
-    lineDescription?: string;
-    /** journal_entry only. */
-    postingType?: TransactionCategory;
-    projectId?: ID;
-    /**
-     * Backs the "Recommended" group in the category/class dropdowns. Carries the COT shape the
-     * line-table row already expects, with empty cot/reasoning -- chain-of-thought needs an
-     * existing transaction, which a create does not have.
-     */
-    recommendationsWithCOT?: RecommendationWithCOT[];
-    /** journal_entry only -- the per-line name. */
-    vendorQboId?: ID;
-}
-export interface CreateTransactionLocalData {
-    /** Empty for transfer, which has no lines at all. */
-    lines: CreateTransactionLineLocalData[];
-    transactionType: CreatableTransactionType;
-    /** journal_entry reference number. */
-    documentId?: string;
-    /** check / credit_card_credit reference number. */
-    documentNumber?: string;
-    /** transfer */
-    fromAccountId?: ID;
-    paymentType?: PaymentType;
-    /** check only. */
-    printStatus?: PrintStatus;
-    qboAccountId?: ID;
-    /** check only. */
-    remitToAddress?: RemitToAddress;
-    toAccountId?: ID;
-    /** transfer only -- every other type derives its total from the lines. */
-    totalAmount?: Amount;
-    transactionDate?: ZeniDate;
-    transactionMemo?: string;
-    vendorId?: ID;
-}
-export type CreateTransactionLocalDataByType = Record<CreatableTransactionType, CreateTransactionLocalData>;
-/**
- * Type-level guarantee that CreatableTransactionType stays a subset of TransactionType. If a
- * value is ever added here that the entity layer does not know about, this line fails to
- * compile rather than failing at the payload boundary.
- */
-export type CreatableTransactionTypeIsTransactionType = CreatableTransactionType extends TransactionType ? true : never;

package/lib/view/transactionDetail/createTransaction/createTransactionState.js

@@ -1,14 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ALL_CREATABLE_TRANSACTION_TYPES = void 0;
-/**
- * The transaction types the Create Transaction flow can originate. A narrow subset of
- * TransactionType -- everything else is read-only and arrives via sync.
- */
-exports.ALL_CREATABLE_TRANSACTION_TYPES = [
-    'expense',
-    'check',
-    'credit_card_credit',
-    'transfer',
-    'journal_entry',
-];

package/lib/view/transactionDetail/createTransaction/epics/createTransactionEpic.d.ts

@@ -1,9 +0,0 @@
-import { ActionsObservable, StateObservable } from 'redux-observable';
-import { Observable } from 'rxjs';
-import { openSnackbar } from '../../../../entity/snackbar/snackbarReducer';
-import { updateTransaction } from '../../../../entity/transaction/transactionReducer';
-import { RootState } from '../../../../rootStateTypes';
-import { ZeniAPI } from '../../../../zeniAPI';
-import { createTransaction, createTransactionSuccessOrFailure, initializeTransactionDetailLocalData, resetCreateTransactionLocalData } from '../../transactionDetailReducer';
-export type ActionType = ReturnType<typeof createTransaction> | ReturnType<typeof createTransactionSuccessOrFailure> | ReturnType<typeof resetCreateTransactionLocalData> | ReturnType<typeof initializeTransactionDetailLocalData> | ReturnType<typeof updateTransaction> | ReturnType<typeof openSnackbar>;
-export declare const createTransactionEpic: (actions$: ActionsObservable<ActionType>, state$: StateObservable<RootState>, zeniAPI: ZeniAPI) => Observable<ActionType>;

package/lib/view/transactionDetail/createTransaction/epics/createTransactionEpic.js

@@ -1,62 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createTransactionEpic = void 0;
-const rxjs_1 = require("rxjs");
-const operators_1 = require("rxjs/operators");
-const snackbarReducer_1 = require("../../../../entity/snackbar/snackbarReducer");
-const transactionIDPayload_1 = require("../../../../entity/transaction/payloadTypes/transactionIDPayload");
-const transactionReducer_1 = require("../../../../entity/transaction/transactionReducer");
-const responsePayload_1 = require("../../../../responsePayload");
-const transactionDetailReducer_1 = require("../../transactionDetailReducer");
-const transactionDetailState_1 = require("../../transactionDetailState");
-const createTransactionPayload_1 = require("../createTransactionPayload");
-const failureActions = (message, status) => [
-    (0, transactionDetailReducer_1.createTransactionSuccessOrFailure)('Error', undefined, status),
-    (0, snackbarReducer_1.openSnackbar)({
-        messageSection: 'create_transaction',
-        messageText: 'failed',
-        type: 'error',
-        // This variable is how the server's own message reaches the user. Per-type required
-        // fields live in the QBO entity classes, so a rejection comes back as a QBO error with no
-        // field name -- the message text is the only useful content we get.
-        variables: [{ variableName: '_api-error_', variableValue: message }],
-    }),
-];
-const createTransactionEpic = (actions$, state$, zeniAPI) => actions$.pipe((0, operators_1.filter)(transactionDetailReducer_1.createTransaction.match), (0, operators_1.mergeMap)((action) => {
-    const { transactionType } = action.payload;
-    const state = state$.value;
-    const localData = state.transactionDetailState.createTransactionsState
-        .newTransactionState[transactionType];
-    const payload = (0, createTransactionPayload_1.prepareCreateTransactionPayload)(state, localData);
-    return zeniAPI
-        .postAndGetJSON(`${zeniAPI.apiEndPoints.accountMicroServiceBaseUrl}/1.0/transactions/manage`, payload)
-        .pipe((0, operators_1.mergeMap)((response) => {
-        if (!(0, responsePayload_1.isSuccessResponse)(response) || response.data == null) {
-            return (0, rxjs_1.from)(failureActions(response.status.message, response.status));
-        }
-        const created = response.data.transactions[0];
-        if (created == null) {
-            return (0, rxjs_1.from)(failureActions('Transaction was created but returned no details.', (0, responsePayload_1.createZeniAPIStatus)('Unexpected Error', 'Create transaction returned an empty transactions array.')));
-        }
-        const newTransactionId = (0, transactionIDPayload_1.toTransactionID)(created);
-        // The write is QBO-only: transaction_write_handler.py touches no local storage, and
-        // Zeni's mirror is populated by the delta sync that runs afterwards. Refetching here
-        // would come back without the new row, so the 200 body is inserted optimistically
-        // instead -- the same approach createTransferEntryEpic takes.
-        return (0, rxjs_1.from)([
-            (0, transactionReducer_1.updateTransaction)((0, transactionDetailState_1.getTransactionDetailKey)(newTransactionId), created),
-            (0, transactionDetailReducer_1.initializeTransactionDetailLocalData)({
-                transactionId: newTransactionId,
-                vendorId: created.vendor_id ?? undefined,
-            }),
-            (0, transactionDetailReducer_1.createTransactionSuccessOrFailure)('Completed', newTransactionId),
-            (0, transactionDetailReducer_1.resetCreateTransactionLocalData)(transactionType),
-            (0, snackbarReducer_1.openSnackbar)({
-                messageSection: 'create_transaction',
-                messageText: 'success',
-                type: 'success',
-            }),
-        ]);
-    }), (0, operators_1.catchError)((error) => (0, rxjs_1.from)(failureActions(JSON.stringify(error), (0, responsePayload_1.createZeniAPIStatus)('Unexpected Error', `Create Transaction REST API call errored out ${JSON.stringify(error)}`)))));
-}));
-exports.createTransactionEpic = createTransactionEpic;

package/lib/view/transactionDetail/createTransaction/epics/fetchVendorRecommendationsForCreateTransactionEpic.d.ts

@@ -1,20 +0,0 @@
-import { ActionsObservable, StateObservable } from 'redux-observable';
-import { Observable } from 'rxjs';
-import { RootState } from '../../../../rootStateTypes';
-import { fetchRecommendationByEntityId, fetchRecommendationByEntityName, indicateReadyToInitializeRecommendation } from '../../../recommendation/recommendationReducer';
-import { clearRecommendationsForCreateTransactionLines, fetchVendorRecommendationsForCreateTransaction, setRecommendationsForCreateTransactionLines } from '../../transactionDetailReducer';
-export type ActionType = ReturnType<typeof fetchVendorRecommendationsForCreateTransaction> | ReturnType<typeof setRecommendationsForCreateTransactionLines> | ReturnType<typeof clearRecommendationsForCreateTransactionLines> | ReturnType<typeof fetchRecommendationByEntityId> | ReturnType<typeof fetchRecommendationByEntityName> | ReturnType<typeof indicateReadyToInitializeRecommendation>;
-/**
- * On vendor select, populates the category/class dropdowns from that vendor's recommendations.
- *
- * Deliberately NOT the detail page's fetchEntityRecommendationsForLineUpdate: that one sends
- * transaction_id / line_ids and writes into transactionDetailById[key], which no-ops when the
- * entry does not exist. A transaction being created has neither.
- *
- * Two differences from the reimbursement epic this is modelled on:
- *  1. the wait filters on the matching entityIdOrName before take(1), so an unrelated
- *     recommendation landing first cannot satisfy this request, and
- *  2. switchMap, so changing the vendor again cancels the earlier wait rather than letting a
- *     stale result overwrite the newer vendor's prefill.
- */
-export declare const fetchVendorRecommendationsForCreateTransactionEpic: (actions$: ActionsObservable<ActionType>, state$: StateObservable<RootState>) => Observable<ActionType>;

package/lib/view/transactionDetail/createTransaction/epics/fetchVendorRecommendationsForCreateTransactionEpic.js

@@ -1,59 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.fetchVendorRecommendationsForCreateTransactionEpic = void 0;
-const rxjs_1 = require("rxjs");
-const operators_1 = require("rxjs/operators");
-const tenantSelector_1 = require("../../../../entity/tenant/tenantSelector");
-const recommendationReducer_1 = require("../../../recommendation/recommendationReducer");
-const recommendationSelector_1 = require("../../../recommendation/recommendationSelector");
-const transactionDetailReducer_1 = require("../../transactionDetailReducer");
-/**
- * The entity-level recommendation fetch, keyed by whatever identifier the endpoint can resolve.
- *
- * A vendor that has not synced to QBO carries `qboId === name`; the id endpoint has nothing to
- * look up in that case, so the by-name variant is used instead.
- */
-const toEntityIdOrName = (entity) => entity.qboId !== '' && entity.qboId !== entity.name
-    ? entity.qboId
-    : entity.name;
-const isUnsyncedVendor = (entity) => entity.qboId === '' || entity.qboId === entity.name;
-/**
- * On vendor select, populates the category/class dropdowns from that vendor's recommendations.
- *
- * Deliberately NOT the detail page's fetchEntityRecommendationsForLineUpdate: that one sends
- * transaction_id / line_ids and writes into transactionDetailById[key], which no-ops when the
- * entry does not exist. A transaction being created has neither.
- *
- * Two differences from the reimbursement epic this is modelled on:
- *  1. the wait filters on the matching entityIdOrName before take(1), so an unrelated
- *     recommendation landing first cannot satisfy this request, and
- *  2. switchMap, so changing the vendor again cancels the earlier wait rather than letting a
- *     stale result overwrite the newer vendor's prefill.
- */
-const fetchVendorRecommendationsForCreateTransactionEpic = (actions$, state$) => actions$.pipe((0, operators_1.filter)(transactionDetailReducer_1.fetchVendorRecommendationsForCreateTransaction.match), (0, operators_1.switchMap)((action) => {
-    const { transactionType, entity, lineIds } = action.payload;
-    if (entity == null) {
-        return (0, rxjs_1.of)((0, transactionDetailReducer_1.clearRecommendationsForCreateTransactionLines)(transactionType, lineIds));
-    }
-    const entityIdOrName = toEntityIdOrName(entity);
-    const state = state$.value;
-    const isAccountingClassesEnabled = (0, tenantSelector_1.getIsAccountingClassesEnabled)(state);
-    const cached = (0, recommendationSelector_1.getRecommendationsForEntity)(state, entityIdOrName, 'vendor');
-    // Cache hit: apply straight away, no request and no wait.
-    if (cached.fetchState === 'Completed') {
-        return (0, rxjs_1.of)((0, transactionDetailReducer_1.setRecommendationsForCreateTransactionLines)(transactionType, lineIds, cached.recommendations ?? [], isAccountingClassesEnabled));
-    }
-    const waitThenApply = actions$.pipe((0, operators_1.filter)(recommendationReducer_1.indicateReadyToInitializeRecommendation.match), (0, operators_1.filter)((ready) => ready.payload.entityType === 'vendor' &&
-        ready.payload.entityIdOrName === entityIdOrName), (0, operators_1.take)(1), // don't listen forever! IMPORTANT!
-    (0, operators_1.mergeMap)(() => (0, rxjs_1.from)([
-        (0, transactionDetailReducer_1.setRecommendationsForCreateTransactionLines)(transactionType, lineIds, (0, recommendationSelector_1.getRecommendationsForEntity)(state$.value, entityIdOrName, 'vendor').recommendations ?? [], (0, tenantSelector_1.getIsAccountingClassesEnabled)(state$.value)),
-    ])));
-    // A fetch already in flight needs no second request, only the wait.
-    if (cached.fetchState === 'In-Progress') {
-        return waitThenApply;
-    }
-    return (0, rxjs_1.concat)((0, rxjs_1.of)((isUnsyncedVendor(entity)
-        ? (0, recommendationReducer_1.fetchRecommendationByEntityName)(entityIdOrName, 'vendor')
-        : (0, recommendationReducer_1.fetchRecommendationByEntityId)(entityIdOrName, 'vendor'))), waitThenApply);
-}));
-exports.fetchVendorRecommendationsForCreateTransactionEpic = fetchVendorRecommendationsForCreateTransactionEpic;

package/lib/view/transactionDetail/createTransaction/epics/initializeCreateTransactionLocalDataEpic.d.ts

@@ -1,12 +0,0 @@
-import { ActionsObservable } from 'redux-observable';
-import { Observable } from 'rxjs';
-import { initializeCreateTransactionLocalData, updateCreateTransactionLocalData } from '../../transactionDetailReducer';
-export type ActionType = ReturnType<typeof initializeCreateTransactionLocalData> | ReturnType<typeof updateCreateTransactionLocalData>;
-/**
- * Seeds the working copy when the Create form opens: today's date, the default line set for the
- * type, and a check's mandatory payment_type.
- *
- * Mirrors the `else` branch of initializeScheduleDetailLocalDataEpic -- a create has no
- * existing entity to read from, so there is nothing to merge, only defaults to apply.
- */
-export declare const initializeCreateTransactionLocalDataEpic: (actions$: ActionsObservable<ActionType>) => Observable<ActionType>;

package/lib/view/transactionDetail/createTransaction/epics/initializeCreateTransactionLocalDataEpic.js

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.initializeCreateTransactionLocalDataEpic = void 0;
-const operators_1 = require("rxjs/operators");
-const transactionDetailReducer_1 = require("../../transactionDetailReducer");
-const createTransactionLocalDataHelper_1 = require("../createTransactionLocalDataHelper");
-/**
- * Seeds the working copy when the Create form opens: today's date, the default line set for the
- * type, and a check's mandatory payment_type.
- *
- * Mirrors the `else` branch of initializeScheduleDetailLocalDataEpic -- a create has no
- * existing entity to read from, so there is nothing to merge, only defaults to apply.
- */
-const initializeCreateTransactionLocalDataEpic = (actions$) => actions$.pipe((0, operators_1.filter)(transactionDetailReducer_1.initializeCreateTransactionLocalData.match), (0, operators_1.map)((action) => {
-    const { transactionType } = action.payload;
-    return (0, transactionDetailReducer_1.updateCreateTransactionLocalData)(transactionType, (0, createTransactionLocalDataHelper_1.getSeededCreateTransactionLocalData)(transactionType));
-}));
-exports.initializeCreateTransactionLocalDataEpic = initializeCreateTransactionLocalDataEpic;