@naturalcycles/js-lib 15.33.3 → 15.34.0

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

@@ -21,9 +21,9 @@ export declare const j: {
     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>;
+    object: typeof object;
     rootObject<T extends AnyObject>(props: { [K in keyof T]: JsonSchemaAnyBuilder<T[K]>; }): JsonSchemaObjectBuilder<T>;
-    array<ITEM = unknown>(itemSchema: JsonSchemaAnyBuilder<ITEM>): JsonSchemaArrayBuilder<ITEM>;
+    array<T extends JsonSchemaAnyBuilder<any>>(itemSchema: T): JsonSchemaArrayBuilder<T["infer"]>;
     tuple<T extends any[] = unknown[]>(items: JsonSchemaAnyBuilder[]): JsonSchemaTupleBuilder<T>;
     oneOf<T = unknown>(items: JsonSchemaAnyBuilder[]): JsonSchemaAnyBuilder<T, JsonSchemaOneOf<T>>;
     allOf<T = unknown>(items: JsonSchemaAnyBuilder[]): JsonSchemaAnyBuilder<T, JsonSchemaAllOf<T>>;
@@ -46,7 +46,9 @@ export declare class JsonSchemaAnyBuilder<T = unknown, SCHEMA_TYPE extends JsonS
     oneOf(schemas: JsonSchema[]): this;
     allOf(schemas: JsonSchema[]): this;
     instanceof(of: string): this;
-    optional(optional?: boolean): this;
+    optional(): JsonSchemaAnyBuilder<T | undefined, JsonSchema<T | undefined>>;
+    optional(optional: true): JsonSchemaAnyBuilder<T | undefined, JsonSchema<T | undefined>>;
+    optional(optional: false): JsonSchemaAnyBuilder<Exclude<T, undefined>, JsonSchema<Exclude<T, undefined>>>;
     /**
      * Produces a "clean schema object" without methods.
      * Same as if it would be JSON.stringified.
@@ -81,6 +83,7 @@ export declare class JsonSchemaNumberBuilder<T extends number = number> extends
     unixTimestampMillis2000: () => this;
     utcOffset: () => this;
     utcOffsetHours: () => this;
+    branded<B extends number>(): JsonSchemaNumberBuilder<B>;
 }
 export declare class JsonSchemaStringBuilder<T extends string = string> extends JsonSchemaAnyBuilder<T, JsonSchemaString<T>> {
     constructor();
@@ -104,6 +107,7 @@ export declare class JsonSchemaStringBuilder<T extends string = string> extends
     trim: (trim?: boolean) => this;
     toLowerCase: (toLowerCase?: boolean) => this;
     toUpperCase: (toUpperCase?: boolean) => this;
+    branded<B extends string>(): JsonSchemaStringBuilder<B>;
     private transformModify;
 }
 export declare class JsonSchemaObjectBuilder<T extends AnyObject> extends JsonSchemaAnyBuilder<T, JsonSchemaObject<T>> {
@@ -131,3 +135,10 @@ export declare class JsonSchemaArrayBuilder<ITEM> extends JsonSchemaAnyBuilder<I
 export declare class JsonSchemaTupleBuilder<T extends any[]> extends JsonSchemaAnyBuilder<T, JsonSchemaTuple<T>> {
     constructor(items: JsonSchemaBuilder[]);
 }
+declare function object<P extends Record<string, JsonSchemaAnyBuilder<any, any>>>(props: P): JsonSchemaObjectBuilder<{
+    [K in keyof P]: P[K] extends JsonSchemaAnyBuilder<infer U, any> ? U : never;
+}>;
+declare function object<T extends AnyObject>(props: {
+    [K in keyof T]: JsonSchemaAnyBuilder<T[K]>;
+}): JsonSchemaObjectBuilder<T>;
+export {};

package/dist/json-schema/jsonSchemaBuilder.js

@@ -61,9 +61,7 @@ export const j = {
     },
     // email: () => new JsonSchemaStringBuilder().email(),
     // complex types
-    object(props) {
-        return new JsonSchemaObjectBuilder().addProperties(props);
-    },
+    object,
     rootObject(props) {
         return new JsonSchemaObjectBuilder().addProperties(props).$schemaDraft7();
     },
@@ -214,6 +212,9 @@ export class JsonSchemaNumberBuilder extends JsonSchemaAnyBuilder {
     unixTimestampMillis2000 = () => this.format('unixTimestampMillis2000').description('UnixTimestampMillis2000');
     utcOffset = () => this.format('utcOffset');
     utcOffsetHours = () => this.format('utcOffsetHours');
+    branded() {
+        return this;
+    }
 }
 export class JsonSchemaStringBuilder extends JsonSchemaAnyBuilder {
     constructor() {
@@ -256,6 +257,9 @@ export class JsonSchemaStringBuilder extends JsonSchemaAnyBuilder {
     trim = (trim = true) => this.transformModify('trim', trim);
     toLowerCase = (toLowerCase = true) => this.transformModify('toLowerCase', toLowerCase);
     toUpperCase = (toUpperCase = true) => this.transformModify('toUpperCase', toUpperCase);
+    branded() {
+        return this;
+    }
     transformModify(t, add) {
         if (add) {
             this.schema.transform = _uniq([...(this.schema.transform || []), t]);
@@ -357,3 +361,6 @@ export class JsonSchemaTupleBuilder extends JsonSchemaAnyBuilder {
         });
     }
 }
+function object(props) {
+    return new JsonSchemaObjectBuilder().addProperties(props);
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@naturalcycles/js-lib",
   "type": "module",
-  "version": "15.33.3",
+  "version": "15.34.0",
   "dependencies": {
     "tslib": "^2",
     "undici": "^7",

package/src/json-schema/jsonSchemaBuilder.ts

@@ -86,18 +86,14 @@ export const j = {
   },
   // email: () => new JsonSchemaStringBuilder().email(),
   // complex types
-  object<T extends AnyObject>(props: {
-    [K in keyof T]: JsonSchemaAnyBuilder<T[K]>
-  }) {
-    return new JsonSchemaObjectBuilder<T>().addProperties(props)
-  },
+  object,
   rootObject<T extends AnyObject>(props: {
     [K in keyof T]: JsonSchemaAnyBuilder<T[K]>
   }) {
     return new JsonSchemaObjectBuilder<T>().addProperties(props).$schemaDraft7()
   },
-  array<ITEM = unknown>(itemSchema: JsonSchemaAnyBuilder<ITEM>) {
-    return new JsonSchemaArrayBuilder<ITEM>(itemSchema)
+  array<T extends JsonSchemaAnyBuilder<any>>(itemSchema: T) {
+    return new JsonSchemaArrayBuilder<T['infer']>(itemSchema)
   },
   tuple<T extends any[] = unknown[]>(items: JsonSchemaAnyBuilder[]) {
     return new JsonSchemaTupleBuilder<T>(items)
@@ -181,7 +177,12 @@ export class JsonSchemaAnyBuilder<T = unknown, SCHEMA_TYPE extends JsonSchema<T>
     return this
   }
 
-  optional(optional = true): this {
+  optional(): JsonSchemaAnyBuilder<T | undefined, JsonSchema<T | undefined>>
+  optional(optional: true): JsonSchemaAnyBuilder<T | undefined, JsonSchema<T | undefined>>
+  optional(
+    optional: false,
+  ): JsonSchemaAnyBuilder<Exclude<T, undefined>, JsonSchema<Exclude<T, undefined>>>
+  optional(optional = true): JsonSchemaAnyBuilder<any, JsonSchema<any>> {
     if (optional) {
       this.schema.optionalField = true
     } else {
@@ -275,6 +276,10 @@ export class JsonSchemaNumberBuilder<T extends number = number> extends JsonSche
 
   utcOffset = (): this => this.format('utcOffset')
   utcOffsetHours = (): this => this.format('utcOffsetHours')
+
+  branded<B extends number>(): JsonSchemaNumberBuilder<B> {
+    return this as unknown as JsonSchemaNumberBuilder<B>
+  }
 }
 
 export class JsonSchemaStringBuilder<T extends string = string> extends JsonSchemaAnyBuilder<
@@ -329,6 +334,10 @@ export class JsonSchemaStringBuilder<T extends string = string> extends JsonSche
   toLowerCase = (toLowerCase = true): this => this.transformModify('toLowerCase', toLowerCase)
   toUpperCase = (toUpperCase = true): this => this.transformModify('toUpperCase', toUpperCase)
 
+  branded<B extends string>(): JsonSchemaStringBuilder<B> {
+    return this as unknown as JsonSchemaStringBuilder<B>
+  }
+
   private transformModify(t: 'trim' | 'toLowerCase' | 'toUpperCase', add: boolean): this {
     if (add) {
       this.schema.transform = _uniq([...(this.schema.transform || []), t])
@@ -457,3 +466,21 @@ export class JsonSchemaTupleBuilder<T extends any[]> extends JsonSchemaAnyBuilde
     })
   }
 }
+
+// TODO and Notes
+// The issue is that in `j` we mix two approaches:
+// 1) the builder driven approach
+// 2) the type driven approach.
+
+function object<P extends Record<string, JsonSchemaAnyBuilder<any, any>>>(
+  props: P,
+): JsonSchemaObjectBuilder<{
+  [K in keyof P]: P[K] extends JsonSchemaAnyBuilder<infer U, any> ? U : never
+}>
+function object<T extends AnyObject>(props: {
+  [K in keyof T]: JsonSchemaAnyBuilder<T[K]>
+}): JsonSchemaObjectBuilder<T>
+
+function object(props: any): any {
+  return new JsonSchemaObjectBuilder<any>().addProperties(props)
+}