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

package/dist/ProtoMap.js

@@ -1075,7 +1075,8 @@ function workingHoursFromProto(workingHours) {
 function workingDaysFromProto(workingDays) {
     if (workingDays === undefined)
         return WorkingDays.ALL_DAYS;
-    return new WorkingDays(Object.freeze([...workingDays.days]), Object.freeze(workingDays.workingHours.map(workingHoursFromProto)));
+    // Not an optional field, so an unspecified zone arrives as an empty string rather than absent
+    return new WorkingDays(Object.freeze([...workingDays.days]), workingDays.timeZone.length === 0 ? null : workingDays.timeZone, Object.freeze(workingDays.workingHours.map(workingHoursFromProto)));
 }
 function shoppingListItemFromProto(item) {
     return ShoppingListItem.fromScaledValues(item.packageId, item.quantity, item.unitPrice, item.shoppingListOrder, item.isOriginal, item.isModified, item.isStockKeepingRequired, item.priceDiscount, item.discount, Object.freeze(item.taxes.map(taxFromProto)), item.expiry, stringFromProto(item.description));

package/dist/WorkingDays.d.ts

@@ -1,14 +1,15 @@
 export default class WorkingDays {
     private readonly _days;
+    private readonly _timeZone;
     private readonly _workingHours;
-    constructor(_days: ReadonlyArray<boolean>, _workingHours: ReadonlyArray<WorkingHours>);
+    constructor(_days: ReadonlyArray<boolean>, _timeZone: string | null, _workingHours: ReadonlyArray<WorkingHours>);
     get days(): ReadonlyArray<boolean>;
+    get timeZone(): string | null;
     get workingHours(): ReadonlyArray<WorkingHours>;
     get includesAllDaysOfWeek(): boolean;
     isWorkingDay(dayOfWeek: number): boolean;
     getWorkingHours(dayOfWeek: number): WorkingHours | null;
     isOpenAllDay(dayOfWeek: number): boolean;
-    isOpenAt(dayOfWeek: number, minuteOfDay: number): boolean;
     private static checkDayOfWeek;
     static readonly ALL_DAYS: WorkingDays;
 }

package/dist/WorkingDays.js

@@ -2,11 +2,12 @@ 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.
-// No time zone here (the protocol carries none) - only a caller that knows the business's zone
-// can turn a moment into these day/minute values.
+// 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.
 class WorkingDays {
-    constructor(_days, _workingHours) {
+    constructor(_days, _timeZone, _workingHours) {
         this._days = _days;
+        this._timeZone = _timeZone;
         this._workingHours = _workingHours;
     }
     // Index 0 is Sunday and index 6 is Saturday, the same numbering as Date.getDay. Shorter than
@@ -14,6 +15,13 @@ 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
+    // 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.
     get workingHours() {
@@ -41,20 +49,14 @@ class WorkingDays {
     isOpenAllDay(dayOfWeek) {
         return this.isWorkingDay(dayOfWeek) && this.getWorkingHours(dayOfWeek) === null;
     }
-    // minuteOfDay is minutes after local midnight, from 0 to Constants.MINUTES_PER_DAY - 1
-    isOpenAt(dayOfWeek, minuteOfDay) {
-        if (!this.isWorkingDay(dayOfWeek))
-            return false;
-        const workingHours = this.getWorkingHours(dayOfWeek);
-        return workingHours === null || workingHours.contains(minuteOfDay);
-    }
     static checkDayOfWeek(dayOfWeek) {
         if (!Number.isInteger(dayOfWeek) || dayOfWeek < 0 || dayOfWeek >= proto_Constants.DAYS_IN_WEEK)
             throw new InvalidArgumentException(`Not a day of the week: ${dayOfWeek}`);
     }
 }
-// What an absent WorkingDays means: the business works every day, all day long
-WorkingDays.ALL_DAYS = new WorkingDays(Object.freeze([true, true, true, true, true, true, true]), Object.freeze([]));
+// What an absent WorkingDays means: the business works every day, all day long. With no hours
+// 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.
 export class WorkingHours {
@@ -73,6 +75,8 @@ export class WorkingHours {
     get isAllDay() {
         return (this._ranges.length === 0 || (this._ranges.length === 1 && this._ranges[0].isAllDay));
     }
+    // minuteOfDay is minutes after local midnight in the zone of the WorkingDays these hours belong
+    // to, from 0 to Constants.MINUTES_PER_DAY - 1
     contains(minuteOfDay) {
         if (this.isAllDay)
             return true;

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@peabody-soft/mbs-model-ts",
-  "version": "1.3.0",
+  "version": "1.4.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.9.0",
+    "@peabody-soft/mbs-protos": "^1.10.0",
     "@protobuf-ts/runtime": "^2.11.1"
   }
 }