@zeniai/client-epic-state 5.2.59-beta0ND → 5.2.60

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (27) hide show
  1. package/lib/entity/snackbar/snackbarTypes.d.ts +1 -1
  2. package/lib/entity/snackbar/snackbarTypes.js +1 -0
  3. package/lib/esm/entity/snackbar/snackbarTypes.js +1 -0
  4. package/lib/esm/index.js +2 -1
  5. package/lib/esm/view/invoicing/editInvoicingSubscriptionDetailView/editInvoicingSubscriptionDetailViewSelector.js +106 -6
  6. package/lib/esm/view/invoicing/invoicingCatalogListView/invoicingCatalogListViewSelector.js +12 -0
  7. package/lib/esm/view/recommendation/recommendationPayload.js +3 -1
  8. package/lib/esm/view/recommendation/recommendationReducer.js +27 -7
  9. package/lib/esm/view/recommendation/recommendationSelector.js +1 -0
  10. package/lib/esm/view/recommendation/submitRecommendationFeedbackEpic.js +20 -8
  11. package/lib/index.d.ts +3 -2
  12. package/lib/index.js +26 -24
  13. package/lib/view/expenseAutomationView/helpers/transactionCategorizationLocalDataHelper.d.ts +1 -1
  14. package/lib/view/invoicing/editInvoicingSubscriptionDetailView/editInvoicingSubscriptionDetailViewSelector.d.ts +64 -13
  15. package/lib/view/invoicing/editInvoicingSubscriptionDetailView/editInvoicingSubscriptionDetailViewSelector.js +108 -7
  16. package/lib/view/invoicing/invoicingCatalogListView/invoicingCatalogListViewSelector.d.ts +10 -0
  17. package/lib/view/invoicing/invoicingCatalogListView/invoicingCatalogListViewSelector.js +12 -0
  18. package/lib/view/recommendation/recommendationPayload.d.ts +1 -0
  19. package/lib/view/recommendation/recommendationPayload.js +5 -0
  20. package/lib/view/recommendation/recommendationReducer.d.ts +7 -1
  21. package/lib/view/recommendation/recommendationReducer.js +28 -8
  22. package/lib/view/recommendation/recommendationSelector.d.ts +2 -0
  23. package/lib/view/recommendation/recommendationSelector.js +3 -1
  24. package/lib/view/recommendation/recommendationState.d.ts +2 -1
  25. package/lib/view/recommendation/submitRecommendationFeedbackEpic.d.ts +2 -2
  26. package/lib/view/recommendation/submitRecommendationFeedbackEpic.js +18 -6
  27. package/package.json +26 -1
@@ -5,8 +5,20 @@ const toolkit_1 = require("@reduxjs/toolkit");
5
5
  const planSelector_1 = require("../../../entity/invoicing/plan/planSelector");
6
6
  const runningInvoicingActionId_1 = require("../runningInvoicingActionId");
7
7
  const invoicingCatalogListViewState_1 = require("./invoicingCatalogListViewState");
8
+ /**
9
+ * Flatten catalog items into the price rows the pickers render.
10
+ *
11
+ * The parent item's `applicableItems` / `itemApplicability` are carried onto
12
+ * every row it produces: applicability is a property of the catalog item, not
13
+ * of its price points, and a row that has lost it cannot be matched against the
14
+ * selected plan's allow-list (see `getInvoicingItemsAllowedForPlan`). Both are
15
+ * written after the spread so the item's own rule wins over any stale copy a
16
+ * price point payload may carry.
17
+ */
8
18
  const getInvoicingCatalogPrices = (items) => items.flatMap((item) => (item.subFamilies ?? []).map((subFamily) => ({
9
19
  ...subFamily,
20
+ applicableItems: item.applicableItems,
21
+ itemApplicability: item.itemApplicability,
10
22
  itemID: item.id,
11
23
  itemType: item.type ?? item.itemType,
12
24
  name: subFamily.name,
@@ -15,6 +15,7 @@ export type FetchRecommendationResponseWithCOT = ZeniAPIResponse<FetchRecommenda
15
15
  export type RecommendationFeedbackDimension = 'vendor' | 'category' | 'class';
16
16
  export type RecommendationFeedbackSource = 'primary' | 'alternate' | 'shadow' | 'qbo';
17
17
  export type RecommendationFeedbackOutcome = 'accepted' | 'override_ranked' | 'override_outside' | 'retracted';
18
+ export declare const isPromptedRecommendationFeedback: (outcome: RecommendationFeedbackOutcome) => boolean;
18
19
  export interface RecommendationFeedbackValue {
19
20
  name: string;
20
21
  id?: string | null;
@@ -1,2 +1,7 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.isPromptedRecommendationFeedback = void 0;
4
+ // Only an override opens the feedback popup. Silent accepts and retractions post
5
+ // in the background, so they must not drive the popup's loader or its toast.
6
+ const isPromptedRecommendationFeedback = (outcome) => outcome === 'override_outside' || outcome === 'override_ranked';
7
+ exports.isPromptedRecommendationFeedback = isPromptedRecommendationFeedback;
@@ -58,6 +58,12 @@ export declare const fetchEntityRecommendationsByTransactionId: import("@reduxjs
58
58
  }, "recommendation/updateRecommendationForEntityFailure">, indicateReadyToInitializeRecommendation: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[entityIdOrName: string, entityType: EntityType], {
59
59
  entityIdOrName: string;
60
60
  entityType: EntityType;
61
- }, "recommendation/indicateReadyToInitializeRecommendation", never, never>, submitRecommendationFeedback: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[args: SubmitRecommendationFeedbackPayload], SubmitRecommendationFeedbackPayload, "recommendation/submitRecommendationFeedback", never, never>;
61
+ }, "recommendation/indicateReadyToInitializeRecommendation", never, never>, submitRecommendationFeedback: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[args: SubmitRecommendationFeedbackPayload], SubmitRecommendationFeedbackPayload, "recommendation/submitRecommendationFeedback", never, never>, submitRecommendationFeedbackCompleted: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[args: {
62
+ succeeded: boolean;
63
+ error?: ZeniAPIStatus;
64
+ }], {
65
+ succeeded: boolean;
66
+ error?: ZeniAPIStatus;
67
+ }, "recommendation/submitRecommendationFeedbackCompleted", never, never>;
62
68
  declare const _default: import("redux").Reducer<EntityRecommendationState>;
63
69
  export default _default;
@@ -1,11 +1,13 @@
1
1
  "use strict";
2
2
  var _a;
3
3
  Object.defineProperty(exports, "__esModule", { value: true });
4
- exports.submitRecommendationFeedback = exports.indicateReadyToInitializeRecommendation = exports.updateRecommendationForEntityFailure = exports.updateRecommendationForEntity = exports.fetchRecommendationByEntityId = exports.fetchRecommendationByEntityName = exports.fetchEntityRecommendationsForLineUpdate = exports.fetchEntityRecommendationsByTransactionId = exports.initialState = void 0;
4
+ exports.submitRecommendationFeedbackCompleted = exports.submitRecommendationFeedback = exports.indicateReadyToInitializeRecommendation = exports.updateRecommendationForEntityFailure = exports.updateRecommendationForEntity = exports.fetchRecommendationByEntityId = exports.fetchRecommendationByEntityName = exports.fetchEntityRecommendationsForLineUpdate = exports.fetchEntityRecommendationsByTransactionId = exports.initialState = void 0;
5
5
  const toolkit_1 = require("@reduxjs/toolkit");
6
6
  const rootActions_1 = require("../../rootActions");
7
+ const recommendationPayload_1 = require("./recommendationPayload");
7
8
  const recommendationState_1 = require("./recommendationState");
8
9
  exports.initialState = {
10
+ feedbackSubmitState: { fetchState: 'Not-Started', error: undefined },
9
11
  recommendationByEntity: {},
10
12
  };
11
13
  const recommendation = (0, toolkit_1.createSlice)({
@@ -135,13 +137,31 @@ const recommendation = (0, toolkit_1.createSlice)({
135
137
  };
136
138
  },
137
139
  },
138
- // Fire-and-forget human feedback on a recommendation (accept, ranked
139
- // override or outside override). Handled by submitRecommendationFeedbackEpic
140
- // which POSTs to the accounting recommendation-feedback endpoint. No state
141
- // mutation: the categorization UX must not depend on the feedback round-trip.
140
+ // Human feedback on a recommendation (accept, ranked override or outside
141
+ // override). Handled by submitRecommendationFeedbackEpic, which POSTs to the
142
+ // accounting recommendation-feedback endpoint. The categorization itself
143
+ // never waits on this: only the feedback popup reads the submit state.
142
144
  submitRecommendationFeedback: {
143
- reducer() {
144
- // Fire-and-forget: no state mutation; the epic performs the POST.
145
+ reducer(draft, action) {
146
+ if (!(0, recommendationPayload_1.isPromptedRecommendationFeedback)(action.payload.outcome)) {
147
+ return;
148
+ }
149
+ draft.feedbackSubmitState = {
150
+ fetchState: 'In-Progress',
151
+ error: undefined,
152
+ };
153
+ },
154
+ prepare(args) {
155
+ return { payload: args };
156
+ },
157
+ },
158
+ submitRecommendationFeedbackCompleted: {
159
+ reducer(draft, action) {
160
+ const { succeeded, error } = action.payload;
161
+ draft.feedbackSubmitState = {
162
+ fetchState: succeeded ? 'Completed' : 'Error',
163
+ error,
164
+ };
145
165
  },
146
166
  prepare(args) {
147
167
  return { payload: args };
@@ -154,7 +174,7 @@ const recommendation = (0, toolkit_1.createSlice)({
154
174
  });
155
175
  },
156
176
  });
157
- _a = recommendation.actions, exports.fetchEntityRecommendationsByTransactionId = _a.fetchEntityRecommendationsByTransactionId, exports.fetchEntityRecommendationsForLineUpdate = _a.fetchEntityRecommendationsForLineUpdate, exports.fetchRecommendationByEntityName = _a.fetchRecommendationByEntityName, exports.fetchRecommendationByEntityId = _a.fetchRecommendationByEntityId, exports.updateRecommendationForEntity = _a.updateRecommendationForEntity, exports.updateRecommendationForEntityFailure = _a.updateRecommendationForEntityFailure, exports.indicateReadyToInitializeRecommendation = _a.indicateReadyToInitializeRecommendation, exports.submitRecommendationFeedback = _a.submitRecommendationFeedback;
177
+ _a = recommendation.actions, exports.fetchEntityRecommendationsByTransactionId = _a.fetchEntityRecommendationsByTransactionId, exports.fetchEntityRecommendationsForLineUpdate = _a.fetchEntityRecommendationsForLineUpdate, exports.fetchRecommendationByEntityName = _a.fetchRecommendationByEntityName, exports.fetchRecommendationByEntityId = _a.fetchRecommendationByEntityId, exports.updateRecommendationForEntity = _a.updateRecommendationForEntity, exports.updateRecommendationForEntityFailure = _a.updateRecommendationForEntityFailure, exports.indicateReadyToInitializeRecommendation = _a.indicateReadyToInitializeRecommendation, exports.submitRecommendationFeedback = _a.submitRecommendationFeedback, exports.submitRecommendationFeedbackCompleted = _a.submitRecommendationFeedbackCompleted;
158
178
  exports.default = recommendation.reducer;
159
179
  const doUpdateRecommendationForEntity = (draft, entityId, entityType, payload) => {
160
180
  const key = (0, recommendationState_1.getEntityRecommendationKey)(entityType, entityId);
@@ -1,3 +1,4 @@
1
+ import { FetchStateAndError } from '../../commonStateTypes/common';
1
2
  import { Recommendation } from '../../commonStateTypes/recommendationBase';
2
3
  import { SelectorView } from '../../commonStateTypes/viewAndReport/viewAndReport';
3
4
  import { EntityType } from '../../entity/genericEntity/entity';
@@ -8,3 +9,4 @@ export interface RecommendationByEntitySelectorView extends SelectorView {
8
9
  recommendations?: Recommendation[];
9
10
  }
10
11
  export declare const getRecommendationsForEntity: (state: RootState, entityId: string, entityType: EntityType) => RecommendationByEntitySelectorView;
12
+ export declare const getRecommendationFeedbackSubmitState: (state: RootState) => FetchStateAndError;
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.getRecommendationsForEntity = void 0;
3
+ exports.getRecommendationFeedbackSubmitState = exports.getRecommendationsForEntity = void 0;
4
4
  const recommendationState_1 = require("./recommendationState");
5
5
  const getRecommendationsForEntity = (state, entityId, entityType) => {
6
6
  const { entityRecommendationState } = state;
@@ -15,3 +15,5 @@ const getRecommendationsForEntity = (state, entityId, entityType) => {
15
15
  };
16
16
  };
17
17
  exports.getRecommendationsForEntity = getRecommendationsForEntity;
18
+ const getRecommendationFeedbackSubmitState = (state) => state.entityRecommendationState.feedbackSubmitState;
19
+ exports.getRecommendationFeedbackSubmitState = getRecommendationFeedbackSubmitState;
@@ -1,4 +1,4 @@
1
- import { FetchedState } from '../../commonStateTypes/common';
1
+ import { FetchStateAndError, FetchedState } from '../../commonStateTypes/common';
2
2
  import { Recommendation } from '../../commonStateTypes/recommendationBase';
3
3
  import { EntityType } from '../../entity/genericEntity/entity';
4
4
  export declare const getEntityRecommendationKey: (entityType: EntityType, entityIdOrName: string) => `vendor_${string}` | `customer_${string}` | `merchant_${string}`;
@@ -8,5 +8,6 @@ export interface EntityRecommendationsStatus extends FetchedState {
8
8
  }
9
9
  export declare const initialEntityRecommendationState: EntityRecommendationsStatus;
10
10
  export interface EntityRecommendationState {
11
+ feedbackSubmitState: FetchStateAndError;
11
12
  recommendationByEntity: Record<EntityRecommendationKey, EntityRecommendationsStatus>;
12
13
  }
@@ -2,6 +2,6 @@ import { ActionsObservable, StateObservable } from 'redux-observable';
2
2
  import { Observable } from 'rxjs';
3
3
  import { RootState } from '../../reducer';
4
4
  import { ZeniAPI } from '../../zeniAPI';
5
- import { submitRecommendationFeedback } from './recommendationReducer';
6
- export type ActionType = ReturnType<typeof submitRecommendationFeedback>;
5
+ import { submitRecommendationFeedback, submitRecommendationFeedbackCompleted } from './recommendationReducer';
6
+ export type ActionType = ReturnType<typeof submitRecommendationFeedback> | ReturnType<typeof submitRecommendationFeedbackCompleted>;
7
7
  export declare const submitRecommendationFeedbackEpic: (actions$: ActionsObservable<ActionType>, _state$: StateObservable<RootState>, zeniAPI: ZeniAPI) => Observable<ActionType>;
@@ -4,6 +4,7 @@ exports.submitRecommendationFeedbackEpic = void 0;
4
4
  const rxjs_1 = require("rxjs");
5
5
  const operators_1 = require("rxjs/operators");
6
6
  const responsePayload_1 = require("../../responsePayload");
7
+ const recommendationPayload_1 = require("./recommendationPayload");
7
8
  const recommendationReducer_1 = require("./recommendationReducer");
8
9
  const toRequestBody = (payload) => ({
9
10
  line_id: payload.lineId ?? null,
@@ -36,21 +37,32 @@ const toRequestBody = (payload) => ({
36
37
  retracts_feedback_id: payload.retractsFeedbackId ?? null,
37
38
  features: payload.features ?? null,
38
39
  });
39
- // Fire-and-forget: the epic never re-emits an action. Feedback delivery is a
40
- // side-effect that must not disrupt the categorization UX, so both the
41
- // success and error paths complete silently (errors are logged for debugging).
40
+ // Always reports completion so the feedback popup can show a loader and tell the
41
+ // user what happened. The categorization itself still never waits on this: a
42
+ // failure is surfaced in a toast rather than blocking or reverting the change.
42
43
  const submitRecommendationFeedbackEpic = (actions$, _state$, zeniAPI) => actions$.pipe((0, operators_1.filter)(recommendationReducer_1.submitRecommendationFeedback.match), (0, operators_1.mergeMap)((action) => {
43
44
  const { transactionId } = action.payload;
45
+ // Only the override that opened the popup reports completion; accepts and
46
+ // retractions stay fire-and-forget so they cannot settle the popup.
47
+ const isPrompted = (0, recommendationPayload_1.isPromptedRecommendationFeedback)(action.payload.outcome);
44
48
  return zeniAPI
45
49
  .postAndGetJSON(`${zeniAPI.apiEndPoints.accountMicroServiceBaseUrl}/1.0/transactions/${transactionId}/recommendation-feedback`, toRequestBody(action.payload))
46
50
  .pipe((0, operators_1.mergeMap)((response) => {
47
- if (!(0, responsePayload_1.isSuccessStatus)(response)) {
51
+ const succeeded = (0, responsePayload_1.isSuccessStatus)(response);
52
+ if (!succeeded) {
48
53
  console.error('submitRecommendationFeedbackEpic: recommendation feedback was not recorded', response.status);
49
54
  }
50
- return rxjs_1.EMPTY;
55
+ return isPrompted
56
+ ? (0, rxjs_1.of)((0, recommendationReducer_1.submitRecommendationFeedbackCompleted)({
57
+ succeeded,
58
+ error: succeeded ? undefined : response.status,
59
+ }))
60
+ : rxjs_1.EMPTY;
51
61
  }), (0, operators_1.catchError)((error) => {
52
62
  console.error('submitRecommendationFeedbackEpic: failed to submit recommendation feedback', error);
53
- return rxjs_1.EMPTY;
63
+ return isPrompted
64
+ ? (0, rxjs_1.of)((0, recommendationReducer_1.submitRecommendationFeedbackCompleted)({ succeeded: false }))
65
+ : rxjs_1.EMPTY;
54
66
  }));
55
67
  }));
56
68
  exports.submitRecommendationFeedbackEpic = submitRecommendationFeedbackEpic;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@zeniai/client-epic-state",
3
- "version": "5.2.59-beta0ND",
3
+ "version": "5.2.60",
4
4
  "description": "Shared module between Web & Mobile containing required abstractions for state management, async network communication. ",
5
5
  "main": "lib/index.js",
6
6
  "module": "lib/esm/index.js",
@@ -53,6 +53,31 @@
53
53
  "url": "https://github.com/zeni-ai/client-epic-state/issues"
54
54
  },
55
55
  "homepage": "https://github.com/zeni-ai/client-epic-state#readme",
56
+ "devDependencies": {
57
+ "@eslint/js": "^9.24.0",
58
+ "@liveblocks/client": "^2.23.0",
59
+ "@trivago/prettier-plugin-sort-imports": "^5.2.2",
60
+ "@types/big.js": "^6.2.2",
61
+ "@types/lodash": "^4.17.23",
62
+ "@types/node": "^20.19.0",
63
+ "@types/url-parse": "^1.4.11",
64
+ "@typescript-eslint/eslint-plugin": "^8.56.0",
65
+ "@typescript-eslint/parser": "^8.56.0",
66
+ "concurrently": "^9.1.2",
67
+ "eslint": "^9.24.0",
68
+ "eslint-config-prettier": "^10.0.2",
69
+ "eslint-plugin-perfectionist": "^4.15.0",
70
+ "eslint-plugin-unused-imports": "^4.1.4",
71
+ "globals": "^16.0.0",
72
+ "knip": "^6.21.0",
73
+ "madge": "^8.0.0",
74
+ "prettier": "^3.5.3",
75
+ "rimraf": "^6.0.1",
76
+ "semver": "^7.7.1",
77
+ "typescript": "^5.7.3",
78
+ "vite": "^7.3.5",
79
+ "vitest": "^4.1.11"
80
+ },
56
81
  "dependencies": {
57
82
  "@redux-devtools/extension": "^3.3.0",
58
83
  "@reduxjs/toolkit": "^1.6.2",