@naturalcycles/nodejs-lib 15.52.0 → 15.54.0

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

@@ -8,6 +8,7 @@ export declare const j: {
         dbEntity: typeof objectDbEntity;
         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.
          */
@@ -114,6 +115,7 @@ export declare class JsonSchemaStringBuilder<IN extends string = string, OUT = I
      */
     ianaTimezone(): JsonSchemaEnumBuilder<string | IANATimezone, IANATimezone, false>;
     base64Url(): this;
+    uuid(): this;
 }
 export interface JsonSchemaStringEmailOptions {
     checkTLD: boolean;
@@ -178,6 +180,7 @@ export declare class JsonSchemaObjectBuilder<IN extends AnyObject, OUT extends A
 }
 interface JsonSchemaObjectBuilderOpts {
     hasIsOfTypeCheck?: false;
+    patternProperties?: StringMap<JsonSchema<any, any>>;
 }
 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;
@@ -242,6 +245,7 @@ export interface JsonSchema<IN = unknown, OUT = IN> {
     properties?: {
         [K in keyof IN & keyof OUT]: JsonSchema<IN[K], OUT[K]>;
     };
+    patternProperties?: StringMap<JsonSchema<any, any>>;
     required?: string[];
     additionalProperties?: boolean;
     minProperties?: number;

package/dist/validation/ajv/jsonSchemaBuilder.js

@@ -5,7 +5,7 @@ import { _uniq } from '@naturalcycles/js-lib/array';
 import { _assert } from '@naturalcycles/js-lib/error';
 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 { BASE64URL_REGEX, COUNTRY_CODE_REGEX, CURRENCY_REGEX, IPV4_REGEX, IPV6_REGEX, LANGUAGE_TAG_REGEX, SEMVER_REGEX, SLUG_REGEX, UUID_REGEX, } from '../regexes.js';
 import { TIMEZONES } from '../timezones.js';
 import { isEveryItemNumber, isEveryItemPrimitive, isEveryItemString, JSON_SCHEMA_ORDER, mergeJsonSchemaObjects, } from './jsonSchemaBuilder.util.js';
 export const j = {
@@ -24,6 +24,17 @@ export const j = {
         any() {
             return j.object({}).allowAdditionalProperties();
         },
+        stringMap(schema) {
+            const builtSchema = schema.build();
+            _assert(!builtSchema?.optionalField, 'In a StringMap schema the value cannot be `undefined`, because `undefined` is not a valid JSON Schema value.');
+            builtSchema.optionalField = undefined;
+            return new JsonSchemaObjectBuilder({}, {
+                hasIsOfTypeCheck: false,
+                patternProperties: {
+                    '^.+$': builtSchema,
+                },
+            });
+        },
         /**
          * Builds the object schema with the indicated `keys` and uses the `schema` for their validation.
          */
@@ -43,7 +54,7 @@ export const j = {
                     enumValues = _stringEnumValues(keys);
                 }
             }
-            _assert(enumValues, 'The key list should be an array of values, NumberEnum or a StrinEnum');
+            _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 });
@@ -325,6 +336,9 @@ export class JsonSchemaStringBuilder extends JsonSchemaAnyBuilder {
             msg: 'contains characters not allowed in Base64 URL characterset',
         });
     }
+    uuid() {
+        return this.regex(UUID_REGEX, { msg: 'is an invalid UUID' });
+    }
 }
 export class JsonSchemaIsoDateBuilder extends JsonSchemaAnyBuilder {
     constructor() {
@@ -472,6 +486,7 @@ export class JsonSchemaObjectBuilder extends JsonSchemaAnyBuilder {
             required: [],
             additionalProperties: false,
             hasIsOfTypeCheck: opt?.hasIsOfTypeCheck ?? true,
+            patternProperties: opt?.patternProperties ?? undefined,
         });
         if (props)
             this.addProperties(props);

package/dist/validation/regexes.d.ts

@@ -1,6 +1,7 @@
 export declare const BASE62_REGEX: RegExp;
 export declare const BASE64_REGEX: RegExp;
 export declare const BASE64URL_REGEX: RegExp;
+export declare const UUID_REGEX: RegExp;
 export declare const COUNTRY_CODE_REGEX: RegExp;
 export declare const CURRENCY_REGEX: RegExp;
 /**

package/dist/validation/regexes.js

@@ -1,6 +1,8 @@
 export const BASE62_REGEX = /^[a-zA-Z0-9]+$/;
 export const BASE64_REGEX = /^[a-zA-Z0-9+/]+={0,2}$/;
 export const BASE64URL_REGEX = /^[a-zA-Z0-9_-]+$/;
+// from `ajv-formats`
+export const UUID_REGEX = /^(?:urn:uuid:)?[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$/i;
 export const COUNTRY_CODE_REGEX = /^[A-Z]{2}$/;
 export const CURRENCY_REGEX = /^[A-Z]{3}$/;
 /**

package/package.json

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

package/src/validation/ajv/jsonSchemaBuilder.ts

@@ -35,6 +35,7 @@ import {
   LANGUAGE_TAG_REGEX,
   SEMVER_REGEX,
   SLUG_REGEX,
+  UUID_REGEX,
 } from '../regexes.js'
 import { TIMEZONES } from '../timezones.js'
 import {
@@ -65,6 +66,27 @@ export const j = {
       return j.object<AnyObject>({}).allowAdditionalProperties()
     },
 
+    stringMap<S extends JsonSchemaTerminal<any, any, any>>(
+      schema: S,
+    ): JsonSchemaObjectBuilder<StringMap<SchemaIn<S>>, StringMap<SchemaOut<S>>> {
+      const builtSchema = schema.build()
+      _assert(
+        !builtSchema?.optionalField,
+        'In a StringMap schema the value cannot be `undefined`, because `undefined` is not a valid JSON Schema value.',
+      )
+      builtSchema.optionalField = undefined
+
+      return new JsonSchemaObjectBuilder<StringMap<SchemaIn<S>>, StringMap<SchemaOut<S>>>(
+        {},
+        {
+          hasIsOfTypeCheck: false,
+          patternProperties: {
+            '^.+$': builtSchema,
+          },
+        },
+      )
+    },
+
     /**
      * Builds the object schema with the indicated `keys` and uses the `schema` for their validation.
      */
@@ -96,7 +118,7 @@ export const j = {
         }
       }
 
-      _assert(enumValues, 'The key list should be an array of values, NumberEnum or a StrinEnum')
+      _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
@@ -457,6 +479,10 @@ export class JsonSchemaStringBuilder<
       msg: 'contains characters not allowed in Base64 URL characterset',
     })
   }
+
+  uuid(): this {
+    return this.regex(UUID_REGEX, { msg: 'is an invalid UUID' })
+  }
 }
 
 export interface JsonSchemaStringEmailOptions {
@@ -667,6 +693,7 @@ export class JsonSchemaObjectBuilder<
       required: [],
       additionalProperties: false,
       hasIsOfTypeCheck: opt?.hasIsOfTypeCheck ?? true,
+      patternProperties: opt?.patternProperties ?? undefined,
     })
 
     if (props) this.addProperties(props)
@@ -737,6 +764,7 @@ export class JsonSchemaObjectBuilder<
 
 interface JsonSchemaObjectBuilderOpts {
   hasIsOfTypeCheck?: false
+  patternProperties?: StringMap<JsonSchema<any, any>>
 }
 
 export class JsonSchemaObjectInferringBuilder<
@@ -967,6 +995,7 @@ export interface JsonSchema<IN = unknown, OUT = IN> {
   properties?: {
     [K in keyof IN & keyof OUT]: JsonSchema<IN[K], OUT[K]>
   }
+  patternProperties?: StringMap<JsonSchema<any, any>>
   required?: string[]
   additionalProperties?: boolean
   minProperties?: number

package/src/validation/regexes.ts

@@ -1,6 +1,8 @@
 export const BASE62_REGEX = /^[a-zA-Z0-9]+$/
 export const BASE64_REGEX = /^[a-zA-Z0-9+/]+={0,2}$/
 export const BASE64URL_REGEX = /^[a-zA-Z0-9_-]+$/
+// from `ajv-formats`
+export const UUID_REGEX = /^(?:urn:uuid:)?[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$/i
 export const COUNTRY_CODE_REGEX = /^[A-Z]{2}$/
 export const CURRENCY_REGEX = /^[A-Z]{3}$/
 /**