@naturalcycles/nodejs-lib 15.60.0 → 15.61.0

package/dist/validation/ajv/getAjv.js

@@ -1,4 +1,4 @@
-import { _lazyValue } from '@naturalcycles/js-lib';
+import { _isBetween, _lazyValue } from '@naturalcycles/js-lib';
 import { Set2 } from '@naturalcycles/js-lib/object';
 import { _substringAfterLast } from '@naturalcycles/js-lib/string';
 import { Ajv } from 'ajv';
@@ -349,6 +349,25 @@ export function createAjv(opt) {
             return false;
         },
     });
+    ajv.addKeyword({
+        keyword: 'IsoMonth',
+        type: 'string',
+        modifying: false,
+        errors: true,
+        schemaType: 'object',
+        validate: function validate(_opt, data, _schema, ctx) {
+            const isValid = isIsoMonthValid(data);
+            if (isValid)
+                return true;
+            validate.errors = [
+                {
+                    instancePath: ctx?.instancePath ?? '',
+                    message: `is an invalid IsoMonth`,
+                },
+            ];
+            return false;
+        },
+    });
     ajv.addKeyword({
         keyword: 'errorMessages',
         schemaType: 'object',
@@ -516,3 +535,21 @@ function isIsoTimezoneValid(s) {
         return false; // min is -12:00
     return true;
 }
+/**
+ * This is a performance optimized correct validation
+ * for ISO month formatted as "YYYY-MM".
+ */
+function isIsoMonthValid(s) {
+    // must be exactly "YYYY-MM"
+    if (s.length !== 7)
+        return false;
+    if (s.charCodeAt(4) !== DASH_CODE)
+        return false;
+    // fast parse numbers without substrings/Number()
+    const year = (s.charCodeAt(0) - ZERO_CODE) * 1000 +
+        (s.charCodeAt(1) - ZERO_CODE) * 100 +
+        (s.charCodeAt(2) - ZERO_CODE) * 10 +
+        (s.charCodeAt(3) - ZERO_CODE);
+    const month = (s.charCodeAt(5) - ZERO_CODE) * 10 + (s.charCodeAt(6) - ZERO_CODE);
+    return _isBetween(year, 1900, 2500, '[]') && _isBetween(month, 1, 12, '[]');
+}

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

@@ -1,5 +1,5 @@
 import type { Set2 } from '@naturalcycles/js-lib/object';
-import { type AnyObject, type BaseDBEntity, type IANATimezone, type Inclusiveness, type IsoDate, type IsoDateTime, type NumberEnum, type StringEnum, type StringMap, type UnixTimestamp, type UnixTimestampMillis } from '@naturalcycles/js-lib/types';
+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: {
     string(): JsonSchemaStringBuilder<string, string, false>;
     number(): JsonSchemaNumberBuilder<number, number, false>;
@@ -139,6 +139,7 @@ export declare class JsonSchemaStringBuilder<IN extends string | undefined = str
      */
     isoDate(): JsonSchemaIsoDateBuilder;
     isoDateTime(): JsonSchemaStringBuilder<IsoDateTime | IN, IsoDateTime, Opt>;
+    isoMonth(): JsonSchemaIsoMonthBuilder;
     /**
      * Validates the string format to be JWT.
      * Expects the JWT to be signed!
@@ -179,6 +180,11 @@ export interface JsonSchemaIsoDateOptions {
     after?: string;
     sameOrAfter?: string;
 }
+export declare class JsonSchemaIsoMonthBuilder<Opt extends boolean = false> extends JsonSchemaAnyBuilder<string | IsoDate, IsoMonth, Opt> {
+    constructor();
+}
+export interface JsonSchemaIsoMonthOptions {
+}
 export declare class JsonSchemaNumberBuilder<IN extends number | undefined = number, OUT = IN, Opt extends boolean = false> extends JsonSchemaAnyBuilder<IN, OUT, Opt> {
     constructor();
     /**
@@ -343,6 +349,7 @@ export interface JsonSchema<IN = unknown, OUT = IN> {
     Buffer?: true;
     IsoDate?: JsonSchemaIsoDateOptions;
     IsoDateTime?: true;
+    IsoMonth?: JsonSchemaIsoMonthOptions;
     instanceof?: string | string[];
     transform?: {
         trim?: true;

package/dist/validation/ajv/jsonSchemaBuilder.js

@@ -322,6 +322,9 @@ export class JsonSchemaStringBuilder extends JsonSchemaAnyBuilder {
     isoDateTime() {
         return this.cloneAndUpdateSchema({ IsoDateTime: true }).branded();
     }
+    isoMonth() {
+        return new JsonSchemaIsoMonthBuilder();
+    }
     /**
      * Validates the string format to be JWT.
      * Expects the JWT to be signed!
@@ -404,6 +407,14 @@ export class JsonSchemaIsoDateBuilder extends JsonSchemaAnyBuilder {
         return this.cloneAndUpdateSchema(schemaPatch);
     }
 }
+export class JsonSchemaIsoMonthBuilder extends JsonSchemaAnyBuilder {
+    constructor() {
+        super({
+            type: 'string',
+            IsoMonth: {},
+        });
+    }
+}
 export class JsonSchemaNumberBuilder extends JsonSchemaAnyBuilder {
     constructor() {
         super({

package/package.json

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

package/src/validation/ajv/getAjv.ts

@@ -1,10 +1,14 @@
-import { _lazyValue } from '@naturalcycles/js-lib'
+import { _isBetween, _lazyValue } from '@naturalcycles/js-lib'
 import { Set2 } from '@naturalcycles/js-lib/object'
 import { _substringAfterLast } from '@naturalcycles/js-lib/string'
 import type { AnyObject } from '@naturalcycles/js-lib/types'
 import { Ajv, type Options, type ValidateFunction } from 'ajv'
 import { validTLDs } from '../tlds.js'
-import type { JsonSchemaIsoDateOptions, JsonSchemaStringEmailOptions } from './jsonSchemaBuilder.js'
+import type {
+  JsonSchemaIsoDateOptions,
+  JsonSchemaIsoMonthOptions,
+  JsonSchemaStringEmailOptions,
+} from './jsonSchemaBuilder.js'
 
 /* eslint-disable @typescript-eslint/prefer-string-starts-ends-with */
 // oxlint-disable unicorn/prefer-code-point
@@ -383,7 +387,7 @@ export function createAjv(opt?: Options): Ajv {
     modifying: false,
     errors: true,
     schemaType: 'boolean',
-    validate: function validate(_opt: true, data: string, _schema, ctx) {
+    validate: function validate(_opt: JsonSchemaIsoMonthOptions, data: string, _schema, ctx) {
       const isValid = isIsoDateTimeValid(data)
       if (isValid) return true
       ;(validate as any).errors = [
@@ -396,6 +400,25 @@ export function createAjv(opt?: Options): Ajv {
     },
   })
 
+  ajv.addKeyword({
+    keyword: 'IsoMonth',
+    type: 'string',
+    modifying: false,
+    errors: true,
+    schemaType: 'object',
+    validate: function validate(_opt: true, data: string, _schema, ctx) {
+      const isValid = isIsoMonthValid(data)
+      if (isValid) return true
+      ;(validate as any).errors = [
+        {
+          instancePath: ctx?.instancePath ?? '',
+          message: `is an invalid IsoMonth`,
+        },
+      ]
+      return false
+    },
+  })
+
   ajv.addKeyword({
     keyword: 'errorMessages',
     schemaType: 'object',
@@ -577,3 +600,24 @@ function isIsoTimezoneValid(s: string): boolean {
 
   return true
 }
+
+/**
+ * This is a performance optimized correct validation
+ * for ISO month formatted as "YYYY-MM".
+ */
+function isIsoMonthValid(s: string): boolean {
+  // must be exactly "YYYY-MM"
+  if (s.length !== 7) return false
+  if (s.charCodeAt(4) !== DASH_CODE) return false
+
+  // fast parse numbers without substrings/Number()
+  const year =
+    (s.charCodeAt(0) - ZERO_CODE) * 1000 +
+    (s.charCodeAt(1) - ZERO_CODE) * 100 +
+    (s.charCodeAt(2) - ZERO_CODE) * 10 +
+    (s.charCodeAt(3) - ZERO_CODE)
+
+  const month = (s.charCodeAt(5) - ZERO_CODE) * 10 + (s.charCodeAt(6) - ZERO_CODE)
+
+  return _isBetween(year, 1900, 2500, '[]') && _isBetween(month, 1, 12, '[]')
+}

package/src/validation/ajv/jsonSchemaBuilder.ts

@@ -19,6 +19,7 @@ import {
   type Inclusiveness,
   type IsoDate,
   type IsoDateTime,
+  type IsoMonth,
   JWT_REGEX,
   type NumberEnum,
   type StringEnum,
@@ -453,6 +454,10 @@ export class JsonSchemaStringBuilder<
     return this.cloneAndUpdateSchema({ IsoDateTime: true }).branded<IsoDateTime>()
   }
 
+  isoMonth(): JsonSchemaIsoMonthBuilder {
+    return new JsonSchemaIsoMonthBuilder()
+  }
+
   /**
    * Validates the string format to be JWT.
    * Expects the JWT to be signed!
@@ -570,6 +575,21 @@ export interface JsonSchemaIsoDateOptions {
   sameOrAfter?: string
 }
 
+export class JsonSchemaIsoMonthBuilder<Opt extends boolean = false> extends JsonSchemaAnyBuilder<
+  string | IsoDate,
+  IsoMonth,
+  Opt
+> {
+  constructor() {
+    super({
+      type: 'string',
+      IsoMonth: {},
+    })
+  }
+}
+
+export interface JsonSchemaIsoMonthOptions {}
+
 export class JsonSchemaNumberBuilder<
   IN extends number | undefined = number,
   OUT = IN,
@@ -1126,6 +1146,7 @@ export interface JsonSchema<IN = unknown, OUT = IN> {
   Buffer?: true
   IsoDate?: JsonSchemaIsoDateOptions
   IsoDateTime?: true
+  IsoMonth?: JsonSchemaIsoMonthOptions
   instanceof?: string | string[]
   transform?: { trim?: true; toLowerCase?: true; toUpperCase?: true; truncate?: number }
   errorMessages?: StringMap<string>