@naturalcycles/js-lib 15.24.0 → 15.25.0

package/dist/json-schema/jsonSchema.model.d.ts

@@ -47,7 +47,7 @@ export interface JsonSchemaNot<T = unknown> extends JsonSchemaAny<T> {
 export interface JsonSchemaConst<T = unknown> extends JsonSchemaAny<T> {
     const: T;
 }
-export interface JsonSchemaString extends JsonSchemaAny<string> {
+export interface JsonSchemaString<T extends string = string> extends JsonSchemaAny<T> {
     type: 'string';
     pattern?: string;
     minLength?: number;
@@ -60,7 +60,7 @@ export interface JsonSchemaString extends JsonSchemaAny<string> {
      */
     transform?: ('trim' | 'toLowerCase' | 'toUpperCase')[];
 }
-export interface JsonSchemaNumber extends JsonSchemaAny<number> {
+export interface JsonSchemaNumber<T extends number = number> extends JsonSchemaAny<T> {
     type: 'number' | 'integer';
     format?: string;
     multipleOf?: number;

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

@@ -1,13 +1,13 @@
-import type { AnyObject, BaseDBEntity } from '../types.js';
+import type { AnyObject, BaseDBEntity, IsoDate, UnixTimestamp } from '../types.js';
 import type { JsonSchema, JsonSchemaAllOf, JsonSchemaAny, JsonSchemaArray, JsonSchemaBoolean, JsonSchemaConst, JsonSchemaEnum, JsonSchemaNull, JsonSchemaNumber, JsonSchemaObject, JsonSchemaOneOf, JsonSchemaRef, JsonSchemaString, JsonSchemaTuple } from './jsonSchema.model.js';
 export interface JsonSchemaBuilder<T = unknown> {
     build: () => JsonSchema<T>;
 }
 /**
  * Fluent (chainable) API to manually create Json Schemas.
- * Inspired by Joi
+ * Inspired by Joi and Zod.
  */
-export declare const jsonSchema: {
+export declare const j: {
     any<T = unknown>(): JsonSchemaAnyBuilder<T, JsonSchemaAny<T>>;
     const<T = unknown>(value: T): JsonSchemaAnyBuilder<T, JsonSchemaConst<T>>;
     null(): JsonSchemaAnyBuilder<null, JsonSchemaNull>;
@@ -15,14 +15,14 @@ export declare const jsonSchema: {
     enum<T = unknown>(enumValues: T[]): JsonSchemaAnyBuilder<T, JsonSchemaEnum<T>>;
     boolean(): JsonSchemaAnyBuilder<boolean, JsonSchemaBoolean>;
     buffer(): JsonSchemaAnyBuilder<Buffer<ArrayBufferLike>, JsonSchemaAny<Buffer<ArrayBufferLike>>>;
-    number(): JsonSchemaNumberBuilder;
-    integer(): JsonSchemaNumberBuilder;
-    unixTimestamp(): JsonSchemaNumberBuilder;
-    unixTimestamp2000(): JsonSchemaNumberBuilder;
-    string(): JsonSchemaStringBuilder;
-    dateString(): JsonSchemaStringBuilder;
-    object<T extends AnyObject>(props: { [k in keyof T]: JsonSchemaAnyBuilder<T[k]>; }): JsonSchemaObjectBuilder<T>;
-    rootObject<T extends AnyObject>(props: { [k in keyof T]: JsonSchemaAnyBuilder<T[k]>; }): JsonSchemaObjectBuilder<T>;
+    number<T extends number = number>(): JsonSchemaNumberBuilder<T>;
+    integer<T extends number = number>(): JsonSchemaNumberBuilder<T>;
+    unixTimestamp(): JsonSchemaNumberBuilder<UnixTimestamp>;
+    unixTimestamp2000(): JsonSchemaNumberBuilder<UnixTimestamp>;
+    string<T extends string = string>(): JsonSchemaStringBuilder<T>;
+    isoDate(): JsonSchemaStringBuilder<IsoDate>;
+    object<T extends AnyObject>(props: { [K in keyof T]: JsonSchemaAnyBuilder<T[K]>; }): JsonSchemaObjectBuilder<T>;
+    rootObject<T extends AnyObject>(props: { [K in keyof T]: JsonSchemaAnyBuilder<T[K]>; }): JsonSchemaObjectBuilder<T>;
     array<ITEM = unknown>(itemSchema: JsonSchemaAnyBuilder<ITEM>): JsonSchemaArrayBuilder<ITEM>;
     tuple<T extends any[] = unknown[]>(items: JsonSchemaAnyBuilder[]): JsonSchemaTupleBuilder<T>;
     oneOf<T = unknown>(items: JsonSchemaAnyBuilder[]): JsonSchemaAnyBuilder<T, JsonSchemaOneOf<T>>;
@@ -54,7 +54,7 @@ export declare class JsonSchemaAnyBuilder<T = unknown, SCHEMA_TYPE extends JsonS
     build(): SCHEMA_TYPE;
     clone(): JsonSchemaAnyBuilder<T, SCHEMA_TYPE>;
 }
-export declare class JsonSchemaNumberBuilder extends JsonSchemaAnyBuilder<number, JsonSchemaNumber> {
+export declare class JsonSchemaNumberBuilder<T extends number = number> extends JsonSchemaAnyBuilder<T, JsonSchemaNumber<T>> {
     constructor();
     integer(): this;
     multipleOf(multipleOf: number): this;
@@ -78,7 +78,7 @@ export declare class JsonSchemaNumberBuilder extends JsonSchemaAnyBuilder<number
     utcOffset: () => this;
     utcOffsetHours: () => this;
 }
-export declare class JsonSchemaStringBuilder extends JsonSchemaAnyBuilder<string, JsonSchemaString> {
+export declare class JsonSchemaStringBuilder<T extends string = string> extends JsonSchemaAnyBuilder<T, JsonSchemaString<T>> {
     constructor();
     pattern(pattern: string): this;
     min(minLength: number): this;
@@ -86,7 +86,7 @@ export declare class JsonSchemaStringBuilder extends JsonSchemaAnyBuilder<string
     length(minLength: number, maxLength: number): this;
     format(format: string): this;
     email: () => this;
-    date: () => this;
+    isoDate: () => this;
     url: () => this;
     ipv4: () => this;
     ipv6: () => this;

package/dist/json-schema/jsonSchemaBuilder.js

@@ -5,9 +5,9 @@ import { JSON_SCHEMA_ORDER } from './jsonSchema.cnst.js';
 import { mergeJsonSchemaObjects } from './jsonSchema.util.js';
 /**
  * Fluent (chainable) API to manually create Json Schemas.
- * Inspired by Joi
+ * Inspired by Joi and Zod.
  */
-export const jsonSchema = {
+export const j = {
     any() {
         return new JsonSchemaAnyBuilder({});
     },
@@ -56,8 +56,8 @@ export const jsonSchema = {
     string() {
         return new JsonSchemaStringBuilder();
     },
-    dateString() {
-        return new JsonSchemaStringBuilder().date();
+    isoDate() {
+        return new JsonSchemaStringBuilder().isoDate();
     },
     // email: () => new JsonSchemaStringBuilder().email(),
     // complex types
@@ -204,10 +204,10 @@ export class JsonSchemaNumberBuilder extends JsonSchemaAnyBuilder {
     int64 = () => this.format('int64');
     float = () => this.format('float');
     double = () => this.format('double');
-    unixTimestamp = () => this.format('unixTimestamp');
-    unixTimestamp2000 = () => this.format('unixTimestamp2000');
-    unixTimestampMillis = () => this.format('unixTimestampMillis');
-    unixTimestampMillis2000 = () => this.format('unixTimestampMillis2000');
+    unixTimestamp = () => this.format('unixTimestamp').description('UnixTimestamp');
+    unixTimestamp2000 = () => this.format('unixTimestamp2000').description('UnixTimestamp2000');
+    unixTimestampMillis = () => this.format('unixTimestampMillis').description('UnixTimestampMillis');
+    unixTimestampMillis2000 = () => this.format('unixTimestampMillis2000').description('UnixTimestampMillis2000');
     utcOffset = () => this.format('utcOffset');
     utcOffsetHours = () => this.format('utcOffsetHours');
 }
@@ -238,7 +238,7 @@ export class JsonSchemaStringBuilder extends JsonSchemaAnyBuilder {
         return this;
     }
     email = () => this.format('email');
-    date = () => this.format('date');
+    isoDate = () => this.format('date').description('IsoDate'); // todo: make it custom isoDate instead
     url = () => this.format('url');
     ipv4 = () => this.format('ipv4');
     ipv6 = () => this.format('ipv6');

package/dist/json-schema/jsonSchemas.js

@@ -1,6 +1,6 @@
-import { jsonSchema } from './jsonSchemaBuilder.js';
-export const baseDBEntityJsonSchema = jsonSchema.object({
-    id: jsonSchema.string(),
-    created: jsonSchema.unixTimestamp2000(),
-    updated: jsonSchema.unixTimestamp2000(),
+import { j } from './jsonSchemaBuilder.js';
+export const baseDBEntityJsonSchema = j.object({
+    id: j.string(),
+    created: j.unixTimestamp2000(),
+    updated: j.unixTimestamp2000(),
 });

package/dist/zod/zod.shared.schemas.d.ts

@@ -1,7 +1,7 @@
 import type { ZodString } from 'zod';
 import { z } from 'zod';
 import type { IANATimezone, IsoDate, UnixTimestamp, UnixTimestampMillis } from '../types.js';
-type ZodBranded<T, B> = T & Record<'_zod', Record<'output', number & B>>;
+type ZodBranded<T, B> = T & Record<'_zod', Record<'output', B>>;
 export type ZodBrandedString<B> = ZodBranded<z.ZodString, B>;
 export type ZodBrandedInt<B> = ZodBranded<z.ZodInt, B>;
 export type ZodBrandedNumber<B> = ZodBranded<z.ZodNumber, B>;

package/dist/zod/zod.shared.schemas.js

@@ -44,8 +44,8 @@ function isoDate() {
         .string()
         .refine(v => {
         return /^\d{4}-\d{2}-\d{2}$/.test(v);
-    }, 'Must be an IsoDateString')
-        .describe('IsoDateString');
+    }, 'Must be a YYYY-MM-DD string')
+        .describe('IsoDate');
 }
 function email() {
     return z.email().describe('Email');

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@naturalcycles/js-lib",
   "type": "module",
-  "version": "15.24.0",
+  "version": "15.25.0",
   "dependencies": {
     "tslib": "^2",
     "zod": "^4"

package/src/json-schema/jsonSchema.model.ts

@@ -80,7 +80,7 @@ export interface JsonSchemaConst<T = unknown> extends JsonSchemaAny<T> {
   const: T // literal type
 }
 
-export interface JsonSchemaString extends JsonSchemaAny<string> {
+export interface JsonSchemaString<T extends string = string> extends JsonSchemaAny<T> {
   type: 'string'
   pattern?: string
   minLength?: number
@@ -96,7 +96,7 @@ export interface JsonSchemaString extends JsonSchemaAny<string> {
   transform?: ('trim' | 'toLowerCase' | 'toUpperCase')[]
 }
 
-export interface JsonSchemaNumber extends JsonSchemaAny<number> {
+export interface JsonSchemaNumber<T extends number = number> extends JsonSchemaAny<T> {
   type: 'number' | 'integer'
   format?: string
   multipleOf?: number

package/src/json-schema/jsonSchemaBuilder.ts

@@ -1,7 +1,7 @@
 import { _uniq } from '../array/array.util.js'
 import { _deepCopy } from '../object/object.util.js'
 import { _sortObject } from '../object/sortObject.js'
-import type { AnyObject, BaseDBEntity } from '../types.js'
+import type { AnyObject, BaseDBEntity, IsoDate, UnixTimestamp } from '../types.js'
 import { JSON_SCHEMA_ORDER } from './jsonSchema.cnst.js'
 import type {
   JsonSchema,
@@ -29,9 +29,9 @@ export interface JsonSchemaBuilder<T = unknown> {
 
 /**
  * Fluent (chainable) API to manually create Json Schemas.
- * Inspired by Joi
+ * Inspired by Joi and Zod.
  */
-export const jsonSchema = {
+export const j = {
   any<T = unknown>() {
     return new JsonSchemaAnyBuilder<T, JsonSchemaAny<T>>({})
   },
@@ -65,34 +65,34 @@ export const jsonSchema = {
   },
 
   // number types
-  number() {
-    return new JsonSchemaNumberBuilder()
+  number<T extends number = number>() {
+    return new JsonSchemaNumberBuilder<T>()
   },
-  integer() {
-    return new JsonSchemaNumberBuilder().integer()
+  integer<T extends number = number>() {
+    return new JsonSchemaNumberBuilder<T>().integer()
   },
   unixTimestamp() {
-    return new JsonSchemaNumberBuilder().unixTimestamp()
+    return new JsonSchemaNumberBuilder<UnixTimestamp>().unixTimestamp()
   },
   unixTimestamp2000() {
-    return new JsonSchemaNumberBuilder().unixTimestamp2000()
+    return new JsonSchemaNumberBuilder<UnixTimestamp>().unixTimestamp2000()
   },
   // string types
-  string() {
-    return new JsonSchemaStringBuilder()
+  string<T extends string = string>() {
+    return new JsonSchemaStringBuilder<T>()
   },
-  dateString() {
-    return new JsonSchemaStringBuilder().date()
+  isoDate() {
+    return new JsonSchemaStringBuilder<IsoDate>().isoDate()
   },
   // email: () => new JsonSchemaStringBuilder().email(),
   // complex types
   object<T extends AnyObject>(props: {
-    [k in keyof T]: JsonSchemaAnyBuilder<T[k]>
+    [K in keyof T]: JsonSchemaAnyBuilder<T[K]>
   }) {
     return new JsonSchemaObjectBuilder<T>().addProperties(props)
   },
   rootObject<T extends AnyObject>(props: {
-    [k in keyof T]: JsonSchemaAnyBuilder<T[k]>
+    [K in keyof T]: JsonSchemaAnyBuilder<T[K]>
   }) {
     return new JsonSchemaObjectBuilder<T>().addProperties(props).$schemaDraft7()
   },
@@ -203,7 +203,10 @@ export class JsonSchemaAnyBuilder<T = unknown, SCHEMA_TYPE extends JsonSchema<T>
   }
 }
 
-export class JsonSchemaNumberBuilder extends JsonSchemaAnyBuilder<number, JsonSchemaNumber> {
+export class JsonSchemaNumberBuilder<T extends number = number> extends JsonSchemaAnyBuilder<
+  T,
+  JsonSchemaNumber<T>
+> {
   constructor() {
     super({
       type: 'number',
@@ -257,15 +260,22 @@ export class JsonSchemaNumberBuilder extends JsonSchemaAnyBuilder<number, JsonSc
   int64 = (): this => this.format('int64')
   float = (): this => this.format('float')
   double = (): this => this.format('double')
-  unixTimestamp = (): this => this.format('unixTimestamp')
-  unixTimestamp2000 = (): this => this.format('unixTimestamp2000')
-  unixTimestampMillis = (): this => this.format('unixTimestampMillis')
-  unixTimestampMillis2000 = (): this => this.format('unixTimestampMillis2000')
+  unixTimestamp = (): this => this.format('unixTimestamp').description('UnixTimestamp')
+  unixTimestamp2000 = (): this => this.format('unixTimestamp2000').description('UnixTimestamp2000')
+  unixTimestampMillis = (): this =>
+    this.format('unixTimestampMillis').description('UnixTimestampMillis')
+
+  unixTimestampMillis2000 = (): this =>
+    this.format('unixTimestampMillis2000').description('UnixTimestampMillis2000')
+
   utcOffset = (): this => this.format('utcOffset')
   utcOffsetHours = (): this => this.format('utcOffsetHours')
 }
 
-export class JsonSchemaStringBuilder extends JsonSchemaAnyBuilder<string, JsonSchemaString> {
+export class JsonSchemaStringBuilder<T extends string = string> extends JsonSchemaAnyBuilder<
+  T,
+  JsonSchemaString<T>
+> {
   constructor() {
     super({
       type: 'string',
@@ -298,7 +308,7 @@ export class JsonSchemaStringBuilder extends JsonSchemaAnyBuilder<string, JsonSc
   }
 
   email = (): this => this.format('email')
-  date = (): this => this.format('date')
+  isoDate = (): this => this.format('date').description('IsoDate') // todo: make it custom isoDate instead
   url = (): this => this.format('url')
   ipv4 = (): this => this.format('ipv4')
   ipv6 = (): this => this.format('ipv6')

package/src/json-schema/jsonSchemas.ts

@@ -1,8 +1,8 @@
 import type { BaseDBEntity } from '../types.js'
-import { jsonSchema } from './jsonSchemaBuilder.js'
+import { j } from './jsonSchemaBuilder.js'
 
-export const baseDBEntityJsonSchema = jsonSchema.object<BaseDBEntity>({
-  id: jsonSchema.string(),
-  created: jsonSchema.unixTimestamp2000(),
-  updated: jsonSchema.unixTimestamp2000(),
+export const baseDBEntityJsonSchema = j.object<BaseDBEntity>({
+  id: j.string(),
+  created: j.unixTimestamp2000(),
+  updated: j.unixTimestamp2000(),
 })

package/src/zod/zod.shared.schemas.ts

@@ -2,7 +2,7 @@ import type { ZodString } from 'zod'
 import { z } from 'zod'
 import type { IANATimezone, IsoDate, UnixTimestamp, UnixTimestampMillis } from '../types.js'
 
-type ZodBranded<T, B> = T & Record<'_zod', Record<'output', number & B>>
+type ZodBranded<T, B> = T & Record<'_zod', Record<'output', B>>
 export type ZodBrandedString<B> = ZodBranded<z.ZodString, B>
 export type ZodBrandedInt<B> = ZodBranded<z.ZodInt, B>
 export type ZodBrandedNumber<B> = ZodBranded<z.ZodNumber, B>
@@ -58,8 +58,8 @@ function isoDate(): ZodBrandedString<IsoDate> {
     .string()
     .refine(v => {
       return /^\d{4}-\d{2}-\d{2}$/.test(v)
-    }, 'Must be an IsoDateString')
-    .describe('IsoDateString') as ZodBrandedString<IsoDate>
+    }, 'Must be a YYYY-MM-DD string')
+    .describe('IsoDate') as ZodBrandedString<IsoDate>
 }
 
 function email(): z.ZodEmail {