@naturalcycles/nodejs-lib 15.51.2 → 15.52.0

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

@@ -8,6 +8,10 @@ export declare const j: {
         dbEntity: typeof objectDbEntity;
         infer: typeof objectInfer;
         any(): JsonSchemaObjectBuilder<AnyObject, AnyObject, false>;
+        /**
+         * 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>>>;
     };
     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>;
@@ -158,7 +162,7 @@ export declare class JsonSchemaBooleanBuilder<IN extends boolean = boolean, OUT
     constructor();
 }
 export declare class JsonSchemaObjectBuilder<IN extends AnyObject, OUT extends AnyObject, Opt extends boolean = false> extends JsonSchemaAnyBuilder<IN, OUT, Opt> {
-    constructor(props?: AnyObject);
+    constructor(props?: AnyObject, opt?: JsonSchemaObjectBuilderOpts);
     addProperties(props: AnyObject): this;
     /**
      * When set, the validation will not strip away properties that are not specified explicitly in the schema.
@@ -172,6 +176,9 @@ export declare class JsonSchemaObjectBuilder<IN extends AnyObject, OUT extends A
     minProperties(minProperties: number): this;
     maxProperties(maxProperties: number): this;
 }
+interface JsonSchemaObjectBuilderOpts {
+    hasIsOfTypeCheck?: false;
+}
 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;
 } & {
@@ -326,4 +333,7 @@ interface JsonBuilderRuleOpt {
      */
     name?: string;
 }
+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;
 export {};

package/dist/validation/ajv/jsonSchemaBuilder.js

@@ -7,7 +7,7 @@ import { _deepCopy, _sortObject } from '@naturalcycles/js-lib/object';
 import { _objectAssign, JWT_REGEX, } from '@naturalcycles/js-lib/types';
 import { BASE64URL_REGEX, COUNTRY_CODE_REGEX, CURRENCY_REGEX, IPV4_REGEX, IPV6_REGEX, LANGUAGE_TAG_REGEX, SEMVER_REGEX, SLUG_REGEX, } from '../regexes.js';
 import { TIMEZONES } from '../timezones.js';
-import { isEveryItemNumber, isEveryItemString, JSON_SCHEMA_ORDER, mergeJsonSchemaObjects, } from './jsonSchemaBuilder.util.js';
+import { isEveryItemNumber, isEveryItemPrimitive, isEveryItemString, JSON_SCHEMA_ORDER, mergeJsonSchemaObjects, } from './jsonSchemaBuilder.util.js';
 export const j = {
     string() {
         return new JsonSchemaStringBuilder();
@@ -24,6 +24,30 @@ export const j = {
         any() {
             return j.object({}).allowAdditionalProperties();
         },
+        /**
+         * 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 StrinEnum');
+            const typedValues = enumValues;
+            const props = Object.fromEntries(typedValues.map(key => [key, schema]));
+            return new JsonSchemaObjectBuilder(props, { hasIsOfTypeCheck: false });
+        },
     }),
     array(itemSchema) {
         return new JsonSchemaArrayBuilder(itemSchema);
@@ -441,13 +465,13 @@ export class JsonSchemaBooleanBuilder extends JsonSchemaAnyBuilder {
     }
 }
 export class JsonSchemaObjectBuilder extends JsonSchemaAnyBuilder {
-    constructor(props) {
+    constructor(props, opt) {
         super({
             type: 'object',
             properties: {},
             required: [],
             additionalProperties: false,
-            hasIsOfTypeCheck: true,
+            hasIsOfTypeCheck: opt?.hasIsOfTypeCheck ?? true,
         });
         if (props)
             this.addProperties(props);

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

@@ -9,3 +9,4 @@ export declare const JSON_SCHEMA_ORDER: string[];
 export declare function mergeJsonSchemaObjects<T1 extends AnyObject, T2 extends AnyObject>(schema1: JsonSchema<T1>, schema2: JsonSchema<T2>): JsonSchema<T1 & T2>;
 export declare function isEveryItemString(arr: any[]): boolean;
 export declare function isEveryItemNumber(arr: any[]): boolean;
+export declare function isEveryItemPrimitive(arr: any[]): boolean;

package/dist/validation/ajv/jsonSchemaBuilder.util.js

@@ -77,3 +77,11 @@ export function isEveryItemNumber(arr) {
     }
     return true;
 }
+export function isEveryItemPrimitive(arr) {
+    for (const item of arr) {
+        if (typeof item !== 'number' && typeof item !== 'string' && typeof item !== 'symbol') {
+            return false;
+        }
+    }
+    return true;
+}

package/package.json

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

package/src/validation/ajv/jsonSchemaBuilder.ts

@@ -39,6 +39,7 @@ import {
 import { TIMEZONES } from '../timezones.js'
 import {
   isEveryItemNumber,
+  isEveryItemPrimitive,
   isEveryItemString,
   JSON_SCHEMA_ORDER,
   mergeJsonSchemaObjects,
@@ -63,6 +64,48 @@ export const j = {
     any() {
       return j.object<AnyObject>({}).allowAdditionalProperties()
     },
+
+    /**
+     * 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 StrinEnum')
+
+      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 },
+      )
+    },
   }),
 
   array<IN, OUT, Opt>(
@@ -617,13 +660,13 @@ export class JsonSchemaObjectBuilder<
   OUT extends AnyObject,
   Opt extends boolean = false,
 > extends JsonSchemaAnyBuilder<IN, OUT, Opt> {
-  constructor(props?: AnyObject) {
+  constructor(props?: AnyObject, opt?: JsonSchemaObjectBuilderOpts) {
     super({
       type: 'object',
       properties: {},
       required: [],
       additionalProperties: false,
-      hasIsOfTypeCheck: true,
+      hasIsOfTypeCheck: opt?.hasIsOfTypeCheck ?? true,
     })
 
     if (props) this.addProperties(props)
@@ -692,6 +735,10 @@ export class JsonSchemaObjectBuilder<
   }
 }
 
+interface JsonSchemaObjectBuilderOpts {
+  hasIsOfTypeCheck?: false
+}
+
 export class JsonSchemaObjectInferringBuilder<
   PROPS extends Record<string, JsonSchemaAnyBuilder<any, any, any>>,
   Opt extends boolean = false,
@@ -1049,3 +1096,15 @@ interface JsonBuilderRuleOpt {
    */
   name?: string
 }
+
+type EnumKeyUnion<T> =
+  // array of literals -> union of its elements
+  T extends readonly (infer U)[]
+    ? U
+    : // enum object -> union of its values
+      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

package/src/validation/ajv/jsonSchemaBuilder.util.ts

@@ -90,3 +90,12 @@ export function isEveryItemNumber(arr: any[]): boolean {
   }
   return true
 }
+
+export function isEveryItemPrimitive(arr: any[]): boolean {
+  for (const item of arr) {
+    if (typeof item !== 'number' && typeof item !== 'string' && typeof item !== 'symbol') {
+      return false
+    }
+  }
+  return true
+}