@naturalcycles/nodejs-lib 15.47.0 → 15.47.1

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

@@ -13,6 +13,13 @@ export declare const getAjv: any;
  * and are not interested in transforming the data.
  */
 export declare const getNonMutatingAjv: any;
+/**
+ * Returns cached instance of Ajv, which is coercing data.
+ *
+ * To be used in places where we know that we are going to receive data with the wrong type,
+ * typically: request path params and request query params.
+ */
+export declare const getCoercingAjv: any;
 /**
  * Create Ajv with modified defaults.
  *

package/dist/validation/ajv/getAjv.js

@@ -19,6 +19,10 @@ const AJV_NON_MUTATING_OPTIONS = {
     removeAdditional: false,
     useDefaults: false,
 };
+const AJV_MUTATING_COERCING_OPTIONS = {
+    ...AJV_OPTIONS,
+    coerceTypes: true,
+};
 /**
  * Return cached instance of Ajv with default (recommended) options.
  *
@@ -33,6 +37,13 @@ export const getAjv = _lazyValue(createAjv);
  * and are not interested in transforming the data.
  */
 export const getNonMutatingAjv = _lazyValue(() => createAjv(AJV_NON_MUTATING_OPTIONS));
+/**
+ * Returns cached instance of Ajv, which is coercing data.
+ *
+ * To be used in places where we know that we are going to receive data with the wrong type,
+ * typically: request path params and request query params.
+ */
+export const getCoercingAjv = _lazyValue(() => createAjv(AJV_MUTATING_COERCING_OPTIONS));
 /**
  * Create Ajv with modified defaults.
  *

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

@@ -208,9 +208,10 @@ export declare class JsonSchemaBufferBuilder extends JsonSchemaAnyBuilder<string
     constructor();
 }
 export declare class JsonSchemaEnumBuilder<IN extends string | number | boolean | null, OUT extends IN = IN, Opt extends boolean = false> extends JsonSchemaAnyBuilder<IN, OUT, Opt> {
-    constructor(enumValues: readonly IN[], opt?: JsonBuilderRuleOpt);
+    constructor(enumValues: readonly IN[], baseType: EnumBaseType, opt?: JsonBuilderRuleOpt);
     branded<B extends IN>(): JsonSchemaEnumBuilder<B | IN, B, Opt>;
 }
+type EnumBaseType = 'string' | 'number' | 'other';
 export interface JsonSchema<IN = unknown, OUT = IN> {
     readonly in?: IN;
     readonly out?: OUT;

package/dist/validation/ajv/jsonSchemaBuilder.js

@@ -6,7 +6,7 @@ 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 { TIMEZONES } from '../timezones.js';
-import { JSON_SCHEMA_ORDER, mergeJsonSchemaObjects } from './jsonSchemaBuilder.util.js';
+import { isEveryItemNumber, isEveryItemString, JSON_SCHEMA_ORDER, mergeJsonSchemaObjects, } from './jsonSchemaBuilder.util.js';
 export const j = {
     string() {
         return new JsonSchemaStringBuilder();
@@ -35,20 +35,29 @@ export const j = {
     },
     enum(input, opt) {
         let enumValues;
+        let baseType = 'other';
         if (Array.isArray(input)) {
             enumValues = input;
+            if (isEveryItemNumber(input)) {
+                baseType = 'number';
+            }
+            else if (isEveryItemString(input)) {
+                baseType = 'string';
+            }
         }
         else if (typeof input === 'object') {
             const enumType = getEnumType(input);
             if (enumType === 'NumberEnum') {
                 enumValues = _numberEnumValues(input);
+                baseType = 'number';
             }
             else if (enumType === 'StringEnum') {
                 enumValues = _stringEnumValues(input);
+                baseType = 'string';
             }
         }
         _assert(enumValues, 'Unsupported enum input');
-        return new JsonSchemaEnumBuilder(enumValues, opt);
+        return new JsonSchemaEnumBuilder(enumValues, baseType, opt);
     },
     oneOf(items) {
         const schemas = items.map(b => b.build());
@@ -592,8 +601,15 @@ export class JsonSchemaBufferBuilder extends JsonSchemaAnyBuilder {
     }
 }
 export class JsonSchemaEnumBuilder extends JsonSchemaAnyBuilder {
-    constructor(enumValues, opt) {
-        super({ enum: enumValues });
+    constructor(enumValues, baseType, opt) {
+        const jsonSchema = { enum: enumValues };
+        // Specifying the base type helps in cases when we ask Ajv to coerce the types.
+        // Having only the `enum` in the schema does not trigger a coercion in Ajv.
+        if (baseType === 'string')
+            jsonSchema.type = 'string';
+        if (baseType === 'number')
+            jsonSchema.type = 'number';
+        super(jsonSchema);
         if (opt?.name)
             this.setErrorMessage('pattern', `is not a valid ${opt.name}`);
         if (opt?.msg)

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

@@ -7,3 +7,5 @@ export declare const JSON_SCHEMA_ORDER: string[];
  * API similar to Object.assign(s1, s2)
  */
 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;

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

@@ -63,3 +63,17 @@ export function mergeJsonSchemaObjects(schema1, schema2) {
     // `additionalProperties` remains the same
     return _filterNullishValues(s1, { mutate: true });
 }
+export function isEveryItemString(arr) {
+    for (let i = 0; i <= arr.length; ++i) {
+        if (typeof arr[i] !== 'string')
+            return false;
+    }
+    return true;
+}
+export function isEveryItemNumber(arr) {
+    for (let i = 0; i <= arr.length; ++i) {
+        if (typeof arr[i] !== 'number')
+            return false;
+    }
+    return true;
+}

package/package.json

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

package/src/validation/ajv/getAjv.ts

@@ -24,6 +24,11 @@ const AJV_NON_MUTATING_OPTIONS: Options = {
   useDefaults: false,
 }
 
+const AJV_MUTATING_COERCING_OPTIONS: Options = {
+  ...AJV_OPTIONS,
+  coerceTypes: true,
+}
+
 /**
  * Return cached instance of Ajv with default (recommended) options.
  *
@@ -40,6 +45,14 @@ export const getAjv = _lazyValue(createAjv)
  */
 export const getNonMutatingAjv = _lazyValue(() => createAjv(AJV_NON_MUTATING_OPTIONS))
 
+/**
+ * Returns cached instance of Ajv, which is coercing data.
+ *
+ * To be used in places where we know that we are going to receive data with the wrong type,
+ * typically: request path params and request query params.
+ */
+export const getCoercingAjv = _lazyValue(() => createAjv(AJV_MUTATING_COERCING_OPTIONS))
+
 /**
  * Create Ajv with modified defaults.
  *

package/src/validation/ajv/jsonSchemaBuilder.ts

@@ -27,7 +27,12 @@ import {
   type UnixTimestampMillis,
 } from '@naturalcycles/js-lib/types'
 import { TIMEZONES } from '../timezones.js'
-import { JSON_SCHEMA_ORDER, mergeJsonSchemaObjects } from './jsonSchemaBuilder.util.js'
+import {
+  isEveryItemNumber,
+  isEveryItemString,
+  JSON_SCHEMA_ORDER,
+  mergeJsonSchemaObjects,
+} from './jsonSchemaBuilder.util.js'
 
 export const j = {
   string(): JsonSchemaStringBuilder<string, string, false> {
@@ -79,20 +84,28 @@ export const j = {
           : never
   > {
     let enumValues: readonly (string | number | boolean | null)[] | undefined
+    let baseType: EnumBaseType = 'other'
 
     if (Array.isArray(input)) {
       enumValues = input
+      if (isEveryItemNumber(input)) {
+        baseType = 'number'
+      } else if (isEveryItemString(input)) {
+        baseType = 'string'
+      }
     } else if (typeof input === 'object') {
       const enumType = getEnumType(input)
       if (enumType === 'NumberEnum') {
         enumValues = _numberEnumValues(input as NumberEnum)
+        baseType = 'number'
       } else if (enumType === 'StringEnum') {
         enumValues = _stringEnumValues(input as StringEnum)
+        baseType = 'string'
       }
     }
 
     _assert(enumValues, 'Unsupported enum input')
-    return new JsonSchemaEnumBuilder(enumValues as any, opt)
+    return new JsonSchemaEnumBuilder(enumValues as any, baseType, opt)
   },
 
   oneOf<
@@ -851,8 +864,15 @@ export class JsonSchemaEnumBuilder<
   OUT extends IN = IN,
   Opt extends boolean = false,
 > extends JsonSchemaAnyBuilder<IN, OUT, Opt> {
-  constructor(enumValues: readonly IN[], opt?: JsonBuilderRuleOpt) {
-    super({ enum: enumValues })
+  constructor(enumValues: readonly IN[], baseType: EnumBaseType, opt?: JsonBuilderRuleOpt) {
+    const jsonSchema: JsonSchema = { enum: enumValues }
+    // Specifying the base type helps in cases when we ask Ajv to coerce the types.
+    // Having only the `enum` in the schema does not trigger a coercion in Ajv.
+    if (baseType === 'string') jsonSchema.type = 'string'
+    if (baseType === 'number') jsonSchema.type = 'number'
+
+    super(jsonSchema)
+
     if (opt?.name) this.setErrorMessage('pattern', `is not a valid ${opt.name}`)
     if (opt?.msg) this.setErrorMessage('enum', opt.msg)
   }
@@ -862,6 +882,8 @@ export class JsonSchemaEnumBuilder<
   }
 }
 
+type EnumBaseType = 'string' | 'number' | 'other'
+
 export interface JsonSchema<IN = unknown, OUT = IN> {
   readonly in?: IN
   readonly out?: OUT

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

@@ -76,3 +76,17 @@ export function mergeJsonSchemaObjects<T1 extends AnyObject, T2 extends AnyObjec
 
   return _filterNullishValues(s1, { mutate: true })
 }
+
+export function isEveryItemString(arr: any[]): boolean {
+  for (let i = 0; i <= arr.length; ++i) {
+    if (typeof arr[i] !== 'string') return false
+  }
+  return true
+}
+
+export function isEveryItemNumber(arr: any[]): boolean {
+  for (let i = 0; i <= arr.length; ++i) {
+    if (typeof arr[i] !== 'number') return false
+  }
+  return true
+}