@naturalcycles/nodejs-lib 15.121.1 → 15.122.1

package/dist/exec2/exec2.js

@@ -277,8 +277,15 @@ class Exec2 {
         }
     }
     logFinish(cmd, opt, started, isSuccessful) {
-        if (isSuccessful && !opt.logFinish)
-            return;
+        if (!opt.logFinish) {
+            if (isSuccessful)
+                return;
+            // Failures are logged even with logFinish: false,
+            // unless explicitly silenced with `log: false`
+            // (e.g when the caller buffers the output to print it later, like runCheck does)
+            if (opt.log === false)
+                return;
+        }
         console.log([
             isSuccessful ? ' ✓' : ' ×',
             white(opt.name || _substringAfterLast(cmd, '/')),

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

@@ -2,7 +2,7 @@ import type { ValidationFunction, ValidationFunctionResult } from '@naturalcycle
 import type { Set2 } from '@naturalcycles/js-lib/object';
 import type { AnyObject, BaseDBEntity, IANATimezone, Inclusiveness, IsoDate, IsoDateTime, IsoMonth, NumberEnum, StringEnum, StringMap, UnixTimestamp, UnixTimestampMillis } from '@naturalcycles/js-lib/types';
 import type { StandardJSONSchemaV1, StandardSchemaV1 } from '@standard-schema/spec';
-import type { Ajv } from 'ajv';
+import type { Ajv, ValidateFunction } from 'ajv';
 import { AjvValidationError } from './ajvValidationError.js';
 export declare const j: {
     /**
@@ -480,12 +480,12 @@ export declare class AjvSchema<OUT> {
      * Creates a minimal AjvSchema wrapper from a pre-compiled validate function.
      * Used internally by JSchema to cache a compatible AjvSchema instance.
      */
-    static _wrap<OUT>(schema: JsonSchema<OUT>, compiledFn: any): AjvSchema<OUT>;
+    static _wrap<OUT>(schema: JsonSchema<OUT>, compiledFn: ValidateFunction): AjvSchema<OUT>;
     static isSchemaWithCachedAjvSchema<Base, OUT>(schema: Base): schema is WithCachedAjvSchema<Base, OUT>;
     static cacheAjvSchema<Base extends AnyObject, OUT>(schema: Base, ajvSchema: AjvSchema<OUT>): WithCachedAjvSchema<Base, OUT>;
     static requireCachedAjvSchema<Base, OUT>(schema: WithCachedAjvSchema<Base, OUT>): AjvSchema<OUT>;
     readonly cfg: AjvSchemaCfg;
-    private _compiledFn;
+    private _compiledFn?;
     private _getValidateFn;
     /**
      * It returns the original object just for convenience.

package/dist/validation/ajv/jSchema.js

@@ -1174,6 +1174,9 @@ function executeValidation(fn, builtSchema, input, opt = {}, defaultInputName) {
             fn.errors = [
                 {
                     instancePath: '',
+                    schemaPath: '',
+                    keyword: 'postValidation',
+                    params: {},
                     message: err.message,
                 },
             ];
@@ -1190,15 +1193,40 @@ function executeValidation(fn, builtSchema, input, opt = {}, defaultInputName) {
     // Build fingerprint before applyImprovementsOnErrorMessages: after it, /items/0/name becomes
     // .items[0].name, embedding the index into the segment and making it harder to strip without regex
     const fingerprint = buildAjvErrorFingerprint(errors[0], inputName, resolveCustomErrorMessage(builtSchema, errors[0]));
-    applyImprovementsOnErrorMessages(errors, builtSchema);
-    let message = getAjv().errorsText(errors, {
-        dataVar,
-        separator,
-    });
     // Note: if we mutated the input already, e.g stripped unknown properties,
     // the error message Input would contain already mutated object print, such as Input: {}
     // Unless `getOriginalInput` function is provided - then it will be used to preserve the Input pureness.
-    const inputStringified = _inspect(opt.getOriginalInput?.() || input, { maxLen: 4000 });
+    const inputForPrint = opt.getOriginalInput?.() || input;
+    // Resolve each error's failing value while its instancePath is still a raw JSON pointer
+    // (e.g `/events/2/name`), which is unambiguous to walk - unlike the dot notation it gets
+    // rewritten into below (a property name may itself contain a dot).
+    // Root errors (empty instancePath) resolve to undefined - there the value is the whole Input,
+    // which is printed anyway.
+    // `required` errors also resolve to undefined - their instancePath points at the parent object
+    // that lacks the property, so `got:` would print that whole object - noise next to the Input print.
+    const failingValueByError = new Map(errors.map(e => [
+        e,
+        e.instancePath && e.keyword !== 'required'
+            ? getValueAtJsonPointer(inputForPrint, e.instancePath)
+            : undefined,
+    ]));
+    applyImprovementsOnErrorMessages(errors, builtSchema);
+    // Same line format as Ajv's errorsText().
+    // Each error line is followed by a `Got: ...` line printing the narrow failing value itself,
+    // so it stays visible even when the Input print below gets truncated for large inputs.
+    // `Got` is a separate line (and is allowed to print multi-line) on purpose: consumers that
+    // only take the first line of the message keep getting the unchanged (pre-Got) error line.
+    let message = errors
+        .flatMap(e => {
+        const lines = [`${dataVar}${e.instancePath} ${e.message}`];
+        const value = failingValueByError.get(e);
+        if (value !== undefined) {
+            lines.push(`Got: ${_inspect(value, { maxLen: 500 })}`);
+        }
+        return lines;
+    })
+        .join(separator);
+    const inputStringified = _inspect(inputForPrint, { maxLen: 4000 });
     message = [message, 'Input: ' + inputStringified].join(separator);
     const err = new AjvValidationError(message, _filterNullishValues({
         errors,
@@ -1209,6 +1237,19 @@ function executeValidation(fn, builtSchema, input, opt = {}, defaultInputName) {
     return [err, output];
 }
 // ==== Error formatting helpers ====
+/**
+ * Resolves the value at an Ajv error's raw instancePath, which is a JSON pointer, e.g `/events/2/name`.
+ * Returns undefined if the path cannot be resolved (e.g the input was mutated).
+ */
+function getValueAtJsonPointer(input, pointer) {
+    let value = input;
+    for (const segment of pointer.split('/').slice(1)) {
+        if (value === null || typeof value !== 'object')
+            return undefined;
+        value = value[segment.replaceAll('~1', '/').replaceAll('~0', '~')];
+    }
+    return value;
+}
 function applyImprovementsOnErrorMessages(errors, schema) {
     if (!errors)
         return;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@naturalcycles/nodejs-lib",
   "type": "module",
-  "version": "15.121.1",
+  "version": "15.122.1",
   "dependencies": {
     "@naturalcycles/js-lib": "^15",
     "@standard-schema/spec": "^1",
@@ -14,8 +14,8 @@
     "yaml": "^2"
   },
   "devDependencies": {
-    "typescript": "^7",
-    "@naturalcycles/dev-lib": "0.0.0"
+    "@naturalcycles/dev-lib": "0.0.0",
+    "typescript": "^7"
   },
   "exports": {
     ".": "./dist/index.js",

package/src/exec2/exec2.ts

@@ -332,7 +332,13 @@ class Exec2 {
     started: UnixTimestampMillis,
     isSuccessful: boolean,
   ): void {
-    if (isSuccessful && !opt.logFinish) return
+    if (!opt.logFinish) {
+      if (isSuccessful) return
+      // Failures are logged even with logFinish: false,
+      // unless explicitly silenced with `log: false`
+      // (e.g when the caller buffers the output to print it later, like runCheck does)
+      if (opt.log === false) return
+    }
 
     console.log(
       [

package/src/validation/ajv/jSchema.ts

@@ -27,7 +27,7 @@ import type {
 } from '@naturalcycles/js-lib/types'
 import { _objectAssign, _typeCast, JWT_REGEX } from '@naturalcycles/js-lib/types'
 import type { StandardJSONSchemaV1, StandardSchemaV1 } from '@standard-schema/spec'
-import type { Ajv, ErrorObject } from 'ajv'
+import type { Ajv, ErrorObject, ValidateFunction } from 'ajv'
 import { _inspect } from '../../string/inspect.js'
 import {
   BASE64URL_REGEX,
@@ -367,7 +367,7 @@ export class JSchema<OUT, Opt>
   }
 
   private _builtSchema?: JsonSchema
-  private _compiledFns?: WeakMap<Ajv, any>
+  private _compiledFns?: WeakMap<Ajv, ValidateFunction>
 
   private _getBuiltSchema(): JsonSchema {
     if (!this._builtSchema) {
@@ -387,7 +387,7 @@ export class JSchema<OUT, Opt>
     return this._builtSchema
   }
 
-  private _getCompiled(overrideAjv?: Ajv): { fn: any; builtSchema: JsonSchema } {
+  private _getCompiled(overrideAjv?: Ajv): { fn: ValidateFunction; builtSchema: JsonSchema } {
     const builtSchema = this._getBuiltSchema()
     const ajv = overrideAjv ?? this._cfg?.ajv ?? getAjv()
 
@@ -1105,18 +1105,22 @@ export class JObject<OUT extends AnyObject, Opt extends boolean = false> extends
         OUT,
         {
           // required keys
-          [K in keyof P as P[K] extends JSchema<any, infer IsOpt>
-            ? IsOpt extends true
-              ? never
-              : K
-            : never]: P[K] extends JSchema<infer OUT2, any> ? OUT2 : never
+          [
+            K in keyof P as P[K] extends JSchema<any, infer IsOpt>
+              ? IsOpt extends true
+                ? never
+                : K
+              : never
+          ]: P[K] extends JSchema<infer OUT2, any> ? OUT2 : never
         } & {
           // optional keys
-          [K in keyof P as P[K] extends JSchema<any, infer IsOpt>
-            ? IsOpt extends true
-              ? K
+          [
+            K in keyof P as P[K] extends JSchema<any, infer IsOpt>
+              ? IsOpt extends true
+                ? K
+                : never
               : never
-            : never]?: P[K] extends JSchema<infer OUT2, any> ? OUT2 : never
+          ]?: P[K] extends JSchema<infer OUT2, any> ? OUT2 : never
         }
       >
     >,
@@ -1185,17 +1189,21 @@ export class JObjectInfer<
 > extends JBuilder<
   Expand<
     {
-      [K in keyof PROPS as PROPS[K] extends JSchema<any, infer IsOpt>
-        ? IsOpt extends true
-          ? never
-          : K
-        : never]: PROPS[K] extends JSchema<infer OUT, any> ? OUT : never
+      [
+        K in keyof PROPS as PROPS[K] extends JSchema<any, infer IsOpt>
+          ? IsOpt extends true
+            ? never
+            : K
+          : never
+      ]: PROPS[K] extends JSchema<infer OUT, any> ? OUT : never
     } & {
-      [K in keyof PROPS as PROPS[K] extends JSchema<any, infer IsOpt>
-        ? IsOpt extends true
-          ? K
+      [
+        K in keyof PROPS as PROPS[K] extends JSchema<any, infer IsOpt>
+          ? IsOpt extends true
+            ? K
+            : never
           : never
-        : never]?: PROPS[K] extends JSchema<infer OUT, any> ? OUT : never
+      ]?: PROPS[K] extends JSchema<infer OUT, any> ? OUT : never
     }
   >,
   Opt
@@ -1516,7 +1524,7 @@ export class AjvSchema<OUT> {
   private constructor(
     public schema: JsonSchema<OUT>,
     cfg: Partial<AjvSchemaCfg> = {},
-    preCompiledFn?: any,
+    preCompiledFn?: ValidateFunction,
   ) {
     this.cfg = {
       lazy: false,
@@ -1585,7 +1593,7 @@ export class AjvSchema<OUT> {
    * Creates a minimal AjvSchema wrapper from a pre-compiled validate function.
    * Used internally by JSchema to cache a compatible AjvSchema instance.
    */
-  static _wrap<OUT>(schema: JsonSchema<OUT>, compiledFn: any): AjvSchema<OUT> {
+  static _wrap<OUT>(schema: JsonSchema<OUT>, compiledFn: ValidateFunction): AjvSchema<OUT> {
     return new AjvSchema<OUT>(schema, {}, compiledFn)
   }
 
@@ -1608,9 +1616,9 @@ export class AjvSchema<OUT> {
 
   readonly cfg: AjvSchemaCfg
 
-  private _compiledFn: any
+  private _compiledFn?: ValidateFunction
 
-  private _getValidateFn(): any {
+  private _getValidateFn(): ValidateFunction {
     this._compiledFn ||= this.cfg.ajv.compile(this.schema as any)
     return this._compiledFn
   }
@@ -1663,7 +1671,7 @@ export class AjvSchema<OUT> {
 const separator = '\n'
 
 function executeValidation<OUT>(
-  fn: any,
+  fn: ValidateFunction,
   builtSchema: JsonSchema,
   input: unknown,
   opt: AjvValidationOptions = {},
@@ -1685,6 +1693,9 @@ function executeValidation<OUT>(
       fn.errors = [
         {
           instancePath: '',
+          schemaPath: '',
+          keyword: 'postValidation',
+          params: {},
           message: err.message,
         },
       ]
@@ -1706,22 +1717,51 @@ function executeValidation<OUT>(
   // Build fingerprint before applyImprovementsOnErrorMessages: after it, /items/0/name becomes
   // .items[0].name, embedding the index into the segment and making it harder to strip without regex
   const fingerprint = buildAjvErrorFingerprint(
-    errors[0],
+    errors[0]!,
     inputName,
-    resolveCustomErrorMessage(builtSchema, errors[0]),
+    resolveCustomErrorMessage(builtSchema, errors[0]!),
   )
 
-  applyImprovementsOnErrorMessages(errors, builtSchema)
-
-  let message = getAjv().errorsText(errors, {
-    dataVar,
-    separator,
-  })
-
   // Note: if we mutated the input already, e.g stripped unknown properties,
   // the error message Input would contain already mutated object print, such as Input: {}
   // Unless `getOriginalInput` function is provided - then it will be used to preserve the Input pureness.
-  const inputStringified = _inspect(opt.getOriginalInput?.() || input, { maxLen: 4000 })
+  const inputForPrint = opt.getOriginalInput?.() || input
+
+  // Resolve each error's failing value while its instancePath is still a raw JSON pointer
+  // (e.g `/events/2/name`), which is unambiguous to walk - unlike the dot notation it gets
+  // rewritten into below (a property name may itself contain a dot).
+  // Root errors (empty instancePath) resolve to undefined - there the value is the whole Input,
+  // which is printed anyway.
+  // `required` errors also resolve to undefined - their instancePath points at the parent object
+  // that lacks the property, so `got:` would print that whole object - noise next to the Input print.
+  const failingValueByError = new Map<ErrorObject, unknown>(
+    errors.map(e => [
+      e,
+      e.instancePath && e.keyword !== 'required'
+        ? getValueAtJsonPointer(inputForPrint, e.instancePath)
+        : undefined,
+    ]),
+  )
+
+  applyImprovementsOnErrorMessages(errors, builtSchema)
+
+  // Same line format as Ajv's errorsText().
+  // Each error line is followed by a `Got: ...` line printing the narrow failing value itself,
+  // so it stays visible even when the Input print below gets truncated for large inputs.
+  // `Got` is a separate line (and is allowed to print multi-line) on purpose: consumers that
+  // only take the first line of the message keep getting the unchanged (pre-Got) error line.
+  let message = errors
+    .flatMap(e => {
+      const lines = [`${dataVar}${e.instancePath} ${e.message}`]
+      const value = failingValueByError.get(e)
+      if (value !== undefined) {
+        lines.push(`Got: ${_inspect(value, { maxLen: 500 })}`)
+      }
+      return lines
+    })
+    .join(separator)
+
+  const inputStringified = _inspect(inputForPrint, { maxLen: 4000 })
   message = [message, 'Input: ' + inputStringified].join(separator)
 
   const err = new AjvValidationError(
@@ -1738,6 +1778,19 @@ function executeValidation<OUT>(
 
 // ==== Error formatting helpers ====
 
+/**
+ * Resolves the value at an Ajv error's raw instancePath, which is a JSON pointer, e.g `/events/2/name`.
+ * Returns undefined if the path cannot be resolved (e.g the input was mutated).
+ */
+function getValueAtJsonPointer(input: unknown, pointer: string): unknown {
+  let value: any = input
+  for (const segment of pointer.split('/').slice(1)) {
+    if (value === null || typeof value !== 'object') return undefined
+    value = value[segment.replaceAll('~1', '/').replaceAll('~0', '~')]
+  }
+  return value
+}
+
 function applyImprovementsOnErrorMessages(
   errors: ErrorObject[] | null | undefined,
   schema: JsonSchema,
@@ -2146,13 +2199,15 @@ type StripIndexSignatureDeep<T> = T extends readonly unknown[]
   ? T
   : T extends Record<string, any>
     ? {
-        [K in keyof T as string extends K
-          ? never
-          : number extends K
+        [
+          K in keyof T as string extends K
             ? never
-            : symbol extends K
+            : number extends K
               ? never
-              : K]: StripIndexSignatureDeep<T[K]>
+              : symbol extends K
+                ? never
+                : K
+        ]: StripIndexSignatureDeep<T[K]>
       }
     : T