@naturalcycles/js-lib 14.109.0 → 14.110.0

package/dist/typeFest.d.ts

@@ -10,6 +10,19 @@ export declare type Primitive = null | undefined | string | number | boolean | s
 export declare type Simplify<T> = {
     [KeyType in keyof T]: T[KeyType];
 };
+/**
+ Returns a boolean for whether the two given types are equal.
+ @link https://github.com/microsoft/TypeScript/issues/27024#issuecomment-421529650
+ @link https://stackoverflow.com/questions/68961864/how-does-the-equals-work-in-typescript/68963796#68963796
+ */
+export declare type IsEqual<T, U> = (<G>() => G extends T ? 1 : 2) extends <G>() => G extends U ? 1 : 2 ? true : false;
+/**
+ * Filter out keys from an object.
+ * Returns `never` if `Exclude` is strictly equal to `Key`.
+ * Returns `never` if `Key` extends `Exclude`.
+ * Returns `Key` otherwise.
+ */
+declare type Filter<KeyType, ExcludeType> = IsEqual<KeyType, ExcludeType> extends true ? never : KeyType extends ExcludeType ? never : KeyType;
 /**
  Create a type from an object type without certain keys.
 
@@ -33,7 +46,9 @@ export declare type Simplify<T> = {
 
  @category Utilities
  */
-export declare type Except<ObjectType, KeysType extends keyof ObjectType> = Pick<ObjectType, Exclude<keyof ObjectType, KeysType>>;
+export declare type Except<ObjectType, KeysType extends keyof ObjectType> = {
+    [KeyType in keyof ObjectType as Filter<KeyType, KeysType>]: ObjectType[KeyType];
+};
 /**
  Convert `object`s, `Map`s, `Set`s, and `Array`s and all of their keys/elements into immutable structures recursively.
 
@@ -82,7 +97,27 @@ interface ReadonlySetDeep<ItemType> extends ReadonlySet<ReadonlyDeep<ItemType>>
 declare type ReadonlyObjectDeep<ObjectType extends object> = {
     readonly [KeyType in keyof ObjectType]: ReadonlyDeep<ObjectType[KeyType]>;
 };
-declare type Merge_<FirstType, SecondType> = Except<FirstType, Extract<keyof FirstType, keyof SecondType>> & SecondType;
+/**
+ * Pick only index signatures from the given object type, leaving out all explicitly defined properties.
+ * This is the counterpart of `OmitIndexSignature`.
+ * When you use a type that will iterate through an object that has indexed keys and explicitly defined keys you end up with a type where only the indexed keys are kept. This is because `keyof` of an indexed type always returns `string | number | symbol`, because every key is possible in that object. With this type, you can save the indexed keys and reinject them later, like in the second example below.
+ */
+export declare type PickIndexSignature<ObjectType> = {
+    [KeyType in keyof ObjectType as {} extends Record<KeyType, unknown> ? KeyType : never]: ObjectType[KeyType];
+};
+/**
+ * Omit any index signatures from the given object type, leaving only explicitly defined properties.
+ * This is the counterpart of `PickIndexSignature`.
+ * Use-cases:
+ * - Remove overly permissive signatures from third-party types.
+ *
+ * This type was taken from this [StackOverflow answer](https://stackoverflow.com/a/68261113/420747).
+ * It relies on the fact that an empty object (`{}`) is assignable to an object with just an index signature, like `Record<string, unknown>`, but not to an object with explicitly defined keys, like `Record<'foo' | 'bar', unknown>`.
+ * (The actual value type, `unknown`, is irrelevant and could be any type. Only the key type matters.)
+ */
+export declare type OmitIndexSignature<ObjectType> = {
+    [KeyType in keyof ObjectType as {} extends Record<KeyType, unknown> ? never : KeyType]: ObjectType[KeyType];
+};
 /**
  Merge two types into a new type. Keys of the second type overrides keys of the first type.
 
@@ -104,7 +139,9 @@ declare type Merge_<FirstType, SecondType> = Except<FirstType, Extract<keyof Fir
 
  @category Utilities
  */
-export declare type Merge<FirstType, SecondType> = Simplify<Merge_<FirstType, SecondType>>;
+export declare type Merge<Destination, Source> = {
+    [Key in keyof OmitIndexSignature<Destination & Source>]: Key extends keyof Source ? Source[Key] : Key extends keyof Destination ? Destination[Key] : never;
+} & PickIndexSignature<Destination & Source>;
 /**
  Create a type that represents either the value or the value wrapped in `PromiseLike`.
 

package/dist/types.d.ts

@@ -1,4 +1,4 @@
-import { Except, Merge, Promisable } from './typeFest';
+import type { Promisable } from './typeFest';
 /**
  * Map from String to String (or <T>).
  *
@@ -7,14 +7,6 @@ import { Except, Merge, Promisable } from './typeFest';
 export interface StringMap<T = string> {
     [k: string | number]: T | undefined;
 }
-/**
- * Object to be passed to pProps to resolve all promises into properties.
- *
- * Alternative: Record<String, Promise<any>>
- */
-export interface PromiseMap {
-    [prop: string]: Promise<any> | undefined;
-}
 /**
  * Convenience shorthand for `Record<string, any>`.
  * Because `object` type is not safe/recommended to be used (e.g discouraged by eslint-typescript due to: https://github.com/microsoft/TypeScript/issues/21732)
@@ -56,10 +48,10 @@ export interface SavedDBEntity<ID extends string | number = string> {
  * When it's known to be saved - `SavedDBEntity` interface can be used instead.
  */
 export declare type BaseDBEntity<ID extends string | number = string> = Partial<SavedDBEntity<ID>>;
-export declare type Saved<T extends Partial<ObjectWithId>> = Merge<T, SavedDBEntity<Exclude<T['id'], undefined>>>;
-export declare type Unsaved<T extends Partial<ObjectWithId>> = Merge<T, BaseDBEntity<Exclude<T['id'], undefined>>>;
-export declare type UnsavedId<T extends Partial<ObjectWithId>> = Except<T, 'id'> & {
-    id: Exclude<T['id'], undefined>;
+export declare type Saved<T extends Partial<ObjectWithId>> = Omit<T, 'id' | 'created' | 'updated'> & SavedDBEntity<NonNullable<T['id']>>;
+export declare type Unsaved<T extends Partial<ObjectWithId>> = Omit<T, 'id' | 'created' | 'updated'> & BaseDBEntity<NonNullable<T['id']>>;
+export declare type UnsavedId<T extends Partial<ObjectWithId>> = Omit<T, 'id'> & {
+    id?: T['id'];
 };
 /**
  * Convenience type shorthand.

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

@@ -1,4 +1,4 @@
-import { AppError, _jsonParseIfPossible, _stringifyAny, } from '..';
+import { AppError, _jsonParseIfPossible, _stringifyAny } from '..';
 /**
  * Useful to ensure that error in `catch (err) { ... }`
  * is indeed an Error (and not e.g `string` or `undefined`).

package/dist-esm/index.js

@@ -2,13 +2,14 @@ export * from './array/array.util';
 export * from './lazy';
 export * from './string/url.util';
 export * from './array/range';
-import { _createPromiseDecorator, } from './decorators/createPromiseDecorator';
+export * from './decorators/createPromiseDecorator';
 export * from './decorators/debounce';
 export * from './decorators/debounce.decorator';
 export * from './decorators/decorator.util';
 export * from './decorators/logMethod.decorator';
 export * from './decorators/memo.decorator';
 export * from './decorators/asyncMemo.decorator';
+export * from './decorators/memo.util';
 export * from './decorators/memoFn';
 export * from './decorators/memoFnAsync';
 export * from './decorators/retry.decorator';
@@ -16,15 +17,18 @@ export * from './decorators/timeout.decorator';
 export * from './error/app.error';
 export * from './error/assert';
 export * from './enum.util';
+export * from './error/error.model';
 export * from './error/error.util';
-import { ErrorMode } from './error/errorMode';
+export * from './error/errorMode';
 export * from './error/http.error';
 export * from './error/try';
-import { _TryCatch, _tryCatch } from './error/tryCatch';
+export * from './error/tryCatch';
 export * from './json-schema/from-data/generateJsonSchemaFromData';
 export * from './json-schema/jsonSchema.cnst';
+export * from './json-schema/jsonSchema.model';
 export * from './json-schema/jsonSchema.util';
-import { jsonSchema, JsonSchemaAnyBuilder, } from './json-schema/jsonSchemaBuilder';
+export * from './json-schema/jsonSchemaBuilder';
+export * from './json-schema/jsonSchemaBuilder';
 export * from './math/math.util';
 export * from './math/sma';
 export * from './number/createDeterministicRandom';
@@ -33,25 +37,26 @@ export * from './object/deepEquals';
 export * from './object/object.util';
 export * from './object/sortObject';
 export * from './object/sortObjectDeep';
-import { AggregatedError } from './promise/AggregatedError';
-import { pDefer } from './promise/pDefer';
+export * from './promise/AggregatedError';
+export * from './promise/pDefer';
 export * from './promise/pDelay';
 export * from './promise/pFilter';
 export * from './promise/pHang';
-import { pMap } from './promise/pMap';
+export * from './promise/pMap';
 export * from './promise/pProps';
-import { pRetry, pRetryFn } from './promise/pRetry';
+export * from './promise/pRetry';
 export * from './promise/pState';
-import { pTimeout, pTimeoutFn } from './promise/pTimeout';
+export * from './promise/pTimeout';
 export * from './string/case';
 export * from './string/json.util';
 export * from './string/string.util';
 export * from './string/readingTime';
 export * from './string/escape';
 export * from './string/pupa';
-import { _stringifyAny } from './string/stringifyAny';
+export * from './string/stringifyAny';
 export * from './time/time.util';
 export * from './is.util';
+export * from './typeFest';
 export * from './types';
 export * from './unit/size.util';
 import { is } from './vendor/is';
@@ -65,5 +70,8 @@ export * from './datetime/localDate';
 export * from './datetime/localTime';
 export * from './datetime/dateInterval';
 export * from './datetime/timeInterval';
-import { ISODayOfWeek, } from './datetime/localTime';
-export { is, _createPromiseDecorator, pMap, ErrorMode, pDefer, AggregatedError, pRetry, pRetryFn, pTimeout, pTimeoutFn, _tryCatch, _TryCatch, _stringifyAny, jsonSchema, JsonSchemaAnyBuilder, };
+export * from './datetime/localDate';
+export * from './datetime/localTime';
+export * from './datetime/dateInterval';
+export * from './datetime/timeInterval';
+export { is };

package/dist-esm/json-schema/from-data/generateJsonSchemaFromData.js

@@ -1,4 +1,4 @@
-import { _stringMapEntries, _uniq, } from '../..';
+import { _stringMapEntries, _uniq } from '../..';
 /**
  * Each row must be an object (current limitation).
  *

package/dist-esm/json-schema/jsonSchemaBuilder.js

@@ -1,5 +1,5 @@
 import { _uniq } from '../array/array.util';
-import { mergeJsonSchemaObjects, _deepCopy, _sortObject, } from '../index';
+import { mergeJsonSchemaObjects, _deepCopy, _sortObject } from '../index';
 import { JSON_SCHEMA_ORDER } from './jsonSchema.cnst';
 /**
  * Fluent (chainable) API to manually create Json Schemas.

package/dist-esm/seq/seq.js

@@ -1,4 +1,4 @@
-import { END, SKIP, } from '../types';
+import { END, SKIP } from '../types';
 /**
  * Inspired by Kotlin Sequences.
  * Similar to arrays, but with lazy evaluation, abortable.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@naturalcycles/js-lib",
-  "version": "14.109.0",
+  "version": "14.110.0",
   "scripts": {
     "prepare": "husky install",
     "build-prod": "build-prod-esm-cjs",
@@ -17,7 +17,7 @@
     "@naturalcycles/time-lib": "^3.5.1",
     "@types/node": "^18.0.0",
     "expect-type": "^0.13.0",
-    "jest": "^28.0.3",
+    "jest": "^29.0.0",
     "prettier": "^2.1.2",
     "rxjs": "^7.0.1",
     "vuepress": "^1.7.1",

package/src/array/array.util.ts

@@ -1,6 +1,6 @@
 import { _isNotNullish } from '../is.util'
-import { RecursiveArray } from '../lodash.types'
-import { FalsyValue, Mapper, Predicate, StringMap } from '../types'
+import type { RecursiveArray } from '../lodash.types'
+import type { FalsyValue, Mapper, Predicate, StringMap } from '../types'
 
 /**
  * Creates an array of elements split into groups the length of size. If collection can’t be split evenly, the

package/src/datetime/dateInterval.ts

@@ -1,4 +1,5 @@
-import { Inclusiveness, LocalDate, LocalDateConfig, LocalDateUnit } from './localDate'
+import type { Inclusiveness, LocalDateConfig, LocalDateUnit } from './localDate'
+import { LocalDate } from './localDate'
 
 export type DateIntervalConfig = DateInterval | DateIntervalString
 export type DateIntervalString = string

package/src/datetime/localDate.ts

@@ -1,5 +1,5 @@
 import { _assert } from '../error/assert'
-import {
+import type {
   IsoDateString,
   IsoDateTimeString,
   UnixTimestampMillisNumber,

package/src/datetime/localTime.ts

@@ -1,12 +1,13 @@
 import { _assert } from '../error/assert'
 import { _ms } from '../time/time.util'
-import {
+import type {
   IsoDateString,
   IsoDateTimeString,
   UnixTimestampMillisNumber,
   UnixTimestampNumber,
 } from '../types'
-import { Inclusiveness, LocalDate } from './localDate'
+import type { Inclusiveness } from './localDate'
+import { LocalDate } from './localDate'
 
 export type LocalTimeUnit = 'year' | 'month' | 'week' | 'day' | 'hour' | 'minute' | 'second'
 

package/src/datetime/timeInterval.ts

@@ -1,6 +1,7 @@
-import { UnixTimestampNumber } from '../types'
-import { Inclusiveness } from './localDate'
-import { LocalTime, LocalTimeConfig } from './localTime'
+import type { UnixTimestampNumber } from '../types'
+import type { Inclusiveness } from './localDate'
+import type { LocalTimeConfig } from './localTime'
+import { LocalTime } from './localTime'
 
 export type TimeIntervalConfig = TimeInterval | TimeIntervalString
 export type TimeIntervalString = string

package/src/decorators/asyncMemo.decorator.ts

@@ -1,8 +1,9 @@
-import { CommonLogger } from '../log/commonLogger'
+import type { CommonLogger } from '../log/commonLogger'
 import { _since } from '../time/time.util'
-import { AnyObject } from '../types'
+import type { AnyObject } from '../types'
 import { _getArgsSignature, _getMethodSignature, _getTargetMethodSignature } from './decorator.util'
-import { AsyncMemoCache, jsonMemoSerializer, MapMemoCache } from './memo.util'
+import type { AsyncMemoCache } from './memo.util'
+import { jsonMemoSerializer, MapMemoCache } from './memo.util'
 
 export interface AsyncMemoOptions {
   /**

package/src/decorators/debounce.decorator.ts

@@ -1,4 +1,5 @@
-import { DebounceOptions, ThrottleOptions, _debounce, _throttle } from './debounce'
+import type { DebounceOptions, ThrottleOptions } from './debounce'
+import { _debounce, _throttle } from './debounce'
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
 export function _Debounce(wait: number, opt: DebounceOptions = {}): MethodDecorator {

package/src/decorators/debounce.ts

@@ -1,4 +1,4 @@
-import { AnyFunction } from '../types'
+import type { AnyFunction } from '../types'
 
 export interface Cancelable {
   cancel(): void

package/src/decorators/decorator.util.ts

@@ -1,4 +1,4 @@
-import { AnyObject, InstanceId } from '../index'
+import type { AnyObject, InstanceId } from '../index'
 
 /**
  * @returns

package/src/decorators/logMethod.decorator.ts

@@ -1,4 +1,5 @@
-import { SimpleMovingAverage, _stringifyAny, CommonLogger, _assert } from '..'
+import type { CommonLogger } from '..'
+import { SimpleMovingAverage, _stringifyAny, _assert } from '..'
 import { _ms } from '../time/time.util'
 import { _getArgsSignature, _getMethodSignature } from './decorator.util'
 

package/src/decorators/memo.decorator.ts

@@ -1,8 +1,9 @@
-import { CommonLogger } from '../log/commonLogger'
+import type { CommonLogger } from '../log/commonLogger'
 import { _since } from '../time/time.util'
-import { AnyObject } from '../types'
+import type { AnyObject } from '../types'
 import { _getArgsSignature, _getMethodSignature, _getTargetMethodSignature } from './decorator.util'
-import { jsonMemoSerializer, MapMemoCache, MemoCache } from './memo.util'
+import type { MemoCache } from './memo.util'
+import { jsonMemoSerializer, MapMemoCache } from './memo.util'
 
 export interface MemoOptions {
   /**

package/src/decorators/memo.util.ts

@@ -1,5 +1,5 @@
 import { _isPrimitive } from '..'
-import { Promisable } from '../typeFest'
+import type { Promisable } from '../typeFest'
 
 export type MemoSerializer = (args: any[]) => any
 

package/src/decorators/memoFn.ts

@@ -1,7 +1,8 @@
 import { _since } from '../time/time.util'
 import { _getArgsSignature } from './decorator.util'
-import { MemoOptions } from './memo.decorator'
-import { jsonMemoSerializer, MapMemoCache, MemoCache } from './memo.util'
+import type { MemoOptions } from './memo.decorator'
+import type { MemoCache } from './memo.util'
+import { jsonMemoSerializer, MapMemoCache } from './memo.util'
 
 export interface MemoizedFunction {
   cache: MemoCache

package/src/decorators/memoFnAsync.ts

@@ -1,7 +1,8 @@
 import { _since } from '../time/time.util'
-import { AsyncMemoOptions } from './asyncMemo.decorator'
+import type { AsyncMemoOptions } from './asyncMemo.decorator'
 import { _getArgsSignature } from './decorator.util'
-import { AsyncMemoCache, jsonMemoSerializer, MapMemoCache } from './memo.util'
+import type { AsyncMemoCache } from './memo.util'
+import { jsonMemoSerializer, MapMemoCache } from './memo.util'
 
 export interface MemoizedAsyncFunction {
   cache: AsyncMemoCache

package/src/decorators/memoSimple.decorator.ts

@@ -11,9 +11,10 @@ Otherwise resorts to JSON.stringify.
 Benchmark shows similar perf for ObjectCache and MapCache.
  */
 
-import { CommonLogger } from '../log/commonLogger'
+import type { CommonLogger } from '../log/commonLogger'
 import { _getArgsSignature, _getTargetMethodSignature } from './decorator.util'
-import { jsonMemoSerializer, MapMemoCache, MemoCache } from './memo.util'
+import type { MemoCache } from './memo.util'
+import { jsonMemoSerializer, MapMemoCache } from './memo.util'
 
 export interface MemoOpts {
   logHit?: boolean

package/src/decorators/retry.decorator.ts

@@ -1,4 +1,5 @@
-import { pRetryFn, PRetryOptions } from '..'
+import type { PRetryOptions } from '..'
+import { pRetryFn } from '..'
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
 export function _Retry(opt: PRetryOptions = {}): MethodDecorator {

package/src/decorators/timeout.decorator.ts

@@ -1,5 +1,6 @@
 import { _assert } from '../error/assert'
-import { pTimeout, PTimeoutOptions } from '../promise/pTimeout'
+import type { PTimeoutOptions } from '../promise/pTimeout'
+import { pTimeout } from '../promise/pTimeout'
 import { _getMethodSignature } from './decorator.util'
 
 // eslint-disable-next-line @typescript-eslint/naming-convention

package/src/enum.util.ts

@@ -1,4 +1,4 @@
-import { NumberEnum, StringEnum } from './types'
+import type { NumberEnum, StringEnum } from './types'
 
 /**
  * Returns all number keys of a number-enum.

package/src/error/app.error.ts

@@ -1,4 +1,4 @@
-import { ErrorData } from './error.model'
+import type { ErrorData } from './error.model'
 
 /**
  * Base class for all our (not system) errors.

package/src/error/assert.ts

@@ -1,4 +1,5 @@
-import { ErrorData, _deepEquals, _stringifyAny } from '..'
+import type { ErrorData } from '..'
+import { _deepEquals, _stringifyAny } from '..'
 import { AppError } from './app.error'
 
 /**

package/src/error/error.util.ts

@@ -1,14 +1,12 @@
-import {
-  AppError,
+import type {
   ErrorData,
   ErrorObject,
   HttpErrorData,
   HttpErrorResponse,
   StringifyAnyOptions,
-  _jsonParseIfPossible,
-  _stringifyAny,
   Class,
 } from '..'
+import { AppError, _jsonParseIfPossible, _stringifyAny } from '..'
 
 /**
  * Useful to ensure that error in `catch (err) { ... }`
@@ -89,11 +87,13 @@ export function _errorToErrorObject<DATA_TYPE extends ErrorData = ErrorData>(
   return obj
 }
 
-export function _errorObjectToAppError<DATA_TYPE>(o: ErrorObject<DATA_TYPE>): AppError<DATA_TYPE> {
+export function _errorObjectToAppError<DATA_TYPE extends ErrorData>(
+  o: ErrorObject<DATA_TYPE>,
+): AppError<DATA_TYPE> {
   return _errorObjectToError(o, AppError)
 }
 
-export function _errorObjectToError<DATA_TYPE, ERROR_TYPE extends Error>(
+export function _errorObjectToError<DATA_TYPE extends ErrorData, ERROR_TYPE extends Error>(
   o: ErrorObject<DATA_TYPE>,
   errorClass: Class<ERROR_TYPE> = Error as any,
 ): ERROR_TYPE {

package/src/error/http.error.ts

@@ -1,5 +1,5 @@
 import { AppError } from './app.error'
-import { HttpErrorData } from './error.model'
+import type { HttpErrorData } from './error.model'
 
 /**
  * Base class for HTTP errors - errors that define HTTP error code.

package/src/error/try.ts

@@ -1,4 +1,4 @@
-import { AnyFunction } from '../types'
+import type { AnyFunction } from '../types'
 import { AppError } from './app.error'
 
 /**

package/src/error/tryCatch.ts

@@ -1,5 +1,6 @@
-import { _anyToError, _since, _stringifyAny, CommonLogger } from '../index'
-import { AnyFunction } from '../types'
+import type { CommonLogger } from '../index'
+import { _anyToError, _since, _stringifyAny } from '../index'
+import type { AnyFunction } from '../types'
 
 export interface TryCatchOptions {
   /**