@naturalcycles/nodejs-lib 15.73.0 → 15.74.1

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, UUID_REGEX, } from '../regexes.js';
+import { BASE64URL_REGEX, COUNTRY_CODE_REGEX, CURRENCY_REGEX, IPV4_REGEX, IPV6_REGEX, LANGUAGE_TAG_REGEX, SEMVER_REGEX, SLUG_REGEX, URL_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 = {
@@ -157,6 +157,7 @@ export class JsonSchemaTerminal {
      * Same as if it would be JSON.stringified.
      */
     build() {
+        _assert(!(this.schema.optionalField && this.schema.default !== undefined), '.optional() and .default() should not be used together - the default value makes .optional() redundant and causes incorrect type inference');
         const jsonSchema = _sortObject(JSON.parse(JSON.stringify(this.schema)), JSON_SCHEMA_ORDER);
         delete jsonSchema.optionalField;
         return jsonSchema;
@@ -278,6 +279,7 @@ export class JsonSchemaStringBuilder extends JsonSchemaAnyBuilder {
         return newBuilder;
     }
     regex(pattern, opt) {
+        _assert(!pattern.flags, `Regex flags are not supported by JSON Schema. Received: /${pattern.source}/${pattern.flags}`);
         return this.pattern(pattern.source, opt);
     }
     pattern(pattern, opt) {
@@ -348,9 +350,7 @@ export class JsonSchemaStringBuilder extends JsonSchemaAnyBuilder {
         return this.regex(JWT_REGEX, { msg: 'is not a valid JWT format' });
     }
     url() {
-        // from `ajv-formats`
-        const regex = /^(?:https?|ftp):\/\/(?:\S+(?::\S*)?@)?(?:(?!(?:10|127)(?:\.\d{1,3}){3})(?!(?:169\.254|192\.168)(?:\.\d{1,3}){2})(?!172\.(?:1[6-9]|2\d|3[0-1])(?:\.\d{1,3}){2})(?:[1-9]\d?|1\d\d|2[01]\d|22[0-3])(?:\.(?:1?\d{1,2}|2[0-4]\d|25[0-5])){2}(?:\.(?:[1-9]\d?|1\d\d|2[0-4]\d|25[0-4]))|(?:(?:[a-z0-9\u{00A1}-\u{FFFF}]+-)*[a-z0-9\u{00A1}-\u{FFFF}]+)(?:\.(?:[a-z0-9\u{00A1}-\u{FFFF}]+-)*[a-z0-9\u{00A1}-\u{FFFF}]+)*(?:\.(?:[a-z\u{00A1}-\u{FFFF}]{2,})))(?::\d{2,5})?(?:\/[^\s]*)?$/iu;
-        return this.regex(regex, { msg: 'is not a valid URL format' });
+        return this.regex(URL_REGEX, { msg: 'is not a valid URL format' });
     }
     ipv4() {
         return this.regex(IPV4_REGEX, { msg: 'is not a valid IPv4 format' });
@@ -807,6 +807,9 @@ function record(keySchema, valueSchema) {
     });
 }
 function withRegexKeys(keyRegex, schema) {
+    if (keyRegex instanceof RegExp) {
+        _assert(!keyRegex.flags, `Regex flags are not supported by JSON Schema. Received: /${keyRegex.source}/${keyRegex.flags}`);
+    }
     const pattern = keyRegex instanceof RegExp ? keyRegex.source : keyRegex;
     const jsonSchema = schema.build();
     return new JsonSchemaObjectBuilder([], {

package/dist/validation/regexes.d.ts

@@ -18,3 +18,4 @@ export declare const LANGUAGE_TAG_REGEX: RegExp;
 export declare const MAC_ADDRESS_REGEX: RegExp;
 export declare const SEMVER_REGEX: RegExp;
 export declare const SLUG_REGEX: RegExp;
+export declare const URL_REGEX: RegExp;

package/dist/validation/regexes.js

@@ -23,3 +23,7 @@ export const LANGUAGE_TAG_REGEX = /^[a-z]{2}(-[A-Z]{2})?$/;
 export const MAC_ADDRESS_REGEX = /^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$/;
 export const SEMVER_REGEX = /^[0-9]+\.[0-9]+\.[0-9]+$/;
 export const SLUG_REGEX = /^[a-z0-9-]+$/;
+// URL regex based on `ajv-formats`, but without flags for JSON Schema compatibility.
+// Uses [a-zA-Z] instead of [a-z] with i flag. Simplified to not require unicode flag.
+// Without the unicode flag - it DOES NOT support urls like https://münchen.de
+export const URL_REGEX = /^(?:https?|ftp):\/\/(?:\S+(?::\S*)?@)?(?:(?!(?:10|127)(?:\.\d{1,3}){3})(?!(?:169\.254|192\.168)(?:\.\d{1,3}){2})(?!172\.(?:1[6-9]|2\d|3[0-1])(?:\.\d{1,3}){2})(?:[1-9]\d?|1\d\d|2[01]\d|22[0-3])(?:\.(?:1?\d{1,2}|2[0-4]\d|25[0-5])){2}(?:\.(?:[1-9]\d?|1\d\d|2[0-4]\d|25[0-4]))|(?:(?:[a-zA-Z0-9]+-)*[a-zA-Z0-9]+)(?:\.(?:[a-zA-Z0-9]+-)*[a-zA-Z0-9]+)*(?:\.(?:[a-zA-Z]{2,})))(?::\d{2,5})?(?:\/[^\s]*)?$/;

package/package.json

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

package/src/validation/ajv/jsonSchemaBuilder.ts

@@ -36,6 +36,7 @@ import {
   LANGUAGE_TAG_REGEX,
   SEMVER_REGEX,
   SLUG_REGEX,
+  URL_REGEX,
   UUID_REGEX,
 } from '../regexes.js'
 import { TIMEZONES } from '../timezones.js'
@@ -246,6 +247,11 @@ export class JsonSchemaTerminal<IN, OUT, Opt> {
    * Same as if it would be JSON.stringified.
    */
   build(): JsonSchema<IN, OUT> {
+    _assert(
+      !(this.schema.optionalField && this.schema.default !== undefined),
+      '.optional() and .default() should not be used together - the default value makes .optional() redundant and causes incorrect type inference',
+    )
+
     const jsonSchema = _sortObject(
       JSON.parse(JSON.stringify(this.schema)),
       JSON_SCHEMA_ORDER,
@@ -405,6 +411,10 @@ export class JsonSchemaStringBuilder<
   }
 
   regex(pattern: RegExp, opt?: JsonBuilderRuleOpt): this {
+    _assert(
+      !pattern.flags,
+      `Regex flags are not supported by JSON Schema. Received: /${pattern.source}/${pattern.flags}`,
+    )
     return this.pattern(pattern.source, opt)
   }
 
@@ -490,10 +500,7 @@ export class JsonSchemaStringBuilder<
   }
 
   url(): this {
-    // from `ajv-formats`
-    const regex =
-      /^(?:https?|ftp):\/\/(?:\S+(?::\S*)?@)?(?:(?!(?:10|127)(?:\.\d{1,3}){3})(?!(?:169\.254|192\.168)(?:\.\d{1,3}){2})(?!172\.(?:1[6-9]|2\d|3[0-1])(?:\.\d{1,3}){2})(?:[1-9]\d?|1\d\d|2[01]\d|22[0-3])(?:\.(?:1?\d{1,2}|2[0-4]\d|25[0-5])){2}(?:\.(?:[1-9]\d?|1\d\d|2[0-4]\d|25[0-4]))|(?:(?:[a-z0-9\u{00A1}-\u{FFFF}]+-)*[a-z0-9\u{00A1}-\u{FFFF}]+)(?:\.(?:[a-z0-9\u{00A1}-\u{FFFF}]+-)*[a-z0-9\u{00A1}-\u{FFFF}]+)*(?:\.(?:[a-z\u{00A1}-\u{FFFF}]{2,})))(?::\d{2,5})?(?:\/[^\s]*)?$/iu
-    return this.regex(regex, { msg: 'is not a valid URL format' })
+    return this.regex(URL_REGEX, { msg: 'is not a valid URL format' })
   }
 
   ipv4(): this {
@@ -1353,6 +1360,12 @@ function withRegexKeys<
   Opt extends true ? StringMap<SchemaOut<S>> : StringMap<SchemaOut<S>>,
   false
 > {
+  if (keyRegex instanceof RegExp) {
+    _assert(
+      !keyRegex.flags,
+      `Regex flags are not supported by JSON Schema. Received: /${keyRegex.source}/${keyRegex.flags}`,
+    )
+  }
   const pattern = keyRegex instanceof RegExp ? keyRegex.source : keyRegex
   const jsonSchema = schema.build()
 

package/src/validation/regexes.ts

@@ -24,3 +24,8 @@ export const LANGUAGE_TAG_REGEX = /^[a-z]{2}(-[A-Z]{2})?$/
 export const MAC_ADDRESS_REGEX = /^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$/
 export const SEMVER_REGEX = /^[0-9]+\.[0-9]+\.[0-9]+$/
 export const SLUG_REGEX = /^[a-z0-9-]+$/
+// URL regex based on `ajv-formats`, but without flags for JSON Schema compatibility.
+// Uses [a-zA-Z] instead of [a-z] with i flag. Simplified to not require unicode flag.
+// Without the unicode flag - it DOES NOT support urls like https://münchen.de
+export const URL_REGEX =
+  /^(?:https?|ftp):\/\/(?:\S+(?::\S*)?@)?(?:(?!(?:10|127)(?:\.\d{1,3}){3})(?!(?:169\.254|192\.168)(?:\.\d{1,3}){2})(?!172\.(?:1[6-9]|2\d|3[0-1])(?:\.\d{1,3}){2})(?:[1-9]\d?|1\d\d|2[01]\d|22[0-3])(?:\.(?:1?\d{1,2}|2[0-4]\d|25[0-5])){2}(?:\.(?:[1-9]\d?|1\d\d|2[0-4]\d|25[0-4]))|(?:(?:[a-zA-Z0-9]+-)*[a-zA-Z0-9]+)(?:\.(?:[a-zA-Z0-9]+-)*[a-zA-Z0-9]+)*(?:\.(?:[a-zA-Z]{2,})))(?::\d{2,5})?(?:\/[^\s]*)?$/