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

package/dist/Catalog.js

@@ -1,51 +1,70 @@
 import { Constants as proto_Constants } from "./generated/Constants";
-import { EntityHeader } from "./Entity";
+import { DEFAULT_SALE_PRICE_LIST_ID } from "./Constants";
+import { EntityHeader, UpdatableEntity } from "./Entity";
 import ProductCategory from "./ProductCategory";
 // The catalog of a business: its categories and the products in them. Not an entity and not on the
-// wire. The sync layer rebuilds it from the flat item entities of a sync response.
+// wire. The sync layer builds it from the flat item entities of a sync response, as the merchant
+// app's Catalog is built.
+//
+// The constructor links what it is given: a package to its product, a price to its price list and a
+// price list to its parent. It does not depend on any price list being present. Packages are priced
+// from currentSalePriceListId, so setting that id decides which packages and products are buyable.
 class Catalog {
-    constructor(categories, products, _priceList) {
-        this._priceList = _priceList;
+    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._priceListMap = new Map();
+        this._currentSalePriceListId = DEFAULT_SALE_PRICE_LIST_ID;
+        // What a customer can reach, rebuilt by applySalePriceList
+        this._categories = Object.freeze([]);
+        this._products = Object.freeze([]);
         this._categoryMap = new Map();
         this._productMap = new Map();
         this._packageMap = new Map();
+        this._allCategories = categories;
+        this._allProducts = products;
         // A dummy category for products whose parentItemId is Constants.ENTITY_ID_NULL. Its id is also
         // ENTITY_ID_NULL, so getCategory(product.productCategoryId) resolves it like a real category.
-        // It is left out below like any other category when it has no products.
-        const uncategorized = new ProductCategory(new EntityHeader(BigInt(proto_Constants.ENTITY_ID_NULL), 0n, 0n, 0n, 0n), "", null, BigInt(proto_Constants.ENTITY_ID_NULL), false);
-        // 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. Enforced here so no builder can expose a product that cannot
-        // be bought.
-        const buyableProducts = [];
-        const productsByCategory = new Map();
-        for (const product of products) {
-            if (!product.isBuyable)
+        // It is left out like any other category when it has no buyable products.
+        this._uncategorized = new ProductCategory(new EntityHeader(BigInt(proto_Constants.ENTITY_ID_NULL), 0n, 0n, 0n, 0n), "", null, BigInt(proto_Constants.ENTITY_ID_NULL), false);
+        // A package with no product is dropped
+        const productsById = new Map();
+        for (const product of products)
+            productsById.set(product.id, product);
+        for (const pkg of packages) {
+            const product = productsById.get(pkg.productId);
+            if (product === undefined)
                 continue;
-            buyableProducts.push(product);
-            this._productMap.set(product.id, product);
-            const productsOfCategory = productsByCategory.get(product.productCategoryId);
-            if (productsOfCategory === undefined)
-                productsByCategory.set(product.productCategoryId, [product]);
+            UpdatableEntity.setParent(pkg, product);
+            const productPackages = this._candidatePackages.get(product.id);
+            if (productPackages === undefined)
+                this._candidatePackages.set(product.id, [pkg]);
             else
-                productsOfCategory.push(product);
-            for (const pkg of product.packages)
-                this._packageMap.set(pkg.id, pkg);
+                productPackages.push(pkg);
         }
-        this._products = Object.freeze(buyableProducts);
-        // A category that no buyable product reached is left out rather than shown empty. This covers
-        // the dummy too.
-        const nonEmptyCategories = [];
-        for (const category of [...categories, uncategorized]) {
-            const categoryProducts = productsByCategory.get(category.id);
-            if (categoryProducts === undefined)
+        // The first of two price lists with one id is kept. A price with no price list is dropped, and a
+        // list holds one price per package, the first to arrive.
+        for (const priceList of priceLists)
+            if (!this._priceListMap.has(priceList.id))
+                this._priceListMap.set(priceList.id, priceList);
+        const pricesByList = new Map();
+        for (const price of prices) {
+            if (!this._priceListMap.has(price.priceListId))
                 continue;
-            category.products = Object.freeze(categoryProducts);
-            nonEmptyCategories.push(category);
+            const listPrices = pricesByList.get(price.priceListId);
+            if (listPrices === undefined)
+                pricesByList.set(price.priceListId, new Map([[price.packageId, price]]));
+            else if (!listPrices.has(price.packageId))
+                listPrices.set(price.packageId, price);
         }
-        this._categories = Object.freeze(nonEmptyCategories);
-        for (const category of this._categories)
-            this._categoryMap.set(category.id, category);
+        // A parent that was not read, or a list that names itself, leaves the list without a parent
+        for (const priceList of this._priceListMap.values()) {
+            const updatable = priceList;
+            updatable.prices = pricesByList.get(priceList.id) ?? new Map();
+            const parent = this._priceListMap.get(priceList.parentPriceListId) ?? null;
+            updatable.parentPriceList = parent === priceList ? null : parent;
+        }
+        this.applySalePriceList();
     }
     // In no particular order - a UI orders these for display
     get categories() {
@@ -55,11 +74,22 @@ class Catalog {
     get products() {
         return this._products;
     }
-    // The one price list a storefront sells from (MeraBills Online). Null until it arrives. Every
-    // price in this catalog belongs to it, and prices in other lists are left out. A shopping list
-    // names this list, or falls back to its id when it has none set.
+    // The id of the price list packages are priced from, DEFAULT_SALE_PRICE_LIST_ID until the sync
+    // layer sets it. Setting it prices every package from that list, or from its parent where the list
+    // has no price, and keeps the packages, products and categories that can then be bought. An id
+    // that names no list prices nothing, so the catalog holds nothing.
+    get currentSalePriceListId() {
+        return this._currentSalePriceListId;
+    }
+    set currentSalePriceListId(value) {
+        this._currentSalePriceListId = value;
+        this.applySalePriceList();
+    }
+    // The price list packages are priced from (MeraBills Online for a storefront). Null when the
+    // catalog has no list with the current id, as before the catalog has arrived. A shopping list
+    // built from this catalog carries its id, or MERABILLS_ONLINE_PRICE_LIST_ID while it is null.
     get priceList() {
-        return this._priceList;
+        return this._priceListMap.get(this._currentSalePriceListId) ?? null;
     }
     get productCount() {
         return this._products.length;
@@ -75,7 +105,8 @@ class Catalog {
         return this._productMap.get(productId) ?? null;
     }
     // Null for the four reserved package ids a shopping list uses for its charge and summary lines
-    // (see Ids.isReservedPackageId), and for a package whose product was deleted or is not buyable
+    // (see Ids.isReservedPackageId), and for a package that is not buyable or whose product is not
+    // buyable
     getPackage(packageId) {
         return this._packageMap.get(packageId) ?? null;
     }
@@ -90,7 +121,7 @@ class Catalog {
             return byPrice;
         return Catalog.compareIds(left, right);
     }
-    // Display comparator for items generally: case insensitive, numeric, id-tiebroken
+    // Display comparator for items generally: case insensitive, numeric, ties broken by id
     static compareByName(left, right) {
         const byName = Catalog.compareNames(left.name, right.name);
         if (byName !== 0)
@@ -111,7 +142,56 @@ class Catalog {
             return -1;
         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.
+    applySalePriceList() {
+        const salePriceList = this.priceList;
+        const buyableProducts = [];
+        const productMap = new Map();
+        const packageMap = new Map();
+        const productsByCategory = new Map();
+        for (const product of this._allProducts) {
+            const candidates = this._candidatePackages.get(product.id) ?? [];
+            for (const pkg of candidates) {
+                const price = salePriceList === null ? null : salePriceList.getPrice(pkg.id);
+                pkg.price = price;
+                if (price !== null)
+                    UpdatableEntity.setParent(price, pkg);
+            }
+            // The product keeps only the buyable ones, and is judged by them
+            product.packages = candidates;
+            if (!product.isBuyable)
+                continue;
+            buyableProducts.push(product);
+            productMap.set(product.id, product);
+            const productsOfCategory = productsByCategory.get(product.productCategoryId);
+            if (productsOfCategory === undefined)
+                productsByCategory.set(product.productCategoryId, [product]);
+            else
+                productsOfCategory.push(product);
+            for (const pkg of product.packages)
+                packageMap.set(pkg.id, pkg);
+        }
+        const nonEmptyCategories = [];
+        const categoryMap = new Map();
+        for (const category of [...this._allCategories, this._uncategorized]) {
+            const categoryProducts = productsByCategory.get(category.id);
+            category.products = Object.freeze(categoryProducts ?? []);
+            if (categoryProducts === undefined)
+                continue;
+            nonEmptyCategories.push(category);
+            categoryMap.set(category.id, category);
+        }
+        this._products = Object.freeze(buyableProducts);
+        this._categories = Object.freeze(nonEmptyCategories);
+        this._productMap = productMap;
+        this._packageMap = packageMap;
+        this._categoryMap = categoryMap;
+    }
 }
 // A business whose catalog has not arrived yet
-Catalog.EMPTY = new Catalog(Object.freeze([]), Object.freeze([]), null);
+Catalog.EMPTY = new Catalog([], [], [], [], []);
 export default Catalog;

package/dist/Constants.d.ts

@@ -1,5 +1,6 @@
 export { Constants } from "./generated/Constants";
 export declare function buildPriceListId(priceList: number): bigint;
+export declare const DEFAULT_SALE_PRICE_LIST_ID: bigint;
 export declare const MERABILLS_ONLINE_PRICE_LIST_ID: bigint;
 export declare const MAX_SCALED_AMOUNT: bigint;
 export declare function amountFromScaledValue(scaledAmount: bigint): number;

package/dist/Constants.js

@@ -1,7 +1,7 @@
 import { Constants as proto_Constants } from "./generated/Constants";
 import Ids from "./Ids";
 // The protocol's limits and scaling factors, and the wire-to-UI value conversions.
-// Limits are re-exported so a Java constant has only one place to be wrong.
+// Limits are re-exported from the generated code so each Java constant is defined in one place.
 export { Constants } from "./generated/Constants";
 // The id of a built-in price list, from the low part Constants carries for it:
 // DEFAULT_SALE_PRICE_LIST, DEFAULT_PURCHASE_PRICE_LIST, MERABILLS_ONLINE_PRICE_LIST,
@@ -11,12 +11,14 @@ export { Constants } from "./generated/Constants";
 export function buildPriceListId(priceList) {
     return Ids.buildId(proto_Constants.PRICE_LIST_ENTITY_TYPE_ID, BigInt(priceList));
 }
-// The only price list this library reads. A business prices a package in several lists (over the
-// counter, on a marketplace), and only this one is the storefront's. Prices in other lists are
-// skipped, see ProtoMap.buildBusiness.
+// The list a catalog sells from until another is set, as in the merchant app's Catalog
+export const DEFAULT_SALE_PRICE_LIST_ID = buildPriceListId(proto_Constants.DEFAULT_SALE_PRICE_LIST);
+// The list a storefront sells from. A business prices a package in several lists (over the counter,
+// on a marketplace), and a response can carry any of its public ones. ProtoMap.buildBusiness sets
+// the catalog to sell from this one, and a package with no price in it is priced from its parent.
 export const MERABILLS_ONLINE_PRICE_LIST_ID = buildPriceListId(proto_Constants.MERABILLS_ONLINE_PRICE_LIST);
 // The largest amount the protocol can carry (Java Transaction.MAX_AMOUNT). Kept here because it does
-// not fit a protobuf enum value. Unscaled it is well below 2^53, so an amount is safe as a number.
+// not fit a protobuf enum value. It is 2^44 - 1, well below 2^53, so an amount is safe as a number.
 export const MAX_SCALED_AMOUNT = 17592186044415n;
 // An amount, price or discount travels multiplied by Constants.AMOUNT_FACTOR, bounded by
 // MAX_SCALED_AMOUNT, so it's safe as a number even though it arrives as an int64.

package/dist/ContainerNames.js

@@ -9,12 +9,12 @@ export function forBusiness(nameSuffix) {
 export function forProfile(nameSuffix) {
     return `${VERSION_PREFIX}${PROFILE_PREFIX}${nameSuffix}`;
 }
-// Every name carries the layout version of its contents, so a change in how a container is stored
-// needs no migration: the new version uses names nothing has written, and the old containers stay
-// inert until deleted. Bump it whenever a stored blob changes meaning, since callers cannot be
-// relied on to clear a store and a half-understood container is worse than no cache.
+// Every name carries the layout version of its contents, so changing how a container is stored
+// needs no migration. The new version uses names nothing has written, and the old containers stay
+// unused until deleted. Bump it whenever a stored blob changes meaning. Callers cannot be relied
+// on to clear a store, and a container read with the wrong meaning is worse than no cache.
 const VERSION_PREFIX = "V1.";
-// Neither id space is this library's to constrain, so without a prefix a subject id equal to a
-// business id would put a profile and a catalog in one container
+// This library does not control either id space. Without a prefix, a subject id equal to a
+// business id would put a profile and a catalog in one container.
 const BUSINESS_PREFIX = "b.";
 const PROFILE_PREFIX = "p.";

package/dist/Entity.js

@@ -35,8 +35,9 @@ class Entity {
     get updateType() {
         return Number(this._header.updateNumber & Entity.UPDATE_TYPE_MASK);
     }
-    // A deleted entity is a tombstone: it carries what the entity was when deleted. A UI never reaches
-    // one, except an order whose message is deleted, which is an order the business has completed.
+    // A deleted entity is a tombstone: it carries what the entity was when deleted. A UI is never
+    // given one, except an order whose message is deleted, which is an order the business has
+    // completed.
     get isDeleted() {
         return this.updateType === proto_Constants.UPDATE_TYPE_DELETED;
     }
@@ -52,7 +53,7 @@ class Entity {
 Entity.UPDATE_TYPE_MASK = BigInt(proto_Constants.UPDATE_TYPE_MASK);
 export default Entity;
 // The fields of the Entity message every entity carries. Passed as one value because they are all
-// bigint and could be transposed silently at a call site.
+// bigint, so swapping two at a call site would not be a type error.
 export class EntityHeader {
     constructor(id, createdAt, updatedAt, updateNumber, updateInfo) {
         this.id = id;

package/dist/Enums.d.ts

@@ -5,6 +5,7 @@ export { BusinessIdentifierType } from "./generated/BusinessIdentifierType";
 export { DimensionUnit } from "./generated/DimensionUnit";
 export { FulfillmentMode } from "./generated/FulfillmentMode";
 export { MessageType } from "./generated/MessageType";
+export { OnlineStoreTheme } from "./generated/OnlineStoreTheme";
 export { OrderStatus } from "./generated/OrderStatus";
 export { PackageIdentifierType } from "./generated/PackageIdentifierType";
 export { PaymentMethod } from "./generated/PaymentMethod";

package/dist/Enums.js

@@ -1,5 +1,5 @@
-// Every enum of the protocol, re-exported so their Java-defined numeric ids have only one place to
-// be wrong. The list also records which enums are part of the library's surface.
+// Every enum of the protocol, re-exported so each Java-defined numeric id is defined in one place.
+// The list also records which enums are part of the library's surface.
 // TaxType is the exception: the protocol does not carry it, so it is defined in TaxType.ts.
 export { AddressType } from "./generated/AddressType";
 export { AttachmentType } from "./generated/AttachmentType";
@@ -8,6 +8,7 @@ export { BusinessIdentifierType } from "./generated/BusinessIdentifierType";
 export { DimensionUnit } from "./generated/DimensionUnit";
 export { FulfillmentMode } from "./generated/FulfillmentMode";
 export { MessageType } from "./generated/MessageType";
+export { OnlineStoreTheme } from "./generated/OnlineStoreTheme";
 export { OrderStatus } from "./generated/OrderStatus";
 export { PackageIdentifierType } from "./generated/PackageIdentifierType";
 export { PaymentMethod } from "./generated/PaymentMethod";

package/dist/Exceptions.js

@@ -1,5 +1,5 @@
-// The two failures this library raises. Both are programming errors that a UI does not recover
-// from. A sync failure surfaces as a rejected promise.
+// The two programming errors this library throws. A UI does not recover from either. A sync
+// failure is a rejected promise (see ServiceExceptions.ts).
 // A caller passed something this library cannot work with
 export class InvalidArgumentException extends Error {
 }

package/dist/GeneralSettings.d.ts

@@ -1,4 +1,5 @@
 import { FulfillmentMode as proto_FulfillmentMode } from "./generated/FulfillmentMode";
+import { OnlineStoreTheme as proto_OnlineStoreTheme } from "./generated/OnlineStoreTheme";
 import { AddressList } from "./Address";
 import BusinessIdentifier from "./BusinessIdentifier";
 import LatLong from "./LatLong";
@@ -22,10 +23,10 @@ export default class GeneralSettings {
     private readonly _primaryStoreLocation;
     private readonly _googleBusinessCategoryId;
     private readonly _googleBusinessCategoryName;
-    private readonly _onlineStoreThemeId;
+    private readonly _onlineStoreTheme;
     private readonly _onlineShoppingEnabled;
-    static fromScaledValues(paymentMethodDetails: ReadonlyArray<PaymentMethodDetail>, customerServicePhone: string | null, isWhatsAppSupported: boolean, isSmsSupported: boolean, businessAddresses: AddressList, businessIdentifiers: ReadonlyArray<BusinessIdentifier>, fulfillmentModes: ReadonlyArray<proto_FulfillmentMode>, scaledDeliveryCharge: bigint, deliveryChargeTaxes: ReadonlyArray<Tax>, scaledFreeDeliveryTotal: bigint, deliveryRadiusKilometres: number, storeTagline: string | null, workingDays: WorkingDays, primaryStoreLocation: LatLong | null, googleBusinessCategoryId: string | null, googleBusinessCategoryName: string | null, onlineStoreThemeId: string | null, onlineShoppingEnabled: boolean): GeneralSettings;
-    constructor(_paymentMethodDetails: ReadonlyArray<PaymentMethodDetail>, _customerServicePhone: string | null, _isWhatsAppSupported: boolean, _isSmsSupported: boolean, _businessAddresses: AddressList, _businessIdentifiers: ReadonlyArray<BusinessIdentifier>, _fulfillmentModes: ReadonlyArray<proto_FulfillmentMode>, _deliveryCharge: number, _deliveryChargeTaxes: ReadonlyArray<Tax>, _freeDeliveryTotal: number, _deliveryRadiusKilometres: number, _storeTagline: string | null, _workingDays: WorkingDays, _primaryStoreLocation: LatLong | null, _googleBusinessCategoryId: string | null, _googleBusinessCategoryName: string | null, _onlineStoreThemeId: string | null, _onlineShoppingEnabled: boolean);
+    static fromScaledValues(paymentMethodDetails: ReadonlyArray<PaymentMethodDetail>, customerServicePhone: string | null, isWhatsAppSupported: boolean, isSmsSupported: boolean, businessAddresses: AddressList, businessIdentifiers: ReadonlyArray<BusinessIdentifier>, fulfillmentModes: ReadonlyArray<proto_FulfillmentMode>, scaledDeliveryCharge: bigint, deliveryChargeTaxes: ReadonlyArray<Tax>, scaledFreeDeliveryTotal: bigint, deliveryRadiusKilometres: number, storeTagline: string | null, workingDays: WorkingDays, primaryStoreLocation: LatLong | null, googleBusinessCategoryId: string | null, googleBusinessCategoryName: string | null, onlineStoreTheme: proto_OnlineStoreTheme | null, onlineShoppingEnabled: boolean): GeneralSettings;
+    constructor(_paymentMethodDetails: ReadonlyArray<PaymentMethodDetail>, _customerServicePhone: string | null, _isWhatsAppSupported: boolean, _isSmsSupported: boolean, _businessAddresses: AddressList, _businessIdentifiers: ReadonlyArray<BusinessIdentifier>, _fulfillmentModes: ReadonlyArray<proto_FulfillmentMode>, _deliveryCharge: number, _deliveryChargeTaxes: ReadonlyArray<Tax>, _freeDeliveryTotal: number, _deliveryRadiusKilometres: number, _storeTagline: string | null, _workingDays: WorkingDays, _primaryStoreLocation: LatLong | null, _googleBusinessCategoryId: string | null, _googleBusinessCategoryName: string | null, _onlineStoreTheme: proto_OnlineStoreTheme | null, _onlineShoppingEnabled: boolean);
     get paymentMethodDetails(): ReadonlyArray<PaymentMethodDetail>;
     get customerServicePhone(): string | null;
     get isWhatsAppSupported(): boolean;
@@ -42,7 +43,7 @@ export default class GeneralSettings {
     get primaryStoreLocation(): LatLong | null;
     get googleBusinessCategoryId(): string | null;
     get googleBusinessCategoryName(): string | null;
-    get onlineStoreThemeId(): string | null;
+    get onlineStoreTheme(): proto_OnlineStoreTheme | null;
     get onlineShoppingEnabled(): boolean;
     static readonly EMPTY: GeneralSettings;
 }

package/dist/GeneralSettings.js

@@ -7,10 +7,10 @@ import WorkingDays from "./WorkingDays";
 // merchant-only fields are absent.
 class GeneralSettings {
     // For ProtoMap, which sees amounts still multiplied by Constants.AMOUNT_FACTOR.
-    static fromScaledValues(paymentMethodDetails, customerServicePhone, isWhatsAppSupported, isSmsSupported, businessAddresses, businessIdentifiers, fulfillmentModes, scaledDeliveryCharge, deliveryChargeTaxes, scaledFreeDeliveryTotal, deliveryRadiusKilometres, storeTagline, workingDays, primaryStoreLocation, googleBusinessCategoryId, googleBusinessCategoryName, onlineStoreThemeId, onlineShoppingEnabled) {
-        return new GeneralSettings(paymentMethodDetails, customerServicePhone, isWhatsAppSupported, isSmsSupported, businessAddresses, businessIdentifiers, fulfillmentModes, amountFromScaledValue(scaledDeliveryCharge), deliveryChargeTaxes, amountFromScaledValue(scaledFreeDeliveryTotal), deliveryRadiusKilometres, storeTagline, workingDays, primaryStoreLocation, googleBusinessCategoryId, googleBusinessCategoryName, onlineStoreThemeId, onlineShoppingEnabled);
+    static fromScaledValues(paymentMethodDetails, customerServicePhone, isWhatsAppSupported, isSmsSupported, businessAddresses, businessIdentifiers, fulfillmentModes, scaledDeliveryCharge, deliveryChargeTaxes, scaledFreeDeliveryTotal, deliveryRadiusKilometres, storeTagline, workingDays, primaryStoreLocation, googleBusinessCategoryId, googleBusinessCategoryName, onlineStoreTheme, onlineShoppingEnabled) {
+        return new GeneralSettings(paymentMethodDetails, customerServicePhone, isWhatsAppSupported, isSmsSupported, businessAddresses, businessIdentifiers, fulfillmentModes, amountFromScaledValue(scaledDeliveryCharge), deliveryChargeTaxes, amountFromScaledValue(scaledFreeDeliveryTotal), deliveryRadiusKilometres, storeTagline, workingDays, primaryStoreLocation, googleBusinessCategoryId, googleBusinessCategoryName, onlineStoreTheme, onlineShoppingEnabled);
     }
-    constructor(_paymentMethodDetails, _customerServicePhone, _isWhatsAppSupported, _isSmsSupported, _businessAddresses, _businessIdentifiers, _fulfillmentModes, _deliveryCharge, _deliveryChargeTaxes, _freeDeliveryTotal, _deliveryRadiusKilometres, _storeTagline, _workingDays, _primaryStoreLocation, _googleBusinessCategoryId, _googleBusinessCategoryName, _onlineStoreThemeId, _onlineShoppingEnabled) {
+    constructor(_paymentMethodDetails, _customerServicePhone, _isWhatsAppSupported, _isSmsSupported, _businessAddresses, _businessIdentifiers, _fulfillmentModes, _deliveryCharge, _deliveryChargeTaxes, _freeDeliveryTotal, _deliveryRadiusKilometres, _storeTagline, _workingDays, _primaryStoreLocation, _googleBusinessCategoryId, _googleBusinessCategoryName, _onlineStoreTheme, _onlineShoppingEnabled) {
         this._paymentMethodDetails = _paymentMethodDetails;
         this._customerServicePhone = _customerServicePhone;
         this._isWhatsAppSupported = _isWhatsAppSupported;
@@ -27,7 +27,7 @@ class GeneralSettings {
         this._primaryStoreLocation = _primaryStoreLocation;
         this._googleBusinessCategoryId = _googleBusinessCategoryId;
         this._googleBusinessCategoryName = _googleBusinessCategoryName;
-        this._onlineStoreThemeId = _onlineStoreThemeId;
+        this._onlineStoreTheme = _onlineStoreTheme;
         this._onlineShoppingEnabled = _onlineShoppingEnabled;
     }
     get paymentMethodDetails() {
@@ -49,7 +49,8 @@ class GeneralSettings {
     get businessIdentifiers() {
         return this._businessIdentifiers;
     }
-    // The modes this business offers, as a list rather than Java's bit mask. Empty means none published, not none offered.
+    // The modes this business offers, as a list rather than Java's bit mask. An empty list means the
+    // business has published none, and CartEditor then offers no delivery.
     get fulfillmentModes() {
         return this._fulfillmentModes;
     }
@@ -92,16 +93,17 @@ class GeneralSettings {
     get googleBusinessCategoryName() {
         return this._googleBusinessCategoryName;
     }
-    // Which of the storefront's own themes this business picked. What an id means is up to the
-    // storefront, not this library. Null when none was picked.
-    get onlineStoreThemeId() {
-        return this._onlineStoreThemeId;
-    }
-    // Whether the business has turned online shopping on. The server does not refuse a business that
-    // has not. Model does, with a NotFoundException, after reading everything it is sent, when the
-    // settings it holds do not say so or it holds none (see Model.setBusinessId). Also false for
-    // GeneralSettings.EMPTY. It is the only thing about what a business sells that closes it: one with
-    // nothing a customer can buy is open, with an empty catalog.
+    // Which of the storefront's themes this business picked. Null when none was picked. A theme that a
+    // newer app added, which this version of the library has no entry for, is returned as it came: a
+    // number that is not a member of the enum. A caller that maps themes must have a fallback.
+    get onlineStoreTheme() {
+        return this._onlineStoreTheme;
+    }
+    // Whether the business has turned online shopping on. The server sends the business either way.
+    // Model throws a NotFoundException, after reading everything it was sent, when the settings it
+    // holds do not say shopping is on or it holds none (see Model.setBusinessId). Also false for
+    // GeneralSettings.EMPTY. A business with online shopping off is closed. A business with nothing
+    // to buy is open.
     get onlineShoppingEnabled() {
         return this._onlineShoppingEnabled;
     }

package/dist/HttpStatusCodes.js

@@ -1,15 +1,15 @@
 import { BadRequestException, ConflictException, InternalServerException, MethodNotAllowedException, NotFoundException, ServiceException, ServiceUnavailableException, UnauthorizedException, UpgradeRequiredException, } from "./ServiceExceptions";
-// Which failure a status code stands for. The classes are in ServiceExceptions.ts. The split matches
-// Java's HttpStatusCodes and exception package, so the table of what each code means has one home
-// in each client.
+// Maps a status code to its exception. The classes are in ServiceExceptions.ts. The split matches
+// Java's HttpStatusCodes and exception package, so each client has one table of what each code
+// means.
 // Everything from 300 up (Java's HttpURLConnection.HTTP_MULT_CHOICE). A redirect counts as a
-// failure because this client follows none, so being sent elsewhere means the call did not happen.
+// failure because this client follows none, so the call did not happen.
 export function isError(httpStatusCode) {
     return httpStatusCode >= LOWEST_ERROR_STATUS_CODE;
 }
-// Raises the failure a status code stands for, and does nothing for a code that is not an error.
-// A code with no class of its own becomes a ServiceException carrying the code, so a new server
-// response cannot pass as a success.
+// Throws the exception for a status code, and does nothing for a code that is not an error. A code
+// with no class throws a ServiceException carrying the code, so an unlisted error code cannot pass
+// as a success.
 export function throwOnError(httpStatusCode, message) {
     if (!isError(httpStatusCode))
         return;

package/dist/Ids.js

@@ -22,8 +22,7 @@ class Ids {
     }
     // A fresh id for an entity this client creates (Java Entity.getRandomLongForId): random, never
     // in 0-255, which every entity type reserves. Only the low part is drawn, as buildId masks the
-    // rest off. It uses the cryptographic generator because a Math.random id is guessable and a
-    // message id can be handed to a caller.
+    // rest off. It uses the cryptographic generator because a Math.random id is guessable.
     static getNewId(entityTypeId) {
         for (;;) {
             const bytes = new Uint8Array(8);
@@ -55,9 +54,9 @@ class Ids {
     static toOrderNumberString(orderId) {
         return (orderId & Ids.UNSIGNED_32_BIT_MASK).toString(16).toUpperCase();
     }
-    // Where a container keeps how far its reads of one entity type have got. The blob's eTag is the
-    // cursor the next read sends, and the blob holds nothing else. The store keeps the greater eTag,
-    // so a cursor never drops on a stale or repeated page or a write from another tab. Written in
+    // The blob in which a container keeps the sync cursor of one entity type. Its eTag is the cursor
+    // the next read sends, and the blob holds no other data. The store keeps the greater eTag, so a
+    // stale or repeated page, or a write from another tab, cannot lower the cursor. It is written in
     // the batch of the page that moved it, so it cannot get ahead of the entities it describes. key
     // is one of SyncKeys.
     static getSyncCursorBlobId(key) {

package/dist/Item.js

@@ -2,7 +2,8 @@ import Entity from "./Entity";
 // Something a business buys or sells, or a category or price of one. Mirrors the protocol's Item, embedded in each of the five real types.
 // parentItemId is the wire parent (a product's category). Entity.parent is the sync layer's containment parent (the business).
 export default class Item extends Entity {
-    // Public because ProductCategory and PriceList add nothing of their own. The class is still abstract.
+    // Public because ProductCategory and PriceList declare no constructor and inherit this one. The
+    // class is still abstract.
     constructor(header, _name, _description, _parentItemId, _isDisabled) {
         super(header);
         this._name = _name;
@@ -16,13 +17,15 @@ export default class Item extends Entity {
     get description() {
         return this._description;
     }
-    // Constants.ENTITY_ID_NULL when this item has no parent (e.g. an uncategorized product, or a price list).
+    // Constants.ENTITY_ID_NULL when this item has no parent (e.g. an uncategorized product, or a price
+    // list with no parent list).
     get parentItemId() {
         return this._parentItemId;
     }
-    // True when the business has disabled this item. Unlike isPublic and Product.isDraft, it can
-    // change after an item exists, so it is sent rather than filtered out. A product-level check does
-    // not guarantee that every package of an otherwise visible product is enabled.
+    // True when the business has disabled this item. The server filters out draft and non-public
+    // products, but this flag can change after an item exists, so a disabled item is sent flagged. A
+    // product-level check does not guarantee that every package of an otherwise visible product is
+    // enabled.
     get isDisabled() {
         return this._isDisabled;
     }

package/dist/LiveData.js

@@ -29,7 +29,7 @@ class LiveData {
     // Returns the function that stops this observer observing. Observing twice with the same function only observes once.
     observe(observer, notifyImmediately = false) {
         if (!this._observers.has(observer)) {
-            // NOT_NOTIFIED means the immediate notification below has something to deliver; otherwise a new observer only hears future changes (not sticky, unlike Android LiveData).
+            // NOT_NOTIFIED means the immediate notification below has something to deliver; otherwise a new observer receives only future changes (not sticky, unlike Android LiveData).
             this._observers.set(observer, notifyImmediately ? LiveData.NOT_NOTIFIED : this._version);
         }
         if (notifyImmediately)
@@ -54,7 +54,7 @@ class LiveData {
                     if (this._isNotificationStale)
                         break; // Start again with the newer value
                     if (this._observers.get(observer) === this._version)
-                        continue; // Already told
+                        continue; // Already notified
                     this._observers.set(observer, this._version);
                     observer(this._holder);
                 }

package/dist/Measures.js

@@ -1,5 +1,6 @@
-// How big a package is and how much it weighs, grouped since a UI showing one usually shows both. Neither is an entity; both are values on the Package row.
-// Units are the generated proto enums. A value displays in the unit the merchant entered it in, and nothing here converts between units.
+// How big a package is and how much it weighs, in one file since a UI showing one usually shows both.
+// Neither is an entity; both are values on Package.
+// Units are the generated proto enums. A value is shown in the unit the merchant entered it in, and nothing here converts between units.
 export class Dimensions {
     constructor(_unit, _length, _width, _height) {
         this._unit = _unit;

package/dist/Message.js

@@ -12,7 +12,7 @@ export default class Message extends Entity {
     }
     // The customer's party id at the business (BusinessLink.partyId), not the id of their User. A
     // business sync out sends a customer only messages from their own party. senderName and
-    // senderPhone say who it was without resolving the party.
+    // senderPhone identify the sender without resolving the party.
     get senderId() {
         return this._senderId;
     }

package/dist/MockDatabase.js

@@ -1,5 +1,6 @@
-// A Database that holds everything in a Map, for tests and training mode to run against with no
-// network. Enforces the eTag rule (write only if the new eTag is greater), so a test proves the sync is idempotent.
+// A Database that holds everything in a Map, for tests and training mode, which run with no
+// network. It enforces the eTag rule (a write applies only if its eTag is greater), so a test can
+// check that a sync is idempotent.
 export default class MockDatabase {
     constructor() {
         this._containers = new Map();
@@ -18,14 +19,14 @@ export default class MockDatabase {
     async deleteContainer(name) {
         this._containers.delete(name);
     }
-    // For a test that wants to look at what was stored without going through a sync
+    // Lets a test inspect what was stored without going through a sync
     getContainerIfPresent(name) {
         return this._containers.get(name) ?? null;
     }
 }
 export class MockContainer {
     constructor() {
-        // Set by a test just before the write it wants to fail
+        // A test sets this just before the write that should fail. That write clears it.
         this.failNextWrite = false;
         // How many times write has been called, so that a test can show a sync did not write per entity
         this.writeCount = 0;
@@ -56,7 +57,7 @@ export class MockContainer {
             this._blobs.delete(id);
         return appliedCount;
     }
-    // Greater eTag wins; a blob with no eTag (or overwriting one with none) is always written.
+    // The greater eTag wins. A write always applies when the incoming blob or the stored one has no eTag.
     static isNewer(incoming, stored) {
         if (stored === null)
             return true;