@naturalcycles/nodejs-lib 13.1.3 → 13.2.0

package/dist/index.d.ts

@@ -58,7 +58,7 @@ export * from './stream/writable/writableVoid';
 export * from './csv/csvWriter';
 export * from './csv/csvReader';
 export * from './csv/transformToCSV';
-export * from './string/inspectAny';
+export * from './string/inspect';
 export * from './util/env.util';
 export * from './util/lruMemoCache';
 export * from './util/zip.util';

package/dist/index.js

@@ -62,7 +62,7 @@ tslib_1.__exportStar(require("./stream/writable/writableVoid"), exports);
 tslib_1.__exportStar(require("./csv/csvWriter"), exports);
 tslib_1.__exportStar(require("./csv/csvReader"), exports);
 tslib_1.__exportStar(require("./csv/transformToCSV"), exports);
-tslib_1.__exportStar(require("./string/inspectAny"), exports);
+tslib_1.__exportStar(require("./string/inspect"), exports);
 tslib_1.__exportStar(require("./util/env.util"), exports);
 tslib_1.__exportStar(require("./util/lruMemoCache"), exports);
 tslib_1.__exportStar(require("./util/zip.util"), exports);

package/dist/log/log.util.js

@@ -7,5 +7,5 @@ const index_1 = require("../index");
  * CommonLogger that logs to process.stdout directly (bypassing console.log).
  */
 exports.stdoutLogger = (0, js_lib_1.commonLoggerCreate)((_level, args) => {
-    process.stdout.write(args.map(a => (0, index_1.inspectAny)(a)).join(' ') + '\n');
+    process.stdout.write(args.map(a => (0, index_1._inspect)(a)).join(' ') + '\n');
 });

package/dist/script/runScript.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.runScript = void 0;
 const js_lib_1 = require("@naturalcycles/js-lib");
-const inspectAny_1 = require("../string/inspectAny");
+const inspect_1 = require("../string/inspect");
 const { DEBUG_RUN_SCRIPT } = process.env;
 /**
  * Use it in your top-level scripts like this:
@@ -23,7 +23,7 @@ const { DEBUG_RUN_SCRIPT } = process.env;
  * Set env DEBUG_RUN_SCRIPT for extra debugging.
  */
 function runScript(fn, opt = {}) {
-    (0, js_lib_1.setGlobalStringifyFunction)(inspectAny_1.inspectAnyStringifyFn);
+    (0, js_lib_1.setGlobalStringifyFunction)(inspect_1.inspectStringifyFn);
     const { logger = console, noExit } = opt;
     process.on('uncaughtException', err => {
         logger.error('uncaughtException:', err);

package/dist/slack/slack.service.js

@@ -69,10 +69,10 @@ class SlackService {
         let text;
         // Array has a special treatment here
         if (Array.isArray(msg.items)) {
-            text = msg.items.map(t => (0, __1.inspectAny)(t, inspectOptions)).join('\n');
+            text = msg.items.map(t => (0, __1._inspect)(t, inspectOptions)).join('\n');
         }
         else {
-            text = (0, __1.inspectAny)(msg.items, inspectOptions);
+            text = (0, __1._inspect)(msg.items, inspectOptions);
         }
         // Wrap in markdown-text-block if it's anything but plain String
         if (typeof msg.items !== 'string') {

package/dist/string/{inspectAny.d.ts → inspect.d.ts}

@@ -1,12 +1,12 @@
 /// <reference types="node" />
 import { InspectOptions } from 'node:util';
-import { StringifyAnyOptions, JsonStringifyFunction } from '@naturalcycles/js-lib';
-export interface InspectAnyOptions extends StringifyAnyOptions, InspectOptions {
+import { StringifyOptions, JsonStringifyFunction } from '@naturalcycles/js-lib';
+export interface InspectAnyOptions extends StringifyOptions, InspectOptions {
 }
 /**
  * Just a convenience export of a const that fulfills the JsonStringifyFunction interface.
  */
-export declare const inspectAnyStringifyFn: JsonStringifyFunction;
+export declare const inspectStringifyFn: JsonStringifyFunction;
 /**
  * Transforms ANY to human-readable string (via util.inspect mainly).
  * Safe (no error throwing).
@@ -22,6 +22,10 @@ export declare const inspectAnyStringifyFn: JsonStringifyFunction;
  * Returns 'empty_string' if empty string is passed.
  * Returns 'undefined' if undefined is passed (default util.inspect behavior).
  *
- * Based on `_stringifyAny` from `js-lib`, just replaced `JSON.stringify` with `util.inspect`.
+ * Based on `_stringify` from `js-lib`, just replaced `JSON.stringify` with `util.inspect`.
  */
-export declare function inspectAny(obj: any, opt?: InspectAnyOptions): string;
+export declare function _inspect(obj: any, opt?: InspectAnyOptions): string;
+/**
+ * @deprecated renamed to _inspect
+ */
+export declare const inspectAny: typeof _inspect;

package/dist/string/{inspectAny.js → inspect.js}

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.inspectAny = exports.inspectAnyStringifyFn = void 0;
+exports.inspectAny = exports._inspect = exports.inspectStringifyFn = void 0;
 const node_util_1 = require("node:util");
 const js_lib_1 = require("@naturalcycles/js-lib");
 const INSPECT_OPT = {
@@ -10,8 +10,8 @@ const INSPECT_OPT = {
 /**
  * Just a convenience export of a const that fulfills the JsonStringifyFunction interface.
  */
-const inspectAnyStringifyFn = obj => (0, node_util_1.inspect)(obj, INSPECT_OPT);
-exports.inspectAnyStringifyFn = inspectAnyStringifyFn;
+const inspectStringifyFn = obj => (0, node_util_1.inspect)(obj, INSPECT_OPT);
+exports.inspectStringifyFn = inspectStringifyFn;
 /**
  * Transforms ANY to human-readable string (via util.inspect mainly).
  * Safe (no error throwing).
@@ -27,9 +27,9 @@ exports.inspectAnyStringifyFn = inspectAnyStringifyFn;
  * Returns 'empty_string' if empty string is passed.
  * Returns 'undefined' if undefined is passed (default util.inspect behavior).
  *
- * Based on `_stringifyAny` from `js-lib`, just replaced `JSON.stringify` with `util.inspect`.
+ * Based on `_stringify` from `js-lib`, just replaced `JSON.stringify` with `util.inspect`.
  */
-function inspectAny(obj, opt = {}) {
+function _inspect(obj, opt = {}) {
     // Inspect handles functions better
     if (typeof obj === 'function') {
         return (0, node_util_1.inspect)(obj, {
@@ -37,7 +37,7 @@ function inspectAny(obj, opt = {}) {
             ...opt,
         });
     }
-    return (0, js_lib_1._stringifyAny)(obj, {
+    return (0, js_lib_1._stringify)(obj, {
         ...opt,
         stringifyFn: obj => (0, node_util_1.inspect)(obj, {
             ...INSPECT_OPT,
@@ -45,4 +45,8 @@ function inspectAny(obj, opt = {}) {
         }),
     });
 }
-exports.inspectAny = inspectAny;
+exports._inspect = _inspect;
+/**
+ * @deprecated renamed to _inspect
+ */
+exports.inspectAny = _inspect;

package/dist/validation/ajv/ajvSchema.js

@@ -86,7 +86,7 @@ class AjvSchema {
             dataVar: name,
             separator,
         });
-        const strValue = (0, index_1.inspectAny)(obj, { maxLen: 1000 });
+        const strValue = (0, index_1._inspect)(obj, { maxLen: 1000 });
         message = [message, 'Input: ' + strValue].join(separator);
         if (logErrors) {
             this.cfg.logger.error(errors);

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

@@ -11,7 +11,7 @@ export interface JoiValidationResult<T = any> {
  *
  * If `schema` is undefined - returns value as is.
  */
-export declare function validate<T>(value: T, schema?: AnySchema<T>, objectName?: string, options?: ValidationOptions): T;
+export declare function validate<T>(input: any, schema?: AnySchema<T>, objectName?: string, opt?: ValidationOptions): T;
 /**
  * Validates with Joi.
  * Returns JoiValidationResult with converted value and error (if any).
@@ -19,15 +19,15 @@ export declare function validate<T>(value: T, schema?: AnySchema<T>, objectName?
  *
  * If `schema` is undefined - returns value as is.
  */
-export declare function getValidationResult<T>(value: T, schema?: AnySchema<T>, objectName?: string, options?: ValidationOptions): JoiValidationResult<T>;
+export declare function getValidationResult<T>(input: any, schema?: AnySchema<T>, objectName?: string, options?: ValidationOptions): JoiValidationResult<T>;
 /**
  * Convenience function that returns true if !error.
  */
-export declare function isValid<T>(value: T, schema?: AnySchema<T>): boolean;
-export declare function undefinedIfInvalid<T>(value: T, schema?: AnySchema<T>): T | undefined;
+export declare function isValid<T>(input: T, schema?: AnySchema<T>): boolean;
+export declare function undefinedIfInvalid<T>(input: any, schema?: AnySchema<T>): T | undefined;
 /**
- * Will do joi-convertation, regardless of error/validity of value.
+ * Will do joi-conversion, regardless of error/validity of value.
  *
  * @returns converted value
  */
-export declare function convert<T>(value: T, schema?: AnySchema<T>): T;
+export declare function convert<T>(input: any, schema?: AnySchema<T>): T;

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

@@ -40,8 +40,8 @@ const defaultOptions = {
  *
  * If `schema` is undefined - returns value as is.
  */
-function validate(value, schema, objectName, options = {}) {
-    const { value: returnValue, error } = getValidationResult(value, schema, objectName, options);
+function validate(input, schema, objectName, opt = {}) {
+    const { value: returnValue, error } = getValidationResult(input, schema, objectName, opt);
     if (error) {
         throw error;
     }
@@ -55,18 +55,18 @@ exports.validate = validate;
  *
  * If `schema` is undefined - returns value as is.
  */
-function getValidationResult(value, schema, objectName, options = {}) {
+function getValidationResult(input, schema, objectName, options = {}) {
     if (!schema)
-        return { value };
-    const { value: returnValue, error } = schema.validate(value, {
+        return { value: input };
+    const { value, error } = schema.validate(input, {
         ...defaultOptions,
         ...options,
     });
     const vr = {
-        value: returnValue,
+        value,
     };
     if (error) {
-        vr.error = createError(value, error, objectName);
+        vr.error = createError(input, error, objectName);
     }
     return vr;
 }
@@ -74,35 +74,33 @@ exports.getValidationResult = getValidationResult;
 /**
  * Convenience function that returns true if !error.
  */
-function isValid(value, schema) {
+function isValid(input, schema) {
     if (!schema)
-        return { value };
-    const { error } = schema.validate(value, defaultOptions);
+        return true;
+    const { error } = schema.validate(input, defaultOptions);
     return !error;
 }
 exports.isValid = isValid;
-function undefinedIfInvalid(value, schema) {
+function undefinedIfInvalid(input, schema) {
     if (!schema)
-        return { value };
-    const { value: returnValue, error } = schema.validate(value, defaultOptions);
-    return error ? undefined : returnValue;
+        return input;
+    const { value, error } = schema.validate(input, defaultOptions);
+    return error ? undefined : value;
 }
 exports.undefinedIfInvalid = undefinedIfInvalid;
 /**
- * Will do joi-convertation, regardless of error/validity of value.
+ * Will do joi-conversion, regardless of error/validity of value.
  *
  * @returns converted value
  */
-function convert(value, schema) {
+function convert(input, schema) {
     if (!schema)
-        return value;
-    const { value: returnValue } = schema.validate(value, defaultOptions);
-    return returnValue;
+        return input;
+    const { value } = schema.validate(input, defaultOptions);
+    return value;
 }
 exports.convert = convert;
 function createError(value, err, objectName) {
-    if (!err)
-        return undefined;
     const tokens = [];
     const objectId = (0, js_lib_1._isObject)(value) ? value['id'] : undefined;
     if (objectId || objectName) {

package/package.json

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

package/src/index.ts

@@ -68,7 +68,7 @@ export * from './stream/writable/writableVoid'
 export * from './csv/csvWriter'
 export * from './csv/csvReader'
 export * from './csv/transformToCSV'
-export * from './string/inspectAny'
+export * from './string/inspect'
 export * from './util/env.util'
 export * from './util/lruMemoCache'
 export * from './util/zip.util'

package/src/log/log.util.ts

@@ -1,9 +1,9 @@
 import { commonLoggerCreate } from '@naturalcycles/js-lib'
-import { inspectAny } from '../index'
+import { _inspect } from '../index'
 
 /**
  * CommonLogger that logs to process.stdout directly (bypassing console.log).
  */
 export const stdoutLogger = commonLoggerCreate((_level, args) => {
-  process.stdout.write(args.map(a => inspectAny(a)).join(' ') + '\n')
+  process.stdout.write(args.map(a => _inspect(a)).join(' ') + '\n')
 })

package/src/script/runScript.ts

@@ -1,6 +1,6 @@
 import { setGlobalStringifyFunction } from '@naturalcycles/js-lib'
 import type { CommonLogger } from '@naturalcycles/js-lib'
-import { inspectAnyStringifyFn } from '../string/inspectAny'
+import { inspectStringifyFn } from '../string/inspect'
 
 export interface RunScriptOptions {
   /**
@@ -37,7 +37,7 @@ const { DEBUG_RUN_SCRIPT } = process.env
  * Set env DEBUG_RUN_SCRIPT for extra debugging.
  */
 export function runScript(fn: (...args: any[]) => any, opt: RunScriptOptions = {}): void {
-  setGlobalStringifyFunction(inspectAnyStringifyFn)
+  setGlobalStringifyFunction(inspectStringifyFn)
 
   const { logger = console, noExit } = opt
 

package/src/slack/slack.service.ts

@@ -9,7 +9,7 @@ import {
   localTimeNow,
   PQueue,
 } from '@naturalcycles/js-lib'
-import { inspectAny, InspectAnyOptions } from '..'
+import { _inspect, InspectAnyOptions } from '..'
 import {
   SlackApiBody,
   SlackAttachmentField,
@@ -99,9 +99,9 @@ export class SlackService<CTX = any> {
 
     // Array has a special treatment here
     if (Array.isArray(msg.items)) {
-      text = msg.items.map(t => inspectAny(t, inspectOptions)).join('\n')
+      text = msg.items.map(t => _inspect(t, inspectOptions)).join('\n')
     } else {
-      text = inspectAny(msg.items, inspectOptions)
+      text = _inspect(msg.items, inspectOptions)
     }
 
     // Wrap in markdown-text-block if it's anything but plain String

package/src/string/{inspectAny.ts → inspect.ts}

@@ -1,7 +1,7 @@
 import { inspect, InspectOptions } from 'node:util'
-import { StringifyAnyOptions, _stringifyAny, JsonStringifyFunction } from '@naturalcycles/js-lib'
+import { StringifyOptions, _stringify, JsonStringifyFunction } from '@naturalcycles/js-lib'
 
-export interface InspectAnyOptions extends StringifyAnyOptions, InspectOptions {}
+export interface InspectAnyOptions extends StringifyOptions, InspectOptions {}
 
 const INSPECT_OPT: InspectOptions = {
   breakLength: 80, // default: ??
@@ -11,7 +11,7 @@ const INSPECT_OPT: InspectOptions = {
 /**
  * Just a convenience export of a const that fulfills the JsonStringifyFunction interface.
  */
-export const inspectAnyStringifyFn: JsonStringifyFunction = obj => inspect(obj, INSPECT_OPT)
+export const inspectStringifyFn: JsonStringifyFunction = obj => inspect(obj, INSPECT_OPT)
 
 /**
  * Transforms ANY to human-readable string (via util.inspect mainly).
@@ -28,9 +28,9 @@ export const inspectAnyStringifyFn: JsonStringifyFunction = obj => inspect(obj,
  * Returns 'empty_string' if empty string is passed.
  * Returns 'undefined' if undefined is passed (default util.inspect behavior).
  *
- * Based on `_stringifyAny` from `js-lib`, just replaced `JSON.stringify` with `util.inspect`.
+ * Based on `_stringify` from `js-lib`, just replaced `JSON.stringify` with `util.inspect`.
  */
-export function inspectAny(obj: any, opt: InspectAnyOptions = {}): string {
+export function _inspect(obj: any, opt: InspectAnyOptions = {}): string {
   // Inspect handles functions better
   if (typeof obj === 'function') {
     return inspect(obj, {
@@ -39,7 +39,7 @@ export function inspectAny(obj: any, opt: InspectAnyOptions = {}): string {
     })
   }
 
-  return _stringifyAny(obj, {
+  return _stringify(obj, {
     ...opt,
     stringifyFn: obj =>
       inspect(obj, {
@@ -48,3 +48,8 @@ export function inspectAny(obj: any, opt: InspectAnyOptions = {}): string {
       }),
   })
 }
+
+/**
+ * @deprecated renamed to _inspect
+ */
+export const inspectAny = _inspect

package/src/validation/ajv/ajvSchema.ts

@@ -8,7 +8,7 @@ import {
   CommonLogger,
 } from '@naturalcycles/js-lib'
 import Ajv, { ValidateFunction } from 'ajv'
-import { _readJsonSync, inspectAny, requireFileToExist } from '../../index'
+import { _readJsonSync, _inspect, requireFileToExist } from '../../index'
 import { AjvValidationError } from './ajvValidationError'
 import { getAjv } from './getAjv'
 
@@ -173,7 +173,7 @@ export class AjvSchema<T = unknown> {
       separator,
     })
 
-    const strValue = inspectAny(obj, { maxLen: 1000 })
+    const strValue = _inspect(obj, { maxLen: 1000 })
     message = [message, 'Input: ' + strValue].join(separator)
 
     if (logErrors) {

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

@@ -49,12 +49,12 @@ const defaultOptions: ValidationOptions = {
  * If `schema` is undefined - returns value as is.
  */
 export function validate<T>(
-  value: T,
+  input: any,
   schema?: AnySchema<T>,
   objectName?: string,
-  options: ValidationOptions = {},
+  opt: ValidationOptions = {},
 ): T {
-  const { value: returnValue, error } = getValidationResult(value, schema, objectName, options)
+  const { value: returnValue, error } = getValidationResult(input, schema, objectName, opt)
 
   if (error) {
     throw error
@@ -71,24 +71,24 @@ export function validate<T>(
  * If `schema` is undefined - returns value as is.
  */
 export function getValidationResult<T>(
-  value: T,
+  input: any,
   schema?: AnySchema<T>,
   objectName?: string,
   options: ValidationOptions = {},
 ): JoiValidationResult<T> {
-  if (!schema) return { value } as any
+  if (!schema) return { value: input }
 
-  const { value: returnValue, error } = schema.validate(value, {
+  const { value, error } = schema.validate(input, {
     ...defaultOptions,
     ...options,
   })
 
   const vr: JoiValidationResult<T> = {
-    value: returnValue,
+    value,
   }
 
   if (error) {
-    vr.error = createError(value, error, objectName)
+    vr.error = createError(input, error, objectName)
   }
 
   return vr
@@ -97,34 +97,33 @@ export function getValidationResult<T>(
 /**
  * Convenience function that returns true if !error.
  */
-export function isValid<T>(value: T, schema?: AnySchema<T>): boolean {
-  if (!schema) return { value } as any
+export function isValid<T>(input: T, schema?: AnySchema<T>): boolean {
+  if (!schema) return true
 
-  const { error } = schema.validate(value, defaultOptions)
+  const { error } = schema.validate(input, defaultOptions)
   return !error
 }
 
-export function undefinedIfInvalid<T>(value: T, schema?: AnySchema<T>): T | undefined {
-  if (!schema) return { value } as any
+export function undefinedIfInvalid<T>(input: any, schema?: AnySchema<T>): T | undefined {
+  if (!schema) return input
 
-  const { value: returnValue, error } = schema.validate(value, defaultOptions)
+  const { value, error } = schema.validate(input, defaultOptions)
 
-  return error ? undefined : returnValue
+  return error ? undefined : value
 }
 
 /**
- * Will do joi-convertation, regardless of error/validity of value.
+ * Will do joi-conversion, regardless of error/validity of value.
  *
  * @returns converted value
  */
-export function convert<T>(value: T, schema?: AnySchema<T>): T {
-  if (!schema) return value as any
-  const { value: returnValue } = schema.validate(value, defaultOptions)
-  return returnValue
+export function convert<T>(input: any, schema?: AnySchema<T>): T {
+  if (!schema) return input
+  const { value } = schema.validate(input, defaultOptions)
+  return value
 }
 
 function createError(value: any, err: ValidationError, objectName?: string): JoiValidationError {
-  if (!err) return undefined as any
   const tokens: string[] = []
 
   const objectId = _isObject(value) ? (value['id'] as string) : undefined