@naturalcycles/nodejs-lib 15.39.0 → 15.41.0

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

@@ -4,7 +4,8 @@ export declare const j: {
     string(): JsonSchemaStringBuilder<string, string, false>;
     number(): JsonSchemaNumberBuilder<number, number, false>;
     boolean(): JsonSchemaBooleanBuilder<boolean, boolean, false>;
-    object<P extends Record<string, JsonSchemaAnyBuilder<any, any, any>>>(props: P): JsonSchemaObjectBuilder<P, false>;
+    object: typeof object;
+    objectInfer<P extends Record<string, JsonSchemaAnyBuilder<any, any, any>>>(props: P): JsonSchemaObjectInferringBuilder<P, false>;
     array<IN, OUT, Opt>(itemSchema: JsonSchemaAnyBuilder<IN, OUT, Opt>): JsonSchemaArrayBuilder<IN, OUT, Opt>;
     set<IN, OUT, Opt>(itemSchema: JsonSchemaAnyBuilder<IN, OUT, Opt>): JsonSchemaSet2Builder<IN, OUT, Opt>;
     buffer(): JsonSchemaBufferBuilder;
@@ -47,6 +48,11 @@ export declare class JsonSchemaAnyBuilder<IN, OUT, Opt> {
      */
     build(): JsonSchema<IN, OUT>;
     clone(): JsonSchemaAnyBuilder<IN, OUT, Opt>;
+    /**
+     * @deprecated
+     * The usage of this function is discouraged as it defeats the purpose of having type-safe validation.
+     */
+    castAs<T>(): JsonSchemaAnyBuilder<T, T, Opt>;
     /**
      * @experimental
      */
@@ -113,7 +119,20 @@ export declare class JsonSchemaNumberBuilder<IN extends number = number, OUT = I
 export declare class JsonSchemaBooleanBuilder<IN extends boolean = boolean, OUT = IN, Opt extends boolean = false> extends JsonSchemaAnyBuilder<IN, OUT, Opt> {
     constructor();
 }
-export declare class JsonSchemaObjectBuilder<PROPS extends Record<string, JsonSchemaAnyBuilder<any, any, any>>, Opt extends boolean = false> extends JsonSchemaAnyBuilder<Expand<{
+export declare class JsonSchemaObjectBuilder<IN extends AnyObject, OUT extends AnyObject, Opt extends boolean = false> extends JsonSchemaAnyBuilder<IN, OUT, Opt> {
+    constructor(props?: AnyObject);
+    addProperties(props: AnyObject): this;
+    /**
+     * When set, the validation will not strip away properties that are not specified explicitly in the schema.
+     */
+    allowAdditionalProperties(): this;
+    extend<IN2 extends AnyObject>(props: AnyObject): JsonSchemaObjectBuilder<IN & IN2, OUT & IN2, Opt>;
+    /**
+     * Extends the current schema with `id`, `created` and `updated` according to NC DB conventions.
+     */
+    dbEntity(): JsonSchemaObjectBuilder<any, any, Opt>;
+}
+export declare class JsonSchemaObjectInferringBuilder<PROPS extends Record<string, JsonSchemaAnyBuilder<any, any, any>>, Opt extends boolean = false> extends JsonSchemaAnyBuilder<Expand<{
     [K in keyof PROPS as PROPS[K] extends JsonSchemaAnyBuilder<any, any, infer IsOpt> ? IsOpt extends true ? never : K : never]: PROPS[K] extends JsonSchemaAnyBuilder<infer IN, any, any> ? IN : never;
 } & {
     [K in keyof PROPS as PROPS[K] extends JsonSchemaAnyBuilder<any, any, infer IsOpt> ? IsOpt extends true ? K : never : never]?: PROPS[K] extends JsonSchemaAnyBuilder<infer IN, any, any> ? IN : never;
@@ -124,13 +143,17 @@ export declare class JsonSchemaObjectBuilder<PROPS extends Record<string, JsonSc
 }>, Opt> {
     constructor(props?: PROPS);
     addProperties(props: PROPS): this;
-    extend<NEW_PROPS extends Record<string, JsonSchemaAnyBuilder<any, any, any>>>(props: NEW_PROPS): JsonSchemaObjectBuilder<{
+    /**
+     * When set, the validation will not strip away properties that are not specified explicitly in the schema.
+     */
+    allowAdditionalProperties(): this;
+    extend<NEW_PROPS extends Record<string, JsonSchemaAnyBuilder<any, any, any>>>(props: NEW_PROPS): JsonSchemaObjectInferringBuilder<{
         [K in keyof PROPS | keyof NEW_PROPS]: K extends keyof NEW_PROPS ? NEW_PROPS[K] : K extends keyof PROPS ? PROPS[K] : never;
     }, Opt>;
     /**
      * Extends the current schema with `id`, `created` and `updated` according to NC DB conventions.
      */
-    dbEntity(): JsonSchemaObjectBuilder<{ [K in keyof PROPS | "id" | "created" | "updated"]: K extends "id" | "created" | "updated" ? {
+    dbEntity(): JsonSchemaObjectInferringBuilder<{ [K in keyof PROPS | "id" | "created" | "updated"]: K extends "id" | "created" | "updated" ? {
         id: JsonSchemaStringBuilder<string, string, false>;
         created: JsonSchemaNumberBuilder<UnixTimestamp, UnixTimestamp, false>;
         updated: JsonSchemaNumberBuilder<UnixTimestamp, UnixTimestamp, false>;
@@ -209,6 +232,10 @@ export interface JsonSchema<IN = unknown, OUT = IN> {
     errorMessages?: StringMap<string>;
     hasIsOfTypeCheck?: boolean;
 }
+declare function object(props: AnyObject): never;
+declare function object<IN extends AnyObject>(props: {
+    [key in keyof IN]: JsonSchemaAnyBuilder<any, IN[key], any>;
+}): JsonSchemaObjectBuilder<IN, IN, false>;
 type Expand<T> = T extends infer O ? {
     [K in keyof O]: O[K];
 } : never;

package/dist/validation/ajv/jsonSchemaBuilder.js

@@ -16,8 +16,9 @@ export const j = {
     boolean() {
         return new JsonSchemaBooleanBuilder();
     },
-    object(props) {
-        return new JsonSchemaObjectBuilder(props);
+    object,
+    objectInfer(props) {
+        return new JsonSchemaObjectInferringBuilder(props);
     },
     array(itemSchema) {
         return new JsonSchemaArrayBuilder(itemSchema);
@@ -150,6 +151,13 @@ export class JsonSchemaAnyBuilder {
     clone() {
         return new JsonSchemaAnyBuilder(_deepCopy(this.schema));
     }
+    /**
+     * @deprecated
+     * The usage of this function is discouraged as it defeats the purpose of having type-safe validation.
+     */
+    castAs() {
+        return this;
+    }
     /**
      * @experimental
      */
@@ -363,6 +371,7 @@ export class JsonSchemaObjectBuilder extends JsonSchemaAnyBuilder {
             properties: {},
             required: [],
             additionalProperties: false,
+            hasIsOfTypeCheck: true,
         });
         if (props)
             this.addProperties(props);
@@ -384,6 +393,13 @@ export class JsonSchemaObjectBuilder extends JsonSchemaAnyBuilder {
         this.schema.required = _uniq(required).sort();
         return this;
     }
+    /**
+     * When set, the validation will not strip away properties that are not specified explicitly in the schema.
+     */
+    allowAdditionalProperties() {
+        Object.assign(this.schema, { additionalProperties: true });
+        return this;
+    }
     extend(props) {
         const newBuilder = new JsonSchemaObjectBuilder();
         Object.assign(newBuilder.schema, _deepCopy(this.schema));
@@ -403,6 +419,60 @@ export class JsonSchemaObjectBuilder extends JsonSchemaAnyBuilder {
         });
     }
 }
+export class JsonSchemaObjectInferringBuilder extends JsonSchemaAnyBuilder {
+    constructor(props) {
+        super({
+            type: 'object',
+            properties: {},
+            required: [],
+            additionalProperties: false,
+        });
+        if (props)
+            this.addProperties(props);
+    }
+    addProperties(props) {
+        const properties = {};
+        const required = [];
+        for (const [key, builder] of Object.entries(props)) {
+            const schema = builder.build();
+            if (!schema.optionalField) {
+                required.push(key);
+            }
+            else {
+                schema.optionalField = undefined;
+            }
+            properties[key] = schema;
+        }
+        this.schema.properties = properties;
+        this.schema.required = _uniq(required).sort();
+        return this;
+    }
+    /**
+     * When set, the validation will not strip away properties that are not specified explicitly in the schema.
+     */
+    allowAdditionalProperties() {
+        Object.assign(this.schema, { additionalProperties: true });
+        return this;
+    }
+    extend(props) {
+        const newBuilder = new JsonSchemaObjectInferringBuilder();
+        Object.assign(newBuilder.schema, _deepCopy(this.schema));
+        const incomingSchemaBuilder = new JsonSchemaObjectInferringBuilder(props);
+        mergeJsonSchemaObjects(newBuilder.schema, incomingSchemaBuilder.schema);
+        return newBuilder;
+    }
+    /**
+     * Extends the current schema with `id`, `created` and `updated` according to NC DB conventions.
+     */
+    // eslint-disable-next-line @typescript-eslint/explicit-function-return-type, @typescript-eslint/explicit-module-boundary-types
+    dbEntity() {
+        return this.extend({
+            id: j.string(),
+            created: j.number().unixTimestamp2000(),
+            updated: j.number().unixTimestamp2000(),
+        });
+    }
+}
 export class JsonSchemaArrayBuilder extends JsonSchemaAnyBuilder {
     constructor(itemsSchema) {
         super({
@@ -451,3 +521,6 @@ export class JsonSchemaEnumBuilder extends JsonSchemaAnyBuilder {
         super({ enum: enumValues });
     }
 }
+function object(props) {
+    return new JsonSchemaObjectBuilder(props);
+}

package/package.json

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

package/src/validation/ajv/jsonSchemaBuilder.ts

@@ -37,10 +37,12 @@ export const j = {
     return new JsonSchemaBooleanBuilder()
   },
 
-  object<P extends Record<string, JsonSchemaAnyBuilder<any, any, any>>>(
+  object,
+
+  objectInfer<P extends Record<string, JsonSchemaAnyBuilder<any, any, any>>>(
     props: P,
-  ): JsonSchemaObjectBuilder<P, false> {
-    return new JsonSchemaObjectBuilder<P, false>(props)
+  ): JsonSchemaObjectInferringBuilder<P, false> {
+    return new JsonSchemaObjectInferringBuilder<P, false>(props)
   },
 
   array<IN, OUT, Opt>(
@@ -213,6 +215,14 @@ export class JsonSchemaAnyBuilder<IN, OUT, Opt> {
     return new JsonSchemaAnyBuilder<IN, OUT, Opt>(_deepCopy(this.schema))
   }
 
+  /**
+   * @deprecated
+   * The usage of this function is discouraged as it defeats the purpose of having type-safe validation.
+   */
+  castAs<T>(): JsonSchemaAnyBuilder<T, T, Opt> {
+    return this as unknown as JsonSchemaAnyBuilder<T, T, Opt>
+  }
+
   /**
    * @experimental
    */
@@ -489,6 +499,76 @@ export class JsonSchemaBooleanBuilder<
 }
 
 export class JsonSchemaObjectBuilder<
+  IN extends AnyObject,
+  OUT extends AnyObject,
+  Opt extends boolean = false,
+> extends JsonSchemaAnyBuilder<IN, OUT, Opt> {
+  constructor(props?: AnyObject) {
+    super({
+      type: 'object',
+      properties: {},
+      required: [],
+      additionalProperties: false,
+      hasIsOfTypeCheck: true,
+    })
+
+    if (props) this.addProperties(props)
+  }
+
+  addProperties(props: AnyObject): this {
+    const properties: Record<string, JsonSchema> = {}
+    const required: string[] = []
+
+    for (const [key, builder] of Object.entries(props)) {
+      const schema = builder.build()
+      if (!schema.optionalField) {
+        required.push(key)
+      } else {
+        schema.optionalField = undefined
+      }
+      properties[key] = schema
+    }
+
+    this.schema.properties = properties
+    this.schema.required = _uniq(required).sort()
+
+    return this
+  }
+
+  /**
+   * When set, the validation will not strip away properties that are not specified explicitly in the schema.
+   */
+  allowAdditionalProperties(): this {
+    Object.assign(this.schema, { additionalProperties: true })
+    return this
+  }
+
+  extend<IN2 extends AnyObject>(
+    props: AnyObject,
+  ): JsonSchemaObjectBuilder<IN & IN2, OUT & IN2, Opt> {
+    const newBuilder = new JsonSchemaObjectBuilder<IN & IN2, OUT & IN2, Opt>()
+    Object.assign(newBuilder.schema, _deepCopy(this.schema))
+
+    const incomingSchemaBuilder = new JsonSchemaObjectBuilder<IN2, IN2, false>(props)
+    mergeJsonSchemaObjects(newBuilder.schema as any, incomingSchemaBuilder.schema as any)
+
+    return newBuilder
+  }
+
+  /**
+   * Extends the current schema with `id`, `created` and `updated` according to NC DB conventions.
+   */
+  // eslint-disable-next-line @typescript-eslint/explicit-function-return-type, @typescript-eslint/explicit-module-boundary-types
+  dbEntity() {
+    return this.extend({
+      id: j.string(),
+      created: j.number().unixTimestamp2000(),
+      updated: j.number().unixTimestamp2000(),
+    })
+  }
+}
+
+export class JsonSchemaObjectInferringBuilder<
   PROPS extends Record<string, JsonSchemaAnyBuilder<any, any, any>>,
   Opt extends boolean = false,
 > extends JsonSchemaAnyBuilder<
@@ -555,9 +635,17 @@ export class JsonSchemaObjectBuilder<
     return this
   }
 
+  /**
+   * When set, the validation will not strip away properties that are not specified explicitly in the schema.
+   */
+  allowAdditionalProperties(): this {
+    Object.assign(this.schema, { additionalProperties: true })
+    return this
+  }
+
   extend<NEW_PROPS extends Record<string, JsonSchemaAnyBuilder<any, any, any>>>(
     props: NEW_PROPS,
-  ): JsonSchemaObjectBuilder<
+  ): JsonSchemaObjectInferringBuilder<
     {
       [K in keyof PROPS | keyof NEW_PROPS]: K extends keyof NEW_PROPS
         ? NEW_PROPS[K]
@@ -567,13 +655,13 @@ export class JsonSchemaObjectBuilder<
     },
     Opt
   > {
-    const newBuilder = new JsonSchemaObjectBuilder<PROPS, Opt>()
+    const newBuilder = new JsonSchemaObjectInferringBuilder<PROPS, Opt>()
     Object.assign(newBuilder.schema, _deepCopy(this.schema))
 
-    const incomingSchemaBuilder = new JsonSchemaObjectBuilder<NEW_PROPS, false>(props)
+    const incomingSchemaBuilder = new JsonSchemaObjectInferringBuilder<NEW_PROPS, false>(props)
     mergeJsonSchemaObjects(newBuilder.schema as any, incomingSchemaBuilder.schema as any)
 
-    return newBuilder as JsonSchemaObjectBuilder<
+    return newBuilder as JsonSchemaObjectInferringBuilder<
       {
         [K in keyof PROPS | keyof NEW_PROPS]: K extends keyof NEW_PROPS
           ? NEW_PROPS[K]
@@ -734,6 +822,17 @@ export interface JsonSchema<IN = unknown, OUT = IN> {
   hasIsOfTypeCheck?: boolean
 }
 
+function object(props: AnyObject): never
+function object<IN extends AnyObject>(props: {
+  [key in keyof IN]: JsonSchemaAnyBuilder<any, IN[key], any>
+}): JsonSchemaObjectBuilder<IN, IN, false>
+
+function object<IN extends AnyObject>(props: {
+  [key in keyof IN]: JsonSchemaAnyBuilder<any, IN[key], any>
+}): JsonSchemaObjectBuilder<IN, IN, false> {
+  return new JsonSchemaObjectBuilder<IN, IN, false>(props)
+}
+
 type Expand<T> = T extends infer O ? { [K in keyof O]: O[K] } : never
 
 type ExactMatch<A, B> =