@peabody-soft/mbs-model-ts 1.4.0 → 1.5.0

package/dist/Enums.d.ts

@@ -12,5 +12,5 @@ export { ProductType } from "./generated/ProductType";
 export { ReservedPackage } from "./generated/ReservedPackage";
 export { Role } from "./generated/Role";
 export { TaskStatus } from "./generated/TaskStatus";
-export { TaxType } from "./generated/TaxType";
+export { TaxType } from "./TaxType";
 export { WeightUnit } from "./generated/WeightUnit";

package/dist/Enums.js

@@ -1,5 +1,6 @@
 // Every enum of the protocol, re-exported under its own name so their Java-defined numeric ids
 // have only one place to be wrong, and this file 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";
 export { AuthenticationMethod } from "./generated/AuthenticationMethod";
@@ -14,5 +15,5 @@ export { ProductType } from "./generated/ProductType";
 export { ReservedPackage } from "./generated/ReservedPackage";
 export { Role } from "./generated/Role";
 export { TaskStatus } from "./generated/TaskStatus";
-export { TaxType } from "./generated/TaxType";
+export { TaxType } from "./TaxType";
 export { WeightUnit } from "./generated/WeightUnit";

package/dist/GeneralSettings.d.ts

@@ -23,8 +23,9 @@ export default class GeneralSettings {
     private readonly _googleBusinessCategoryId;
     private readonly _googleBusinessCategoryName;
     private readonly _onlineStoreThemeId;
-    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): 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);
+    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);
     get paymentMethodDetails(): ReadonlyArray<PaymentMethodDetail>;
     get customerServicePhone(): string | null;
     get isWhatsAppSupported(): boolean;
@@ -42,5 +43,6 @@ export default class GeneralSettings {
     get googleBusinessCategoryId(): string | null;
     get googleBusinessCategoryName(): string | null;
     get onlineStoreThemeId(): string | null;
+    get onlineShoppingEnabled(): boolean;
     static readonly EMPTY: GeneralSettings;
 }

package/dist/GeneralSettings.js

@@ -7,10 +7,10 @@ import WorkingDays from "./WorkingDays";
 class GeneralSettings {
     // Only ProtoMap calls this: it is the one place that 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) {
-        return new GeneralSettings(paymentMethodDetails, customerServicePhone, isWhatsAppSupported, isSmsSupported, businessAddresses, businessIdentifiers, fulfillmentModes, amountFromScaledValue(scaledDeliveryCharge), deliveryChargeTaxes, amountFromScaledValue(scaledFreeDeliveryTotal), deliveryRadiusKilometres, storeTagline, workingDays, primaryStoreLocation, googleBusinessCategoryId, googleBusinessCategoryName, onlineStoreThemeId);
+    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);
     }
-    constructor(_paymentMethodDetails, _customerServicePhone, _isWhatsAppSupported, _isSmsSupported, _businessAddresses, _businessIdentifiers, _fulfillmentModes, _deliveryCharge, _deliveryChargeTaxes, _freeDeliveryTotal, _deliveryRadiusKilometres, _storeTagline, _workingDays, _primaryStoreLocation, _googleBusinessCategoryId, _googleBusinessCategoryName, _onlineStoreThemeId) {
+    constructor(_paymentMethodDetails, _customerServicePhone, _isWhatsAppSupported, _isSmsSupported, _businessAddresses, _businessIdentifiers, _fulfillmentModes, _deliveryCharge, _deliveryChargeTaxes, _freeDeliveryTotal, _deliveryRadiusKilometres, _storeTagline, _workingDays, _primaryStoreLocation, _googleBusinessCategoryId, _googleBusinessCategoryName, _onlineStoreThemeId, _onlineShoppingEnabled) {
         this._paymentMethodDetails = _paymentMethodDetails;
         this._customerServicePhone = _customerServicePhone;
         this._isWhatsAppSupported = _isWhatsAppSupported;
@@ -28,6 +28,7 @@ class GeneralSettings {
         this._googleBusinessCategoryId = _googleBusinessCategoryId;
         this._googleBusinessCategoryName = _googleBusinessCategoryName;
         this._onlineStoreThemeId = _onlineStoreThemeId;
+        this._onlineShoppingEnabled = _onlineShoppingEnabled;
     }
     get paymentMethodDetails() {
         return this._paymentMethodDetails;
@@ -52,15 +53,18 @@ class GeneralSettings {
     get fulfillmentModes() {
         return this._fulfillmentModes;
     }
+    // What delivery costs, INCLUDING the taxes in deliveryChargeTaxes, as the price of a package
+    // includes the taxes of its product. CartEditor takes them out when it puts the charge in a list.
     get deliveryCharge() {
         return this._deliveryCharge;
     }
-    // The taxes on the delivery charge, which are the business's own and not a product's - at most
-    // Constants.MAX_TAXES of them. Empty means the charge is untaxed.
+    // The taxes included in the delivery charge, which are the business's own and not a product's -
+    // at most Constants.MAX_TAXES of them. Empty means the charge includes no tax.
     get deliveryChargeTaxes() {
         return this._deliveryChargeTaxes;
     }
-    // Order total at or above which delivery is free. Zero means never free, not always free.
+    // Order total at or above which delivery is free, measured on the goods with their taxes in
+    // them and without the delivery charge. Zero means never free, not always free.
     get freeDeliveryTotal() {
         return this._freeDeliveryTotal;
     }
@@ -93,7 +97,14 @@ class GeneralSettings {
     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, once it has read everything it is sent and finds that the settings it then holds do not
+    // say so, or that it holds none - see Model.setBusinessId. Also false of a business that has made no settings, which
+    // is what GeneralSettings.EMPTY is.
+    get onlineShoppingEnabled() {
+        return this._onlineShoppingEnabled;
+    }
 }
 // A business with no published public settings, used instead of null so every field is already the protocol's empty value.
-GeneralSettings.EMPTY = new GeneralSettings(Object.freeze([]), null, false, false, AddressList.EMPTY, Object.freeze([]), Object.freeze([]), 0, Object.freeze([]), 0, 0, null, WorkingDays.ALL_DAYS, null, null, null, null);
+GeneralSettings.EMPTY = new GeneralSettings(Object.freeze([]), null, false, false, AddressList.EMPTY, Object.freeze([]), Object.freeze([]), 0, Object.freeze([]), 0, 0, null, WorkingDays.ALL_DAYS, null, null, null, null, false);
 export default GeneralSettings;

package/dist/Ids.d.ts

@@ -7,11 +7,13 @@ export default class Ids {
     static isReservedPackageId(packageId: bigint): boolean;
     static toStorageHexString(id: bigint): string;
     static toOrderNumberString(orderId: bigint): string;
+    static getSyncCursorBlobId(key: number): bigint;
     static readonly ENTITY_TYPE_BIT_SHIFT: bigint;
     static readonly ID_MASK: bigint;
     static readonly GENERAL_SETTINGS_CONFIGURATION_ID: bigint;
     static readonly ATTACHMENT_BASE_URL_BLOB_ID: bigint;
     static readonly AUTH_TOKENS_BLOB_ID: bigint;
+    private static readonly SYNC_CURSOR_BLOB_ID_BASE;
     private static readonly UNSIGNED_64_BIT_MASK;
     private static readonly UNSIGNED_32_BIT_MASK;
 }

package/dist/Ids.js

@@ -61,6 +61,14 @@ 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 cursor the next read
+    // sends for it, which is the eTag of the blob and the whole of it. The store keeps the greater of two
+    // eTags, so a cursor is never lowered, by a page that is stale or sent again or by another tab
+    // writing at the same time. Written in the batch of the page that moved it, so that it cannot get
+    // ahead of the entities it describes. key is one of SyncKeys: the table an entity type counts under.
+    static getSyncCursorBlobId(key) {
+        return Ids.SYNC_CURSOR_BLOB_ID_BASE - BigInt(key);
+    }
 }
 Ids.ENTITY_TYPE_BIT_SHIFT = BigInt(proto_Constants.ENTITY_TYPE_BIT_SHIFT);
 // Everything an id holds below its entity type; not in Constants.proto since 64 bits don't fit an enum value.
@@ -73,6 +81,8 @@ Ids.GENERAL_SETTINGS_CONFIGURATION_ID = 0x0d10000000000000n;
 Ids.ATTACHMENT_BASE_URL_BLOB_ID = -1n;
 // Where a container keeps the credentials that sign its calls - see AuthTokens. Written with a null eTag, since a reissued token is not a later version of an earlier one: the latest simply wins.
 Ids.AUTH_TOKENS_BLOB_ID = -2n;
+// The first of a block of fixed blob ids, one per key - see getSyncCursorBlobId. A key is an entity type id, which is below 0x80, so the block runs from -0x100 down to -0x17F and cannot meet the other fixed blobs at -1 and -2.
+Ids.SYNC_CURSOR_BLOB_ID_BASE = -0x100n;
 Ids.UNSIGNED_64_BIT_MASK = (1n << 64n) - 1n;
 Ids.UNSIGNED_32_BIT_MASK = (1n << 32n) - 1n;
 export default Ids;

package/dist/Message.js

@@ -10,8 +10,9 @@ export default class Message extends Entity {
         this._senderName = _senderName;
         this._senderPhone = _senderPhone;
     }
-    // The customer's User id; a business sync out doesn't carry it, so it's resolvable only against a profile sync out.
-    // senderName/senderPhone below are the fallback a UI shows meanwhile, and all an anonymous client ever has.
+    // The customer's party id at the business (BusinessLink.partyId), and not the id of their User. A business sync out
+    // sends a customer only the messages whose sender is their own party. senderName/senderPhone below say who it was
+    // without resolving the party.
     get senderId() {
         return this._senderId;
     }

package/dist/Model.d.ts

@@ -31,6 +31,8 @@ export default class Model {
     private businessSyncIn;
     private syncAnonymousBusiness;
     private syncBusinessContainer;
+    private readBusinessPages;
+    private static isBusinessNamed;
     private requireBusinessLink;
     private readJoinBusinessId;
     private static findBusinessEntity;
@@ -48,6 +50,8 @@ export default class Model {
     private buildProfileAuthTokens;
     private requireProfileAuthTokens;
     private publishBusiness;
+    private publish;
+    private static buildPublishable;
     private publishProfile;
     private static getService;
     private static getCache;
@@ -58,6 +62,7 @@ export default class Model {
     private _subjectId;
     private _authenticationToken;
     private _businessId;
+    private _isPublishedBusinessVetted;
     private readonly _business;
     private readonly _profile;
 }