@peabody-soft/mbs-model-ts 1.7.0 → 1.8.0

package/dist/Attachment.js

@@ -1,7 +1,7 @@
 import Entity from "./Entity";
 import Ids from "./Ids";
-// A file attached to an entity: a photo of a business, product or package. Not public. A UI is given
-// a Photo (attachment type and url) built from it.
+// A file attached to an entity: a photo of a business, product or package. Not exported from
+// index.ts: a UI is given a Photo (attachment type and url) built from it.
 export default class Attachment extends Entity {
     constructor(header, _attachmentType, _owningEntityId, _fileHash, _fileExtension, _fileName) {
         super(header);

package/dist/AttachmentBaseUrl.js

@@ -1,14 +1,14 @@
 import { Constants as proto_Constants } from "./generated/Constants";
 import { InvalidArgumentException } from "./Exceptions";
 // Where a business's attachment files live, the signature that reads them, and when both expire.
-// The signature has no getter, only createFileUrl exposes it. It is safe in a url because it is
-// scoped, read-only and short-lived, unlike AuthTokens' userToken and linkToken.
+// The signature has no getter, and only createFileUrl exposes it. A signature in a url is safe
+// because it is scoped, read-only and short-lived, unlike AuthTokens' userToken and linkToken.
 export default class AttachmentBaseUrl {
     constructor(_resourceUrl, _sasToken, expiry) {
         this._resourceUrl = _resourceUrl;
         this._sasToken = _sasToken;
-        // The protobuf promises no trailing slash and no query string. Checked, since either would
-        // silently build a url that fetches nothing.
+        // The protobuf specifies no trailing slash and no query string. Either would build a url that
+        // fetches nothing, so both are checked.
         if (_resourceUrl.length === 0 || _resourceUrl.endsWith("/"))
             throw new InvalidArgumentException(`Not a container url: ${_resourceUrl}`);
         if (_resourceUrl.includes("?"))

package/dist/AuthTokens.js

@@ -1,6 +1,6 @@
-// The credentials a request is signed with: the fields of the AuthTokens message, nothing derived.
-// A class of its own because it is held and cached. ProtoMap turns one into the message a Service
-// is handed. Every value is a bearer credential, so never log one.
+// The credentials a request is signed with: the fields of the AuthTokens message, with nothing
+// derived. It is a class because it is held and cached. ProtoMap converts one into the message
+// passed to a Service. Every value is a bearer credential, so never log one.
 export default class AuthTokens {
     constructor(_authenticationMethod, _authenticationToken, _userToken, _linkToken) {
         this._authenticationMethod = _authenticationMethod;
@@ -13,13 +13,13 @@ export default class AuthTokens {
     get authenticationMethod() {
         return this._authenticationMethod;
     }
-    // Who is calling, as their identity provider states it. Empty when read back from the cache, which
-    // keeps no copy. See ProtoMap.authTokensToBlob.
+    // The identity provider's token for the caller. Empty when read back from the cache, which stores
+    // no copy. See ProtoMap.authTokensToBlob.
     get authenticationToken() {
         return this._authenticationToken;
     }
-    // The MeraBills user, issued by this server. Null until the first profile sync out, which is the
-    // call that returns one.
+    // Identifies the MeraBills user. This server issues it, so it is null until the first profile
+    // sync out returns one.
     get userToken() {
         return this._userToken;
     }

package/dist/Business.js

@@ -48,8 +48,8 @@ export default class Business extends Entity {
         this._photos = value;
     }
     // The orders this customer has placed, open and completed (fulfilled or cancelled). Order.status
-    // says how far the business got, and Order.isDeleted that it has completed the order. The library
-    // does not sort them.
+    // is the order's progress, and Order.isDeleted is true once the business has completed it. The
+    // library does not sort them.
     get orders() {
         return this._orders;
     }
@@ -57,8 +57,8 @@ export default class Business extends Entity {
         this._orders = value;
     }
     // What this customer has picked and not yet ordered. Null until something is put in a cart, and
-    // null again once it is ordered, although the message carrying the cart outlives that. Only the
-    // list is exposed. The fulfillment mode is chosen when an order is placed and is a field of the
+    // null again once the cart is ordered. The cart message itself stays, with no list. Only the list
+    // is exposed here. The fulfillment mode is chosen when an order is placed and is stored on the
     // Order (see defaultFulfillmentMode).
     get cart() {
         return this._cart;
@@ -66,9 +66,9 @@ export default class Business extends Entity {
     set cart(value) {
         this._cart = value;
     }
-    // What to preselect for the next order. It is the mode in the party preferences message, which
-    // createOrder stamps with the mode of the order just placed, so it is the last order's choice.
-    // DELIVERY when there is no party preferences message.
+    // The fulfillment mode to preselect for the next order: the mode of the last order placed, which
+    // Model.createOrder writes to the party preferences message. DELIVERY when there is no party
+    // preferences message.
     get defaultFulfillmentMode() {
         return this._defaultFulfillmentMode;
     }
@@ -84,12 +84,13 @@ export default class Business extends Entity {
     }
     // A scratch copy of the cart to edit, priced from this business's catalog and settings (see
     // CartEditor). It reads catalog, settings and cart once, so a Business republished mid-edit needs
-    // a new editor. Nothing it does touches this business until its built list reaches
-    // Model.updateCartLocalOnly.
+    // a new editor. Editing does not change this business. The cart changes only when the editor's
+    // built list is passed to Model.updateCartLocalOnly.
     createCartEditor() {
         return new CartEditor(this._catalog, this._settings, this._cart);
     }
-    // Where this business's photo files live. Renewed on its own schedule.
+    // Where this business's photo files live. The server renews it, and it is tracked by its expiry,
+    // not by an entity cursor.
     get attachmentBaseUrl() {
         return this._attachmentBaseUrl;
     }

package/dist/BusinessIdentifier.js

@@ -1,5 +1,6 @@
-// An identifier of a business, such as a GSTIN, and its kind. A pair rather than a map, as in
-// PackageIdentifier: Java identifies kinds by string id, so the numbering is protocol-only.
+// An identifier of a business, such as a GSTIN, and its kind. It is a pair of type and value, not a
+// map keyed by kind, as in PackageIdentifier. Java identifies kinds by string id, so the enum
+// numbering exists only in the protocol.
 export default class BusinessIdentifier {
     constructor(_type, _value) {
         this._type = _type;

package/dist/BusinessLink.js

@@ -44,8 +44,9 @@ class BusinessLink extends Entity {
     get isExpirySet() {
         return this._expiry !== BusinessLink.NO_EXPIRY;
     }
-    // True once past expiry by more than Constants.MAX_CLOCK_SKEW. Applied the opposite way to
-    // AttachmentBaseUrl.hasExpired, so a false positive cannot lock out an entitled customer.
+    // True once expiry is more than Constants.MAX_CLOCK_SKEW in the past. The skew delays expiry
+    // here, whereas AttachmentBaseUrl.hasExpired advances it. A false positive here would lock out an
+    // entitled customer.
     get hasExpired() {
         if (!this.isExpirySet)
             return false;

package/dist/CartEditor.js

@@ -6,33 +6,36 @@ import { InvalidArgumentException } from "./Exceptions";
 import Ids from "./Ids";
 import ShoppingList, { ShoppingListItem, validatePricing } from "./ShoppingList";
 import TaxHelper from "./TaxHelper";
-// Builds the cart a customer is filling, in the terms a UI has to hand: packages, quantities as
-// the customer means them (not multiplied by Constants.QUANTITY_FACTOR), prices from the catalog.
-// Get one from Business.createCartEditor, edit it, then hand build() to Model.updateCartLocalOnly.
+// Builds the cart a customer is filling. It works in packages, quantities as the customer enters
+// them (not multiplied by Constants.QUANTITY_FACTOR) and prices from the catalog. Get one from
+// Business.createCartEditor, edit it, then pass build() to Model.updateCartLocalOnly.
 //
-// Mutable, and the only mutable thing in this object model. It is a scratch copy: editing it
-// changes no Business, store or server until a built list is handed to Model. It is also a
-// snapshot, read once at construction, so a sync mid-edit does not move prices under the customer.
-// Make a fresh one when the Business republishes.
+// Mutable, and the only mutable class in this object model. It is a scratch copy: editing it
+// changes no Business, store or server until a built list is passed to Model. It is also a
+// snapshot, read once at construction, so a sync during an edit does not change the prices. Make
+// a new one when the Business is republished.
 //
-// EVERY PRICE HERE INCLUDES TAXES: a package's includes its product's taxes, the delivery charge
-// the taxes the settings name for it, so a customer pays what the catalog shows. A shopping list
-// item stores a price WITHOUT taxes, so building one takes them out, as Java
-// ShoppingListItem.setDetailsFromTaxInclusivePrices does (to the unit, see TaxHelper). Taxes are
-// shown as what a total includes (taxes), never added to it.
+// EVERY PRICE HERE INCLUDES TAXES. A package's price includes its product's taxes, and the
+// delivery charge includes the taxes the settings name for it, so a customer pays what the
+// catalog shows. A shopping list item stores a price WITHOUT taxes, so building one takes them
+// out, as Java ShoppingListItem.setDetailsFromTaxInclusivePrices does (with the same amounts to
+// the unit, see TaxHelper). A total includes its taxes. They are reported separately and never
+// added to it.
 class CartEditor {
-    // Business.createCartEditor is how a UI gets one. It takes the catalog, settings and cart, not
-    // the Business, so a caller can build a cart against ones that are not currently published.
+    // It takes the catalog, settings and cart instead of the Business, so a caller can build a cart
+    // against ones that are not the currently published ones.
     //
-    // Every line is priced off the catalog, not off what the cart held: the merchant may have
-    // repriced since, and an order freezes the price when it is placed. A line goes to
-    // unavailableItems, for a UI to tell the customer about, when the catalog can no longer price it
-    // (package withdrawn, disabled or without a price) or setQuantity would refuse it (a cart that
-    // was read is not known to be one this class could have made): a zero or invalid quantity, a
-    // fraction of a package not sold loose, more than the wire or the protocol carries at today's
-    // price, or a line past the most a cart holds (the first lines are kept, in pick order).
-    // The charge lines of the starting list (see ShoppingListItem.isReservedPackage) are dropped, not
-    // listed, since build() puts back what the settings now say.
+    // Every line is priced from the catalog, not from the price the cart held: the merchant may have
+    // repriced since, and an order freezes the price when it is placed.
+    //
+    // A line goes to unavailableItems, for a UI to show the customer, when the catalog cannot price
+    // it (package withdrawn, disabled or without a price). A cart that was read back is not known to
+    // be one this class could have made, so a line also goes there when setQuantity would reject it:
+    // a zero or invalid quantity, a fraction of a package not sold loose, a quantity too large for
+    // the wire, a quantity whose amount at today's price is too large for the protocol, or a line
+    // past the most a cart holds (the first lines are kept, in pick order).
+    // The charge lines of the starting list (see ShoppingListItem.isReservedPackage) are dropped and
+    // not listed, because build() adds the charges the settings give.
     constructor(_catalog, _settings, cart) {
         this._catalog = _catalog;
         this._settings = _settings;
@@ -40,8 +43,8 @@ class CartEditor {
         // shoppingListOrder
         this._quantities = new Map();
         this._inventoryLocationId = cart?.inventoryLocationId ?? 0;
-        // goodsItems is in the order the customer picked. existingItems is not, the server sending it
-        // by package id, so a cart read back would reorder itself
+        // goodsItems is in the order the customer picked. existingItems is in the order the server
+        // sends it, by package id, so reading from it would reorder the cart
         const unavailableItems = [];
         for (const item of cart?.goodsItems ?? []) {
             if (item.isReservedPackage)
@@ -63,8 +66,8 @@ class CartEditor {
         }
         return Object.freeze(lines);
     }
-    // The lines of the starting cart that the catalog can no longer price (see the constructor).
-    // Empty for a cart built from nothing, and no edit adds to it.
+    // The lines of the starting cart that could not be kept (see the constructor). Empty for a cart
+    // built from nothing, and no edit adds to it.
     get unavailableItems() {
         return this._unavailableItems;
     }
@@ -86,11 +89,12 @@ class CartEditor {
     getQuantity(item) {
         return this._quantities.get(item.id) ?? 0;
     }
-    // Sets how much of one package the cart holds; zero takes it out. Refuses a package a customer
-    // cannot buy (disabled, or priced in no list this storefront sells from), a fractional quantity
-    // of a package that is not sold loose, and a quantity past what the wire can carry. Sold loose is
-    // read from the catalog's package, since the Package passed in may predate a catalog change.
-    // Returns this, so edits chain.
+    // Sets how much of one package the cart holds; zero removes it. Throws InvalidArgumentException
+    // for a package a customer cannot buy (disabled, or priced in no list this storefront sells
+    // from), a fractional quantity of a package that is not sold loose, and a quantity past what the
+    // wire can carry. See checkQuantity for the full list. Whether a package is sold loose comes from
+    // the catalog's package, because the Package passed in may be older than the catalog. Returns
+    // this, so edits chain.
     setQuantity(item, quantity) {
         const wireQuantity = CartEditor.toWireQuantity(quantity);
         // Less than half a thousandth rounds to zero on the wire, a line that costs nothing, so it
@@ -102,8 +106,8 @@ class CartEditor {
         this._quantities.set(item.id, this.checkQuantity(item.id, quantity, wireQuantity));
         return this;
     }
-    // Adds to what the cart holds of this package, as a quantity stepper does. A negative amount
-    // takes away, down to zero at the lowest.
+    // Adds to the quantity of this package in the cart, as a quantity stepper does. A negative
+    // amount subtracts, to a minimum of zero.
     add(item, quantity = 1) {
         return this.setQuantity(item, Math.max(0, this.getQuantity(item) + quantity));
     }
@@ -114,8 +118,8 @@ class CartEditor {
         this._quantities.clear();
         return this;
     }
-    // What the packages come to, taxes included and offers taken off: the sum of the lines' final
-    // prices, which a customer sees as the price of the cart. Delivery is not in it.
+    // The sum of the lines' final prices: taxes included, offers taken off, delivery not included. A
+    // customer sees it as the price of the cart.
     get itemsTotal() {
         return ShoppingList.sumOfFinalPrices(this.lines.map((line) => line.item));
     }
@@ -170,27 +174,29 @@ class CartEditor {
         return remaining > 0n ? amountFromScaledValue(remaining) : 0;
     }
     // The tax inside deliveryCharge, from GeneralSettings.deliveryChargeTaxes. Those are the
-    // business's own, unrelated to a product's. Included in the charge, not added to it. Zero when
+    // business's own, unrelated to a product's, and are already included in the charge. Zero when
     // delivery is free.
     get deliveryTax() {
         return this.buildDeliveryChargeItem(this.getDeliveryCharge(this.itemsTotal), 0)?.totalTax ?? 0;
     }
-    // What the cart comes to, taxes included. Delivery is left out unless asked for: a cart page
-    // leaves it out and a checkout page puts it in, as in build(). It is the total of the list
-    // build() answers, and so of an order placed from it.
+    // What the cart comes to, taxes included. Delivery is included only when withDeliveryCharge is
+    // true: a cart page leaves it out and a checkout page includes it, as in build(). It is the total
+    // of the list build() returns, and so of an order placed from it.
     total(withDeliveryCharge = false) {
         return this.build(withDeliveryCharge).totalAmount;
     }
-    // The cart as a list, to write (Model.updateCartLocalOnly, Model.updateCart, Model.createOrder)
-    // and to SHOW: every price, total and tax a cart or checkout page displays can be read off it.
+    // The cart as a list, to write (Model.updateCartLocalOnly or Model.updateCart) and to SHOW: every
+    // price, total and tax a cart or checkout page displays can be read off it. Model.createOrder
+    // takes no list: it orders the cart as stored.
     // Each line stores its price without taxes and is flagged original, as Java ShoppingList.addItem
-    // does before a list is final. The list comes back not final: Model.createOrder makes it so.
+    // does before a list is final. The list is not final: Model.createOrder sends it final.
     //
     // withDeliveryCharge adds the delivery charge as a line (ReservedPackage.DELIVERY_CHARGE_PACKAGE)
-    // and sets ShoppingList.autoAddDeliveryCharge. A cart page leaves it out (the default), a checkout
-    // page that has settled on delivery asks for it. The line is added even when the charge is
-    // waived: at zero, with the regular charge (less its taxes) as its priceDiscount, so a bill can
-    // show FREE with the original struck through (Java ShoppingCartViewModel.setDeliveryCharge).
+    // and sets ShoppingList.autoAddDeliveryCharge. A cart page leaves it out (the default). A
+    // checkout page whose customer has chosen delivery passes true. The line is added even when the
+    // charge is waived: at zero, with the regular charge (less its taxes) as its priceDiscount, so a
+    // bill can show FREE with the original struck through (Java
+    // ShoppingCartViewModel.setDeliveryCharge).
     // An empty cart gets no line: a list holding only a delivery charge is not an order, and Java
     // removes that line when it is all that is left.
     build(withDeliveryCharge = false) {
@@ -203,8 +209,8 @@ class CartEditor {
         if (delivery !== null)
             items.push(delivery);
         // The total is the sum of the final prices of the lines sent, tax included, as ShoppingList.proto
-        // defines it. There is no list-wide discount: an offer comes off a line, and a storefront gives
-        // no other.
+        // defines it. There is no list-wide discount: an offer comes off a line, and a storefront
+        // applies no other.
         return new ShoppingList(false, delivery !== null, false, this._inventoryLocationId, this._catalog.priceList?.id ?? MERABILLS_ONLINE_PRICE_LIST_ID, ShoppingList.sumOfFinalPrices(items), 0, items.length, 0, Object.freeze(items), Object.freeze([]));
     }
     // The delivery charge as a line: one unit at what it costs now (charge: the regular charge, or
@@ -236,13 +242,14 @@ class CartEditor {
             return charge; // Never free, at any total
         return itemsTotal >= freeDeliveryTotal ? 0 : charge;
     }
-    // The package this id names, and null unless a customer could actually buy it right now
+    // The package with this id, or null unless a customer can buy it
     getBuyablePackage(packageId) {
         const item = this._catalog.getPackage(packageId);
         return item !== null && item.isBuyable ? item : null;
     }
-    // Keeps a line of a cart that was read, as setQuantity would, and says whether it could. A line
-    // that cannot be kept goes to unavailableItems, as it is not the caller's mistake.
+    // Keeps a line of a cart that was read, as setQuantity would, and returns whether it could. A
+    // line that cannot be kept goes to unavailableItems instead of throwing, because it is not a
+    // caller's error.
     tryKeep(item) {
         try {
             const wireQuantity = CartEditor.toWireQuantity(item.quantity);
@@ -258,18 +265,18 @@ class CartEditor {
         }
     }
     // A quantity travels as an int32 multiplied by Constants.QUANTITY_FACTOR (Java rounds to it with
-    // NumberHelper.floatToInt), so the least is a thousandth. This converts a quantity to that. What
-    // is kept is the quantity the wire holds, so getQuantity never reports one the order will not
-    // have.
+    // NumberHelper.floatToInt), so the smallest quantity is a thousandth. This converts a quantity
+    // to that. The editor stores the quantity the wire holds, so getQuantity reports the quantity the
+    // order will have.
     static toWireQuantity(quantity) {
         if (!Number.isFinite(quantity) || quantity < 0)
             throw new InvalidArgumentException(`${quantity} is not a quantity`);
         return Math.round(quantity * proto_Constants.QUANTITY_FACTOR);
     }
-    // The quantity to keep for this much of a package, as the wire holds it, or an
-    // InvalidArgumentException saying why the cart cannot have it: the catalog does not sell the
-    // package, it is not sold loose and the quantity is a fraction, the quantity or what it comes to
-    // is more than the protocol carries, or the cart is full. All of it is read off the catalog's
+    // Returns the quantity to store for this much of a package, as the wire holds it. Throws
+    // InvalidArgumentException when the cart cannot have it: the catalog does not sell the package,
+    // it is not sold loose and the quantity is a fraction, the quantity or its amount is more than
+    // the protocol carries, or the cart is full. Everything is checked against the catalog's
     // package, which the order is priced from.
     checkQuantity(packageId, quantity, wireQuantity) {
         const buyable = this.getBuyablePackage(packageId);
@@ -277,19 +284,19 @@ class CartEditor {
             throw new InvalidArgumentException(`Package ${Ids.toStorageHexString(packageId)} cannot be bought from this catalog`);
         if (!buyable.isSoldLoose && !Number.isInteger(quantity))
             throw new InvalidArgumentException(`${buyable.name} is not sold loose, so it cannot be bought ${quantity} at a time`);
-        // The most of one package a cart can hold. Refused here so it does not wrap silently on the wire
+        // The most of one package a cart can hold. Rejected here so it cannot overflow on the wire
         if (wireQuantity > CartEditor.MAX_WIRE_QUANTITY)
             throw new InvalidArgumentException(`${quantity} is more than the ${CartEditor.MAX_WIRE_QUANTITY / proto_Constants.QUANTITY_FACTOR} the protocol can carry`);
-        // A list holds at most Constants.SHOPPING_LIST_MAX_ITEMS items, and the delivery charge is one
-        // (Java ShoppingList.addItem counts it like any other, and a server refuses a list one line
-        // over). Where the business delivers, one place is kept for it: a cart filled to the limit
-        // could not be ordered for delivery.
+        // A list holds at most Constants.SHOPPING_LIST_MAX_ITEMS items, and the delivery charge counts
+        // as one (Java ShoppingList.addItem counts it like any other, and a server rejects a list one
+        // line over). Where the business delivers, one place is reserved for it: a cart filled to the
+        // limit could not be ordered for delivery.
         const maxLines = proto_Constants.SHOPPING_LIST_MAX_ITEMS - (this.isDeliveryOffered ? 1 : 0);
         if (!this._quantities.has(packageId) && this._quantities.size >= maxLines)
             throw new InvalidArgumentException(`A cart holds at most ${maxLines} lines`);
-        // Java refuses an amount past Transaction.MAX_AMOUNT (validateAmount) in the item that comes to
-        // it, and so does pricing an item here. It is priced before the line is kept, so the failure
-        // does not wait until a list is written.
+        // Java rejects an amount past Transaction.MAX_AMOUNT (validateAmount) in the item that reaches
+        // it, and so does pricing an item here. The line is priced before it is kept, so the error is
+        // raised here and not when a list is written.
         const stored = wireQuantity / proto_Constants.QUANTITY_FACTOR;
         try {
             validatePricing(new CartLine(buyable, this._catalog.getProduct(buyable.productId), stored).item);
@@ -310,7 +317,7 @@ export default CartEditor;
 // holds, rebuilt on every read of CartEditor.lines.
 //
 // Everything is read off item, the line as a shopping list would store it, so the cart page shows
-// what the order will and no price is worked out twice.
+// the same prices as the order and no price is computed twice.
 export class CartLine {
     constructor(_package, _product, _quantity) {
         this._package = _package;
@@ -321,7 +328,8 @@ export class CartLine {
     get package() {
         return this._package;
     }
-    // Null when the package's product is not in the catalog, which a buyable package never has
+    // Null when the package's product is not in the catalog. A buyable package always has its
+    // product there.
     get product() {
         return this._product;
     }
@@ -329,7 +337,7 @@ export class CartLine {
         return this._quantity;
     }
     // This line as a shopping list holds it: priced without taxes, with the taxes beside it. Show
-    // this to show the line as an order does. Its place in the list means nothing here.
+    // this to show the line as an order does. Its shoppingListOrder is always 0 and means nothing.
     get item() {
         this._item ?? (this._item = this.toShoppingListItem(0));
         return this._item;
@@ -340,8 +348,8 @@ export class CartLine {
         return includedTaxes(this._product?.taxes ?? []);
     }
     // What one unit costs, taxes included: the offer price where the package is on offer, else the
-    // regular price. This is the catalog's price to within tax rounding (a thousandth or two, which
-    // no one is shown). A buyable package always has a price, so nothing is guessed.
+    // regular price. This is the catalog's price to within tax rounding (a thousandth or two, too
+    // small to show). A buyable package always has a price, so no default price is used.
     get unitPrice() {
         return this.item.unitPriceWithTaxes;
     }
@@ -372,8 +380,8 @@ export class CartLine {
     get finalPrice() {
         return this.item.finalPrice;
     }
-    // This line as the protocol carries it. CartEditor.build calls it and assigns the order. Taxes
-    // come out of the price on the way (see buildItem).
+    // This line as the protocol carries it. CartEditor.build calls it with the line's position as
+    // shoppingListOrder. Taxes are taken out of the price here (see buildItem).
     toShoppingListItem(shoppingListOrder) {
         const price = this._package.price;
         return buildItem(this._package.id, this._quantity, price?.finalPrice ?? 0, price?.regularPrice ?? 0, this._product?.taxes ?? [], shoppingListOrder);
@@ -384,13 +392,13 @@ export class CartLine {
 function includedTaxes(taxes) {
     return Object.freeze(taxes.filter((tax) => Number.isFinite(tax.rate) && tax.rate > 0));
 }
-// Where a price with taxes in it becomes a shopping list item, and so where CartEditor takes a tax
-// out of a price, as Java ShoppingListItem.setDetailsFromTaxInclusivePrices does. The offer price
-// and the regular price each have their taxes removed, and the price discount is the difference of
-// those two, which is not the difference of the prices with taxes. The rest is as Java's
-// ProductSelectionCard leaves a new item: no discount of its own, no description (that is for
-// lines with no package), no stock keeping or expiry (a storefront is not told). It is flagged
-// original, as in build.
+// Builds a shopping list item from prices that include taxes, so this is where CartEditor takes a
+// tax out of a price, as Java ShoppingListItem.setDetailsFromTaxInclusivePrices does. The offer
+// price and the regular price each have their taxes removed, and the price discount is the
+// difference of those two, which is not the difference of the prices with taxes. The other fields
+// are as Java's ProductSelectionCard sets them on a new item: no discount besides the price
+// discount, no description (that is for lines with no package), no stock keeping or expiry (a
+// storefront is not sent them). The item is flagged original, as in build.
 // A price is a whole number of thousandths and each tax is rounded, so some prices cannot be
 // reached. The item then has the nearest price (TaxHelper.removeTaxes).
 function buildItem(packageId, quantity, offerPriceWithTaxes, regularPriceWithTaxes, taxes, shoppingListOrder) {

package/dist/Catalog.d.ts

@@ -1,13 +1,15 @@
 import Item from "./Item";
 import Package from "./Package";
+import Price from "./Price";
 import PriceList from "./PriceList";
 import Product from "./Product";
 import ProductCategory from "./ProductCategory";
 export default class Catalog {
-    private readonly _priceList;
-    constructor(categories: ReadonlyArray<ProductCategory>, products: ReadonlyArray<Product>, _priceList: PriceList | null);
+    constructor(categories: ReadonlyArray<ProductCategory>, products: ReadonlyArray<Product>, packages: ReadonlyArray<Package>, priceLists: ReadonlyArray<PriceList>, prices: ReadonlyArray<Price>);
     get categories(): ReadonlyArray<ProductCategory>;
     get products(): ReadonlyArray<Product>;
+    get currentSalePriceListId(): bigint;
+    private set currentSalePriceListId(value);
     get priceList(): PriceList | null;
     get productCount(): number;
     get packageCount(): number;
@@ -19,10 +21,20 @@ export default class Catalog {
     private static compareNames;
     private static compareIds;
     private static comparePrices;
+    private applySalePriceList;
     static readonly EMPTY: Catalog;
-    private readonly _categories;
-    private readonly _products;
-    private readonly _categoryMap;
-    private readonly _productMap;
-    private readonly _packageMap;
+    private readonly _allCategories;
+    private readonly _allProducts;
+    private readonly _uncategorized;
+    private readonly _candidatePackages;
+    private readonly _priceListMap;
+    private _currentSalePriceListId;
+    private _categories;
+    private _products;
+    private _categoryMap;
+    private _productMap;
+    private _packageMap;
+}
+export interface UpdatableCatalog {
+    set currentSalePriceListId(value: bigint);
 }