@naturalcycles/js-lib 14.92.0 → 14.95.0

package/dist/datetime/dateInterval.d.ts

@@ -0,0 +1,39 @@
+import { LocalDate, LocalDateConfig } from './localDate';
+export declare type DateIntervalConfig = DateInterval | string;
+export declare type DateIntervalString = string;
+/**
+ * Class that supports ISO8601 "Time interval" standard that looks like `2022-02-24/2022-03-30`.
+ *
+ * @experimental
+ */
+export declare class DateInterval {
+    start: LocalDate;
+    end: LocalDate;
+    private constructor();
+    static of(start: LocalDateConfig, end: LocalDateConfig): DateInterval;
+    /**
+     * Parses string like `2022-02-24/2023-03-30` into a DateInterval.
+     */
+    static parse(d: DateIntervalConfig): DateInterval;
+    isSame(d: DateIntervalConfig): boolean;
+    isBefore(d: DateIntervalConfig): boolean;
+    isSameOrBefore(d: DateIntervalConfig): boolean;
+    isAfter(d: DateIntervalConfig): boolean;
+    isSameOrAfter(d: DateIntervalConfig): boolean;
+    /**
+     * Ranges of DateInterval (start, end) are INCLUSIVE.
+     */
+    includes(d: LocalDateConfig): boolean;
+    /**
+     * DateIntervals compare by start date.
+     * If it's the same - then by end date.
+     */
+    cmp(d: DateIntervalConfig): -1 | 0 | 1;
+    /**
+     * Returns an array of LocalDates that are included in the interval.
+     * Ranges are INCLUSIVE.
+     */
+    getDays(): LocalDate[];
+    toString(): DateIntervalString;
+    toJSON(): DateIntervalString;
+}

package/dist/datetime/dateInterval.js

@@ -0,0 +1,80 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DateInterval = void 0;
+const localDate_1 = require("./localDate");
+/**
+ * Class that supports ISO8601 "Time interval" standard that looks like `2022-02-24/2022-03-30`.
+ *
+ * @experimental
+ */
+class DateInterval {
+    constructor(start, end) {
+        this.start = start;
+        this.end = end;
+    }
+    static of(start, end) {
+        return new DateInterval(localDate_1.LocalDate.of(start), localDate_1.LocalDate.of(end));
+    }
+    /**
+     * Parses string like `2022-02-24/2023-03-30` into a DateInterval.
+     */
+    static parse(d) {
+        if (d instanceof DateInterval)
+            return d;
+        const [start, end] = d.split('/');
+        if (!end || !start) {
+            throw new Error(`Cannot parse "${d}" into DateInterval`);
+        }
+        return new DateInterval(localDate_1.LocalDate.of(start), localDate_1.LocalDate.of(end));
+    }
+    isSame(d) {
+        return this.cmp(d) === 0;
+    }
+    isBefore(d) {
+        return this.cmp(d) === -1;
+    }
+    isSameOrBefore(d) {
+        return this.cmp(d) <= 0;
+    }
+    isAfter(d) {
+        return this.cmp(d) === 1;
+    }
+    isSameOrAfter(d) {
+        return this.cmp(d) >= 0;
+    }
+    /**
+     * Ranges of DateInterval (start, end) are INCLUSIVE.
+     */
+    includes(d) {
+        d = localDate_1.LocalDate.of(d);
+        return d.isSameOrAfter(this.start) && d.isSameOrBefore(this.end);
+    }
+    /**
+     * DateIntervals compare by start date.
+     * If it's the same - then by end date.
+     */
+    cmp(d) {
+        d = DateInterval.parse(d);
+        return this.start.cmp(d.start) || this.end.cmp(d.end);
+    }
+    /**
+     * Returns an array of LocalDates that are included in the interval.
+     * Ranges are INCLUSIVE.
+     */
+    getDays() {
+        const days = [];
+        let current = this.start;
+        do {
+            days.push(current);
+            current = current.add(1, 'day');
+        } while (current.isSameOrBefore(this.end));
+        return days;
+    }
+    toString() {
+        return [this.start, this.end].join('/');
+    }
+    toJSON() {
+        return this.toString();
+    }
+}
+exports.DateInterval = DateInterval;

package/dist/datetime/localDate.d.ts

@@ -2,6 +2,7 @@ import { Sequence } from '../seq/seq';
 import { IsoDate, UnixTimestamp } from '../types';
 import { LocalTime } from './localTime';
 export declare type LocalDateUnit = 'year' | 'month' | 'day';
+export declare type Inclusiveness = '()' | '[]' | '[)' | '(]';
 export declare type LocalDateConfig = LocalDate | string;
 /**
  * @experimental
@@ -42,6 +43,7 @@ export declare class LocalDate {
     isSameOrBefore(d: LocalDateConfig): boolean;
     isAfter(d: LocalDateConfig): boolean;
     isSameOrAfter(d: LocalDateConfig): boolean;
+    isBetween(min: LocalDateConfig, max: LocalDateConfig, incl?: Inclusiveness): boolean;
     /**
      * Returns 1 if this > d
      * returns 0 if they are equal

package/dist/datetime/localDate.js

@@ -131,6 +131,15 @@ class LocalDate {
     isSameOrAfter(d) {
         return this.cmp(d) >= 0;
     }
+    isBetween(min, max, incl = '[)') {
+        let r = this.cmp(min);
+        if (r < 0 || (r === 0 && incl[0] === '('))
+            return false;
+        r = this.cmp(max);
+        if (r > 0 || (r === 0 && incl[1] === ')'))
+            return false;
+        return true;
+    }
     /**
      * Returns 1 if this > d
      * returns 0 if they are equal

package/dist/datetime/localTime.d.ts

@@ -1,5 +1,5 @@
 import { IsoDate, IsoDateTime, UnixTimestamp } from '../types';
-import { LocalDate } from './localDate';
+import { Inclusiveness, LocalDate } from './localDate';
 export declare type LocalTimeUnit = 'year' | 'month' | 'day' | 'hour' | 'minute' | 'second';
 export declare type LocalTimeConfig = LocalTime | Date | IsoDateTime | UnixTimestamp;
 export interface LocalTimeComponents {
@@ -64,6 +64,7 @@ export declare class LocalTime {
     isSameOrBefore(d: LocalTimeConfig): boolean;
     isAfter(d: LocalTimeConfig): boolean;
     isSameOrAfter(d: LocalTimeConfig): boolean;
+    isBetween(min: LocalTimeConfig, max: LocalTimeConfig, incl?: Inclusiveness): boolean;
     /**
      * Returns 1 if this > d
      * returns 0 if they are equal

package/dist/datetime/localTime.js

@@ -14,6 +14,9 @@ const localDate_1 = require("./localDate");
 // .valueOf returns unix timestamp (no millis)
 // Prevents dayjs(undefined) being dayjs.now()
 // Validates on parse, throws if invalid. Doesn't allow invalid objects
+// No arbitrary .format('') (which is slow to parse) vs well-defined (opinionated) formats
+// Separate LocalTime, powered by native js Date, and LocalDate - a smaller functionality class when
+// you only need "whole dates", no time, no timezone worry
 /**
  * @experimental
  */
@@ -260,6 +263,15 @@ class LocalTime {
     isSameOrAfter(d) {
         return this.cmp(d) >= 0;
     }
+    isBetween(min, max, incl = '[)') {
+        let r = this.cmp(min);
+        if (r < 0 || (r === 0 && incl[0] === '('))
+            return false;
+        r = this.cmp(max);
+        if (r > 0 || (r === 0 && incl[1] === ')'))
+            return false;
+        return true;
+    }
     /**
      * Returns 1 if this > d
      * returns 0 if they are equal

package/dist/index.d.ts

@@ -63,7 +63,9 @@ export * from './math/stack.util';
 export * from './string/leven';
 export * from './datetime/localDate';
 export * from './datetime/localTime';
-import { LocalDateConfig, LocalDateUnit } from './datetime/localDate';
+export * from './datetime/dateInterval';
+import { LocalDateConfig, LocalDateUnit, Inclusiveness } from './datetime/localDate';
 import { LocalTimeConfig, LocalTimeUnit, LocalTimeComponents } from './datetime/localTime';
-export type { LocalDateConfig, LocalDateUnit, LocalTimeConfig, LocalTimeUnit, LocalTimeComponents, AbortableMapper, AbortablePredicate, AbortableAsyncPredicate, AbortableAsyncMapper, PQueueCfg, MemoCache, AsyncMemoCache, PromiseDecoratorCfg, PromiseDecoratorResp, ErrorData, ErrorObject, HttpErrorData, HttpErrorResponse, Admin401ErrorData, Admin403ErrorData, StringMap, PromiseMap, AnyObject, AnyFunction, ValuesOf, ValueOf, KeyValueTuple, ObjectMapper, ObjectPredicate, InstanceId, IsoDate, IsoDateTime, Reviver, PMapOptions, Mapper, AsyncMapper, Predicate, AsyncPredicate, BatchResult, DeferredPromise, PRetryOptions, PTimeoutOptions, TryCatchOptions, StringifyAnyOptions, JsonStringifyFunction, Merge, ReadonlyDeep, Promisable, Simplify, ConditionalPick, ConditionalExcept, Class, UnixTimestamp, Integer, BaseDBEntity, SavedDBEntity, Saved, Unsaved, CreatedUpdated, CreatedUpdatedId, ObjectWithId, AnyObjectWithId, JsonSchema, JsonSchemaAny, JsonSchemaOneOf, JsonSchemaAllOf, JsonSchemaAnyOf, JsonSchemaNot, JsonSchemaRef, JsonSchemaConst, JsonSchemaEnum, JsonSchemaString, JsonSchemaNumber, JsonSchemaBoolean, JsonSchemaNull, JsonSchemaRootObject, JsonSchemaObject, JsonSchemaArray, JsonSchemaTuple, JsonSchemaBuilder, CommonLogLevel, CommonLogWithLevelFunction, CommonLogFunction, CommonLogger, };
+import { DateIntervalConfig, DateIntervalString } from './datetime/dateInterval';
+export type { DateIntervalConfig, DateIntervalString, LocalDateConfig, LocalDateUnit, Inclusiveness, LocalTimeConfig, LocalTimeUnit, LocalTimeComponents, AbortableMapper, AbortablePredicate, AbortableAsyncPredicate, AbortableAsyncMapper, PQueueCfg, MemoCache, AsyncMemoCache, PromiseDecoratorCfg, PromiseDecoratorResp, ErrorData, ErrorObject, HttpErrorData, HttpErrorResponse, Admin401ErrorData, Admin403ErrorData, StringMap, PromiseMap, AnyObject, AnyFunction, ValuesOf, ValueOf, KeyValueTuple, ObjectMapper, ObjectPredicate, InstanceId, IsoDate, IsoDateTime, Reviver, PMapOptions, Mapper, AsyncMapper, Predicate, AsyncPredicate, BatchResult, DeferredPromise, PRetryOptions, PTimeoutOptions, TryCatchOptions, StringifyAnyOptions, JsonStringifyFunction, Merge, ReadonlyDeep, Promisable, Simplify, ConditionalPick, ConditionalExcept, Class, UnixTimestamp, Integer, BaseDBEntity, SavedDBEntity, Saved, Unsaved, CreatedUpdated, CreatedUpdatedId, ObjectWithId, AnyObjectWithId, JsonSchema, JsonSchemaAny, JsonSchemaOneOf, JsonSchemaAllOf, JsonSchemaAnyOf, JsonSchemaNot, JsonSchemaRef, JsonSchemaConst, JsonSchemaEnum, JsonSchemaString, JsonSchemaNumber, JsonSchemaBoolean, JsonSchemaNull, JsonSchemaRootObject, JsonSchemaObject, JsonSchemaArray, JsonSchemaTuple, JsonSchemaBuilder, CommonLogLevel, CommonLogWithLevelFunction, CommonLogFunction, CommonLogger, };
 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/dist/index.js

@@ -95,3 +95,4 @@ tslib_1.__exportStar(require("./math/stack.util"), exports);
 tslib_1.__exportStar(require("./string/leven"), exports);
 tslib_1.__exportStar(require("./datetime/localDate"), exports);
 tslib_1.__exportStar(require("./datetime/localTime"), exports);
+tslib_1.__exportStar(require("./datetime/dateInterval"), exports);

package/dist-esm/datetime/dateInterval.js

@@ -0,0 +1,76 @@
+import { LocalDate } from './localDate';
+/**
+ * Class that supports ISO8601 "Time interval" standard that looks like `2022-02-24/2022-03-30`.
+ *
+ * @experimental
+ */
+export class DateInterval {
+    constructor(start, end) {
+        this.start = start;
+        this.end = end;
+    }
+    static of(start, end) {
+        return new DateInterval(LocalDate.of(start), LocalDate.of(end));
+    }
+    /**
+     * Parses string like `2022-02-24/2023-03-30` into a DateInterval.
+     */
+    static parse(d) {
+        if (d instanceof DateInterval)
+            return d;
+        const [start, end] = d.split('/');
+        if (!end || !start) {
+            throw new Error(`Cannot parse "${d}" into DateInterval`);
+        }
+        return new DateInterval(LocalDate.of(start), LocalDate.of(end));
+    }
+    isSame(d) {
+        return this.cmp(d) === 0;
+    }
+    isBefore(d) {
+        return this.cmp(d) === -1;
+    }
+    isSameOrBefore(d) {
+        return this.cmp(d) <= 0;
+    }
+    isAfter(d) {
+        return this.cmp(d) === 1;
+    }
+    isSameOrAfter(d) {
+        return this.cmp(d) >= 0;
+    }
+    /**
+     * Ranges of DateInterval (start, end) are INCLUSIVE.
+     */
+    includes(d) {
+        d = LocalDate.of(d);
+        return d.isSameOrAfter(this.start) && d.isSameOrBefore(this.end);
+    }
+    /**
+     * DateIntervals compare by start date.
+     * If it's the same - then by end date.
+     */
+    cmp(d) {
+        d = DateInterval.parse(d);
+        return this.start.cmp(d.start) || this.end.cmp(d.end);
+    }
+    /**
+     * Returns an array of LocalDates that are included in the interval.
+     * Ranges are INCLUSIVE.
+     */
+    getDays() {
+        const days = [];
+        let current = this.start;
+        do {
+            days.push(current);
+            current = current.add(1, 'day');
+        } while (current.isSameOrBefore(this.end));
+        return days;
+    }
+    toString() {
+        return [this.start, this.end].join('/');
+    }
+    toJSON() {
+        return this.toString();
+    }
+}

package/dist-esm/datetime/localDate.js

@@ -128,6 +128,15 @@ export class LocalDate {
     isSameOrAfter(d) {
         return this.cmp(d) >= 0;
     }
+    isBetween(min, max, incl = '[)') {
+        let r = this.cmp(min);
+        if (r < 0 || (r === 0 && incl[0] === '('))
+            return false;
+        r = this.cmp(max);
+        if (r > 0 || (r === 0 && incl[1] === ')'))
+            return false;
+        return true;
+    }
     /**
      * Returns 1 if this > d
      * returns 0 if they are equal

package/dist-esm/datetime/localTime.js

@@ -11,6 +11,9 @@ import { LocalDate } from './localDate';
 // .valueOf returns unix timestamp (no millis)
 // Prevents dayjs(undefined) being dayjs.now()
 // Validates on parse, throws if invalid. Doesn't allow invalid objects
+// No arbitrary .format('') (which is slow to parse) vs well-defined (opinionated) formats
+// Separate LocalTime, powered by native js Date, and LocalDate - a smaller functionality class when
+// you only need "whole dates", no time, no timezone worry
 /**
  * @experimental
  */
@@ -257,6 +260,15 @@ export class LocalTime {
     isSameOrAfter(d) {
         return this.cmp(d) >= 0;
     }
+    isBetween(min, max, incl = '[)') {
+        let r = this.cmp(min);
+        if (r < 0 || (r === 0 && incl[0] === '('))
+            return false;
+        r = this.cmp(max);
+        if (r > 0 || (r === 0 && incl[1] === ')'))
+            return false;
+        return true;
+    }
     /**
      * Returns 1 if this > d
      * returns 0 if they are equal

package/dist-esm/index.js

@@ -59,4 +59,5 @@ export * from './math/stack.util';
 export * from './string/leven';
 export * from './datetime/localDate';
 export * from './datetime/localTime';
+export * from './datetime/dateInterval';
 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.92.0",
+  "version": "14.95.0",
   "scripts": {
     "prepare": "husky install",
     "build-prod": "build-prod-esm-cjs",

package/src/datetime/dateInterval.ts

@@ -0,0 +1,92 @@
+import { LocalDate, LocalDateConfig } from './localDate'
+
+export type DateIntervalConfig = DateInterval | string
+export type DateIntervalString = string
+
+/**
+ * Class that supports ISO8601 "Time interval" standard that looks like `2022-02-24/2022-03-30`.
+ *
+ * @experimental
+ */
+export class DateInterval {
+  private constructor(public start: LocalDate, public end: LocalDate) {}
+
+  static of(start: LocalDateConfig, end: LocalDateConfig): DateInterval {
+    return new DateInterval(LocalDate.of(start), LocalDate.of(end))
+  }
+
+  /**
+   * Parses string like `2022-02-24/2023-03-30` into a DateInterval.
+   */
+  static parse(d: DateIntervalConfig): DateInterval {
+    if (d instanceof DateInterval) return d
+
+    const [start, end] = d.split('/')
+
+    if (!end || !start) {
+      throw new Error(`Cannot parse "${d}" into DateInterval`)
+    }
+
+    return new DateInterval(LocalDate.of(start), LocalDate.of(end))
+  }
+
+  isSame(d: DateIntervalConfig): boolean {
+    return this.cmp(d) === 0
+  }
+
+  isBefore(d: DateIntervalConfig): boolean {
+    return this.cmp(d) === -1
+  }
+
+  isSameOrBefore(d: DateIntervalConfig): boolean {
+    return this.cmp(d) <= 0
+  }
+
+  isAfter(d: DateIntervalConfig): boolean {
+    return this.cmp(d) === 1
+  }
+
+  isSameOrAfter(d: DateIntervalConfig): boolean {
+    return this.cmp(d) >= 0
+  }
+
+  /**
+   * Ranges of DateInterval (start, end) are INCLUSIVE.
+   */
+  includes(d: LocalDateConfig): boolean {
+    d = LocalDate.of(d)
+    return d.isSameOrAfter(this.start) && d.isSameOrBefore(this.end)
+  }
+
+  /**
+   * DateIntervals compare by start date.
+   * If it's the same - then by end date.
+   */
+  cmp(d: DateIntervalConfig): -1 | 0 | 1 {
+    d = DateInterval.parse(d)
+    return this.start.cmp(d.start) || this.end.cmp(d.end)
+  }
+
+  /**
+   * Returns an array of LocalDates that are included in the interval.
+   * Ranges are INCLUSIVE.
+   */
+  getDays(): LocalDate[] {
+    const days: LocalDate[] = []
+    let current = this.start
+    do {
+      days.push(current)
+      current = current.add(1, 'day')
+    } while (current.isSameOrBefore(this.end))
+
+    return days
+  }
+
+  toString(): DateIntervalString {
+    return [this.start, this.end].join('/')
+  }
+
+  toJSON(): DateIntervalString {
+    return this.toString()
+  }
+}

package/src/datetime/localDate.ts

@@ -4,6 +4,7 @@ import { END, IsoDate, UnixTimestamp } from '../types'
 import { LocalTime } from './localTime'
 
 export type LocalDateUnit = 'year' | 'month' | 'day'
+export type Inclusiveness = '()' | '[]' | '[)' | '(]'
 
 const m31 = new Set<number>([1, 3, 5, 7, 8, 10, 12])
 
@@ -194,6 +195,14 @@ export class LocalDate {
     return this.cmp(d) >= 0
   }
 
+  isBetween(min: LocalDateConfig, max: LocalDateConfig, incl: Inclusiveness = '[)'): boolean {
+    let r = this.cmp(min)
+    if (r < 0 || (r === 0 && incl[0] === '(')) return false
+    r = this.cmp(max)
+    if (r > 0 || (r === 0 && incl[1] === ')')) return false
+    return true
+  }
+
   /**
    * Returns 1 if this > d
    * returns 0 if they are equal

package/src/datetime/localTime.ts

@@ -1,7 +1,7 @@
 import { _assert } from '../error/assert'
 import { _ms } from '../time/time.util'
 import { IsoDate, IsoDateTime, UnixTimestamp } from '../types'
-import { LocalDate } from './localDate'
+import { Inclusiveness, LocalDate } from './localDate'
 
 export type LocalTimeUnit = 'year' | 'month' | 'day' | 'hour' | 'minute' | 'second'
 
@@ -27,6 +27,9 @@ export interface LocalTimeComponents {
 // .valueOf returns unix timestamp (no millis)
 // Prevents dayjs(undefined) being dayjs.now()
 // Validates on parse, throws if invalid. Doesn't allow invalid objects
+// No arbitrary .format('') (which is slow to parse) vs well-defined (opinionated) formats
+// Separate LocalTime, powered by native js Date, and LocalDate - a smaller functionality class when
+// you only need "whole dates", no time, no timezone worry
 /**
  * @experimental
  */
@@ -319,6 +322,14 @@ export class LocalTime {
     return this.cmp(d) >= 0
   }
 
+  isBetween(min: LocalTimeConfig, max: LocalTimeConfig, incl: Inclusiveness = '[)'): boolean {
+    let r = this.cmp(min)
+    if (r < 0 || (r === 0 && incl[0] === '(')) return false
+    r = this.cmp(max)
+    if (r > 0 || (r === 0 && incl[1] === ')')) return false
+    return true
+  }
+
   /**
    * Returns 1 if this > d
    * returns 0 if they are equal

package/src/index.ts

@@ -158,12 +158,17 @@ export * from './math/stack.util'
 export * from './string/leven'
 export * from './datetime/localDate'
 export * from './datetime/localTime'
-import { LocalDateConfig, LocalDateUnit } from './datetime/localDate'
+export * from './datetime/dateInterval'
+import { LocalDateConfig, LocalDateUnit, Inclusiveness } from './datetime/localDate'
 import { LocalTimeConfig, LocalTimeUnit, LocalTimeComponents } from './datetime/localTime'
+import { DateIntervalConfig, DateIntervalString } from './datetime/dateInterval'
 
 export type {
+  DateIntervalConfig,
+  DateIntervalString,
   LocalDateConfig,
   LocalDateUnit,
+  Inclusiveness,
   LocalTimeConfig,
   LocalTimeUnit,
   LocalTimeComponents,