@naturalcycles/js-lib 14.98.1 → 14.99.0

package/dist-esm/datetime/localDate.js

@@ -87,16 +87,24 @@ export class LocalDate {
     }
     static earliest(items) {
         _assert(items.length, 'LocalDate.earliest called on empty array');
-        return items.reduce((min, item) => (min.isSameOrBefore(item) ? min : item));
+        return items
+            .map(i => LocalDate.of(i))
+            .reduce((min, item) => (min.isSameOrBefore(item) ? min : item));
     }
     static latestOrUndefined(items) {
         return items.length ? LocalDate.latest(items) : undefined;
     }
     static latest(items) {
         _assert(items.length, 'LocalDate.latest called on empty array');
-        return items.reduce((max, item) => (max.isSameOrAfter(item) ? max : item));
+        return items
+            .map(i => LocalDate.of(i))
+            .reduce((max, item) => (max.isSameOrAfter(item) ? max : item));
     }
     static range(min, max, incl = '[)', step = 1, stepUnit = 'day') {
+        if (stepUnit === 'week') {
+            step *= 7;
+            stepUnit = 'day';
+        }
         const dates = [];
         const $min = LocalDate.of(min);
         const $max = LocalDate.of(max).startOf(stepUnit);
@@ -206,7 +214,7 @@ export class LocalDate {
         if (unit === 'month') {
             return (this.$year - d.$year) * 12 + (this.$month - d.$month);
         }
-        // unit is 'day'
+        // unit is 'day' or 'week'
         let days = this.$day - d.$day;
         if (d.$year < this.$year) {
             for (let year = d.$year; year < this.$year; year++) {
@@ -228,10 +236,17 @@ export class LocalDate {
                 days -= LocalDate.getMonthLength(d.$year, month);
             }
         }
+        if (unit === 'week') {
+            return Math.floor(days / 7);
+        }
         return days;
     }
     add(num, unit, mutate = false) {
         let { $day, $month, $year } = this;
+        if (unit === 'week') {
+            num *= 7;
+            unit = 'day';
+        }
         if (unit === 'day') {
             $day += num;
         }
@@ -331,6 +346,12 @@ export class LocalDate {
     toISODate() {
         return this.toString();
     }
+    /**
+     * Returns e.g: `1984-06-21T17:56:21`
+     */
+    toISODateTime() {
+        return this.toString() + 'T00:00:00';
+    }
     toString() {
         return [
             String(this.$year).padStart(4, '0'),
@@ -355,6 +376,9 @@ export class LocalDate {
     toJSON() {
         return this.toString();
     }
+    format(fmt) {
+        return fmt(this);
+    }
 }
 /**
  * Shortcut wrapper around `LocalDate.parse` / `LocalDate.today`

package/dist-esm/datetime/localTime.js

@@ -1,6 +1,21 @@
 import { _assert } from '../error/assert';
 import { _ms } from '../time/time.util';
 import { LocalDate } from './localDate';
+export var ISODayOfWeek;
+(function (ISODayOfWeek) {
+    ISODayOfWeek[ISODayOfWeek["MONDAY"] = 1] = "MONDAY";
+    ISODayOfWeek[ISODayOfWeek["TUESDAY"] = 2] = "TUESDAY";
+    ISODayOfWeek[ISODayOfWeek["WEDNESDAY"] = 3] = "WEDNESDAY";
+    ISODayOfWeek[ISODayOfWeek["THURSDAY"] = 4] = "THURSDAY";
+    ISODayOfWeek[ISODayOfWeek["FRIDAY"] = 5] = "FRIDAY";
+    ISODayOfWeek[ISODayOfWeek["SATURDAY"] = 6] = "SATURDAY";
+    ISODayOfWeek[ISODayOfWeek["SUNDAY"] = 7] = "SUNDAY";
+})(ISODayOfWeek || (ISODayOfWeek = {}));
+const weekStartsOn = 1; // mon, as per ISO
+const MILLISECONDS_IN_WEEK = 604800000;
+// const MILLISECONDS_IN_DAY = 86400000
+// const MILLISECONDS_IN_MINUTE = 60000
+const VALID_DAYS_OF_WEEK = new Set([1, 2, 3, 4, 5, 6, 7]);
 /* eslint-disable no-dupe-class-members */
 /**
  * @experimental
@@ -104,6 +119,9 @@ export class LocalTime {
         if (unit === 'minute') {
             return this.utcMode ? this.$date.getUTCMinutes() : this.$date.getMinutes();
         }
+        if (unit === 'week') {
+            return getWeek(this.$date);
+        }
         // second
         return this.utcMode ? this.$date.getUTCSeconds() : this.$date.getSeconds();
     }
@@ -128,6 +146,9 @@ export class LocalTime {
         else if (unit === 'second') {
             this.utcMode ? t.$date.setUTCSeconds(v) : t.$date.setSeconds(v);
         }
+        else if (unit === 'week') {
+            setWeek(t.$date, v, true);
+        }
         /* eslint-enable @typescript-eslint/no-unused-expressions */
         return t;
     }
@@ -137,9 +158,21 @@ export class LocalTime {
     month(v) {
         return v === undefined ? this.get('month') : this.set('month', v);
     }
+    week(v) {
+        return v === undefined ? getWeek(this.$date) : this.set('week', v);
+    }
     day(v) {
         return v === undefined ? this.get('day') : this.set('day', v);
     }
+    dayOfWeek(v) {
+        const dow = (this.$date.getDay() || 7);
+        if (v === undefined) {
+            return dow;
+        }
+        if (!VALID_DAYS_OF_WEEK.has(v))
+            throw new Error(`Invalid dayOfWeek: ${v}`);
+        return this.add(v - dow, 'day');
+    }
     hour(v) {
         return v === undefined ? this.get('hour') : this.set('hour', v);
     }
@@ -174,6 +207,10 @@ export class LocalTime {
         return mutate ? this : new LocalTime(d, this.utcMode);
     }
     add(num, unit, mutate = false) {
+        if (unit === 'week') {
+            num *= 7;
+            unit = 'day';
+        }
         return this.set(unit, this.get(unit) + num, mutate);
     }
     subtract(num, unit, mutate = false) {
@@ -197,6 +234,9 @@ export class LocalTime {
         if (unit === 'day') {
             r = secDiff / (24 * 60 * 60);
         }
+        else if (unit === 'week') {
+            r = secDiff / (7 * 24 * 60 * 60);
+        }
         else if (unit === 'hour') {
             r = secDiff / (60 * 60);
         }
@@ -207,7 +247,7 @@ export class LocalTime {
             // unit === 'second'
             r = secDiff;
         }
-        r = r < 0 ? -Math.floor(-r) : Math.floor(r);
+        r = Math.trunc(r);
         if (Object.is(r, -0))
             return 0;
         return r;
@@ -216,16 +256,53 @@ export class LocalTime {
         if (unit === 'second')
             return this;
         const d = mutate ? this.$date : new Date(this.$date);
+        d.setSeconds(0, 0);
         /* eslint-disable @typescript-eslint/no-unused-expressions */
-        this.utcMode ? d.setUTCSeconds(0) : d.setSeconds(0);
         if (unit !== 'minute') {
             this.utcMode ? d.setUTCMinutes(0) : d.setMinutes(0);
             if (unit !== 'hour') {
                 this.utcMode ? d.setUTCHours(0) : d.setHours(0);
                 if (unit !== 'day') {
-                    this.utcMode ? d.setUTCDate(0) : d.setDate(0);
-                    if (unit !== 'month') {
+                    // year, month or week
+                    if (unit === 'year') {
                         this.utcMode ? d.setUTCMonth(0) : d.setMonth(0);
+                        this.utcMode ? d.setUTCDate(1) : d.setDate(1);
+                    }
+                    else if (unit === 'month') {
+                        this.utcMode ? d.setUTCDate(1) : d.setDate(1);
+                    }
+                    else {
+                        // week
+                        startOfWeek(d, true);
+                    }
+                }
+            }
+        }
+        /* eslint-enable @typescript-eslint/no-unused-expressions */
+        return mutate ? this : new LocalTime(d, this.utcMode);
+    }
+    endOf(unit, mutate = false) {
+        if (unit === 'second')
+            return this;
+        const d = mutate ? this.$date : new Date(this.$date);
+        d.setSeconds(59, 0);
+        /* eslint-disable @typescript-eslint/no-unused-expressions */
+        if (unit !== 'minute') {
+            this.utcMode ? d.setUTCMinutes(59) : d.setMinutes(59);
+            if (unit !== 'hour') {
+                this.utcMode ? d.setUTCHours(23) : d.setHours(23);
+                if (unit !== 'day') {
+                    // year, month or week
+                    if (unit === 'year') {
+                        this.utcMode ? d.setUTCMonth(11) : d.setMonth(11);
+                    }
+                    if (unit === 'week') {
+                        endOfWeek(d, true);
+                    }
+                    else {
+                        // year or month
+                        const lastDay = LocalDate.getMonthLength(d.getFullYear(), d.getMonth() + 1);
+                        this.utcMode ? d.setUTCDate(lastDay) : d.setDate(lastDay);
                     }
                 }
             }
@@ -248,14 +325,18 @@ export class LocalTime {
     }
     static earliest(items) {
         _assert(items.length, 'LocalTime.earliest called on empty array');
-        return items.reduce((min, item) => (min.isSameOrBefore(item) ? min : item));
+        return items
+            .map(i => LocalTime.of(i))
+            .reduce((min, item) => (min.isSameOrBefore(item) ? min : item));
     }
     static latestOrUndefined(items) {
         return items.length ? LocalTime.latest(items) : undefined;
     }
     static latest(items) {
         _assert(items.length, 'LocalTime.latest called on empty array');
-        return items.reduce((max, item) => (max.isSameOrAfter(item) ? max : item));
+        return items
+            .map(i => LocalTime.of(i))
+            .reduce((max, item) => (max.isSameOrAfter(item) ? max : item));
     }
     isSame(d) {
         return this.cmp(d) === 0;
@@ -295,7 +376,6 @@ export class LocalTime {
             return 0;
         return t1 < t2 ? -1 : 1;
     }
-    // todo: endOf
     components() {
         if (this.utcMode) {
             return {
@@ -368,7 +448,7 @@ export class LocalTime {
         //   .join(' ')
     }
     /**
-     * Returns e.g: `1984-06-21T17:56:21`, only the date part of DateTime
+     * Returns e.g: `1984-06-21T17:56:21`
      */
     toISODateTime() {
         return this.$date.toISOString().slice(0, 19);
@@ -420,6 +500,9 @@ export class LocalTime {
     toJSON() {
         return this.unix();
     }
+    format(fmt) {
+        return fmt(this);
+    }
 }
 /**
  * Shortcut wrapper around `LocalDate.parse` / `LocalDate.today`
@@ -427,3 +510,83 @@ export class LocalTime {
 export function localTime(d) {
     return d ? LocalTime.of(d) : LocalTime.now();
 }
+// based on: https://github.com/date-fns/date-fns/blob/master/src/getISOWeek/index.ts
+function getWeek(date) {
+    const diff = startOfWeek(date).getTime() - startOfWeekYear(date).getTime();
+    return Math.round(diff / MILLISECONDS_IN_WEEK) + 1;
+}
+function setWeek(date, week, mutate = false) {
+    const d = mutate ? date : new Date(date);
+    const diff = getWeek(d) - week;
+    d.setDate(d.getDate() - diff * 7);
+    return d;
+}
+// based on: https://github.com/date-fns/date-fns/blob/master/src/startOfISOWeekYear/index.ts
+function startOfWeekYear(date) {
+    const year = getWeekYear(date);
+    const fourthOfJanuary = new Date(0);
+    fourthOfJanuary.setFullYear(year, 0, 4);
+    fourthOfJanuary.setHours(0, 0, 0, 0);
+    return startOfWeek(fourthOfJanuary, true);
+}
+// based on: https://github.com/date-fns/date-fns/blob/fd6bb1a0bab143f2da068c05a9c562b9bee1357d/src/getISOWeekYear/index.ts
+function getWeekYear(date) {
+    const year = date.getFullYear();
+    const fourthOfJanuaryOfNextYear = new Date(0);
+    fourthOfJanuaryOfNextYear.setFullYear(year + 1, 0, 4);
+    fourthOfJanuaryOfNextYear.setHours(0, 0, 0, 0);
+    const startOfNextYear = startOfWeek(fourthOfJanuaryOfNextYear, true);
+    const fourthOfJanuaryOfThisYear = new Date(0);
+    fourthOfJanuaryOfThisYear.setFullYear(year, 0, 4);
+    fourthOfJanuaryOfThisYear.setHours(0, 0, 0, 0);
+    const startOfThisYear = startOfWeek(fourthOfJanuaryOfThisYear, true);
+    if (date.getTime() >= startOfNextYear.getTime()) {
+        return year + 1;
+    }
+    else if (date.getTime() >= startOfThisYear.getTime()) {
+        return year;
+    }
+    else {
+        return year - 1;
+    }
+}
+// function setWeekYear(
+//   date: Date,
+//   year: number,
+// ): Date {
+//   const diff = differenceInCalendarDays(date, startOfWeekYear(date))
+//   const fourthOfJanuary = new Date(0)
+//   fourthOfJanuary.setFullYear(year, 0, 4)
+//   fourthOfJanuary.setHours(0, 0, 0, 0)
+//   date = startOfWeekYear(fourthOfJanuary)
+//   date.setDate(date.getDate() + diff)
+//   return date
+// }
+// function differenceInCalendarDays(
+//   dateLeft: Date,
+//   dateRight: Date,
+// ): number {
+//   return Math.round((startOfDay(dateLeft).getTime() - startOfDay(dateRight).getTime()) / MILLISECONDS_IN_DAY)
+// }
+// function startOfDay(date: Date, mutate = false): Date {
+//   const d = mutate ? date : new Date(date)
+//   d.setHours(0, 0, 0, 0)
+//   return d
+// }
+// based on: https://github.com/date-fns/date-fns/blob/fd6bb1a0bab143f2da068c05a9c562b9bee1357d/src/startOfWeek/index.ts
+function startOfWeek(date, mutate = false) {
+    const d = mutate ? date : new Date(date);
+    const day = d.getDay();
+    const diff = (day < weekStartsOn ? 7 : 0) + day - weekStartsOn;
+    d.setDate(d.getDate() - diff);
+    d.setHours(0, 0, 0, 0);
+    return d;
+}
+// based on: https://github.com/date-fns/date-fns/blob/master/src/endOfWeek/index.ts
+function endOfWeek(date, mutate = false) {
+    const d = mutate ? date : new Date(date);
+    const day = d.getDay();
+    const diff = (day < weekStartsOn ? -7 : 0) + 6 - (day - weekStartsOn);
+    d.setDate(d.getDate() + diff);
+    return d;
+}

package/dist-esm/index.js

@@ -60,4 +60,5 @@ export * from './datetime/localDate';
 export * from './datetime/localTime';
 export * from './datetime/dateInterval';
 export * from './datetime/timeInterval';
+import { ISODayOfWeek, } from './datetime/localTime';
 export { is, _createPromiseDecorator, _stringMapValues, _stringMapEntries, _objectKeys, pMap, _passthroughMapper, _passUndefinedMapper, _passthroughPredicate, _passNothingPredicate, _noop, ErrorMode, pDefer, AggregatedError, pRetry, pRetryFn, pTimeout, pTimeoutFn, _tryCatch, _TryCatch, _stringifyAny, jsonSchema, JsonSchemaAnyBuilder, commonLoggerMinLevel, commonLoggerNoop, commonLogLevelNumber, commonLoggerPipe, commonLoggerPrefix, commonLoggerCreate, PQueue, END, SKIP, };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@naturalcycles/js-lib",
-  "version": "14.98.1",
+  "version": "14.99.0",
   "scripts": {
     "prepare": "husky install",
     "build-prod": "build-prod-esm-cjs",
@@ -16,7 +16,7 @@
     "@naturalcycles/nodejs-lib": "^12.33.4",
     "@naturalcycles/time-lib": "^3.5.1",
     "@types/node": "^17.0.4",
-    "jest": "^27.0.1",
+    "jest": "^28.0.3",
     "patch-package": "^6.2.1",
     "prettier": "^2.1.2",
     "rxjs": "^7.0.1",

package/src/array/array.util.ts

@@ -272,9 +272,38 @@ export function _shuffle<T>(array: T[], mutate = false): T[] {
   return a
 }
 
+/**
+ * Returns last item of non-empty array.
+ * Throws if array is empty.
+ */
+export function _last<T>(array: T[]): T {
+  if (!array.length) throw new Error('_last called on empty array')
+  return array[array.length - 1]!
+}
+
 /**
  * Returns last item of the array (or undefined if array is empty).
  */
-export function _last<T>(array: T[]): T | undefined {
+export function _lastOrUndefined<T>(array: T[]): T | undefined {
   return array[array.length - 1]
 }
+
+export function _minOrUndefined<T>(array: T[]): T | undefined {
+  if (!array.length) return
+  return _min(array)
+}
+
+export function _min<T>(array: T[]): T {
+  if (!array.length) throw new Error('_min called on empty array')
+  return array.reduce((min, item) => (min <= item ? min : item))
+}
+
+export function _maxOrUndefined<T>(array: T[]): T | undefined {
+  if (!array.length) return
+  return _max(array)
+}
+
+export function _max<T>(array: T[]): T {
+  if (!array.length) throw new Error('_max called on empty array')
+  return array.reduce((max, item) => (max >= item ? max : item))
+}

package/src/datetime/localDate.ts

@@ -1,14 +1,16 @@
 import { _assert } from '../error/assert'
-import { IsoDateString, UnixTimestampNumber } from '../types'
+import { IsoDateString, IsoDateTimeString, UnixTimestampNumber } from '../types'
 import { LocalTime } from './localTime'
 
-export type LocalDateUnit = 'year' | 'month' | 'day'
+export type LocalDateUnit = LocalDateUnitStrict | 'week'
+export type LocalDateUnitStrict = 'year' | 'month' | 'day'
 export type Inclusiveness = '()' | '[]' | '[)' | '(]'
 
 const MDAYS = [0, 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31]
 const DATE_REGEX = /^(\d\d\d\d)-(\d\d)-(\d\d)$/
 
 export type LocalDateConfig = LocalDate | IsoDateString
+export type LocalDateFormatter = (ld: LocalDate) => string
 
 /* eslint-disable no-dupe-class-members */
 
@@ -106,24 +108,28 @@ export class LocalDate {
     return (mutate ? items : [...items]).sort((a, b) => a.cmp(b) * mod)
   }
 
-  static earliestOrUndefined(items: LocalDate[]): LocalDate | undefined {
+  static earliestOrUndefined(items: LocalDateConfig[]): LocalDate | undefined {
     return items.length ? LocalDate.earliest(items) : undefined
   }
 
-  static earliest(items: LocalDate[]): LocalDate {
+  static earliest(items: LocalDateConfig[]): LocalDate {
     _assert(items.length, 'LocalDate.earliest called on empty array')
 
-    return items.reduce((min, item) => (min.isSameOrBefore(item) ? min : item))
+    return items
+      .map(i => LocalDate.of(i))
+      .reduce((min, item) => (min.isSameOrBefore(item) ? min : item))
   }
 
-  static latestOrUndefined(items: LocalDate[]): LocalDate | undefined {
+  static latestOrUndefined(items: LocalDateConfig[]): LocalDate | undefined {
     return items.length ? LocalDate.latest(items) : undefined
   }
 
-  static latest(items: LocalDate[]): LocalDate {
+  static latest(items: LocalDateConfig[]): LocalDate {
     _assert(items.length, 'LocalDate.latest called on empty array')
 
-    return items.reduce((max, item) => (max.isSameOrAfter(item) ? max : item))
+    return items
+      .map(i => LocalDate.of(i))
+      .reduce((max, item) => (max.isSameOrAfter(item) ? max : item))
   }
 
   static range(
@@ -133,6 +139,11 @@ export class LocalDate {
     step = 1,
     stepUnit: LocalDateUnit = 'day',
   ): LocalDate[] {
+    if (stepUnit === 'week') {
+      step *= 7
+      stepUnit = 'day'
+    }
+
     const dates: LocalDate[] = []
     const $min = LocalDate.of(min)
     const $max = LocalDate.of(max).startOf(stepUnit)
@@ -153,11 +164,11 @@ export class LocalDate {
     return dates
   }
 
-  get(unit: LocalDateUnit): number {
+  get(unit: LocalDateUnitStrict): number {
     return unit === 'year' ? this.$year : unit === 'month' ? this.$month : this.$day
   }
 
-  set(unit: LocalDateUnit, v: number, mutate = false): LocalDate {
+  set(unit: LocalDateUnitStrict, v: number, mutate = false): LocalDate {
     const t = mutate ? this : this.clone()
 
     if (unit === 'year') {
@@ -257,7 +268,7 @@ export class LocalDate {
       return (this.$year - d.$year) * 12 + (this.$month - d.$month)
     }
 
-    // unit is 'day'
+    // unit is 'day' or 'week'
     let days = this.$day - d.$day
 
     if (d.$year < this.$year) {
@@ -280,12 +291,21 @@ export class LocalDate {
       }
     }
 
+    if (unit === 'week') {
+      return Math.floor(days / 7)
+    }
+
     return days
   }
 
   add(num: number, unit: LocalDateUnit, mutate = false): LocalDate {
     let { $day, $month, $year } = this
 
+    if (unit === 'week') {
+      num *= 7
+      unit = 'day'
+    }
+
     if (unit === 'day') {
       $day += num
     } else if (unit === 'month') {
@@ -346,14 +366,14 @@ export class LocalDate {
     return this.add(-num, unit, mutate)
   }
 
-  startOf(unit: LocalDateUnit): LocalDate {
+  startOf(unit: LocalDateUnitStrict): LocalDate {
     if (unit === 'day') return this
     if (unit === 'month') return LocalDate.create(this.$year, this.$month, 1)
     // year
     return LocalDate.create(this.$year, 1, 1)
   }
 
-  endOf(unit: LocalDateUnit): LocalDate {
+  endOf(unit: LocalDateUnitStrict): LocalDate {
     if (unit === 'day') return this
     if (unit === 'month')
       return LocalDate.create(
@@ -400,6 +420,13 @@ export class LocalDate {
     return this.toString()
   }
 
+  /**
+   * Returns e.g: `1984-06-21T17:56:21`
+   */
+  toISODateTime(): IsoDateTimeString {
+    return this.toString() + 'T00:00:00'
+  }
+
   toString(): IsoDateString {
     return [
       String(this.$year).padStart(4, '0'),
@@ -428,6 +455,10 @@ export class LocalDate {
   toJSON(): IsoDateString {
     return this.toString()
   }
+
+  format(fmt: LocalDateFormatter): string {
+    return fmt(this)
+  }
 }
 
 /**