@peabody-soft/mbs-model-ts 1.9.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) {
@@ -143,10 +165,9 @@ class Catalog {
         return left.offerPrice - right.offerPrice;
     }
     // Prices the packages from the current sale price list, then rebuilds what a customer can reach.
-    // Only a buyable product is part of a catalog: enabled, not sold only offline, with at least one
-    // buyable package. Any other is left out of products, getProduct and its categories, and its
-    // packages are unreachable by id. A category with no buyable products is left out too, the dummy
-    // one included.
+    // Only a buyable product is part of a catalog: enabled, with at least one buyable package. Any
+    // other is left out of products, getProduct and its categories, and its packages are unreachable
+    // by id. A category with no buyable products is left out too, the dummy one included.
     applySalePriceList() {
         const salePriceList = this.priceList;
         const buyableProducts = [];

package/dist/Product.d.ts

@@ -14,9 +14,8 @@ export default class Product extends Item {
     private readonly _manufacturerAddress;
     private readonly _taxes;
     private readonly _features;
-    private readonly _isForOfflineSaleOnly;
     private readonly _photos;
-    constructor(header: EntityHeader, name: string, description: string | null, productCategoryId: bigint, isDisabled: boolean, _productType: proto_ProductType, _brand: string | null, _isManufacturedByBusiness: boolean, _manufacturer: string | null, _manufacturerAddress: Address | null, _taxes: ReadonlyArray<Tax>, _features: ReadonlyArray<string>, _isForOfflineSaleOnly: boolean, _photos: ReadonlyArray<Photo>);
+    constructor(header: EntityHeader, name: string, description: string | null, productCategoryId: bigint, isDisabled: boolean, _productType: proto_ProductType, _brand: string | null, _isManufacturedByBusiness: boolean, _manufacturer: string | null, _manufacturerAddress: Address | null, _taxes: ReadonlyArray<Tax>, _features: ReadonlyArray<string>, _photos: ReadonlyArray<Photo>);
     get productCategoryId(): bigint;
     get productType(): proto_ProductType;
     get brand(): string | null;
@@ -25,7 +24,6 @@ export default class Product extends Item {
     get manufacturerAddress(): Address | null;
     get taxes(): ReadonlyArray<Tax>;
     get features(): ReadonlyArray<string>;
-    get isForOfflineSaleOnly(): boolean;
     get photos(): ReadonlyArray<Photo>;
     get packages(): ReadonlyArray<Package>;
     private set packages(value);

package/dist/Product.js

@@ -2,7 +2,7 @@ import Item from "./Item";
 // A product in the catalog: goods, a service, a raw material or a fixed asset. Built with its
 // photos. Catalog sets its packages, once their prices are known.
 export default class Product extends Item {
-    constructor(header, name, description, productCategoryId, isDisabled, _productType, _brand, _isManufacturedByBusiness, _manufacturer, _manufacturerAddress, _taxes, _features, _isForOfflineSaleOnly, _photos) {
+    constructor(header, name, description, productCategoryId, isDisabled, _productType, _brand, _isManufacturedByBusiness, _manufacturer, _manufacturerAddress, _taxes, _features, _photos) {
         super(header, name, description, productCategoryId, isDisabled);
         this._productType = _productType;
         this._brand = _brand;
@@ -11,7 +11,6 @@ export default class Product extends Item {
         this._manufacturerAddress = _manufacturerAddress;
         this._taxes = _taxes;
         this._features = _features;
-        this._isForOfflineSaleOnly = _isForOfflineSaleOnly;
         this._photos = _photos;
         this._packages = Object.freeze([]);
     }
@@ -46,12 +45,6 @@ export default class Product extends Item {
     get features() {
         return this._features;
     }
-    // True when the business sells this product only offline. The server sends such a product like
-    // any other, flagged, and this model must not offer it to a customer (see isBuyable). A catalog
-    // never holds one, so only a hand-built product can report true.
-    get isForOfflineSaleOnly() {
-        return this._isForOfflineSaleOnly;
-    }
     get photos() {
         return this._photos;
     }
@@ -86,11 +79,10 @@ export default class Product extends Item {
                 return true;
         return false;
     }
-    // True when this product is enabled, is not sold only offline, and has at least one variant (it
-    // keeps only buyable ones). The server filters out draft and non-public products before they
-    // arrive. isDisabled can change after an item exists and offline-only products are sent flagged,
-    // so both are checked here.
+    // True when this product is enabled and has at least one variant (it keeps only buyable ones).
+    // The server filters out draft and non-public products before they arrive. isDisabled can change
+    // after an item exists, so it is checked here.
     get isBuyable() {
-        return !this.isDisabled && !this._isForOfflineSaleOnly && this._packages.length > 0;
+        return !this.isDisabled && this._packages.length > 0;
     }
 }

package/dist/ProtoMap.js

@@ -1248,7 +1248,7 @@ function productFromProto(productProto, photos, countryCode) {
     return new Product(toEntityHeader(entity), item.name, stringFromProto(item.description), item.parentItemId, item.isDisabled, productProto.productType, stringFromProto(productProto.brand), productProto.isManufacturedByBusiness ?? true, // Absent means true (Product.proto)
     stringFromProto(productProto.manufacturer), productProto.manufacturerAddress === undefined
         ? null
-        : addressFromProto(productProto.manufacturerAddress), Object.freeze(productProto.taxes.map((tax) => taxFromProto(tax, countryCode))), Object.freeze([...productProto.features]), productProto.forOfflineSaleOnly, photos);
+        : addressFromProto(productProto.manufacturerAddress), Object.freeze(productProto.taxes.map((tax) => taxFromProto(tax, countryCode))), Object.freeze([...productProto.features]), photos);
 }
 function orderFromProto(message, salesOrder, countryCode) {
     const entity = getEntity(message.entity);

package/dist/generated/Product.d.ts

@@ -13,7 +13,7 @@ import { Item } from "./Item";
  * at most one category (Item.parentItemId, 0 = none); its packages and photos are found the same
  * way, by parentItemId / owningEntityId.
  * Excluded: isDraft, isStockKeepingEnabled, isExpiryTrackingEnabled,
- * storeProperties, defaultExpiry, classifications, all Translations fields.
+ * storeProperties, defaultExpiry, classifications, forOfflineSaleOnly, all Translations fields.
  *
  * @generated from protobuf message com.merabills.storefront.Product
  */
@@ -63,15 +63,6 @@ export interface Product {
      * @generated from protobuf field: repeated string features = 8
      */
     features: string[];
-    /**
-     * True when the business sells this product only offline (Java Product.getForOfflineSaleOnly: the product has "available
-     * online" turned off). The server sends such a product like any other public one, and it is for the client to not show
-     * it, nor its packages, to a customer, nor let a customer order it (mbs-model's Catalog leaves it out). Absent means
-     * false: a product that is not offline-only
-     *
-     * @generated from protobuf field: bool forOfflineSaleOnly = 9
-     */
-    forOfflineSaleOnly: boolean;
 }
 declare class Product$Type extends MessageType<Product> {
     constructor();

package/dist/generated/Product.js

@@ -17,8 +17,7 @@ class Product$Type extends MessageType {
             { no: 5, name: "manufacturer", kind: "scalar", opt: true, T: 9 /*ScalarType.STRING*/ },
             { no: 6, name: "manufacturerAddress", kind: "message", T: () => Address },
             { no: 7, name: "taxes", kind: "message", repeat: 2 /*RepeatType.UNPACKED*/, T: () => Tax },
-            { no: 8, name: "features", kind: "scalar", repeat: 2 /*RepeatType.UNPACKED*/, T: 9 /*ScalarType.STRING*/ },
-            { no: 9, name: "forOfflineSaleOnly", kind: "scalar", T: 8 /*ScalarType.BOOL*/ }
+            { no: 8, name: "features", kind: "scalar", repeat: 2 /*RepeatType.UNPACKED*/, T: 9 /*ScalarType.STRING*/ }
         ]);
     }
     create(value) {
@@ -26,7 +25,6 @@ class Product$Type extends MessageType {
         message.productType = 0;
         message.taxes = [];
         message.features = [];
-        message.forOfflineSaleOnly = false;
         if (value !== undefined)
             reflectionMergePartial(this, message, value);
         return message;
@@ -60,9 +58,6 @@ class Product$Type extends MessageType {
                 case /* repeated string features */ 8:
                     message.features.push(reader.string());
                     break;
-                case /* bool forOfflineSaleOnly */ 9:
-                    message.forOfflineSaleOnly = reader.bool();
-                    break;
                 default:
                     let u = options.readUnknownField;
                     if (u === "throw")
@@ -99,9 +94,6 @@ class Product$Type extends MessageType {
         /* repeated string features = 8; */
         for (let i = 0; i < message.features.length; i++)
             writer.tag(8, WireType.LengthDelimited).string(message.features[i]);
-        /* bool forOfflineSaleOnly = 9; */
-        if (message.forOfflineSaleOnly !== false)
-            writer.tag(9, WireType.Varint).bool(message.forOfflineSaleOnly);
         let u = options.writeUnknownFields;
         if (u !== false)
             (u == true ? UnknownFieldHandler.onWrite : u)(this.typeName, message, writer);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@peabody-soft/mbs-model-ts",
-  "version": "1.9.0",
+  "version": "1.11.0",
   "description": "MeraBills storefront client-side model (TypeScript)",
   "author": "Peabody Soft",
   "license": "AGPL-3.0-or-later",
@@ -49,7 +49,7 @@
     "typescript": "^7.0.2"
   },
   "dependencies": {
-    "@peabody-soft/mbs-protos": "^1.13.0",
+    "@peabody-soft/mbs-protos": "^1.14.0",
     "@protobuf-ts/runtime": "^2.11.1"
   }
 }