@zeniai/client-epic-state 5.3.8 → 5.3.10-beta0KB

package/lib/view/coachmarkPreferences/coachmarkPreferencesSelector.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDismissedCoachmarks = getDismissedCoachmarks;
+exports.isCoachmarkDismissed = isCoachmarkDismissed;
+exports.getCoachmarkPreferencesFetchState = getCoachmarkPreferencesFetchState;
+function getDismissedCoachmarks(state) {
+    return state.coachmarkPreferencesState.dismissedCoachmarks;
+}
+function isCoachmarkDismissed(state, coachmarkId) {
+    return state.coachmarkPreferencesState.dismissedCoachmarks.includes(coachmarkId);
+}
+function getCoachmarkPreferencesFetchState(state) {
+    return state.coachmarkPreferencesState.fetchState;
+}

package/lib/view/coachmarkPreferences/coachmarkPreferencesState.d.ts

@@ -0,0 +1,5 @@
+import { FetchStateAndError, FetchedState } from '../../commonStateTypes/common';
+export interface CoachmarkPreferencesState extends FetchedState {
+    coachmarkDismissUpdateStatus: FetchStateAndError;
+    dismissedCoachmarks: string[];
+}

package/lib/view/coachmarkPreferences/coachmarkPreferencesState.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/view/coachmarkPreferences/epic/fetchCoachmarkPreferencesEpic.d.ts

@@ -0,0 +1,12 @@
+import { ActionsObservable, StateObservable } from 'redux-observable';
+import { RootState } from '../../../rootStateTypes';
+import { ZeniAPI } from '../../../zeniAPI';
+import { fetchCoachmarkPreferences, fetchCoachmarkPreferencesFailure, fetchCoachmarkPreferencesSuccess } from '../coachmarkPreferencesReducer';
+export type ActionType = ReturnType<typeof fetchCoachmarkPreferences> | ReturnType<typeof fetchCoachmarkPreferencesSuccess> | ReturnType<typeof fetchCoachmarkPreferencesFailure>;
+export declare const fetchCoachmarkPreferencesEpic: (actions$: ActionsObservable<ActionType>, _: StateObservable<RootState>, zeniAPI: ZeniAPI) => import("rxjs").Observable<{
+    payload: string[];
+    type: "coachmarkPreferences/fetchCoachmarkPreferencesSuccess";
+} | {
+    payload: import("../../../zeniAPIStatus").ZeniAPIStatus<Record<string, unknown>>;
+    type: "coachmarkPreferences/fetchCoachmarkPreferencesFailure";
+}>;

package/lib/view/coachmarkPreferences/epic/fetchCoachmarkPreferencesEpic.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchCoachmarkPreferencesEpic = void 0;
+const rxjs_1 = require("rxjs");
+const operators_1 = require("rxjs/operators");
+const responsePayload_1 = require("../../../responsePayload");
+const coachmarkPreferencesReducer_1 = require("../coachmarkPreferencesReducer");
+const fetchCoachmarkPreferencesEpic = (actions$, _, zeniAPI) => actions$.pipe((0, operators_1.filter)(coachmarkPreferencesReducer_1.fetchCoachmarkPreferences.match), (0, operators_1.switchMap)(() => zeniAPI
+    .getJSON(`${zeniAPI.apiEndPoints.tenantMicroServiceBaseUrl}/1.0/webapp-preferences`)
+    .pipe((0, operators_1.map)((response) => {
+    if ((0, responsePayload_1.isSuccessResponse)(response) && response.data) {
+        return (0, coachmarkPreferencesReducer_1.fetchCoachmarkPreferencesSuccess)(response.data.dismissed_coachmarks ?? []);
+    }
+    // No preferences doc yet (404) means nothing has been dismissed —
+    // treat it as an empty set so first-time users still see coachmarks.
+    if (response.status.code === 404) {
+        return (0, coachmarkPreferencesReducer_1.fetchCoachmarkPreferencesSuccess)([]);
+    }
+    return (0, coachmarkPreferencesReducer_1.fetchCoachmarkPreferencesFailure)(response.status);
+}), (0, operators_1.catchError)((error) => (0, rxjs_1.of)((0, coachmarkPreferencesReducer_1.fetchCoachmarkPreferencesFailure)((0, responsePayload_1.createZeniAPIStatus)('Unexpected Error', 'Coachmark preferences REST API call errored out: ' +
+    (error instanceof Error ? error.message : String(error)))))))));
+exports.fetchCoachmarkPreferencesEpic = fetchCoachmarkPreferencesEpic;

package/lib/view/coachmarkPreferences/epic/markCoachmarkDismissedEpic.d.ts

@@ -0,0 +1,6 @@
+import { ActionsObservable, StateObservable } from 'redux-observable';
+import { RootState } from '../../../rootStateTypes';
+import { ZeniAPI } from '../../../zeniAPI';
+import { markCoachmarkDismissed, markCoachmarkDismissedFailure, markCoachmarkDismissedSuccess } from '../coachmarkPreferencesReducer';
+export type ActionType = ReturnType<typeof markCoachmarkDismissed> | ReturnType<typeof markCoachmarkDismissedSuccess> | ReturnType<typeof markCoachmarkDismissedFailure>;
+export declare const markCoachmarkDismissedEpic: (actions$: ActionsObservable<ActionType>, state$: StateObservable<RootState>, zeniAPI: ZeniAPI) => import("rxjs").Observable<ActionType>;

package/lib/view/coachmarkPreferences/epic/markCoachmarkDismissedEpic.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.markCoachmarkDismissedEpic = void 0;
+const rxjs_1 = require("rxjs");
+const operators_1 = require("rxjs/operators");
+const responsePayload_1 = require("../../../responsePayload");
+const coachmarkPreferencesReducer_1 = require("../coachmarkPreferencesReducer");
+const markCoachmarkDismissedEpic = (actions$, state$, zeniAPI) => actions$.pipe((0, operators_1.filter)(coachmarkPreferencesReducer_1.markCoachmarkDismissed.match), (0, operators_1.concatMap)(() => {
+    // The reducer has already appended the id optimistically, so state holds
+    // the full set to persist.
+    const dismissedCoachmarks = state$.value.coachmarkPreferencesState.dismissedCoachmarks;
+    const url = `${zeniAPI.apiEndPoints.tenantMicroServiceBaseUrl}/1.0/webapp-preferences`;
+    const body = { dismissed_coachmarks: dismissedCoachmarks };
+    const toResultAction = (response) => (0, responsePayload_1.isSuccessResponse)(response) && response.data
+        ? (0, coachmarkPreferencesReducer_1.markCoachmarkDismissedSuccess)(response.data.dismissed_coachmarks ?? dismissedCoachmarks)
+        : (0, coachmarkPreferencesReducer_1.markCoachmarkDismissedFailure)(response.status);
+    return zeniAPI
+        .putAndGetJSON(url, body)
+        .pipe((0, operators_1.mergeMap)((putResponse) => {
+        // No preferences doc yet — create it with POST.
+        if (!(0, responsePayload_1.isSuccessResponse)(putResponse) &&
+            putResponse.status.code === 404) {
+            return zeniAPI
+                .postAndGetJSON(url, body)
+                .pipe((0, operators_1.map)(toResultAction));
+        }
+        return (0, rxjs_1.of)(toResultAction(putResponse));
+    }), (0, operators_1.catchError)((error) => (0, rxjs_1.of)((0, coachmarkPreferencesReducer_1.markCoachmarkDismissedFailure)((0, responsePayload_1.createZeniAPIStatus)('Unexpected Error', 'Coachmark dismiss REST API call errored out: ' +
+        (error instanceof Error ? error.message : String(error)))))));
+}));
+exports.markCoachmarkDismissedEpic = markCoachmarkDismissedEpic;

package/lib/view/dashboardLayout/fetchDashboardLayoutEpic.js

@@ -10,8 +10,10 @@ const fetchDashboardLayoutEpic = (actions$, _, zeniAPI) => actions$.pipe((0, ope
     .getJSON(`${zeniAPI.apiEndPoints.tenantMicroServiceBaseUrl}/1.0/webapp-preferences`)
     .pipe((0, operators_1.mergeMap)((response) => {
     if ((0, responsePayload_1.isSuccessResponse)(response) && response.data) {
-        const cardOrder = response.data.preferences
-            .card_order;
+        // A coachmark-first user has a preferences doc with no
+        // card_order (or none at all) — fall back to the default order.
+        const cardOrder = (response.data.preferences?.card_order ??
+            dashboardLayoutReducer_2.defaultCardsInOrder);
         let updatedCardOrder = [...cardOrder];
         const treasuryIdx = updatedCardOrder.indexOf('treasury_promo_card');
         const zeniPromoIdx = updatedCardOrder.indexOf('zeni_promo_card');

package/lib/view/transactionDetail/createTransaction/createTransactionPayload.d.ts

@@ -13,8 +13,8 @@ import { CreateTransactionLocalData } from './createTransactionState';
  *    constant NAMES; ZENI_LINE_DETAIL_TYPE_TO_QBO_LINE_DETAIL_TYPE_MAP converts them for the
  *    body the backend sends on to QuickBooks, never for ours.
  * 2. The QBO Purchases (check, credit_card_credit) send their reference number as
- *    `document_number`; a journal entry sends its entry name as `document_id`. Both land on
- *    QBO's DocNumber, but QBOJournalEntry reads only `document_id`.
+ *    `document_number`; a journal entry sends its entry name, and a bill its bill number, as
+ *    `document_id`. All land on QBO's DocNumber, but QBOJournalEntry reads only `document_id`.
  */
 export interface CreateTransactionAccountPayload {
     qbo_id: ID;
@@ -53,10 +53,12 @@ export interface CreateTransactionRemitToAddressPayload {
 export interface CreateTransactionRequest extends Record<string, unknown> {
     transaction_date: string;
     transaction_type: string;
-    /** journal_entry entry name (QBO DocNumber). */
+    /** journal_entry entry name or bill number (QBO DocNumber). */
     document_id?: string;
     /** check / credit_card_credit reference number (QBO Purchase). */
     document_number?: string;
+    /** bill only. */
+    due_date?: string;
     from_account_id?: ID;
     /** credit_card_credit is modelled as a Purchase with Credit: true. */
     is_credit?: boolean;

package/lib/view/transactionDetail/createTransaction/createTransactionPayload.js

@@ -135,13 +135,21 @@ const prepareCreateTransactionPayload = (state, localData) => {
         };
     }
     const lines = localData.lines.map((line) => toLinePayload(state, line, transactionType));
+    const documentId = localData.documentNumber != null && localData.documentNumber !== ''
+        ? { document_id: localData.documentNumber }
+        : {};
     if (transactionType === 'journal_entry') {
+        return { ...base, ...documentId, lines };
+    }
+    // A bill posts to accounts payable, so it carries no header account or payment type.
+    if (transactionType === 'bill') {
         return {
             ...base,
-            ...(localData.documentNumber != null &&
-                localData.documentNumber !== '' && {
-                document_id: localData.documentNumber,
+            vendor_id: toQboVendorId(state, localData.vendorId),
+            ...(localData.dueDate != null && {
+                due_date: localData.dueDate.format(timePeriod_1.DEFAULT_DATE_FORMAT),
             }),
+            ...documentId,
             lines,
         };
     }

package/lib/view/transactionDetail/createTransaction/createTransactionState.d.ts

@@ -9,7 +9,7 @@ import { ZeniDate } from '../../../zeniDayJS';
  * The transaction types the Create Transaction flow can originate. A narrow subset of
  * TransactionType -- everything else is read-only and arrives via sync.
  */
-export declare const ALL_CREATABLE_TRANSACTION_TYPES: readonly ["expense", "check", "credit_card_credit", "transfer", "journal_entry"];
+export declare const ALL_CREATABLE_TRANSACTION_TYPES: readonly ["expense", "check", "credit_card_credit", "transfer", "journal_entry", "bill"];
 export type CreatableTransactionType = (typeof ALL_CREATABLE_TRANSACTION_TYPES)[number];
 /**
  * The wire shape the create endpoint expects for a check's remit-to address. Deliberately not
@@ -54,8 +54,10 @@ export interface CreateTransactionLocalData {
     /** Empty for transfer, which has no lines at all. */
     lines: CreateTransactionLineLocalData[];
     transactionType: CreatableTransactionType;
-    /** check / credit_card_credit reference number, or the journal_entry entry name. */
+    /** check / credit_card_credit reference number, journal_entry entry name, or bill number. */
     documentNumber?: string;
+    /** bill only. */
+    dueDate?: ZeniDate;
     /** transfer */
     fromAccountId?: ID;
     paymentType?: PaymentType;

package/lib/view/transactionDetail/createTransaction/createTransactionState.js

@@ -11,4 +11,5 @@ exports.ALL_CREATABLE_TRANSACTION_TYPES = [
     'credit_card_credit',
     'transfer',
     'journal_entry',
+    'bill',
 ];

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

@@ -177,39 +177,39 @@ export declare const downloadAccountingProviderAttachment: import("@reduxjs/tool
 }, "transactionDetail/deleteSplitLine", never, never>, toggleSplitEditMode: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[transactionId: TransactionID, editMode: boolean], {
     transactionId: TransactionID;
     editMode: boolean;
-}, "transactionDetail/toggleSplitEditMode", never, never>, initializeCreateTransactionLocalData: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[transactionType: "expense" | "check" | "credit_card_credit" | "transfer" | "journal_entry"], {
-    transactionType: "expense" | "check" | "credit_card_credit" | "transfer" | "journal_entry";
-}, "transactionDetail/initializeCreateTransactionLocalData", never, never>, updateCreateTransactionLocalData: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[transactionType: "expense" | "check" | "credit_card_credit" | "transfer" | "journal_entry", localData: Partial<CreateTransactionLocalData>], {
-    transactionType: "expense" | "check" | "credit_card_credit" | "transfer" | "journal_entry";
+}, "transactionDetail/toggleSplitEditMode", never, never>, initializeCreateTransactionLocalData: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[transactionType: "expense" | "check" | "bill" | "credit_card_credit" | "transfer" | "journal_entry"], {
+    transactionType: "expense" | "check" | "bill" | "credit_card_credit" | "transfer" | "journal_entry";
+}, "transactionDetail/initializeCreateTransactionLocalData", never, never>, updateCreateTransactionLocalData: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[transactionType: "expense" | "check" | "bill" | "credit_card_credit" | "transfer" | "journal_entry", localData: Partial<CreateTransactionLocalData>], {
+    transactionType: "expense" | "check" | "bill" | "credit_card_credit" | "transfer" | "journal_entry";
     localData: Partial<CreateTransactionLocalData>;
-}, "transactionDetail/updateCreateTransactionLocalData", never, never>, updateCreateTransactionLineLocalData: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[transactionType: "expense" | "check" | "credit_card_credit" | "transfer" | "journal_entry", lineId: string, lineUpdates: Partial<CreateTransactionLineLocalData>], {
-    transactionType: "expense" | "check" | "credit_card_credit" | "transfer" | "journal_entry";
+}, "transactionDetail/updateCreateTransactionLocalData", never, never>, updateCreateTransactionLineLocalData: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[transactionType: "expense" | "check" | "bill" | "credit_card_credit" | "transfer" | "journal_entry", lineId: string, lineUpdates: Partial<CreateTransactionLineLocalData>], {
+    transactionType: "expense" | "check" | "bill" | "credit_card_credit" | "transfer" | "journal_entry";
     lineId: string;
     lineUpdates: Partial<CreateTransactionLineLocalData>;
-}, "transactionDetail/updateCreateTransactionLineLocalData", never, never>, addCreateTransactionLine: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[transactionType: "expense" | "check" | "credit_card_credit" | "transfer" | "journal_entry", line?: Partial<CreateTransactionLineLocalData> | undefined], {
-    transactionType: "expense" | "check" | "credit_card_credit" | "transfer" | "journal_entry";
+}, "transactionDetail/updateCreateTransactionLineLocalData", never, never>, addCreateTransactionLine: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[transactionType: "expense" | "check" | "bill" | "credit_card_credit" | "transfer" | "journal_entry", line?: Partial<CreateTransactionLineLocalData> | undefined], {
+    transactionType: "expense" | "check" | "bill" | "credit_card_credit" | "transfer" | "journal_entry";
     line: Partial<CreateTransactionLineLocalData> | undefined;
-}, "transactionDetail/addCreateTransactionLine", never, never>, removeCreateTransactionLine: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[transactionType: "expense" | "check" | "credit_card_credit" | "transfer" | "journal_entry", lineId: string], {
-    transactionType: "expense" | "check" | "credit_card_credit" | "transfer" | "journal_entry";
+}, "transactionDetail/addCreateTransactionLine", never, never>, removeCreateTransactionLine: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[transactionType: "expense" | "check" | "bill" | "credit_card_credit" | "transfer" | "journal_entry", lineId: string], {
+    transactionType: "expense" | "check" | "bill" | "credit_card_credit" | "transfer" | "journal_entry";
     lineId: string;
-}, "transactionDetail/removeCreateTransactionLine", never, never>, resetCreateTransactionLocalData: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[transactionType: "expense" | "check" | "credit_card_credit" | "transfer" | "journal_entry"], {
-    transactionType: "expense" | "check" | "credit_card_credit" | "transfer" | "journal_entry";
-}, "transactionDetail/resetCreateTransactionLocalData", never, never>, createTransaction: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[transactionType: "expense" | "check" | "credit_card_credit" | "transfer" | "journal_entry"], {
-    transactionType: "expense" | "check" | "credit_card_credit" | "transfer" | "journal_entry";
+}, "transactionDetail/removeCreateTransactionLine", never, never>, resetCreateTransactionLocalData: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[transactionType: "expense" | "check" | "bill" | "credit_card_credit" | "transfer" | "journal_entry"], {
+    transactionType: "expense" | "check" | "bill" | "credit_card_credit" | "transfer" | "journal_entry";
+}, "transactionDetail/resetCreateTransactionLocalData", never, never>, createTransaction: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[transactionType: "expense" | "check" | "bill" | "credit_card_credit" | "transfer" | "journal_entry"], {
+    transactionType: "expense" | "check" | "bill" | "credit_card_credit" | "transfer" | "journal_entry";
 }, "transactionDetail/createTransaction", never, never>, createTransactionSuccessOrFailure: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[fetchState: FetchState, createdTransactionId?: TransactionID | undefined, error?: ZeniAPIStatus<Record<string, unknown>> | undefined], {
     fetchState: FetchState;
     createdTransactionId: TransactionID | undefined;
     error: ZeniAPIStatus<Record<string, unknown>> | undefined;
-}, "transactionDetail/createTransactionSuccessOrFailure", never, never>, setRecommendationsForCreateTransactionLines: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[transactionType: "expense" | "check" | "credit_card_credit" | "transfer" | "journal_entry", lineIds: string[], recommendations: Recommendation[], isAccountingClassesEnabled: boolean], {
-    transactionType: "expense" | "check" | "credit_card_credit" | "transfer" | "journal_entry";
+}, "transactionDetail/createTransactionSuccessOrFailure", never, never>, setRecommendationsForCreateTransactionLines: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[transactionType: "expense" | "check" | "bill" | "credit_card_credit" | "transfer" | "journal_entry", lineIds: string[], recommendations: Recommendation[], isAccountingClassesEnabled: boolean], {
+    transactionType: "expense" | "check" | "bill" | "credit_card_credit" | "transfer" | "journal_entry";
     lineIds: string[];
     recommendations: Recommendation[];
     isAccountingClassesEnabled: boolean;
-}, "transactionDetail/setRecommendationsForCreateTransactionLines", never, never>, clearRecommendationsForCreateTransactionLines: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[transactionType: "expense" | "check" | "credit_card_credit" | "transfer" | "journal_entry", lineIds: string[]], {
-    transactionType: "expense" | "check" | "credit_card_credit" | "transfer" | "journal_entry";
+}, "transactionDetail/setRecommendationsForCreateTransactionLines", never, never>, clearRecommendationsForCreateTransactionLines: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[transactionType: "expense" | "check" | "bill" | "credit_card_credit" | "transfer" | "journal_entry", lineIds: string[]], {
+    transactionType: "expense" | "check" | "bill" | "credit_card_credit" | "transfer" | "journal_entry";
     lineIds: string[];
-}, "transactionDetail/clearRecommendationsForCreateTransactionLines", never, never>, fetchVendorRecommendationsForCreateTransaction: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[transactionType: "expense" | "check" | "credit_card_credit" | "transfer" | "journal_entry", lineIds: string[], entity?: Entity | undefined], {
-    transactionType: "expense" | "check" | "credit_card_credit" | "transfer" | "journal_entry";
+}, "transactionDetail/clearRecommendationsForCreateTransactionLines", never, never>, fetchVendorRecommendationsForCreateTransaction: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[transactionType: "expense" | "check" | "bill" | "credit_card_credit" | "transfer" | "journal_entry", lineIds: string[], entity?: Entity | undefined], {
+    transactionType: "expense" | "check" | "bill" | "credit_card_credit" | "transfer" | "journal_entry";
     lineIds: string[];
     entity: Entity | undefined;
 }, "transactionDetail/fetchVendorRecommendationsForCreateTransaction", never, never>, createTransactionAttachmentUploadFailure: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[failedAttachmentFileNames: string[]], {

package/package.json

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