@zeniai/client-epic-state 5.1.60-betaDI1 → 5.1.61

package/lib/view/invoicing/discountAction/discountActionReducer.js

@@ -0,0 +1,40 @@
+"use strict";
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.clearAllInvoicingDiscountActions = exports.clearInvoicingDiscountAction = exports.runInvoicingDiscountActionFailure = exports.runInvoicingDiscountActionSuccess = exports.runInvoicingDiscountAction = exports.initialState = void 0;
+const toolkit_1 = require("@reduxjs/toolkit");
+exports.initialState = {
+    byId: {},
+};
+const discountAction = (0, toolkit_1.createSlice)({
+    name: 'invoicingDiscountAction',
+    initialState: exports.initialState,
+    reducers: {
+        runInvoicingDiscountAction(draft, action) {
+            draft.byId[action.payload.id] = {
+                fetchState: 'In-Progress',
+                error: undefined,
+            };
+        },
+        runInvoicingDiscountActionSuccess(draft, action) {
+            draft.byId[action.payload.id] = {
+                fetchState: 'Completed',
+                error: undefined,
+            };
+        },
+        runInvoicingDiscountActionFailure(draft, action) {
+            draft.byId[action.payload.id] = {
+                fetchState: 'Error',
+                error: action.payload.error,
+            };
+        },
+        clearInvoicingDiscountAction(draft, action) {
+            delete draft.byId[action.payload];
+        },
+        clearAllInvoicingDiscountActions(draft) {
+            draft.byId = {};
+        },
+    },
+});
+_a = discountAction.actions, exports.runInvoicingDiscountAction = _a.runInvoicingDiscountAction, exports.runInvoicingDiscountActionSuccess = _a.runInvoicingDiscountActionSuccess, exports.runInvoicingDiscountActionFailure = _a.runInvoicingDiscountActionFailure, exports.clearInvoicingDiscountAction = _a.clearInvoicingDiscountAction, exports.clearAllInvoicingDiscountActions = _a.clearAllInvoicingDiscountActions;
+exports.default = discountAction.reducer;

package/lib/view/invoicing/discountAction/discountActionSelector.d.ts

@@ -0,0 +1,3 @@
+import { FetchStateAndError, ID } from '../../../commonStateTypes/common';
+import { RootState } from '../../../reducer';
+export declare const getInvoicingDiscountActionState: (id: ID) => (state: RootState) => FetchStateAndError;

package/lib/view/invoicing/discountAction/discountActionSelector.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getInvoicingDiscountActionState = void 0;
+const NOT_STARTED = {
+    fetchState: 'Not-Started',
+    error: undefined,
+};
+const getInvoicingDiscountActionState = (id) => (state) => state.invoicingDiscountActionState.byId[id] ?? NOT_STARTED;
+exports.getInvoicingDiscountActionState = getInvoicingDiscountActionState;

package/lib/view/invoicing/discountAction/discountActionState.d.ts

@@ -0,0 +1,5 @@
+import { FetchStateAndError, ID } from '../../../commonStateTypes/common';
+/** Per-coupon action fetch state keyed by coupon id. */
+export interface InvoicingDiscountActionState {
+    byId: Record<ID, FetchStateAndError>;
+}

package/lib/view/invoicing/discountAction/discountActionState.js

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

package/lib/view/invoicing/dunningAction/dunningActionEpic.d.ts

@@ -0,0 +1,8 @@
+import { ActionsObservable, StateObservable } from 'redux-observable';
+import { Observable } from 'rxjs';
+import { updateInvoicingDunningCases } from '../../../entity/invoicing/dunningCase/dunningCaseReducer';
+import { RootState } from '../../../reducer';
+import { ZeniAPI } from '../../../zeniAPI';
+import { runInvoicingDunningAction, runInvoicingDunningActionFailure, runInvoicingDunningActionSuccess } from './dunningActionReducer';
+export type ActionType = ReturnType<typeof runInvoicingDunningAction> | ReturnType<typeof runInvoicingDunningActionSuccess> | ReturnType<typeof runInvoicingDunningActionFailure> | ReturnType<typeof updateInvoicingDunningCases>;
+export declare const runInvoicingDunningActionEpic: (actions$: ActionsObservable<ActionType>, _state$: StateObservable<RootState>, zeniAPI: ZeniAPI) => Observable<ActionType>;

package/lib/view/invoicing/dunningAction/dunningActionEpic.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runInvoicingDunningActionEpic = void 0;
+const rxjs_1 = require("rxjs");
+const operators_1 = require("rxjs/operators");
+const dunningCaseReducer_1 = require("../../../entity/invoicing/dunningCase/dunningCaseReducer");
+const responsePayload_1 = require("../../../responsePayload");
+const dunningActionReducer_1 = require("./dunningActionReducer");
+const runInvoicingDunningActionEpic = (actions$, _state$, zeniAPI) => actions$.pipe((0, operators_1.filter)(dunningActionReducer_1.runInvoicingDunningAction.match), (0, operators_1.mergeMap)((action) => {
+    const { action: kind, body, id } = action.payload;
+    const apiUrl = `${zeniAPI.apiEndPoints.invoicingMicroServiceBaseUrl}/1.0/dunning/${encodeURIComponent(id)}/${kind}`;
+    return zeniAPI
+        .postAndGetJSON(apiUrl, (body ?? {}))
+        .pipe((0, operators_1.mergeMap)((response) => {
+        if ((0, responsePayload_1.isSuccessResponse)(response) && response.data != null) {
+            return [
+                (0, dunningCaseReducer_1.updateInvoicingDunningCases)([response.data], 'merge'),
+                (0, dunningActionReducer_1.runInvoicingDunningActionSuccess)({ id }),
+            ];
+        }
+        return (0, rxjs_1.of)((0, dunningActionReducer_1.runInvoicingDunningActionFailure)({
+            error: response.status,
+            id,
+        }));
+    }), (0, operators_1.catchError)((error) => (0, rxjs_1.of)((0, dunningActionReducer_1.runInvoicingDunningActionFailure)({
+        error: (0, responsePayload_1.createZeniAPIStatus)('Unexpected Error', 'Dunning action REST API call errored out ' +
+            JSON.stringify(error)),
+        id,
+    }))));
+}));
+exports.runInvoicingDunningActionEpic = runInvoicingDunningActionEpic;

package/lib/view/invoicing/dunningAction/dunningActionPayload.d.ts

@@ -0,0 +1,3 @@
+import { InvoicingDunningCasePayload } from '../../../entity/invoicing/dunningCase/dunningCasePayload';
+import { ZeniAPIResponse } from '../../../responsePayload';
+export type InvoicingDunningActionResponse = ZeniAPIResponse<InvoicingDunningCasePayload>;

package/lib/view/invoicing/dunningAction/dunningActionPayload.js

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

package/lib/view/invoicing/dunningAction/dunningActionReducer.d.ts

@@ -0,0 +1,20 @@
+import { ID } from '../../../commonStateTypes/common';
+import { ZeniAPIStatus } from '../../../responsePayload';
+import { InvoicingDunningActionBody } from './dunningActionRequestPayload';
+import { InvoicingDunningActionState } from './dunningActionState';
+export interface RunInvoicingDunningActionPayload {
+    action: string;
+    id: ID;
+    /** Optional JSON body for actions that take parameters. */
+    body?: InvoicingDunningActionBody;
+}
+export declare const initialState: InvoicingDunningActionState;
+export type { InvoicingDunningActionState } from './dunningActionState';
+export declare const runInvoicingDunningAction: import("@reduxjs/toolkit").ActionCreatorWithPayload<RunInvoicingDunningActionPayload, "invoicingDunningAction/runInvoicingDunningAction">, runInvoicingDunningActionSuccess: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    id: ID;
+}, "invoicingDunningAction/runInvoicingDunningActionSuccess">, runInvoicingDunningActionFailure: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
+    error: ZeniAPIStatus;
+    id: ID;
+}, "invoicingDunningAction/runInvoicingDunningActionFailure">, clearInvoicingDunningAction: import("@reduxjs/toolkit").ActionCreatorWithPayload<string, "invoicingDunningAction/clearInvoicingDunningAction">, clearAllInvoicingDunningActions: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"invoicingDunningAction/clearAllInvoicingDunningActions">;
+declare const _default: import("redux").Reducer<InvoicingDunningActionState>;
+export default _default;

package/lib/view/invoicing/dunningAction/dunningActionReducer.js

@@ -0,0 +1,40 @@
+"use strict";
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.clearAllInvoicingDunningActions = exports.clearInvoicingDunningAction = exports.runInvoicingDunningActionFailure = exports.runInvoicingDunningActionSuccess = exports.runInvoicingDunningAction = exports.initialState = void 0;
+const toolkit_1 = require("@reduxjs/toolkit");
+exports.initialState = {
+    byId: {},
+};
+const dunningAction = (0, toolkit_1.createSlice)({
+    name: 'invoicingDunningAction',
+    initialState: exports.initialState,
+    reducers: {
+        runInvoicingDunningAction(draft, action) {
+            draft.byId[action.payload.id] = {
+                fetchState: 'In-Progress',
+                error: undefined,
+            };
+        },
+        runInvoicingDunningActionSuccess(draft, action) {
+            draft.byId[action.payload.id] = {
+                fetchState: 'Completed',
+                error: undefined,
+            };
+        },
+        runInvoicingDunningActionFailure(draft, action) {
+            draft.byId[action.payload.id] = {
+                fetchState: 'Error',
+                error: action.payload.error,
+            };
+        },
+        clearInvoicingDunningAction(draft, action) {
+            delete draft.byId[action.payload];
+        },
+        clearAllInvoicingDunningActions(draft) {
+            draft.byId = {};
+        },
+    },
+});
+_a = dunningAction.actions, exports.runInvoicingDunningAction = _a.runInvoicingDunningAction, exports.runInvoicingDunningActionSuccess = _a.runInvoicingDunningActionSuccess, exports.runInvoicingDunningActionFailure = _a.runInvoicingDunningActionFailure, exports.clearInvoicingDunningAction = _a.clearInvoicingDunningAction, exports.clearAllInvoicingDunningActions = _a.clearAllInvoicingDunningActions;
+exports.default = dunningAction.reducer;

package/lib/view/invoicing/dunningAction/dunningActionRequestPayload.d.ts

@@ -0,0 +1,24 @@
+/** Snake_case request bodies for dunning action endpoints. */
+export type DunningPauseBody = {
+    duration?: number;
+    reason?: string;
+    resume_date?: string;
+};
+export type DunningCollectBody = {
+    amount?: number;
+    payment_method?: string;
+};
+export type DunningEmailBody = {
+    body?: string;
+    cc?: string;
+    subject?: string;
+    to?: string;
+};
+export type DunningBulkEmailBody = {
+    body?: string;
+    case_ids?: string[];
+    cc?: string;
+    subject?: string;
+    to?: string;
+};
+export type InvoicingDunningActionBody = DunningPauseBody | DunningCollectBody | DunningEmailBody | DunningBulkEmailBody | Record<string, never>;

package/lib/view/invoicing/dunningAction/dunningActionRequestPayload.js

@@ -0,0 +1,3 @@
+"use strict";
+/** Snake_case request bodies for dunning action endpoints. */
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/view/invoicing/dunningAction/dunningActionSelector.d.ts

@@ -0,0 +1,3 @@
+import { FetchStateAndError, ID } from '../../../commonStateTypes/common';
+import { RootState } from '../../../reducer';
+export declare const getInvoicingDunningActionState: (id: ID) => (state: RootState) => FetchStateAndError;

package/lib/view/invoicing/dunningAction/dunningActionSelector.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getInvoicingDunningActionState = void 0;
+const NOT_STARTED = {
+    fetchState: 'Not-Started',
+    error: undefined,
+};
+const getInvoicingDunningActionState = (id) => (state) => state.invoicingDunningActionState.byId[id] ?? NOT_STARTED;
+exports.getInvoicingDunningActionState = getInvoicingDunningActionState;

package/lib/view/invoicing/dunningAction/dunningActionState.d.ts

@@ -0,0 +1,5 @@
+import { FetchStateAndError, ID } from '../../../commonStateTypes/common';
+/** Per-dunning-case action fetch state keyed by dunning case id. */
+export interface InvoicingDunningActionState {
+    byId: Record<ID, FetchStateAndError>;
+}

package/lib/view/invoicing/dunningAction/dunningActionState.js

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

package/lib/view/invoicing/editInvoicingCatalogItemDetailView/catalogDetailEditPayload.d.ts

@@ -0,0 +1,51 @@
+import type { InvoicingPlan } from '../../../entity/invoicing/plan/planState';
+import type { InvoicingProduct } from '../../../entity/invoicing/product/productState';
+import type { InvoicingCatalogItemFormSubFamily } from './editInvoicingCatalogItemDetailViewState';
+export type CatalogDetailSubFamilyEditValues = InvoicingCatalogItemFormSubFamily;
+export interface CatalogDetailEditValues {
+    applicableItems: string[];
+    description: string;
+    enabledForCheckout: boolean;
+    enabledInPortal: boolean;
+    giftClaimRedirectUrl: string;
+    includedInMrr: boolean;
+    isGiftable: boolean;
+    isShippable: boolean;
+    itemApplicability: string;
+    metered: boolean;
+    name: string;
+    productCode: string;
+    subFamilies: CatalogDetailSubFamilyEditValues[];
+    unit: string;
+    usageCalculation: string;
+}
+export interface CatalogDetailProductUpdate {
+    data: Record<string, unknown>;
+    id: string;
+}
+export interface CatalogDetailSavePayload {
+    planData: Record<string, unknown>;
+    productUpdates: CatalogDetailProductUpdate[];
+}
+/** Build default inline-edit form values from a loaded catalog item. */
+export declare const planToCatalogDetailEditValues: (plan: InvoicingPlan) => CatalogDetailEditValues;
+export declare const catalogDetailEditValuesToSavePayload: (values: CatalogDetailEditValues, itemType?: string, originalSubFamilies?: readonly InvoicingProduct[]) => CatalogDetailSavePayload;
+export interface CreateSubFamilyFormValues {
+    billingCycles: string;
+    description: string;
+    freeQuantity: string;
+    invoiceNotes: string;
+    name: string;
+    period: string;
+    periodUnit: string;
+    priceCode: string;
+    priceDollars: string;
+    pricingModel: string;
+    prorationType: string;
+    trialEndAction: string;
+    trialPeriod: string;
+    trialPeriodUnit: string;
+}
+/** Build POST /catalog/products body for Create sub-family. */
+export declare const createSubFamilyFormToPayload: (itemId: string, itemType: string, values: CreateSubFamilyFormValues) => Record<string, unknown>;
+export declare const productToCreateSubFamilyFormValues: (product?: InvoicingProduct) => CreateSubFamilyFormValues;

package/lib/view/invoicing/editInvoicingCatalogItemDetailView/catalogDetailEditPayload.js

@@ -0,0 +1,178 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.productToCreateSubFamilyFormValues = exports.createSubFamilyFormToPayload = exports.catalogDetailEditValuesToSavePayload = exports.planToCatalogDetailEditValues = void 0;
+const invoicingCatalogItemFormConfig_1 = require("./invoicingCatalogItemFormConfig");
+const trimOrUndefined = (value) => value.trim() !== '' ? value.trim() : undefined;
+const trimOrNull = (value) => value.trim() !== '' ? value.trim() : null;
+const hasValue = (value) => String(value ?? '').trim() !== '';
+const toProductCode = (value) => value
+    .trim()
+    .toLowerCase()
+    .replace(/[^a-z0-9]+/g, '-')
+    .replace(/^-|-$/g, '');
+const subFamilyToEditValues = (subFamily) => (0, invoicingCatalogItemFormConfig_1.invoicingProductToCatalogItemFormSubFamily)(subFamily);
+/** Build default inline-edit form values from a loaded catalog item. */
+const planToCatalogDetailEditValues = (plan) => ({
+    applicableItems: plan.applicableItems ?? [],
+    description: plan.description ?? '',
+    enabledForCheckout: plan.enabledForCheckout ?? true,
+    enabledInPortal: plan.enabledInPortal ?? true,
+    giftClaimRedirectUrl: plan.giftClaimRedirectUrl ?? '',
+    includedInMrr: plan.includedInMrr ?? true,
+    isGiftable: plan.isGiftable ?? false,
+    isShippable: plan.isShippable ?? false,
+    itemApplicability: plan.itemApplicability ?? 'all',
+    metered: plan.metered ?? false,
+    name: plan.name ?? '',
+    productCode: plan.productCode ?? '',
+    subFamilies: (plan.subFamilies ?? []).map(subFamilyToEditValues),
+    unit: plan.unit ?? '',
+    usageCalculation: plan.usageCalculation ?? 'sum_of_usages',
+});
+exports.planToCatalogDetailEditValues = planToCatalogDetailEditValues;
+const tierToPayload = (tier) => ({
+    ending_unit: hasValue(tier.endingUnit) ? Number(tier.endingUnit) : undefined,
+    package_size: hasValue(tier.packageSize)
+        ? Number(tier.packageSize)
+        : undefined,
+    price: toAmountValue(tier.price),
+    pricing_type: tier.pricingType,
+    starting_unit: Number(tier.startingUnit) || 1,
+});
+const subFamilyToProductUpdate = (subFamily, itemType) => {
+    const tiered = (0, invoicingCatalogItemFormConfig_1.isTieredCatalogPricingModel)(subFamily.pricingModel);
+    const data = {
+        billing_cycles: hasValue(subFamily.billingCycles)
+            ? Number(subFamily.billingCycles)
+            : null,
+        free_quantity: Number(subFamily.freeQuantity) || 0,
+        is_taxable: subFamily.isTaxable,
+        period: hasValue(subFamily.period) ? Number(subFamily.period) : null,
+        period_unit: hasValue(subFamily.period) ? subFamily.periodUnit : null,
+        price: tiered ? 0 : toAmountValue(subFamily.priceDollars),
+        pricing_model: subFamily.pricingModel,
+        show_description_in_quotes: subFamily.showDescriptionInQuotes,
+        tiers: tiered ? subFamily.tiers.map(tierToPayload) : [],
+        trial_end_action: hasValue(subFamily.trialPeriod)
+            ? subFamily.trialEndAction
+            : null,
+        trial_period: hasValue(subFamily.trialPeriod)
+            ? Number(subFamily.trialPeriod)
+            : null,
+        trial_period_unit: hasValue(subFamily.trialPeriod)
+            ? subFamily.trialPeriodUnit
+            : null,
+    };
+    if (itemType === 'addon') {
+        data.proration_type = subFamily.prorationType;
+    }
+    return { data, id: subFamily.id };
+};
+const catalogDetailEditValuesToSavePayload = (values, itemType = 'plan', originalSubFamilies) => {
+    const planData = {
+        applicable_items: values.itemApplicability === 'restricted' ? values.applicableItems : [],
+        enabled_for_checkout: values.enabledForCheckout,
+        enabled_in_portal: values.enabledInPortal,
+        gift_claim_redirect_url: trimOrNull(values.giftClaimRedirectUrl),
+        included_in_mrr: values.includedInMrr,
+        is_giftable: values.isGiftable,
+        is_shippable: values.isShippable,
+        item_applicability: values.itemApplicability,
+        metered: values.metered,
+        name: trimOrUndefined(values.name),
+        product_code: trimOrUndefined(values.productCode) ?? toProductCode(values.name),
+        sub_family_details: values.subFamilies.map((subFamily) => ({
+            description: trimOrNull(subFamily.description),
+            id: subFamily.id,
+            invoice_notes: trimOrNull(subFamily.invoiceNotes),
+            name: subFamily.name.trim(),
+            price_code: trimOrUndefined(subFamily.priceCode) ?? toProductCode(subFamily.name),
+            show_description_in_invoices: subFamily.showDescriptionInInvoices,
+        })),
+        usage_calculation: values.metered ? values.usageCalculation : null,
+    };
+    const description = trimOrUndefined(values.description);
+    if (description != null) {
+        planData.description = description;
+    }
+    const unit = trimOrUndefined(values.unit);
+    if (unit != null) {
+        planData.unit = unit;
+    }
+    const productUpdates = values.subFamilies.flatMap((subFamily) => {
+        const update = subFamilyToProductUpdate(subFamily, itemType);
+        const original = originalSubFamilies?.find((product) => product.id === subFamily.id);
+        if (original == null) {
+            return [update];
+        }
+        const originalUpdate = subFamilyToProductUpdate(subFamilyToEditValues(original), itemType);
+        const changedData = Object.fromEntries(Object.entries(update.data).filter(([key, value]) => JSON.stringify(value) !== JSON.stringify(originalUpdate.data[key])));
+        return Object.keys(changedData).length > 0
+            ? [{ data: changedData, id: update.id }]
+            : [];
+    });
+    return {
+        planData,
+        productUpdates,
+    };
+};
+exports.catalogDetailEditValuesToSavePayload = catalogDetailEditValuesToSavePayload;
+const toAmountValue = (value) => Number(value) || 0;
+/** Build POST /catalog/products body for Create sub-family. */
+const createSubFamilyFormToPayload = (itemId, itemType, values) => {
+    const name = values.name.trim();
+    const priceCode = trimOrUndefined(values.priceCode) ?? toProductCode(name);
+    const payload = {
+        currency_code: 'USD',
+        free_quantity: Number(values.freeQuantity) || 0,
+        is_taxable: true,
+        item_id: itemId,
+        name,
+        price: toAmountValue(values.priceDollars),
+        price_code: priceCode,
+        pricing_model: values.pricingModel || 'flat_fee',
+        show_description_in_invoices: true,
+    };
+    const description = trimOrUndefined(values.description);
+    if (description != null) {
+        payload.description = description;
+    }
+    const invoiceNotes = trimOrUndefined(values.invoiceNotes);
+    if (invoiceNotes != null) {
+        payload.invoice_notes = invoiceNotes;
+    }
+    if (itemType === 'plan' || itemType === 'addon') {
+        payload.period = Number(values.period) || 1;
+        payload.period_unit = values.periodUnit || 'month';
+    }
+    if (values.trialPeriod.trim() !== '') {
+        payload.trial_period = Number(values.trialPeriod);
+        payload.trial_period_unit = values.trialPeriodUnit || 'day';
+        payload.trial_end_action = values.trialEndAction || 'site_default';
+    }
+    if (values.billingCycles.trim() !== '') {
+        payload.billing_cycles = Number(values.billingCycles);
+    }
+    if (itemType === 'addon' && values.prorationType) {
+        payload.proration_type = values.prorationType;
+    }
+    return payload;
+};
+exports.createSubFamilyFormToPayload = createSubFamilyFormToPayload;
+const productToCreateSubFamilyFormValues = (product) => ({
+    billingCycles: product?.billingCycles != null ? String(product.billingCycles) : '',
+    description: product?.description ?? '',
+    freeQuantity: product?.freeQuantity != null ? String(product.freeQuantity) : '0',
+    invoiceNotes: product?.invoiceNotes ?? '',
+    name: product?.name != null ? `${product.name} (copy)` : '',
+    period: product?.period != null ? String(product.period) : '1',
+    periodUnit: product?.periodUnit ?? 'month',
+    priceCode: '',
+    priceDollars: product?.price != null ? String(product.price.amount) : '',
+    pricingModel: product?.pricingModel ?? 'flat_fee',
+    prorationType: product?.prorationType ?? 'site_default',
+    trialEndAction: product?.trialEndAction ?? 'site_default',
+    trialPeriod: product?.trialPeriod != null ? String(product.trialPeriod) : '',
+    trialPeriodUnit: product?.trialPeriodUnit ?? 'day',
+});
+exports.productToCreateSubFamilyFormValues = productToCreateSubFamilyFormValues;

package/lib/view/invoicing/editInvoicingCatalogItemDetailView/editInvoicingCatalogItemDetailViewPayload.d.ts

@@ -0,0 +1,9 @@
+import { InvoicingPlanPayload } from '../../../entity/invoicing/plan/planPayload';
+import { ZeniAPIResponse } from '../../../responsePayload';
+import { InvoicingCatalogItemFormLocalData } from './editInvoicingCatalogItemDetailViewState';
+export type SaveInvoicingCatalogItemResponse = ZeniAPIResponse<InvoicingPlanPayload>;
+/**
+ * Build the parent catalog-item request body from the form draft. Creates omit
+ * both parent and sub-family IDs; edits retain returned sub-family IDs.
+ */
+export declare const localDataToSaveInvoicingCatalogItemPayload: (localData: InvoicingCatalogItemFormLocalData, isCreate: boolean) => Record<string, unknown>;

package/lib/view/invoicing/editInvoicingCatalogItemDetailView/editInvoicingCatalogItemDetailViewPayload.js

@@ -0,0 +1,135 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.localDataToSaveInvoicingCatalogItemPayload = void 0;
+const invoicingCatalogItemFormConfig_1 = require("./invoicingCatalogItemFormConfig");
+const CURRENCY_CODE = 'USD';
+const trimOrUndefined = (value) => value.trim() !== '' ? value.trim() : undefined;
+const trimOrNull = (value) => value.trim() !== '' ? value.trim() : null;
+const toProductCode = (value) => value
+    .trim()
+    .toLowerCase()
+    .replace(/[^a-z0-9]+/g, '-')
+    .replace(/^-|-$/g, '');
+const toAmountValue = (value) => Number(value) || 0;
+const buildAccountingDetail = (localData) => {
+    const detail = {};
+    if (localData.sku.trim() !== '') {
+        detail.sku = localData.sku.trim();
+    }
+    if (localData.accountingCode.trim() !== '') {
+        detail.accounting_code = localData.accountingCode.trim();
+    }
+    if (localData.accountingCategory.trim() !== '') {
+        detail.accounting_category_1 = localData.accountingCategory.trim();
+    }
+    return Object.keys(detail).length > 0 ? detail : undefined;
+};
+const buildSubFamilyPayload = (localData, subFamily, clearEmptyValues) => {
+    const isAddon = localData.catalogType === 'addon';
+    const tiered = (0, invoicingCatalogItemFormConfig_1.isTieredCatalogPricingModel)(subFamily.pricingModel);
+    const name = subFamily.name.trim();
+    const priceCode = trimOrUndefined(subFamily.priceCode) ?? toProductCode(name);
+    const payload = {
+        currency_code: CURRENCY_CODE,
+        free_quantity: Number(subFamily.freeQuantity) || 0,
+        is_taxable: subFamily.isTaxable,
+        name,
+        price: tiered ? 0 : toAmountValue(subFamily.priceDollars),
+        price_code: priceCode,
+        pricing_model: subFamily.pricingModel,
+        show_description_in_invoices: subFamily.showDescriptionInInvoices,
+        show_description_in_quotes: subFamily.showDescriptionInQuotes,
+    };
+    const description = trimOrUndefined(subFamily.description);
+    if (description != null) {
+        payload.description = description;
+    }
+    else if (clearEmptyValues) {
+        payload.description = null;
+    }
+    const invoiceNotes = trimOrUndefined(subFamily.invoiceNotes);
+    if (invoiceNotes != null) {
+        payload.invoice_notes = invoiceNotes;
+    }
+    else if (clearEmptyValues) {
+        payload.invoice_notes = null;
+    }
+    if (subFamily.period.trim() !== '') {
+        payload.period = Number(subFamily.period);
+        payload.period_unit = subFamily.periodUnit || 'month';
+    }
+    if (subFamily.trialPeriod.trim() !== '') {
+        payload.trial_period = Number(subFamily.trialPeriod);
+        payload.trial_period_unit = subFamily.trialPeriodUnit;
+        payload.trial_end_action = subFamily.trialEndAction;
+    }
+    if (subFamily.billingCycles.trim() !== '') {
+        payload.billing_cycles = Number(subFamily.billingCycles);
+    }
+    if (isAddon && subFamily.prorationType) {
+        payload.proration_type = subFamily.prorationType;
+    }
+    if (tiered) {
+        payload.tiers = subFamily.tiers.map((tier) => ({
+            ending_unit: tier.endingUnit.trim() !== '' ? Number(tier.endingUnit) : undefined,
+            package_size: tier.packageSize.trim() !== '' ? Number(tier.packageSize) : undefined,
+            price: toAmountValue(tier.price),
+            pricing_type: tier.pricingType,
+            starting_unit: Number(tier.startingUnit) || 1,
+        }));
+    }
+    const accountingDetail = buildAccountingDetail(localData);
+    if (accountingDetail != null) {
+        payload.accounting_detail = accountingDetail;
+    }
+    return payload;
+};
+/**
+ * Build the parent catalog-item request body from the form draft. Creates omit
+ * both parent and sub-family IDs; edits retain returned sub-family IDs.
+ */
+const localDataToSaveInvoicingCatalogItemPayload = (localData, isCreate) => {
+    const description = trimOrUndefined(localData.description);
+    const productCode = trimOrUndefined(localData.productCode) ?? toProductCode(localData.name);
+    const itemPayload = {
+        enabled_for_checkout: true,
+        enabled_in_portal: true,
+        is_giftable: false,
+        is_shippable: false,
+        item_applicability: localData.itemApplicability,
+        metered: false,
+        name: localData.name.trim(),
+        product_code: productCode,
+        type: localData.catalogType,
+    };
+    if (description != null) {
+        itemPayload.description = description;
+    }
+    const unit = trimOrUndefined(localData.unit);
+    if (unit != null) {
+        itemPayload.unit = unit;
+    }
+    if (localData.itemApplicability === 'restricted' &&
+        localData.applicableItems.length > 0) {
+        itemPayload.applicable_items = localData.applicableItems;
+    }
+    const subFamilies = localData.subFamilies.length > 0
+        ? localData.subFamilies
+        : [(0, invoicingCatalogItemFormConfig_1.blankInvoicingCatalogSubFamily)()];
+    itemPayload.sub_family_details = isCreate
+        ? subFamilies.map((subFamily) => buildSubFamilyPayload(localData, subFamily, false))
+        : subFamilies.map((subFamily) => {
+            const priceCode = trimOrUndefined(subFamily.priceCode) ?? toProductCode(subFamily.name);
+            const detail = {
+                description: trimOrNull(subFamily.description),
+                invoice_notes: trimOrNull(subFamily.invoiceNotes),
+                name: subFamily.name.trim(),
+                price_code: priceCode,
+                show_description_in_invoices: subFamily.showDescriptionInInvoices,
+            };
+            const id = trimOrUndefined(subFamily.id);
+            return id != null ? { ...detail, id } : detail;
+        });
+    return itemPayload;
+};
+exports.localDataToSaveInvoicingCatalogItemPayload = localDataToSaveInvoicingCatalogItemPayload;