@naturalcycles/nodejs-lib 15.75.0 → 15.77.0

package/dist/validation/ajv/getAjv.js

@@ -448,6 +448,35 @@ export function createAjv(opt) {
             return isValid;
         },
     });
+    ajv.addKeyword({
+        keyword: 'exclusiveProperties',
+        type: 'object',
+        modifying: false,
+        errors: true,
+        schemaType: 'array',
+        validate: function validate(exclusiveProperties, data, _schema, ctx) {
+            if (typeof data !== 'object')
+                return true;
+            for (const props of exclusiveProperties) {
+                let numberOfDefinedProperties = 0;
+                for (const prop of props) {
+                    if (data[prop] !== undefined)
+                        numberOfDefinedProperties++;
+                    if (numberOfDefinedProperties > 1) {
+                        ;
+                        validate.errors = [
+                            {
+                                instancePath: ctx?.instancePath ?? '',
+                                message: `must have only one of the "${props.join(', ')}" properties`,
+                            },
+                        ];
+                        return false;
+                    }
+                }
+            }
+            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

@@ -1,6 +1,11 @@
 import type { Set2 } from '@naturalcycles/js-lib/object';
 import { type AnyObject, type BaseDBEntity, type IANATimezone, type Inclusiveness, type IsoDate, type IsoDateTime, type IsoMonth, type NumberEnum, type StringEnum, type StringMap, type UnixTimestamp, type UnixTimestampMillis } from '@naturalcycles/js-lib/types';
 export declare const j: {
+    /**
+     * Matches literally any value - equivalent to TypeScript's `any` type.
+     * Use sparingly, as it bypasses type validation entirely.
+     */
+    any(): JsonSchemaAnyBuilder<any, any, false>;
     string(): JsonSchemaStringBuilder<string, string, false>;
     number(): JsonSchemaNumberBuilder<number, number, false>;
     boolean(): JsonSchemaBooleanBuilder<boolean, boolean, false>;
@@ -285,6 +290,7 @@ export declare class JsonSchemaObjectBuilder<IN extends AnyObject, OUT extends A
     } & {}, false>;
     minProperties(minProperties: number): this;
     maxProperties(maxProperties: number): this;
+    exclusiveProperties(propNames: readonly (keyof IN & string)[]): this;
 }
 interface JsonSchemaObjectBuilderOpts {
     hasIsOfTypeCheck?: false;
@@ -409,6 +415,7 @@ export interface JsonSchema<IN = unknown, OUT = IN> {
     optionalValues?: (string | number | boolean)[];
     keySchema?: JsonSchema;
     minProperties2?: number;
+    exclusiveProperties?: (readonly string[])[];
 }
 declare function object(props: AnyObject): never;
 declare function object<IN extends AnyObject>(props: {

package/dist/validation/ajv/jsonSchemaBuilder.js

@@ -9,6 +9,13 @@ import { BASE64URL_REGEX, COUNTRY_CODE_REGEX, CURRENCY_REGEX, IPV4_REGEX, IPV6_R
 import { TIMEZONES } from '../timezones.js';
 import { isEveryItemNumber, isEveryItemPrimitive, isEveryItemString, JSON_SCHEMA_ORDER, mergeJsonSchemaObjects, } from './jsonSchemaBuilder.util.js';
 export const j = {
+    /**
+     * Matches literally any value - equivalent to TypeScript's `any` type.
+     * Use sparingly, as it bypasses type validation entirely.
+     */
+    any() {
+        return new JsonSchemaAnyBuilder({});
+    },
     string() {
         return new JsonSchemaStringBuilder();
     },
@@ -649,6 +656,10 @@ export class JsonSchemaObjectBuilder extends JsonSchemaAnyBuilder {
     maxProperties(maxProperties) {
         return this.cloneAndUpdateSchema({ maxProperties });
     }
+    exclusiveProperties(propNames) {
+        const exclusiveProperties = this.schema.exclusiveProperties ?? [];
+        return this.cloneAndUpdateSchema({ exclusiveProperties: [...exclusiveProperties, propNames] });
+    }
 }
 export class JsonSchemaObjectInferringBuilder extends JsonSchemaAnyBuilder {
     constructor(props) {

package/package.json

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

package/src/validation/ajv/getAjv.ts

@@ -513,6 +513,35 @@ export function createAjv(opt?: Options): Ajv2020 {
     },
   })
 
+  ajv.addKeyword({
+    keyword: 'exclusiveProperties',
+    type: 'object',
+    modifying: false,
+    errors: true,
+    schemaType: 'array',
+    validate: function validate(exclusiveProperties: string[][], data: AnyObject, _schema, ctx) {
+      if (typeof data !== 'object') return true
+
+      for (const props of exclusiveProperties) {
+        let numberOfDefinedProperties = 0
+        for (const prop of props) {
+          if (data[prop] !== undefined) numberOfDefinedProperties++
+          if (numberOfDefinedProperties > 1) {
+            ;(validate as any).errors = [
+              {
+                instancePath: ctx?.instancePath ?? '',
+                message: `must have only one of the "${props.join(', ')}" properties`,
+              },
+            ]
+            return false
+          }
+        }
+      }
+
+      return true
+    },
+  })
+
   return ajv
 }
 

package/src/validation/ajv/jsonSchemaBuilder.ts

@@ -49,6 +49,14 @@ import {
 } from './jsonSchemaBuilder.util.js'
 
 export const j = {
+  /**
+   * Matches literally any value - equivalent to TypeScript's `any` type.
+   * Use sparingly, as it bypasses type validation entirely.
+   */
+  any(): JsonSchemaAnyBuilder<any, any, false> {
+    return new JsonSchemaAnyBuilder({})
+  },
+
   string(): JsonSchemaStringBuilder<string, string, false> {
     return new JsonSchemaStringBuilder()
   },
@@ -950,6 +958,11 @@ export class JsonSchemaObjectBuilder<
   maxProperties(maxProperties: number): this {
     return this.cloneAndUpdateSchema({ maxProperties })
   }
+
+  exclusiveProperties(propNames: readonly (keyof IN & string)[]): this {
+    const exclusiveProperties = this.schema.exclusiveProperties ?? []
+    return this.cloneAndUpdateSchema({ exclusiveProperties: [...exclusiveProperties, propNames] })
+  }
 }
 
 interface JsonSchemaObjectBuilderOpts {
@@ -1264,6 +1277,7 @@ export interface JsonSchema<IN = unknown, OUT = IN> {
   optionalValues?: (string | number | boolean)[]
   keySchema?: JsonSchema
   minProperties2?: number
+  exclusiveProperties?: (readonly string[])[]
 }
 
 function object(props: AnyObject): never