@zeniai/client-epic-state 5.1.91 → 5.1.92-beta0ND

package/lib/view/invoicing/settingsView/settingsViewEpics.js

@@ -4,6 +4,7 @@ exports.saveInvoicingSettingsEpic = exports.disconnectInvoicingStripeEpic = expo
 const rxjs_1 = require("rxjs");
 const operators_1 = require("rxjs/operators");
 const addressReducer_1 = require("../../../entity/address/addressReducer");
+const snackbarApiError_1 = require("../../../entity/snackbar/snackbarApiError");
 const snackbarReducer_1 = require("../../../entity/snackbar/snackbarReducer");
 const responsePayload_1 = require("../../../responsePayload");
 const settingsViewReducer_1 = require("./settingsViewReducer");
@@ -65,13 +66,15 @@ exports.disconnectInvoicingStripeEpic = disconnectInvoicingStripeEpic;
 const saveInvoicingSettingsEpic = (actions$, _state$, zeniAPI) => actions$.pipe((0, operators_1.filter)(settingsViewReducer_1.saveInvoicingSettings.match), (0, operators_1.mergeMap)((action) => {
     const apiUrl = `${zeniAPI.apiEndPoints.invoicingMicroServiceBaseUrl}/1.0/settings`;
     const { settings, snackbarSection } = action.payload;
-    const snackbar = (messageText) => snackbarSection == null
+    /** `status` surfaces the platform's error text; omit it to keep the generic copy. */
+    const snackbar = (messageText, status) => snackbarSection == null
         ? []
         : [
             (0, snackbarReducer_1.openSnackbar)({
                 messageSection: snackbarSection,
                 messageText,
                 type: messageText === 'success' ? 'success' : 'error',
+                variables: (0, snackbarApiError_1.apiErrorSnackbarVariables)(status),
             }),
         ];
     return zeniAPI
@@ -85,7 +88,7 @@ const saveInvoicingSettingsEpic = (actions$, _state$, zeniAPI) => actions$.pipe(
         }
         return (0, rxjs_1.from)([
             (0, settingsViewReducer_1.saveInvoicingSettingsFailure)(response.status),
-            ...snackbar('failed'),
+            ...snackbar('failed', response.status),
         ]);
     }), (0, operators_1.catchError)((error) => (0, rxjs_1.from)([
         (0, settingsViewReducer_1.saveInvoicingSettingsFailure)((0, responsePayload_1.createZeniAPIStatus)('Unexpected Error', 'Save settings REST API call errored out ' +

package/lib/view/invoicing/settingsView/settingsViewSelector.d.ts

@@ -1,7 +1,8 @@
 import { FetchState, FetchStateAndError } from '../../../commonStateTypes/common';
-import { InvoicingNamedOption, InvoicingSettingsPayload } from '../../../entity/invoicing/invoicingCommonPayload';
+import { InvoicingNamedOption, InvoicingQboAccountMappingKindOption, InvoicingSettingsPayload } from '../../../entity/invoicing/invoicingCommonPayload';
 import { RootState } from '../../../reducer';
 import { ZeniAPIStatus } from '../../../responsePayload';
+import { InvoicingOnboardingStatus } from '../invoicingConfigView/invoicingConfigViewPayload';
 import { InvoicingBrandingFormLocalData } from './invoicingBrandingFormConfig';
 /**
  * Shared primitive: the raw invoicing settings. Consumed internally by other
@@ -27,6 +28,45 @@ export interface InvoicingSettingsView {
  * Stripe-connect fetch state.
  */
 export declare const getInvoicingSettingsView: (state: RootState) => InvoicingSettingsView;
+export interface InvoicingEnablePrerequisites {
+    canEnable: boolean;
+    isQboConfigured: boolean;
+    isStripeConnected: boolean;
+}
+/**
+ * Gates the Enable Invoicing action: payments must be able to land (Stripe
+ * connected *and* accepting charges) and the QBO accounting step must be
+ * finished, so an enabled tenant can always book what it invoices.
+ *
+ * Deliberately not part of `deriveInvoicingOnboardingStatus`, which routes the
+ * module off the config flags alone. Folding these in there would (a) demote a
+ * live tenant to the settings tree the moment an integration broke, stranding
+ * its existing invoices, and (b) deadlock the route gate, which fetches only the
+ * config — never the settings or QBO connection these read.
+ */
+export declare function deriveInvoicingEnablePrerequisites(settings: InvoicingSettingsPayload | undefined, isQboConnected: boolean, qboAccountMappingKindOptions: InvoicingQboAccountMappingKindOption[]): InvoicingEnablePrerequisites;
+export interface InvoicingSettingsHubView {
+    canEnableInvoicing: boolean;
+    isEnablingInvoicing: boolean;
+    isQboConfigured: boolean;
+    isStripeConnected: boolean;
+    status?: InvoicingOnboardingStatus;
+}
+/**
+ * The settings hub's composite of everything it derives from the store: whether
+ * to offer Enable Invoicing at all, the in-flight flag for that action, and the
+ * two integration prerequisites kept separate so the hub can name the step still
+ * outstanding instead of showing a dead button.
+ *
+ * `canEnableInvoicing` folds in the onboarding step, so the screen does not need
+ * to re-check it: the footer is only offered mid-onboarding and only once both
+ * integrations are ready.
+ *
+ * Deliberately not folded into `getInvoicingConfigView`: that selector gates
+ * every invoicing route and stays a pure read of the config slice. The settings
+ * and QBO slices read here are only fetched once a settings screen is mounted.
+ */
+export declare const getInvoicingSettingsHubView: (state: RootState) => InvoicingSettingsHubView;
 export interface InvoicingBrandingFormView {
     dateFormatOptions: InvoicingNamedOption[];
     localData: InvoicingBrandingFormLocalData;

package/lib/view/invoicing/settingsView/settingsViewSelector.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getInvoicingBrandingFormView = exports.getInvoicingSettingsView = exports.getInvoicingSettingsFetchState = exports.getInvoicingSettings = void 0;
+exports.getInvoicingBrandingFormView = exports.getInvoicingSettingsHubView = exports.getInvoicingSettingsView = exports.getInvoicingSettingsFetchState = exports.getInvoicingSettings = void 0;
+exports.deriveInvoicingEnablePrerequisites = deriveInvoicingEnablePrerequisites;
+const invoicingCommonPayload_1 = require("../../../entity/invoicing/invoicingCommonPayload");
 const addressViewSelector_1 = require("../../addressView/addressViewSelector");
 const invoicingConfigViewSelector_1 = require("../invoicingConfigView/invoicingConfigViewSelector");
 const invoicingBrandingFormConfig_1 = require("./invoicingBrandingFormConfig");
@@ -36,6 +38,58 @@ const getInvoicingSettingsView = (state) => {
     };
 };
 exports.getInvoicingSettingsView = getInvoicingSettingsView;
+/**
+ * Gates the Enable Invoicing action: payments must be able to land (Stripe
+ * connected *and* accepting charges) and the QBO accounting step must be
+ * finished, so an enabled tenant can always book what it invoices.
+ *
+ * Deliberately not part of `deriveInvoicingOnboardingStatus`, which routes the
+ * module off the config flags alone. Folding these in there would (a) demote a
+ * live tenant to the settings tree the moment an integration broke, stranding
+ * its existing invoices, and (b) deadlock the route gate, which fetches only the
+ * config — never the settings or QBO connection these read.
+ */
+function deriveInvoicingEnablePrerequisites(settings, isQboConnected, qboAccountMappingKindOptions) {
+    const isStripeConnected = settings?.stripe_connected === true &&
+        settings?.stripe_account?.charges_enabled === true;
+    const accountMappings = settings?.qbo?.account_mappings ?? undefined;
+    // An empty option list means the config has not landed yet — treating that as
+    // configured would let `every` pass vacuously and unlock the button early.
+    const isQboConfigured = isQboConnected &&
+        qboAccountMappingKindOptions.length > 0 &&
+        qboAccountMappingKindOptions.every((option) => (0, invoicingCommonPayload_1.getInvoicingQboAccountMappingId)(accountMappings, option.code) != null);
+    return {
+        canEnable: isStripeConnected && isQboConfigured,
+        isQboConfigured,
+        isStripeConnected,
+    };
+}
+/**
+ * The settings hub's composite of everything it derives from the store: whether
+ * to offer Enable Invoicing at all, the in-flight flag for that action, and the
+ * two integration prerequisites kept separate so the hub can name the step still
+ * outstanding instead of showing a dead button.
+ *
+ * `canEnableInvoicing` folds in the onboarding step, so the screen does not need
+ * to re-check it: the footer is only offered mid-onboarding and only once both
+ * integrations are ready.
+ *
+ * Deliberately not folded into `getInvoicingConfigView`: that selector gates
+ * every invoicing route and stays a pure read of the config slice. The settings
+ * and QBO slices read here are only fetched once a settings screen is mounted.
+ */
+const getInvoicingSettingsHubView = (state) => {
+    const { enableState, qboAccountMappingKindOptions, status } = (0, invoicingConfigViewSelector_1.getInvoicingConfigView)(state);
+    const { canEnable, isQboConfigured, isStripeConnected } = deriveInvoicingEnablePrerequisites(state.invoicingSettingsViewState.settings, state.invoicingQboViewState.connection?.connected === true, qboAccountMappingKindOptions);
+    return {
+        canEnableInvoicing: status === 'settings' && canEnable,
+        isEnablingInvoicing: enableState.fetchState === 'In-Progress',
+        isQboConfigured,
+        isStripeConnected,
+        status,
+    };
+};
+exports.getInvoicingSettingsHubView = getInvoicingSettingsHubView;
 /**
  * Bundled view for the branding settings form: the draft `localData` (seeded
  * from the existing settings until the user edits), the business-address label

package/lib/view/invoicing/subscriptionAction/subscriptionActionEpic.js

@@ -6,6 +6,7 @@ const operators_1 = require("rxjs/operators");
 const addressReducer_1 = require("../../../entity/address/addressReducer");
 const invoicingSubscriptionPayload_1 = require("../../../entity/invoicing/invoicingSubscription/invoicingSubscriptionPayload");
 const invoicingSubscriptionReducer_1 = require("../../../entity/invoicing/invoicingSubscription/invoicingSubscriptionReducer");
+const snackbarApiError_1 = require("../../../entity/snackbar/snackbarApiError");
 const snackbarReducer_1 = require("../../../entity/snackbar/snackbarReducer");
 const responsePayload_1 = require("../../../responsePayload");
 const subscriptionActionReducer_1 = require("./subscriptionActionReducer");
@@ -27,13 +28,15 @@ const runInvoicingSubscriptionActionEpic = (actions$, _state$, zeniAPI) => actio
     const { action: kind, body, id } = action.payload;
     const requestBody = { action: kind, ...(body ?? {}) };
     const snackbarSection = SNACKBAR_SECTION_BY_ACTION[kind];
-    const snackbar = (messageText) => snackbarSection == null
+    /** `status` surfaces the platform's error text; omit it to keep the generic copy. */
+    const snackbar = (messageText, status) => snackbarSection == null
         ? []
         : [
             (0, snackbarReducer_1.openSnackbar)({
                 messageSection: snackbarSection,
                 messageText,
                 type: messageText === 'success' ? 'success' : 'error',
+                variables: (0, snackbarApiError_1.apiErrorSnackbarVariables)(status),
             }),
         ];
     const apiUrl = `${zeniAPI.apiEndPoints.invoicingMicroServiceBaseUrl}/1.0/subscriptions/${encodeURIComponent(id)}/actions`;
@@ -53,7 +56,7 @@ const runInvoicingSubscriptionActionEpic = (actions$, _state$, zeniAPI) => actio
                 error: response.status,
                 id,
             }),
-            ...snackbar('failed'),
+            ...snackbar('failed', response.status),
         ]);
     }), (0, operators_1.catchError)((error) => (0, rxjs_1.from)([
         (0, subscriptionActionReducer_1.runInvoicingSubscriptionActionFailure)({

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

@@ -12,4 +12,38 @@ 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' | 'retracted';
+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;
+    retractsFeedbackId?: 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 = {
@@ -57,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 rootActions_1 = require("../../rootActions");
 const recommendationState_1 = require("./recommendationState");
@@ -138,6 +138,22 @@ 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 };
+            },
+        },
     },
     extraReducers: (builder) => {
         builder.addCase(rootActions_1.clearAll, (draft) => {
@@ -145,7 +161,7 @@ const recommendation = (0, toolkit_1.createSlice)({
         });
     },
 });
-_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,56 @@
+"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,
+    retracts_feedback_id: payload.retractsFeedbackId ?? null,
+    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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zeniai/client-epic-state",
-  "version": "5.1.91",
+  "version": "5.1.92-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",