@naturalcycles/nodejs-lib 15.43.2 → 15.45.0

package/dist/validation/ajv/getAjv.js

@@ -2,7 +2,7 @@ import { _lazyValue } from '@naturalcycles/js-lib';
 import { Set2 } from '@naturalcycles/js-lib/object';
 import { _substringAfterLast } from '@naturalcycles/js-lib/string';
 import { _, Ajv } from 'ajv';
-import { validTLDs } from './tlds.js';
+import { validTLDs } from '../tlds.js';
 /* eslint-disable @typescript-eslint/prefer-string-starts-ends-with */
 // oxlint-disable unicorn/prefer-code-point
 const AJV_OPTIONS = {

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

@@ -1,5 +1,5 @@
 import type { Set2 } from '@naturalcycles/js-lib/object';
-import { type AnyObject, type IsoDate, type IsoDateTime, type NumberEnum, type StringEnum, type StringMap, type UnixTimestamp, type UnixTimestampMillis } from '@naturalcycles/js-lib/types';
+import { type AnyObject, type IANATimezone, type Inclusiveness, type IsoDate, type IsoDateTime, type NumberEnum, type StringEnum, type StringMap, type UnixTimestamp, type UnixTimestampMillis } from '@naturalcycles/js-lib/types';
 export declare const j: {
     string(): JsonSchemaStringBuilder<string, string, false>;
     number(): JsonSchemaNumberBuilder<number, number, false>;
@@ -12,7 +12,7 @@ export declare const j: {
     array<IN, OUT, Opt>(itemSchema: JsonSchemaAnyBuilder<IN, OUT, Opt>): JsonSchemaArrayBuilder<IN, OUT, Opt>;
     set<IN, OUT, Opt>(itemSchema: JsonSchemaAnyBuilder<IN, OUT, Opt>): JsonSchemaSet2Builder<IN, OUT, Opt>;
     buffer(): JsonSchemaBufferBuilder;
-    enum<const T extends readonly (string | number | boolean | null)[] | StringEnum | NumberEnum>(input: T): JsonSchemaEnumBuilder<T extends readonly (infer U)[] ? U : T extends StringEnum ? T[keyof T] : T extends NumberEnum ? T[keyof T] : never>;
+    enum<const T extends readonly (string | number | boolean | null)[] | StringEnum | NumberEnum>(input: T, opt?: JsonBuilderRuleOpt): JsonSchemaEnumBuilder<T extends readonly (infer U)[] ? U : T extends StringEnum ? T[keyof T] : T extends NumberEnum ? T[keyof T] : never>;
     oneOf<B extends readonly JsonSchemaAnyBuilder<any, any, boolean>[], IN = BuilderInUnion<B>, OUT = BuilderOutUnion<B>>(items: [...B]): JsonSchemaAnyBuilder<IN, OUT, false>;
 };
 export declare class JsonSchemaAnyBuilder<IN, OUT, Opt> {
@@ -91,6 +91,13 @@ export declare class JsonSchemaStringBuilder<IN extends string = string, OUT = I
     languageTag(): this;
     countryCode(): this;
     currency(): this;
+    /**
+     * Validates that the input is a valid IANATimzone value.
+     *
+     * All previous expectations in the schema chain are dropped - including `.optional()` -
+     * because this call effectively starts a new schema chain as an `enum` validation.
+     */
+    ianaTimezone(): JsonSchemaEnumBuilder<string | IANATimezone, IANATimezone, false>;
 }
 export interface JsonSchemaStringEmailOptions {
     checkTLD: boolean;
@@ -104,10 +111,11 @@ export declare class JsonSchemaNumberBuilder<IN extends number = number, OUT = I
     exclusiveMin(exclusiveMinimum: number): this;
     max(maximum: number): this;
     exclusiveMax(exclusiveMaximum: number): this;
-    /**
-     * Both ranges are inclusive.
-     */
-    range(minimum: number, maximum: number): this;
+    lessThan(value: number): this;
+    lessThanOrEqual(value: number): this;
+    moreThan(value: number): this;
+    moreThanOrEqual(value: number): this;
+    range(minimum: number, maximum: number, incl: Inclusiveness): this;
     int32(): this;
     int64(): this;
     float(): this;
@@ -156,7 +164,7 @@ export declare class JsonSchemaObjectInferringBuilder<PROPS extends Record<strin
     /**
      * Extends the current schema with `id`, `created` and `updated` according to NC DB conventions.
      */
-    dbEntity(): JsonSchemaObjectInferringBuilder<{ [K in keyof PROPS | "id" | "created" | "updated"]: K extends "id" | "created" | "updated" ? {
+    dbEntity(): JsonSchemaObjectInferringBuilder<{ [K in "id" | keyof PROPS | "created" | "updated"]: K extends "id" | "created" | "updated" ? {
         id: JsonSchemaStringBuilder<string, string, false>;
         created: JsonSchemaNumberBuilder<UnixTimestamp, UnixTimestamp, false>;
         updated: JsonSchemaNumberBuilder<UnixTimestamp, UnixTimestamp, false>;
@@ -177,7 +185,8 @@ 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[]);
+    constructor(enumValues: readonly IN[], opt?: JsonBuilderRuleOpt);
+    branded<B extends IN>(): JsonSchemaEnumBuilder<B | IN, B, Opt>;
 }
 export interface JsonSchema<IN = unknown, OUT = IN> {
     readonly in?: IN;
@@ -256,6 +265,17 @@ type BuilderInUnion<B extends readonly JsonSchemaAnyBuilder<any, any, any>[]> =
     [K in keyof B]: B[K] extends JsonSchemaAnyBuilder<infer I, any, any> ? I : never;
 }[number];
 interface JsonBuilderRuleOpt {
+    /**
+     * Text of error message to return when the validation fails for the given rule:
+     *
+     * `{ msg: "is not a valid Oompa-loompa" } => "Object.property is not a valid Oompa-loompa"`
+     */
     msg?: string;
+    /**
+     * A friendly name for what we are validating, that will be used in error messages:
+     *
+     * `{ name: "Oompa-loompa" } => "Object.property is not a valid Oompa-loompa"`
+     */
+    name?: string;
 }
 export {};

package/dist/validation/ajv/jsonSchemaBuilder.js

@@ -5,6 +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 { JWT_REGEX, } from '@naturalcycles/js-lib/types';
+import { TIMEZONES } from '../timezones.js';
 import { JSON_SCHEMA_ORDER, mergeJsonSchemaObjects } from './jsonSchemaBuilder.util.js';
 export const j = {
     string() {
@@ -32,7 +33,7 @@ export const j = {
     buffer() {
         return new JsonSchemaBufferBuilder();
     },
-    enum(input) {
+    enum(input, opt) {
         let enumValues;
         if (Array.isArray(input)) {
             enumValues = input;
@@ -47,7 +48,7 @@ export const j = {
             }
         }
         _assert(enumValues, 'Unsupported enum input');
-        return new JsonSchemaEnumBuilder(enumValues);
+        return new JsonSchemaEnumBuilder(enumValues, opt);
     },
     oneOf(items) {
         const schemas = items.map(b => b.build());
@@ -177,6 +178,8 @@ export class JsonSchemaStringBuilder extends JsonSchemaAnyBuilder {
         return this.pattern(pattern.source, opt);
     }
     pattern(pattern, opt) {
+        if (opt?.name)
+            this.setErrorMessage('pattern', `is not a valid ${opt.name}`);
         if (opt?.msg)
             this.setErrorMessage('pattern', opt.msg);
         Object.assign(this.schema, { pattern });
@@ -275,6 +278,16 @@ export class JsonSchemaStringBuilder extends JsonSchemaAnyBuilder {
         const regex = /^[A-Z]{3}$/;
         return this.regex(regex, { msg: 'is not a valid currency format' });
     }
+    /**
+     * Validates that the input is a valid IANATimzone value.
+     *
+     * All previous expectations in the schema chain are dropped - including `.optional()` -
+     * because this call effectively starts a new schema chain as an `enum` validation.
+     */
+    ianaTimezone() {
+        // UTC is added to assist unit-testing, which uses UTC by default (not technically a valid Iana timezone identifier)
+        return j.enum(TIMEZONES, { msg: 'is an invalid IANA timezone' }).branded();
+    }
 }
 export class JsonSchemaNumberBuilder extends JsonSchemaAnyBuilder {
     constructor() {
@@ -309,12 +322,23 @@ export class JsonSchemaNumberBuilder extends JsonSchemaAnyBuilder {
         Object.assign(this.schema, { exclusiveMaximum });
         return this;
     }
-    /**
-     * Both ranges are inclusive.
-     */
-    range(minimum, maximum) {
-        Object.assign(this.schema, { minimum, maximum });
-        return this;
+    lessThan(value) {
+        return this.exclusiveMax(value);
+    }
+    lessThanOrEqual(value) {
+        return this.max(value);
+    }
+    moreThan(value) {
+        return this.exclusiveMin(value);
+    }
+    moreThanOrEqual(value) {
+        return this.min(value);
+    }
+    range(minimum, maximum, incl) {
+        if (incl === '[)') {
+            return this.moreThanOrEqual(minimum).lessThan(maximum);
+        }
+        return this.moreThanOrEqual(minimum).lessThanOrEqual(maximum);
     }
     int32() {
         const MIN_INT32 = -(2 ** 31);
@@ -520,8 +544,15 @@ export class JsonSchemaBufferBuilder extends JsonSchemaAnyBuilder {
     }
 }
 export class JsonSchemaEnumBuilder extends JsonSchemaAnyBuilder {
-    constructor(enumValues) {
+    constructor(enumValues, opt) {
         super({ enum: enumValues });
+        if (opt?.name)
+            this.setErrorMessage('pattern', `is not a valid ${opt.name}`);
+        if (opt?.msg)
+            this.setErrorMessage('enum', opt.msg);
+    }
+    branded() {
+        return this;
     }
 }
 function object(props) {

package/dist/validation/timezones.d.ts

@@ -0,0 +1,9 @@
+/**
+ * A complicated merge of timezones from the underlying Javascript engine
+ * and a list exported from Wikipedia.
+ *
+ * Why? The `Int.supportedValuesOf('timeZone')` we use provide only
+ * canonical/standardized timezone values like `Europe/Stockholm`
+ * but does not list accepted aliases like `ETC/Gmt`, `CET` or `Canada/Atlantic`.
+ */
+export declare const TIMEZONES: any;