@zeniai/client-epic-state 5.2.41-beta1MM → 5.2.42-betaAK0

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

@@ -3,7 +3,6 @@ import { toClassBasePayload } from '../../../entity/class/classPayload';
 import { blankInvoicingCatalogSubFamily, isTieredCatalogPricingModel, } from './invoicingCatalogItemFormHelper';
 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()
@@ -91,13 +90,24 @@ const buildSubFamilyPayload = (localData, subFamily, clearEmptyValues, lookup) =
 /** `unit` is the item's unit of measure, not a currency; `CURRENCY_CODE` above prices Price points. */
 const DEFAULT_CATALOG_ITEM_UNIT = 'USD';
 /**
- * Build the parent catalog-item request body from the form draft. Creates omit
- * both parent and price point IDs; edits retain returned price point IDs.
+ * Build the parent catalog-item request body from the form draft. Every field
+ * the form holds is sent, so a value cleared on the form is cleared on the
+ * item: the service reads an absent key as "leave it alone", which is why
+ * `description` travels as an empty string and `applicable_items` as an empty
+ * list rather than being dropped. Fields the form does not collect
+ * (`external_name`, `item_family_id`, `metadata`, …) stay off the body so an
+ * edit cannot overwrite them with a value nobody chose.
  */
 export const localDataToSaveInvoicingCatalogItemPayload = (localData, isCreate, lookup) => {
-    const description = trimOrUndefined(localData.description);
     const productCode = trimOrUndefined(localData.productCode) ?? toProductCode(localData.name);
     const itemPayload = {
+        // `applicable_items` only means anything while the item is restricted;
+        // sending the empty list otherwise is what clears a restriction that was
+        // just lifted.
+        applicable_items: localData.itemApplicability === 'restricted'
+            ? localData.applicableItems
+            : [],
+        description: trimOrUndefined(localData.description) ?? '',
         enabled_for_checkout: true,
         enabled_in_portal: true,
         is_giftable: false,
@@ -107,41 +117,40 @@ export const localDataToSaveInvoicingCatalogItemPayload = (localData, isCreate,
         name: localData.name.trim(),
         product_code: productCode,
         type: localData.catalogType,
+        // The form no longer collects a unit; an item that already has one keeps it.
+        unit: trimOrUndefined(localData.unit) ?? DEFAULT_CATALOG_ITEM_UNIT,
     };
-    if (description != null) {
-        itemPayload.description = description;
-    }
-    // The form no longer collects a unit; an item that already has one keeps it.
-    itemPayload.unit =
-        trimOrUndefined(localData.unit) ?? DEFAULT_CATALOG_ITEM_UNIT;
-    if (localData.itemApplicability === 'restricted' &&
-        localData.applicableItems.length > 0) {
-        itemPayload.applicable_items = localData.applicableItems;
+    // The external id is assigned by the billing service and shown read-only, so
+    // it is echoed back only when the item already has one: sending the blank a
+    // create starts with would clear an id assigned in the meantime.
+    const externalId = trimOrUndefined(localData.externalId);
+    if (externalId != null) {
+        itemPayload.external_id = externalId;
     }
     const subFamilies = localData.subFamilies.length > 0
         ? localData.subFamilies
         : [blankInvoicingCatalogSubFamily()];
-    itemPayload.sub_family_details = isCreate
+    itemPayload.sub_families = isCreate
         ? subFamilies.map((subFamily) => buildSubFamilyPayload(localData, subFamily, false, lookup))
         : 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,
-            };
-            // Edits send a narrower body than creates, but the accounting mapping
-            // is editable on this form, so leaving it out dropped the account and
-            // class the user had just picked. `null` rather than omitted when it is
-            // empty: an absent key on an update reads as "leave it alone", which
-            // would make a cleared mapping impossible to save — the same reason
-            // `description` and `invoice_notes` go through `trimOrNull`.
+            // Edits send the same body a create does. The narrower hand-built one
+            // this replaces had to be kept in step by hand and was not: it dropped
+            // `accounting_detail` once, and `billing_cycles`, `price`,
+            // `pricing_model`, `period`, the trial fields, `proration_type`,
+            // `free_quantity`, `is_taxable` and `tiers` were never added at all, so
+            // editing any of them looked saved and changed nothing.
+            const detail = buildSubFamilyPayload(localData, subFamily, true, lookup);
+            // `null` rather than omitted when empty: an absent key on an update
+            // reads as "leave it alone", which would make a cleared mapping
+            // impossible to save — the same reason `description` and
+            // `invoice_notes` are cleared rather than dropped above.
             detail.accounting_detail =
                 buildAccountingDetail(subFamily, lookup) ?? null;
-            const id = trimOrUndefined(subFamily.id);
-            return id != null ? { ...detail, id } : detail;
+            // A price point added on this form has no id yet, and travels with a
+            // blank one. The update endpoint reads that as "create this one", so it
+            // lands in the same request as the edits around it rather than a second
+            // call that could fail on its own.
+            return { ...detail, id: subFamily.id.trim() };
         });
     return itemPayload;
 };

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

@@ -1,10 +1,30 @@
 import { AccountBase } from '../../../entity/account/accountState';
 import { ClassBase } from '../../../entity/class/classState';
 import { InvoicingPlanPayload } from '../../../entity/invoicing/plan/planPayload';
-import { InvoicingProductPayload } from '../../../entity/invoicing/product/productPayload';
+import { InvoicingAccountingDetailPayload, InvoicingProductPayload } from '../../../entity/invoicing/product/productPayload';
 import { ZeniAPIResponse } from '../../../responsePayload';
 import { InvoicingCatalogItemFormLocalData } from './editInvoicingCatalogItemDetailViewState';
 export type SaveInvoicingCatalogItemResponse = ZeniAPIResponse<InvoicingPlanPayload>;
+/**
+ * The price-point half of a save body. `InvoicingProductPayload` is the shape
+ * the service returns; a save differs in two ways: a field is cleared by
+ * sending an explicit `null` (an absent key reads as "leave it alone"), and a
+ * price point the form has only just added carries a blank `id`, which the
+ * update endpoint reads as "create this one".
+ */
+export type InvoicingCatalogSubFamilySavePayload = Omit<Partial<InvoicingProductPayload>, 'accounting_detail' | 'description' | 'invoice_notes'> & {
+    accounting_detail?: InvoicingAccountingDetailPayload | null;
+    description?: string | null;
+    invoice_notes?: string | null;
+};
+/**
+ * The catalog-item save body: the item the service returns, minus the fields it
+ * assigns itself. Price points keep the `sub_families` name they are read back
+ * under, and differ only in allowing the cleared and blank-id forms above.
+ */
+export type InvoicingCatalogItemSavePayload = Omit<Partial<InvoicingPlanPayload>, 'sub_families'> & {
+    sub_families?: InvoicingCatalogSubFamilySavePayload[];
+};
 /**
  * Resolves the QuickBooks ids the pickers submit back to the entities they name.
  * The payload carries the whole account and class, so the ids alone are not
@@ -20,12 +40,17 @@ export interface InvoicingCatalogAccountingFields {
     accountingCode: string;
     sku: string;
 }
-export declare const buildAccountingDetail: (subFamily: InvoicingCatalogAccountingFields, lookup: InvoicingCatalogAccountingLookup) => Record<string, unknown> | undefined;
+export declare const buildAccountingDetail: (subFamily: InvoicingCatalogAccountingFields, lookup: InvoicingCatalogAccountingLookup) => InvoicingAccountingDetailPayload | undefined;
 /**
- * Build the parent catalog-item request body from the form draft. Creates omit
- * both parent and price point IDs; edits retain returned price point IDs.
+ * Build the parent catalog-item request body from the form draft. Every field
+ * the form holds is sent, so a value cleared on the form is cleared on the
+ * item: the service reads an absent key as "leave it alone", which is why
+ * `description` travels as an empty string and `applicable_items` as an empty
+ * list rather than being dropped. Fields the form does not collect
+ * (`external_name`, `item_family_id`, `metadata`, …) stay off the body so an
+ * edit cannot overwrite them with a value nobody chose.
  */
-export declare const localDataToSaveInvoicingCatalogItemPayload: (localData: InvoicingCatalogItemFormLocalData, isCreate: boolean, lookup: InvoicingCatalogAccountingLookup) => Record<string, unknown>;
+export declare const localDataToSaveInvoicingCatalogItemPayload: (localData: InvoicingCatalogItemFormLocalData, isCreate: boolean, lookup: InvoicingCatalogAccountingLookup) => InvoicingCatalogItemSavePayload;
 export type RunInvoicingCatalogPlanActionResponse = ZeniAPIResponse<InvoicingPlanPayload>;
 export type RunInvoicingCatalogProductActionResponse = ZeniAPIResponse<InvoicingProductPayload>;
 export type InvoicingCatalogItemDetailResponse = ZeniAPIResponse<InvoicingPlanPayload>;

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

@@ -6,7 +6,6 @@ const classPayload_1 = require("../../../entity/class/classPayload");
 const invoicingCatalogItemFormHelper_1 = require("./invoicingCatalogItemFormHelper");
 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()
@@ -95,13 +94,24 @@ const buildSubFamilyPayload = (localData, subFamily, clearEmptyValues, lookup) =
 /** `unit` is the item's unit of measure, not a currency; `CURRENCY_CODE` above prices Price points. */
 const DEFAULT_CATALOG_ITEM_UNIT = 'USD';
 /**
- * Build the parent catalog-item request body from the form draft. Creates omit
- * both parent and price point IDs; edits retain returned price point IDs.
+ * Build the parent catalog-item request body from the form draft. Every field
+ * the form holds is sent, so a value cleared on the form is cleared on the
+ * item: the service reads an absent key as "leave it alone", which is why
+ * `description` travels as an empty string and `applicable_items` as an empty
+ * list rather than being dropped. Fields the form does not collect
+ * (`external_name`, `item_family_id`, `metadata`, …) stay off the body so an
+ * edit cannot overwrite them with a value nobody chose.
  */
 const localDataToSaveInvoicingCatalogItemPayload = (localData, isCreate, lookup) => {
-    const description = trimOrUndefined(localData.description);
     const productCode = trimOrUndefined(localData.productCode) ?? toProductCode(localData.name);
     const itemPayload = {
+        // `applicable_items` only means anything while the item is restricted;
+        // sending the empty list otherwise is what clears a restriction that was
+        // just lifted.
+        applicable_items: localData.itemApplicability === 'restricted'
+            ? localData.applicableItems
+            : [],
+        description: trimOrUndefined(localData.description) ?? '',
         enabled_for_checkout: true,
         enabled_in_portal: true,
         is_giftable: false,
@@ -111,41 +121,40 @@ const localDataToSaveInvoicingCatalogItemPayload = (localData, isCreate, lookup)
         name: localData.name.trim(),
         product_code: productCode,
         type: localData.catalogType,
+        // The form no longer collects a unit; an item that already has one keeps it.
+        unit: trimOrUndefined(localData.unit) ?? DEFAULT_CATALOG_ITEM_UNIT,
     };
-    if (description != null) {
-        itemPayload.description = description;
-    }
-    // The form no longer collects a unit; an item that already has one keeps it.
-    itemPayload.unit =
-        trimOrUndefined(localData.unit) ?? DEFAULT_CATALOG_ITEM_UNIT;
-    if (localData.itemApplicability === 'restricted' &&
-        localData.applicableItems.length > 0) {
-        itemPayload.applicable_items = localData.applicableItems;
+    // The external id is assigned by the billing service and shown read-only, so
+    // it is echoed back only when the item already has one: sending the blank a
+    // create starts with would clear an id assigned in the meantime.
+    const externalId = trimOrUndefined(localData.externalId);
+    if (externalId != null) {
+        itemPayload.external_id = externalId;
     }
     const subFamilies = localData.subFamilies.length > 0
         ? localData.subFamilies
         : [(0, invoicingCatalogItemFormHelper_1.blankInvoicingCatalogSubFamily)()];
-    itemPayload.sub_family_details = isCreate
+    itemPayload.sub_families = isCreate
         ? subFamilies.map((subFamily) => buildSubFamilyPayload(localData, subFamily, false, lookup))
         : 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,
-            };
-            // Edits send a narrower body than creates, but the accounting mapping
-            // is editable on this form, so leaving it out dropped the account and
-            // class the user had just picked. `null` rather than omitted when it is
-            // empty: an absent key on an update reads as "leave it alone", which
-            // would make a cleared mapping impossible to save — the same reason
-            // `description` and `invoice_notes` go through `trimOrNull`.
+            // Edits send the same body a create does. The narrower hand-built one
+            // this replaces had to be kept in step by hand and was not: it dropped
+            // `accounting_detail` once, and `billing_cycles`, `price`,
+            // `pricing_model`, `period`, the trial fields, `proration_type`,
+            // `free_quantity`, `is_taxable` and `tiers` were never added at all, so
+            // editing any of them looked saved and changed nothing.
+            const detail = buildSubFamilyPayload(localData, subFamily, true, lookup);
+            // `null` rather than omitted when empty: an absent key on an update
+            // reads as "leave it alone", which would make a cleared mapping
+            // impossible to save — the same reason `description` and
+            // `invoice_notes` are cleared rather than dropped above.
             detail.accounting_detail =
                 (0, exports.buildAccountingDetail)(subFamily, lookup) ?? null;
-            const id = trimOrUndefined(subFamily.id);
-            return id != null ? { ...detail, id } : detail;
+            // A price point added on this form has no id yet, and travels with a
+            // blank one. The update endpoint reads that as "create this one", so it
+            // lands in the same request as the edits around it rather than a second
+            // call that could fail on its own.
+            return { ...detail, id: subFamily.id.trim() };
         });
     return itemPayload;
 };

package/package.json

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