@zeniai/client-epic-state 5.2.74 → 5.2.76

package/lib/view/companyTaskManagerView/epics/fetchCompanyTaskManagerViewEpic.js

@@ -7,19 +7,41 @@ const sortOrderPayload_1 = require("../../../commonPayloadTypes/sortOrderPayload
 const tagReducer_1 = require("../../../entity/tag/tagReducer");
 const taskReducer_1 = require("../../../entity/task/taskReducer");
 const responsePayload_1 = require("../../../responsePayload");
+const zeniDayJS_1 = require("../../../zeniDayJS");
 const companyTaskManagerViewReducer_1 = require("../companyTaskManagerViewReducer");
 const DEFAULT_PAGE_SIZE = 100;
-const fetchCompanyTaskManagerViewEpic = (actions$, _state$, zeniAPI) => actions$.pipe((0, operators_1.filter)(companyTaskManagerViewReducer_1.fetchCompanyTaskManagerView.match), (0, operators_1.switchMap)((action) => {
+// Mutates the accumulator rather than spreading it: spreading rebuilds the whole
+// map on every entry, which is O(n^2) over a tenant's tag list.
+const toTagNameByID = (state) => Object.entries(state.tagState.tagByID).reduce((result, [tagId, tag]) => {
+    const name = tag?.name;
+    if (name != null && name !== '') {
+        result[tagId] = name;
+    }
+    return result;
+}, {});
+const hasTagCategory = (filters) => (filters?.categories ?? []).some((category) => category.field === 'tag');
+const fetchCompanyTaskManagerViewEpic = (actions$, state$, zeniAPI) => actions$.pipe((0, operators_1.filter)(companyTaskManagerViewReducer_1.fetchCompanyTaskManagerView.match), (0, operators_1.switchMap)((action) => {
     const { from: fromOffset, searchString, sortKey, sortOrder, filters, } = action.payload;
     const queryValue = {
         size: DEFAULT_PAGE_SIZE,
         from: fromOffset,
         global_search: searchString ?? '',
+        // TasksEsSearch defaults this to true, which AND-injects an
+        // `assignees = <caller>` filter. Cockpit's task list is a cross-tenant
+        // view grouped by company (and offers an Assignee filter), so it must
+        // NOT be scoped to the operator — otherwise every category filter
+        // AND's down to their own tasks and returns nothing. The metrics panel
+        // deliberately passes `true`; this list deliberately passes `false`.
+        is_filter_by_logged_in_user: false,
         sort_by: toSortKeyPayload(sortKey),
         sort_order: (0, sortOrderPayload_1.getSortOrder)(sortOrder),
         filter_join: filters?.categoryCombinationOperator === 'AND' ? 'and' : 'or',
         ...(filters?.categories != null && filters.categories.length > 0
-            ? { filter_by: toFilterByPayload(filters) }
+            ? {
+                // Only walk the tag map when a tag filter is actually in play;
+                // otherwise every dispatch pays for a map nothing reads.
+                filter_by: toFilterByPayload(filters, hasTagCategory(filters) ? toTagNameByID(state$.value) : {}),
+            }
             : {}),
         task_group_scopes: filters?.taskGroupScopes != null && filters.taskGroupScopes.length > 0
             ? filters.taskGroupScopes
@@ -67,14 +89,123 @@ const toSortKeyPayload = (sortKey) => {
             return sortKey;
     }
 };
-const toFilterByPayload = (filters) => {
+// Cockpit filter-category keys are UI identifiers; the ES index uses its own
+// field names (see TasksEsSearch.get). Anything not listed here already matches
+// the contract (assignees, priority, status, company_id).
+const ES_FIELD_BY_CATEGORY = {
+    creationDate: 'create_time',
+    dueDate: 'due_date',
+    tag: 'tags',
+};
+// ES rejects `is` / `is_not` on date fields — they only accept `between`, whose
+// values are the [start, end] pair the dateRange picker already emits.
+const ES_DATE_FIELDS = new Set(['create_time', 'due_date']);
+// The cockpit date picker hands over ZeniDate objects; once filters have round-
+// tripped through redux they can arrive as ISO or date-only strings instead.
+// Both have to reach ES as instants: `create_time`/`update_time` carry a real
+// timestamp, so a date-only upper bound lands on midnight and drops everything
+// created later that day — a single-day Created filter would return almost
+// nothing, which is the empty state this epic exists to fix.
+// A real check rather than `value as ZeniDate`: the cast would silently lie
+// about a raw Date, a number, or anything else redux hands back, leaving the
+// runtime guard as the only thing standing between us and a crash.
+const isZeniDateLike = (value) => value != null &&
+    typeof value.isValid === 'function' &&
+    typeof value.format === 'function';
+const CALENDAR_DATE_ONLY = /^\d{4}-\d{2}-\d{2}$/;
+const toDateBound = (value, edge) => {
+    // A bare `YYYY-MM-DD` carries no instant to misread — use it verbatim. This
+    // is the only genuinely timezone-proof shape, which is why it is worth a
+    // fast path of its own.
+    if (typeof value === 'string' && CALENDAR_DATE_ONLY.test(value)) {
+        return edge === 'start'
+            ? `${value}T00:00:00.000Z`
+            : `${value}T23:59:59.999Z`;
+    }
+    // Everything else came from the picker, and the picker emits LOCAL midnight:
+    // `ZeniDatePicker` hands react-datepicker's local-midnight Date to
+    // `zeniDate(date.toISOString())`. So the instant encodes "midnight on the day
+    // the user clicked, in the user's zone" — and the day they clicked is
+    // recovered by reading it locally, never in UTC.
+    //
+    // Reading it in UTC subtracts the offset for every UTC+ operator: clicking
+    // "Mar 4" in Asia/Kolkata stores 2026-03-03T18:30:00Z, which is the 3rd in
+    // UTC. A single-day filter then returns the wrong day's tasks rather than
+    // none, and US-based testing never sees it.
+    const parsed = typeof value === 'string' ? (0, zeniDayJS_1.date)(value) : value;
+    if (!isZeniDateLike(parsed) || !parsed.isValid()) {
+        // Drop the row rather than send garbage: ES rejects the whole request on
+        // one bad bound, taking the other filters down with it.
+        return '';
+    }
+    const ymd = parsed.format('YYYY-MM-DD');
+    return edge === 'start' ? `${ymd}T00:00:00.000Z` : `${ymd}T23:59:59.999Z`;
+};
+const toFilterByPayload = (filters, tagNameByID) => {
     if (filters.categories == null) {
         return [];
     }
-    return filters.categories.map((category) => ({
-        field: category.field ?? '',
-        operator: category.matchingOperator === 'equal' ? 'is' : 'is_not',
-        values: category.values.map((v) => String(v)),
-        join: category.valuesCombinationOperator === 'ALL' ? 'and' : 'or',
-    }));
+    return filters.categories.flatMap((category) => {
+        const categoryField = category.field ?? '';
+        const field = ES_FIELD_BY_CATEGORY[categoryField] ?? categoryField;
+        // The dropdown is keyed by tagId, but ES matches `tags` on the tag NAME,
+        // so resolve through the tag entity this epic itself populates. Unknown ids
+        // fall through unchanged rather than being dropped.
+        const isDateField = ES_DATE_FIELDS.has(field);
+        // `between` is exactly [from, to]. A half-filled picker (one value) makes ES
+        // reject the query outright, and a longer array would quietly bind extras to
+        // `end` — both land the user back on an unexplained empty page, which is the
+        // failure this epic exists to remove. Drop the row instead.
+        if (isDateField && category.values.length !== 2) {
+            return [];
+        }
+        const values = category.values.map((value, index) => {
+            if (isDateField) {
+                // [from, to] — widen the upper bound to the end of its day.
+                return toDateBound(value, index === 0 ? 'start' : 'end');
+            }
+            const raw = String(value);
+            if (field !== 'tags') {
+                return raw;
+            }
+            // An id we cannot resolve would reach ES verbatim and match nothing —
+            // another silent empty page. Can happen when a filter is hydrated from the
+            // URL before `updateTags` has populated `tagByID`, so keep the value
+            // (dropping it would widen the result set) but make it visible in logs.
+            const tagName = tagNameByID[raw];
+            if (tagName == null) {
+                console.debug(`[taskManager] unresolved tagId "${raw}" sent to ES verbatim; expect no matches`);
+            }
+            return tagName ?? raw;
+        });
+        // `toDateBound` returns '' for a value it cannot parse. Honour that here:
+        // emitting a `between` with an empty bound fails the whole ES query, which
+        // takes every OTHER filter in the same request down with it — the silent
+        // empty page this epic exists to remove, from one unparseable value that a
+        // URL-hydrated filter can supply.
+        if (isDateField && values.some((value) => value === '')) {
+            return [];
+        }
+        // ES has no date-exclusion operator: `is`/`is_not` are rejected on date
+        // fields, and `between` can only select a range, never exclude one. The
+        // operator dropdown still offers "is not" for every category, so an excluded
+        // date range would otherwise be sent as a plain `between` — returning exactly
+        // the rows the user asked to hide. Drop the row instead: a superset is
+        // wrong-but-obvious, an inverted result is wrong-and-invisible.
+        if (isDateField && category.matchingOperator !== 'equal') {
+            return [];
+        }
+        return [
+            {
+                field,
+                operator: isDateField
+                    ? 'between'
+                    : category.matchingOperator === 'equal'
+                        ? 'is'
+                        : 'is_not',
+                values,
+                join: category.valuesCombinationOperator === 'ALL' ? 'and' : 'or',
+            },
+        ];
+    });
 };

package/lib/view/invoicing/editInvoicingSubscriptionDetailView/editInvoicingSubscriptionDetailViewPayload.d.ts

@@ -1,7 +1,7 @@
 import { InvoicingSubscriptionPayload } from '../../../entity/invoicing/invoicingSubscription/invoicingSubscriptionPayload';
 import { ZeniAPIResponse } from '../../../responsePayload';
 import { AddressUpdatableInfo } from '../../addressView/addressViewState';
-import { InvoicingSubscriptionFormLocalData } from './editInvoicingSubscriptionDetailViewState';
+import { InvoicingSubscriptionEstimate, InvoicingSubscriptionFormLocalData } from './editInvoicingSubscriptionDetailViewState';
 export type SaveInvoicingSubscriptionResponse = ZeniAPIResponse<InvoicingSubscriptionPayload>;
 /**
  * Build the create/update subscription request body from the form draft. The
@@ -74,3 +74,48 @@ export type ScheduleChargeBody = {
 };
 export type InvoicingSubscriptionActionBody = ApplyCouponBody | RemoveCouponBody | AddChargesBody | PauseSubscriptionBody | CancelSubscriptionBody | ChangePlanBody | ChangeTermEndBody | ScheduleChargeBody | Record<string, never>;
 export type InvoicingSubscriptionDetailResponse = ZeniAPIResponse<InvoicingSubscriptionPayload>;
+interface InvoicingSubscriptionEstimateLineItemPayload {
+    amount: number;
+    description: string;
+    discount_amount: number;
+    quantity: number;
+    unit_amount: number;
+    date_from?: string;
+    date_to?: string;
+    tax_amount?: number | null;
+}
+interface InvoicingSubscriptionInvoiceEstimatePayload {
+    amount_due: number;
+    coupon_discount_total: number;
+    credits_applied: number;
+    gross_sub_total: number;
+    line_items: InvoicingSubscriptionEstimateLineItemPayload[];
+    promotional_credits_applied: number;
+    sub_total: number;
+    tax: number | null;
+    total: number;
+    due_date?: string;
+    invoice_date?: string;
+}
+export interface InvoicingSubscriptionEstimatePayload {
+    currency_code: string;
+    currency_symbol: string;
+    invoice_estimate: InvoicingSubscriptionInvoiceEstimatePayload | null;
+    next_invoice_estimate: InvoicingSubscriptionInvoiceEstimatePayload | null;
+    proration_estimate: {
+        document_type: string;
+        invoice_estimate: InvoicingSubscriptionInvoiceEstimatePayload | null;
+        net: number;
+    } | null;
+    reason: string;
+    subscription_estimate: {
+        becomes_non_renewing_after_this_term?: boolean;
+        current_term_end?: string;
+        current_term_start?: string;
+        next_billing_at?: string | null;
+    } | null;
+    will_be_invoiced: boolean;
+}
+export type InvoicingSubscriptionEstimateResponse = ZeniAPIResponse<InvoicingSubscriptionEstimatePayload>;
+export declare const mapInvoicingSubscriptionEstimatePayloadToState: (payload: InvoicingSubscriptionEstimatePayload) => InvoicingSubscriptionEstimate;
+export {};

package/lib/view/invoicing/editInvoicingSubscriptionDetailView/editInvoicingSubscriptionDetailViewPayload.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.localDataToSaveInvoicingSubscriptionPayload = void 0;
+exports.mapInvoicingSubscriptionEstimatePayloadToState = exports.localDataToSaveInvoicingSubscriptionPayload = void 0;
+const amount_1 = require("../../../commonStateTypes/amount");
+const zeniDayJS_1 = require("../../../zeniDayJS");
 const addressViewPayload_1 = require("../../addressView/addressViewPayload");
 const invoicingSubscriptionFormConfig_1 = require("./invoicingSubscriptionFormConfig");
 /**
@@ -60,3 +62,57 @@ const localDataToSaveInvoicingSubscriptionPayload = (localData, shippingAddress)
     };
 };
 exports.localDataToSaveInvoicingSubscriptionPayload = localDataToSaveInvoicingSubscriptionPayload;
+const toEstimateDate = (value) => value != null && value !== '' ? (0, zeniDayJS_1.date)(value) : undefined;
+const mapInvoiceEstimate = (payload, money) => payload == null
+    ? undefined
+    : {
+        amountDue: money(payload.amount_due),
+        couponDiscountTotal: money(payload.coupon_discount_total),
+        creditsApplied: money(payload.credits_applied),
+        dueDate: toEstimateDate(payload.due_date),
+        grossSubTotal: money(payload.gross_sub_total),
+        invoiceDate: toEstimateDate(payload.invoice_date),
+        lineItems: payload.line_items.map((lineItem) => ({
+            amount: money(lineItem.amount),
+            dateFrom: toEstimateDate(lineItem.date_from),
+            dateTo: toEstimateDate(lineItem.date_to),
+            description: lineItem.description,
+            discountAmount: money(lineItem.discount_amount),
+            quantity: lineItem.quantity,
+            taxAmount: lineItem.tax_amount != null
+                ? money(lineItem.tax_amount)
+                : undefined,
+            unitAmount: money(lineItem.unit_amount),
+        })),
+        promotionalCreditsApplied: money(payload.promotional_credits_applied),
+        subTotal: money(payload.sub_total),
+        tax: payload.tax != null ? money(payload.tax) : undefined,
+        total: money(payload.total),
+    };
+const mapInvoicingSubscriptionEstimatePayloadToState = (payload) => {
+    const money = (amount) => (0, amount_1.toAmount)(amount, payload.currency_code, payload.currency_symbol);
+    const term = payload.subscription_estimate;
+    const proration = payload.proration_estimate;
+    return {
+        invoice: mapInvoiceEstimate(payload.invoice_estimate, money),
+        nextInvoice: mapInvoiceEstimate(payload.next_invoice_estimate, money),
+        proration: proration != null
+            ? {
+                documentType: proration.document_type,
+                invoice: mapInvoiceEstimate(proration.invoice_estimate, money),
+                net: money(proration.net),
+            }
+            : undefined,
+        reason: payload.reason,
+        term: term != null
+            ? {
+                becomesNonRenewing: term.becomes_non_renewing_after_this_term === true,
+                currentTermEnd: toEstimateDate(term.current_term_end),
+                currentTermStart: toEstimateDate(term.current_term_start),
+                nextBillingAt: toEstimateDate(term.next_billing_at),
+            }
+            : undefined,
+        willBeInvoiced: payload.will_be_invoiced,
+    };
+};
+exports.mapInvoicingSubscriptionEstimatePayloadToState = mapInvoicingSubscriptionEstimatePayloadToState;

package/lib/view/invoicing/editInvoicingSubscriptionDetailView/editInvoicingSubscriptionDetailViewReducer.d.ts

@@ -1,7 +1,7 @@
 import { ID } from '../../../commonStateTypes/common';
 import { ZeniAPIStatus } from '../../../responsePayload';
 import { InvoicingSubscriptionActionBody } from './editInvoicingSubscriptionDetailViewPayload';
-import { EditInvoicingSubscriptionDetailViewState, InvoicingSubscriptionFormLocalData } from './editInvoicingSubscriptionDetailViewState';
+import { EditInvoicingSubscriptionDetailViewState, InvoicingSubscriptionEstimate, InvoicingSubscriptionFormLocalData } from './editInvoicingSubscriptionDetailViewState';
 /** Push the full form draft into CES (edit tree when `id` is present). */
 export interface UpdateInvoicingSubscriptionFormDraftPayload {
     localData: InvoicingSubscriptionFormLocalData;
@@ -59,6 +59,14 @@ export declare const runInvoicingSubscriptionAction: import("@reduxjs/toolkit").
     id?: ID;
 } | undefined, "editInvoicingSubscriptionDetailView/resetEditInvoicingSubscriptionDetailView">, initializeInvoicingSubscriptionAddress: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: InitializeInvoicingSubscriptionAddressPayload], InitializeInvoicingSubscriptionAddressPayload, "editInvoicingSubscriptionDetailView/initializeInvoicingSubscriptionAddress", never, never>, claimInvoicingSubscriptionShippingAddress: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
     id: ID;
-}, "editInvoicingSubscriptionDetailView/claimInvoicingSubscriptionShippingAddress">, syncInvoicingSubscriptionCoupons: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: SyncInvoicingSubscriptionCouponsPayload], SyncInvoicingSubscriptionCouponsPayload, "editInvoicingSubscriptionDetailView/syncInvoicingSubscriptionCoupons", never, never>;
+}, "editInvoicingSubscriptionDetailView/claimInvoicingSubscriptionShippingAddress">, syncInvoicingSubscriptionCoupons: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: SyncInvoicingSubscriptionCouponsPayload], SyncInvoicingSubscriptionCouponsPayload, "editInvoicingSubscriptionDetailView/syncInvoicingSubscriptionCoupons", never, never>, fetchInvoicingSubscriptionEstimate: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    id?: ID;
+}, "editInvoicingSubscriptionDetailView/fetchInvoicingSubscriptionEstimate">, updateInvoicingSubscriptionEstimate: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    estimate: InvoicingSubscriptionEstimate;
+    id?: ID;
+}, "editInvoicingSubscriptionDetailView/updateInvoicingSubscriptionEstimate">, updateInvoicingSubscriptionEstimateFailure: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    status: ZeniAPIStatus;
+    id?: ID;
+}, "editInvoicingSubscriptionDetailView/updateInvoicingSubscriptionEstimateFailure">, clearInvoicingSubscriptionEstimate: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"editInvoicingSubscriptionDetailView/clearInvoicingSubscriptionEstimate">;
 declare const _default: import("redux").Reducer<EditInvoicingSubscriptionDetailViewState>;
 export default _default;

package/lib/view/invoicing/editInvoicingSubscriptionDetailView/editInvoicingSubscriptionDetailViewReducer.js

@@ -1,15 +1,19 @@
 "use strict";
 var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.syncInvoicingSubscriptionCoupons = exports.claimInvoicingSubscriptionShippingAddress = exports.initializeInvoicingSubscriptionAddress = exports.resetEditInvoicingSubscriptionDetailView = exports.submitInvoicingSubscriptionFormFailure = exports.submitInvoicingSubscriptionFormSuccess = exports.submitInvoicingSubscriptionForm = exports.updateInvoicingSubscriptionFormDraft = exports.updateInvoicingSubscriptionDetailFailure = exports.updateInvoicingSubscriptionDetail = exports.seedInvoicingSubscriptionFormDraft = exports.fetchInvoicingSubscriptionFormPage = exports.fetchInvoicingSubscriptionDetailPage = exports.fetchInvoicingSubscriptionDetail = exports.runInvoicingSubscriptionActionSuccess = exports.runInvoicingSubscriptionActionFailure = exports.runInvoicingSubscriptionAction = exports.initialState = void 0;
+exports.clearInvoicingSubscriptionEstimate = exports.updateInvoicingSubscriptionEstimateFailure = exports.updateInvoicingSubscriptionEstimate = exports.fetchInvoicingSubscriptionEstimate = exports.syncInvoicingSubscriptionCoupons = exports.claimInvoicingSubscriptionShippingAddress = exports.initializeInvoicingSubscriptionAddress = exports.resetEditInvoicingSubscriptionDetailView = exports.submitInvoicingSubscriptionFormFailure = exports.submitInvoicingSubscriptionFormSuccess = exports.submitInvoicingSubscriptionForm = exports.updateInvoicingSubscriptionFormDraft = exports.updateInvoicingSubscriptionDetailFailure = exports.updateInvoicingSubscriptionDetail = exports.seedInvoicingSubscriptionFormDraft = exports.fetchInvoicingSubscriptionFormPage = exports.fetchInvoicingSubscriptionDetailPage = exports.fetchInvoicingSubscriptionDetail = exports.runInvoicingSubscriptionActionSuccess = exports.runInvoicingSubscriptionActionFailure = exports.runInvoicingSubscriptionAction = exports.initialState = void 0;
 const toolkit_1 = require("@reduxjs/toolkit");
 const rootActions_1 = require("../../../rootActions");
 const invoicingFormDraft_1 = require("../invoicingFormDraft");
 const invoicingSubscriptionFormConfig_1 = require("./invoicingSubscriptionFormConfig");
+const initialEstimateState = {
+    fetchState: { fetchState: 'Not-Started', error: undefined },
+};
 exports.initialState = {
     fetchState: 'Not-Started',
     error: undefined,
     editDraftById: {},
+    estimateState: initialEstimateState,
     actionStateById: {},
     recordStateById: {},
     shippingAddressOwnerId: undefined,
@@ -23,6 +27,36 @@ const editInvoicingSubscriptionDetailView = (0, toolkit_1.createSlice)({
     name: 'editInvoicingSubscriptionDetailView',
     initialState: exports.initialState,
     reducers: {
+        // What saving the draft would bill (no id: create); see the estimate epic.
+        fetchInvoicingSubscriptionEstimate(draft, action) {
+            draft.estimateState = {
+                fetchState: { fetchState: 'In-Progress', error: undefined },
+                subscriptionId: action.payload.id,
+            };
+        },
+        // Dropped when the dialog has since moved to another subscription.
+        updateInvoicingSubscriptionEstimate(draft, action) {
+            if (draft.estimateState.subscriptionId !== action.payload.id) {
+                return;
+            }
+            draft.estimateState.estimate = action.payload.estimate;
+            draft.estimateState.fetchState = {
+                fetchState: 'Completed',
+                error: undefined,
+            };
+        },
+        updateInvoicingSubscriptionEstimateFailure(draft, action) {
+            if (draft.estimateState.subscriptionId !== action.payload.id) {
+                return;
+            }
+            draft.estimateState.fetchState = {
+                fetchState: 'Error',
+                error: action.payload.status,
+            };
+        },
+        clearInvoicingSubscriptionEstimate(draft) {
+            draft.estimateState = initialEstimateState;
+        },
         runInvoicingSubscriptionAction(draft, action) {
             draft.actionStateById[action.payload.id] = {
                 fetchState: 'In-Progress',
@@ -162,5 +196,5 @@ const editInvoicingSubscriptionDetailView = (0, toolkit_1.createSlice)({
         });
     },
 });
-_a = editInvoicingSubscriptionDetailView.actions, exports.runInvoicingSubscriptionAction = _a.runInvoicingSubscriptionAction, exports.runInvoicingSubscriptionActionFailure = _a.runInvoicingSubscriptionActionFailure, exports.runInvoicingSubscriptionActionSuccess = _a.runInvoicingSubscriptionActionSuccess, exports.fetchInvoicingSubscriptionDetail = _a.fetchInvoicingSubscriptionDetail, exports.fetchInvoicingSubscriptionDetailPage = _a.fetchInvoicingSubscriptionDetailPage, exports.fetchInvoicingSubscriptionFormPage = _a.fetchInvoicingSubscriptionFormPage, exports.seedInvoicingSubscriptionFormDraft = _a.seedInvoicingSubscriptionFormDraft, exports.updateInvoicingSubscriptionDetail = _a.updateInvoicingSubscriptionDetail, exports.updateInvoicingSubscriptionDetailFailure = _a.updateInvoicingSubscriptionDetailFailure, exports.updateInvoicingSubscriptionFormDraft = _a.updateInvoicingSubscriptionFormDraft, exports.submitInvoicingSubscriptionForm = _a.submitInvoicingSubscriptionForm, exports.submitInvoicingSubscriptionFormSuccess = _a.submitInvoicingSubscriptionFormSuccess, exports.submitInvoicingSubscriptionFormFailure = _a.submitInvoicingSubscriptionFormFailure, exports.resetEditInvoicingSubscriptionDetailView = _a.resetEditInvoicingSubscriptionDetailView, exports.initializeInvoicingSubscriptionAddress = _a.initializeInvoicingSubscriptionAddress, exports.claimInvoicingSubscriptionShippingAddress = _a.claimInvoicingSubscriptionShippingAddress, exports.syncInvoicingSubscriptionCoupons = _a.syncInvoicingSubscriptionCoupons;
+_a = editInvoicingSubscriptionDetailView.actions, exports.runInvoicingSubscriptionAction = _a.runInvoicingSubscriptionAction, exports.runInvoicingSubscriptionActionFailure = _a.runInvoicingSubscriptionActionFailure, exports.runInvoicingSubscriptionActionSuccess = _a.runInvoicingSubscriptionActionSuccess, exports.fetchInvoicingSubscriptionDetail = _a.fetchInvoicingSubscriptionDetail, exports.fetchInvoicingSubscriptionDetailPage = _a.fetchInvoicingSubscriptionDetailPage, exports.fetchInvoicingSubscriptionFormPage = _a.fetchInvoicingSubscriptionFormPage, exports.seedInvoicingSubscriptionFormDraft = _a.seedInvoicingSubscriptionFormDraft, exports.updateInvoicingSubscriptionDetail = _a.updateInvoicingSubscriptionDetail, exports.updateInvoicingSubscriptionDetailFailure = _a.updateInvoicingSubscriptionDetailFailure, exports.updateInvoicingSubscriptionFormDraft = _a.updateInvoicingSubscriptionFormDraft, exports.submitInvoicingSubscriptionForm = _a.submitInvoicingSubscriptionForm, exports.submitInvoicingSubscriptionFormSuccess = _a.submitInvoicingSubscriptionFormSuccess, exports.submitInvoicingSubscriptionFormFailure = _a.submitInvoicingSubscriptionFormFailure, exports.resetEditInvoicingSubscriptionDetailView = _a.resetEditInvoicingSubscriptionDetailView, exports.initializeInvoicingSubscriptionAddress = _a.initializeInvoicingSubscriptionAddress, exports.claimInvoicingSubscriptionShippingAddress = _a.claimInvoicingSubscriptionShippingAddress, exports.syncInvoicingSubscriptionCoupons = _a.syncInvoicingSubscriptionCoupons, exports.fetchInvoicingSubscriptionEstimate = _a.fetchInvoicingSubscriptionEstimate, exports.updateInvoicingSubscriptionEstimate = _a.updateInvoicingSubscriptionEstimate, exports.updateInvoicingSubscriptionEstimateFailure = _a.updateInvoicingSubscriptionEstimateFailure, exports.clearInvoicingSubscriptionEstimate = _a.clearInvoicingSubscriptionEstimate;
 exports.default = editInvoicingSubscriptionDetailView.reducer;

package/lib/view/invoicing/editInvoicingSubscriptionDetailView/editInvoicingSubscriptionDetailViewSelector.d.ts

@@ -5,7 +5,8 @@ import { InvoicingCatalogPricePoint } from '../../../entity/invoicing/invoicingC
 import { InvoicingFieldHelpByCode, InvoicingNamedOption, InvoicingSubscriptionLifecycleActionOption } from '../../../entity/invoicing/invoicingCommonPayload';
 import { InvoicingSubscription } from '../../../entity/invoicing/invoicingSubscription/invoicingSubscriptionState';
 import { RootState } from '../../../rootStateTypes';
-import { InvoicingSubscriptionFormLocalData } from './editInvoicingSubscriptionDetailViewState';
+import { ZeniDate } from '../../../zeniDayJS';
+import { InvoicingSubscriptionEstimateState, InvoicingSubscriptionFormLocalData, InvoicingSubscriptionInvoiceEstimate } from './editInvoicingSubscriptionDetailViewState';
 /**
  * Bundled view for the subscription create/edit form's save concern: the save
  * fetch state/error, the id of the subscription last saved, and — when an
@@ -29,6 +30,22 @@ export interface EditInvoicingSubscriptionDetailView extends SelectorView {
  * `{label, value}` records, so this stays free of any web-components
  * dependency while leaving the screen nothing to derive.
  */
+export type InvoicingSubscriptionEstimateKind = 'invoice_now' | 'later_invoice' | 'proration_credit' | 'proration_invoice' | 'reason_only';
+export interface InvoicingSubscriptionEstimateView {
+    /** A later invoice quotes today's credit balances, which can change by then. */
+    creditsMayChange: boolean;
+    fetchState: FetchStateAndError;
+    nonRenewing: boolean;
+    /** The one invoice to show, whichever estimate it came from. */
+    invoice?: InvoicingSubscriptionInvoiceEstimate;
+    kind?: InvoicingSubscriptionEstimateKind;
+    nextBillingAt?: ZeniDate;
+    reason?: string;
+    storeCredit?: Amount;
+    termEnd?: ZeniDate;
+    termStart?: ZeniDate;
+}
+export declare const toInvoicingSubscriptionEstimateView: ({ estimate, fetchState, subscriptionId }: InvoicingSubscriptionEstimateState, invoicingSubscriptionID?: ID) => InvoicingSubscriptionEstimateView;
 export interface InvoicingSubscriptionFormView extends SelectorView {
     /** Lifecycle action in flight, folded in from the record view. */
     actionState: FetchStateAndError;
@@ -43,6 +60,8 @@ export interface InvoicingSubscriptionFormView extends SelectorView {
     charges: InvoicingSubscriptionOption[];
     coupons: InvoicingSubscriptionOption[];
     customers: InvoicingSubscriptionOption[];
+    /** The review dialog's cost estimate for saving this draft. */
+    estimate: InvoicingSubscriptionEstimateView;
     fieldHelp: InvoicingFieldHelpByCode;
     /**
      * True while the subscription being edited is still on its way to the form.

package/lib/view/invoicing/editInvoicingSubscriptionDetailView/editInvoicingSubscriptionDetailViewSelector.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getInvoicingSubscriptionFormView = exports.isInvoicingAddonPeriodCompatible = exports.getInvoicingItemsAllowedForPlan = exports.getEditInvoicingSubscriptionDetailViewState = void 0;
+exports.getInvoicingSubscriptionFormView = exports.isInvoicingAddonPeriodCompatible = exports.getInvoicingItemsAllowedForPlan = exports.getEditInvoicingSubscriptionDetailViewState = exports.toInvoicingSubscriptionEstimateView = void 0;
 const reduceFetchState_1 = require("../../../commonStateTypes/reduceFetchState");
 const addressSelector_1 = require("../../../entity/address/addressSelector");
 const invoicingSubscriptionSelector_1 = require("../../../entity/invoicing/invoicingSubscription/invoicingSubscriptionSelector");
@@ -12,6 +12,58 @@ const invoicingCustomerListViewSelector_1 = require("../invoicingCustomerListVie
 const invoicingFormDraft_1 = require("../invoicingFormDraft");
 const invoicingSubscriptionFormConfig_1 = require("./invoicingSubscriptionFormConfig");
 const invoicingSubscriptionFormConfig_2 = require("./invoicingSubscriptionFormConfig");
+const notStartedEstimateView = {
+    creditsMayChange: false,
+    fetchState: { fetchState: 'Not-Started', error: undefined },
+    nonRenewing: false,
+};
+const toInvoicingSubscriptionEstimateView = ({ estimate, fetchState, subscriptionId }, invoicingSubscriptionID) => {
+    // A slot asked for another subscription is not this form's estimate.
+    if (subscriptionId !== invoicingSubscriptionID) {
+        return notStartedEstimateView;
+    }
+    if (estimate == null) {
+        return { ...notStartedEstimateView, fetchState };
+    }
+    const { invoice, nextInvoice, proration, reason, term } = estimate;
+    const base = {
+        fetchState,
+        nonRenewing: term?.becomesNonRenewing === true,
+        nextBillingAt: term?.nextBillingAt,
+        reason: reason !== '' ? reason : undefined,
+        termEnd: term?.currentTermEnd,
+        termStart: term?.currentTermStart,
+    };
+    if (proration?.documentType === 'invoice' && proration.invoice != null) {
+        return {
+            ...base,
+            creditsMayChange: false,
+            invoice: proration.invoice,
+            kind: 'proration_invoice',
+        };
+    }
+    if (proration?.documentType === 'credit_note') {
+        return {
+            ...base,
+            creditsMayChange: false,
+            kind: 'proration_credit',
+            storeCredit: { ...proration.net, amount: Math.abs(proration.net.amount) },
+        };
+    }
+    if (estimate.willBeInvoiced && invoice != null) {
+        return { ...base, creditsMayChange: false, invoice, kind: 'invoice_now' };
+    }
+    if (nextInvoice != null) {
+        return {
+            ...base,
+            creditsMayChange: true,
+            invoice: nextInvoice,
+            kind: 'later_invoice',
+        };
+    }
+    return { ...base, creditsMayChange: false, kind: 'reason_only' };
+};
+exports.toInvoicingSubscriptionEstimateView = toInvoicingSubscriptionEstimateView;
 const getEditInvoicingSubscriptionDetailViewState = (state, invoicingSubscriptionID) => {
     const { error, fetchState, savedSubscriptionId } = state.editInvoicingSubscriptionDetailViewState;
     const { subscriptionCommercialEditAllowedFromStatuses, subscriptionLifecycleActionOptions, subscriptionMetadataEditAllowedFromStatuses, } = (0, invoicingConfigViewSelector_1.getInvoicingConfigView)(state);
@@ -176,7 +228,7 @@ const toInvoicingCustomerOption = (customer) => ({
     value: customer.id,
 });
 const getInvoicingSubscriptionFormView = (state, invoicingSubscriptionID) => {
-    const { editDraftById, error, fetchState, newSubscriptionDraft, savedSubscriptionId, } = state.editInvoicingSubscriptionDetailViewState;
+    const { editDraftById, error, estimateState, fetchState, newSubscriptionDraft, savedSubscriptionId, } = state.editInvoicingSubscriptionDetailViewState;
     const mode = invoicingSubscriptionID != null ? 'edit' : 'create';
     const subscription = invoicingSubscriptionID != null
         ? (0, invoicingSubscriptionSelector_1.getInvoicingSubscriptionById)(state.invoicingSubscriptionState, invoicingSubscriptionID)
@@ -230,6 +282,7 @@ const getInvoicingSubscriptionFormView = (state, invoicingSubscriptionID) => {
         subscriptionMetadataEditAllowedFromStatuses: configState.subscriptionMetadataEditAllowedFromStatuses,
         recordState,
         isFormLoading: (0, invoicingFormDraft_1.isInvoicingFormDraftPending)(editDraftById, invoicingSubscriptionID),
+        estimate: (0, exports.toInvoicingSubscriptionEstimateView)(estimateState, invoicingSubscriptionID),
         fieldHelp: (0, invoicingConfigViewSelector_1.invoicingFieldHelpForGroup)(state, 'subscription'),
         addons: catalogItemOptionsOfType('addon'),
         charges: catalogItemOptionsOfType('charge'),

package/lib/view/invoicing/editInvoicingSubscriptionDetailView/editInvoicingSubscriptionDetailViewState.d.ts

@@ -1,5 +1,6 @@
 import { Amount } from '../../../commonStateTypes/amount';
 import { FetchStateAndError, FetchedState, ID } from '../../../commonStateTypes/common';
+import { ZeniDate } from '../../../zeniDayJS';
 import { InvoicingFormDraftById } from '../invoicingFormDraft';
 /**
  * Draft form state for the create/edit subscription form. Held in CES so the
@@ -39,10 +40,67 @@ export interface InvoicingSubscriptionFormLocalData {
     /** Unset until the user enters one, so an explicit 0 stays distinguishable. */
     setupFee?: Amount;
 }
+export interface InvoicingSubscriptionEstimateLineItem {
+    amount: Amount;
+    description: string;
+    discountAmount: Amount;
+    quantity: number;
+    unitAmount: Amount;
+    dateFrom?: ZeniDate;
+    dateTo?: ZeniDate;
+    taxAmount?: Amount;
+}
+/** An invoice the save would raise now, or the next one it would raise later. */
+export interface InvoicingSubscriptionInvoiceEstimate {
+    amountDue: Amount;
+    couponDiscountTotal: Amount;
+    /** Refundable credits plus excess payments; promotional credits are separate. */
+    creditsApplied: Amount;
+    grossSubTotal: Amount;
+    lineItems: InvoicingSubscriptionEstimateLineItem[];
+    promotionalCreditsApplied: Amount;
+    /** After coupons and promotional credits. */
+    subTotal: Amount;
+    total: Amount;
+    dueDate?: ZeniDate;
+    invoiceDate?: ZeniDate;
+    /** Absent when the tax quote failed on a later invoice; Save still succeeds. */
+    tax?: Amount;
+}
+export interface InvoicingSubscriptionProrationEstimate {
+    /** `invoice`, `credit_note`, or `none` when the change nets to zero. */
+    documentType: string;
+    net: Amount;
+    invoice?: InvoicingSubscriptionInvoiceEstimate;
+}
+export interface InvoicingSubscriptionTermEstimate {
+    becomesNonRenewing: boolean;
+    currentTermEnd?: ZeniDate;
+    currentTermStart?: ZeniDate;
+    nextBillingAt?: ZeniDate;
+}
+/** What a save would bill, from `POST /subscriptions[/{id}]/estimate`. */
+export interface InvoicingSubscriptionEstimate {
+    /** The service's sentence for why nothing is invoiced now; empty otherwise. */
+    reason: string;
+    willBeInvoiced: boolean;
+    invoice?: InvoicingSubscriptionInvoiceEstimate;
+    nextInvoice?: InvoicingSubscriptionInvoiceEstimate;
+    proration?: InvoicingSubscriptionProrationEstimate;
+    term?: InvoicingSubscriptionTermEstimate;
+}
+export interface InvoicingSubscriptionEstimateState {
+    fetchState: FetchStateAndError;
+    estimate?: InvoicingSubscriptionEstimate;
+    /** The subscription the estimate was asked for; absent for a new one. */
+    subscriptionId?: ID;
+}
 export interface EditInvoicingSubscriptionDetailViewState extends FetchedState {
     /** Lifecycle action fetch state per subscription id. */
     actionStateById: Record<ID, FetchStateAndError>;
     editDraftById: InvoicingFormDraftById<InvoicingSubscriptionFormLocalData>;
+    /** The cost estimate shown before a save; nothing is saved by asking. */
+    estimateState: InvoicingSubscriptionEstimateState;
     newSubscriptionDraft: InvoicingSubscriptionFormLocalData;
     /** Detail-load state per subscription id. */
     recordStateById: Record<ID, FetchStateAndError>;

package/lib/view/invoicing/editInvoicingSubscriptionDetailView/fetchInvoicingSubscriptionEstimateEpic.d.ts

@@ -0,0 +1,7 @@
+import { ActionsObservable, StateObservable } from 'redux-observable';
+import { Observable } from 'rxjs';
+import { RootState } from '../../../rootStateTypes';
+import { ZeniAPI } from '../../../zeniAPI';
+import { fetchInvoicingSubscriptionEstimate, updateInvoicingSubscriptionEstimate, updateInvoicingSubscriptionEstimateFailure } from './editInvoicingSubscriptionDetailViewReducer';
+export type ActionType = ReturnType<typeof fetchInvoicingSubscriptionEstimate> | ReturnType<typeof updateInvoicingSubscriptionEstimate> | ReturnType<typeof updateInvoicingSubscriptionEstimateFailure>;
+export declare const fetchInvoicingSubscriptionEstimateEpic: (actions$: ActionsObservable<ActionType>, state$: StateObservable<RootState>, zeniAPI: ZeniAPI) => Observable<ActionType>;