@naturalcycles/nodejs-lib 12.52.0 → 12.53.0

package/dist/got/getGot.js

@@ -13,6 +13,7 @@ const colors_1 = require("../colors");
  * 3. Reasonable defaults(tm), e.g non-infinite Timeout
  */
 function getGot(opt = {}) {
+    opt.logger || (opt.logger = console);
     return got_1.default.extend({
         // Most-important is to set to anything non-empty (so, requests don't "hang" by default).
         // Should be long enough to handle for slow responses from scaled cloud APIs in times of spikes
@@ -93,7 +94,7 @@ function gotBeforeRequestHook(opt) {
         };
         if (opt.logStart) {
             const shortUrl = getShortUrl(opt, options.url, options.prefixUrl);
-            console.log([(0, colors_1.dimGrey)(' >>'), (0, colors_1.dimGrey)(options.method), (0, colors_1.grey)(shortUrl)].join(' '));
+            opt.logger.log([(0, colors_1.dimGrey)(' >>'), (0, colors_1.dimGrey)(options.method), (0, colors_1.grey)(shortUrl)].join(' '));
         }
     };
 }
@@ -104,7 +105,7 @@ function gotAfterResponseHook(opt = {}) {
             const { started } = resp.request.options.context;
             const { url, prefixUrl, method } = resp.request.options;
             const shortUrl = getShortUrl(opt, url, prefixUrl);
-            console.log([
+            opt.logger.log([
                 (0, colors_1.dimGrey)(' <<'),
                 coloredHttpCode(resp.statusCode),
                 (0, colors_1.dimGrey)(method),
@@ -117,7 +118,7 @@ function gotAfterResponseHook(opt = {}) {
         }
         // Error responses are not logged, cause they're included in Error message already
         if (opt.logResponse && success) {
-            console.log((0, __1.inspectAny)((0, js_lib_1._jsonParseIfPossible)(resp.body), { maxLen: opt.maxResponseLength }));
+            opt.logger.log((0, __1.inspectAny)(resp.body, { maxLen: opt.maxResponseLength }));
         }
         return resp;
     };

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

@@ -1,4 +1,4 @@
-import { AnyObject } from '@naturalcycles/js-lib';
+import { AnyObject, CommonLogger } from '@naturalcycles/js-lib';
 import type { Options } from 'got';
 export interface GetGotOptions extends Options {
     /**
@@ -27,6 +27,10 @@ export interface GetGotOptions extends Options {
      * Set to false to strip searchParams from url when logging (both success and error)
      */
     logWithSearchParams?: boolean;
+    /**
+     * Defaults to `console`
+     */
+    logger?: CommonLogger;
     /**
      * Max length of response object before it's truncated.
      *

package/dist/index.d.ts

@@ -51,7 +51,7 @@ import { writableForEach } from './stream/writable/writableForEach';
 import { writableFork } from './stream/writable/writableFork';
 import { writablePushToArray } from './stream/writable/writablePushToArray';
 import { writableVoid } from './stream/writable/writableVoid';
-import { inspectAny, InspectAnyOptions } from './string/inspectAny';
+import { inspectAny, InspectAnyOptions, inspectAnyStringifyFn } from './string/inspectAny';
 import { requireEnvKeys, requireFileToExist } from './util/env.util';
 import { LRUMemoCache } from './util/lruMemoCache';
 import { gunzipBuffer, gunzipToString, gzipBuffer, gzipString, unzipBuffer, unzipToString, zipBuffer, zipString } from './util/zip.util';
@@ -66,4 +66,4 @@ import { JoiValidationError, JoiValidationErrorData } from './validation/joi/joi
 import { convert, getValidationResult, isValid, JoiValidationResult, undefinedIfInvalid, validate } from './validation/joi/joi.validation.util';
 import { sanitizeHTML, SanitizeHTMLOptions } from './validation/sanitize.util';
 export type { JoiValidationErrorData, JoiValidationResult, ValidationErrorItem, ExtendedJoi, SchemaTyped, AnySchema, AnySchemaTyped, ArraySchemaTyped, BooleanSchemaTyped, NumberSchemaTyped, ObjectSchemaTyped, StringSchemaTyped, IDebug, IDebugger, SlackServiceCfg, SlackMessage, SlackMessageProps, SlackApiBody, SlackMessagePrefixHook, ReadableTyped, WritableTyped, TransformTyped, PipelineFromNDJsonFileOptions, PipelineToNDJsonFileOptions, TransformJsonParseOptions, TransformToNDJsonOptions, TransformMapOptions, TransformMapSyncOptions, NDJSONStreamForEachOptions, TransformOptions, TransformLogProgressOptions, TransformMultiThreadedOptions, WorkerClassInterface, WorkerInput, WorkerOutput, TableDiffOptions, InspectAnyOptions, Got, GetGotOptions, AfterResponseHook, BeforeErrorHook, BeforeRequestHook, AjvValidationOptions, AjvSchemaCfg, AjvValidationErrorData, SanitizeHTMLOptions, };
-export { JoiValidationError, validate, getValidationResult, isValid, undefinedIfInvalid, convert, Joi, booleanSchema, booleanDefaultToFalseSchema, stringSchema, numberSchema, integerSchema, percentageSchema, dateStringSchema, arraySchema, binarySchema, objectSchema, oneOfSchema, anySchema, anyObjectSchema, baseDBEntitySchema, savedDBEntitySchema, idSchema, unixTimestampSchema, verSchema, emailSchema, SEM_VER_PATTERN, semVerSchema, userAgentSchema, utcOffsetSchema, ipAddressSchema, slugSchema, urlSchema, processSharedUtil, zipBuffer, gzipBuffer, unzipBuffer, gunzipBuffer, zipString, gzipString, unzipToString, gunzipToString, requireEnvKeys, requireFileToExist, LRUMemoCache, stringId, stringIdAsync, stringIdUnsafe, ALPHABET_NUMBER, ALPHABET_LOWERCASE, ALPHABET_UPPERCASE, ALPHABET_ALPHANUMERIC_LOWERCASE, ALPHABET_ALPHANUMERIC_UPPERCASE, ALPHABET_ALPHANUMERIC, md5, hash, hashAsBuffer, md5AsBuffer, stringToBase64, base64ToString, bufferToBase64, base64ToBuffer, Debug, getSecretMap, setSecretMap, loadSecretsFromEnv, loadSecretsFromJsonFile, removeSecretsFromEnv, secret, secretOptional, memoryUsage, memoryUsageFull, SlackService, slackDefaultMessagePrefixHook, readableCreate, readableFrom, readableFromArray, readableToArray, readableForEach, readableForEachSync, readableMap, readableMapToArray, _pipeline, transformBuffer, ndjsonMap, ndJsonFileRead, ndJsonFileWrite, ndjsonStreamForEach, pipelineFromNDJsonFile, pipelineToNDJsonFile, NDJsonStats, streamToNDJsonFile, transformJsonParse, bufferReviver, transformToNDJson, transformFilter, transformFilterSync, transformMap, transformMapSync, transformMapSimple, transformNoOp, writableForEach, writablePushToArray, transformSplit, transformToString, transformToArray, transformTap, transformLogProgress, transformLimit, writableVoid, writableFork, transformMultiThreaded, BaseWorkerClass, tableDiff, inspectAny, getGot, HTTPError, TimeoutError, _chunkBuffer, Ajv, getAjv, AjvSchema, AjvValidationError, readJsonSchemas, readAjvSchemas, hasColors, sanitizeHTML, };
+export { JoiValidationError, validate, getValidationResult, isValid, undefinedIfInvalid, convert, Joi, booleanSchema, booleanDefaultToFalseSchema, stringSchema, numberSchema, integerSchema, percentageSchema, dateStringSchema, arraySchema, binarySchema, objectSchema, oneOfSchema, anySchema, anyObjectSchema, baseDBEntitySchema, savedDBEntitySchema, idSchema, unixTimestampSchema, verSchema, emailSchema, SEM_VER_PATTERN, semVerSchema, userAgentSchema, utcOffsetSchema, ipAddressSchema, slugSchema, urlSchema, processSharedUtil, zipBuffer, gzipBuffer, unzipBuffer, gunzipBuffer, zipString, gzipString, unzipToString, gunzipToString, requireEnvKeys, requireFileToExist, LRUMemoCache, stringId, stringIdAsync, stringIdUnsafe, ALPHABET_NUMBER, ALPHABET_LOWERCASE, ALPHABET_UPPERCASE, ALPHABET_ALPHANUMERIC_LOWERCASE, ALPHABET_ALPHANUMERIC_UPPERCASE, ALPHABET_ALPHANUMERIC, md5, hash, hashAsBuffer, md5AsBuffer, stringToBase64, base64ToString, bufferToBase64, base64ToBuffer, Debug, getSecretMap, setSecretMap, loadSecretsFromEnv, loadSecretsFromJsonFile, removeSecretsFromEnv, secret, secretOptional, memoryUsage, memoryUsageFull, SlackService, slackDefaultMessagePrefixHook, readableCreate, readableFrom, readableFromArray, readableToArray, readableForEach, readableForEachSync, readableMap, readableMapToArray, _pipeline, transformBuffer, ndjsonMap, ndJsonFileRead, ndJsonFileWrite, ndjsonStreamForEach, pipelineFromNDJsonFile, pipelineToNDJsonFile, NDJsonStats, streamToNDJsonFile, transformJsonParse, bufferReviver, transformToNDJson, transformFilter, transformFilterSync, transformMap, transformMapSync, transformMapSimple, transformNoOp, writableForEach, writablePushToArray, transformSplit, transformToString, transformToArray, transformTap, transformLogProgress, transformLimit, writableVoid, writableFork, transformMultiThreaded, BaseWorkerClass, tableDiff, inspectAny, inspectAnyStringifyFn, getGot, HTTPError, TimeoutError, _chunkBuffer, Ajv, getAjv, AjvSchema, AjvValidationError, readJsonSchemas, readAjvSchemas, hasColors, sanitizeHTML, };

package/dist/index.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ALPHABET_LOWERCASE = exports.ALPHABET_NUMBER = exports.stringIdUnsafe = exports.stringIdAsync = exports.stringId = exports.LRUMemoCache = exports.requireFileToExist = exports.requireEnvKeys = exports.gunzipToString = exports.unzipToString = exports.gzipString = exports.zipString = exports.gunzipBuffer = exports.unzipBuffer = exports.gzipBuffer = exports.zipBuffer = exports.processSharedUtil = exports.urlSchema = exports.slugSchema = exports.ipAddressSchema = exports.utcOffsetSchema = exports.userAgentSchema = exports.semVerSchema = exports.SEM_VER_PATTERN = exports.emailSchema = exports.verSchema = exports.unixTimestampSchema = exports.idSchema = exports.savedDBEntitySchema = exports.baseDBEntitySchema = exports.anyObjectSchema = exports.anySchema = exports.oneOfSchema = exports.objectSchema = exports.binarySchema = exports.arraySchema = exports.dateStringSchema = exports.percentageSchema = exports.integerSchema = exports.numberSchema = exports.stringSchema = exports.booleanDefaultToFalseSchema = exports.booleanSchema = exports.Joi = exports.convert = exports.undefinedIfInvalid = exports.isValid = exports.getValidationResult = exports.validate = exports.JoiValidationError = void 0;
 exports.transformMapSimple = exports.transformMapSync = exports.transformMap = exports.transformFilterSync = exports.transformFilter = exports.transformToNDJson = exports.bufferReviver = exports.transformJsonParse = exports.streamToNDJsonFile = exports.NDJsonStats = exports.pipelineToNDJsonFile = exports.pipelineFromNDJsonFile = exports.ndjsonStreamForEach = exports.ndJsonFileWrite = exports.ndJsonFileRead = exports.ndjsonMap = exports.transformBuffer = exports._pipeline = exports.readableMapToArray = exports.readableMap = exports.readableForEachSync = exports.readableForEach = exports.readableToArray = exports.readableFromArray = exports.readableFrom = exports.readableCreate = exports.slackDefaultMessagePrefixHook = exports.SlackService = exports.memoryUsageFull = exports.memoryUsage = exports.secretOptional = exports.secret = exports.removeSecretsFromEnv = exports.loadSecretsFromJsonFile = exports.loadSecretsFromEnv = exports.setSecretMap = exports.getSecretMap = exports.Debug = exports.base64ToBuffer = exports.bufferToBase64 = exports.base64ToString = exports.stringToBase64 = exports.md5AsBuffer = exports.hashAsBuffer = exports.hash = exports.md5 = exports.ALPHABET_ALPHANUMERIC = exports.ALPHABET_ALPHANUMERIC_UPPERCASE = exports.ALPHABET_ALPHANUMERIC_LOWERCASE = exports.ALPHABET_UPPERCASE = void 0;
-exports.sanitizeHTML = exports.hasColors = exports.readAjvSchemas = exports.readJsonSchemas = exports.AjvValidationError = exports.AjvSchema = exports.getAjv = exports.Ajv = exports._chunkBuffer = exports.TimeoutError = exports.HTTPError = exports.getGot = exports.inspectAny = exports.tableDiff = exports.BaseWorkerClass = exports.transformMultiThreaded = exports.writableFork = exports.writableVoid = exports.transformLimit = exports.transformLogProgress = exports.transformTap = exports.transformToArray = exports.transformToString = exports.transformSplit = exports.writablePushToArray = exports.writableForEach = exports.transformNoOp = void 0;
+exports.sanitizeHTML = exports.hasColors = exports.readAjvSchemas = exports.readJsonSchemas = exports.AjvValidationError = exports.AjvSchema = exports.getAjv = exports.Ajv = exports._chunkBuffer = exports.TimeoutError = exports.HTTPError = exports.getGot = exports.inspectAnyStringifyFn = exports.inspectAny = exports.tableDiff = exports.BaseWorkerClass = exports.transformMultiThreaded = exports.writableFork = exports.writableVoid = exports.transformLimit = exports.transformLogProgress = exports.transformTap = exports.transformToArray = exports.transformToString = exports.transformSplit = exports.writablePushToArray = exports.writableForEach = exports.transformNoOp = void 0;
 const ajv_1 = require("ajv");
 exports.Ajv = ajv_1.default;
 const got_1 = require("got");
@@ -128,6 +128,7 @@ const writableVoid_1 = require("./stream/writable/writableVoid");
 Object.defineProperty(exports, "writableVoid", { enumerable: true, get: function () { return writableVoid_1.writableVoid; } });
 const inspectAny_1 = require("./string/inspectAny");
 Object.defineProperty(exports, "inspectAny", { enumerable: true, get: function () { return inspectAny_1.inspectAny; } });
+Object.defineProperty(exports, "inspectAnyStringifyFn", { enumerable: true, get: function () { return inspectAny_1.inspectAnyStringifyFn; } });
 const env_util_1 = require("./util/env.util");
 Object.defineProperty(exports, "requireEnvKeys", { enumerable: true, get: function () { return env_util_1.requireEnvKeys; } });
 Object.defineProperty(exports, "requireFileToExist", { enumerable: true, get: function () { return env_util_1.requireFileToExist; } });

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

@@ -16,6 +16,10 @@ export interface TransformToNDJsonOptions {
      * @default `\n`
      */
     separator?: string;
+    /**
+     * @experimental
+     */
+    useFlatstr?: boolean;
 }
 /**
  * Transforms objects (objectMode=true) into chunks \n-terminated JSON strings (readableObjectMode=false).

package/dist/stream/ndjson/transformToNDJson.js

@@ -7,7 +7,7 @@ const js_lib_1 = require("@naturalcycles/js-lib");
  * Transforms objects (objectMode=true) into chunks \n-terminated JSON strings (readableObjectMode=false).
  */
 function transformToNDJson(opt = {}) {
-    const { strict = true, separator = '\n', sortObjects = false } = opt;
+    const { strict = true, separator = '\n', sortObjects = false, useFlatstr = false } = opt;
     return new stream_1.Transform({
         objectMode: true,
         readableObjectMode: false,
@@ -16,7 +16,12 @@ function transformToNDJson(opt = {}) {
                 if (sortObjects) {
                     chunk = (0, js_lib_1._sortObjectDeep)(chunk);
                 }
-                cb(null, JSON.stringify(chunk) + separator);
+                if (useFlatstr) {
+                    cb(null, flatstr(JSON.stringify(chunk) + separator));
+                }
+                else {
+                    cb(null, JSON.stringify(chunk) + separator);
+                }
             }
             catch (err) {
                 console.error(err);
@@ -31,3 +36,11 @@ function transformToNDJson(opt = {}) {
     });
 }
 exports.transformToNDJson = transformToNDJson;
+/**
+ * Based on: https://github.com/davidmarkclements/flatstr/blob/master/index.js
+ */
+function flatstr(s) {
+    // eslint-disable-next-line
+    s | 0;
+    return s;
+}

package/dist/string/inspectAny.d.ts

@@ -1,8 +1,12 @@
 /// <reference types="node" />
 import { InspectOptions } from 'util';
-import { StringifyAnyOptions } from '@naturalcycles/js-lib';
+import { StringifyAnyOptions, JsonStringifyFunction } from '@naturalcycles/js-lib';
 export interface InspectAnyOptions extends StringifyAnyOptions, InspectOptions {
 }
+/**
+ * Just a convenience export of a const that fulfills the JsonStringifyFunction interface.
+ */
+export declare const inspectAnyStringifyFn: JsonStringifyFunction;
 /**
  * Transforms ANY to human-readable string (via util.inspect mainly).
  * Safe (no error throwing).

package/dist/string/inspectAny.js

@@ -1,12 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.inspectAny = void 0;
+exports.inspectAny = exports.inspectAnyStringifyFn = void 0;
 const util_1 = require("util");
 const js_lib_1 = require("@naturalcycles/js-lib");
 const INSPECT_OPT = {
     breakLength: 80,
     depth: 10, // default: 2
 };
+/**
+ * Just a convenience export of a const that fulfills the JsonStringifyFunction interface.
+ */
+const inspectAnyStringifyFn = obj => inspectAny(obj);
+exports.inspectAnyStringifyFn = inspectAnyStringifyFn;
 /**
  * Transforms ANY to human-readable string (via util.inspect mainly).
  * Safe (no error throwing).

package/package.json

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

package/src/got/getGot.ts

@@ -1,5 +1,5 @@
 import { URL } from 'url'
-import { _jsonParseIfPossible, _since } from '@naturalcycles/js-lib'
+import { _since } from '@naturalcycles/js-lib'
 import got, { AfterResponseHook, BeforeErrorHook, BeforeRequestHook, Got, HTTPError } from 'got'
 import { inspectAny } from '..'
 import { dimGrey, grey, red, yellow } from '../colors'
@@ -13,6 +13,8 @@ import { GetGotOptions, GotRequestContext } from './got.model'
  * 3. Reasonable defaults(tm), e.g non-infinite Timeout
  */
 export function getGot(opt: GetGotOptions = {}): Got {
+  opt.logger ||= console
+
   return got.extend({
     // Most-important is to set to anything non-empty (so, requests don't "hang" by default).
     // Should be long enough to handle for slow responses from scaled cloud APIs in times of spikes
@@ -99,7 +101,7 @@ function gotBeforeRequestHook(opt: GetGotOptions): BeforeRequestHook {
 
     if (opt.logStart) {
       const shortUrl = getShortUrl(opt, options.url, options.prefixUrl)
-      console.log([dimGrey(' >>'), dimGrey(options.method), grey(shortUrl)].join(' '))
+      opt.logger!.log([dimGrey(' >>'), dimGrey(options.method), grey(shortUrl)].join(' '))
     }
   }
 }
@@ -113,7 +115,7 @@ function gotAfterResponseHook(opt: GetGotOptions = {}): AfterResponseHook {
       const { url, prefixUrl, method } = resp.request.options
       const shortUrl = getShortUrl(opt, url, prefixUrl)
 
-      console.log(
+      opt.logger!.log(
         [
           dimGrey(' <<'),
           coloredHttpCode(resp.statusCode),
@@ -129,7 +131,7 @@ function gotAfterResponseHook(opt: GetGotOptions = {}): AfterResponseHook {
 
     // Error responses are not logged, cause they're included in Error message already
     if (opt.logResponse && success) {
-      console.log(inspectAny(_jsonParseIfPossible(resp.body), { maxLen: opt.maxResponseLength }))
+      opt.logger!.log(inspectAny(resp.body, { maxLen: opt.maxResponseLength }))
     }
 
     return resp

package/src/got/got.model.ts

@@ -1,4 +1,4 @@
-import { AnyObject } from '@naturalcycles/js-lib'
+import { AnyObject, CommonLogger } from '@naturalcycles/js-lib'
 import type { Options } from 'got'
 
 export interface GetGotOptions extends Options {
@@ -33,6 +33,11 @@ export interface GetGotOptions extends Options {
    */
   logWithSearchParams?: boolean
 
+  /**
+   * Defaults to `console`
+   */
+  logger?: CommonLogger
+
   /**
    * Max length of response object before it's truncated.
    *

package/src/index.ts

@@ -108,7 +108,7 @@ import { writableForEach } from './stream/writable/writableForEach'
 import { writableFork } from './stream/writable/writableFork'
 import { writablePushToArray } from './stream/writable/writablePushToArray'
 import { writableVoid } from './stream/writable/writableVoid'
-import { inspectAny, InspectAnyOptions } from './string/inspectAny'
+import { inspectAny, InspectAnyOptions, inspectAnyStringifyFn } from './string/inspectAny'
 import { requireEnvKeys, requireFileToExist } from './util/env.util'
 import { LRUMemoCache } from './util/lruMemoCache'
 import {
@@ -339,6 +339,7 @@ export {
   BaseWorkerClass,
   tableDiff,
   inspectAny,
+  inspectAnyStringifyFn,
   getGot,
   HTTPError,
   TimeoutError,

package/src/stream/ndjson/transformToNDJson.ts

@@ -21,6 +21,11 @@ export interface TransformToNDJsonOptions {
    * @default `\n`
    */
   separator?: string
+
+  /**
+   * @experimental
+   */
+  useFlatstr?: boolean
 }
 
 /**
@@ -29,7 +34,7 @@ export interface TransformToNDJsonOptions {
 export function transformToNDJson<IN = any>(
   opt: TransformToNDJsonOptions = {},
 ): TransformTyped<IN, string> {
-  const { strict = true, separator = '\n', sortObjects = false } = opt
+  const { strict = true, separator = '\n', sortObjects = false, useFlatstr = false } = opt
 
   return new Transform({
     objectMode: true,
@@ -39,7 +44,12 @@ export function transformToNDJson<IN = any>(
         if (sortObjects) {
           chunk = _sortObjectDeep(chunk as any)
         }
-        cb(null, JSON.stringify(chunk) + separator)
+
+        if (useFlatstr) {
+          cb(null, flatstr(JSON.stringify(chunk) + separator))
+        } else {
+          cb(null, JSON.stringify(chunk) + separator)
+        }
       } catch (err) {
         console.error(err)
 
@@ -52,3 +62,12 @@ export function transformToNDJson<IN = any>(
     },
   })
 }
+
+/**
+ * Based on: https://github.com/davidmarkclements/flatstr/blob/master/index.js
+ */
+function flatstr(s: any): string {
+  // eslint-disable-next-line
+  s | 0
+  return s
+}

package/src/string/inspectAny.ts

@@ -1,5 +1,5 @@
 import { inspect, InspectOptions } from 'util'
-import { StringifyAnyOptions, _stringifyAny } from '@naturalcycles/js-lib'
+import { StringifyAnyOptions, _stringifyAny, JsonStringifyFunction } from '@naturalcycles/js-lib'
 
 export interface InspectAnyOptions extends StringifyAnyOptions, InspectOptions {}
 
@@ -8,6 +8,11 @@ const INSPECT_OPT: InspectOptions = {
   depth: 10, // default: 2
 }
 
+/**
+ * Just a convenience export of a const that fulfills the JsonStringifyFunction interface.
+ */
+export const inspectAnyStringifyFn: JsonStringifyFunction = obj => inspectAny(obj)
+
 /**
  * Transforms ANY to human-readable string (via util.inspect mainly).
  * Safe (no error throwing).