@zeniai/client-epic-state 5.0.46 → 5.0.47

package/lib/view/transactionList/transactionListReducer.js

@@ -1,7 +1,7 @@
 "use strict";
 var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.updateLatestTransactionId = exports.clearTransactionList = exports.updateTransactionListUIStateByCategoryType = exports.updateTransactionsListByCategoryTypeFailure = exports.updateTransactionListByCategoryType = exports.fetchTransactionsListByCategoryType = exports.parallelFetchTransactionListByCategoryType = exports.updateTransactionListByClassFailure = exports.updateTransactionListByClassUIState = exports.updateTransactionListByClass = exports.fetchClassTransactionList = exports.parallelFetchClassTransactionList = exports.updateTransactionListByAccountUIState = exports.updateTransactionListByEntityFailure = exports.updateTransactionListByEntity = exports.fetchEntityTransactionList = exports.parallelFetchEntityTransactionList = exports.updateTransactionListByAccountFailure = exports.updateTransactionListByAccount = exports.fetchAccountTransactionList = exports.parallelFetchAccountTransactionList = exports.initialState = void 0;
+exports.updateLatestTransactionId = exports.clearTransactionList = exports.updateTransactionListUIStateByCategoryType = exports.updateTransactionsListByCategoryTypeFailure = exports.updateTransactionListByCategoryType = exports.fetchTransactionsListByCategoryType = exports.parallelFetchTransactionListByCategoryType = exports.updateTransactionListByProjectFailure = exports.updateTransactionListByProjectUIState = exports.updateTransactionListByProject = exports.fetchProjectTransactionList = exports.parallelFetchProjectTransactionList = exports.updateTransactionListByClassFailure = exports.updateTransactionListByClassUIState = exports.updateTransactionListByClass = exports.fetchClassTransactionList = exports.parallelFetchClassTransactionList = exports.updateTransactionListByAccountUIState = exports.updateTransactionListByEntityFailure = exports.updateTransactionListByEntity = exports.fetchEntityTransactionList = exports.parallelFetchEntityTransactionList = exports.updateTransactionListByAccountFailure = exports.updateTransactionListByAccount = exports.fetchAccountTransactionList = exports.parallelFetchAccountTransactionList = exports.initialState = void 0;
 const toolkit_1 = require("@reduxjs/toolkit");
 const timePeriod_1 = require("../../commonStateTypes/timePeriod");
 const accountPayload_1 = require("../../entity/account/accountPayload");
@@ -41,6 +41,10 @@ exports.initialState = {
         transactionListByClassKey: {},
         transactionListUIStateByClassKey: {},
     },
+    byProject: {
+        transactionListByProjectKey: {},
+        transactionListUIStateByProjectKey: {},
+    },
 };
 const transactionList = (0, toolkit_1.createSlice)({
     name: 'transactionList',
@@ -250,6 +254,64 @@ const transactionList = (0, toolkit_1.createSlice)({
                 return { payload: { accountId, accountType, classId, period, error } };
             },
         },
+        // Transaction list by project related reducers
+        //
+        // Mirrors the by-class set; the only behavioural difference is that the
+        // server query param is `zeni_project_id` (post-Ayon's accounting #3984
+        // rename) and there's no equivalent of `include_sub_class_transactions`
+        // — projects don't have a sub-project hierarchy in this layout yet.
+        parallelFetchProjectTransactionList: {
+            reducer() {
+                // Do nothing..
+            },
+            prepare(accountId, accountType, projectId, period, cacheOverride = false) {
+                return {
+                    payload: { accountId, accountType, projectId, period, cacheOverride },
+                };
+            },
+        },
+        fetchProjectTransactionList: {
+            reducer(draft, action) {
+                const key = (0, transactionListState_1.getProjectAcTranKey)(action.payload.accountId, action.payload.accountType, action.payload.projectId, action.payload.period);
+                if (action.payload.cacheOverride === true ||
+                    draft.byProject.transactionListByProjectKey[key] == null ||
+                    (draft.byProject.transactionListByProjectKey[key]?.hasValidState() ===
+                        false &&
+                        draft.byProject.transactionListByProjectKey[key]?.fetchState !=
+                            'In-Progress')) {
+                    draft.byProject.transactionListByProjectKey[key] = {
+                        ...transactionListState_1.initialProjectTransactionState,
+                        fetchState: 'In-Progress',
+                        error: undefined,
+                    };
+                }
+            },
+            prepare(accountId, accountType, projectId, period, cacheOverride = false) {
+                return {
+                    payload: { accountId, accountType, projectId, period, cacheOverride },
+                };
+            },
+        },
+        updateTransactionListByProject(draft, action) {
+            doUpdateTransactionListByProject(draft.byProject.transactionListByProjectKey, action.payload);
+        },
+        updateTransactionListByProjectUIState(draft, action) {
+            const key = (0, transactionListState_1.getProjectAcKey)(action.payload.accountId, action.payload.accountType, action.payload.projectId);
+            draft.byProject.transactionListUIStateByProjectKey[key] = Object.assign({}, draft.byProject.transactionListUIStateByProjectKey[key], action.payload.uiState);
+        },
+        updateTransactionListByProjectFailure: {
+            reducer(draft, action) {
+                const key = (0, transactionListState_1.getProjectAcTranKey)(action.payload.accountId, action.payload.accountType, action.payload.projectId, action.payload.period);
+                draft.byProject.transactionListByProjectKey[key] = {
+                    ...transactionListState_1.initialProjectTransactionState,
+                    fetchState: 'Error',
+                    error: action.payload.error,
+                };
+            },
+            prepare(accountId, accountType, projectId, period, error) {
+                return { payload: { accountId, accountType, projectId, period, error } };
+            },
+        },
         parallelFetchTransactionListByCategoryType: {
             reducer() {
                 // Do nothing..
@@ -344,7 +406,7 @@ const transactionList = (0, toolkit_1.createSlice)({
         },
     },
 });
-_a = transactionList.actions, exports.parallelFetchAccountTransactionList = _a.parallelFetchAccountTransactionList, exports.fetchAccountTransactionList = _a.fetchAccountTransactionList, exports.updateTransactionListByAccount = _a.updateTransactionListByAccount, exports.updateTransactionListByAccountFailure = _a.updateTransactionListByAccountFailure, exports.parallelFetchEntityTransactionList = _a.parallelFetchEntityTransactionList, exports.fetchEntityTransactionList = _a.fetchEntityTransactionList, exports.updateTransactionListByEntity = _a.updateTransactionListByEntity, exports.updateTransactionListByEntityFailure = _a.updateTransactionListByEntityFailure, exports.updateTransactionListByAccountUIState = _a.updateTransactionListByAccountUIState, exports.parallelFetchClassTransactionList = _a.parallelFetchClassTransactionList, exports.fetchClassTransactionList = _a.fetchClassTransactionList, exports.updateTransactionListByClass = _a.updateTransactionListByClass, exports.updateTransactionListByClassUIState = _a.updateTransactionListByClassUIState, exports.updateTransactionListByClassFailure = _a.updateTransactionListByClassFailure, exports.parallelFetchTransactionListByCategoryType = _a.parallelFetchTransactionListByCategoryType, exports.fetchTransactionsListByCategoryType = _a.fetchTransactionsListByCategoryType, exports.updateTransactionListByCategoryType = _a.updateTransactionListByCategoryType, exports.updateTransactionsListByCategoryTypeFailure = _a.updateTransactionsListByCategoryTypeFailure, exports.updateTransactionListUIStateByCategoryType = _a.updateTransactionListUIStateByCategoryType, exports.clearTransactionList = _a.clearTransactionList, exports.updateLatestTransactionId = _a.updateLatestTransactionId;
+_a = transactionList.actions, exports.parallelFetchAccountTransactionList = _a.parallelFetchAccountTransactionList, exports.fetchAccountTransactionList = _a.fetchAccountTransactionList, exports.updateTransactionListByAccount = _a.updateTransactionListByAccount, exports.updateTransactionListByAccountFailure = _a.updateTransactionListByAccountFailure, exports.parallelFetchEntityTransactionList = _a.parallelFetchEntityTransactionList, exports.fetchEntityTransactionList = _a.fetchEntityTransactionList, exports.updateTransactionListByEntity = _a.updateTransactionListByEntity, exports.updateTransactionListByEntityFailure = _a.updateTransactionListByEntityFailure, exports.updateTransactionListByAccountUIState = _a.updateTransactionListByAccountUIState, exports.parallelFetchClassTransactionList = _a.parallelFetchClassTransactionList, exports.fetchClassTransactionList = _a.fetchClassTransactionList, exports.updateTransactionListByClass = _a.updateTransactionListByClass, exports.updateTransactionListByClassUIState = _a.updateTransactionListByClassUIState, exports.updateTransactionListByClassFailure = _a.updateTransactionListByClassFailure, exports.parallelFetchProjectTransactionList = _a.parallelFetchProjectTransactionList, exports.fetchProjectTransactionList = _a.fetchProjectTransactionList, exports.updateTransactionListByProject = _a.updateTransactionListByProject, exports.updateTransactionListByProjectUIState = _a.updateTransactionListByProjectUIState, exports.updateTransactionListByProjectFailure = _a.updateTransactionListByProjectFailure, exports.parallelFetchTransactionListByCategoryType = _a.parallelFetchTransactionListByCategoryType, exports.fetchTransactionsListByCategoryType = _a.fetchTransactionsListByCategoryType, exports.updateTransactionListByCategoryType = _a.updateTransactionListByCategoryType, exports.updateTransactionsListByCategoryTypeFailure = _a.updateTransactionsListByCategoryTypeFailure, exports.updateTransactionListUIStateByCategoryType = _a.updateTransactionListUIStateByCategoryType, exports.clearTransactionList = _a.clearTransactionList, exports.updateLatestTransactionId = _a.updateLatestTransactionId;
 exports.default = transactionList.reducer;
 /**
  * Helper functions
@@ -394,3 +456,22 @@ function doUpdateTransactionListByClass(draft, payload) {
         transactionIDs,
     };
 }
+function doUpdateTransactionListByProject(draft, payload) {
+    const transactionIDs = payload.account.transactions.map((transactionPaylod) => transactionPaylod.transaction_id);
+    const account = (0, accountPayload_1.mapAccountBasePayloadToAccountBase)(payload.account);
+    const projectId = payload.query.zeni_project_id;
+    const start = (0, timePeriod_1.toAbsoluteDay)(payload.query.start_date);
+    const end = (0, timePeriod_1.toAbsoluteDay)(payload.query.end_date);
+    const key = (0, transactionListState_1.getProjectAcTranKey)(account.accountId, account.accountType, projectId, {
+        start,
+        end,
+    });
+    draft[key] = {
+        ...transactionListState_1.initialProjectTransactionState,
+        fetchState: 'Completed',
+        error: undefined,
+        account: account,
+        projectId: projectId,
+        transactionIDs,
+    };
+}

package/lib/view/transactionList/transactionListState.d.ts

@@ -45,6 +45,20 @@ export interface TransactionListByClassState {
     transactionListUIStateByClassKey: Record<ClassAcKey, TransactionListUIState>;
 }
 export declare const initialClassTransactionState: ClassAccountTransactions;
+export declare const getProjectAcTranKey: (accountId: ID, accountType: AccountType, projectId: ID, period: TimePeriod) => string;
+export type ProjectAcTranKey = ReturnType<typeof getProjectAcTranKey>;
+export declare const getProjectAcKey: (accountId: ID, accountType: AccountType, projectId: ID) => string;
+type ProjectAcKey = ReturnType<typeof getProjectAcKey>;
+export interface ProjectAccountTransactions extends FetchedState {
+    transactionIDs: ID[];
+    account?: AccountBase;
+    projectId?: ID;
+}
+export interface TransactionListByProjectState {
+    transactionListByProjectKey: Record<ProjectAcTranKey, ProjectAccountTransactions>;
+    transactionListUIStateByProjectKey: Record<ProjectAcKey, TransactionListUIState>;
+}
+export declare const initialProjectTransactionState: ProjectAccountTransactions;
 export type TransactionCategoryType = 'missingReceipts' | 'miscategorizedExpense' | 'miscategorizedIncome' | 'uncategorizedIncome' | 'uncategorizedExpense';
 export declare const getCategoryTypeTranKey: (categoryType: TransactionCategoryType, period: TimePeriod) => string;
 type CategoryTypeTranKey = ReturnType<typeof getCategoryTypeTranKey>;
@@ -59,6 +73,7 @@ export interface TransactionListState {
     byAccount: TransactionListByAccountState;
     byClass: TransactionListByClassState;
     byEntity: TransactionListByEntityState;
+    byProject: TransactionListByProjectState;
     byType: Record<TransactionCategoryType, TransactionListByCategoryState>;
     latestTransactionId?: TransactionID;
 }

package/lib/view/transactionList/transactionListState.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.initialTransactionsStateByCategoryType = exports.getCategoryTypeTranKey = exports.initialClassTransactionState = exports.getClassAcKey = exports.getClassAcTranKey = exports.initialEntityTransactionState = exports.getEntityTranKey = exports.accountTransactionsInitialState = exports.getAcKey = exports.getAcTranKey = void 0;
+exports.initialTransactionsStateByCategoryType = exports.getCategoryTypeTranKey = exports.initialProjectTransactionState = exports.getProjectAcKey = exports.getProjectAcTranKey = exports.initialClassTransactionState = exports.getClassAcKey = exports.getClassAcTranKey = exports.initialEntityTransactionState = exports.getEntityTranKey = exports.accountTransactionsInitialState = exports.getAcKey = exports.getAcTranKey = void 0;
 const getAcTranKey = (accountId, accountType, period) => `${accountId}-${accountType}-${period.start.day}_${period.start.month}_${period.start.year}_${period.end.day}_${period.end.month}_${period.end.year}`;
 exports.getAcTranKey = getAcTranKey;
 const getAcKey = (accountId, accountType) => `${accountId}-${accountType}`;
@@ -38,6 +38,18 @@ exports.initialClassTransactionState = {
         return this.fetchState == 'Completed';
     },
 };
+const getProjectAcTranKey = (accountId, accountType, projectId, period) => `${accountId}-${accountType}-${projectId}-${period.start.day}_${period.start.month}_${period.start.year}_${period.end.day}_${period.end.month}_${period.end.year}`;
+exports.getProjectAcTranKey = getProjectAcTranKey;
+const getProjectAcKey = (accountId, accountType, projectId) => `${accountId}-${accountType}-${projectId}`;
+exports.getProjectAcKey = getProjectAcKey;
+exports.initialProjectTransactionState = {
+    transactionIDs: [],
+    fetchState: 'Not-Started',
+    error: undefined,
+    hasValidState() {
+        return this.fetchState == 'Completed';
+    },
+};
 const getCategoryTypeTranKey = (categoryType, period) => `${categoryType}_${period.start.day}_${period.start.month}_${period.start.year}_${period.end.day}_${period.end.month}_${period.end.year}`;
 exports.getCategoryTypeTranKey = getCategoryTypeTranKey;
 exports.initialTransactionsStateByCategoryType = {

package/package.json

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