@zeniai/client-epic-state 5.3.7 → 5.3.8

package/lib/init.js

@@ -36,9 +36,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.injectFeatureEpics = exports.injectFeatureModules = exports.store = exports.pusher = exports.initializePusher = exports.disconnectPusher = exports.zeniAPI = void 0;
+exports.injectFeatureEpics = exports.injectFeatureModules = exports.store = exports.pusher = exports.initializePusher = exports.disconnectPusher = exports.setSessionEndpointsLoader = exports.zeniAPI = void 0;
 exports.default = initialize;
 exports.updateZeniAPIClientConfig = updateZeniAPIClientConfig;
+exports.updateZeniAPIEndpoints = updateZeniAPIEndpoints;
 exports.zeniAPIClientConfig = zeniAPIClientConfig;
 exports.initializeWithNewStore = initializeWithNewStore;
 exports.initialize3rdPartyExtensions = initialize3rdPartyExtensions;
@@ -47,6 +48,8 @@ const zeniAPI_1 = require("./zeniAPI");
 const zeniAPIClientState_1 = require("./zeniAPIClientState");
 var zeniAPIClientState_2 = require("./zeniAPIClientState");
 Object.defineProperty(exports, "zeniAPI", { enumerable: true, get: function () { return zeniAPIClientState_2.zeniAPI; } });
+var sessionEndpointsLoader_1 = require("./sessionEndpointsLoader");
+Object.defineProperty(exports, "setSessionEndpointsLoader", { enumerable: true, get: function () { return sessionEndpointsLoader_1.setSessionEndpointsLoader; } });
 var pusherClient_1 = require("./pusherClient");
 Object.defineProperty(exports, "disconnectPusher", { enumerable: true, get: function () { return pusherClient_1.disconnectPusher; } });
 Object.defineProperty(exports, "initializePusher", { enumerable: true, get: function () { return pusherClient_1.initializePusher; } });
@@ -60,11 +63,10 @@ let initialized = false;
  */
 function initialize(restEndPoints, userId, sessionId, tenantId, isSandboxEnv, onSessionInvalidated) {
     if (initialized) {
-        console.warn(`Already initialized with url ${JSON.stringify(zeniAPIClientState_1.zeniAPI.apiEndPoints)}`);
+        console.warn('client-epic-state is already initialized');
         return exports.store;
     }
     initialized = true;
-    console.info(`initializing with ${JSON.stringify(restEndPoints)}`);
     initialize3rdPartyExtensions();
     (0, zeniAPIClientState_1.setZeniAPIClient)(new zeniAPI_1.ZeniAPIClient(restEndPoints, userId, sessionId, tenantId, onSessionInvalidated));
     exports.store = (0, configureStore_1.default)(zeniAPIClientState_1.zeniAPI, isSandboxEnv);
@@ -84,6 +86,18 @@ Object.defineProperty(exports, "injectFeatureEpics", { enumerable: true, get: fu
 function updateZeniAPIClientConfig(userId, sessionId, tenantId) {
     zeniAPIClientState_1.zeniAPI.update(userId, sessionId, tenantId);
 }
+/**
+ * Replace the REST endpoints the API client calls. Epics read the endpoints
+ * at request time, so every request made after this uses the new ones.
+ * Note: This version SHOULD BE used only in the client side.
+ * @param restEndPoints
+ */
+function updateZeniAPIEndpoints(restEndPoints) {
+    if (zeniAPIClientState_1.zeniAPI == null) {
+        throw new Error('Call initialize() before updateZeniAPIEndpoints()');
+    }
+    zeniAPIClientState_1.zeniAPI.apiEndPoints = restEndPoints;
+}
 /**
  * Returns current Zeni REST API client config.
  * @returns
@@ -110,7 +124,6 @@ function zeniAPIClientConfig() {
  * @param tenantId tenant id
  */
 async function initializeWithNewStore(restEndPoints, userId, sessionId, tenantId) {
-    console.info(`initializeWithNewStore with ${JSON.stringify(restEndPoints)}`);
     initialize3rdPartyExtensions();
     const zeniHttpClient = new zeniAPI_1.ZeniAPIClient(restEndPoints, userId, sessionId, tenantId);
     const store = (0, configureStore_1.default)(zeniHttpClient, false);

package/lib/sessionEndpointsLoader.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Called after sign-in, before the user's tenants are fetched. The app uses it
+ * to fetch the endpoints that are only served to a signed-in session and to
+ * hand them to `updateZeniAPIEndpoints`. Without a loader, tenants are fetched
+ * straight away with the endpoints given to `initialize`.
+ */
+export type SessionEndpointsLoader = (userId: string, sessionId?: string) => Promise<void>;
+export declare function setSessionEndpointsLoader(loader: SessionEndpointsLoader | undefined): void;
+export declare function getSessionEndpointsLoader(): SessionEndpointsLoader | undefined;

package/lib/sessionEndpointsLoader.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setSessionEndpointsLoader = setSessionEndpointsLoader;
+exports.getSessionEndpointsLoader = getSessionEndpointsLoader;
+let sessionEndpointsLoader;
+function setSessionEndpointsLoader(loader) {
+    sessionEndpointsLoader = loader;
+}
+function getSessionEndpointsLoader() {
+    return sessionEndpointsLoader;
+}

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

@@ -29,9 +29,10 @@ const fetchReconciliationViewEpic = (actions$, state$, zeniAPI) => actions$.pipe
     }
     let fetchState;
     if (accountId != null) {
+        // Period bucket can be unhydrated during app-shell load.
         fetchState =
             accountReconciliationRecords[(0, timePeriod_1.toMonthYearPeriodId)(selectedPeriod)]
-                .reconciliationByAccountID[accountId].transactionFetchState
+                ?.reconciliationByAccountID[accountId]?.transactionFetchState
                 .fetchState;
     }
     else {

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

@@ -12,8 +12,9 @@ import { CreateTransactionLocalData } from './createTransactionState';
  * 1. `line_detail_type` is snake_case. The PascalCase strings in the backend are Python
  *    constant NAMES; ZENI_LINE_DETAIL_TYPE_TO_QBO_LINE_DETAIL_TYPE_MAP converts them for the
  *    body the backend sends on to QuickBooks, never for ours.
- * 2. Only the QBO Purchases (check, credit_card_credit) send a reference number, as
- *    `document_number`. A journal entry sends none.
+ * 2. The QBO Purchases (check, credit_card_credit) send their reference number as
+ *    `document_number`; a journal entry sends its entry name as `document_id`. Both land on
+ *    QBO's DocNumber, but QBOJournalEntry reads only `document_id`.
  */
 export interface CreateTransactionAccountPayload {
     qbo_id: ID;
@@ -25,14 +26,15 @@ export interface CreateTransactionLineDetailPayload {
         qbo_id: ID;
     };
     /**
-     * journal_entry only, and it MUST sit inside line_detail. The write validator's docstring
-     * warns that a misplaced posting_type is silently dropped and then rejected by QBO.
+     * journal_entry only, inside line_detail. QBOJournalEntry reads only posting_type_name; a
+     * lowercase posting_type is dropped and QBO then rejects the line.
      */
-    posting_type?: 'credit' | 'debit';
+    posting_type_name?: 'Credit' | 'Debit';
     /** Same shape the transaction update sends on a vendor line. */
     project?: ProjectBasePayload;
+    /** journal_entry only. The backend reads the QBO vendor id from `vendor_id`, not `qbo_id`. */
     vendor?: {
-        qbo_id: ID;
+        vendor_id: ID;
     };
 }
 export interface CreateTransactionLinePayload {
@@ -51,6 +53,8 @@ export interface CreateTransactionRemitToAddressPayload {
 export interface CreateTransactionRequest extends Record<string, unknown> {
     transaction_date: string;
     transaction_type: string;
+    /** journal_entry entry name (QBO DocNumber). */
+    document_id?: string;
     /** check / credit_card_credit reference number (QBO Purchase). */
     document_number?: string;
     from_account_id?: ID;

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

@@ -7,6 +7,10 @@ const classSelector_1 = require("../../../entity/class/classSelector");
 const projectPayload_1 = require("../../../entity/project/projectPayload");
 const projectSelector_1 = require("../../../entity/project/projectSelector");
 const vendorSelector_1 = require("../../../entity/vendor/vendorSelector");
+const POSTING_TYPE_NAME = {
+    credit: 'Credit',
+    debit: 'Debit',
+};
 const toRemitToAddressPayload = (address) => {
     if (address == null) {
         return undefined;
@@ -38,10 +42,12 @@ const toLinePayload = (state, line, transactionType) => {
         });
     }
     if (transactionType === 'journal_entry') {
-        lineDetail.posting_type = line.postingType;
+        if (line.postingType != null) {
+            lineDetail.posting_type_name = POSTING_TYPE_NAME[line.postingType];
+        }
         const vendorQboId = toQboLineVendorId(state, line.vendorQboId);
         if (vendorQboId != null) {
-            lineDetail.vendor = { qbo_id: vendorQboId };
+            lineDetail.vendor = { vendor_id: vendorQboId };
         }
     }
     return {
@@ -132,6 +138,10 @@ const prepareCreateTransactionPayload = (state, localData) => {
     if (transactionType === 'journal_entry') {
         return {
             ...base,
+            ...(localData.documentNumber != null &&
+                localData.documentNumber !== '' && {
+                document_id: localData.documentNumber,
+            }),
             lines,
         };
     }
@@ -145,6 +155,8 @@ const prepareCreateTransactionPayload = (state, localData) => {
     if (transactionType === 'check') {
         return {
             ...purchaseBase,
+            // The form has no payment method field for a check; qbo_purchase.py still requires it.
+            payment_type: 'check',
             document_number: localData.documentNumber,
             print_status: localData.printStatus,
             remit_to_address: toRemitToAddressPayload(localData.remitToAddress),

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

@@ -22,7 +22,10 @@ export interface CreateTransactionView extends SelectorView {
     lineAccountListFetchState: FetchState;
     localData: CreateTransactionLocalData;
     paymentAccountListFetchState: FetchState;
-    /** Bank, credit card and other current asset accounts for the header payment account. */
+    /**
+     * Bank, credit card and other current asset accounts for the header payment account; bank
+     * accounts only for a check.
+     */
     paymentAccountListNestedAccountHierarchy: NestedAccountHierarchyForReport[];
     transactionType: CreatableTransactionType;
     /** Populated for transfer only; the COA would offer ineligible accounts. */

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

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getCreateTransactionView = exports.getCreateTransactionVendorRecommendations = exports.getCreateTransactionStatus = exports.getCreateTransactionLocalData = void 0;
 const toolkit_1 = require("@reduxjs/toolkit");
+const accountSelector_1 = require("../../../entity/account/accountSelector");
 const accountListSelector_1 = require("../../accountList/accountListSelector");
 const classListSelector_1 = require("../../classList/classListSelector");
 const createTransferEntrySelector_1 = require("../../createTransferEntry/createTransferEntrySelector");
@@ -28,6 +29,23 @@ const getCreateTransactionVendorRecommendations = (state, vendorQboId) => {
     };
 };
 exports.getCreateTransactionVendorRecommendations = getCreateTransactionVendorRecommendations;
+/**
+ * QBO sub-accounts share their parent's type, so filtering the root nodes keeps whole subtrees.
+ *
+ * Memoized on its own: createTransactionsState changes on every keystroke, which re-runs the view
+ * projection, and the filter would otherwise hand the dropdown a new array each time.
+ */
+const getPaymentAccountListNestedAccountHierarchy = (0, toolkit_1.createSelector)([
+    (state) => (0, accountListSelector_1.getNestedAccountListHierarchy)(state.accountListState, 'createTransactionPaymentAccountList'),
+    (state) => state.accountState,
+    (_state, transactionType) => transactionType,
+], (hierarchy, accountState, transactionType) => {
+    if (transactionType !== 'check') {
+        return hierarchy;
+    }
+    return hierarchy.filter((node) => (0, accountSelector_1.getAccountBase)(accountState, node.accountId[0], 'account_list')
+        ?.accountType === 'bank');
+});
 /**
  * Memoized: app-ui reads this straight from useSelector, and the vendor list and hierarchies are
  * rebuilt on every call, so an unmemoized version re-renders the page on every store action.
@@ -36,10 +54,11 @@ exports.getCreateTransactionView = (0, toolkit_1.createSelector)([
     (state) => state.transactionDetailState.createTransactionsState,
     (state) => state.vendorState.vendorByID,
     (state) => state.accountListState,
+    getPaymentAccountListNestedAccountHierarchy,
     (state) => state.classListState,
     (state) => (0, createTransferEntrySelector_1.getResolvedTransferAccounts)(state).transferAccountsList,
     (_state, transactionType) => transactionType,
-], (createTransactionsState, vendorByID, accountListState, classListState, transferAccountsList, transactionType) => ({
+], (createTransactionsState, vendorByID, accountListState, paymentAccountListNestedAccountHierarchy, classListState, transferAccountsList, transactionType) => ({
     transactionType,
     localData: createTransactionsState.newTransactionState[transactionType],
     createStatus: createTransactionsState.createStatus,
@@ -49,7 +68,7 @@ exports.getCreateTransactionView = (0, toolkit_1.createSelector)([
     lineAccountListFetchState: (0, accountListSelector_1.getAccountListFetchState)(accountListState, 'createTransactionLineAccountList'),
     paymentAccountListFetchState: (0, accountListSelector_1.getAccountListFetchState)(accountListState, 'createTransactionPaymentAccountList'),
     accountListNestedAccountHierarchy: (0, accountListSelector_1.getNestedAccountListHierarchy)(accountListState, 'createTransactionLineAccountList'),
-    paymentAccountListNestedAccountHierarchy: (0, accountListSelector_1.getNestedAccountListHierarchy)(accountListState, 'createTransactionPaymentAccountList'),
+    paymentAccountListNestedAccountHierarchy,
     classListNestedAccountHierarchy: (0, classListSelector_1.getNestedClassListHierarchy)(classListState),
     transferAccountsList: transactionType === 'transfer' ? transferAccountsList : [],
     fetchState: createTransactionsState.createStatus.fetchState,

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

@@ -54,7 +54,7 @@ export interface CreateTransactionLocalData {
     /** Empty for transfer, which has no lines at all. */
     lines: CreateTransactionLineLocalData[];
     transactionType: CreatableTransactionType;
-    /** check / credit_card_credit reference number. */
+    /** check / credit_card_credit reference number, or the journal_entry entry name. */
     documentNumber?: string;
     /** transfer */
     fromAccountId?: ID;

package/lib/zeniAPI.d.ts

@@ -25,7 +25,7 @@ export interface RESTAPIEndpoints {
     readonly tenantMicroServiceBaseUrl: string;
 }
 export interface ZeniAPI<ResponseType = FetchResponse> {
-    readonly apiEndPoints: RESTAPIEndpoints;
+    apiEndPoints: RESTAPIEndpoints;
     readonly sessionId?: string;
     readonly tenantId?: string;
     readonly userId?: string;
@@ -40,7 +40,7 @@ export interface ZeniAPI<ResponseType = FetchResponse> {
     update(userId?: string, sessionId?: string, tenantId?: string): void;
 }
 export declare class ZeniAPIClient implements ZeniAPI {
-    readonly apiEndPoints: RESTAPIEndpoints;
+    apiEndPoints: RESTAPIEndpoints;
     userId?: string | undefined;
     sessionId?: string | undefined;
     tenantId?: string | undefined;

package/package.json

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