@xh/hoist 79.0.0-SNAPSHOT.1766259546947 → 79.0.0-SNAPSHOT.1766260837143

package/utils/datetime/LocalDate.ts

@@ -4,7 +4,7 @@
  *
  * Copyright © 2025 Extremely Heavy Industries Inc.
  */
-import {XH} from '@xh/hoist/core';
+import {LocalDateUnit, XH} from '@xh/hoist/core';
 import {computeOnce, throwIf} from '@xh/hoist/utils/js';
 import {isNil, isString} from 'lodash';
 import moment, {Moment, MomentInput} from 'moment';
@@ -18,16 +18,26 @@ import moment, {Moment, MomentInput} from 'moment';
  * For efficiency and to enable strict equality checks, instances of this class are memoized:
  * only a single version of the object will be created and returned for each calendar day,
  * as long as the caller uses one of the *public factory methods*, which they always should!
- *
- * Unit accepted by manipulation methods are ['year', 'quarter', 'month', 'week', 'day', 'date'].
  */
 export class LocalDate {
-    private static _instances = new Map();
-    static VALID_UNITS = ['year', 'quarter', 'month', 'week', 'day', 'date'];
-
-    private _isoString: string;
-    private _moment: Moment;
-    private _date: Date;
+    static readonly VALID_UNITS: Set<LocalDateUnit> = new Set([
+        'year',
+        'years',
+        'quarter',
+        'quarters',
+        'month',
+        'months',
+        'week',
+        'weeks',
+        'day',
+        'days'
+    ]);
+
+    private static _instances: Map<string, LocalDate> = new Map();
+
+    private readonly _isoString: string;
+    private readonly _moment: Moment;
+    private readonly _date: Date;
 
     //------------------------
     // Factories
@@ -187,17 +197,17 @@ export class LocalDate {
     //--------------------------
     // Manipulate/Calendar logic
     //--------------------------
-    add(value, unit = 'days'): LocalDate {
+    add(value: number, unit: LocalDateUnit = 'days'): LocalDate {
         this.ensureUnitValid(unit);
         return LocalDate.from(this.moment.add(value, unit));
     }
 
-    subtract(value, unit = 'days'): LocalDate {
+    subtract(value: number, unit: LocalDateUnit = 'days'): LocalDate {
         this.ensureUnitValid(unit);
         return LocalDate.from(this.moment.subtract(value, unit));
     }
 
-    addWeekdays(value): LocalDate {
+    addWeekdays(value: number): LocalDate {
         if (value < 0) {
             return this.subtractWeekdays(Math.abs(value));
         }
@@ -211,7 +221,7 @@ export class LocalDate {
         return ret;
     }
 
-    subtractWeekdays(value): LocalDate {
+    subtractWeekdays(value: number): LocalDate {
         if (value < 0) {
             return this.addWeekdays(Math.abs(value));
         }
@@ -225,7 +235,7 @@ export class LocalDate {
         return ret;
     }
 
-    startOf(unit): LocalDate {
+    startOf(unit: LocalDateUnit): LocalDate {
         this.ensureUnitValid(unit);
         return LocalDate.from(this.moment.startOf(unit));
     }
@@ -309,7 +319,7 @@ export class LocalDate {
         return this.isWeekday ? this : this.previousWeekday();
     }
 
-    diff(other: LocalDate, unit: moment.unitOfTime.Diff = 'days'): number {
+    diff(other: LocalDate, unit: LocalDateUnit = 'days'): number {
         this.ensureUnitValid(unit);
         return this._moment.diff(other._moment, unit);
     }
@@ -329,20 +339,12 @@ export class LocalDate {
         this._date = m.toDate();
     }
 
-    private ensureUnitValid(unit) {
-        // Units smaller than 'day'/'date' are irrelevant to LocalDate,
-        unit = moment.normalizeUnits(unit);
-        throwIf(
-            !LocalDate.VALID_UNITS.includes(unit),
-            `Invalid unit for LocalDate adjustment: ${unit}`
-        );
+    private ensureUnitValid(unit: LocalDateUnit) {
+        throwIf(!LocalDate.VALID_UNITS.has(unit), `Invalid unit for LocalDate adjustment: ${unit}`);
     }
 }
 
-/**
- * Is the input value a local Date?
- * Convenience alias for LocalDate.isLocalDate()
- */
+/** @returns true if the input value is a `LocalDate` instance. */
 export function isLocalDate(val: any): val is LocalDate {
     return !!val?.isLocalDate;
 }