@naturalcycles/js-lib 14.80.0 → 14.80.1

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(): JsonSchemaObjectBuilder<T & BaseDBEntity>;
-    savedDBEntity(): JsonSchemaObjectBuilder<T & SavedDBEntity>;
+    baseDBEntity<ID = string>(idType?: string): JsonSchemaObjectBuilder<T & BaseDBEntity<ID>>;
+    savedDBEntity<ID = 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/json-schema/jsonSchemaBuilder.js

@@ -306,16 +306,16 @@ class JsonSchemaObjectBuilder extends JsonSchemaAnyBuilder {
         Object.assign(this.schema, { additionalProperties });
         return this;
     }
-    baseDBEntity() {
+    baseDBEntity(idType = 'string') {
         Object.assign(this.schema.properties, {
-            id: { type: 'string' },
+            id: { type: idType },
             created: { type: 'number', format: 'unixTimestamp' },
             updated: { type: 'number', format: 'unixTimestamp' },
         });
         return this;
     }
-    savedDBEntity() {
-        return this.baseDBEntity().addRequired(['id', 'created', 'updated']);
+    savedDBEntity(idType = 'string') {
+        return this.baseDBEntity(idType).addRequired(['id', 'created', 'updated']);
     }
     extend(s2) {
         const builder = new JsonSchemaObjectBuilder();

package/dist/json-schema/jsonSchemas.d.ts

@@ -1,3 +1,3 @@
 import { SavedDBEntity } from '../types';
-export declare const baseDBEntityJsonSchema: import("./jsonSchemaBuilder").JsonSchemaObjectBuilder<Partial<SavedDBEntity>>;
-export declare const savedDBEntityJsonSchema: import("./jsonSchemaBuilder").JsonSchemaObjectBuilder<SavedDBEntity>;
+export declare const baseDBEntityJsonSchema: import("./jsonSchemaBuilder").JsonSchemaObjectBuilder<Partial<SavedDBEntity<string>>>;
+export declare const savedDBEntityJsonSchema: import("./jsonSchemaBuilder").JsonSchemaObjectBuilder<SavedDBEntity<string>>;

package/dist/types.d.ts

@@ -127,8 +127,8 @@ export declare type UnixTimestamp = number;
 /**
  * Base interface for any Entity that was saved to DB.
  */
-export interface SavedDBEntity {
-    id: string;
+export interface SavedDBEntity<ID = string> {
+    id: ID;
     /**
      * unixTimestamp of when the entity was first created (in the DB).
      */
@@ -144,9 +144,9 @@ export interface SavedDBEntity {
  * 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 = Partial<SavedDBEntity>;
-export declare type Saved<E> = Merge<E, SavedDBEntity>;
-export declare type Unsaved<E> = Merge<E, BaseDBEntity>;
+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/json-schema/jsonSchemaBuilder.js

@@ -301,16 +301,16 @@ export class JsonSchemaObjectBuilder extends JsonSchemaAnyBuilder {
         Object.assign(this.schema, { additionalProperties });
         return this;
     }
-    baseDBEntity() {
+    baseDBEntity(idType = 'string') {
         Object.assign(this.schema.properties, {
-            id: { type: 'string' },
+            id: { type: idType },
             created: { type: 'number', format: 'unixTimestamp' },
             updated: { type: 'number', format: 'unixTimestamp' },
         });
         return this;
     }
-    savedDBEntity() {
-        return this.baseDBEntity().addRequired(['id', 'created', 'updated']);
+    savedDBEntity(idType = 'string') {
+        return this.baseDBEntity(idType).addRequired(['id', 'created', 'updated']);
     }
     extend(s2) {
         const builder = new JsonSchemaObjectBuilder();

package/package.json

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

package/src/json-schema/jsonSchemaBuilder.ts

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

package/src/types.ts

@@ -169,8 +169,8 @@ export type UnixTimestamp = number
 /**
  * Base interface for any Entity that was saved to DB.
  */
-export interface SavedDBEntity {
-  id: string
+export interface SavedDBEntity<ID = string> {
+  id: ID
 
   /**
    * unixTimestamp of when the entity was first created (in the DB).
@@ -189,10 +189,10 @@ export interface SavedDBEntity {
  * 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 = Partial<SavedDBEntity>
+export type BaseDBEntity<ID = string> = Partial<SavedDBEntity<ID>>
 
-export type Saved<E> = Merge<E, SavedDBEntity>
-export type Unsaved<E> = Merge<E, BaseDBEntity>
+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