@naturalcycles/js-lib 14.97.1 → 14.98.2

package/dist/index.d.ts

@@ -51,7 +51,7 @@ export * from './string/string.util';
 import { JsonStringifyFunction, StringifyAnyOptions, _stringifyAny } from './string/stringifyAny';
 export * from './time/time.util';
 import { Class, ConditionalExcept, ConditionalPick, Merge, Promisable, ReadonlyDeep, Simplify } from './typeFest';
-import { AsyncMapper, AsyncPredicate, BaseDBEntity, CreatedUpdated, CreatedUpdatedId, ObjectWithId, AnyObjectWithId, Saved, Unsaved, BatchResult, InstanceId, IsoDate, IsoDateString, IsoDateTimeString, KeyValueTuple, Mapper, ObjectMapper, ObjectPredicate, Predicate, PromiseMap, AnyObject, AnyFunction, Reviver, SavedDBEntity, StringMap, UnixTimestampNumber, UnixTimestamp, Integer, ValueOf, ValuesOf, AbortableMapper, AbortableAsyncPredicate, AbortableAsyncMapper, AbortablePredicate, END, SKIP, _noop, _objectKeys, _passNothingPredicate, _passthroughMapper, _passthroughPredicate, _passUndefinedMapper, _stringMapEntries, _stringMapValues } from './types';
+import { AsyncMapper, AsyncPredicate, BaseDBEntity, CreatedUpdated, CreatedUpdatedId, ObjectWithId, AnyObjectWithId, Saved, Unsaved, UnsavedId, BatchResult, InstanceId, IsoDate, IsoDateString, IsoDateTimeString, KeyValueTuple, Mapper, ObjectMapper, ObjectPredicate, Predicate, PromiseMap, AnyObject, AnyFunction, Reviver, SavedDBEntity, StringMap, UnixTimestampNumber, UnixTimestamp, Integer, ValueOf, ValuesOf, AbortableMapper, AbortableAsyncPredicate, AbortableAsyncMapper, AbortablePredicate, END, SKIP, _noop, _objectKeys, _passNothingPredicate, _passthroughMapper, _passthroughPredicate, _passUndefinedMapper, _stringMapEntries, _stringMapValues } from './types';
 export * from './unit/size.util';
 import { is } from './vendor/is';
 import { CommonLogLevel, CommonLogFunction, CommonLogger, commonLoggerMinLevel, commonLoggerNoop, commonLogLevelNumber, commonLoggerPipe, commonLoggerPrefix, CommonLogWithLevelFunction, commonLoggerCreate } from './log/commonLogger';
@@ -68,5 +68,5 @@ import { LocalDateConfig, LocalDateUnit, Inclusiveness } from './datetime/localD
 import { LocalTimeConfig, LocalTimeUnit, LocalTimeComponents } from './datetime/localTime';
 import { DateIntervalConfig, DateIntervalString } from './datetime/dateInterval';
 import { TimeIntervalConfig, TimeIntervalString } from './datetime/timeInterval';
-export type { DateIntervalConfig, DateIntervalString, TimeIntervalConfig, TimeIntervalString, 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, IsoDateString, IsoDateTimeString, Reviver, PMapOptions, Mapper, AsyncMapper, Predicate, AsyncPredicate, BatchResult, DeferredPromise, PRetryOptions, PTimeoutOptions, TryCatchOptions, StringifyAnyOptions, JsonStringifyFunction, Merge, ReadonlyDeep, Promisable, Simplify, ConditionalPick, ConditionalExcept, Class, UnixTimestampNumber, 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 type { DateIntervalConfig, DateIntervalString, TimeIntervalConfig, TimeIntervalString, 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, IsoDateString, IsoDateTimeString, Reviver, PMapOptions, Mapper, AsyncMapper, Predicate, AsyncPredicate, BatchResult, DeferredPromise, PRetryOptions, PTimeoutOptions, TryCatchOptions, StringifyAnyOptions, JsonStringifyFunction, Merge, ReadonlyDeep, Promisable, Simplify, ConditionalPick, ConditionalExcept, Class, UnixTimestampNumber, UnixTimestamp, Integer, BaseDBEntity, SavedDBEntity, Saved, Unsaved, UnsavedId, 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/json-schema/jsonSchemaBuilder.d.ts

@@ -113,8 +113,8 @@ export declare class JsonSchemaObjectBuilder<T extends AnyObject> extends JsonSc
     minProps(minProperties: number): this;
     maxProps(maxProperties: number): this;
     additionalProps(additionalProperties: boolean): this;
-    baseDBEntity<ID = string>(idType?: string): JsonSchemaObjectBuilder<T & BaseDBEntity<ID>>;
-    savedDBEntity<ID = string>(idType?: string): JsonSchemaObjectBuilder<T & SavedDBEntity<ID>>;
+    baseDBEntity<ID extends string | number = string>(idType?: string): JsonSchemaObjectBuilder<T & BaseDBEntity<ID>>;
+    savedDBEntity<ID extends string | number = string>(idType?: string): JsonSchemaObjectBuilder<T & SavedDBEntity<ID>>;
     extend<T2 extends AnyObject>(s2: JsonSchemaObjectBuilder<T2>): JsonSchemaObjectBuilder<T & T2>;
 }
 export declare class JsonSchemaArrayBuilder<ITEM> extends JsonSchemaAnyBuilder<ITEM[], JsonSchemaArray<ITEM>> {

package/dist/math/math.util.d.ts

@@ -7,6 +7,10 @@
  * // 2.5
  */
 export declare function _average(values: number[]): number;
+/**
+ * Same as _average, but safely returns null if input array is empty or nullish.
+ */
+export declare function _averageOrNull(values: number[] | undefined | null): number | null;
 /**
  * valuesArray and weightsArray length is expected to be the same.
  */

package/dist/math/math.util.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports._median = exports._percentiles = exports._percentile = exports._averageWeighted = exports._average = void 0;
+exports._median = exports._percentiles = exports._percentile = exports._averageWeighted = exports._averageOrNull = exports._average = void 0;
 const number_util_1 = require("../number/number.util");
 /**
  * @returns Average of the array of numbers
@@ -14,6 +14,13 @@ function _average(values) {
     return values.reduce((a, b) => a + b) / values.length;
 }
 exports._average = _average;
+/**
+ * Same as _average, but safely returns null if input array is empty or nullish.
+ */
+function _averageOrNull(values) {
+    return values?.length ? values.reduce((a, b) => a + b) / values.length : null;
+}
+exports._averageOrNull = _averageOrNull;
 /**
  * valuesArray and weightsArray length is expected to be the same.
  */

package/dist/math/sma.d.ts

@@ -14,6 +14,10 @@ export declare class SimpleMovingAverage {
      * Returns 0 (not undefined) for empty data.
      */
     avg: number;
+    /**
+     * Push new value.
+     * Returns newly calculated average (using newly pushed value).
+     */
     push(n: number): number;
     private calculateAvg;
 }

package/dist/math/sma.js

@@ -18,6 +18,10 @@ class SimpleMovingAverage {
          */
         this.avg = 0;
     }
+    /**
+     * Push new value.
+     * Returns newly calculated average (using newly pushed value).
+     */
     push(n) {
         this.data[this.nextIndex] = n;
         this.nextIndex =

package/dist/types.d.ts

@@ -1,11 +1,11 @@
-import { Merge, Promisable } from './typeFest';
+import { Except, Merge, Promisable } from './typeFest';
 /**
  * Map from String to String (or <T>).
  *
  * Alternative: Record<string, T | undefined>
  */
 export interface StringMap<T = string> {
-    [k: string]: T | undefined;
+    [k: string | number]: T | undefined;
 }
 /**
  * Object to be passed to pProps to resolve all promises into properties.
@@ -24,14 +24,40 @@ export interface CreatedUpdated {
     created: number;
     updated: number;
 }
-export interface CreatedUpdatedId<ID = string> extends CreatedUpdated {
+export interface CreatedUpdatedId<ID extends string | number = string | number> extends CreatedUpdated {
     id: ID;
 }
-export interface ObjectWithId<ID = string> {
+export interface ObjectWithId<ID extends string | number = string | number> {
     id: ID;
 }
-export interface AnyObjectWithId<ID = string> extends AnyObject, ObjectWithId<ID> {
+export interface AnyObjectWithId<ID extends string | number = string | number> extends AnyObject, ObjectWithId<ID> {
 }
+/**
+ * Base interface for any Entity that was saved to DB.
+ */
+export interface SavedDBEntity<ID extends string | number = string> {
+    id: ID;
+    /**
+     * unixTimestamp of when the entity was first created (in the DB).
+     */
+    created: UnixTimestampNumber;
+    /**
+     * unixTimestamp of when the entity was last updated (in the DB).
+     */
+    updated: UnixTimestampNumber;
+}
+/**
+ * Base interface for any Entity that can be saved to DB.
+ * This interface fits when entity was NOT YET saved to DB,
+ * hence `id`, `created` and `updated` fields CAN BE undefined (yet).
+ * 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>;
+};
 /**
  * Convenience type shorthand.
  * Because `Function` type is discouraged by eslint.
@@ -136,29 +162,6 @@ export declare type UnixTimestamp = number;
  * Same as `number`, but with semantic meaning that it's an Integer.
  */
 export declare type Integer = number;
-/**
- * Base interface for any Entity that was saved to DB.
- */
-export interface SavedDBEntity<ID = string> {
-    id: ID;
-    /**
-     * unixTimestamp of when the entity was first created (in the DB).
-     */
-    created: UnixTimestampNumber;
-    /**
-     * unixTimestamp of when the entity was last updated (in the DB).
-     */
-    updated: UnixTimestampNumber;
-}
-/**
- * Base interface for any Entity that can be saved to DB.
- * This interface fits when entity was NOT YET saved to DB,
- * hence `id`, `created` and `updated` fields CAN BE undefined (yet).
- * When it's known to be saved - `SavedDBEntity` interface can be used instead.
- */
-export declare type BaseDBEntity<ID = string> = Partial<SavedDBEntity<ID>>;
-export declare type Saved<E, ID = string> = Merge<E, SavedDBEntity<ID>>;
-export declare type Unsaved<E, ID = string> = Merge<E, BaseDBEntity<ID>>;
 /**
  * Named type for JSON.parse / JSON.stringify second argument
  */

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

@@ -10,6 +10,12 @@ import { _sortNumbers } from '../number/number.util';
 export function _average(values) {
     return values.reduce((a, b) => a + b) / values.length;
 }
+/**
+ * Same as _average, but safely returns null if input array is empty or nullish.
+ */
+export function _averageOrNull(values) {
+    return (values === null || values === void 0 ? void 0 : values.length) ? values.reduce((a, b) => a + b) / values.length : null;
+}
 /**
  * valuesArray and weightsArray length is expected to be the same.
  */

package/dist-esm/math/sma.js

@@ -15,6 +15,10 @@ export class SimpleMovingAverage {
          */
         this.avg = 0;
     }
+    /**
+     * Push new value.
+     * Returns newly calculated average (using newly pushed value).
+     */
     push(n) {
         this.data[this.nextIndex] = n;
         this.nextIndex =

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@naturalcycles/js-lib",
-  "version": "14.97.1",
+  "version": "14.98.2",
   "scripts": {
     "prepare": "husky install",
     "build-prod": "build-prod-esm-cjs",

package/src/index.ts

@@ -102,6 +102,7 @@ import {
   AnyObjectWithId,
   Saved,
   Unsaved,
+  UnsavedId,
   BatchResult,
   InstanceId,
   IsoDate,
@@ -232,6 +233,7 @@ export type {
   SavedDBEntity,
   Saved,
   Unsaved,
+  UnsavedId,
   CreatedUpdated,
   CreatedUpdatedId,
   ObjectWithId,

package/src/json-schema/jsonSchemaBuilder.ts

@@ -365,7 +365,9 @@ export class JsonSchemaObjectBuilder<T extends AnyObject> extends JsonSchemaAnyB
     return this
   }
 
-  baseDBEntity<ID = string>(idType = 'string'): JsonSchemaObjectBuilder<T & BaseDBEntity<ID>> {
+  baseDBEntity<ID extends string | number = string>(
+    idType = 'string',
+  ): JsonSchemaObjectBuilder<T & BaseDBEntity<ID>> {
     Object.assign(this.schema.properties, {
       id: { type: idType },
       created: { type: 'number', format: 'unixTimestamp' },
@@ -375,7 +377,9 @@ export class JsonSchemaObjectBuilder<T extends AnyObject> extends JsonSchemaAnyB
     return this
   }
 
-  savedDBEntity<ID = string>(idType = 'string'): JsonSchemaObjectBuilder<T & SavedDBEntity<ID>> {
+  savedDBEntity<ID extends string | number = string>(
+    idType = 'string',
+  ): JsonSchemaObjectBuilder<T & SavedDBEntity<ID>> {
     return this.baseDBEntity(idType).addRequired(['id', 'created', 'updated']) as any
   }
 

package/src/math/math.util.ts

@@ -12,6 +12,13 @@ export function _average(values: number[]): number {
   return values.reduce((a, b) => a + b) / values.length
 }
 
+/**
+ * Same as _average, but safely returns null if input array is empty or nullish.
+ */
+export function _averageOrNull(values: number[] | undefined | null): number | null {
+  return values?.length ? values.reduce((a, b) => a + b) / values.length : null
+}
+
 /**
  * valuesArray and weightsArray length is expected to be the same.
  */

package/src/math/sma.ts

@@ -15,6 +15,10 @@ export class SimpleMovingAverage {
    */
   avg = 0
 
+  /**
+   * Push new value.
+   * Returns newly calculated average (using newly pushed value).
+   */
   push(n: number): number {
     this.data[this.nextIndex] = n
     this.nextIndex =

package/src/types.ts

@@ -1,4 +1,4 @@
-import { Merge, Promisable } from './typeFest'
+import { Except, Merge, Promisable } from './typeFest'
 
 /**
  * Map from String to String (or <T>).
@@ -6,7 +6,7 @@ import { Merge, Promisable } from './typeFest'
  * Alternative: Record<string, T | undefined>
  */
 export interface StringMap<T = string> {
-  [k: string]: T | undefined
+  [k: string | number]: T | undefined
 }
 
 /**
@@ -29,15 +29,57 @@ export interface CreatedUpdated {
   updated: number
 }
 
-export interface CreatedUpdatedId<ID = string> extends CreatedUpdated {
+export interface CreatedUpdatedId<ID extends string | number = string | number>
+  extends CreatedUpdated {
   id: ID
 }
 
-export interface ObjectWithId<ID = string> {
+export interface ObjectWithId<ID extends string | number = string | number> {
   id: ID
 }
 
-export interface AnyObjectWithId<ID = string> extends AnyObject, ObjectWithId<ID> {}
+export interface AnyObjectWithId<ID extends string | number = string | number>
+  extends AnyObject,
+    ObjectWithId<ID> {}
+
+/**
+ * Base interface for any Entity that was saved to DB.
+ */
+export interface SavedDBEntity<ID extends string | number = string> {
+  id: ID
+
+  /**
+   * unixTimestamp of when the entity was first created (in the DB).
+   */
+  created: UnixTimestampNumber
+
+  /**
+   * unixTimestamp of when the entity was last updated (in the DB).
+   */
+  updated: UnixTimestampNumber
+}
+
+/**
+ * Base interface for any Entity that can be saved to DB.
+ * This interface fits when entity was NOT YET saved to DB,
+ * hence `id`, `created` and `updated` fields CAN BE undefined (yet).
+ * When it's known to be saved - `SavedDBEntity` interface can be used instead.
+ */
+export type BaseDBEntity<ID extends string | number = string> = Partial<SavedDBEntity<ID>>
+
+export type Saved<T extends Partial<ObjectWithId>> = Merge<
+  T,
+  SavedDBEntity<Exclude<T['id'], undefined>>
+>
+
+export type Unsaved<T extends Partial<ObjectWithId>> = Merge<
+  T,
+  BaseDBEntity<Exclude<T['id'], undefined>>
+>
+
+export type UnsavedId<T extends Partial<ObjectWithId>> = Except<T, 'id'> & {
+  id: Exclude<T['id'], undefined>
+}
 
 /**
  * Convenience type shorthand.
@@ -181,34 +223,6 @@ export type UnixTimestamp = number
  */
 export type Integer = number
 
-/**
- * Base interface for any Entity that was saved to DB.
- */
-export interface SavedDBEntity<ID = string> {
-  id: ID
-
-  /**
-   * unixTimestamp of when the entity was first created (in the DB).
-   */
-  created: UnixTimestampNumber
-
-  /**
-   * unixTimestamp of when the entity was last updated (in the DB).
-   */
-  updated: UnixTimestampNumber
-}
-
-/**
- * Base interface for any Entity that can be saved to DB.
- * This interface fits when entity was NOT YET saved to DB,
- * hence `id`, `created` and `updated` fields CAN BE undefined (yet).
- * When it's known to be saved - `SavedDBEntity` interface can be used instead.
- */
-export type BaseDBEntity<ID = string> = Partial<SavedDBEntity<ID>>
-
-export type Saved<E, ID = string> = Merge<E, SavedDBEntity<ID>>
-export type Unsaved<E, ID = string> = Merge<E, BaseDBEntity<ID>>
-
 /**
  * Named type for JSON.parse / JSON.stringify second argument
  */