@naturalcycles/nodejs-lib 15.85.0 → 15.87.0

package/dist/validation/ajv/getAjv.js

@@ -1,4 +1,4 @@
-import { _isBetween, _lazyValue } from '@naturalcycles/js-lib';
+import { _isBetween, _lazyValue, _round } from '@naturalcycles/js-lib';
 import { _assert } from '@naturalcycles/js-lib/error';
 import { _deepCopy, _mapObject, Set2 } from '@naturalcycles/js-lib/object';
 import { _substringAfterLast } from '@naturalcycles/js-lib/string';
@@ -417,6 +417,15 @@ export function createAjv(opt) {
             return validate;
         },
     });
+    // Validates that the value is undefined. Used in record/stringMap with optional value schemas
+    // to allow undefined values in patternProperties via anyOf.
+    ajv.addKeyword({
+        keyword: 'isUndefined',
+        modifying: false,
+        errors: false,
+        schemaType: 'boolean',
+        validate: (_schema, data) => data === undefined,
+    });
     // This is added because Ajv validates the `min/maxProperties` before validating the properties.
     // So, in case of `minProperties(1)` and `{ foo: 'bar' }` Ajv will let it pass, even
     // if the property validation would strip `foo` from the data.
@@ -560,6 +569,20 @@ export function createAjv(opt) {
             return validate;
         },
     });
+    ajv.addKeyword({
+        keyword: 'precision',
+        type: ['number'],
+        modifying: true,
+        errors: false,
+        schemaType: 'number',
+        validate: function validate(numberOfDigits, data, _schema, ctx) {
+            if (!numberOfDigits)
+                return true;
+            _assert(ctx?.parentData && ctx.parentDataProperty !== undefined, 'You should only use `precision(n) on a property of an object, or on an element of an array due to Ajv mutation issues.');
+            ctx.parentData[ctx.parentDataProperty] = _round(data, 10 ** (-1 * numberOfDigits));
+            return true;
+        },
+    });
     return ajv;
 }
 const monthLengths = [0, 31, 29, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31];

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

@@ -279,6 +279,12 @@ export declare class JsonSchemaNumberBuilder<IN extends number | undefined = num
     unixTimestamp2000Millis(): JsonSchemaNumberBuilder<UnixTimestampMillis, UnixTimestampMillis, Opt>;
     utcOffset(): this;
     utcOffsetHour(): this;
+    /**
+     * Specify the precision of the floating point numbers by the number of digits after the ".".
+     * Excess digits will be cut-off when the current schema is nested in an object or array schema,
+     * due to how mutability works in Ajv.
+     */
+    precision(numberOfDigits: number): this;
 }
 export declare class JsonSchemaBooleanBuilder<IN extends boolean | undefined = boolean, OUT = IN, Opt extends boolean = false> extends JsonSchemaAnyBuilder<IN, OUT, Opt> {
     constructor();
@@ -505,6 +511,7 @@ export interface JsonSchema<IN = unknown, OUT = IN> {
     errorMessages?: StringMap<string>;
     optionalValues?: (string | number | boolean | null)[];
     keySchema?: JsonSchema;
+    isUndefined?: true;
     minProperties2?: number;
     exclusiveProperties?: (readonly string[])[];
     anyOfBy?: {
@@ -512,6 +519,7 @@ export interface JsonSchema<IN = unknown, OUT = IN> {
         schemaDictionary: Record<string, JsonSchema>;
     };
     anyOfThese?: JsonSchema[];
+    precision?: number;
 }
 declare function object(props: AnyObject): never;
 declare function object<IN extends AnyObject>(props: {

package/dist/validation/ajv/jsonSchemaBuilder.js

@@ -32,11 +32,15 @@ export const j = {
             return j.object({}).allowAdditionalProperties();
         },
         stringMap(schema) {
+            const isValueOptional = schema.getSchema().optionalField;
             const builtSchema = schema.build();
+            const finalValueSchema = isValueOptional
+                ? { anyOf: [{ isUndefined: true }, builtSchema] }
+                : builtSchema;
             return new JsonSchemaObjectBuilder({}, {
                 hasIsOfTypeCheck: false,
                 patternProperties: {
-                    '^.+$': builtSchema,
+                    '^.+$': finalValueSchema,
                 },
             });
         },
@@ -632,6 +636,14 @@ export class JsonSchemaNumberBuilder extends JsonSchemaAnyBuilder {
     utcOffsetHour() {
         return this.integer().min(-12).max(14);
     }
+    /**
+     * Specify the precision of the floating point numbers by the number of digits after the ".".
+     * Excess digits will be cut-off when the current schema is nested in an object or array schema,
+     * due to how mutability works in Ajv.
+     */
+    precision(numberOfDigits) {
+        return this.cloneAndUpdateSchema({ precision: numberOfDigits });
+    }
 }
 export class JsonSchemaBooleanBuilder extends JsonSchemaAnyBuilder {
     constructor() {
@@ -971,12 +983,19 @@ function objectDbEntity(props) {
 }
 function record(keySchema, valueSchema) {
     const keyJsonSchema = keySchema.build();
+    // Check if value schema is optional before build() strips the optionalField flag
+    const isValueOptional = valueSchema.getSchema()
+        .optionalField;
     const valueJsonSchema = valueSchema.build();
+    // When value schema is optional, wrap in anyOf to allow undefined values
+    const finalValueSchema = isValueOptional
+        ? { anyOf: [{ isUndefined: true }, valueJsonSchema] }
+        : valueJsonSchema;
     return new JsonSchemaObjectBuilder([], {
         hasIsOfTypeCheck: false,
         keySchema: keyJsonSchema,
         patternProperties: {
-            ['^.*$']: valueJsonSchema,
+            ['^.*$']: finalValueSchema,
         },
     });
 }

package/package.json

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

package/src/validation/ajv/getAjv.ts

@@ -1,4 +1,4 @@
-import { _isBetween, _lazyValue } from '@naturalcycles/js-lib'
+import { _isBetween, _lazyValue, _round } from '@naturalcycles/js-lib'
 import { _assert } from '@naturalcycles/js-lib/error'
 import { _deepCopy, _mapObject, Set2 } from '@naturalcycles/js-lib/object'
 import { _substringAfterLast } from '@naturalcycles/js-lib/string'
@@ -486,6 +486,16 @@ export function createAjv(opt?: Options): Ajv2020 {
     },
   })
 
+  // Validates that the value is undefined. Used in record/stringMap with optional value schemas
+  // to allow undefined values in patternProperties via anyOf.
+  ajv.addKeyword({
+    keyword: 'isUndefined',
+    modifying: false,
+    errors: false,
+    schemaType: 'boolean',
+    validate: (_schema: boolean, data: unknown) => data === undefined,
+  })
+
   // This is added because Ajv validates the `min/maxProperties` before validating the properties.
   // So, in case of `minProperties(1)` and `{ foo: 'bar' }` Ajv will let it pass, even
   // if the property validation would strip `foo` from the data.
@@ -639,6 +649,26 @@ export function createAjv(opt?: Options): Ajv2020 {
     },
   })
 
+  ajv.addKeyword({
+    keyword: 'precision',
+    type: ['number'],
+    modifying: true,
+    errors: false,
+    schemaType: 'number',
+    validate: function validate(numberOfDigits: number, data: number, _schema, ctx) {
+      if (!numberOfDigits) return true
+
+      _assert(
+        ctx?.parentData && ctx.parentDataProperty !== undefined,
+        'You should only use `precision(n) on a property of an object, or on an element of an array due to Ajv mutation issues.',
+      )
+
+      ctx.parentData[ctx.parentDataProperty] = _round(data, 10 ** (-1 * numberOfDigits))
+
+      return true
+    },
+  })
+
   return ajv
 }
 

package/src/validation/ajv/jsonSchemaBuilder.ts

@@ -80,14 +80,18 @@ export const j = {
     stringMap<S extends JsonSchemaTerminal<any, any, any>>(
       schema: S,
     ): JsonSchemaObjectBuilder<StringMap<SchemaIn<S>>, StringMap<SchemaOut<S>>> {
+      const isValueOptional = schema.getSchema().optionalField
       const builtSchema = schema.build()
+      const finalValueSchema: JsonSchema = isValueOptional
+        ? { anyOf: [{ isUndefined: true }, builtSchema] }
+        : builtSchema
 
       return new JsonSchemaObjectBuilder<StringMap<SchemaIn<S>>, StringMap<SchemaOut<S>>>(
         {},
         {
           hasIsOfTypeCheck: false,
           patternProperties: {
-            '^.+$': builtSchema,
+            '^.+$': finalValueSchema,
           },
         },
       )
@@ -888,6 +892,15 @@ export class JsonSchemaNumberBuilder<
   utcOffsetHour(): this {
     return this.integer().min(-12).max(14)
   }
+
+  /**
+   * Specify the precision of the floating point numbers by the number of digits after the ".".
+   * Excess digits will be cut-off when the current schema is nested in an object or array schema,
+   * due to how mutability works in Ajv.
+   */
+  precision(numberOfDigits: number): this {
+    return this.cloneAndUpdateSchema({ precision: numberOfDigits })
+  }
 }
 
 export class JsonSchemaBooleanBuilder<
@@ -1565,6 +1578,7 @@ export interface JsonSchema<IN = unknown, OUT = IN> {
   errorMessages?: StringMap<string>
   optionalValues?: (string | number | boolean | null)[]
   keySchema?: JsonSchema
+  isUndefined?: true
   minProperties2?: number
   exclusiveProperties?: (readonly string[])[]
   anyOfBy?: {
@@ -1572,6 +1586,7 @@ export interface JsonSchema<IN = unknown, OUT = IN> {
     schemaDictionary: Record<string, JsonSchema>
   }
   anyOfThese?: JsonSchema[]
+  precision?: number
 }
 
 function object(props: AnyObject): never
@@ -1638,8 +1653,16 @@ function record<
   false
 > {
   const keyJsonSchema = keySchema.build()
+  // Check if value schema is optional before build() strips the optionalField flag
+  const isValueOptional = (valueSchema as JsonSchemaTerminal<any, any, any>).getSchema()
+    .optionalField
   const valueJsonSchema = valueSchema.build()
 
+  // When value schema is optional, wrap in anyOf to allow undefined values
+  const finalValueSchema: JsonSchema = isValueOptional
+    ? { anyOf: [{ isUndefined: true }, valueJsonSchema] }
+    : valueJsonSchema
+
   return new JsonSchemaObjectBuilder<
     Opt extends true
       ? Partial<Record<SchemaIn<KS>, SchemaIn<VS>>>
@@ -1652,7 +1675,7 @@ function record<
     hasIsOfTypeCheck: false,
     keySchema: keyJsonSchema,
     patternProperties: {
-      ['^.*$']: valueJsonSchema,
+      ['^.*$']: finalValueSchema,
     },
   })
 }