@naturalcycles/js-lib 14.232.0 → 14.233.1

package/dist/datetime/dateInterval.d.ts

@@ -1,6 +1,5 @@
 import { Inclusiveness } from '../types';
-import type { LocalDateInput, LocalDateUnit } from './localDate';
-import { LocalDate } from './localDate';
+import { LocalDateInput, LocalDateUnit, LocalDate } from './localDate';
 export type DateIntervalConfig = DateInterval | DateIntervalString;
 export type DateIntervalString = string;
 /**

package/dist/datetime/dateInterval.js

@@ -13,7 +13,7 @@ class DateInterval {
         this.end = end;
     }
     static of(start, end) {
-        return new DateInterval(localDate_1.LocalDate.of(start), localDate_1.LocalDate.of(end));
+        return new DateInterval((0, localDate_1.localDate)(start), (0, localDate_1.localDate)(end));
     }
     /**
      * Parses string like `2022-02-24/2023-03-30` into a DateInterval.
@@ -25,7 +25,7 @@ class DateInterval {
         if (!end || !start) {
             throw new Error(`Cannot parse "${d}" into DateInterval`);
         }
-        return new DateInterval(localDate_1.LocalDate.of(start), localDate_1.LocalDate.of(end));
+        return new DateInterval((0, localDate_1.localDate)(start), (0, localDate_1.localDate)(end));
     }
     isSame(d) {
         return this.cmp(d) === 0;
@@ -48,7 +48,7 @@ class DateInterval {
      * Ranges of DateInterval (start, end) are INCLUSIVE.
      */
     includes(d, incl = '[]') {
-        d = localDate_1.LocalDate.of(d);
+        d = (0, localDate_1.localDate)(d);
         // eslint-disable-next-line @typescript-eslint/prefer-string-starts-ends-with
         return d.isAfter(this.start, incl[0] === '[') && d.isBefore(this.end, incl[1] === ']');
     }
@@ -66,13 +66,13 @@ class DateInterval {
         return this.start.cmp(d.start) || this.end.cmp(d.end);
     }
     getDays(incl = '[]') {
-        return (0, localDate_1.localDateRange)(this.start, this.end, incl, 1, 'day');
+        return localDate_1.localDate.range(this.start, this.end, incl, 1, 'day');
     }
     /**
      * Returns an array of LocalDates that are included in the interval.
      */
     range(incl = '[]', step = 1, stepUnit = 'day') {
-        return (0, localDate_1.localDateRange)(this.start, this.end, incl, step, stepUnit);
+        return localDate_1.localDate.range(this.start, this.end, incl, step, stepUnit);
     }
     toString() {
         return [this.start, this.end].join('/');

package/dist/datetime/localDate.d.ts

@@ -6,34 +6,14 @@ export type LocalDateUnitStrict = 'year' | 'month' | 'day';
 export type LocalDateInput = LocalDate | Date | IsoDateString;
 export type LocalDateFormatter = (ld: LocalDate) => string;
 /**
- * @experimental
+ * LocalDate represents a date without time.
+ * It is timezone-independent.
  */
 export declare class LocalDate {
     private $year;
     private $month;
     private $day;
-    private constructor();
-    static create(year: number, month: number, day: number): LocalDate;
-    /**
-     * Parses input into LocalDate.
-     * Input can already be a LocalDate - it is returned as-is in that case.
-     */
-    static of(d: LocalDateInput): LocalDate;
-    static parseCompact(d: string): LocalDate;
-    static fromDate(d: Date): LocalDate;
-    static fromDateUTC(d: Date): LocalDate;
-    /**
-     * Returns null if invalid.
-     */
-    static parseOrNull(d: LocalDateInput | undefined | null): LocalDate | null;
-    static isValid(iso: string | undefined | null): boolean;
-    static today(): LocalDate;
-    static todayUTC(): LocalDate;
-    static sort(items: LocalDate[], mutate?: boolean, dir?: SortDirection): LocalDate[];
-    static earliestOrUndefined(items: LocalDateInput[]): LocalDate | undefined;
-    static earliest(items: LocalDateInput[]): LocalDate;
-    static latestOrUndefined(items: LocalDateInput[]): LocalDate | undefined;
-    static latest(items: LocalDateInput[]): LocalDate;
+    constructor($year: number, $month: number, $day: number);
     get(unit: LocalDateUnitStrict): number;
     set(unit: LocalDateUnitStrict, v: number, mutate?: boolean): LocalDate;
     year(): number;
@@ -102,9 +82,6 @@ export declare class LocalDate {
      * E.g 31 for January.
      */
     daysInMonth(): number;
-    static getYearLength(year: number): number;
-    static getMonthLength(year: number, month: number): number;
-    static isLeapYear(year: number): boolean;
     clone(): LocalDate;
     /**
      * Converts LocalDate into instance of Date.
@@ -118,48 +95,144 @@ export declare class LocalDate {
      * Unlike normal `.toDate` that uses browser's timezone by default.
      */
     toDateInUTC(): Date;
+    /**
+     * Converts LocalDate to LocalTime with 0 hours, 0 minutes, 0 seconds.
+     * LocalTime's Date will be in local timezone.
+     */
     toLocalTime(): LocalTime;
+    /**
+     * Returns e.g: `1984-06-21`
+     */
     toISODate(): IsoDateString;
     /**
-     * Returns e.g: `1984-06-21T17:56:21`
+     * Returns e.g: `1984-06-21T00:00:00`
+     * Hours, minutes and seconds are 0.
      */
     toISODateTime(): IsoDateTimeString;
     /**
-     * Returns e.g: `1984-06-21T17:56:21Z` (notice the Z at the end, which indicates UTC)
+     * Returns e.g: `1984-06-21T00:00:00Z` (notice the Z at the end, which indicates UTC).
+     * Hours, minutes and seconds are 0.
      */
-    toISODateTimeUTC(): IsoDateTimeString;
+    toISODateTimeInUTC(): IsoDateTimeString;
     toString(): IsoDateString;
+    /**
+     * Returns e.g: `19840621`
+     */
     toStringCompact(): string;
+    /**
+     * Returns e.g: `1984-06`
+     */
     toMonthId(): MonthId;
+    /**
+     * Returns unix timestamp of 00:00:00 of that date (in UTC, because unix timestamp always reflects UTC).
+     */
     unix(): UnixTimestampNumber;
+    /**
+     * Same as .unix(), but in milliseconds.
+     */
     unixMillis(): UnixTimestampMillisNumber;
     toJSON(): IsoDateString;
     format(fmt: Intl.DateTimeFormat | LocalDateFormatter): string;
 }
-export declare function localDateRange(min: LocalDateInput, max: LocalDateInput, incl?: Inclusiveness, step?: number, stepUnit?: LocalDateUnit): LocalDate[];
-/**
- * Experimental, returns the range as Iterable2.
- */
-export declare function localDateRangeIterable(min: LocalDateInput, max: LocalDateInput, incl?: Inclusiveness, step?: number, stepUnit?: LocalDateUnit): Iterable2<LocalDate>;
-/**
- * Convenience wrapper around `LocalDate.of`
- */
-export declare function localDate(d: LocalDateInput): LocalDate;
-/**
- * Convenience wrapper around `LocalDate.today`
- */
-export declare function localDateToday(): LocalDate;
-/**
- * Creates a LocalDate from the input, unless it's falsy - then returns undefined.
- *
- * `localDate` function will instead return LocalDate of today for falsy input.
- */
-export declare function localDateOrUndefined(d?: LocalDateInput | null): LocalDate | undefined;
-/**
- * Creates a LocalDate from the input, unless it's falsy - then returns LocalDate.today.
- */
-export declare function localDateOrToday(d?: LocalDateInput | null): LocalDate;
+declare class LocalDateFactory {
+    /**
+     * Create LocalDate from year, month and day components.
+     */
+    create(year: number, month: number, day: number): LocalDate;
+    /**
+     * Create LocalDate from LocalDateInput.
+     * Input can already be a LocalDate - it is returned as-is in that case.
+     * String - will be parsed as yyyy-mm-dd.
+     * Date - will be converted to LocalDate (as-is, in whatever timezone it is - local or UTC).
+     * No other formats are supported.
+     *
+     * Will throw if it fails to parse/construct LocalDate.
+     */
+    of(d: LocalDateInput): LocalDate;
+    /**
+     * Tries to construct LocalDate from LocalDateInput, returns null otherwise.
+     * Does not throw (returns null instead).
+     */
+    parseOrNull(d: LocalDateInput | undefined | null): LocalDate | null;
+    /**
+     * Parses "compact iso8601 format", e.g `19840621` into LocalDate.
+     * Throws if it fails to do so.
+     */
+    parseCompact(d: string): LocalDate;
+    getYearLength(year: number): number;
+    getMonthLength(year: number, month: number): number;
+    isLeapYear(year: number): boolean;
+    /**
+     * Constructs LocalDate from Date.
+     * Takes Date as-is, in its timezone - local or UTC.
+     */
+    fromDate(d: Date): LocalDate;
+    /**
+     * Constructs LocalDate from Date.
+     * Takes Date's year/month/day components in UTC, using getUTCFullYear, getUTCMonth, getUTCDate.
+     */
+    fromDateInUTC(d: Date): LocalDate;
+    /**
+     * Returns true if isoString is a valid iso8601 string like `yyyy-mm-dd`.
+     */
+    isValid(isoString: string | undefined | null): boolean;
+    /**
+     * Creates LocalDate that represents `today` (in local timezone).
+     */
+    today(): LocalDate;
+    /**
+     * Creates LocalDate that represents `today` in UTC.
+     */
+    todayInUTC(): LocalDate;
+    /**
+     * Sorts an array of LocalDates in `dir` order (ascending by default).
+     */
+    sort(items: LocalDate[], dir?: SortDirection, mutate?: boolean): LocalDate[];
+    /**
+     * Returns the earliest (min) LocalDate from the array, or undefined if the array is empty.
+     */
+    minOrUndefined(items: LocalDateInput[]): LocalDate | undefined;
+    /**
+     * Returns the earliest LocalDate from the array.
+     * Throws if the array is empty.
+     */
+    min(items: LocalDateInput[]): LocalDate;
+    /**
+     * Returns the latest (max) LocalDate from the array, or undefined if the array is empty.
+     */
+    maxOrUndefined(items: LocalDateInput[]): LocalDate | undefined;
+    /**
+     * Returns the latest LocalDate from the array.
+     * Throws if the array is empty.
+     */
+    max(items: LocalDateInput[]): LocalDate;
+    /**
+     * Returns the range (array) of LocalDates between min and max.
+     * By default, min is included, max is excluded.
+     */
+    range(min: LocalDateInput, max: LocalDateInput, incl?: Inclusiveness, step?: number, stepUnit?: LocalDateUnit): LocalDate[];
+    /**
+     * Returns the Iterable2 of LocalDates between min and max.
+     * By default, min is included, max is excluded.
+     */
+    rangeIterable(min: LocalDateInput, max: LocalDateInput, incl?: Inclusiveness, step?: number, stepUnit?: LocalDateUnit): Iterable2<LocalDate>;
+    /**
+     * Creates a LocalDate from the input, unless it's falsy - then returns undefined.
+     *
+     * Similar to `localDate.orToday`, but that will instead return Today on falsy input.
+     */
+    orUndefined(d: LocalDateInput | null | undefined): LocalDate | undefined;
+    /**
+     * Creates a LocalDate from the input, unless it's falsy - then returns localDate.today.
+     */
+    orToday(d: LocalDateInput | null | undefined): LocalDate;
+}
+interface LocalDateFn extends LocalDateFactory {
+    (d: LocalDateInput): LocalDate;
+}
+export declare const localDate: LocalDateFn;
 /**
  Convenience function to return current today's IsoDateString representation, e.g `2024-06-21`
  */
 export declare function todayString(): IsoDateString;
+export {};