@zeniai/client-epic-state 5.2.58-beta0ND → 5.2.58-beta1ND

package/lib/esm/view/recommendation/recommendationPayload.js

@@ -1 +1,3 @@
-export {};
+// Only an override opens the feedback popup. Silent accepts and retractions post
+// in the background, so they must not drive the popup's loader or its toast.
+export const isPromptedRecommendationFeedback = (outcome) => outcome === 'override_outside' || outcome === 'override_ranked';

package/lib/esm/view/recommendation/recommendationReducer.js

@@ -1,8 +1,9 @@
 import { createSlice } from '@reduxjs/toolkit';
 import { clearAll } from '../../rootActions';
-import { getEntityRecommendationKey, getRecommendationFeedbackKey, initialEntityRecommendationState, } from './recommendationState';
+import { isPromptedRecommendationFeedback, } from './recommendationPayload';
+import { getEntityRecommendationKey, initialEntityRecommendationState, } from './recommendationState';
 export const initialState = {
-    feedbackSubmitStateByKey: {},
+    feedbackSubmitState: { fetchState: 'Not-Started', error: undefined },
     recommendationByEntity: {},
 };
 const recommendation = createSlice({
@@ -138,9 +139,10 @@ const recommendation = createSlice({
         // never waits on this: only the feedback popup reads the submit state.
         submitRecommendationFeedback: {
             reducer(draft, action) {
-                const { transactionId, lineId, dimension } = action.payload;
-                const key = getRecommendationFeedbackKey(transactionId, lineId, dimension);
-                draft.feedbackSubmitStateByKey[key] = {
+                if (!isPromptedRecommendationFeedback(action.payload.outcome)) {
+                    return;
+                }
+                draft.feedbackSubmitState = {
                     fetchState: 'In-Progress',
                     error: undefined,
                 };
@@ -151,8 +153,8 @@ const recommendation = createSlice({
         },
         submitRecommendationFeedbackCompleted: {
             reducer(draft, action) {
-                const { key, succeeded, error } = action.payload;
-                draft.feedbackSubmitStateByKey[key] = {
+                const { succeeded, error } = action.payload;
+                draft.feedbackSubmitState = {
                     fetchState: succeeded ? 'Completed' : 'Error',
                     error,
                 };

package/lib/esm/view/recommendation/recommendationSelector.js

@@ -1,4 +1,4 @@
-import { getEntityRecommendationKey, getRecommendationFeedbackKey, } from './recommendationState';
+import { getEntityRecommendationKey } from './recommendationState';
 export const getRecommendationsForEntity = (state, entityId, entityType) => {
     const { entityRecommendationState } = state;
     const key = getEntityRecommendationKey(entityType, entityId);
@@ -11,4 +11,4 @@ export const getRecommendationsForEntity = (state, entityId, entityType) => {
         recommendations,
     };
 };
-export const getRecommendationFeedbackSubmitState = (state, transactionId, lineId, dimension) => state.entityRecommendationState.feedbackSubmitStateByKey[getRecommendationFeedbackKey(transactionId, lineId, dimension)] ?? { fetchState: 'Not-Started', error: undefined };
+export const getRecommendationFeedbackSubmitState = (state) => state.entityRecommendationState.feedbackSubmitState;

package/lib/esm/view/recommendation/recommendationState.js

@@ -1,5 +1,4 @@
 export const getEntityRecommendationKey = (entityType, entityIdOrName) => `${entityType}_${entityIdOrName}`;
-export const getRecommendationFeedbackKey = (transactionId, lineId, dimension) => `${transactionId}|${lineId ?? ''}|${dimension}`;
 export const initialEntityRecommendationState = {
     fetchState: 'Not-Started',
     error: undefined,

package/lib/esm/view/recommendation/submitRecommendationFeedbackEpic.js

@@ -1,8 +1,8 @@
-import { of } from 'rxjs';
+import { EMPTY, of } from 'rxjs';
 import { catchError, filter, mergeMap } from 'rxjs/operators';
 import { isSuccessStatus } from '../../responsePayload';
+import { isPromptedRecommendationFeedback, } from './recommendationPayload';
 import { submitRecommendationFeedback, submitRecommendationFeedbackCompleted, } from './recommendationReducer';
-import { getRecommendationFeedbackKey } from './recommendationState';
 const toRequestBody = (payload) => ({
     line_id: payload.lineId ?? null,
     dimension: payload.dimension,
@@ -38,8 +38,10 @@ const toRequestBody = (payload) => ({
 // user what happened. The categorization itself still never waits on this: a
 // failure is surfaced in a toast rather than blocking or reverting the change.
 export const submitRecommendationFeedbackEpic = (actions$, _state$, zeniAPI) => actions$.pipe(filter(submitRecommendationFeedback.match), mergeMap((action) => {
-    const { transactionId, lineId, dimension } = action.payload;
-    const key = getRecommendationFeedbackKey(transactionId, lineId, dimension);
+    const { transactionId } = action.payload;
+    // Only the override that opened the popup reports completion; accepts and
+    // retractions stay fire-and-forget so they cannot settle the popup.
+    const isPrompted = isPromptedRecommendationFeedback(action.payload.outcome);
     return zeniAPI
         .postAndGetJSON(`${zeniAPI.apiEndPoints.accountMicroServiceBaseUrl}/1.0/transactions/${transactionId}/recommendation-feedback`, toRequestBody(action.payload))
         .pipe(mergeMap((response) => {
@@ -47,13 +49,16 @@ export const submitRecommendationFeedbackEpic = (actions$, _state$, zeniAPI) =>
         if (!succeeded) {
             console.error('submitRecommendationFeedbackEpic: recommendation feedback was not recorded', response.status);
         }
-        return of(submitRecommendationFeedbackCompleted({
-            key,
-            succeeded,
-            error: succeeded ? undefined : response.status,
-        }));
+        return isPrompted
+            ? of(submitRecommendationFeedbackCompleted({
+                succeeded,
+                error: succeeded ? undefined : response.status,
+            }))
+            : EMPTY;
     }), catchError((error) => {
         console.error('submitRecommendationFeedbackEpic: failed to submit recommendation feedback', error);
-        return of(submitRecommendationFeedbackCompleted({ key, succeeded: false }));
+        return isPrompted
+            ? of(submitRecommendationFeedbackCompleted({ succeeded: false }))
+            : EMPTY;
     }));
 }));

package/lib/view/recommendation/recommendationPayload.d.ts

@@ -15,6 +15,7 @@ export type FetchRecommendationResponseWithCOT = ZeniAPIResponse<FetchRecommenda
 export type RecommendationFeedbackDimension = 'vendor' | 'category' | 'class';
 export type RecommendationFeedbackSource = 'primary' | 'alternate' | 'shadow' | 'qbo';
 export type RecommendationFeedbackOutcome = 'accepted' | 'override_ranked' | 'override_outside' | 'retracted';
+export declare const isPromptedRecommendationFeedback: (outcome: RecommendationFeedbackOutcome) => boolean;
 export interface RecommendationFeedbackValue {
     name: string;
     id?: string | null;

package/lib/view/recommendation/recommendationPayload.js

@@ -1,2 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.isPromptedRecommendationFeedback = void 0;
+// Only an override opens the feedback popup. Silent accepts and retractions post
+// in the background, so they must not drive the popup's loader or its toast.
+const isPromptedRecommendationFeedback = (outcome) => outcome === 'override_outside' || outcome === 'override_ranked';
+exports.isPromptedRecommendationFeedback = isPromptedRecommendationFeedback;

package/lib/view/recommendation/recommendationReducer.d.ts

@@ -6,7 +6,7 @@ import { SupportedTransaction } from '../../entity/transaction/transactionState'
 import { ZeniAPIStatus } from '../../responsePayload';
 import { TransactionsTab } from '../expenseAutomationView/types/transactionsViewState';
 import { SubmitRecommendationFeedbackPayload } from './recommendationPayload';
-import { EntityRecommendationState, RecommendationFeedbackKey } from './recommendationState';
+import { EntityRecommendationState } from './recommendationState';
 export type RecommendationLineUpdateFlowType = 'categorization' | 'detail';
 type FetchEntityRecommendationsForLineUpdateCommonPayload = {
     amount: number;
@@ -59,11 +59,9 @@ export declare const fetchEntityRecommendationsByTransactionId: import("@reduxjs
     entityIdOrName: string;
     entityType: EntityType;
 }, "recommendation/indicateReadyToInitializeRecommendation", never, never>, submitRecommendationFeedback: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[args: SubmitRecommendationFeedbackPayload], SubmitRecommendationFeedbackPayload, "recommendation/submitRecommendationFeedback", never, never>, submitRecommendationFeedbackCompleted: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[args: {
-    key: RecommendationFeedbackKey;
     succeeded: boolean;
     error?: ZeniAPIStatus;
 }], {
-    key: RecommendationFeedbackKey;
     succeeded: boolean;
     error?: ZeniAPIStatus;
 }, "recommendation/submitRecommendationFeedbackCompleted", never, never>;

package/lib/view/recommendation/recommendationReducer.js

@@ -4,9 +4,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.submitRecommendationFeedbackCompleted = exports.submitRecommendationFeedback = exports.indicateReadyToInitializeRecommendation = exports.updateRecommendationForEntityFailure = exports.updateRecommendationForEntity = exports.fetchRecommendationByEntityId = exports.fetchRecommendationByEntityName = exports.fetchEntityRecommendationsForLineUpdate = exports.fetchEntityRecommendationsByTransactionId = exports.initialState = void 0;
 const toolkit_1 = require("@reduxjs/toolkit");
 const rootActions_1 = require("../../rootActions");
+const recommendationPayload_1 = require("./recommendationPayload");
 const recommendationState_1 = require("./recommendationState");
 exports.initialState = {
-    feedbackSubmitStateByKey: {},
+    feedbackSubmitState: { fetchState: 'Not-Started', error: undefined },
     recommendationByEntity: {},
 };
 const recommendation = (0, toolkit_1.createSlice)({
@@ -142,9 +143,10 @@ const recommendation = (0, toolkit_1.createSlice)({
         // never waits on this: only the feedback popup reads the submit state.
         submitRecommendationFeedback: {
             reducer(draft, action) {
-                const { transactionId, lineId, dimension } = action.payload;
-                const key = (0, recommendationState_1.getRecommendationFeedbackKey)(transactionId, lineId, dimension);
-                draft.feedbackSubmitStateByKey[key] = {
+                if (!(0, recommendationPayload_1.isPromptedRecommendationFeedback)(action.payload.outcome)) {
+                    return;
+                }
+                draft.feedbackSubmitState = {
                     fetchState: 'In-Progress',
                     error: undefined,
                 };
@@ -155,8 +157,8 @@ const recommendation = (0, toolkit_1.createSlice)({
         },
         submitRecommendationFeedbackCompleted: {
             reducer(draft, action) {
-                const { key, succeeded, error } = action.payload;
-                draft.feedbackSubmitStateByKey[key] = {
+                const { succeeded, error } = action.payload;
+                draft.feedbackSubmitState = {
                     fetchState: succeeded ? 'Completed' : 'Error',
                     error,
                 };

package/lib/view/recommendation/recommendationSelector.d.ts

@@ -9,4 +9,4 @@ export interface RecommendationByEntitySelectorView extends SelectorView {
     recommendations?: Recommendation[];
 }
 export declare const getRecommendationsForEntity: (state: RootState, entityId: string, entityType: EntityType) => RecommendationByEntitySelectorView;
-export declare const getRecommendationFeedbackSubmitState: (state: RootState, transactionId: string, lineId: string | null | undefined, dimension: string) => FetchStateAndError;
+export declare const getRecommendationFeedbackSubmitState: (state: RootState) => FetchStateAndError;

package/lib/view/recommendation/recommendationSelector.js

@@ -15,5 +15,5 @@ const getRecommendationsForEntity = (state, entityId, entityType) => {
     };
 };
 exports.getRecommendationsForEntity = getRecommendationsForEntity;
-const getRecommendationFeedbackSubmitState = (state, transactionId, lineId, dimension) => state.entityRecommendationState.feedbackSubmitStateByKey[(0, recommendationState_1.getRecommendationFeedbackKey)(transactionId, lineId, dimension)] ?? { fetchState: 'Not-Started', error: undefined };
+const getRecommendationFeedbackSubmitState = (state) => state.entityRecommendationState.feedbackSubmitState;
 exports.getRecommendationFeedbackSubmitState = getRecommendationFeedbackSubmitState;

package/lib/view/recommendation/recommendationState.d.ts

@@ -3,13 +3,11 @@ import { Recommendation } from '../../commonStateTypes/recommendationBase';
 import { EntityType } from '../../entity/genericEntity/entity';
 export declare const getEntityRecommendationKey: (entityType: EntityType, entityIdOrName: string) => `vendor_${string}` | `customer_${string}` | `merchant_${string}`;
 export type EntityRecommendationKey = ReturnType<typeof getEntityRecommendationKey>;
-export declare const getRecommendationFeedbackKey: (transactionId: string, lineId: string | null | undefined, dimension: string) => `${string}|${string}|${string}`;
-export type RecommendationFeedbackKey = ReturnType<typeof getRecommendationFeedbackKey>;
 export interface EntityRecommendationsStatus extends FetchedState {
     recommendations?: Recommendation[];
 }
 export declare const initialEntityRecommendationState: EntityRecommendationsStatus;
 export interface EntityRecommendationState {
-    feedbackSubmitStateByKey: Record<RecommendationFeedbackKey, FetchStateAndError>;
+    feedbackSubmitState: FetchStateAndError;
     recommendationByEntity: Record<EntityRecommendationKey, EntityRecommendationsStatus>;
 }

package/lib/view/recommendation/recommendationState.js

@@ -1,10 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.initialEntityRecommendationState = exports.getRecommendationFeedbackKey = exports.getEntityRecommendationKey = void 0;
+exports.initialEntityRecommendationState = exports.getEntityRecommendationKey = void 0;
 const getEntityRecommendationKey = (entityType, entityIdOrName) => `${entityType}_${entityIdOrName}`;
 exports.getEntityRecommendationKey = getEntityRecommendationKey;
-const getRecommendationFeedbackKey = (transactionId, lineId, dimension) => `${transactionId}|${lineId ?? ''}|${dimension}`;
-exports.getRecommendationFeedbackKey = getRecommendationFeedbackKey;
 exports.initialEntityRecommendationState = {
     fetchState: 'Not-Started',
     error: undefined,

package/lib/view/recommendation/submitRecommendationFeedbackEpic.js

@@ -4,8 +4,8 @@ exports.submitRecommendationFeedbackEpic = void 0;
 const rxjs_1 = require("rxjs");
 const operators_1 = require("rxjs/operators");
 const responsePayload_1 = require("../../responsePayload");
+const recommendationPayload_1 = require("./recommendationPayload");
 const recommendationReducer_1 = require("./recommendationReducer");
-const recommendationState_1 = require("./recommendationState");
 const toRequestBody = (payload) => ({
     line_id: payload.lineId ?? null,
     dimension: payload.dimension,
@@ -41,8 +41,10 @@ const toRequestBody = (payload) => ({
 // user what happened. The categorization itself still never waits on this: a
 // failure is surfaced in a toast rather than blocking or reverting the change.
 const submitRecommendationFeedbackEpic = (actions$, _state$, zeniAPI) => actions$.pipe((0, operators_1.filter)(recommendationReducer_1.submitRecommendationFeedback.match), (0, operators_1.mergeMap)((action) => {
-    const { transactionId, lineId, dimension } = action.payload;
-    const key = (0, recommendationState_1.getRecommendationFeedbackKey)(transactionId, lineId, dimension);
+    const { transactionId } = action.payload;
+    // Only the override that opened the popup reports completion; accepts and
+    // retractions stay fire-and-forget so they cannot settle the popup.
+    const isPrompted = (0, recommendationPayload_1.isPromptedRecommendationFeedback)(action.payload.outcome);
     return zeniAPI
         .postAndGetJSON(`${zeniAPI.apiEndPoints.accountMicroServiceBaseUrl}/1.0/transactions/${transactionId}/recommendation-feedback`, toRequestBody(action.payload))
         .pipe((0, operators_1.mergeMap)((response) => {
@@ -50,14 +52,17 @@ const submitRecommendationFeedbackEpic = (actions$, _state$, zeniAPI) => actions
         if (!succeeded) {
             console.error('submitRecommendationFeedbackEpic: recommendation feedback was not recorded', response.status);
         }
-        return (0, rxjs_1.of)((0, recommendationReducer_1.submitRecommendationFeedbackCompleted)({
-            key,
-            succeeded,
-            error: succeeded ? undefined : response.status,
-        }));
+        return isPrompted
+            ? (0, rxjs_1.of)((0, recommendationReducer_1.submitRecommendationFeedbackCompleted)({
+                succeeded,
+                error: succeeded ? undefined : response.status,
+            }))
+            : rxjs_1.EMPTY;
     }), (0, operators_1.catchError)((error) => {
         console.error('submitRecommendationFeedbackEpic: failed to submit recommendation feedback', error);
-        return (0, rxjs_1.of)((0, recommendationReducer_1.submitRecommendationFeedbackCompleted)({ key, succeeded: false }));
+        return isPrompted
+            ? (0, rxjs_1.of)((0, recommendationReducer_1.submitRecommendationFeedbackCompleted)({ succeeded: false }))
+            : rxjs_1.EMPTY;
     }));
 }));
 exports.submitRecommendationFeedbackEpic = submitRecommendationFeedbackEpic;

package/package.json

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