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

package/dist/WorkingDays.js

@@ -1,9 +1,9 @@
 import { Constants as proto_Constants } from "./generated/Constants";
 import { InvalidArgumentException } from "./Exceptions";
 // Days and hours a business works. Absence is the permissive value throughout: no WorkingDays
-// means every day (ALL_DAYS); a day with no hours/ranges means worked all day.
-// The hours are minutes after local midnight in timeZone, so a caller asking about a moment reads
-// it in that zone first, as a day and a minute.
+// means every day (ALL_DAYS), and a day with no hours or ranges is worked all day.
+// Hours are minutes after local midnight in timeZone, so a caller asking about a moment reads it
+// in that zone first, as a day and a minute.
 class WorkingDays {
     constructor(_days, _timeZone, _workingHours) {
         this._days = _days;
@@ -15,15 +15,15 @@ class WorkingDays {
     get days() {
         return this._days;
     }
-    // The IANA ID of the zone the hours are in, for example "Asia/Kolkata" - never an abbreviation
-    // like "IST". Null when none was specified: settings saved before the protocol carried one, and
-    // ALL_DAYS. Then the hours cannot be placed on a clock, and only a caller that knows the
+    // The IANA ID of the zone the hours are in, for example "Asia/Kolkata", never an abbreviation
+    // like "IST". Null when none was specified (settings saved before the protocol carried one, and
+    // ALL_DAYS). The hours then cannot be placed on a clock, and only a caller that knows the
     // business's zone can read a moment into them.
     get timeZone() {
         return this._timeZone;
     }
-    // Indexed exactly as days above. Shorter than days, or empty, is normal: see the comment on
-    // this class for what a missing entry means.
+    // Indexed as days is. Shorter than days, or empty, is normal. See the class comment for what a
+    // missing entry means.
     get workingHours() {
         return this._workingHours;
     }
@@ -37,8 +37,8 @@ class WorkingDays {
         WorkingDays.checkDayOfWeek(dayOfWeek);
         return this._days[dayOfWeek] === true;
     }
-    // The hours of a day that is worked, or null when that day is worked all day long or is not
-    // worked at all. A UI showing opening times treats null as all day, having tested the day first.
+    // The hours of a worked day, or null when that day is worked all day or not at all. A UI showing
+    // opening times tests the day first, then treats null as all day.
     getWorkingHours(dayOfWeek) {
         WorkingDays.checkDayOfWeek(dayOfWeek);
         if (dayOfWeek >= this._workingHours.length)
@@ -58,13 +58,13 @@ class WorkingDays {
 // there is nothing for a zone to place, so it has none.
 WorkingDays.ALL_DAYS = new WorkingDays(Object.freeze([true, true, true, true, true, true, true]), null, Object.freeze([]));
 export default WorkingDays;
-// The hours of a single day that are worked, as the stretches of it that are.
+// The worked hours of a single day, as ranges.
 export class WorkingHours {
     constructor(_ranges) {
         this._ranges = _ranges;
     }
-    // Ordered by openMinute, never overlapping, and never touching: a range that closes exactly when
-    // the next opens arrives as one unbroken range.
+    // Ordered by openMinute, non-overlapping and non-touching: a range that closes when the next
+    // opens arrives as one unbroken range.
     get ranges() {
         return this._ranges;
     }
@@ -108,8 +108,8 @@ export class WorkingHoursRange {
     get openMinute() {
         return this._openMinute;
     }
-    // Not worked; MINUTES_PER_DAY means work stops at midnight. Always > openMinute - a range never
-    // spans midnight, so overnight work is two ranges on two days.
+    // Not worked; MINUTES_PER_DAY means work stops at midnight. Always greater than openMinute. A
+    // range never spans midnight, so overnight work is two ranges on two days.
     get closeMinute() {
         return this._closeMinute;
     }

package/dist/index.js

@@ -1,12 +1,12 @@
-// The public surface of this library. Deliberately excludes Attachment (UIs get Photo instead), the sync layer's internal cursors,
+// 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 (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).
+// 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).
 export { default as Model } from "./Model";
 export * as ContainerNames from "./ContainerNames";
 export { buildAuthTokensBytes } from "./ProtoMap";
-// The Service implementation that reaches a real server, and the routes it reaches it by. A caller
-// that is happy with plain https needs only the base url; one that is not implements Service itself.
+// The Service implementation that reaches a real server, and its routes. A caller using plain
+// https needs only the base url. Any other caller implements Service itself.
 export { default as ServiceProxy } from "./ServiceProxy";
 export { default as Routes } from "./Routes";
 // Observation
@@ -45,13 +45,13 @@ 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 on the surface because a UI naming it on a cart it is building needs
-// it, and Catalog.priceList is null until the catalog has arrived.
+// 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.
 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, and
+// 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.
 export { IllegalOperationException, InvalidArgumentException } from "./Exceptions";
 export { BadRequestException, ConflictException, InternalServerException, MethodNotAllowedException, NetworkConnectionException, NotFoundException, ServiceException, ServiceUnavailableException, UnauthorizedException, UpgradeRequiredException, } from "./ServiceExceptions";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@peabody-soft/mbs-model-ts",
-  "version": "1.5.0",
+  "version": "1.6.0",
   "description": "MeraBills storefront client-side model (TypeScript)",
   "author": "Peabody Soft",
   "license": "AGPL-3.0-or-later",