@zeniai/client-epic-state 5.1.59 → 5.1.60-beta0ND

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

@@ -12,4 +12,37 @@ interface FetchRecommendationPayloadWithCOT {
     recommendations: RecommendationPayloadWithCOT[];
 }
 export type FetchRecommendationResponseWithCOT = ZeniAPIResponse<FetchRecommendationPayloadWithCOT>;
+export type RecommendationFeedbackDimension = 'vendor' | 'category' | 'class';
+export type RecommendationFeedbackSource = 'primary' | 'alternate' | 'shadow' | 'qbo';
+export type RecommendationFeedbackOutcome = 'accepted' | 'override_ranked' | 'override_outside';
+export interface RecommendationFeedbackValue {
+    name: string;
+    id?: string | null;
+    integrationId?: string | null;
+}
+export interface ShownRecommendationForFeedback {
+    rank: number;
+    source: RecommendationFeedbackSource;
+    value: RecommendationFeedbackValue;
+    confidence?: number | null;
+    cot?: string[];
+    reasoning?: string | null;
+}
+export interface SubmitRecommendationFeedbackPayload {
+    dimension: RecommendationFeedbackDimension;
+    outcome: RecommendationFeedbackOutcome;
+    selected: RecommendationFeedbackValue & {
+        isNewEntity?: boolean;
+    };
+    transactionId: string;
+    features?: Record<string, unknown> | null;
+    lineId?: string | null;
+    matchedRank?: number | null;
+    matchedSource?: RecommendationFeedbackSource | null;
+    reasonText?: string | null;
+    recommendationSetId?: string | null;
+    shownRecommendations?: ShownRecommendationForFeedback[];
+    skipped?: boolean;
+    topPickSource?: RecommendationFeedbackSource | null;
+}
 export {};

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

@@ -5,6 +5,7 @@ import { TransactionID } from '../../entity/transaction/stateTypes/transaction';
 import { SupportedTransaction } from '../../entity/transaction/transactionState';
 import { ZeniAPIStatus } from '../../responsePayload';
 import { TransactionsTab } from '../expenseAutomationView/types/transactionsViewState';
+import { SubmitRecommendationFeedbackPayload } from './recommendationPayload';
 import { EntityRecommendationState } from './recommendationState';
 export type RecommendationLineUpdateFlowType = 'categorization' | 'detail';
 type FetchEntityRecommendationsForLineUpdateCommonPayload = {
@@ -17,7 +18,6 @@ type FetchEntityRecommendationsForLineUpdateCommonPayload = {
     };
     isBulkFetch?: boolean;
     isFetchCOT?: boolean;
-    isUncategorizedExpenseCategoryEnabled?: boolean;
 };
 export type FetchEntityRecommendationsForLineUpdatePayload = (FetchEntityRecommendationsForLineUpdateCommonPayload & {
     flowType: 'categorization';
@@ -30,7 +30,7 @@ export declare const fetchEntityRecommendationsByTransactionId: import("@reduxjs
     lineIds: ID[];
     transaction: SupportedTransaction;
     transactionId: TransactionID;
-}, isBulkFetch: boolean, isTransactionCategorizationFlow?: any, isFetchCOT?: any, isUncategorizedExpenseCategoryEnabled?: boolean | undefined], {
+}, isBulkFetch: boolean, isTransactionCategorizationFlow?: any, isFetchCOT?: any], {
     entity: Entity;
     amount: number;
     transactionDetails: {
@@ -41,7 +41,6 @@ export declare const fetchEntityRecommendationsByTransactionId: import("@reduxjs
     isBulkFetch: boolean;
     isTransactionCategorizationFlow: any;
     isFetchCOT: any;
-    isUncategorizedExpenseCategoryEnabled: boolean | undefined;
 }, "recommendation/fetchEntityRecommendationsByTransactionId", never, never>, fetchEntityRecommendationsForLineUpdate: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[args: FetchEntityRecommendationsForLineUpdatePayload], FetchEntityRecommendationsForLineUpdatePayload, "recommendation/fetchEntityRecommendationsForLineUpdate", never, never>, fetchRecommendationByEntityName: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[entityName: string, entityType: EntityType], {
     entityName: string;
     entityType: EntityType;
@@ -59,6 +58,6 @@ export declare const fetchEntityRecommendationsByTransactionId: import("@reduxjs
 }, "recommendation/updateRecommendationForEntityFailure">, indicateReadyToInitializeRecommendation: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[entityIdOrName: string, entityType: EntityType], {
     entityIdOrName: string;
     entityType: EntityType;
-}, "recommendation/indicateReadyToInitializeRecommendation", never, never>, clearRecommendation: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"recommendation/clearRecommendation">;
+}, "recommendation/indicateReadyToInitializeRecommendation", never, never>, clearRecommendation: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"recommendation/clearRecommendation">, submitRecommendationFeedback: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[args: SubmitRecommendationFeedbackPayload], SubmitRecommendationFeedbackPayload, "recommendation/submitRecommendationFeedback", never, never>;
 declare const _default: import("redux").Reducer<EntityRecommendationState>;
 export default _default;

package/lib/view/recommendation/recommendationReducer.js

@@ -1,7 +1,7 @@
 "use strict";
 var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.clearRecommendation = exports.indicateReadyToInitializeRecommendation = exports.updateRecommendationForEntityFailure = exports.updateRecommendationForEntity = exports.fetchRecommendationByEntityId = exports.fetchRecommendationByEntityName = exports.fetchEntityRecommendationsForLineUpdate = exports.fetchEntityRecommendationsByTransactionId = exports.initialState = void 0;
+exports.submitRecommendationFeedback = exports.clearRecommendation = 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 recommendationState_1 = require("./recommendationState");
 exports.initialState = {
@@ -23,7 +23,7 @@ const recommendation = (0, toolkit_1.createSlice)({
                     };
                 }
             },
-            prepare(entity, amount, transactionDetails, isBulkFetch, isTransactionCategorizationFlow = false, isFetchCOT = false, isUncategorizedExpenseCategoryEnabled) {
+            prepare(entity, amount, transactionDetails, isBulkFetch, isTransactionCategorizationFlow = false, isFetchCOT = false) {
                 return {
                     payload: {
                         entity,
@@ -32,7 +32,6 @@ const recommendation = (0, toolkit_1.createSlice)({
                         isBulkFetch,
                         isTransactionCategorizationFlow,
                         isFetchCOT,
-                        isUncategorizedExpenseCategoryEnabled,
                     },
                 };
             },
@@ -138,9 +137,25 @@ const recommendation = (0, toolkit_1.createSlice)({
         clearRecommendation(draft) {
             Object.assign(draft, exports.initialState);
         },
+        // Fire-and-forget human feedback on a recommendation (accept, ranked
+        // override or outside override). Handled by submitRecommendationFeedbackEpic
+        // which POSTs to the accounting recommendation-feedback endpoint. No state
+        // mutation: the categorization UX must not depend on the feedback round-trip.
+        submitRecommendationFeedback: {
+            reducer(
+            // eslint-disable-next-line @typescript-eslint/no-unused-vars
+            _draft, 
+            // eslint-disable-next-line @typescript-eslint/no-unused-vars
+            _action) {
+                // do nothing
+            },
+            prepare(args) {
+                return { payload: args };
+            },
+        },
     },
 });
-_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.clearRecommendation = _a.clearRecommendation;
+_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.clearRecommendation = _a.clearRecommendation, exports.submitRecommendationFeedback = _a.submitRecommendationFeedback;
 exports.default = recommendation.reducer;
 const doUpdateRecommendationForEntity = (draft, entityId, entityType, payload) => {
     const key = (0, recommendationState_1.getEntityRecommendationKey)(entityType, entityId);

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

@@ -0,0 +1,7 @@
+import { ActionsObservable, StateObservable } from 'redux-observable';
+import { Observable } from 'rxjs';
+import { RootState } from '../../reducer';
+import { ZeniAPI } from '../../zeniAPI';
+import { submitRecommendationFeedback } from './recommendationReducer';
+export type ActionType = ReturnType<typeof submitRecommendationFeedback>;
+export declare const submitRecommendationFeedbackEpic: (actions$: ActionsObservable<ActionType>, _state$: StateObservable<RootState>, zeniAPI: ZeniAPI) => Observable<ActionType>;

package/lib/view/recommendation/submitRecommendationFeedbackEpic.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.submitRecommendationFeedbackEpic = void 0;
+const rxjs_1 = require("rxjs");
+const operators_1 = require("rxjs/operators");
+const responsePayload_1 = require("../../responsePayload");
+const recommendationReducer_1 = require("./recommendationReducer");
+const toRequestBody = (payload) => ({
+    line_id: payload.lineId ?? null,
+    dimension: payload.dimension,
+    recommendation_set_id: payload.recommendationSetId ?? null,
+    top_pick_source: payload.topPickSource ?? null,
+    shown_recommendations: (payload.shownRecommendations ?? []).map((recommendation) => ({
+        source: recommendation.source,
+        rank: recommendation.rank,
+        value: {
+            name: recommendation.value.name,
+            id: recommendation.value.id ?? null,
+            integration_id: recommendation.value.integrationId ?? null,
+        },
+        confidence: recommendation.confidence ?? null,
+        reasoning: recommendation.reasoning ?? null,
+        cot: recommendation.cot ?? [],
+    })),
+    selected: {
+        name: payload.selected.name,
+        id: payload.selected.id ?? null,
+        integration_id: payload.selected.integrationId ?? null,
+        is_new_entity: payload.selected.isNewEntity ?? false,
+    },
+    matched_source: payload.matchedSource ?? null,
+    matched_rank: payload.matchedRank ?? null,
+    outcome: payload.outcome,
+    reason_text: payload.reasonText ?? null,
+    skipped: payload.skipped ?? false,
+    features: payload.features ?? null,
+});
+// Fire-and-forget: the epic never re-emits an action. Feedback delivery is a
+// side-effect that must not disrupt the categorization UX, so both the
+// success and error paths complete silently (errors are logged for debugging).
+const submitRecommendationFeedbackEpic = (actions$, _state$, zeniAPI) => actions$.pipe((0, operators_1.filter)(recommendationReducer_1.submitRecommendationFeedback.match), (0, operators_1.mergeMap)((action) => {
+    const { transactionId } = action.payload;
+    return zeniAPI
+        .postAndGetJSON(`${zeniAPI.apiEndPoints.accountMicroServiceBaseUrl}/1.0/transactions/${transactionId}/recommendation-feedback`, toRequestBody(action.payload))
+        .pipe((0, operators_1.mergeMap)((response) => {
+        if (!(0, responsePayload_1.isSuccessStatus)(response)) {
+            console.error('submitRecommendationFeedbackEpic: recommendation feedback was not recorded', response.status);
+        }
+        return rxjs_1.EMPTY;
+    }), (0, operators_1.catchError)((error) => {
+        console.error('submitRecommendationFeedbackEpic: failed to submit recommendation feedback', error);
+        return rxjs_1.EMPTY;
+    }));
+}));
+exports.submitRecommendationFeedbackEpic = submitRecommendationFeedbackEpic;

package/lib/view/transactionDetail/epics/saveTransactionDetailEpic.js

@@ -13,7 +13,7 @@ const transactionDetailReducer_1 = require("../transactionDetailReducer");
 const transactionDetailState_1 = require("../transactionDetailState");
 const saveTransactionHelper_1 = require("./saveTransactionHelper");
 const saveTransactionDetailEpic = (actions$, state$) => actions$.pipe((0, operators_1.filter)(transactionDetailReducer_1.saveTransactionDetail.match), (0, operators_1.mergeMap)((action) => {
-    const { transactionId, cotTransactionTracking, isExpenseAutomationEnabled, isUncategorizedExpenseCategoryEnabled, } = action.payload;
+    const { transactionId, cotTransactionTracking, isExpenseAutomationEnabled, } = action.payload;
     const fetchActions = [];
     const transactionDetailState = state$.value.transactionDetailState;
     const transactionState = state$.value.transactionState;
@@ -24,7 +24,7 @@ const saveTransactionDetailEpic = (actions$, state$) => actions$.pipe((0, operat
     if (detail != null && transaction != null) {
         const localData = detail.transactionDetailLocalData;
         const transactionSaveUpdates = (0, saveTransactionHelper_1.toTransactionUpdatesFromTransactionDetailLocalData)(localData, transaction, isExpenseAutomationEnabled, isAccountingProjectsEnabled);
-        fetchActions.push((0, transactionDetailReducer_1.updateTransactionDetail)(transactionId, transactionSaveUpdates, isExpenseAutomationEnabled, cotTransactionTracking, isUncategorizedExpenseCategoryEnabled));
+        fetchActions.push((0, transactionDetailReducer_1.updateTransactionDetail)(transactionId, transactionSaveUpdates, isExpenseAutomationEnabled, cotTransactionTracking));
         return (0, rxjs_1.from)(fetchActions);
     }
     return (0, rxjs_1.from)(fetchActions);

package/lib/view/transactionDetail/epics/updateTransactionDetailEpic.js

@@ -35,7 +35,7 @@ const transactionDetailState_1 = require("../transactionDetailState");
 const updateTransactionDetailEpic = (actions$, state$, zeniAPI) => actions$.pipe((0, operators_1.filter)(transactionDetailReducer_1.updateTransactionDetail.match), (0, operators_1.mergeMap)((action) => {
     const { transactionState, vendorState, transactionDetailState } = state$.value;
     const isAccountingProjectsEnabled = (0, tenantSelector_1.getIsAccountingProjectsEnabled)(state$.value);
-    const { cotTransactionTracking, transactionId, transactionSaveUpdates, isUncategorizedExpenseCategoryEnabled, } = action.payload;
+    const { cotTransactionTracking, transactionId, transactionSaveUpdates, } = action.payload;
     return zeniAPI
         .putAndGetJSON(`${zeniAPI.apiEndPoints.accountMicroServiceBaseUrl}/1.0/transactions/${action.payload.transactionId.id}/categorize`, preparePayload(transactionState, vendorState, transactionDetailState, transactionId, transactionSaveUpdates, cotTransactionTracking, isAccountingProjectsEnabled))
         .pipe((0, operators_1.mergeMap)((response) => {
@@ -88,7 +88,7 @@ const updateTransactionDetailEpic = (actions$, state$, zeniAPI) => actions$.pipe
             actions.push((0, transactionReducer_1.updateTransactions)([response.data.transaction], (value) => value.transaction_id, 'merge'));
             const transactionWithCOT = (0, transactionHelper_1.getTransactionWithCOT)(transaction);
             const pendingReviewLineIds = (0, transactionCategorizationLocalDataHelper_1.getPendingReviewLineIdsFromTransaction)(transactionWithCOT);
-            actions.push((0, transactionsViewReducer_1.syncTransactionCategorizationFromDetailSave)(transactionIdResp, transactionWithCOT, pendingReviewLineIds, uncategorizedIncomeExpense, isUncategorizedExpenseCategoryEnabled));
+            actions.push((0, transactionsViewReducer_1.syncTransactionCategorizationFromDetailSave)(transactionIdResp, transactionWithCOT, pendingReviewLineIds));
             return (0, rxjs_1.from)(actions);
         }
         else if ((0, responsePayload_1.isActionNotAllowed)(response)) {

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

@@ -26,12 +26,11 @@ export declare const downloadAccountingProviderAttachment: import("@reduxjs/tool
     payload: SupportedTransactionPayload;
 }, "transactionDetail/uploadMissingAttachmentSuccess", never, {
     updateType: UpdateType;
-}>, updateTransactionDetail: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[transactionId: TransactionID, transactionSaveUpdates: TransactionSaveUpdates, isExpenseAutomationEnabled: boolean, cotTransactionTracking: COTTransactionTracking, isUncategorizedExpenseCategoryEnabled?: boolean | undefined], {
+}>, updateTransactionDetail: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[transactionId: TransactionID, transactionSaveUpdates: TransactionSaveUpdates, isExpenseAutomationEnabled: boolean, cotTransactionTracking: COTTransactionTracking], {
     transactionId: TransactionID;
     transactionSaveUpdates: TransactionSaveUpdates;
     isExpenseAutomationEnabled: boolean;
     cotTransactionTracking: COTTransactionTracking;
-    isUncategorizedExpenseCategoryEnabled: boolean | undefined;
 }, "transactionDetail/updateTransactionDetail", never, never>, updateTransactionDetailSaveStatus: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[transactionId: TransactionID, fetchState: FetchState, error?: ZeniAPIStatus<Record<string, unknown>> | undefined], {
     transactionId: TransactionID;
     fetchState: FetchState;
@@ -66,7 +65,6 @@ export declare const downloadAccountingProviderAttachment: import("@reduxjs/tool
     cotTransactionTracking: COTTransactionTracking;
     isExpenseAutomationEnabled: boolean;
     transactionId: TransactionID;
-    isUncategorizedExpenseCategoryEnabled?: boolean;
 }, "transactionDetail/saveTransactionDetail">, initializeTransactionDetailLocalData: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
     transactionId: TransactionID;
     customerId?: ID;

package/lib/view/transactionDetail/transactionDetailReducer.js

@@ -112,14 +112,13 @@ const transactionDetail = (0, toolkit_1.createSlice)({
                     };
                 }
             },
-            prepare(transactionId, transactionSaveUpdates, isExpenseAutomationEnabled, cotTransactionTracking, isUncategorizedExpenseCategoryEnabled) {
+            prepare(transactionId, transactionSaveUpdates, isExpenseAutomationEnabled, cotTransactionTracking) {
                 return {
                     payload: {
                         transactionId,
                         transactionSaveUpdates,
                         isExpenseAutomationEnabled,
                         cotTransactionTracking,
-                        isUncategorizedExpenseCategoryEnabled,
                     },
                 };
             },

package/package.json

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