@peabody-soft/mbs-model-ts 1.10.0 → 1.11.0

package/dist/Catalog.d.ts

@@ -16,6 +16,8 @@ export default class Catalog {
     getCategory(productCategoryId: bigint): ProductCategory | null;
     getProduct(productId: bigint): Product | null;
     getPackage(packageId: bigint): Package | null;
+    getProductForDisplay(productId: bigint): Product | null;
+    getPackageForDisplay(packageId: bigint): Package | null;
     static comparePackages(left: Package, right: Package): number;
     static compareByName(left: Item, right: Item): number;
     private static compareNames;
@@ -27,6 +29,8 @@ export default class Catalog {
     private readonly _allProducts;
     private readonly _uncategorized;
     private readonly _candidatePackages;
+    private readonly _displayProductMap;
+    private readonly _displayPackageMap;
     private readonly _priceListMap;
     private _currentSalePriceListId;
     private _categories;

package/dist/Catalog.js

@@ -13,6 +13,7 @@ class Catalog {
     constructor(categories, products, packages, priceLists, prices) {
         // Every package that has a product, by that product's id, whether it can be bought or not
         this._candidatePackages = new Map();
+        this._displayPackageMap = new Map();
         this._priceListMap = new Map();
         this._currentSalePriceListId = DEFAULT_SALE_PRICE_LIST_ID;
         // What a customer can reach, rebuilt by applySalePriceList
@@ -31,11 +32,13 @@ class Catalog {
         const productsById = new Map();
         for (const product of products)
             productsById.set(product.id, product);
+        this._displayProductMap = productsById;
         for (const pkg of packages) {
             const product = productsById.get(pkg.productId);
             if (product === undefined)
                 continue;
             UpdatableEntity.setParent(pkg, product);
+            this._displayPackageMap.set(pkg.id, pkg);
             const productPackages = this._candidatePackages.get(product.id);
             if (productPackages === undefined)
                 this._candidatePackages.set(product.id, [pkg]);
@@ -110,6 +113,25 @@ class Catalog {
     getPackage(packageId) {
         return this._packageMap.get(packageId) ?? null;
     }
+    // Like getProduct, but for any product that the server sent, whether it can be bought or not: it
+    // is disabled, or it has nothing left to buy. It is for drawing a shopping list that already
+    // exists, such as an order that was placed, whose line can name a product that is no longer
+    // sold. Do not use it to offer anything for sale. Its packages are not on offer either:
+    // Product.packages keeps only the buyable ones, so it is empty for a product that cannot be
+    // bought. Null for an unknown id.
+    getProductForDisplay(productId) {
+        return this._displayProductMap.get(productId) ?? null;
+    }
+    // Like getPackage, but for any package of a product that the server sent, whether it can be
+    // bought or not: it is disabled, it has no enabled price, or its product is disabled. For
+    // drawing a shopping list that already exists (see getProductForDisplay), not for offering
+    // anything for sale. Package.price is the price in the current sale price list, null when there
+    // is none, and disabled when the package is not in that list. Null for an unknown id, and for
+    // the four reserved package ids a shopping list uses for its charge and summary lines (see
+    // Ids.isReservedPackageId).
+    getPackageForDisplay(packageId) {
+        return this._displayPackageMap.get(packageId) ?? null;
+    }
     // Display comparator for packages, matching the merchant app's PackageComparator minus the
     // clauses a storefront cannot exercise (disabled packages and the purchase price list, neither sent)
     static comparePackages(left, right) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@peabody-soft/mbs-model-ts",
-  "version": "1.10.0",
+  "version": "1.11.0",
   "description": "MeraBills storefront client-side model (TypeScript)",
   "author": "Peabody Soft",
   "license": "AGPL-3.0-or-later",