@naturalcycles/js-lib 14.184.0 → 14.185.0

package/dist/datetime/localDate.d.ts

@@ -1,4 +1,4 @@
-import type { IsoDateString, IsoDateTimeString, UnixTimestampMillisNumber, UnixTimestampNumber } from '../types';
+import type { IsoDateString, IsoDateTimeString, MonthId, UnixTimestampMillisNumber, UnixTimestampNumber } from '../types';
 import { LocalTime } from './localTime';
 export type LocalDateUnit = LocalDateUnitStrict | 'week';
 export type LocalDateUnitStrict = 'year' | 'month' | 'day';
@@ -49,6 +49,14 @@ export declare class LocalDate {
     isAfter(d: LocalDateInput, inclusive?: boolean): boolean;
     isSameOrAfter(d: LocalDateInput): boolean;
     isBetween(min: LocalDateInput, max: LocalDateInput, incl?: Inclusiveness): boolean;
+    /**
+     * Checks if this localDate is older than "today" by X units.
+     *
+     * Example:
+     *
+     * localDate(expirationDate).isOlderThan(5, 'day')
+     */
+    isOlderThan(n: number, unit: LocalDateUnitStrict): boolean;
     /**
      * Returns 1 if this > d
      * returns 0 if they are equal
@@ -88,6 +96,7 @@ export declare class LocalDate {
     toISODateTime(): IsoDateTimeString;
     toString(): IsoDateString;
     toStringCompact(): string;
+    toMonthId(): MonthId;
     unix(): UnixTimestampNumber;
     unixMillis(): UnixTimestampMillisNumber;
     toJSON(): IsoDateString;

package/dist/datetime/localDate.js

@@ -179,6 +179,16 @@ class LocalDate {
             return false;
         return true;
     }
+    /**
+     * Checks if this localDate is older than "today" by X units.
+     *
+     * Example:
+     *
+     * localDate(expirationDate).isOlderThan(5, 'day')
+     */
+    isOlderThan(n, unit) {
+        return this.isBefore(LocalDate.today().add(-n, unit));
+    }
     /**
      * Returns 1 if this > d
      * returns 0 if they are equal
@@ -393,6 +403,9 @@ class LocalDate {
             String(this.$day).padStart(2, '0'),
         ].join('');
     }
+    toMonthId() {
+        return this.toString().slice(0, 7);
+    }
     // May be not optimal, as LocalTime better suits it
     unix() {
         return Math.floor(this.toDate().valueOf() / 1000);

package/dist/datetime/localTime.d.ts

@@ -1,4 +1,4 @@
-import type { IsoDateString, IsoDateTimeString, UnixTimestampMillisNumber, UnixTimestampNumber } from '../types';
+import type { IsoDateString, IsoDateTimeString, MonthId, UnixTimestampMillisNumber, UnixTimestampNumber } from '../types';
 import type { Inclusiveness } from './localDate';
 import { LocalDate } from './localDate';
 export type LocalTimeUnit = 'year' | 'month' | 'week' | 'day' | 'hour' | 'minute' | 'second';
@@ -87,6 +87,14 @@ export declare class LocalTime {
     isAfter(d: LocalTimeInput, inclusive?: boolean): boolean;
     isSameOrAfter(d: LocalTimeInput): boolean;
     isBetween(min: LocalTimeInput, max: LocalTimeInput, incl?: Inclusiveness): boolean;
+    /**
+     * Checks if this localTime is older than "now" by X units.
+     *
+     * Example:
+     *
+     * localTime(expirationDate).isOlderThan(5, 'day')
+     */
+    isOlderThan(n: number, unit: LocalTimeUnit): boolean;
     /**
      * Returns 1 if this > d
      * returns 0 if they are equal
@@ -120,6 +128,7 @@ export declare class LocalTime {
     toStringCompact(seconds?: boolean): string;
     toString(): string;
     toJSON(): UnixTimestampNumber;
+    toMonthId(): MonthId;
     format(fmt: Intl.DateTimeFormat | LocalTimeFormatter): string;
 }
 /**

package/dist/datetime/localTime.js

@@ -357,6 +357,16 @@ class LocalTime {
             return false;
         return true;
     }
+    /**
+     * Checks if this localTime is older than "now" by X units.
+     *
+     * Example:
+     *
+     * localTime(expirationDate).isOlderThan(5, 'day')
+     */
+    isOlderThan(n, unit) {
+        return this.isBefore(LocalTime.now().add(-n, unit));
+    }
     /**
      * Returns 1 if this > d
      * returns 0 if they are equal
@@ -480,6 +490,9 @@ class LocalTime {
     toJSON() {
         return this.unix();
     }
+    toMonthId() {
+        return this.$date.toISOString().slice(0, 7);
+    }
     format(fmt) {
         if (fmt instanceof Intl.DateTimeFormat) {
             return fmt.format(this.$date);

package/dist/object/object.util.d.ts

@@ -189,3 +189,21 @@ export declare function _has<T extends AnyObject>(obj: T, path: string): boolean
  * Based on: https://github.com/substack/deep-freeze/blob/master/index.js
  */
 export declare function _deepFreeze(o: any): void;
+/**
+ * let target: T = { a: 'a', n: 1}
+ * let source: T = { a: 'a2', b: 'b' }
+ *
+ * _objectAssignExact(target, source)
+ *
+ * Does the same as `target = source`,
+ * except that it mutates the target to make it exactly the same as source,
+ * while keeping the reference to the same object.
+ *
+ * This way it can "propagate deletions".
+ * E.g source doesn't have the `n` property, so it'll be deleted from target.
+ * With normal Object.assign - it'll override the keys that `source` has, but not the
+ * "missing/deleted keys".
+ *
+ * To make mutation extra clear - function returns void (unlike Object.assign).
+ */
+export declare function _objectAssignExact<T extends AnyObject>(target: T, source: T): void;

package/dist/object/object.util.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports._deepFreeze = exports._has = exports._set = exports._get = exports._invertMap = exports._invert = exports._unset = exports._deepTrim = exports._merge = exports._filterEmptyValues = exports._undefinedIfEmpty = exports._deepCopy = exports._objectNullValuesToUndefined = exports._findKeyByValue = exports._mapObject = exports._mapKeys = exports._mapValues = exports._filterObject = exports._filterEmptyArrays = exports._filterUndefinedValues = exports._filterNullishValues = exports._filterFalsyValues = exports._mask = exports._omit = exports._pick = void 0;
+exports._objectAssignExact = exports._deepFreeze = exports._has = exports._set = exports._get = exports._invertMap = exports._invert = exports._unset = exports._deepTrim = exports._merge = exports._filterEmptyValues = exports._undefinedIfEmpty = exports._deepCopy = exports._objectNullValuesToUndefined = exports._findKeyByValue = exports._mapObject = exports._mapKeys = exports._mapValues = exports._filterObject = exports._filterEmptyArrays = exports._filterUndefinedValues = exports._filterNullishValues = exports._filterFalsyValues = exports._mask = exports._omit = exports._pick = void 0;
 const is_util_1 = require("../is.util");
 const types_1 = require("../types");
 /**
@@ -384,3 +384,27 @@ function _deepFreeze(o) {
     });
 }
 exports._deepFreeze = _deepFreeze;
+/**
+ * let target: T = { a: 'a', n: 1}
+ * let source: T = { a: 'a2', b: 'b' }
+ *
+ * _objectAssignExact(target, source)
+ *
+ * Does the same as `target = source`,
+ * except that it mutates the target to make it exactly the same as source,
+ * while keeping the reference to the same object.
+ *
+ * This way it can "propagate deletions".
+ * E.g source doesn't have the `n` property, so it'll be deleted from target.
+ * With normal Object.assign - it'll override the keys that `source` has, but not the
+ * "missing/deleted keys".
+ *
+ * To make mutation extra clear - function returns void (unlike Object.assign).
+ */
+function _objectAssignExact(target, source) {
+    Object.assign(target, source);
+    Object.keys(target)
+        .filter(k => !(k in source))
+        .forEach(k => delete target[k]);
+}
+exports._objectAssignExact = _objectAssignExact;

package/dist/types.d.ts

@@ -154,11 +154,12 @@ export type IsoDateString = string;
  */
 export type IsoDateTimeString = string;
 /**
+ * Identifies the Month.
  * Like IsoDateString, but without the Day token.
  *
  * @example '2023-09'
  */
-export type YearMonthString = string;
+export type MonthId = string;
 /**
  * Interface explicitly states that the value is a Unix timestamp (in seconds).
  *

package/dist-esm/datetime/localDate.js

@@ -176,6 +176,16 @@ export class LocalDate {
             return false;
         return true;
     }
+    /**
+     * Checks if this localDate is older than "today" by X units.
+     *
+     * Example:
+     *
+     * localDate(expirationDate).isOlderThan(5, 'day')
+     */
+    isOlderThan(n, unit) {
+        return this.isBefore(LocalDate.today().add(-n, unit));
+    }
     /**
      * Returns 1 if this > d
      * returns 0 if they are equal
@@ -390,6 +400,9 @@ export class LocalDate {
             String(this.$day).padStart(2, '0'),
         ].join('');
     }
+    toMonthId() {
+        return this.toString().slice(0, 7);
+    }
     // May be not optimal, as LocalTime better suits it
     unix() {
         return Math.floor(this.toDate().valueOf() / 1000);

package/dist-esm/datetime/localTime.js

@@ -355,6 +355,16 @@ export class LocalTime {
             return false;
         return true;
     }
+    /**
+     * Checks if this localTime is older than "now" by X units.
+     *
+     * Example:
+     *
+     * localTime(expirationDate).isOlderThan(5, 'day')
+     */
+    isOlderThan(n, unit) {
+        return this.isBefore(LocalTime.now().add(-n, unit));
+    }
     /**
      * Returns 1 if this > d
      * returns 0 if they are equal
@@ -478,6 +488,9 @@ export class LocalTime {
     toJSON() {
         return this.unix();
     }
+    toMonthId() {
+        return this.$date.toISOString().slice(0, 7);
+    }
     format(fmt) {
         if (fmt instanceof Intl.DateTimeFormat) {
             return fmt.format(this.$date);

package/dist-esm/object/object.util.js

@@ -358,3 +358,26 @@ export function _deepFreeze(o) {
         }
     });
 }
+/**
+ * let target: T = { a: 'a', n: 1}
+ * let source: T = { a: 'a2', b: 'b' }
+ *
+ * _objectAssignExact(target, source)
+ *
+ * Does the same as `target = source`,
+ * except that it mutates the target to make it exactly the same as source,
+ * while keeping the reference to the same object.
+ *
+ * This way it can "propagate deletions".
+ * E.g source doesn't have the `n` property, so it'll be deleted from target.
+ * With normal Object.assign - it'll override the keys that `source` has, but not the
+ * "missing/deleted keys".
+ *
+ * To make mutation extra clear - function returns void (unlike Object.assign).
+ */
+export function _objectAssignExact(target, source) {
+    Object.assign(target, source);
+    Object.keys(target)
+        .filter(k => !(k in source))
+        .forEach(k => delete target[k]);
+}

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@naturalcycles/js-lib",
-  "version": "14.184.0",
+  "version": "14.185.0",
   "scripts": {
     "prepare": "husky install",
     "build-prod": "build-prod-esm-cjs",
-    "docs-serve": "NODE_OPTIONS=--openssl-legacy-provider vuepress dev docs",
-    "docs-build": "NODE_OPTIONS=--openssl-legacy-provider vuepress build docs"
+    "docs-dev": "vitepress dev docs --open",
+    "docs-build": "vitepress build docs",
+    "docs-preview": "vitepress preview docs"
   },
   "dependencies": {
     "tslib": "^2.0.0",
@@ -21,8 +22,8 @@
     "crypto-js": "^4.1.1",
     "jest": "^29.0.0",
     "prettier": "^3.0.0",
-    "vuepress": "^1.7.1",
-    "vuepress-plugin-typescript": "^0.3.1"
+    "vitepress": "^1.0.0-rc.12",
+    "vue": "^3.2.45"
   },
   "resolutions": {
     "expect-type": "0.15.0"

package/src/datetime/localDate.ts

@@ -2,6 +2,7 @@ import { _assert } from '../error/assert'
 import type {
   IsoDateString,
   IsoDateTimeString,
+  MonthId,
   UnixTimestampMillisNumber,
   UnixTimestampNumber,
 } from '../types'
@@ -239,6 +240,17 @@ export class LocalDate {
     return true
   }
 
+  /**
+   * Checks if this localDate is older than "today" by X units.
+   *
+   * Example:
+   *
+   * localDate(expirationDate).isOlderThan(5, 'day')
+   */
+  isOlderThan(n: number, unit: LocalDateUnitStrict): boolean {
+    return this.isBefore(LocalDate.today().add(-n, unit))
+  }
+
   /**
    * Returns 1 if this > d
    * returns 0 if they are equal
@@ -482,6 +494,10 @@ export class LocalDate {
     ].join('')
   }
 
+  toMonthId(): MonthId {
+    return this.toString().slice(0, 7)
+  }
+
   // May be not optimal, as LocalTime better suits it
   unix(): UnixTimestampNumber {
     return Math.floor(this.toDate().valueOf() / 1000)

package/src/datetime/localTime.ts

@@ -3,6 +3,7 @@ import { _ms } from '../time/time.util'
 import type {
   IsoDateString,
   IsoDateTimeString,
+  MonthId,
   UnixTimestampMillisNumber,
   UnixTimestampNumber,
 } from '../types'
@@ -439,6 +440,17 @@ export class LocalTime {
     return true
   }
 
+  /**
+   * Checks if this localTime is older than "now" by X units.
+   *
+   * Example:
+   *
+   * localTime(expirationDate).isOlderThan(5, 'day')
+   */
+  isOlderThan(n: number, unit: LocalTimeUnit): boolean {
+    return this.isBefore(LocalTime.now().add(-n, unit))
+  }
+
   /**
    * Returns 1 if this > d
    * returns 0 if they are equal
@@ -587,6 +599,10 @@ export class LocalTime {
     return this.unix()
   }
 
+  toMonthId(): MonthId {
+    return this.$date.toISOString().slice(0, 7)
+  }
+
   format(fmt: Intl.DateTimeFormat | LocalTimeFormatter): string {
     if (fmt instanceof Intl.DateTimeFormat) {
       return fmt.format(this.$date)

package/src/object/object.util.ts

@@ -419,3 +419,27 @@ export function _deepFreeze(o: any): void {
     }
   })
 }
+
+/**
+ * let target: T = { a: 'a', n: 1}
+ * let source: T = { a: 'a2', b: 'b' }
+ *
+ * _objectAssignExact(target, source)
+ *
+ * Does the same as `target = source`,
+ * except that it mutates the target to make it exactly the same as source,
+ * while keeping the reference to the same object.
+ *
+ * This way it can "propagate deletions".
+ * E.g source doesn't have the `n` property, so it'll be deleted from target.
+ * With normal Object.assign - it'll override the keys that `source` has, but not the
+ * "missing/deleted keys".
+ *
+ * To make mutation extra clear - function returns void (unlike Object.assign).
+ */
+export function _objectAssignExact<T extends AnyObject>(target: T, source: T): void {
+  Object.assign(target, source)
+  Object.keys(target)
+    .filter(k => !(k in source))
+    .forEach(k => delete target[k])
+}

package/src/types.ts

@@ -215,11 +215,12 @@ export type IsoDateString = string
 export type IsoDateTimeString = string
 
 /**
+ * Identifies the Month.
  * Like IsoDateString, but without the Day token.
  *
  * @example '2023-09'
  */
-export type YearMonthString = string
+export type MonthId = string
 
 /**
  * Interface explicitly states that the value is a Unix timestamp (in seconds).