@naturalcycles/nodejs-lib 15.63.0 → 15.64.0

package/dist/validation/ajv/jsonSchemaBuilder.d.ts

@@ -235,16 +235,21 @@ export declare class JsonSchemaObjectBuilder<IN extends AnyObject, OUT extends A
      * When set, the validation will not strip away properties that are not specified explicitly in the schema.
      */
     allowAdditionalProperties(): this;
-    extend(props: AnyObject): never;
-    extend<IN2 extends AnyObject>(props: {
-        [K in keyof Required<IN2>]-?: JsonSchemaAnyBuilder<any, IN2[K], any>;
-    }): JsonSchemaObjectBuilder<IN & IN2, OUT & IN2, false>;
+    extend<P extends Record<string, JsonSchemaAnyBuilder<any, any, any>>>(props: P): JsonSchemaObjectBuilder<IN & {
+        [K in keyof P as P[K] extends JsonSchemaAnyBuilder<any, any, infer IsOpt> ? IsOpt extends true ? never : K : never]: P[K] extends JsonSchemaAnyBuilder<infer IN2, any, any> ? IN2 : never;
+    } & {
+        [K in keyof P as P[K] extends JsonSchemaAnyBuilder<any, any, infer IsOpt> ? IsOpt extends true ? K : never : never]?: P[K] extends JsonSchemaAnyBuilder<infer IN2, any, any> ? IN2 : never;
+    }, OUT & {
+        [K in keyof P as P[K] extends JsonSchemaAnyBuilder<any, any, infer IsOpt> ? IsOpt extends true ? never : K : never]: P[K] extends JsonSchemaAnyBuilder<any, infer OUT2, any> ? OUT2 : never;
+    } & {
+        [K in keyof P as P[K] extends JsonSchemaAnyBuilder<any, any, infer IsOpt> ? IsOpt extends true ? K : never : never]?: P[K] extends JsonSchemaAnyBuilder<any, infer OUT2, any> ? OUT2 : never;
+    }, false>;
     /**
      * Concatenates another schema to the current schema.
      *
-     * It expects 2 types to be passed in as a generic:
-     * 1) the expected final type,
-     * 2) the type of the passed in schema.
+     * It expects you to use `isOfType<T>()` in the chain,
+     * otherwise the validation will throw. This is to ensure
+     * that the schemas you concatenated match the intended final type.
      *
      * ```ts
      *  interface Foo { foo: string }
@@ -254,15 +259,22 @@ export declare class JsonSchemaObjectBuilder<IN extends AnyObject, OUT extends A
      *  const barSchema = j.object<Bar>({ bar: j.number() })
      *
      *  interface Shu { foo: string, bar: number }
-     *  const shuSchema = fooSchema.concat<Shu, Bar>(barSchema)
+     *  const shuSchema = fooSchema.concat(barSchema).isOfType<Shu>() // important
      * ```
      */
-    concat(other: any): never;
-    concat<NEW_TYPE extends AnyObject, OUT2 extends AnyObject>(other: JsonSchemaObjectBuilder<any, OUT2, any>): ExactMatch<NEW_TYPE, OUT & OUT2> extends true ? JsonSchemaObjectBuilder<NEW_TYPE, NEW_TYPE, false> : never;
+    concat<IN2 extends AnyObject, OUT2 extends AnyObject>(other: JsonSchemaObjectBuilder<IN2, OUT2, any>): JsonSchemaObjectBuilder<IN & IN2, OUT & OUT2, false>;
     /**
      * Extends the current schema with `id`, `created` and `updated` according to NC DB conventions.
      */
-    dbEntity(): never;
+    dbEntity(): JsonSchemaObjectBuilder<IN & {
+        id: string;
+        created: any;
+        updated: any;
+    } & {}, OUT & {
+        id: string;
+        created: any;
+        updated: any;
+    } & {}, false>;
     minProperties(minProperties: number): this;
     maxProperties(maxProperties: number): this;
 }
@@ -292,7 +304,7 @@ export declare class JsonSchemaObjectInferringBuilder<PROPS extends Record<strin
     /**
      * Extends the current schema with `id`, `created` and `updated` according to NC DB conventions.
      */
-    dbEntity(): JsonSchemaObjectInferringBuilder<{ [K in "id" | keyof PROPS | "created" | "updated"]: K extends "id" | "created" | "updated" ? {
+    dbEntity(): JsonSchemaObjectInferringBuilder<{ [K in "id" | "created" | "updated" | keyof PROPS]: K extends "id" | "created" | "updated" ? {
         id: JsonSchemaStringBuilder<string, string, false>;
         created: JsonSchemaNumberBuilder<UnixTimestamp, UnixTimestamp, false>;
         updated: JsonSchemaNumberBuilder<UnixTimestamp, UnixTimestamp, false>;

package/dist/validation/ajv/jsonSchemaBuilder.js

@@ -586,18 +586,35 @@ export class JsonSchemaObjectBuilder extends JsonSchemaAnyBuilder {
         return this.cloneAndUpdateSchema({ additionalProperties: true });
     }
     extend(props) {
-        const clone = this.clone();
+        const newBuilder = new JsonSchemaObjectBuilder();
+        _objectAssign(newBuilder.schema, _deepCopy(this.schema));
         const incomingSchemaBuilder = new JsonSchemaObjectBuilder(props);
-        mergeJsonSchemaObjects(clone.schema, incomingSchemaBuilder.schema);
-        // The incoming object is type-safe because `extend<Foo>()` expects a passed in type that matches the passed in props,
-        // but maybe the current schema was created differently, so that's what decides the typecheckedness.
-        const hasIsOfTypeCheck = this.schema.hasIsOfTypeCheck;
-        _objectAssign(clone.schema, { hasIsOfTypeCheck });
-        return clone;
+        mergeJsonSchemaObjects(newBuilder.schema, incomingSchemaBuilder.schema);
+        _objectAssign(newBuilder.schema, { hasIsOfTypeCheck: false });
+        return newBuilder;
     }
+    /**
+     * Concatenates another schema to the current schema.
+     *
+     * It expects you to use `isOfType<T>()` in the chain,
+     * otherwise the validation will throw. This is to ensure
+     * that the schemas you concatenated match the intended final type.
+     *
+     * ```ts
+     *  interface Foo { foo: string }
+     *  const fooSchema = j.object<Foo>({ foo: j.string() })
+     *
+     *  interface Bar { bar: number }
+     *  const barSchema = j.object<Bar>({ bar: j.number() })
+     *
+     *  interface Shu { foo: string, bar: number }
+     *  const shuSchema = fooSchema.concat(barSchema).isOfType<Shu>() // important
+     * ```
+     */
     concat(other) {
         const clone = this.clone();
         mergeJsonSchemaObjects(clone.schema, other.schema);
+        _objectAssign(clone.schema, { hasIsOfTypeCheck: false });
         return clone;
     }
     /**

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@naturalcycles/nodejs-lib",
   "type": "module",
-  "version": "15.63.0",
+  "version": "15.64.0",
   "dependencies": {
     "@naturalcycles/js-lib": "^15",
     "@types/js-yaml": "^4",

package/src/validation/ajv/jsonSchemaBuilder.ts

@@ -828,32 +828,58 @@ export class JsonSchemaObjectBuilder<
     return this.cloneAndUpdateSchema({ additionalProperties: true })
   }
 
-  extend(props: AnyObject): never
-  extend<IN2 extends AnyObject>(props: {
-    [K in keyof Required<IN2>]-?: JsonSchemaAnyBuilder<any, IN2[K], any>
-  }): JsonSchemaObjectBuilder<IN & IN2, OUT & IN2, false>
-  extend<IN2 extends AnyObject>(props: {
-    [key in keyof IN2]: JsonSchemaAnyBuilder<any, IN2[key], any>
-  }): JsonSchemaObjectBuilder<IN & IN2, OUT & IN2, false> {
-    const clone = this.clone()
+  extend<P extends Record<string, JsonSchemaAnyBuilder<any, any, any>>>(
+    props: P,
+  ): JsonSchemaObjectBuilder<
+    IN & {
+      // required keys
+      [K in keyof P as P[K] extends JsonSchemaAnyBuilder<any, any, infer IsOpt>
+        ? IsOpt extends true
+          ? never
+          : K
+        : never]: P[K] extends JsonSchemaAnyBuilder<infer IN2, any, any> ? IN2 : never
+    } & {
+      // optional keys
+      [K in keyof P as P[K] extends JsonSchemaAnyBuilder<any, any, infer IsOpt>
+        ? IsOpt extends true
+          ? K
+          : never
+        : never]?: P[K] extends JsonSchemaAnyBuilder<infer IN2, any, any> ? IN2 : never
+    },
+    OUT & {
+      // required keys
+      [K in keyof P as P[K] extends JsonSchemaAnyBuilder<any, any, infer IsOpt>
+        ? IsOpt extends true
+          ? never
+          : K
+        : never]: P[K] extends JsonSchemaAnyBuilder<any, infer OUT2, any> ? OUT2 : never
+    } & {
+      // optional keys
+      [K in keyof P as P[K] extends JsonSchemaAnyBuilder<any, any, infer IsOpt>
+        ? IsOpt extends true
+          ? K
+          : never
+        : never]?: P[K] extends JsonSchemaAnyBuilder<any, infer OUT2, any> ? OUT2 : never
+    },
+    false
+  > {
+    const newBuilder = new JsonSchemaObjectBuilder()
+    _objectAssign(newBuilder.schema, _deepCopy(this.schema))
 
-    const incomingSchemaBuilder = new JsonSchemaObjectBuilder<IN2, IN2, false>(props)
-    mergeJsonSchemaObjects(clone.schema as any, incomingSchemaBuilder.schema as any)
+    const incomingSchemaBuilder = new JsonSchemaObjectBuilder(props)
+    mergeJsonSchemaObjects(newBuilder.schema as any, incomingSchemaBuilder.schema as any)
 
-    // The incoming object is type-safe because `extend<Foo>()` expects a passed in type that matches the passed in props,
-    // but maybe the current schema was created differently, so that's what decides the typecheckedness.
-    const hasIsOfTypeCheck = this.schema.hasIsOfTypeCheck
-    _objectAssign(clone.schema, { hasIsOfTypeCheck })
+    _objectAssign(newBuilder.schema, { hasIsOfTypeCheck: false })
 
-    return clone as unknown as JsonSchemaObjectBuilder<IN & IN2, OUT & IN2, false>
+    return newBuilder as any
   }
 
   /**
    * Concatenates another schema to the current schema.
    *
-   * It expects 2 types to be passed in as a generic:
-   * 1) the expected final type,
-   * 2) the type of the passed in schema.
+   * It expects you to use `isOfType<T>()` in the chain,
+   * otherwise the validation will throw. This is to ensure
+   * that the schemas you concatenated match the intended final type.
    *
    * ```ts
    *  interface Foo { foo: string }
@@ -863,19 +889,16 @@ export class JsonSchemaObjectBuilder<
    *  const barSchema = j.object<Bar>({ bar: j.number() })
    *
    *  interface Shu { foo: string, bar: number }
-   *  const shuSchema = fooSchema.concat<Shu, Bar>(barSchema)
+   *  const shuSchema = fooSchema.concat(barSchema).isOfType<Shu>() // important
    * ```
    */
-  concat(other: any): never
-  concat<NEW_TYPE extends AnyObject, OUT2 extends AnyObject>(
-    other: JsonSchemaObjectBuilder<any, OUT2, any>,
-  ): ExactMatch<NEW_TYPE, OUT & OUT2> extends true
-    ? JsonSchemaObjectBuilder<NEW_TYPE, NEW_TYPE, false>
-    : never
-  concat(other: any): any {
+  concat<IN2 extends AnyObject, OUT2 extends AnyObject>(
+    other: JsonSchemaObjectBuilder<IN2, OUT2, any>,
+  ): JsonSchemaObjectBuilder<IN & IN2, OUT & OUT2, false> {
     const clone = this.clone()
-    mergeJsonSchemaObjects(clone.schema as any, other.schema)
-    return clone
+    mergeJsonSchemaObjects(clone.schema as any, other.schema as any)
+    _objectAssign(clone.schema, { hasIsOfTypeCheck: false })
+    return clone as unknown as JsonSchemaObjectBuilder<IN & IN2, OUT & OUT2, false>
   }
 
   /**