@naturalcycles/nodejs-lib 12.45.0 → 12.45.1

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [12.45.1](https://github.com/NaturalCycles/nodejs-lib/compare/v12.45.0...v12.45.1) (2021-10-25)
+
+
+### Bug Fixes
+
+* make JoiValidationError.annotation non-enumerable ([9337fd3](https://github.com/NaturalCycles/nodejs-lib/commit/9337fd3e1a60deb0d9e91b17cf5e7b42f72b5459))
+
 # [12.45.0](https://github.com/NaturalCycles/nodejs-lib/compare/v12.44.0...v12.45.0) (2021-10-22)
 
 

package/dist/diff/tableDiff.d.ts

@@ -1,3 +1,4 @@
+import { AnyObject } from '@naturalcycles/js-lib';
 export interface TableDiffOptions {
     /**
      * @default false
@@ -29,4 +30,4 @@ export interface TableDiffOptions {
  *
  * Function is located in nodejs-lib (not js-lib), because it's planned to improve in the future and add e.g colors (via chalk).
  */
-export declare function tableDiff(a: Record<string, any>, b: Record<string, any>, opt?: TableDiffOptions): void;
+export declare function tableDiff(a: AnyObject, b: AnyObject, opt?: TableDiffOptions): void;

package/dist/got/got.model.d.ts

@@ -1,3 +1,4 @@
+import { AnyObject } from '@naturalcycles/js-lib';
 import type { Options } from 'got';
 export interface GetGotOptions extends Options {
     /**
@@ -33,7 +34,7 @@ export interface GetGotOptions extends Options {
      */
     maxResponseLength?: number;
 }
-export interface GotRequestContext extends Record<string, any> {
+export interface GotRequestContext extends AnyObject {
     /**
      * Millisecond-timestamp of when the request was started. To be able to count "time spent".
      */

package/dist/stream/ndjson/transformJsonParse.d.ts

@@ -24,5 +24,5 @@ export interface TransformJsonParseOptions {
  *   consumeYourStream...
  * [)
  */
-export declare function transformJsonParse<OUT = Record<string, any>>(opt?: TransformJsonParseOptions): TransformTyped<string | Buffer, OUT>;
+export declare function transformJsonParse<OUT = any>(opt?: TransformJsonParseOptions): TransformTyped<string | Buffer, OUT>;
 export declare const bufferReviver: Reviver;

package/dist/stream/transform/transformBuffer.d.ts

@@ -7,4 +7,4 @@ export interface TransformBufferOptions extends TransformOptions {
  *
  * @default batchSize is 10
  */
-export declare function transformBuffer<IN = Record<string, any>>(opt: TransformBufferOptions): TransformTyped<IN, IN[]>;
+export declare function transformBuffer<IN = any>(opt: TransformBufferOptions): TransformTyped<IN, IN[]>;

package/dist/stream/transform/transformLogProgress.d.ts

@@ -1,3 +1,4 @@
+import { AnyObject } from '@naturalcycles/js-lib';
 import { TransformOptions, TransformTyped } from '../stream.model';
 export interface TransformLogProgressOptions<IN = any> extends TransformOptions {
     /**
@@ -73,7 +74,7 @@ export interface TransformLogProgressOptions<IN = any> extends TransformOptions
      *
      * chunk is undefined for "final" stats, otherwise is defined.
      */
-    extra?: (chunk: IN | undefined, index: number) => Record<string, any>;
+    extra?: (chunk: IN | undefined, index: number) => AnyObject;
 }
 /**
  * Pass-through transform that optionally logs progress.

package/dist/stream/transform/worker/transformMultiThreaded.d.ts

@@ -1,3 +1,4 @@
+import { AnyObject } from '@naturalcycles/js-lib';
 import { TransformTyped } from '../../stream.model';
 export interface TransformMultiThreadedOptions {
     /**
@@ -19,7 +20,7 @@ export interface TransformMultiThreadedOptions {
     /**
      * Passed to the Worker as `workerData` property (initial data).
      */
-    workerData?: Record<string, any>;
+    workerData?: AnyObject;
 }
 /**
  * Spawns a pool of Workers (threads).

package/dist/validation/joi/joi.validation.error.d.ts

@@ -17,6 +17,9 @@ export interface JoiValidationErrorData extends ErrorData {
     /**
      * Error "annotation" is stripped in Error.message.
      * This field contains the "full" annotation.
+     *
+     * This field is non-enumerable, won't be printed or included in JSON by default,
+     * but still accessible programmatically (via `err.data.annotation`) when needed!
      */
     annotation?: string;
 }

package/dist/validation/joi/joi.validation.util.js

@@ -122,10 +122,16 @@ function createError(value, err, objectName) {
         tokens.push(annotation);
     }
     const msg = tokens.join('\n');
-    return new joi_validation_error_1.JoiValidationError(msg, {
+    const data = {
         joiValidationErrorItems: err.details,
         ...(objectName && { joiValidationObjectName: objectName }),
         ...(objectId && { joiValidationObjectId: objectId }),
-        annotation,
+    };
+    // Make annotation non-enumerable, to not get it automatically printed,
+    // but still accessible
+    Object.defineProperty(data, 'annotation', {
+        enumerable: false,
+        value: annotation,
     });
+    return new joi_validation_error_1.JoiValidationError(msg, data);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@naturalcycles/nodejs-lib",
-  "version": "12.45.0",
+  "version": "12.45.1",
   "scripts": {
     "prepare": "husky install",
     "docs-serve": "vuepress dev docs",

package/src/diff/tableDiff.ts

@@ -1,4 +1,4 @@
-import { StringMap, _truncate } from '@naturalcycles/js-lib'
+import { StringMap, _truncate, AnyObject } from '@naturalcycles/js-lib'
 
 export interface TableDiffOptions {
   /**
@@ -35,11 +35,7 @@ export interface TableDiffOptions {
  *
  * Function is located in nodejs-lib (not js-lib), because it's planned to improve in the future and add e.g colors (via chalk).
  */
-export function tableDiff(
-  a: Record<string, any>,
-  b: Record<string, any>,
-  opt: TableDiffOptions = {},
-): void {
+export function tableDiff(a: AnyObject, b: AnyObject, opt: TableDiffOptions = {}): void {
   const { maxFieldLen, aTitle = 'a', bTitle = 'b' } = opt
   const diff: StringMap<any> = {}
 

package/src/got/got.model.ts

@@ -1,3 +1,4 @@
+import { AnyObject } from '@naturalcycles/js-lib'
 import type { Options } from 'got'
 
 export interface GetGotOptions extends Options {
@@ -40,7 +41,7 @@ export interface GetGotOptions extends Options {
   maxResponseLength?: number
 }
 
-export interface GotRequestContext extends Record<string, any> {
+export interface GotRequestContext extends AnyObject {
   /**
    * Millisecond-timestamp of when the request was started. To be able to count "time spent".
    */

package/src/stream/ndjson/transformJsonParse.ts

@@ -27,7 +27,7 @@ export interface TransformJsonParseOptions {
  *   consumeYourStream...
  * [)
  */
-export function transformJsonParse<OUT = Record<string, any>>(
+export function transformJsonParse<OUT = any>(
   opt: TransformJsonParseOptions = {},
 ): TransformTyped<string | Buffer, OUT> {
   const { strict = true, reviver } = opt

package/src/stream/transform/transformBuffer.ts

@@ -10,9 +10,7 @@ export interface TransformBufferOptions extends TransformOptions {
  *
  * @default batchSize is 10
  */
-export function transformBuffer<IN = Record<string, any>>(
-  opt: TransformBufferOptions,
-): TransformTyped<IN, IN[]> {
+export function transformBuffer<IN = any>(opt: TransformBufferOptions): TransformTyped<IN, IN[]> {
   const { batchSize } = opt
 
   let buf: IN[] = []

package/src/stream/transform/transformLogProgress.ts

@@ -1,6 +1,6 @@
 import { Transform } from 'stream'
 import { inspect, InspectOptions } from 'util'
-import { SimpleMovingAverage, _mb, _since } from '@naturalcycles/js-lib'
+import { SimpleMovingAverage, _mb, _since, AnyObject } from '@naturalcycles/js-lib'
 import { dayjs } from '@naturalcycles/time-lib'
 import { boldWhite, dimGrey, white, yellow } from '../../colors'
 import { hasColors } from '../../colors/colors'
@@ -91,7 +91,7 @@ export interface TransformLogProgressOptions<IN = any> extends TransformOptions
    *
    * chunk is undefined for "final" stats, otherwise is defined.
    */
-  extra?: (chunk: IN | undefined, index: number) => Record<string, any>
+  extra?: (chunk: IN | undefined, index: number) => AnyObject
 }
 
 const inspectOpt: InspectOptions = {

package/src/stream/transform/worker/transformMultiThreaded.ts

@@ -1,5 +1,5 @@
 import { Worker } from 'worker_threads'
-import { DeferredPromise, pDefer, _range } from '@naturalcycles/js-lib'
+import { DeferredPromise, pDefer, _range, AnyObject } from '@naturalcycles/js-lib'
 import through2Concurrent = require('through2-concurrent')
 import { TransformTyped } from '../../stream.model'
 import { WorkerInput, WorkerOutput } from './transformMultiThreaded.model'
@@ -30,7 +30,7 @@ export interface TransformMultiThreadedOptions {
   /**
    * Passed to the Worker as `workerData` property (initial data).
    */
-  workerData?: Record<string, any>
+  workerData?: AnyObject
 }
 
 const workerProxyFilePath = `${__dirname}/workerClassProxy.js`

package/src/validation/joi/joi.validation.error.ts

@@ -18,6 +18,9 @@ export interface JoiValidationErrorData extends ErrorData {
   /**
    * Error "annotation" is stripped in Error.message.
    * This field contains the "full" annotation.
+   *
+   * This field is non-enumerable, won't be printed or included in JSON by default,
+   * but still accessible programmatically (via `err.data.annotation`) when needed!
    */
   annotation?: string
 }

package/src/validation/joi/joi.validation.util.ts

@@ -9,7 +9,7 @@
 import { _hb, _isObject, _truncateMiddle } from '@naturalcycles/js-lib'
 import { ValidationError, ValidationOptions } from 'joi'
 import { AnySchemaTyped } from './joi.model'
-import { JoiValidationError } from './joi.validation.error'
+import { JoiValidationError, JoiValidationErrorData } from './joi.validation.error'
 
 // todo: consider replacing with Tuple of [error, value]
 export interface JoiValidationResult<T = any> {
@@ -163,10 +163,18 @@ function createError(value: any, err: ValidationError, objectName?: string): Joi
 
   const msg = tokens.join('\n')
 
-  return new JoiValidationError(msg, {
+  const data: JoiValidationErrorData = {
     joiValidationErrorItems: err.details,
     ...(objectName && { joiValidationObjectName: objectName }),
     ...(objectId && { joiValidationObjectId: objectId }),
-    annotation,
+  }
+
+  // Make annotation non-enumerable, to not get it automatically printed,
+  // but still accessible
+  Object.defineProperty(data, 'annotation', {
+    enumerable: false,
+    value: annotation,
   })
+
+  return new JoiValidationError(msg, data)
 }