@zeniai/client-epic-state 5.2.89 → 5.2.90

package/lib/entity/invoicing/creditNote/creditNotePayload.d.ts

@@ -39,6 +39,8 @@ export interface InvoicingCreditNotePayload {
     status?: InvoicingCreditNoteStatus;
     sub_total?: number;
     subscription_id?: string;
+    /** The subscription's display number (SUB-####), resolved by the service. */
+    subscription_number?: string | null;
     total?: number;
     type?: InvoicingCreditNoteType;
 }

package/lib/entity/invoicing/creditNote/creditNotePayload.js

@@ -54,6 +54,11 @@ const mapInvoicingCreditNotePayloadToState = (payload) => {
         status: payload.status,
         subTotal: payload.sub_total != null ? toAmt(payload.sub_total) : undefined,
         subscriptionID: payload.subscription_id,
+        // Blank when the credit note has no subscription; the API sends "".
+        subscriptionNumber: payload.subscription_number != null &&
+            payload.subscription_number.trim() !== ''
+            ? payload.subscription_number.trim()
+            : undefined,
         total: payload.total != null ? toAmt(payload.total) : undefined,
         type: payload.type,
     };

package/lib/entity/invoicing/creditNote/creditNoteState.d.ts

@@ -39,6 +39,7 @@ export interface InvoicingCreditNote {
     referenceInvoiceNumber?: string;
     status?: InvoicingCreditNoteStatus;
     subscriptionID?: ID;
+    subscriptionNumber?: string;
     subTotal?: Amount;
     total?: Amount;
     type?: InvoicingCreditNoteType;

package/lib/esm/entity/invoicing/creditNote/creditNotePayload.js

@@ -49,6 +49,11 @@ export const mapInvoicingCreditNotePayloadToState = (payload) => {
         status: payload.status,
         subTotal: payload.sub_total != null ? toAmt(payload.sub_total) : undefined,
         subscriptionID: payload.subscription_id,
+        // Blank when the credit note has no subscription; the API sends "".
+        subscriptionNumber: payload.subscription_number != null &&
+            payload.subscription_number.trim() !== ''
+            ? payload.subscription_number.trim()
+            : undefined,
         total: payload.total != null ? toAmt(payload.total) : undefined,
         type: payload.type,
     };

package/lib/esm/view/financeStatement/financeStatementReducer.js

@@ -1,4 +1,5 @@
 import { createSlice } from '@reduxjs/toolkit';
+import { stripCompareAdditionalBalanceTypes, } from '../../commonStateTypes/coaBalance/coaBalanceType';
 import { extractThisPeriod, getMatchingThisPeriod, } from '../../commonStateTypes/viewAndReport/thisPeriodHelpers';
 import { clearAll } from '../../rootActions';
 import { dateNow } from '../../zeniDayJS';
@@ -88,17 +89,11 @@ const financeStatement = createSlice({
         updateFinanceStatementAdditionalBalancesSelection(draft, action) {
             const { additionalBalances: additionalBalancesPayload, maxNumOfPeriodsToHighlight, } = action.payload;
             const additionalBalances = additionalBalancesPayload ?? [];
-            let tempAdditionalBalances = [...additionalBalances];
-            if (additionalBalances.includes('this_period_vs_last_period') ||
-                additionalBalances.includes('this_period_vs_last_period_percent')) {
-                const id = tempAdditionalBalances.findIndex((balance) => balance === 'this_period_vs_last_period' ||
-                    balance === 'this_period_vs_last_period_percent');
-                if (id > -1) {
-                    const balance = tempAdditionalBalances.splice(id, 1);
-                    tempAdditionalBalances = [...balance, ...tempAdditionalBalances];
-                }
-            }
-            draft.selectedAdditionalBalances = tempAdditionalBalances;
+            const otherBalances = stripCompareAdditionalBalanceTypes(additionalBalances);
+            draft.selectedAdditionalBalances = [
+                ...additionalBalances.filter((balance) => !otherBalances.includes(balance)),
+                ...otherBalances,
+            ];
             draft.maxNumOfPeriodsToHighlight = maxNumOfPeriodsToHighlight;
             draft.isAdditionalBalancesShown =
                 additionalBalances.length != 0 ? true : false;

package/lib/esm/view/reportUIOptions/financeStatementCompareBalances.js

@@ -0,0 +1,16 @@
+import { stripCompareAdditionalBalanceTypes, } from '../../commonStateTypes/coaBalance/coaBalanceType';
+// Reports can show the $ and % change columns together, so every requested compare type is kept;
+// compareMode picks one only when none was requested.
+export function getFinanceStatementAdditionalBalances(requestedBalances, isCompareModeOn, compareBalanceFromMode) {
+    const otherBalances = stripCompareAdditionalBalanceTypes(requestedBalances);
+    if (!isCompareModeOn) {
+        return otherBalances;
+    }
+    const requestedCompareBalances = requestedBalances.filter((balance) => !otherBalances.includes(balance));
+    return [
+        ...otherBalances,
+        ...(requestedCompareBalances.length > 0
+            ? requestedCompareBalances
+            : [compareBalanceFromMode]),
+    ];
+}

package/lib/esm/view/reportUIOptions/updateReportUIOptionCompareModeEpic.js

@@ -7,6 +7,7 @@ import { getFinanceStatement } from '../financeStatement/financeStatementSelecto
 import { updateNetBurnOrIncomeAdditionalBalancesSelection } from '../netBurnOrIncome/netBurnOrIncomeReducer';
 import { updateOpExAdditionalBalancesSelection } from '../opEx/opExReducer';
 import { updateRevenueAdditionalBalancesSelection } from '../revenue/revenueReducer';
+import { getFinanceStatementAdditionalBalances } from './financeStatementCompareBalances';
 import { updateReportUIOptionCompareMode } from './reportUIOptionsReducer';
 export const updateReportUIOptionIsCompareModeEpic = (actions$, state) => actions$.pipe(filter(updateReportUIOptionCompareMode.match), switchMap((action) => {
     const { additionalBalances } = action.payload;
@@ -15,11 +16,7 @@ export const updateReportUIOptionIsCompareModeEpic = (actions$, state) => action
         ? 'this_period_vs_last_period_percent'
         : 'this_period_vs_last_period';
     const financeStatementState = getFinanceStatement(state.value);
-    const filteredFinanceAdditionalBalances = additionalBalances.filter((balance) => balance !== 'this_period_vs_last_period' &&
-        balance !== 'this_period_vs_last_period_percent');
-    const financeAdditionalBalances = isCompareModeOn
-        ? [...filteredFinanceAdditionalBalances, additionalBalance]
-        : filteredFinanceAdditionalBalances;
+    const financeAdditionalBalances = getFinanceStatementAdditionalBalances(additionalBalances, isCompareModeOn, additionalBalance);
     return of(updateNetBurnOrIncomeAdditionalBalancesSelection({
         isCompareModeOn,
         additionalBalances: isCompareModeOn ? [additionalBalance] : [],

package/lib/esm/view/reportUIOptions/updateReportUIOptionIsCompareModeOnEpic.js

@@ -7,22 +7,18 @@ import { getFinanceStatement } from '../financeStatement/financeStatementSelecto
 import { updateNetBurnOrIncomeAdditionalBalancesSelection } from '../netBurnOrIncome/netBurnOrIncomeReducer';
 import { updateOpExAdditionalBalancesSelection } from '../opEx/opExReducer';
 import { updateRevenueAdditionalBalancesSelection } from '../revenue/revenueReducer';
+import { getFinanceStatementAdditionalBalances } from './financeStatementCompareBalances';
 import { toggleReportUIOptionForecastMode, updateReportUIOptionIsCompareModeOn, } from './reportUIOptionsReducer';
 export const updateReportUIOptionIsCompareModeOnEpic = (actions$, state) => actions$.pipe(filter(updateReportUIOptionIsCompareModeOn.match), switchMap((action) => {
     const { additionalBalances } = action.payload;
+    const compareBalanceFromMode = state.value.reportUIOptionsState.compareMode === 'compare_mode_percent'
+        ? 'this_period_vs_last_period_percent'
+        : 'this_period_vs_last_period';
     const additionalBalance = action.payload.isCompareModeOn
-        ? state.value.reportUIOptionsState.compareMode ===
-            'compare_mode_percent'
-            ? ['this_period_vs_last_period_percent']
-            : ['this_period_vs_last_period']
+        ? [compareBalanceFromMode]
         : [];
     const financeStatementState = getFinanceStatement(state.value);
-    const filteredFinanceAdditionalBalances = additionalBalances.filter((balance) => balance !== 'this_period_vs_last_period' &&
-        balance !== 'this_period_vs_last_period_percent');
-    const financeAdditionalBalances = [
-        ...filteredFinanceAdditionalBalances,
-        ...additionalBalance,
-    ];
+    const financeAdditionalBalances = getFinanceStatementAdditionalBalances(additionalBalances, action.payload.isCompareModeOn, compareBalanceFromMode);
     const actions = [
         updateNetBurnOrIncomeAdditionalBalancesSelection({
             isCompareModeOn: action.payload.isCompareModeOn,

package/lib/view/financeStatement/financeStatementReducer.js

@@ -3,6 +3,7 @@ var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.updateFinanceStatementFormat = exports.updateFinanceStatementDisplayOrder = exports.updateDownloadState = exports.updateFinanceStatementAdditionalBalancesSelection = exports.updateSelectedReportId = exports.updateCOABalancesRange = exports.updateFinanceStatementThisPeriod = exports.updateFinanceStatementTimeframe = exports.fetchFinanceStatement = exports.initialFinanceStatementState = void 0;
 const toolkit_1 = require("@reduxjs/toolkit");
+const coaBalanceType_1 = require("../../commonStateTypes/coaBalance/coaBalanceType");
 const thisPeriodHelpers_1 = require("../../commonStateTypes/viewAndReport/thisPeriodHelpers");
 const rootActions_1 = require("../../rootActions");
 const zeniDayJS_1 = require("../../zeniDayJS");
@@ -92,17 +93,11 @@ const financeStatement = (0, toolkit_1.createSlice)({
         updateFinanceStatementAdditionalBalancesSelection(draft, action) {
             const { additionalBalances: additionalBalancesPayload, maxNumOfPeriodsToHighlight, } = action.payload;
             const additionalBalances = additionalBalancesPayload ?? [];
-            let tempAdditionalBalances = [...additionalBalances];
-            if (additionalBalances.includes('this_period_vs_last_period') ||
-                additionalBalances.includes('this_period_vs_last_period_percent')) {
-                const id = tempAdditionalBalances.findIndex((balance) => balance === 'this_period_vs_last_period' ||
-                    balance === 'this_period_vs_last_period_percent');
-                if (id > -1) {
-                    const balance = tempAdditionalBalances.splice(id, 1);
-                    tempAdditionalBalances = [...balance, ...tempAdditionalBalances];
-                }
-            }
-            draft.selectedAdditionalBalances = tempAdditionalBalances;
+            const otherBalances = (0, coaBalanceType_1.stripCompareAdditionalBalanceTypes)(additionalBalances);
+            draft.selectedAdditionalBalances = [
+                ...additionalBalances.filter((balance) => !otherBalances.includes(balance)),
+                ...otherBalances,
+            ];
             draft.maxNumOfPeriodsToHighlight = maxNumOfPeriodsToHighlight;
             draft.isAdditionalBalancesShown =
                 additionalBalances.length != 0 ? true : false;

package/lib/view/reportUIOptions/financeStatementCompareBalances.d.ts

@@ -0,0 +1,2 @@
+import { COABalanceType } from '../../commonStateTypes/coaBalance/coaBalanceType';
+export declare function getFinanceStatementAdditionalBalances(requestedBalances: COABalanceType[], isCompareModeOn: boolean, compareBalanceFromMode: COABalanceType): COABalanceType[];

package/lib/view/reportUIOptions/financeStatementCompareBalances.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getFinanceStatementAdditionalBalances = getFinanceStatementAdditionalBalances;
+const coaBalanceType_1 = require("../../commonStateTypes/coaBalance/coaBalanceType");
+// Reports can show the $ and % change columns together, so every requested compare type is kept;
+// compareMode picks one only when none was requested.
+function getFinanceStatementAdditionalBalances(requestedBalances, isCompareModeOn, compareBalanceFromMode) {
+    const otherBalances = (0, coaBalanceType_1.stripCompareAdditionalBalanceTypes)(requestedBalances);
+    if (!isCompareModeOn) {
+        return otherBalances;
+    }
+    const requestedCompareBalances = requestedBalances.filter((balance) => !otherBalances.includes(balance));
+    return [
+        ...otherBalances,
+        ...(requestedCompareBalances.length > 0
+            ? requestedCompareBalances
+            : [compareBalanceFromMode]),
+    ];
+}

package/lib/view/reportUIOptions/updateReportUIOptionCompareModeEpic.js

@@ -10,6 +10,7 @@ const financeStatementSelector_1 = require("../financeStatement/financeStatement
 const netBurnOrIncomeReducer_1 = require("../netBurnOrIncome/netBurnOrIncomeReducer");
 const opExReducer_1 = require("../opEx/opExReducer");
 const revenueReducer_1 = require("../revenue/revenueReducer");
+const financeStatementCompareBalances_1 = require("./financeStatementCompareBalances");
 const reportUIOptionsReducer_1 = require("./reportUIOptionsReducer");
 const updateReportUIOptionIsCompareModeEpic = (actions$, state) => actions$.pipe((0, operators_1.filter)(reportUIOptionsReducer_1.updateReportUIOptionCompareMode.match), (0, operators_1.switchMap)((action) => {
     const { additionalBalances } = action.payload;
@@ -18,11 +19,7 @@ const updateReportUIOptionIsCompareModeEpic = (actions$, state) => actions$.pipe
         ? 'this_period_vs_last_period_percent'
         : 'this_period_vs_last_period';
     const financeStatementState = (0, financeStatementSelector_1.getFinanceStatement)(state.value);
-    const filteredFinanceAdditionalBalances = additionalBalances.filter((balance) => balance !== 'this_period_vs_last_period' &&
-        balance !== 'this_period_vs_last_period_percent');
-    const financeAdditionalBalances = isCompareModeOn
-        ? [...filteredFinanceAdditionalBalances, additionalBalance]
-        : filteredFinanceAdditionalBalances;
+    const financeAdditionalBalances = (0, financeStatementCompareBalances_1.getFinanceStatementAdditionalBalances)(additionalBalances, isCompareModeOn, additionalBalance);
     return (0, rxjs_1.of)((0, netBurnOrIncomeReducer_1.updateNetBurnOrIncomeAdditionalBalancesSelection)({
         isCompareModeOn,
         additionalBalances: isCompareModeOn ? [additionalBalance] : [],

package/lib/view/reportUIOptions/updateReportUIOptionIsCompareModeOnEpic.js

@@ -10,22 +10,18 @@ const financeStatementSelector_1 = require("../financeStatement/financeStatement
 const netBurnOrIncomeReducer_1 = require("../netBurnOrIncome/netBurnOrIncomeReducer");
 const opExReducer_1 = require("../opEx/opExReducer");
 const revenueReducer_1 = require("../revenue/revenueReducer");
+const financeStatementCompareBalances_1 = require("./financeStatementCompareBalances");
 const reportUIOptionsReducer_1 = require("./reportUIOptionsReducer");
 const updateReportUIOptionIsCompareModeOnEpic = (actions$, state) => actions$.pipe((0, operators_1.filter)(reportUIOptionsReducer_1.updateReportUIOptionIsCompareModeOn.match), (0, operators_1.switchMap)((action) => {
     const { additionalBalances } = action.payload;
+    const compareBalanceFromMode = state.value.reportUIOptionsState.compareMode === 'compare_mode_percent'
+        ? 'this_period_vs_last_period_percent'
+        : 'this_period_vs_last_period';
     const additionalBalance = action.payload.isCompareModeOn
-        ? state.value.reportUIOptionsState.compareMode ===
-            'compare_mode_percent'
-            ? ['this_period_vs_last_period_percent']
-            : ['this_period_vs_last_period']
+        ? [compareBalanceFromMode]
         : [];
     const financeStatementState = (0, financeStatementSelector_1.getFinanceStatement)(state.value);
-    const filteredFinanceAdditionalBalances = additionalBalances.filter((balance) => balance !== 'this_period_vs_last_period' &&
-        balance !== 'this_period_vs_last_period_percent');
-    const financeAdditionalBalances = [
-        ...filteredFinanceAdditionalBalances,
-        ...additionalBalance,
-    ];
+    const financeAdditionalBalances = (0, financeStatementCompareBalances_1.getFinanceStatementAdditionalBalances)(additionalBalances, action.payload.isCompareModeOn, compareBalanceFromMode);
     const actions = [
         (0, netBurnOrIncomeReducer_1.updateNetBurnOrIncomeAdditionalBalancesSelection)({
             isCompareModeOn: action.payload.isCompareModeOn,

package/package.json

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