@naturalcycles/js-lib 14.98.3 → 14.99.2

package/dist/array/array.util.d.ts

@@ -137,7 +137,16 @@ export declare function _mapToObject<T, V>(array: T[], mapper: (item: T) => [key
  * Based on: https://stackoverflow.com/a/12646864/4919972
  */
 export declare function _shuffle<T>(array: T[], mutate?: boolean): T[];
+/**
+ * Returns last item of non-empty array.
+ * Throws if array is empty.
+ */
+export declare function _last<T>(array: T[]): T;
 /**
  * Returns last item of the array (or undefined if array is empty).
  */
-export declare function _last<T>(array: T[]): T | undefined;
+export declare function _lastOrUndefined<T>(array: T[]): T | undefined;
+export declare function _minOrUndefined<T>(array: T[]): T | undefined;
+export declare function _min<T>(array: T[]): T;
+export declare function _maxOrUndefined<T>(array: T[]): T | undefined;
+export declare function _max<T>(array: T[]): T;

package/dist/array/array.util.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports._last = exports._shuffle = exports._mapToObject = exports._sumBy = exports._sum = exports._difference = exports._intersection = exports._countBy = exports._dropRightWhile = exports._dropWhile = exports._takeRightWhile = exports._takeWhile = exports._findLast = exports._sortBy = exports._groupBy = exports._by = exports._uniqBy = exports._uniq = exports._flattenDeep = exports._flatten = exports._chunk = void 0;
+exports._max = exports._maxOrUndefined = exports._min = exports._minOrUndefined = exports._lastOrUndefined = exports._last = exports._shuffle = exports._mapToObject = exports._sumBy = exports._sum = exports._difference = exports._intersection = exports._countBy = exports._dropRightWhile = exports._dropWhile = exports._takeRightWhile = exports._takeWhile = exports._findLast = exports._sortBy = exports._groupBy = exports._by = exports._uniqBy = exports._uniq = exports._flattenDeep = exports._flatten = exports._chunk = void 0;
 /**
  * Creates an array of elements split into groups the length of size. If collection can’t be split evenly, the
  * final chunk will be the remaining elements.
@@ -260,9 +260,43 @@ function _shuffle(array, mutate = false) {
 }
 exports._shuffle = _shuffle;
 /**
- * Returns last item of the array (or undefined if array is empty).
+ * Returns last item of non-empty array.
+ * Throws if array is empty.
  */
 function _last(array) {
+    if (!array.length)
+        throw new Error('_last called on empty array');
     return array[array.length - 1];
 }
 exports._last = _last;
+/**
+ * Returns last item of the array (or undefined if array is empty).
+ */
+function _lastOrUndefined(array) {
+    return array[array.length - 1];
+}
+exports._lastOrUndefined = _lastOrUndefined;
+function _minOrUndefined(array) {
+    if (!array.length)
+        return;
+    return _min(array);
+}
+exports._minOrUndefined = _minOrUndefined;
+function _min(array) {
+    if (!array.length)
+        throw new Error('_min called on empty array');
+    return array.reduce((min, item) => (min <= item ? min : item));
+}
+exports._min = _min;
+function _maxOrUndefined(array) {
+    if (!array.length)
+        return;
+    return _max(array);
+}
+exports._maxOrUndefined = _maxOrUndefined;
+function _max(array) {
+    if (!array.length)
+        throw new Error('_max called on empty array');
+    return array.reduce((max, item) => (max >= item ? max : item));
+}
+exports._max = _max;

package/dist/datetime/localDate.d.ts

@@ -1,8 +1,10 @@
 import { IsoDateString, IsoDateTimeString, UnixTimestampNumber } from '../types';
 import { LocalTime } from './localTime';
-export declare type LocalDateUnit = 'year' | 'month' | 'day';
+export declare type LocalDateUnit = LocalDateUnitStrict | 'week';
+export declare type LocalDateUnitStrict = 'year' | 'month' | 'day';
 export declare type Inclusiveness = '()' | '[]' | '[)' | '(]';
 export declare type LocalDateConfig = LocalDate | IsoDateString;
+export declare type LocalDateFormatter = (ld: LocalDate) => string;
 /**
  * @experimental
  */
@@ -28,13 +30,13 @@ export declare class LocalDate {
     static today(): LocalDate;
     static todayUTC(): LocalDate;
     static sort(items: LocalDate[], mutate?: boolean, descending?: boolean): LocalDate[];
-    static earliestOrUndefined(items: LocalDate[]): LocalDate | undefined;
-    static earliest(items: LocalDate[]): LocalDate;
-    static latestOrUndefined(items: LocalDate[]): LocalDate | undefined;
-    static latest(items: LocalDate[]): LocalDate;
+    static earliestOrUndefined(items: LocalDateConfig[]): LocalDate | undefined;
+    static earliest(items: LocalDateConfig[]): LocalDate;
+    static latestOrUndefined(items: LocalDateConfig[]): LocalDate | undefined;
+    static latest(items: LocalDateConfig[]): LocalDate;
     static range(min: LocalDateConfig, max: LocalDateConfig, incl?: Inclusiveness, step?: number, stepUnit?: LocalDateUnit): LocalDate[];
-    get(unit: LocalDateUnit): number;
-    set(unit: LocalDateUnit, v: number, mutate?: boolean): LocalDate;
+    get(unit: LocalDateUnitStrict): number;
+    set(unit: LocalDateUnitStrict, v: number, mutate?: boolean): LocalDate;
     year(): number;
     year(v: number): LocalDate;
     month(): number;
@@ -58,15 +60,15 @@ export declare class LocalDate {
      */
     absDiff(d: LocalDateConfig, unit: LocalDateUnit): number;
     /**
-     * Returns the number of **full** units difference (aka `Math.ceil`).
+     * Returns the number of **full** units difference (aka `Math.floor`).
      *
      * a.diff(b) means "a minus b"
      */
     diff(d: LocalDateConfig, unit: LocalDateUnit): number;
     add(num: number, unit: LocalDateUnit, mutate?: boolean): LocalDate;
     subtract(num: number, unit: LocalDateUnit, mutate?: boolean): LocalDate;
-    startOf(unit: LocalDateUnit): LocalDate;
-    endOf(unit: LocalDateUnit): LocalDate;
+    startOf(unit: LocalDateUnitStrict): LocalDate;
+    endOf(unit: LocalDateUnitStrict): LocalDate;
     static getYearLength(year: number): number;
     static getMonthLength(year: number, month: number): number;
     static isLeapYear(year: number): boolean;
@@ -89,6 +91,7 @@ export declare class LocalDate {
     unix(): UnixTimestampNumber;
     unixMillis(): number;
     toJSON(): IsoDateString;
+    format(fmt: LocalDateFormatter): string;
 }
 /**
  * Shortcut wrapper around `LocalDate.parse` / `LocalDate.today`

package/dist/datetime/localDate.js

@@ -90,16 +90,24 @@ class LocalDate {
     }
     static earliest(items) {
         (0, assert_1._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) {
         (0, assert_1._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);
@@ -197,44 +205,58 @@ class LocalDate {
         return Math.abs(this.diff(d, unit));
     }
     /**
-     * Returns the number of **full** units difference (aka `Math.ceil`).
+     * Returns the number of **full** units difference (aka `Math.floor`).
      *
      * a.diff(b) means "a minus b"
      */
     diff(d, unit) {
         d = LocalDate.of(d);
+        const sign = this.cmp(d);
+        if (!sign)
+            return 0;
+        // Put items in descending order: "big minus small"
+        const [big, small] = sign === 1 ? [this, d] : [d, this];
         if (unit === 'year') {
-            return this.$year - d.$year;
+            let years = big.$year - small.$year;
+            if (big.$month < small.$month || (big.$month === small.$month && big.$day < small.$day)) {
+                years--;
+            }
+            return years * sign || 0;
         }
         if (unit === 'month') {
-            return (this.$year - d.$year) * 12 + (this.$month - d.$month);
+            let months = (big.$year - small.$year) * 12 + (big.$month - small.$month);
+            if (big.$day < small.$day)
+                months--;
+            return months * sign || 0;
         }
-        // unit is 'day'
-        let days = this.$day - d.$day;
-        if (d.$year < this.$year) {
-            for (let year = d.$year; year < this.$year; year++) {
-                days += LocalDate.getYearLength(year);
-            }
+        // unit is 'day' or 'week'
+        let days = big.$day - small.$day;
+        // If small date is after 1st of March - next year's "leapness" should be used
+        const offsetYear = small.$month >= 3 ? 1 : 0;
+        for (let year = small.$year; year < big.$year; year++) {
+            days += LocalDate.getYearLength(year + offsetYear);
         }
-        else if (this.$year < d.$year) {
-            for (let year = this.$year; year < d.$year; year++) {
-                days -= LocalDate.getYearLength(year);
+        if (small.$month < big.$month) {
+            for (let month = small.$month; month < big.$month; month++) {
+                days += LocalDate.getMonthLength(big.$year, month);
             }
         }
-        if (d.$month < this.$month) {
-            for (let month = d.$month; month < this.$month; month++) {
-                days += LocalDate.getMonthLength(this.$year, month);
+        else if (big.$month < small.$month) {
+            for (let month = big.$month; month < small.$month; month++) {
+                days -= LocalDate.getMonthLength(big.$year, month);
             }
         }
-        else if (this.$month < d.$month) {
-            for (let month = this.$month; month < d.$month; month++) {
-                days -= LocalDate.getMonthLength(d.$year, month);
-            }
+        if (unit === 'week') {
+            return Math.trunc(days / 7) * sign || 0;
         }
-        return days;
+        return days * sign || 0;
     }
     add(num, unit, mutate = false) {
         let { $day, $month, $year } = this;
+        if (unit === 'week') {
+            num *= 7;
+            unit = 'day';
+        }
         if (unit === 'day') {
             $day += num;
         }
@@ -364,6 +386,9 @@ class LocalDate {
     toJSON() {
         return this.toString();
     }
+    format(fmt) {
+        return fmt(this);
+    }
 }
 exports.LocalDate = LocalDate;
 /**

package/dist/datetime/localTime.d.ts

@@ -1,7 +1,17 @@
 import { IsoDateString, IsoDateTimeString, UnixTimestampNumber } from '../types';
 import { Inclusiveness, LocalDate } from './localDate';
-export declare type LocalTimeUnit = 'year' | 'month' | 'day' | 'hour' | 'minute' | 'second';
+export declare type LocalTimeUnit = 'year' | 'month' | 'week' | 'day' | 'hour' | 'minute' | 'second';
+export declare enum ISODayOfWeek {
+    MONDAY = 1,
+    TUESDAY = 2,
+    WEDNESDAY = 3,
+    THURSDAY = 4,
+    FRIDAY = 5,
+    SATURDAY = 6,
+    SUNDAY = 7
+}
 export declare type LocalTimeConfig = LocalTime | Date | IsoDateTimeString | UnixTimestampNumber;
+export declare type LocalTimeFormatter = (ld: LocalTime) => string;
 export interface LocalTimeComponents {
     year: number;
     month: number;
@@ -15,15 +25,12 @@ export interface LocalTimeComponents {
  */
 export declare class LocalTime {
     private $date;
-    utcMode: boolean;
     private constructor();
     /**
      * Parses input String into LocalDate.
      * Input can already be a LocalDate - it is returned as-is in that case.
      */
     static of(d: LocalTimeConfig): LocalTime;
-    utc(): this;
-    local(): this;
     /**
      * Returns null if invalid
      */
@@ -42,8 +49,15 @@ export declare class LocalTime {
     year(v: number): LocalTime;
     month(): number;
     month(v: number): LocalTime;
+    week(): number;
+    week(v: number): LocalTime;
     day(): number;
     day(v: number): LocalTime;
+    /**
+     * Based on ISO: 1-7 is Mon-Sun.
+     */
+    dayOfWeek(): ISODayOfWeek;
+    dayOfWeek(v: ISODayOfWeek): LocalTime;
     hour(): number;
     hour(v: number): LocalTime;
     minute(): number;
@@ -56,11 +70,12 @@ export declare class LocalTime {
     absDiff(other: LocalTimeConfig, unit: LocalTimeUnit): number;
     diff(other: LocalTimeConfig, unit: LocalTimeUnit): number;
     startOf(unit: LocalTimeUnit, mutate?: boolean): LocalTime;
+    endOf(unit: LocalTimeUnit, mutate?: boolean): LocalTime;
     static sort(items: LocalTime[], mutate?: boolean, descending?: boolean): LocalTime[];
-    static earliestOrUndefined(items: LocalTime[]): LocalTime | undefined;
-    static earliest(items: LocalTime[]): LocalTime;
-    static latestOrUndefined(items: LocalTime[]): LocalTime | undefined;
-    static latest(items: LocalTime[]): LocalTime;
+    static earliestOrUndefined(items: LocalTimeConfig[]): LocalTime | undefined;
+    static earliest(items: LocalTimeConfig[]): LocalTime;
+    static latestOrUndefined(items: LocalTimeConfig[]): LocalTime | undefined;
+    static latest(items: LocalTimeConfig[]): LocalTime;
     isSame(d: LocalTimeConfig): boolean;
     isBefore(d: LocalTimeConfig, inclusive?: boolean): boolean;
     isSameOrBefore(d: LocalTimeConfig): boolean;
@@ -100,6 +115,7 @@ export declare class LocalTime {
     toStringCompact(seconds?: boolean): string;
     toString(): string;
     toJSON(): UnixTimestampNumber;
+    format(fmt: LocalTimeFormatter): string;
 }
 /**
  * Shortcut wrapper around `LocalDate.parse` / `LocalDate.today`