@zeniai/client-epic-state 5.2.11 → 5.2.12

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

@@ -1,8 +1,12 @@
+import { NestedAccountHierarchyForReport } from '../../../commonStateTypes/accountView/nestedAccountID';
 import { FetchState, FetchStateAndError } from '../../../commonStateTypes/common';
 import { InvoicingDunningActionOption, InvoicingNamedOption, InvoicingQboAccountMappingKindOption, InvoicingSettingsPayload } from '../../../entity/invoicing/invoicingCommonPayload';
 import { ZeniAPIStatus } from '../../../responsePayload';
 import { RootState } from '../../../rootStateTypes';
+import { InvoicingQboConnection, InvoicingQboSyncHealth } from '../invoicingQboView/invoicingQboViewPayload';
+import { InvoicingAccountingOption } from '../invoicingQboView/invoicingQboViewSelector';
 import { InvoicingBrandingFormLocalData } from './invoicingBrandingFormConfig';
+import { InvoicingQboSettingsLocalData } from './invoicingQboSettingsFormConfig';
 /**
  * Shared primitive: the raw invoicing settings. Consumed internally by other
  * CES selectors (create-invoice, customer-detail, overview) and by non-settings
@@ -83,6 +87,37 @@ export interface InvoicingSettingsHubView {
  * and QBO slices read here are only fetched once a settings screen is mounted.
  */
 export declare const getInvoicingSettingsHubView: (state: RootState) => InvoicingSettingsHubView;
+export interface InvoicingQboSettingsFormView {
+    accountMappingKindOptions: InvoicingQboAccountMappingKindOption[];
+    /** Accounts for the mapping dropdowns, narrowed per kind by the page. */
+    accounts: InvoicingAccountingOption[];
+    backfillState: FetchStateAndError;
+    /** So the screen can fetch only what is missing, without reading the slices. */
+    configFetchState: FetchState;
+    customerMatchingOptions: InvoicingNamedOption[];
+    isLoading: boolean;
+    /** The persisted sync toggle — the backfill guard checks that, not the draft. */
+    isSyncEnabledSaved: boolean;
+    /** The draft the page edits, seeded from the settings response. */
+    localData: InvoicingQboSettingsLocalData;
+    nestedAccountHierarchy: NestedAccountHierarchyForReport[];
+    retryFetchStateByTaskId: Record<string, FetchStateAndError>;
+    saveState: FetchStateAndError;
+    settingsFetchState: FetchState;
+    syncStatusOptions: InvoicingNamedOption[];
+    connection?: InvoicingQboConnection;
+    syncHealth?: InvoicingQboSyncHealth;
+}
+/**
+ * Bundled view for the QBO configuration page: the draft it edits, the accounts
+ * and option lists its dropdowns render, the connection and sync health it
+ * reports, and the fetch states that decide between skeleton, form and error.
+ *
+ * `localData` is the draft once the user has edited, and the settings response
+ * before that — so the page has one field to read and CES owns when it becomes
+ * available, rather than the page copying settings into local state.
+ */
+export declare const getInvoicingQboSettingsFormView: (state: RootState) => InvoicingQboSettingsFormView;
 export interface InvoicingBrandingFormView {
     dateFormatOptions: InvoicingNamedOption[];
     localData: InvoicingBrandingFormLocalData;

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

@@ -1,11 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getInvoicingBrandingFormView = exports.getInvoicingSettingsHubView = exports.getInvoicingSettingsView = exports.getInvoicingSettingsFetchState = exports.getInvoicingSettings = void 0;
+exports.getInvoicingBrandingFormView = exports.getInvoicingQboSettingsFormView = 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 invoicingQboViewSelector_1 = require("../invoicingQboView/invoicingQboViewSelector");
 const invoicingBrandingFormConfig_1 = require("./invoicingBrandingFormConfig");
+const invoicingQboSettingsFormConfig_1 = require("./invoicingQboSettingsFormConfig");
 /**
  * Shared primitive: the raw invoicing settings. Consumed internally by other
  * CES selectors (create-invoice, customer-detail, overview) and by non-settings
@@ -100,6 +102,46 @@ const getInvoicingSettingsHubView = (state) => {
     };
 };
 exports.getInvoicingSettingsHubView = getInvoicingSettingsHubView;
+/**
+ * Bundled view for the QBO configuration page: the draft it edits, the accounts
+ * and option lists its dropdowns render, the connection and sync health it
+ * reports, and the fetch states that decide between skeleton, form and error.
+ *
+ * `localData` is the draft once the user has edited, and the settings response
+ * before that — so the page has one field to read and CES owns when it becomes
+ * available, rather than the page copying settings into local state.
+ */
+const getInvoicingQboSettingsFormView = (state) => {
+    const { error, fetchState, qboDraft, saveFetchState, settings } = state.invoicingSettingsViewState;
+    const { fetchState: configFetchState, qboAccountMappingKindOptions, qboCustomerMatchingOptions, qboSyncStatusOptions, } = (0, invoicingConfigViewSelector_1.getInvoicingConfigView)(state);
+    const qboView = (0, invoicingQboViewSelector_1.getInvoicingQboView)(state);
+    return {
+        accountMappingKindOptions: qboAccountMappingKindOptions,
+        accounts: qboView.accounts,
+        backfillState: qboView.backfillState,
+        connection: qboView.connection,
+        configFetchState,
+        customerMatchingOptions: qboCustomerMatchingOptions,
+        // The dropdowns cannot be built before both the settings and the accounts
+        // land, so the page waits on either rather than rendering empty pickers.
+        isLoading: fetchState === 'Not-Started' ||
+            fetchState === 'In-Progress' ||
+            (0, invoicingQboViewSelector_1.isInvoicingAccountingPickerDataLoading)(state),
+        isSyncEnabledSaved: settings?.qbo?.enabled === true,
+        // Seeded in the reducer when the settings response lands, so this is a plain
+        // read rather than a second place that decides what the page starts from.
+        localData: qboDraft ?? invoicingQboSettingsFormConfig_1.initialInvoicingQboSettingsLocalData,
+        nestedAccountHierarchy: qboView.nestedAccountHierarchy,
+        retryFetchStateByTaskId: qboView.retryFetchStateByTaskId,
+        saveState: saveFetchState.fetchState === 'Not-Started' && error != null
+            ? { fetchState, error }
+            : saveFetchState,
+        settingsFetchState: fetchState,
+        syncHealth: qboView.syncHealth,
+        syncStatusOptions: qboSyncStatusOptions,
+    };
+};
+exports.getInvoicingQboSettingsFormView = getInvoicingQboSettingsFormView;
 /**
  * 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/settingsView/settingsViewState.d.ts

@@ -1,9 +1,17 @@
 import { FetchStateAndError, FetchedState } from '../../../commonStateTypes/common';
 import { InvoicingSettingsPayload } from '../../../entity/invoicing/invoicingCommonPayload';
 import { InvoicingBrandingFormLocalData } from './invoicingBrandingFormConfig';
+import { InvoicingQboSettingsLocalData } from './invoicingQboSettingsFormConfig';
 export interface InvoicingSettingsViewState extends FetchedState {
     saveFetchState: FetchStateAndError;
     stripeFetchState: FetchStateAndError;
     brandingDraft?: InvoicingBrandingFormLocalData;
+    /**
+     * In-progress QBO settings edits. Held here rather than in the page so a
+     * selection cannot be lost between the change and the save, and so a
+     * half-finished edit survives navigating away. Undefined until first edited,
+     * which is what makes the server's settings the fallback.
+     */
+    qboDraft?: InvoicingQboSettingsLocalData;
     settings?: InvoicingSettingsPayload;
 }

package/package.json

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

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

@@ -1,92 +0,0 @@
-import { from, of } from 'rxjs';
-import { catchError, filter, mergeMap, switchMap } from 'rxjs/operators';
-import { updateAddresses } from '../../../entity/address/addressReducer';
-import { apiErrorSnackbarVariables } from '../../../entity/snackbar/snackbarApiError';
-import { openSnackbar } from '../../../entity/snackbar/snackbarReducer';
-import { createZeniAPIStatus, isSuccessResponse, } from '../../../responsePayload';
-import { connectInvoicingStripe, disconnectInvoicingStripe, fetchInvoicingSettings, invoicingStripeConnectionFailure, saveInvoicingSettings, saveInvoicingSettingsFailure, saveInvoicingSettingsSuccess, updateInvoicingSettings, updateInvoicingSettingsFailure, updateInvoicingStripeConnection, } from './settingsViewReducer';
-export const fetchInvoicingSettingsEpic = (actions$, _state$, zeniAPI) => actions$.pipe(filter(fetchInvoicingSettings.match), switchMap(() => {
-    const apiUrl = `${zeniAPI.apiEndPoints.invoicingMicroServiceBaseUrl}/1.0/settings`;
-    return zeniAPI.getJSON(apiUrl).pipe(switchMap((response) => {
-        if (isSuccessResponse(response) && response.data != null) {
-            const address = response.data.address;
-            return [
-                ...(address != null ? [updateAddresses([address])] : []),
-                updateInvoicingSettings(response.data),
-            ];
-        }
-        return of(updateInvoicingSettingsFailure(response.status));
-    }), catchError((error) => of(updateInvoicingSettingsFailure(createZeniAPIStatus('Unexpected Error', 'Fetch settings REST API call errored out ' +
-        JSON.stringify(error))))));
-}));
-export const connectInvoicingStripeEpic = (actions$, _state$, zeniAPI) => actions$.pipe(filter(connectInvoicingStripe.match), mergeMap((action) => {
-    const apiUrl = `${zeniAPI.apiEndPoints.invoicingMicroServiceBaseUrl}/1.0/settings/stripe-connect/setup`;
-    const { api_key, publishable_key, webhook_secret } = action.payload;
-    const body = {
-        api_key,
-        publishable_key,
-        ...(webhook_secret != null && webhook_secret !== ''
-            ? { webhook_secret }
-            : {}),
-    };
-    return zeniAPI
-        .postAndGetJSON(apiUrl, body)
-        .pipe(switchMap((response) => {
-        if (isSuccessResponse(response) && response.data != null) {
-            return of(updateInvoicingStripeConnection({
-                stripe_connected: response.data.stripe_connected,
-                publishable_key: response.data.publishable_key,
-            }), fetchInvoicingSettings());
-        }
-        return of(invoicingStripeConnectionFailure(response.status));
-    }), catchError((error) => of(invoicingStripeConnectionFailure(createZeniAPIStatus('Unexpected Error', 'Stripe connect setup REST API call errored out ' +
-        JSON.stringify(error))))));
-}));
-export const disconnectInvoicingStripeEpic = (actions$, _state$, zeniAPI) => actions$.pipe(filter(disconnectInvoicingStripe.match), mergeMap(() => {
-    const apiUrl = `${zeniAPI.apiEndPoints.invoicingMicroServiceBaseUrl}/1.0/settings/stripe-connect/callback`;
-    return zeniAPI
-        .deleteAndGetJSON(apiUrl)
-        .pipe(switchMap((response) => {
-        if (isSuccessResponse(response)) {
-            return of(updateInvoicingStripeConnection({
-                stripe_connected: false,
-                publishable_key: '',
-            }), fetchInvoicingSettings());
-        }
-        return of(invoicingStripeConnectionFailure(response.status));
-    }), catchError((error) => of(invoicingStripeConnectionFailure(createZeniAPIStatus('Unexpected Error', 'Stripe disconnect REST API call errored out ' +
-        JSON.stringify(error))))));
-}));
-export const saveInvoicingSettingsEpic = (actions$, _state$, zeniAPI) => actions$.pipe(filter(saveInvoicingSettings.match), mergeMap((action) => {
-    const apiUrl = `${zeniAPI.apiEndPoints.invoicingMicroServiceBaseUrl}/1.0/settings`;
-    const { settings, snackbarSection } = action.payload;
-    /** `status` surfaces the platform's error text; omit it to keep the generic copy. */
-    const snackbar = (messageText, status) => snackbarSection == null
-        ? []
-        : [
-            openSnackbar({
-                messageSection: snackbarSection,
-                messageText,
-                type: messageText === 'success' ? 'success' : 'error',
-                variables: apiErrorSnackbarVariables(status),
-            }),
-        ];
-    return zeniAPI
-        .putAndGetJSON(apiUrl, { ...settings })
-        .pipe(switchMap((response) => {
-        if (isSuccessResponse(response) && response.data != null) {
-            return from([
-                saveInvoicingSettingsSuccess(response.data),
-                ...snackbar('success'),
-            ]);
-        }
-        return from([
-            saveInvoicingSettingsFailure(response.status),
-            ...snackbar('failed', response.status),
-        ]);
-    }), catchError((error) => from([
-        saveInvoicingSettingsFailure(createZeniAPIStatus('Unexpected Error', 'Save settings REST API call errored out ' +
-            JSON.stringify(error))),
-        ...snackbar('failed'),
-    ])));
-}));

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

@@ -1,12 +0,0 @@
-import { ActionsObservable, StateObservable } from 'redux-observable';
-import { Observable } from 'rxjs';
-import { updateAddresses } from '../../../entity/address/addressReducer';
-import { openSnackbar } from '../../../entity/snackbar/snackbarReducer';
-import { RootState } from '../../../rootStateTypes';
-import { ZeniAPI } from '../../../zeniAPI';
-import { connectInvoicingStripe, disconnectInvoicingStripe, fetchInvoicingSettings, invoicingStripeConnectionFailure, saveInvoicingSettings, saveInvoicingSettingsFailure, saveInvoicingSettingsSuccess, updateInvoicingSettings, updateInvoicingSettingsFailure, updateInvoicingStripeConnection } from './settingsViewReducer';
-export type ActionType = ReturnType<typeof fetchInvoicingSettings> | ReturnType<typeof updateInvoicingSettings> | ReturnType<typeof updateInvoicingSettingsFailure> | ReturnType<typeof saveInvoicingSettings> | ReturnType<typeof saveInvoicingSettingsSuccess> | ReturnType<typeof saveInvoicingSettingsFailure> | ReturnType<typeof connectInvoicingStripe> | ReturnType<typeof disconnectInvoicingStripe> | ReturnType<typeof updateInvoicingStripeConnection> | ReturnType<typeof invoicingStripeConnectionFailure> | ReturnType<typeof updateAddresses> | ReturnType<typeof openSnackbar>;
-export declare const fetchInvoicingSettingsEpic: (actions$: ActionsObservable<ActionType>, _state$: StateObservable<RootState>, zeniAPI: ZeniAPI) => Observable<ActionType>;
-export declare const connectInvoicingStripeEpic: (actions$: ActionsObservable<ActionType>, _state$: StateObservable<RootState>, zeniAPI: ZeniAPI) => Observable<ActionType>;
-export declare const disconnectInvoicingStripeEpic: (actions$: ActionsObservable<ActionType>, _state$: StateObservable<RootState>, zeniAPI: ZeniAPI) => Observable<ActionType>;
-export declare const saveInvoicingSettingsEpic: (actions$: ActionsObservable<ActionType>, _state$: StateObservable<RootState>, zeniAPI: ZeniAPI) => Observable<ActionType>;

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

@@ -1,99 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.saveInvoicingSettingsEpic = exports.disconnectInvoicingStripeEpic = exports.connectInvoicingStripeEpic = exports.fetchInvoicingSettingsEpic = void 0;
-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");
-const fetchInvoicingSettingsEpic = (actions$, _state$, zeniAPI) => actions$.pipe((0, operators_1.filter)(settingsViewReducer_1.fetchInvoicingSettings.match), (0, operators_1.switchMap)(() => {
-    const apiUrl = `${zeniAPI.apiEndPoints.invoicingMicroServiceBaseUrl}/1.0/settings`;
-    return zeniAPI.getJSON(apiUrl).pipe((0, operators_1.switchMap)((response) => {
-        if ((0, responsePayload_1.isSuccessResponse)(response) && response.data != null) {
-            const address = response.data.address;
-            return [
-                ...(address != null ? [(0, addressReducer_1.updateAddresses)([address])] : []),
-                (0, settingsViewReducer_1.updateInvoicingSettings)(response.data),
-            ];
-        }
-        return (0, rxjs_1.of)((0, settingsViewReducer_1.updateInvoicingSettingsFailure)(response.status));
-    }), (0, operators_1.catchError)((error) => (0, rxjs_1.of)((0, settingsViewReducer_1.updateInvoicingSettingsFailure)((0, responsePayload_1.createZeniAPIStatus)('Unexpected Error', 'Fetch settings REST API call errored out ' +
-        JSON.stringify(error))))));
-}));
-exports.fetchInvoicingSettingsEpic = fetchInvoicingSettingsEpic;
-const connectInvoicingStripeEpic = (actions$, _state$, zeniAPI) => actions$.pipe((0, operators_1.filter)(settingsViewReducer_1.connectInvoicingStripe.match), (0, operators_1.mergeMap)((action) => {
-    const apiUrl = `${zeniAPI.apiEndPoints.invoicingMicroServiceBaseUrl}/1.0/settings/stripe-connect/setup`;
-    const { api_key, publishable_key, webhook_secret } = action.payload;
-    const body = {
-        api_key,
-        publishable_key,
-        ...(webhook_secret != null && webhook_secret !== ''
-            ? { webhook_secret }
-            : {}),
-    };
-    return zeniAPI
-        .postAndGetJSON(apiUrl, body)
-        .pipe((0, operators_1.switchMap)((response) => {
-        if ((0, responsePayload_1.isSuccessResponse)(response) && response.data != null) {
-            return (0, rxjs_1.of)((0, settingsViewReducer_1.updateInvoicingStripeConnection)({
-                stripe_connected: response.data.stripe_connected,
-                publishable_key: response.data.publishable_key,
-            }), (0, settingsViewReducer_1.fetchInvoicingSettings)());
-        }
-        return (0, rxjs_1.of)((0, settingsViewReducer_1.invoicingStripeConnectionFailure)(response.status));
-    }), (0, operators_1.catchError)((error) => (0, rxjs_1.of)((0, settingsViewReducer_1.invoicingStripeConnectionFailure)((0, responsePayload_1.createZeniAPIStatus)('Unexpected Error', 'Stripe connect setup REST API call errored out ' +
-        JSON.stringify(error))))));
-}));
-exports.connectInvoicingStripeEpic = connectInvoicingStripeEpic;
-const disconnectInvoicingStripeEpic = (actions$, _state$, zeniAPI) => actions$.pipe((0, operators_1.filter)(settingsViewReducer_1.disconnectInvoicingStripe.match), (0, operators_1.mergeMap)(() => {
-    const apiUrl = `${zeniAPI.apiEndPoints.invoicingMicroServiceBaseUrl}/1.0/settings/stripe-connect/callback`;
-    return zeniAPI
-        .deleteAndGetJSON(apiUrl)
-        .pipe((0, operators_1.switchMap)((response) => {
-        if ((0, responsePayload_1.isSuccessResponse)(response)) {
-            return (0, rxjs_1.of)((0, settingsViewReducer_1.updateInvoicingStripeConnection)({
-                stripe_connected: false,
-                publishable_key: '',
-            }), (0, settingsViewReducer_1.fetchInvoicingSettings)());
-        }
-        return (0, rxjs_1.of)((0, settingsViewReducer_1.invoicingStripeConnectionFailure)(response.status));
-    }), (0, operators_1.catchError)((error) => (0, rxjs_1.of)((0, settingsViewReducer_1.invoicingStripeConnectionFailure)((0, responsePayload_1.createZeniAPIStatus)('Unexpected Error', 'Stripe disconnect REST API call errored out ' +
-        JSON.stringify(error))))));
-}));
-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;
-    /** `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
-        .putAndGetJSON(apiUrl, { ...settings })
-        .pipe((0, operators_1.switchMap)((response) => {
-        if ((0, responsePayload_1.isSuccessResponse)(response) && response.data != null) {
-            return (0, rxjs_1.from)([
-                (0, settingsViewReducer_1.saveInvoicingSettingsSuccess)(response.data),
-                ...snackbar('success'),
-            ]);
-        }
-        return (0, rxjs_1.from)([
-            (0, settingsViewReducer_1.saveInvoicingSettingsFailure)(response.status),
-            ...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 ' +
-            JSON.stringify(error))),
-        ...snackbar('failed'),
-    ])));
-}));
-exports.saveInvoicingSettingsEpic = saveInvoicingSettingsEpic;