@zeniai/client-epic-state 5.1.0-betaSS2 → 5.1.0

package/lib/view/transactionDetail/journalEntryLinesViewModel.d.ts

@@ -0,0 +1,102 @@
+import { Amount } from '../../commonStateTypes/amount';
+import { SortOrder } from '../../commonStateTypes/selectorTypes/sortOrderTypes';
+import { JournalEntryTransactionLine, Line, TransactionLineBase } from '../../entity/transaction/stateTypes/transactionLine';
+/**
+ * View-model helpers for the new Journal Entry table view (see
+ * web-components `journalEntryTable`). Keeps presentation-agnostic
+ * logic — totals, sort, line-filter — colocated in epic-state so it
+ * is testable and reusable.
+ */
+export declare const JOURNAL_ENTRY_SORT_KEYS: readonly ["description", "name", "category", "class", "debit", "credit"];
+export declare const toJournalEntrySortKey: (v: string) => "category" | "class" | "description" | "name" | "credit" | "debit";
+export type JournalEntrySortKey = ReturnType<typeof toJournalEntrySortKey>;
+export interface JournalEntryRowSortConfig {
+    sortKey: JournalEntrySortKey;
+    sortOrder: SortOrder;
+}
+export declare const journalEntryDefaultSortConfig: JournalEntryRowSortConfig;
+type AmountBearer = Pick<TransactionLineBase, 'amount'>;
+/**
+ * Sums the `amount.amount` field of every line and returns an `Amount`
+ * whose currencyCode/currencySymbol are taken from the first line.
+ * Returns `undefined` for an empty list, and also when the first line
+ * has no currency to carry — a stray bare number with no symbol is
+ * worse to render than nothing, so the caller is forced to handle the
+ * absence.
+ *
+ * **Precondition:** all input lines must share a currency. Journal
+ * entry lines on the same transaction always do, which is the only
+ * caller today. Mixed-currency input is summed numerically (no FX
+ * conversion) and tagged with the first line's currency, which will
+ * silently produce a wrong total — if this helper is ever reused for
+ * a cross-currency aggregate (e.g. a multi-transaction report), the
+ * caller must pre-group by currency before calling.
+ *
+ * Mirrors legacy `calculateTotal` in
+ * `web-components/src/components/transactionDetail/items/TransactionLinesJournalEntry.tsx`
+ * but without the `Object.assign` ceremony and with stable currency carry-over.
+ */
+export declare const sumJournalEntryAmounts: (lines: ReadonlyArray<AmountBearer>) => Amount | undefined;
+/**
+ * Splits `lines` by `postingType` into a single debit total and a
+ * single credit total — the shape the new flat-table totals row
+ * (`JournalEntryTotalsRow` in `web-components`, Figma frame
+ * `5177:12750`) needs.
+ *
+ * The legacy `TransactionLinesJournalEntry` grouped lines into six
+ * `JournalEntryItemType` buckets (`debit` / `uncategorizedDebit` /
+ * `miscategorizedDebit` plus the credit triplet) for *visual banner
+ * headers* in the line list; its bottom totals row was already two
+ * combined numbers. The new flat table folds those banners away by
+ * design, so we don't surface a per-status breakdown here. If the
+ * design ever asks for sub-totals per status, that's a richer shape
+ * (`{debit: {total, uncategorized, miscategorized}, credit: {…}}`)
+ * and a follow-up — not a v1 of this helper.
+ *
+ * As a side effect, the legacy `calculateCombinedTotalAmount`
+ * `??`/`+` precedence bug (`totalAmount?.amount ?? 0 + (uncat ?? 0) +
+ * (miscat ?? 0)` parses as `totalAmount?.amount ?? (0 + uncat +
+ * miscat)`, silently dropping the uncat/miscat pieces whenever
+ * `totalAmount` was non-nullish) is gone by construction here: there
+ * is no separate combine step, just one pass over the lines.
+ */
+export declare const journalEntryTotalsByPostingSide: (lines: ReadonlyArray<Pick<JournalEntryTransactionLine, "amount" | "postingType">>) => {
+    creditTotal?: Amount;
+    debitTotal?: Amount;
+};
+/**
+ * Drops `linked_transaction_line` entries — equivalent to legacy
+ * `filterOutLinkedTransactionLine` in `transactionDetail.helpers.ts`.
+ *
+ * The literal lives in `LINE_TYPE_LINKED` next to `LineType` so the
+ * filter discriminant stays bound to the union at the type level.
+ * Other sites still inlining the literal (see `transactionDetailLocalDataHelper`,
+ * `transactionDetailState`, `transactionCategorizationLocalDataHelper`,
+ * `transactionLinePayload`, and the mocks) are a known follow-up.
+ */
+export declare const filterJournalEntryLinesExcludingLinked: <T extends Pick<Line, "type">>(lines?: ReadonlyArray<T>) => T[];
+/**
+ * Accessor functions resolve the sort value for each column from a
+ * line. The new table reads display-formatted values from the form
+ * (selected option label, entity name, etc.), so callers pass in
+ * accessors that match their `LineInfo` shape rather than baking the
+ * column-to-form-field mapping into epic-state.
+ */
+export interface JournalEntrySortAccessors<T> {
+    category: (line: T) => string;
+    class: (line: T) => string;
+    credit: (line: T) => number;
+    debit: (line: T) => number;
+    description: (line: T) => string;
+    name: (line: T) => string;
+}
+/**
+ * Stable, accessor-driven sort over arbitrary line shapes. Lines that
+ * resolve to the same key value preserve their original relative order
+ * thanks to lodash's stable `orderBy`.
+ *
+ * Strings are lower-cased before comparison so the order is predictable
+ * across mixed-case data. Numbers (debit/credit) compare directly.
+ */
+export declare const sortJournalEntryLines: <T>(lines: ReadonlyArray<T>, config: JournalEntryRowSortConfig, accessors: JournalEntrySortAccessors<T>) => T[];
+export {};

package/lib/view/transactionDetail/journalEntryLinesViewModel.js

@@ -0,0 +1,160 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sortJournalEntryLines = exports.filterJournalEntryLinesExcludingLinked = exports.journalEntryTotalsByPostingSide = exports.sumJournalEntryAmounts = exports.journalEntryDefaultSortConfig = exports.toJournalEntrySortKey = exports.JOURNAL_ENTRY_SORT_KEYS = void 0;
+const orderBy_1 = __importDefault(require("lodash/orderBy"));
+const stringToUnion_1 = require("../../commonStateTypes/stringToUnion");
+const transactionLine_1 = require("../../entity/transaction/stateTypes/transactionLine");
+/**
+ * View-model helpers for the new Journal Entry table view (see
+ * web-components `journalEntryTable`). Keeps presentation-agnostic
+ * logic — totals, sort, line-filter — colocated in epic-state so it
+ * is testable and reusable.
+ */
+// ---------------------------------------------------------------------------
+// Sort keys
+// ---------------------------------------------------------------------------
+exports.JOURNAL_ENTRY_SORT_KEYS = [
+    'description',
+    'name',
+    'category',
+    'class',
+    'debit',
+    'credit',
+];
+const toJournalEntrySortKey = (v) => (0, stringToUnion_1.stringToUnion)(v, exports.JOURNAL_ENTRY_SORT_KEYS);
+exports.toJournalEntrySortKey = toJournalEntrySortKey;
+exports.journalEntryDefaultSortConfig = {
+    sortKey: 'description',
+    sortOrder: 'ascending',
+};
+/**
+ * Sums the `amount.amount` field of every line and returns an `Amount`
+ * whose currencyCode/currencySymbol are taken from the first line.
+ * Returns `undefined` for an empty list, and also when the first line
+ * has no currency to carry — a stray bare number with no symbol is
+ * worse to render than nothing, so the caller is forced to handle the
+ * absence.
+ *
+ * **Precondition:** all input lines must share a currency. Journal
+ * entry lines on the same transaction always do, which is the only
+ * caller today. Mixed-currency input is summed numerically (no FX
+ * conversion) and tagged with the first line's currency, which will
+ * silently produce a wrong total — if this helper is ever reused for
+ * a cross-currency aggregate (e.g. a multi-transaction report), the
+ * caller must pre-group by currency before calling.
+ *
+ * Mirrors legacy `calculateTotal` in
+ * `web-components/src/components/transactionDetail/items/TransactionLinesJournalEntry.tsx`
+ * but without the `Object.assign` ceremony and with stable currency carry-over.
+ */
+const sumJournalEntryAmounts = (lines) => {
+    if (lines.length === 0) {
+        return undefined;
+    }
+    const first = lines[0].amount;
+    if (first?.currencyCode == null || first?.currencySymbol == null) {
+        return undefined;
+    }
+    let total = 0;
+    for (const line of lines) {
+        total += line.amount?.amount ?? 0;
+    }
+    return {
+        amount: total,
+        currencyCode: first.currencyCode,
+        currencySymbol: first.currencySymbol,
+    };
+};
+exports.sumJournalEntryAmounts = sumJournalEntryAmounts;
+/**
+ * Splits `lines` by `postingType` into a single debit total and a
+ * single credit total — the shape the new flat-table totals row
+ * (`JournalEntryTotalsRow` in `web-components`, Figma frame
+ * `5177:12750`) needs.
+ *
+ * The legacy `TransactionLinesJournalEntry` grouped lines into six
+ * `JournalEntryItemType` buckets (`debit` / `uncategorizedDebit` /
+ * `miscategorizedDebit` plus the credit triplet) for *visual banner
+ * headers* in the line list; its bottom totals row was already two
+ * combined numbers. The new flat table folds those banners away by
+ * design, so we don't surface a per-status breakdown here. If the
+ * design ever asks for sub-totals per status, that's a richer shape
+ * (`{debit: {total, uncategorized, miscategorized}, credit: {…}}`)
+ * and a follow-up — not a v1 of this helper.
+ *
+ * As a side effect, the legacy `calculateCombinedTotalAmount`
+ * `??`/`+` precedence bug (`totalAmount?.amount ?? 0 + (uncat ?? 0) +
+ * (miscat ?? 0)` parses as `totalAmount?.amount ?? (0 + uncat +
+ * miscat)`, silently dropping the uncat/miscat pieces whenever
+ * `totalAmount` was non-nullish) is gone by construction here: there
+ * is no separate combine step, just one pass over the lines.
+ */
+const journalEntryTotalsByPostingSide = (lines) => {
+    const debitLines = [];
+    const creditLines = [];
+    for (const line of lines) {
+        if (line.postingType === 'debit') {
+            debitLines.push(line);
+        }
+        else if (line.postingType === 'credit') {
+            creditLines.push(line);
+        }
+    }
+    return {
+        debitTotal: (0, exports.sumJournalEntryAmounts)(debitLines),
+        creditTotal: (0, exports.sumJournalEntryAmounts)(creditLines),
+    };
+};
+exports.journalEntryTotalsByPostingSide = journalEntryTotalsByPostingSide;
+// ---------------------------------------------------------------------------
+// Filter
+// ---------------------------------------------------------------------------
+/**
+ * Drops `linked_transaction_line` entries — equivalent to legacy
+ * `filterOutLinkedTransactionLine` in `transactionDetail.helpers.ts`.
+ *
+ * The literal lives in `LINE_TYPE_LINKED` next to `LineType` so the
+ * filter discriminant stays bound to the union at the type level.
+ * Other sites still inlining the literal (see `transactionDetailLocalDataHelper`,
+ * `transactionDetailState`, `transactionCategorizationLocalDataHelper`,
+ * `transactionLinePayload`, and the mocks) are a known follow-up.
+ */
+const filterJournalEntryLinesExcludingLinked = (lines) => lines?.filter((line) => line.type !== transactionLine_1.LINE_TYPE_LINKED) ?? [];
+exports.filterJournalEntryLinesExcludingLinked = filterJournalEntryLinesExcludingLinked;
+const sortOrderToLodash = (sortOrder) => sortOrder === 'descending' ? 'desc' : 'asc';
+/**
+ * Stable, accessor-driven sort over arbitrary line shapes. Lines that
+ * resolve to the same key value preserve their original relative order
+ * thanks to lodash's stable `orderBy`.
+ *
+ * Strings are lower-cased before comparison so the order is predictable
+ * across mixed-case data. Numbers (debit/credit) compare directly.
+ */
+const sortJournalEntryLines = (lines, config, accessors) => {
+    const accessor = (line) => {
+        switch (config.sortKey) {
+            case 'description':
+                return accessors.description(line).toLowerCase();
+            case 'name':
+                return accessors.name(line).toLowerCase();
+            case 'category':
+                return accessors.category(line).toLowerCase();
+            case 'class':
+                return accessors.class(line).toLowerCase();
+            case 'debit':
+                return accessors.debit(line);
+            case 'credit':
+                return accessors.credit(line);
+            default:
+                // stringToUnion narrows permissively (returns `s as StringUnion` for
+                // non-member input, see commonStateTypes/stringToUnion.ts), so this
+                // branch is reachable at runtime — keep it as a description fallback.
+                return accessors.description(line).toLowerCase();
+        }
+    };
+    return (0, orderBy_1.default)([...lines], [accessor], [sortOrderToLodash(config.sortOrder)]);
+};
+exports.sortJournalEntryLines = sortJournalEntryLines;

package/lib/view/transactionDetail/transactionDetailPayload.d.ts

@@ -3,7 +3,7 @@ import { TransactionPayload } from '../../entity/transaction/payloadTypes/transa
 import { SupportedTransactionPayload } from '../../entity/transaction/transactionState';
 import { VendorPayload } from '../../entity/vendor/vendorPayload';
 import { ZeniAPIResponse } from '../../responsePayload';
-interface TransactionDetailPayload {
+export interface TransactionDetailPayload {
     query: {
         transaction_id: string;
         transaction_type: string;

package/lib/view/transactionDetail/transactionDetailSelector.d.ts

@@ -1,7 +1,8 @@
 import { NestedAccountHierarchyForReport } from '../../commonStateTypes/accountView/nestedAccountID';
 import { NestedClassHierarchyForReport } from '../../commonStateTypes/classesView/nestedClassID';
-import { FetchStateAndError } from '../../commonStateTypes/common';
+import { FetchState, FetchStateAndError } from '../../commonStateTypes/common';
 import { SelectorView } from '../../commonStateTypes/viewAndReport/viewAndReport';
+import { AccountBase } from '../../entity/account/accountState';
 import { TransactionID } from '../../entity/transaction/stateTypes/transaction';
 import { SupportedTransactionWithCOT } from '../../entity/transaction/transactionState';
 import { Vendor } from '../../entity/vendor/vendorState';
@@ -17,6 +18,9 @@ export interface TransactionDetailReport extends SelectorView {
     allVendors: Vendor[];
     classHierarchyList: NestedClassHierarchyForReport[];
     classList: ClassListSelectorView;
+    createTransferEntryStatus: FetchState;
+    /** Resolved credit-card pool for credit_card_payment transfer drawer. */
+    creditCardTransferAccountsList: AccountBase[];
     deleteStatusByAttachmentName: Record<string, FetchStateAndError>;
     hasInFlightCategoryClassRecommendations: boolean;
     isAccountingClassesEnabled: boolean;
@@ -25,6 +29,7 @@ export interface TransactionDetailReport extends SelectorView {
     projectList: ProjectListSelectorView;
     transactionDetailLocalData: TransactionDetailLocalData;
     transactionDetailUpdateStatus: FetchStateAndError;
+    transferAccounts: AccountBase[];
     isUpdateNotAllowed?: boolean;
     transaction?: SupportedTransactionWithCOT;
 }

package/lib/view/transactionDetail/transactionDetailSelector.js

@@ -15,6 +15,7 @@ const vendorSelector_1 = require("../../entity/vendor/vendorSelector");
 const zeniDayJS_1 = require("../../zeniDayJS");
 const accountListSelector_1 = require("../accountList/accountListSelector");
 const classListSelector_1 = require("../classList/classListSelector");
+const createTransferEntrySelector_1 = require("../createTransferEntry/createTransferEntrySelector");
 const projectListSelector_1 = require("../projectList/projectListSelector");
 const transactionDetailState_1 = require("./transactionDetailState");
 // "Any line on this transaction is fetching category/class recommendations?"
@@ -39,7 +40,7 @@ const getDetailInFlightRecommendations = (state, transactionId) => {
 };
 exports.getDetailInFlightRecommendations = getDetailInFlightRecommendations;
 const getTransactionDetail = (state, transactionId, fetchLinkedTransactions = true) => {
-    const { transactionDetailState, transactionState, vendorState, vendorListState, accountState, classState, classListState, accountListState, projectState, projectListState, } = state;
+    const { transactionDetailState, transactionState, vendorState, vendorListState, accountState, classState, classListState, accountListState, createTransferEntryState, projectState, projectListState, } = state;
     const detailKey = (0, transactionDetailState_1.getTransactionDetailKey)(transactionId);
     const transactionDetail = (0, get_1.default)(transactionDetailState.transactionDetailById, detailKey);
     let fetchState = {
@@ -106,6 +107,7 @@ const getTransactionDetail = (state, transactionId, fetchLinkedTransactions = tr
         : [];
     const transactionDetailAnyUpdateStatus = reduceUpdateFetchStates(transactionDetail);
     const vendors = (0, vendorSelector_1.getVendorsByVendorIds)(vendorState, vendorListState.vendorIds);
+    const { transferAccountsList, creditCardTransferAccountsList } = (0, createTransferEntrySelector_1.getResolvedTransferAccounts)(state);
     const hasInFlightCategoryClassRecommendations = (0, exports.getDetailInFlightRecommendations)(state, transactionId);
     return {
         reportId: 'transaction_detail',
@@ -124,6 +126,9 @@ const getTransactionDetail = (state, transactionId, fetchLinkedTransactions = tr
         classList: classList,
         hasInFlightCategoryClassRecommendations,
         isAccountingClassesEnabled,
+        createTransferEntryStatus: createTransferEntryState.createTransferEntryStatus,
+        creditCardTransferAccountsList,
+        transferAccounts: transferAccountsList,
         isAccountingProjectsEnabled,
         projectList,
         isUpdateNotAllowed: transactionDetail?.isUpdateNotAllowed,

package/lib/zeniAPI.d.ts

@@ -10,6 +10,7 @@ export interface RESTAPIEndpoints {
     readonly authMicroServiceBaseUrl: string;
     readonly bankingMicroServiceBaseUrl: string;
     readonly cardMicroServiceBaseUrl: string;
+    readonly cashManagementAgentBaseUrl: string;
     readonly communicationAgentMicroServiceBaseUrl: string;
     readonly documentAIMicroServiceBaseUrl: string;
     readonly fileMicroServiceBaseUrl: string;

package/package.json

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