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

package/dist/generated/ShoppingListItem.d.ts

@@ -8,8 +8,21 @@ import { Tax } from "./Tax";
 /**
  * A line item in a shopping list: the package bought, how much, and at what price.
  * Excluded: batches.
- * Not included because it is derived: tax amounts, totalTax, finalPrice (= unitPrice x quantity +
- * taxes - discount).
+ *
+ * Every field here is exactly the member of the same name in the Java class ShoppingListItem, with the same meaning,
+ * and is converted to and from it by copying: nothing is calculated. In particular, the prices (unitPrice and
+ * priceDiscount) are the prices WITHOUT taxes. Taxes are calculated from them, as follows:
+ *   tax base    = unitPrice x quantity, rounded half up to a whole amount, where the quantity is
+ *                 (quantity / Constants.QUANTITY_FACTOR) worked out in 32 bit floating point (a float), and then widened to
+ *                 a double to multiply it by unitPrice. Java does Math.round((double) unitPrice * (double) (quantity / 1000f)),
+ *                 and that is to be matched exactly: dividing in double precision, or multiplying the integers first,
+ *                 differs at exact halves. A unitPrice of 5 and a quantity of 700 (0.7) has a tax base of 3 here, because
+ *                 0.7f is a little under 0.7, and of 4 in double precision
+ *   each tax    = tax base x the rate of the tax / Constants.TAX_RATE_FACTOR, rounded half up (each tax is rounded
+ *                 separately). Taxes only apply to a tax base that is greater than zero
+ *   finalPrice  = tax base + all the taxes - discount (not less than 0). Note that discount is taken off the price
+ *                 with taxes
+ * Not included because it is derived: tax amounts, totalTax, finalPrice.
  *
  * @generated from protobuf message com.merabills.storefront.ShoppingListItem
  */
@@ -28,14 +41,16 @@ export interface ShoppingListItem {
      */
     quantity: number;
     /**
-     * Price of one unit of the package, multiplied by Constants.AMOUNT_FACTOR.
+     * Price of one unit of the package, WITHOUT taxes (the taxes in taxes are calculated on top of it), multiplied by
+     * Constants.AMOUNT_FACTOR.
      * This is the offer price when the package is on offer.
      *
      * @generated from protobuf field: int64 unitPrice = 3
      */
     unitPrice: bigint;
     /**
-     * Position of this item in the shopping list (0 to Constants.SHOPPING_LIST_ITEM_MAX_ORDER)
+     * Position of this item in the shopping list (0 to Constants.SHOPPING_LIST_ITEM_MAX_ORDER). A message with one that is
+     * outside of that is refused (400), and not read as some other position.
      *
      * @generated from protobuf field: int32 shoppingListOrder = 4
      */
@@ -57,8 +72,8 @@ export interface ShoppingListItem {
      */
     isStockKeepingRequired: boolean;
     /**
-     * Discount in the unit price (regularPrice - offerPrice of the package), multiplied by
-     * Constants.AMOUNT_FACTOR
+     * Discount in the unit price (regularPrice - offerPrice of the package, both WITHOUT taxes), multiplied by
+     * Constants.AMOUNT_FACTOR. So, the regular price of one unit, without taxes, is unitPrice + priceDiscount.
      *
      * @generated from protobuf field: int64 priceDiscount = 8
      */

package/dist/generated/Tax.d.ts

@@ -4,7 +4,6 @@ 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 { TaxType } from "./TaxType";
 /**
  * A tax and the rate at which it applies. Replaces the parallel taxCodes / taxRates arrays in Java.
  *
@@ -12,11 +11,12 @@ import { TaxType } from "./TaxType";
  */
 export interface Tax {
     /**
-     * Exposed instead of the raw tax code
+     * The raw tax code: 0 to 127, and meaningful only within the country of the business the tax is on,
+     * which both ends already hold (Business.countryCode). A client names a tax by combining the two.
      *
-     * @generated from protobuf field: com.merabills.storefront.TaxType type = 1
+     * @generated from protobuf field: int32 taxCode = 1
      */
-    type: TaxType;
+    taxCode: number;
     /**
      * Tax rate, multiplied by Constants.TAX_RATE_FACTOR. 18% is stored as 1800.
      *

package/dist/generated/Tax.js

@@ -2,18 +2,17 @@ import { WireType } from "@protobuf-ts/runtime";
 import { UnknownFieldHandler } from "@protobuf-ts/runtime";
 import { reflectionMergePartial } from "@protobuf-ts/runtime";
 import { MessageType } from "@protobuf-ts/runtime";
-import { TaxType } from "./TaxType";
 // @generated message type with reflection information, may provide speed optimized methods
 class Tax$Type extends MessageType {
     constructor() {
         super("com.merabills.storefront.Tax", [
-            { no: 1, name: "type", kind: "enum", T: () => ["com.merabills.storefront.TaxType", TaxType] },
+            { no: 1, name: "taxCode", kind: "scalar", T: 5 /*ScalarType.INT32*/ },
             { no: 2, name: "rate", kind: "scalar", T: 5 /*ScalarType.INT32*/ }
         ]);
     }
     create(value) {
         const message = globalThis.Object.create((this.messagePrototype));
-        message.type = 0;
+        message.taxCode = 0;
         message.rate = 0;
         if (value !== undefined)
             reflectionMergePartial(this, message, value);
@@ -24,8 +23,8 @@ class Tax$Type extends MessageType {
         while (reader.pos < end) {
             let [fieldNo, wireType] = reader.tag();
             switch (fieldNo) {
-                case /* com.merabills.storefront.TaxType type */ 1:
-                    message.type = reader.int32();
+                case /* int32 taxCode */ 1:
+                    message.taxCode = reader.int32();
                     break;
                 case /* int32 rate */ 2:
                     message.rate = reader.int32();
@@ -42,9 +41,9 @@ class Tax$Type extends MessageType {
         return message;
     }
     internalBinaryWrite(message, writer, options) {
-        /* com.merabills.storefront.TaxType type = 1; */
-        if (message.type !== 0)
-            writer.tag(1, WireType.Varint).int32(message.type);
+        /* int32 taxCode = 1; */
+        if (message.taxCode !== 0)
+            writer.tag(1, WireType.Varint).int32(message.taxCode);
         /* int32 rate = 2; */
         if (message.rate !== 0)
             writer.tag(2, WireType.Varint).int32(message.rate);

package/dist/generated/WorkingDays.d.ts

@@ -20,12 +20,20 @@ export interface WorkingDays {
      * @generated from protobuf field: repeated bool days = 1
      */
     days: boolean[];
+    /**
+     * The IANA ID of the time zone the working hours are specified in, for example "Asia/Kolkata";
+     * never an abbreviation like "IST", which is ambiguous. At most 64 characters. Empty means it
+     * was never specified, as in settings saved before this field existed.
+     *
+     * @generated from protobuf field: string timeZone = 2
+     */
+    timeZone: string;
     /**
      * Working hours of each day, indexed as days above (entry 0 = Sunday); up to
      * Constants.DAYS_IN_WEEK entries, fewer is normal. A missing entry, or one with no ranges, means
      * work all day; only meaningful on a day whose days entry is true.
      *
-     * @generated from protobuf field: repeated com.merabills.storefront.WorkingHours workingHours = 2
+     * @generated from protobuf field: repeated com.merabills.storefront.WorkingHours workingHours = 3
      */
     workingHours: WorkingHours[];
 }

package/dist/generated/WorkingDays.js

@@ -8,12 +8,14 @@ class WorkingDays$Type extends MessageType {
     constructor() {
         super("com.merabills.storefront.WorkingDays", [
             { no: 1, name: "days", kind: "scalar", repeat: 1 /*RepeatType.PACKED*/, T: 8 /*ScalarType.BOOL*/ },
-            { no: 2, name: "workingHours", kind: "message", repeat: 2 /*RepeatType.UNPACKED*/, T: () => WorkingHours }
+            { no: 2, name: "timeZone", kind: "scalar", T: 9 /*ScalarType.STRING*/ },
+            { no: 3, name: "workingHours", kind: "message", repeat: 2 /*RepeatType.UNPACKED*/, T: () => WorkingHours }
         ]);
     }
     create(value) {
         const message = globalThis.Object.create((this.messagePrototype));
         message.days = [];
+        message.timeZone = "";
         message.workingHours = [];
         if (value !== undefined)
             reflectionMergePartial(this, message, value);
@@ -31,7 +33,10 @@ class WorkingDays$Type extends MessageType {
                     else
                         message.days.push(reader.bool());
                     break;
-                case /* repeated com.merabills.storefront.WorkingHours workingHours */ 2:
+                case /* string timeZone */ 2:
+                    message.timeZone = reader.string();
+                    break;
+                case /* repeated com.merabills.storefront.WorkingHours workingHours */ 3:
                     message.workingHours.push(WorkingHours.internalBinaryRead(reader, reader.uint32(), options));
                     break;
                 default:
@@ -53,9 +58,12 @@ class WorkingDays$Type extends MessageType {
                 writer.bool(message.days[i]);
             writer.join();
         }
-        /* repeated com.merabills.storefront.WorkingHours workingHours = 2; */
+        /* string timeZone = 2; */
+        if (message.timeZone !== "")
+            writer.tag(2, WireType.LengthDelimited).string(message.timeZone);
+        /* repeated com.merabills.storefront.WorkingHours workingHours = 3; */
         for (let i = 0; i < message.workingHours.length; i++)
-            WorkingHours.internalBinaryWrite(message.workingHours[i], writer.tag(2, WireType.LengthDelimited).fork(), options).join();
+            WorkingHours.internalBinaryWrite(message.workingHours[i], writer.tag(3, WireType.LengthDelimited).fork(), options).join();
         let u = options.writeUnknownFields;
         if (u !== false)
             (u == true ? UnknownFieldHandler.onWrite : u)(this.typeName, message, writer);

package/dist/generated/WorkingHoursRange.d.ts

@@ -5,8 +5,8 @@ import type { IBinaryReader } from "@protobuf-ts/runtime";
 import type { PartialMessage } from "@protobuf-ts/runtime";
 import { MessageType } from "@protobuf-ts/runtime";
 /**
- * A single stretch of working hours within a day, in minutes after local midnight (no time zone is
- * carried - resolve using the business address's time zone).
+ * A single stretch of working hours within a day, in minutes after local midnight (the time zone is
+ * not carried here - it is WorkingDays.timeZone).
  * A range never spans midnight; work past midnight is two ranges - one closing at
  * Constants.MINUTES_PER_DAY, one opening at 0 the next day.
  * Not included because it is derived: isAllDay, contains, overlaps.

package/dist/index.d.ts

@@ -37,8 +37,8 @@ export { default as LatLong } from "./LatLong";
 export { Dimensions, Weight } from "./Measures";
 export { default as PackageIdentifier } from "./PackageIdentifier";
 export { default as PaymentMethodDetail } from "./PaymentMethodDetail";
-export { default as ShoppingList, ShoppingListItem } from "./ShoppingList";
-export { default as Tax } from "./Tax";
+export { default as ShoppingList, ItemChange, ShoppingListItem } from "./ShoppingList";
+export { default as Tax, TaxAmount } from "./Tax";
 export { default as WorkingDays, WorkingHours, WorkingHoursRange } from "./WorkingDays";
 export * from "./Enums";
 export { Constants, MERABILLS_ONLINE_PRICE_LIST_ID, buildPriceListId } from "./Constants";

package/dist/index.js

@@ -1,6 +1,7 @@
 // The public surface of this library. Deliberately 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),
-// and the scaled-value conversions of Constants.ts (amounts, quantities and tax rates are already unscaled on every getter; ProtoMap is the only caller that needs to convert one).
+// the scaled-value conversions of Constants.ts (amounts, quantities and tax rates are already unscaled on every getter; ProtoMap is the only caller that needs to convert one),
+// and TaxHelper, the tax arithmetic, which works in those scaled values (a UI reads a tax off a ShoppingListItem, a ShoppingList or a CartLine, which have done it already).
 export { default as Model } from "./Model";
 export * as ContainerNames from "./ContainerNames";
 export { buildAuthTokensBytes } from "./ProtoMap";
@@ -40,8 +41,8 @@ export { default as LatLong } from "./LatLong";
 export { Dimensions, Weight } from "./Measures";
 export { default as PackageIdentifier } from "./PackageIdentifier";
 export { default as PaymentMethodDetail } from "./PaymentMethodDetail";
-export { default as ShoppingList, ShoppingListItem } from "./ShoppingList";
-export { default as Tax } from "./Tax";
+export { default as ShoppingList, ItemChange, ShoppingListItem } from "./ShoppingList";
+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 on the surface because a UI naming it on a cart it is building needs

package/package.json

@@ -1,55 +1,55 @@
-{
-  "name": "@peabody-soft/mbs-model-ts",
-  "version": "1.3.0",
-  "description": "MeraBills storefront client-side model (TypeScript)",
-  "author": "Peabody Soft",
-  "license": "AGPL-3.0-or-later",
-  "homepage": "https://merabills.com",
-  "keywords": [
-    "MeraBills",
-    "Peabody Soft",
-    "Model",
-    "Storefront",
-    "Mock",
-    "TypeScript"
-  ],
-  "publishConfig": {
-    "access": "public"
-  },
-  "main": "./dist/index.js",
-  "types": "./dist/index.d.ts",
-  "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "default": "./dist/index.js"
-    },
-    "./dist/*": {
-      "types": "./dist/*.d.ts",
-      "default": "./dist/*.js"
-    },
-    "./generated/*": {
-      "types": "./dist/generated/*.d.ts",
-      "default": "./dist/generated/*.js"
-    }
-  },
-  "files": [
-    "dist/**",
-    "!dist/**/*.map",
-    "!USAGE.md"
-  ],
-  "scripts": {
-    "generate": "node generate.mjs",
-    "clean": "node -e \"require('fs').rmSync('dist', { recursive: true, force: true })\"",
-    "build": "npm run generate && npm run clean && tsc",
-    "typecheck": "npm run generate && tsc --noEmit",
-    "prepack": "npm run build"
-  },
-  "devDependencies": {
-    "@protobuf-ts/plugin": "^2.11.1",
-    "typescript": "^7.0.2"
-  },
-  "dependencies": {
-    "@peabody-soft/mbs-protos": "^1.9.0",
-    "@protobuf-ts/runtime": "^2.11.1"
-  }
-}
+{
+  "name": "@peabody-soft/mbs-model-ts",
+  "version": "1.5.0",
+  "description": "MeraBills storefront client-side model (TypeScript)",
+  "author": "Peabody Soft",
+  "license": "AGPL-3.0-or-later",
+  "homepage": "https://merabills.com",
+  "keywords": [
+    "MeraBills",
+    "Peabody Soft",
+    "Model",
+    "Storefront",
+    "Mock",
+    "TypeScript"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./dist/*": {
+      "types": "./dist/*.d.ts",
+      "default": "./dist/*.js"
+    },
+    "./generated/*": {
+      "types": "./dist/generated/*.d.ts",
+      "default": "./dist/generated/*.js"
+    }
+  },
+  "files": [
+    "dist/**",
+    "!dist/**/*.map",
+    "!USAGE.md"
+  ],
+  "scripts": {
+    "generate": "node generate.mjs",
+    "clean": "node -e \"require('fs').rmSync('dist', { recursive: true, force: true })\"",
+    "build": "npm run generate && npm run clean && tsc",
+    "typecheck": "npm run generate && tsc --noEmit",
+    "prepack": "npm run build"
+  },
+  "devDependencies": {
+    "@protobuf-ts/plugin": "^2.11.1",
+    "typescript": "^7.0.2"
+  },
+  "dependencies": {
+    "@peabody-soft/mbs-protos": "^1.11.0",
+    "@protobuf-ts/runtime": "^2.11.1"
+  }
+}

package/dist/generated/TaxType.d.ts

@@ -1,25 +0,0 @@
-/**
- * A tax that applies to a product or to a line item. A raw Java tax code is only unique within a
- * country, so values here are not that raw code: they are computed ids, TaxType.createId(country,
- * taxCode) = (country.getNumeric() << 8) | taxCode, making each value globally unique and
- * self-describing rather than meaningful only together with some other, separately carried country
- * code. A client can recover the ISO 3166-1 numeric country code with (value >> 8); it cannot
- * recover the raw tax code beyond the low 8 bits, and does not need to - the enum name already
- * carries that meaning.
- *
- * @generated from protobuf enum com.merabills.storefront.TaxType
- */
-export declare enum TaxType {
-    /**
-     * No country's numeric code is ever 0, so this id can never collide with a real one
-     *
-     * @generated from protobuf enum value: UNSPECIFIED_TAX_TYPE = 0;
-     */
-    UNSPECIFIED_TAX_TYPE = 0,
-    /**
-     * India (countryCode 356): Goods and Services Tax (taxCode 0)
-     *
-     * @generated from protobuf enum value: GST = 91136;
-     */
-    GST = 91136
-}

package/dist/generated/TaxType.js

@@ -1,30 +0,0 @@
-// @ts-nocheck
-// @generated by protobuf-ts 2.11.1 with parameter long_type_bigint
-// @generated from protobuf file "TaxType.proto" (package "com.merabills.storefront", syntax proto3)
-// tslint:disable
-/**
- * A tax that applies to a product or to a line item. A raw Java tax code is only unique within a
- * country, so values here are not that raw code: they are computed ids, TaxType.createId(country,
- * taxCode) = (country.getNumeric() << 8) | taxCode, making each value globally unique and
- * self-describing rather than meaningful only together with some other, separately carried country
- * code. A client can recover the ISO 3166-1 numeric country code with (value >> 8); it cannot
- * recover the raw tax code beyond the low 8 bits, and does not need to - the enum name already
- * carries that meaning.
- *
- * @generated from protobuf enum com.merabills.storefront.TaxType
- */
-export var TaxType;
-(function (TaxType) {
-    /**
-     * No country's numeric code is ever 0, so this id can never collide with a real one
-     *
-     * @generated from protobuf enum value: UNSPECIFIED_TAX_TYPE = 0;
-     */
-    TaxType[TaxType["UNSPECIFIED_TAX_TYPE"] = 0] = "UNSPECIFIED_TAX_TYPE";
-    /**
-     * India (countryCode 356): Goods and Services Tax (taxCode 0)
-     *
-     * @generated from protobuf enum value: GST = 91136;
-     */
-    TaxType[TaxType["GST"] = 91136] = "GST";
-})(TaxType || (TaxType = {}));