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

package/dist/generated/GeneralSettings.d.ts

@@ -4,6 +4,7 @@ import type { BinaryReadOptions } from "@protobuf-ts/runtime";
 import type { IBinaryReader } from "@protobuf-ts/runtime";
 import type { PartialMessage } from "@protobuf-ts/runtime";
 import { MessageType } from "@protobuf-ts/runtime";
+import { OnlineStoreTheme } from "./OnlineStoreTheme";
 import { LatLong } from "./LatLong";
 import { WorkingDays } from "./WorkingDays";
 import { Tax } from "./Tax";
@@ -122,12 +123,12 @@ export interface GeneralSettings {
      */
     googleBusinessCategoryName?: string;
     /**
-     * Id of the visual theme applied to the online store
-     * (at most Constants.ONLINE_STORE_THEME_ID_MAX_LENGTH)
+     * Visual theme applied to the online store. UNSPECIFIED_ONLINE_STORE_THEME means no theme is set.
+     * A client must treat a number it has no entry for as no theme: a newer app may have added one.
      *
-     * @generated from protobuf field: optional string onlineStoreThemeId = 17
+     * @generated from protobuf field: com.merabills.storefront.OnlineStoreTheme onlineStoreTheme = 17
      */
-    onlineStoreThemeId?: string;
+    onlineStoreTheme: OnlineStoreTheme;
     /**
      * True if the business has turned online shopping on. The server does not refuse a business that has
      * not: it is for the client to, once it has read all it is sent (see BusinessSyncOutResponse). A

package/dist/generated/GeneralSettings.js

@@ -2,6 +2,7 @@ import { UnknownFieldHandler } from "@protobuf-ts/runtime";
 import { WireType } from "@protobuf-ts/runtime";
 import { reflectionMergePartial } from "@protobuf-ts/runtime";
 import { MessageType } from "@protobuf-ts/runtime";
+import { OnlineStoreTheme } from "./OnlineStoreTheme";
 import { LatLong } from "./LatLong";
 import { WorkingDays } from "./WorkingDays";
 import { Tax } from "./Tax";
@@ -29,7 +30,7 @@ class GeneralSettings$Type extends MessageType {
             { no: 14, name: "primaryStoreLocation", kind: "message", T: () => LatLong },
             { no: 15, name: "googleBusinessCategoryId", kind: "scalar", opt: true, T: 9 /*ScalarType.STRING*/ },
             { no: 16, name: "googleBusinessCategoryName", kind: "scalar", opt: true, T: 9 /*ScalarType.STRING*/ },
-            { no: 17, name: "onlineStoreThemeId", kind: "scalar", opt: true, T: 9 /*ScalarType.STRING*/ },
+            { no: 17, name: "onlineStoreTheme", kind: "enum", T: () => ["com.merabills.storefront.OnlineStoreTheme", OnlineStoreTheme] },
             { no: 18, name: "onlineShoppingEnabled", kind: "scalar", T: 8 /*ScalarType.BOOL*/ }
         ]);
     }
@@ -44,6 +45,7 @@ class GeneralSettings$Type extends MessageType {
         message.deliveryChargeTaxes = [];
         message.freeDeliveryTotal = 0n;
         message.deliveryRadiusKms = 0;
+        message.onlineStoreTheme = 0;
         message.onlineShoppingEnabled = false;
         if (value !== undefined)
             reflectionMergePartial(this, message, value);
@@ -106,8 +108,8 @@ class GeneralSettings$Type extends MessageType {
                 case /* optional string googleBusinessCategoryName */ 16:
                     message.googleBusinessCategoryName = reader.string();
                     break;
-                case /* optional string onlineStoreThemeId */ 17:
-                    message.onlineStoreThemeId = reader.string();
+                case /* com.merabills.storefront.OnlineStoreTheme onlineStoreTheme */ 17:
+                    message.onlineStoreTheme = reader.int32();
                     break;
                 case /* bool onlineShoppingEnabled */ 18:
                     message.onlineShoppingEnabled = reader.bool();
@@ -176,9 +178,9 @@ class GeneralSettings$Type extends MessageType {
         /* optional string googleBusinessCategoryName = 16; */
         if (message.googleBusinessCategoryName !== undefined)
             writer.tag(16, WireType.LengthDelimited).string(message.googleBusinessCategoryName);
-        /* optional string onlineStoreThemeId = 17; */
-        if (message.onlineStoreThemeId !== undefined)
-            writer.tag(17, WireType.LengthDelimited).string(message.onlineStoreThemeId);
+        /* com.merabills.storefront.OnlineStoreTheme onlineStoreTheme = 17; */
+        if (message.onlineStoreTheme !== 0)
+            writer.tag(17, WireType.Varint).int32(message.onlineStoreTheme);
         /* bool onlineShoppingEnabled = 18; */
         if (message.onlineShoppingEnabled !== false)
             writer.tag(18, WireType.Varint).bool(message.onlineShoppingEnabled);

package/dist/generated/Item.d.ts

@@ -17,9 +17,10 @@ export interface Item {
      */
     entity?: Entity;
     /**
-     * Id of the parent of this item - the category of a product, the product of a package, or the
-     * price list of a price - or 0 when it has none. A client rebuilds the catalog hierarchy by
-     * grouping items on this id, since nothing nests on the wire.
+     * Id of the parent of this item - the category of a product, the product of a package, the
+     * price list of a price, or the parent price list of a price list - or 0 when it has none. A
+     * client rebuilds the catalog hierarchy by grouping items on this id, since nothing nests on the
+     * wire.
      *
      * @generated from protobuf field: int64 parentItemId = 2
      */

package/dist/generated/Message.d.ts

@@ -13,6 +13,11 @@ import { Entity } from "./Entity";
  * A message sent to a business: an order (SalesOrderPayload) or a customer's shopping cart
  * (PartyPreferencesPayload), typed here rather than left as the serialized string Java stores.
  * MONEY_TRANSFER messages have no payload in this protocol.
+ * A message that has been deleted (see Entity.updateNumber) is converted as it is held, as every entity
+ * is, deleted or not, but for the items of the catalog. The merchant app completes an order, by fulfilling or cancelling it, by deleting
+ * its message, so, a deleted message that carries a sales order is an order that the business has
+ * completed, and is the whole of what a customer is shown of it afterwards. A deleted message is not
+ * a cart, whatever it carries.
  *
  * @generated from protobuf message com.merabills.storefront.Message
  */

package/dist/generated/OnlineStoreTheme.d.ts

@@ -0,0 +1,33 @@
+/**
+ * A visual theme of the online store. The palettes ship with the online store, so a business picks
+ * one of these and cannot mix colours. Values match the ids of the corresponding Java enum entries
+ * and must never be changed.
+ *
+ * @generated from protobuf enum com.merabills.storefront.OnlineStoreTheme
+ */
+export declare enum OnlineStoreTheme {
+    /**
+     * Java has no zero value: it treats a theme of zero as not set
+     *
+     * @generated from protobuf enum value: UNSPECIFIED_ONLINE_STORE_THEME = 0;
+     */
+    UNSPECIFIED_ONLINE_STORE_THEME = 0,
+    /**
+     * Deep forest brand, terracotta accent, warm paper
+     *
+     * @generated from protobuf enum value: FOREST = 1;
+     */
+    FOREST = 1,
+    /**
+     * Indigo brand, rust accent, cooler paper
+     *
+     * @generated from protobuf enum value: INDIGO = 2;
+     */
+    INDIGO = 2,
+    /**
+     * Brick brand, amber accent, the warmest paper
+     *
+     * @generated from protobuf enum value: BRICK = 3;
+     */
+    BRICK = 3
+}

package/dist/generated/OnlineStoreTheme.js

@@ -0,0 +1,38 @@
+// @ts-nocheck
+// @generated by protobuf-ts 2.11.1 with parameter long_type_bigint
+// @generated from protobuf file "OnlineStoreTheme.proto" (package "com.merabills.storefront", syntax proto3)
+// tslint:disable
+/**
+ * A visual theme of the online store. The palettes ship with the online store, so a business picks
+ * one of these and cannot mix colours. Values match the ids of the corresponding Java enum entries
+ * and must never be changed.
+ *
+ * @generated from protobuf enum com.merabills.storefront.OnlineStoreTheme
+ */
+export var OnlineStoreTheme;
+(function (OnlineStoreTheme) {
+    /**
+     * Java has no zero value: it treats a theme of zero as not set
+     *
+     * @generated from protobuf enum value: UNSPECIFIED_ONLINE_STORE_THEME = 0;
+     */
+    OnlineStoreTheme[OnlineStoreTheme["UNSPECIFIED_ONLINE_STORE_THEME"] = 0] = "UNSPECIFIED_ONLINE_STORE_THEME";
+    /**
+     * Deep forest brand, terracotta accent, warm paper
+     *
+     * @generated from protobuf enum value: FOREST = 1;
+     */
+    OnlineStoreTheme[OnlineStoreTheme["FOREST"] = 1] = "FOREST";
+    /**
+     * Indigo brand, rust accent, cooler paper
+     *
+     * @generated from protobuf enum value: INDIGO = 2;
+     */
+    OnlineStoreTheme[OnlineStoreTheme["INDIGO"] = 2] = "INDIGO";
+    /**
+     * Brick brand, amber accent, the warmest paper
+     *
+     * @generated from protobuf enum value: BRICK = 3;
+     */
+    OnlineStoreTheme[OnlineStoreTheme["BRICK"] = 3] = "BRICK";
+})(OnlineStoreTheme || (OnlineStoreTheme = {}));

package/dist/generated/PriceList.d.ts

@@ -6,8 +6,9 @@ import type { PartialMessage } from "@protobuf-ts/runtime";
 import { MessageType } from "@protobuf-ts/runtime";
 import { Item } from "./Item";
 /**
- * A named list of prices; has no parent, so its own Item.parentItemId is 0. Contains nothing - its
- * prices are the Price entities whose Item.parentItemId is this price list's id.
+ * A named list of prices. Item.parentItemId is the id of its parent price list, or 0 when it has
+ * none. A package that has no price in a list is priced from the parent list. Contains
+ * nothing - its prices are the Price entities whose Item.parentItemId is this price list's id.
  * Excluded: isPurchasePriceList - a purchase price list is never sent, so the flag would always be
  * false.
  *

package/dist/generated/ProfileSyncOutRequest.d.ts

@@ -34,21 +34,22 @@ export interface ProfileSyncOutRequest {
     /**
      * The business to join as a customer, if the caller is not already linked to it. 0 means none, and
      * anything else has to be the id of a business: one that is not is refused, not ignored.
-     * A call that carries a valid link token of this business is from a member of it already, and nothing is
-     * joined: the response is what the cursors above return, as for a call that joins nothing, and it is not
-     * refused for the business no longer allowing customers to join it. A link token that is not valid is
-     * refused (401), and one of another business says nothing of this one.
-     * Otherwise the response always carries the BusinessLink and the Business that a join returns, even
-     * where the cursors above would not return them.
-     * An invitation to this business for the caller (looked for by their phone number) takes precedence: it is
-     * accepted in the role and party that the invitation names, which may be those of a manager or an owner as
-     * well as of a customer, whether or not the business allows customers to join without an invitation, and
-     * the invitation is deleted. Only when there is none does the business decide.
-     * The call fails with 404 (NotFoundException) if there is no such business, or if the caller has no
-     * invitation to it and it does not allow customers to join it, and the caller does not hold a valid link
-     * token of it. It is the link token that is tested, and not membership: a member that does not hold one (on
-     * a new device, say) of a business that has since stopped allowing customers to join is refused in the same
-     * way, and then the whole call is a 404 - nothing of the profile is returned either, and not only no join.
+     * A member of the business is not joined again, and is not refused if the business no longer allows
+     * customers to join it. Nothing is changed for a member, so the response is what the cursors above
+     * return, as for a call that joins nothing.
+     * A call that does join makes a new BusinessLink. It is newer than the link cursor, so the response
+     * carries it, and the Business that it names whatever the business cursor is.
+     * An invitation to this business for the caller (looked for by their phone number) that names a party takes
+     * precedence: the newest one is accepted in the role and party that the invitation names, which may be those
+     * of a manager or an owner as well as of a customer, whether or not the business allows customers to join
+     * without an invitation, and the invitation is deleted. The call is refused if another member has that party.
+     * Only when there is no such invitation does the business decide.
+     * Without an invitation the caller joins as a customer: as the customer party of the business that has their
+     * phone number, if there is one, else as a new customer party. A caller that was a member before gets a new
+     * link and, unless a party has their phone number, a new party.
+     * The call fails with 404 (NotFoundException) if there is no such business, or if the caller is not a member,
+     * has no invitation to it, and it does not allow customers to join it. The whole call is then a 404:
+     * nothing of the profile is returned either.
      *
      * @generated from protobuf field: int64 joinBusinessId = 4
      */

package/dist/generated/ProfileSyncOutResponse.d.ts

@@ -11,9 +11,8 @@ import { AuthTokens } from "./AuthTokens";
 /**
  * The answer to a ProfileSyncOutRequest: who the caller is, the businesses they are linked to, and
  * those businesses. Nothing is nested - match BusinessLink.businessId against Business.entity.id.
- * Every field is absent/empty unless that type has changed, but for the caller's own user, which is
- * sent with every response; a tombstone (updateNumber's update-type bits =
- * Constants.UPDATE_TYPE_DELETED) means the entity, and what it owned, was deleted.
+ * Every field is absent/empty unless that type has changed. A tombstone (updateNumber's update-type
+ * bits = Constants.UPDATE_TYPE_DELETED) means the entity, and what it owned, was deleted.
  *
  * @generated from protobuf message com.merabills.storefront.ProfileSyncOutResponse
  */
@@ -26,9 +25,8 @@ export interface ProfileSyncOutResponse {
      */
     authTokens?: AuthTokens;
     /**
-     * The caller. Sent with every response, whatever userUpdateNumber is: a client keeps the copy it holds
-     * when it is as new as this one. The only user a response ever carries: nobody else's, such as the
-     * owner of a business, is sent to a customer.
+     * The caller, if the user has changed since userUpdateNumber. The only user a response ever carries:
+     * nobody else's, such as the owner of a business, is sent to a customer.
      *
      * @generated from protobuf field: com.merabills.storefront.User user = 2
      */

package/dist/generated/SalesOrderPayload.d.ts

@@ -27,19 +27,22 @@ export interface SalesOrderPayload {
      */
     fulfillmentMode: FulfillmentMode;
     /**
-     * What was ordered
+     * What was ordered. Absent for an order that an older version of the merchant app completed: that
+     * version moved the list out of the order, into the record of the sale, which a storefront is never
+     * sent. A client shows such an order with its total and count alone.
      *
      * @generated from protobuf field: com.merabills.storefront.ShoppingList shoppingList = 3
      */
     shoppingList?: ShoppingList;
     /**
-     * Total of the shopping list, multiplied by Constants.AMOUNT_FACTOR
+     * Total of the shopping list, multiplied by Constants.AMOUNT_FACTOR. Sent whether or not the list is
+     * (see above), so, it is all there is of what an order of that kind came to.
      *
      * @generated from protobuf field: int64 shoppingListTotal = 4
      */
     shoppingListTotal: bigint;
     /**
-     * Number of items in the shopping list
+     * Number of items in the shopping list. Sent whether or not the list is, as the total is.
      *
      * @generated from protobuf field: int32 shoppingListCount = 5
      */

package/dist/index.d.ts

@@ -14,13 +14,17 @@ export { default as Business } from "./Business";
 export type { UpdatableBusiness } from "./Business";
 export { default as CartEditor, CartLine } from "./CartEditor";
 export { default as Catalog } from "./Catalog";
+export type { UpdatableCatalog } from "./Catalog";
 export { default as GeneralSettings } from "./GeneralSettings";
 export { default as Order } from "./Order";
 export { default as Package } from "./Package";
+export type { UpdatablePackage } from "./Package";
 export { default as Photo } from "./Photo";
 export { default as Price } from "./Price";
 export { default as PriceList } from "./PriceList";
+export type { UpdatablePriceList } from "./PriceList";
 export { default as Product } from "./Product";
+export type { UpdatableProduct } from "./Product";
 export { default as ProductCategory } from "./ProductCategory";
 export type { UpdatableProductCategory } from "./ProductCategory";
 export { default as Profile } from "./Profile";

package/dist/index.js

@@ -1,7 +1,10 @@
-// The public surface of this library. Excludes Attachment (UIs get Photo instead), the sync layer's internal cursors,
-// the auth tokens (except BusinessLink.linkToken, which the protocol hands to a client), ProtoMap (the wire boundary, except buildAuthTokensBytes),
-// the scaled-value conversions of Constants.ts (every getter is already unscaled),
-// and TaxHelper (tax arithmetic in scaled values; a UI reads a tax off a ShoppingListItem, ShoppingList or CartLine).
+// The public surface of this library. Not exported:
+// - Attachment (a UI gets Photo instead) and the sync layer's internal cursors.
+// - The auth tokens, except BusinessLink.linkToken, which the server sends to a client.
+// - ProtoMap, the wire boundary, except buildAuthTokensBytes.
+// - The scaled-value conversions of Constants.ts (every getter is already unscaled).
+// - TaxHelper, which does tax arithmetic in scaled values. A UI reads a tax off a ShoppingListItem,
+//   ShoppingList or CartLine.
 export { default as Model } from "./Model";
 export * as ContainerNames from "./ContainerNames";
 export { buildAuthTokensBytes } from "./ProtoMap";
@@ -45,14 +48,14 @@ export { default as ShoppingList, ItemChange, ShoppingListItem } from "./Shoppin
 export { default as Tax, TaxAmount } from "./Tax";
 export { default as WorkingDays, WorkingHours, WorkingHoursRange } from "./WorkingDays";
 // The enums of the protocol, the limits it obeys, and how an id is read. The price list a
-// storefront sells from is exported because a UI naming it on a cart it is building needs it,
-// while Catalog.priceList is null until the catalog has arrived.
+// storefront sells from is exported because a UI that builds a cart must name it. Catalog.priceList
+// is null until the catalog has arrived, and when the response did not carry that list.
 export * from "./Enums";
 export { Constants, MERABILLS_ONLINE_PRICE_LIST_ID, buildPriceListId } from "./Constants";
 export { default as Ids } from "./Ids";
 // Failures. The two in Exceptions.ts are programming errors. The rest are what a call fails with
-// and are meant to be caught: ServiceException for anything the server refused,
-// NetworkConnectionException for a call that never got an answer.
+// and are meant to be caught: ServiceException for an error response from the server,
+// NetworkConnectionException for a call that got no response.
 export { IllegalOperationException, InvalidArgumentException } from "./Exceptions";
 export { BadRequestException, ConflictException, InternalServerException, MethodNotAllowedException, NetworkConnectionException, NotFoundException, ServiceException, ServiceUnavailableException, UnauthorizedException, UpgradeRequiredException, } from "./ServiceExceptions";
 // The mock database: a Database over a Map, so a caller can pair it with any Service. MockService

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@peabody-soft/mbs-model-ts",
-  "version": "1.7.0",
+  "version": "1.8.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.11.0",
+    "@peabody-soft/mbs-protos": "^1.12.1",
     "@protobuf-ts/runtime": "^2.11.1"
   }
 }