@naturalcycles/nodejs-lib 15.55.0 → 15.56.1

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

@@ -9,10 +9,7 @@ export declare const j: {
         infer: typeof objectInfer;
         any(): JsonSchemaObjectBuilder<AnyObject, AnyObject, false>;
         stringMap<S extends JsonSchemaTerminal<any, any, any>>(schema: S): JsonSchemaObjectBuilder<StringMap<SchemaIn<S>>, StringMap<SchemaOut<S>>>;
-        /**
-         * Builds the object schema with the indicated `keys` and uses the `schema` for their validation.
-         */
-        withEnumKeys<const T extends readonly (string | number)[] | StringEnum | NumberEnum, S extends JsonSchemaTerminal<any, any, any>, K extends string | number = EnumKeyUnion<T>>(keys: T, schema: S): JsonSchemaObjectBuilder<Record<K, SchemaIn<S>>, Record<K, SchemaOut<S>>>;
+        withEnumKeys: typeof withEnumKeys;
     };
     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>;
@@ -337,6 +334,18 @@ declare function objectDbEntity<IN extends BaseDBEntity & AnyObject, EXTRA_KEYS
 } : {
     updated: BuilderFor<IN['updated']>;
 })): JsonSchemaObjectBuilder<IN, IN, false>;
+/**
+ * Builds the object schema with the indicated `keys` and uses the `schema` for their validation.
+ */
+declare function withEnumKeys<const T extends readonly (string | number)[] | StringEnum | NumberEnum, S extends JsonSchemaAnyBuilder<any, any, any>, K extends string | number = EnumKeyUnion<T>, Opt extends boolean = SchemaOpt<S>>(keys: T, schema: S): JsonSchemaObjectBuilder<Opt extends true ? {
+    [P in K]?: SchemaIn<S>;
+} : {
+    [P in K]: SchemaIn<S>;
+}, Opt extends true ? {
+    [P in K]?: SchemaOut<S>;
+} : {
+    [P in K]: SchemaOut<S>;
+}, false>;
 type Expand<T> = T extends infer O ? {
     [K in keyof O]: O[K];
 } : never;
@@ -365,4 +374,5 @@ interface JsonBuilderRuleOpt {
 type EnumKeyUnion<T> = T extends readonly (infer U)[] ? U : T extends StringEnum | NumberEnum ? T[keyof T] : never;
 type SchemaIn<S> = S extends JsonSchemaAnyBuilder<infer IN, any, any> ? IN : never;
 type SchemaOut<S> = S extends JsonSchemaAnyBuilder<any, infer OUT, any> ? OUT : never;
+type SchemaOpt<S> = S extends JsonSchemaAnyBuilder<any, any, infer Opt> ? Opt : false;
 export {};

package/dist/validation/ajv/jsonSchemaBuilder.js

@@ -35,30 +35,7 @@ export const j = {
                 },
             });
         },
-        /**
-         * Builds the object schema with the indicated `keys` and uses the `schema` for their validation.
-         */
-        withEnumKeys(keys, schema) {
-            let enumValues;
-            if (Array.isArray(keys)) {
-                _assert(isEveryItemPrimitive(keys), 'Every item in the key list should be string, number or symbol');
-                enumValues = keys;
-            }
-            else if (typeof keys === 'object') {
-                const enumType = getEnumType(keys);
-                _assert(enumType === 'NumberEnum' || enumType === 'StringEnum', 'The key list should be StringEnum or NumberEnum');
-                if (enumType === 'NumberEnum') {
-                    enumValues = _numberEnumValues(keys);
-                }
-                else if (enumType === 'StringEnum') {
-                    enumValues = _stringEnumValues(keys);
-                }
-            }
-            _assert(enumValues, 'The key list should be an array of values, NumberEnum or a StringEnum');
-            const typedValues = enumValues;
-            const props = Object.fromEntries(typedValues.map(key => [key, schema]));
-            return new JsonSchemaObjectBuilder(props, { hasIsOfTypeCheck: false });
-        },
+        withEnumKeys,
     }),
     array(itemSchema) {
         return new JsonSchemaArrayBuilder(itemSchema);
@@ -241,8 +218,16 @@ export class JsonSchemaStringBuilder extends JsonSchemaAnyBuilder {
      * due to how mutability works in Ajv.
      */
     optional(optionalValues) {
-        _objectAssign(this.schema, { optionalValues });
-        return super.optional();
+        if (!optionalValues) {
+            return super.optional();
+        }
+        const newBuilder = new JsonSchemaStringBuilder().optional();
+        const alternativesSchema = j.enum(optionalValues);
+        Object.assign(newBuilder.getSchema(), {
+            anyOf: [this.build(), alternativesSchema.build()],
+            optionalValues,
+        });
+        return newBuilder;
     }
     regex(pattern, opt) {
         return this.pattern(pattern.source, opt);
@@ -403,8 +388,16 @@ export class JsonSchemaNumberBuilder extends JsonSchemaAnyBuilder {
      * due to how mutability works in Ajv.
      */
     optional(optionalValues) {
-        _objectAssign(this.schema, { optionalValues });
-        return super.optional();
+        if (!optionalValues) {
+            return super.optional();
+        }
+        const newBuilder = new JsonSchemaNumberBuilder().optional();
+        const alternativesSchema = j.enum(optionalValues);
+        Object.assign(newBuilder.getSchema(), {
+            anyOf: [this.build(), alternativesSchema.build()],
+            optionalValues,
+        });
+        return newBuilder;
     }
     integer() {
         _objectAssign(this.schema, { type: 'integer' });
@@ -511,10 +504,16 @@ export class JsonSchemaBooleanBuilder extends JsonSchemaAnyBuilder {
      * due to how mutability works in Ajv.
      */
     optional(optionalValue) {
-        if (typeof optionalValue !== 'undefined') {
-            _objectAssign(this.schema, { optionalValues: [optionalValue] });
+        if (typeof optionalValue === 'undefined') {
+            return super.optional();
         }
-        return super.optional();
+        const newBuilder = new JsonSchemaBooleanBuilder().optional();
+        const alternativesSchema = j.enum([optionalValue]);
+        Object.assign(newBuilder.getSchema(), {
+            anyOf: [this.build(), alternativesSchema.build()],
+            optionalValues: [optionalValue],
+        });
+        return newBuilder;
     }
 }
 export class JsonSchemaObjectBuilder extends JsonSchemaAnyBuilder {
@@ -717,3 +716,27 @@ function objectDbEntity(props) {
         ...props,
     });
 }
+/**
+ * Builds the object schema with the indicated `keys` and uses the `schema` for their validation.
+ */
+function withEnumKeys(keys, schema) {
+    let enumValues;
+    if (Array.isArray(keys)) {
+        _assert(isEveryItemPrimitive(keys), 'Every item in the key list should be string, number or symbol');
+        enumValues = keys;
+    }
+    else if (typeof keys === 'object') {
+        const enumType = getEnumType(keys);
+        _assert(enumType === 'NumberEnum' || enumType === 'StringEnum', 'The key list should be StringEnum or NumberEnum');
+        if (enumType === 'NumberEnum') {
+            enumValues = _numberEnumValues(keys);
+        }
+        else if (enumType === 'StringEnum') {
+            enumValues = _stringEnumValues(keys);
+        }
+    }
+    _assert(enumValues, 'The key list should be an array of values, NumberEnum or a StringEnum');
+    const typedValues = enumValues;
+    const props = Object.fromEntries(typedValues.map(key => [key, schema]));
+    return new JsonSchemaObjectBuilder(props, { hasIsOfTypeCheck: false });
+}

package/package.json

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

package/src/validation/ajv/jsonSchemaBuilder.ts

@@ -87,47 +87,7 @@ export const j = {
       )
     },
 
-    /**
-     * Builds the object schema with the indicated `keys` and uses the `schema` for their validation.
-     */
-    withEnumKeys<
-      const T extends readonly (string | number)[] | StringEnum | NumberEnum,
-      S extends JsonSchemaTerminal<any, any, any>,
-      K extends string | number = EnumKeyUnion<T>,
-    >(
-      keys: T,
-      schema: S,
-    ): JsonSchemaObjectBuilder<Record<K, SchemaIn<S>>, Record<K, SchemaOut<S>>> {
-      let enumValues: readonly (string | number)[] | undefined
-      if (Array.isArray(keys)) {
-        _assert(
-          isEveryItemPrimitive(keys),
-          'Every item in the key list should be string, number or symbol',
-        )
-        enumValues = keys
-      } else if (typeof keys === 'object') {
-        const enumType = getEnumType(keys)
-        _assert(
-          enumType === 'NumberEnum' || enumType === 'StringEnum',
-          'The key list should be StringEnum or NumberEnum',
-        )
-        if (enumType === 'NumberEnum') {
-          enumValues = _numberEnumValues(keys as NumberEnum)
-        } else if (enumType === 'StringEnum') {
-          enumValues = _stringEnumValues(keys as StringEnum)
-        }
-      }
-
-      _assert(enumValues, 'The key list should be an array of values, NumberEnum or a StringEnum')
-
-      const typedValues = enumValues as readonly K[]
-      const props = Object.fromEntries(typedValues.map(key => [key, schema])) as any
-
-      return new JsonSchemaObjectBuilder<Record<K, SchemaIn<S>>, Record<K, SchemaOut<S>>, false>(
-        props,
-        { hasIsOfTypeCheck: false },
-      )
-    },
+    withEnumKeys,
   }),
 
   array<IN, OUT, Opt>(
@@ -365,12 +325,22 @@ export class JsonSchemaStringBuilder<
   override optional(
     optionalValues?: string[],
   ): JsonSchemaStringBuilder<IN | undefined, OUT | undefined, true> {
-    _objectAssign(this.schema, { optionalValues })
-    return super.optional() as unknown as JsonSchemaStringBuilder<
-      IN | undefined,
-      OUT | undefined,
-      true
-    >
+    if (!optionalValues) {
+      return super.optional() as unknown as JsonSchemaStringBuilder<
+        IN | undefined,
+        OUT | undefined,
+        true
+      >
+    }
+
+    const newBuilder = new JsonSchemaStringBuilder<IN, OUT, Opt>().optional()
+    const alternativesSchema = j.enum(optionalValues)
+    Object.assign(newBuilder.getSchema(), {
+      anyOf: [this.build(), alternativesSchema.build()],
+      optionalValues,
+    })
+
+    return newBuilder
   }
 
   regex(pattern: RegExp, opt?: JsonBuilderRuleOpt): this {
@@ -584,12 +554,22 @@ export class JsonSchemaNumberBuilder<
   override optional(
     optionalValues?: number[],
   ): JsonSchemaNumberBuilder<IN | undefined, OUT | undefined, true> {
-    _objectAssign(this.schema, { optionalValues })
-    return super.optional() as unknown as JsonSchemaNumberBuilder<
-      IN | undefined,
-      OUT | undefined,
-      true
-    >
+    if (!optionalValues) {
+      return super.optional() as unknown as JsonSchemaNumberBuilder<
+        IN | undefined,
+        OUT | undefined,
+        true
+      >
+    }
+
+    const newBuilder = new JsonSchemaNumberBuilder<IN, OUT, Opt>().optional()
+    const alternativesSchema = j.enum(optionalValues)
+    Object.assign(newBuilder.getSchema(), {
+      anyOf: [this.build(), alternativesSchema.build()],
+      optionalValues,
+    })
+
+    return newBuilder
   }
 
   integer(): this {
@@ -731,15 +711,22 @@ export class JsonSchemaBooleanBuilder<
   override optional(
     optionalValue?: boolean,
   ): JsonSchemaBooleanBuilder<IN | undefined, OUT | undefined, true> {
-    if (typeof optionalValue !== 'undefined') {
-      _objectAssign(this.schema, { optionalValues: [optionalValue] })
+    if (typeof optionalValue === 'undefined') {
+      return super.optional() as unknown as JsonSchemaBooleanBuilder<
+        IN | undefined,
+        OUT | undefined,
+        true
+      >
     }
 
-    return super.optional() as unknown as JsonSchemaBooleanBuilder<
-      IN | undefined,
-      OUT | undefined,
-      true
-    >
+    const newBuilder = new JsonSchemaBooleanBuilder<IN, OUT, Opt>().optional()
+    const alternativesSchema = j.enum([optionalValue])
+    Object.assign(newBuilder.getSchema(), {
+      anyOf: [this.build(), alternativesSchema.build()],
+      optionalValues: [optionalValue],
+    })
+
+    return newBuilder
   }
 }
 
@@ -1160,6 +1147,54 @@ function objectDbEntity(props: AnyObject): any {
   })
 }
 
+/**
+ * Builds the object schema with the indicated `keys` and uses the `schema` for their validation.
+ */
+function withEnumKeys<
+  const T extends readonly (string | number)[] | StringEnum | NumberEnum,
+  S extends JsonSchemaAnyBuilder<any, any, any>,
+  K extends string | number = EnumKeyUnion<T>,
+  Opt extends boolean = SchemaOpt<S>,
+>(
+  keys: T,
+  schema: S,
+): JsonSchemaObjectBuilder<
+  Opt extends true ? { [P in K]?: SchemaIn<S> } : { [P in K]: SchemaIn<S> },
+  Opt extends true ? { [P in K]?: SchemaOut<S> } : { [P in K]: SchemaOut<S> },
+  false
+> {
+  let enumValues: readonly (string | number)[] | undefined
+  if (Array.isArray(keys)) {
+    _assert(
+      isEveryItemPrimitive(keys),
+      'Every item in the key list should be string, number or symbol',
+    )
+    enumValues = keys
+  } else if (typeof keys === 'object') {
+    const enumType = getEnumType(keys)
+    _assert(
+      enumType === 'NumberEnum' || enumType === 'StringEnum',
+      'The key list should be StringEnum or NumberEnum',
+    )
+    if (enumType === 'NumberEnum') {
+      enumValues = _numberEnumValues(keys as NumberEnum)
+    } else if (enumType === 'StringEnum') {
+      enumValues = _stringEnumValues(keys as StringEnum)
+    }
+  }
+
+  _assert(enumValues, 'The key list should be an array of values, NumberEnum or a StringEnum')
+
+  const typedValues = enumValues as readonly K[]
+  const props = Object.fromEntries(typedValues.map(key => [key, schema])) as any
+
+  return new JsonSchemaObjectBuilder<
+    Opt extends true ? { [P in K]?: SchemaIn<S> } : { [P in K]: SchemaIn<S> },
+    Opt extends true ? { [P in K]?: SchemaOut<S> } : { [P in K]: SchemaOut<S> },
+    false
+  >(props, { hasIsOfTypeCheck: false })
+}
+
 type Expand<T> = T extends infer O ? { [K in keyof O]: O[K] } : never
 
 type ExactMatch<A, B> =
@@ -1201,3 +1236,4 @@ type EnumKeyUnion<T> =
 
 type SchemaIn<S> = S extends JsonSchemaAnyBuilder<infer IN, any, any> ? IN : never
 type SchemaOut<S> = S extends JsonSchemaAnyBuilder<any, infer OUT, any> ? OUT : never
+type SchemaOpt<S> = S extends JsonSchemaAnyBuilder<any, any, infer Opt> ? Opt : false