@zeniai/client-epic-state 5.2.53 → 5.2.54

package/lib/entity/invoicing/plan/planSelector.d.ts

@@ -1,8 +1,17 @@
 import { Amount } from '../../../commonStateTypes/amount';
 import { ID } from '../../../commonStateTypes/common';
+import { InvoicingProduct } from '../product/productState';
 import { InvoicingPlan, InvoicingPlanState } from './planState';
 export declare function getInvoicingPlansByIds(planState: InvoicingPlanState, ids: ID[]): InvoicingPlan[];
 export declare function getInvoicingPlanById(planState: InvoicingPlanState, id: ID): InvoicingPlan | undefined;
+/**
+ * The amount to show for one price point: what the service computed for a
+ * single unit. `price` is only a fallback for responses predating
+ * `display_price` — reading it first would show `0` for every tiered, volume
+ * and stairstep model, whose configured price is legitimately zero because the
+ * money lives in its tiers.
+ */
+export declare const invoicingPricePointDisplayAmount: (pricePoint: InvoicingProduct) => Amount | undefined;
 /**
  * The lowest amount a catalog item can be bought at: the smallest single-unit
  * price across its active price points.

package/lib/entity/invoicing/plan/planSelector.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getLowestInvoicingPlanPricePointAmount = void 0;
+exports.getLowestInvoicingPlanPricePointAmount = exports.invoicingPricePointDisplayAmount = void 0;
 exports.getInvoicingPlansByIds = getInvoicingPlansByIds;
 exports.getInvoicingPlanById = getInvoicingPlanById;
 const get_1 = __importDefault(require("lodash/get"));
@@ -29,6 +29,7 @@ const isActiveInvoicingPricePoint = (pricePoint) => pricePoint.status == null ||
  * money lives in its tiers.
  */
 const invoicingPricePointDisplayAmount = (pricePoint) => pricePoint.displayPrice ?? pricePoint.price;
+exports.invoicingPricePointDisplayAmount = invoicingPricePointDisplayAmount;
 /**
  * The lowest amount a catalog item can be bought at: the smallest single-unit
  * price across its active price points.
@@ -41,7 +42,7 @@ const invoicingPricePointDisplayAmount = (pricePoint) => pricePoint.displayPrice
 const getLowestInvoicingPlanPricePointAmount = (plan) => {
     const amounts = (plan?.subFamilies ?? [])
         .filter(isActiveInvoicingPricePoint)
-        .map(invoicingPricePointDisplayAmount)
+        .map(exports.invoicingPricePointDisplayAmount)
         .filter((amount) => amount != null);
     if (amounts.length === 0) {
         return undefined;

package/lib/entity/invoicing/product/productPayload.d.ts

@@ -60,7 +60,7 @@ export interface InvoicingProductPayload {
     period_unit?: string;
     price?: number;
     price_code?: string;
-    pricing_model?: string;
+    pricing_model?: string | null;
     product_code?: string;
     proration_type?: string;
     shipping_period?: number;

package/lib/entity/invoicing/product/productPayload.js

@@ -71,7 +71,7 @@ const mapInvoicingProductPayloadToState = (payload) => {
             ? (0, amount_1.toAmount)(payload.price, currencyCode, currencySymbol)
             : undefined,
         priceCode: payload.price_code,
-        pricingModel: payload.pricing_model,
+        pricingModel: payload.pricing_model ?? undefined,
         productCode: payload.product_code,
         prorationType: payload.proration_type,
         shippingPeriod: payload.shipping_period,

package/lib/entity/invoicing/product/productState.d.ts

@@ -16,6 +16,11 @@ export interface InvoicingAccountingDetail {
     accountingCode?: string;
     sku?: string;
 }
+/**
+ * Pricing models the catalog supports. The service has no enum for them yet,
+ * so this union is the single place they are named on the client.
+ */
+export type InvoicingCatalogPricingModel = 'flat_fee' | 'per_unit' | 'tiered' | 'volume' | 'stairstep';
 export interface InvoicingProduct {
     id: ID;
     accountingDetail?: InvoicingAccountingDetail;
@@ -50,6 +55,11 @@ export interface InvoicingProduct {
     periodUnit?: string;
     price?: Amount;
     priceCode?: string;
+    /**
+     * One of [[InvoicingCatalogPricingModel]] for records written by this app;
+     * kept `string` because the service has no enum yet and imports may carry
+     * other values. Absent means `per_unit` (the service default).
+     */
     pricingModel?: string;
     productCode?: string;
     prorationType?: string;

package/lib/esm/entity/invoicing/plan/planSelector.js

@@ -20,7 +20,7 @@ const isActiveInvoicingPricePoint = (pricePoint) => pricePoint.status == null ||
  * and stairstep model, whose configured price is legitimately zero because the
  * money lives in its tiers.
  */
-const invoicingPricePointDisplayAmount = (pricePoint) => pricePoint.displayPrice ?? pricePoint.price;
+export const invoicingPricePointDisplayAmount = (pricePoint) => pricePoint.displayPrice ?? pricePoint.price;
 /**
  * The lowest amount a catalog item can be bought at: the smallest single-unit
  * price across its active price points.

package/lib/esm/entity/invoicing/product/productPayload.js

@@ -67,7 +67,7 @@ export const mapInvoicingProductPayloadToState = (payload) => {
             ? toAmount(payload.price, currencyCode, currencySymbol)
             : undefined,
         priceCode: payload.price_code,
-        pricingModel: payload.pricing_model,
+        pricingModel: payload.pricing_model ?? undefined,
         productCode: payload.product_code,
         prorationType: payload.proration_type,
         shippingPeriod: payload.shipping_period,

package/lib/esm/view/invoicing/createInvoice/createInvoiceSelector.js

@@ -1,8 +1,35 @@
 import { getAddressByAddressId } from '../../../entity/address/addressSelector';
+import { invoicingPricePointDisplayAmount } from '../../../entity/invoicing/plan/planSelector';
 import { getInvoicingCatalogListView, getInvoicingCatalogPrices, } from '../invoicingCatalogListView/invoicingCatalogListViewSelector';
 import { invoicingFieldHelpForGroup } from '../invoicingConfigView/invoicingConfigViewSelector';
 import { getInvoicingCustomerListView } from '../invoicingCustomerListView/invoicingCustomerListViewSelector';
 import { getInvoicingSettings } from '../settingsView/settingsViewSelector';
+/**
+ * Pricing models whose single-unit amount is a true per-unit rate — the only
+ * ones a Create Invoice line may be prefilled from. Typed against the entity
+ * union so a misspelt member fails to compile; a model added to the union
+ * still has to be classified here by hand (it is left out, so it fails closed:
+ * no prefill). The complement is `isTieredCatalogPricingModel`.
+ */
+const PER_UNIT_RATE_PRICING_MODELS = [
+    'per_unit',
+    'flat_fee',
+];
+/**
+ * Whether a price point's single-unit amount is a per-unit rate. A missing
+ * model means per-unit: the service defaults `pricing_model` to `per_unit`
+ * and older records may omit it.
+ */
+const hasPerUnitRate = (pricingModel) => pricingModel == null ||
+    pricingModel === '' ||
+    PER_UNIT_RATE_PRICING_MODELS.some((model) => model === pricingModel);
+/**
+ * The amount to prefill on a Create Invoice line for a price point, or
+ * `undefined` when there is no safe per-unit rate to prefill.
+ */
+const planNamePrefillPrice = (pricePoint) => hasPerUnitRate(pricePoint.pricingModel)
+    ? invoicingPricePointDisplayAmount(pricePoint)?.amount
+    : undefined;
 /**
  * Display name for a customer option: company, else the full name, else the
  * email, else the raw id.
@@ -47,7 +74,7 @@ export const getCreateInvoiceFormView = (state) => {
             .filter((subFamily) => (subFamily.name ?? '') !== '')
             .map((subFamily) => ({
             planName: plan.name ?? '',
-            price: subFamily.price?.amount,
+            price: planNamePrefillPrice(subFamily),
             subFamilyName: subFamily.name ?? '',
         }))),
         products: getInvoicingCatalogPrices(catalogListView.products),

package/lib/esm/view/invoicing/editInvoicingCatalogItemDetailView/invoicingCatalogItemFormHelper.js

@@ -3,13 +3,7 @@
  * for pricing model, tier type, proration or applicability yet, so these stay
  * here until it does. Everything else on this form comes from `/1.0/config`.
  */
-export const INVOICING_CATALOG_PRICING_MODEL_VALUES = [
-    'flat_fee',
-    'per_unit',
-    'tiered',
-    'volume',
-    'stairstep',
-];
+export const INVOICING_CATALOG_PRICING_MODEL_VALUES = ['flat_fee', 'per_unit', 'tiered', 'volume', 'stairstep'];
 export const INVOICING_CATALOG_TIER_TYPE_VALUES = [
     'per_unit',
     'flat_fee',

package/lib/view/invoicing/createInvoice/createInvoiceSelector.d.ts

@@ -9,8 +9,13 @@ import { InvoicingCreateInvoiceFormLocalData } from './createInvoiceState';
  * One catalog plan price, split into its two naming parts so consumers can
  * compose the label themselves (the plan family name and the price point/price
  * name are separate columns in the catalog). `price` is the price point's
- * catalog price in whole USD (never minor units), absent when the catalog
- * carries no price for it.
+ * per-unit amount in whole USD (never minor units): the service-computed
+ * single-unit display price, falling back to the configured price for
+ * responses predating it. It is absent when the catalog carries no price for
+ * it, and deliberately absent for tiered, volume and stairstep price points —
+ * their single-unit figure is a step/band fee, not a rate, so multiplying it
+ * by a quantity (which is what the Create Invoice line prefill does) would
+ * produce a plausible-looking wrong total. Those lines start unpriced.
  */
 export interface InvoicingPlanNameOption {
     planName: string;

package/lib/view/invoicing/createInvoice/createInvoiceSelector.js

@@ -2,10 +2,37 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getCreateInvoiceFormView = void 0;
 const addressSelector_1 = require("../../../entity/address/addressSelector");
+const planSelector_1 = require("../../../entity/invoicing/plan/planSelector");
 const invoicingCatalogListViewSelector_1 = require("../invoicingCatalogListView/invoicingCatalogListViewSelector");
 const invoicingConfigViewSelector_1 = require("../invoicingConfigView/invoicingConfigViewSelector");
 const invoicingCustomerListViewSelector_1 = require("../invoicingCustomerListView/invoicingCustomerListViewSelector");
 const settingsViewSelector_1 = require("../settingsView/settingsViewSelector");
+/**
+ * Pricing models whose single-unit amount is a true per-unit rate — the only
+ * ones a Create Invoice line may be prefilled from. Typed against the entity
+ * union so a misspelt member fails to compile; a model added to the union
+ * still has to be classified here by hand (it is left out, so it fails closed:
+ * no prefill). The complement is `isTieredCatalogPricingModel`.
+ */
+const PER_UNIT_RATE_PRICING_MODELS = [
+    'per_unit',
+    'flat_fee',
+];
+/**
+ * Whether a price point's single-unit amount is a per-unit rate. A missing
+ * model means per-unit: the service defaults `pricing_model` to `per_unit`
+ * and older records may omit it.
+ */
+const hasPerUnitRate = (pricingModel) => pricingModel == null ||
+    pricingModel === '' ||
+    PER_UNIT_RATE_PRICING_MODELS.some((model) => model === pricingModel);
+/**
+ * The amount to prefill on a Create Invoice line for a price point, or
+ * `undefined` when there is no safe per-unit rate to prefill.
+ */
+const planNamePrefillPrice = (pricePoint) => hasPerUnitRate(pricePoint.pricingModel)
+    ? (0, planSelector_1.invoicingPricePointDisplayAmount)(pricePoint)?.amount
+    : undefined;
 /**
  * Display name for a customer option: company, else the full name, else the
  * email, else the raw id.
@@ -50,7 +77,7 @@ const getCreateInvoiceFormView = (state) => {
             .filter((subFamily) => (subFamily.name ?? '') !== '')
             .map((subFamily) => ({
             planName: plan.name ?? '',
-            price: subFamily.price?.amount,
+            price: planNamePrefillPrice(subFamily),
             subFamilyName: subFamily.name ?? '',
         }))),
         products: (0, invoicingCatalogListViewSelector_1.getInvoicingCatalogPrices)(catalogListView.products),

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

@@ -1,12 +1,12 @@
 import { InvoicingPlan } from '../../../entity/invoicing/plan/planState';
-import { InvoicingProduct } from '../../../entity/invoicing/product/productState';
+import { InvoicingCatalogPricingModel, InvoicingProduct } from '../../../entity/invoicing/product/productState';
 import { InvoicingCatalogItemFormLocalData, InvoicingCatalogItemFormSubFamily, InvoicingCatalogItemFormTier } from './editInvoicingCatalogItemDetailViewState';
 /**
  * Value sets the catalog item form still owns locally: the backend has no enum
  * for pricing model, tier type, proration or applicability yet, so these stay
  * here until it does. Everything else on this form comes from `/1.0/config`.
  */
-export declare const INVOICING_CATALOG_PRICING_MODEL_VALUES: readonly ["flat_fee", "per_unit", "tiered", "volume", "stairstep"];
+export declare const INVOICING_CATALOG_PRICING_MODEL_VALUES: readonly InvoicingCatalogPricingModel[];
 export declare const INVOICING_CATALOG_TIER_TYPE_VALUES: readonly ["per_unit", "flat_fee", "package"];
 export declare const INVOICING_CATALOG_PRORATION_VALUES: readonly ["site_default", "partial_term", "full_term"];
 export declare const INVOICING_CATALOG_APPLICABILITY_VALUES: readonly ["all", "restricted"];

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

@@ -6,13 +6,7 @@ exports.entityToInvoicingCatalogItemFormLocalData = exports.initialInvoicingCata
  * for pricing model, tier type, proration or applicability yet, so these stay
  * here until it does. Everything else on this form comes from `/1.0/config`.
  */
-exports.INVOICING_CATALOG_PRICING_MODEL_VALUES = [
-    'flat_fee',
-    'per_unit',
-    'tiered',
-    'volume',
-    'stairstep',
-];
+exports.INVOICING_CATALOG_PRICING_MODEL_VALUES = ['flat_fee', 'per_unit', 'tiered', 'volume', 'stairstep'];
 exports.INVOICING_CATALOG_TIER_TYPE_VALUES = [
     'per_unit',
     'flat_fee',

package/package.json

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