@naturalcycles/nodejs-lib 13.2.1 → 13.3.0

package/dist/security/hash.util.d.ts

@@ -1,15 +1,20 @@
 /// <reference types="node" />
-import { Base64String } from '@naturalcycles/js-lib';
-export declare function md5(s: string | Buffer): string;
-export declare function md5AsBase64(s: string | Buffer): Base64String;
+/// <reference types="node" />
+import { BinaryToTextEncoding } from 'node:crypto';
+import type { Base64String, Base64UrlString } from '@naturalcycles/js-lib';
+export declare function md5(s: string | Buffer, outputEncoding?: BinaryToTextEncoding): string;
 export declare function md5AsBuffer(s: string | Buffer): Buffer;
-export declare function sha256(s: string | Buffer): string;
-export declare function sha256AsBase64(s: string | Buffer): Base64String;
+export declare function sha256(s: string | Buffer, outputEncoding?: BinaryToTextEncoding): string;
 export declare function sha256AsBuffer(s: string | Buffer): Buffer;
-export declare function hash(s: string | Buffer, algorithm: string): string;
+export declare function hash(s: string | Buffer, algorithm: string, outputEncoding?: BinaryToTextEncoding): string;
 export declare function hashAsBuffer(s: string | Buffer, algorithm: string): Buffer;
 export declare function base64(s: string | Buffer): Base64String;
+export declare function base64Url(s: string | Buffer): Base64UrlString;
 export declare function base64ToString(strBase64: Base64String): string;
-export declare function base64ToBuffer(strBase64: string): Buffer;
+export declare function base64UrlToString(strBase64Url: Base64UrlString): string;
+export declare function base64ToBuffer(strBase64: Base64String): Buffer;
+export declare function base64UrlToBuffer(strBase64Url: Base64UrlString): Buffer;
 export declare function stringToBase64(s: string): Base64String;
+export declare function stringToBase64Url(s: string): Base64UrlString;
 export declare function bufferToBase64(b: Buffer): Base64String;
+export declare function bufferToBase64Url(b: Buffer): Base64UrlString;

package/dist/security/hash.util.js

@@ -1,34 +1,26 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.bufferToBase64 = exports.stringToBase64 = exports.base64ToBuffer = exports.base64ToString = exports.base64 = exports.hashAsBuffer = exports.hash = exports.sha256AsBuffer = exports.sha256AsBase64 = exports.sha256 = exports.md5AsBuffer = exports.md5AsBase64 = exports.md5 = void 0;
+exports.bufferToBase64Url = exports.bufferToBase64 = exports.stringToBase64Url = exports.stringToBase64 = exports.base64UrlToBuffer = exports.base64ToBuffer = exports.base64UrlToString = exports.base64ToString = exports.base64Url = exports.base64 = exports.hashAsBuffer = exports.hash = exports.sha256AsBuffer = exports.sha256 = exports.md5AsBuffer = exports.md5 = void 0;
 const tslib_1 = require("tslib");
 const node_crypto_1 = tslib_1.__importDefault(require("node:crypto"));
-function md5(s) {
-    return hash(s, 'md5');
+function md5(s, outputEncoding = 'hex') {
+    return hash(s, 'md5', outputEncoding);
 }
 exports.md5 = md5;
-function md5AsBase64(s) {
-    return hashAsBuffer(s, 'md5').toString('base64');
-}
-exports.md5AsBase64 = md5AsBase64;
 function md5AsBuffer(s) {
     return hashAsBuffer(s, 'md5');
 }
 exports.md5AsBuffer = md5AsBuffer;
-function sha256(s) {
-    return hash(s, 'sha256');
+function sha256(s, outputEncoding = 'hex') {
+    return hash(s, 'sha256', outputEncoding);
 }
 exports.sha256 = sha256;
-function sha256AsBase64(s) {
-    return hashAsBuffer(s, 'sha256').toString('base64');
-}
-exports.sha256AsBase64 = sha256AsBase64;
 function sha256AsBuffer(s) {
     return hashAsBuffer(s, 'sha256');
 }
 exports.sha256AsBuffer = sha256AsBuffer;
-function hash(s, algorithm) {
-    return node_crypto_1.default.createHash(algorithm).update(s).digest('hex');
+function hash(s, algorithm, outputEncoding = 'hex') {
+    return node_crypto_1.default.createHash(algorithm).update(s).digest(outputEncoding);
 }
 exports.hash = hash;
 function hashAsBuffer(s, algorithm) {
@@ -39,19 +31,39 @@ function base64(s) {
     return (typeof s === 'string' ? Buffer.from(s) : s).toString('base64');
 }
 exports.base64 = base64;
+function base64Url(s) {
+    return (typeof s === 'string' ? Buffer.from(s) : s).toString('base64url');
+}
+exports.base64Url = base64Url;
 function base64ToString(strBase64) {
     return Buffer.from(strBase64, 'base64').toString('utf8');
 }
 exports.base64ToString = base64ToString;
+function base64UrlToString(strBase64Url) {
+    return Buffer.from(strBase64Url, 'base64url').toString('utf8');
+}
+exports.base64UrlToString = base64UrlToString;
 function base64ToBuffer(strBase64) {
     return Buffer.from(strBase64, 'base64');
 }
 exports.base64ToBuffer = base64ToBuffer;
+function base64UrlToBuffer(strBase64Url) {
+    return Buffer.from(strBase64Url, 'base64url');
+}
+exports.base64UrlToBuffer = base64UrlToBuffer;
 function stringToBase64(s) {
     return Buffer.from(s, 'utf8').toString('base64');
 }
 exports.stringToBase64 = stringToBase64;
+function stringToBase64Url(s) {
+    return Buffer.from(s, 'utf8').toString('base64url');
+}
+exports.stringToBase64Url = stringToBase64Url;
 function bufferToBase64(b) {
     return b.toString('base64');
 }
 exports.bufferToBase64 = bufferToBase64;
+function bufferToBase64Url(b) {
+    return b.toString('base64url');
+}
+exports.bufferToBase64Url = bufferToBase64Url;

package/dist/stream/ndjson/ndjsonMap.js

@@ -22,7 +22,7 @@ async function ndjsonMap(mapper, opt) {
     await (0, __1._pipeline)([
         readable,
         ...transformUnzip,
-        (0, __1.transformSplit)(),
+        (0, __1.transformSplit)(), // splits by \n
         (0, __1.transformJsonParse)(),
         (0, __1.transformLimit)({ limit: limitInput, sourceReadable: readable }),
         (0, __1.transformLogProgress)({ metric: 'read', ...opt }),

package/dist/stream/ndjson/pipelineFromNDJsonFile.js

@@ -21,7 +21,7 @@ async function pipelineFromNDJsonFile(streams, opt) {
     await (0, __1._pipeline)([
         node_fs_1.default.createReadStream(filePath),
         ...(gzip ? [(0, node_zlib_1.createUnzip)(opt.zlibOptions)] : []),
-        (0, __1.transformSplit)(separator),
+        (0, __1.transformSplit)(separator), // splits by separator
         (0, transformJsonParse_1.transformJsonParse)(opt),
         (0, __1.transformTap)(() => rows++),
         ...streams,

package/dist/stream/ndjson/pipelineToNDJsonFile.js

@@ -27,7 +27,7 @@ async function pipelineToNDJsonFile(streams, opt) {
         ...streams,
         (0, __1.transformTap)(() => rows++),
         (0, transformToNDJson_1.transformToNDJson)(opt),
-        ...(gzip ? [(0, node_zlib_1.createGzip)(opt.zlibOptions)] : []),
+        ...(gzip ? [(0, node_zlib_1.createGzip)(opt.zlibOptions)] : []), // optional gzip
         node_fs_1.default.createWriteStream(filePath),
     ]);
     const { size: sizeBytes } = node_fs_1.default.statSync(filePath);

package/dist/stream/transform/worker/transformMultiThreaded.js

@@ -28,7 +28,7 @@ function transformMultiThreaded(opt) {
         const worker = new node_worker_threads_1.Worker(workerProxyFilePath, {
             workerData: {
                 workerIndex,
-                workerFile,
+                workerFile, // pass it, so workerProxy can require() it
                 ...workerData,
             },
         });

package/dist/string/inspect.js

@@ -4,7 +4,7 @@ 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 = {
-    breakLength: 80,
+    breakLength: 80, // default: ??
     depth: 10, // default: 2
 };
 /**

package/dist/validation/ajv/getAjv.js

@@ -7,7 +7,7 @@ const AJV_OPTIONS = {
     removeAdditional: true,
     allErrors: true,
     // https://ajv.js.org/options.html#usedefaults
-    useDefaults: 'empty',
+    useDefaults: 'empty', // this will mutate your input!
     // these are important and kept same as default:
     // https://ajv.js.org/options.html#coercetypes
     coerceTypes: false, // while `false` - it won't mutate your input
@@ -29,13 +29,14 @@ function getAjv(opt) {
     require('ajv-formats')(ajv);
     // https://ajv.js.org/packages/ajv-keywords.html
     require('ajv-keywords')(ajv, [
-        'transform',
+        'transform', // trim, toLowerCase, etc.
         'uniqueItemProperties',
         'instanceof',
     ]);
     // Adds $merge, $patch keywords
     // https://github.com/ajv-validator/ajv-merge-patch
-    require('ajv-merge-patch')(ajv);
+    // Kirill: temporarily disabled, as it creates a noise of CVE warnings
+    // require('ajv-merge-patch')(ajv)
     return ajv;
 }
 exports.getAjv = getAjv;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@naturalcycles/nodejs-lib",
-  "version": "13.2.1",
+  "version": "13.3.0",
   "scripts": {
     "prepare": "husky install",
     "docs-serve": "vuepress dev docs",
@@ -20,7 +20,6 @@
     "ajv": "^8.6.2",
     "ajv-formats": "^2.1.0",
     "ajv-keywords": "^5.0.0",
-    "ajv-merge-patch": "^5.0.1",
     "binary-split": "^1.0.5",
     "chalk": "^4.0.0",
     "debug": "^4.1.1",

package/src/security/hash.util.ts

@@ -1,32 +1,28 @@
-import crypto from 'node:crypto'
-import { Base64String } from '@naturalcycles/js-lib'
+import crypto, { BinaryToTextEncoding } from 'node:crypto'
+import type { Base64String, Base64UrlString } from '@naturalcycles/js-lib'
 
-export function md5(s: string | Buffer): string {
-  return hash(s, 'md5')
-}
-
-export function md5AsBase64(s: string | Buffer): Base64String {
-  return hashAsBuffer(s, 'md5').toString('base64')
+export function md5(s: string | Buffer, outputEncoding: BinaryToTextEncoding = 'hex'): string {
+  return hash(s, 'md5', outputEncoding)
 }
 
 export function md5AsBuffer(s: string | Buffer): Buffer {
   return hashAsBuffer(s, 'md5')
 }
 
-export function sha256(s: string | Buffer): string {
-  return hash(s, 'sha256')
-}
-
-export function sha256AsBase64(s: string | Buffer): Base64String {
-  return hashAsBuffer(s, 'sha256').toString('base64')
+export function sha256(s: string | Buffer, outputEncoding: BinaryToTextEncoding = 'hex'): string {
+  return hash(s, 'sha256', outputEncoding)
 }
 
 export function sha256AsBuffer(s: string | Buffer): Buffer {
   return hashAsBuffer(s, 'sha256')
 }
 
-export function hash(s: string | Buffer, algorithm: string): string {
-  return crypto.createHash(algorithm).update(s).digest('hex')
+export function hash(
+  s: string | Buffer,
+  algorithm: string,
+  outputEncoding: BinaryToTextEncoding = 'hex',
+): string {
+  return crypto.createHash(algorithm).update(s).digest(outputEncoding)
 }
 
 export function hashAsBuffer(s: string | Buffer, algorithm: string): Buffer {
@@ -37,18 +33,38 @@ export function base64(s: string | Buffer): Base64String {
   return (typeof s === 'string' ? Buffer.from(s) : s).toString('base64')
 }
 
+export function base64Url(s: string | Buffer): Base64UrlString {
+  return (typeof s === 'string' ? Buffer.from(s) : s).toString('base64url')
+}
+
 export function base64ToString(strBase64: Base64String): string {
   return Buffer.from(strBase64, 'base64').toString('utf8')
 }
 
-export function base64ToBuffer(strBase64: string): Buffer {
+export function base64UrlToString(strBase64Url: Base64UrlString): string {
+  return Buffer.from(strBase64Url, 'base64url').toString('utf8')
+}
+
+export function base64ToBuffer(strBase64: Base64String): Buffer {
   return Buffer.from(strBase64, 'base64')
 }
 
+export function base64UrlToBuffer(strBase64Url: Base64UrlString): Buffer {
+  return Buffer.from(strBase64Url, 'base64url')
+}
+
 export function stringToBase64(s: string): Base64String {
   return Buffer.from(s, 'utf8').toString('base64')
 }
 
+export function stringToBase64Url(s: string): Base64UrlString {
+  return Buffer.from(s, 'utf8').toString('base64url')
+}
+
 export function bufferToBase64(b: Buffer): Base64String {
   return b.toString('base64')
 }
+
+export function bufferToBase64Url(b: Buffer): Base64UrlString {
+  return b.toString('base64url')
+}

package/src/validation/ajv/getAjv.ts

@@ -38,7 +38,8 @@ export function getAjv(opt?: Options): Ajv {
 
   // Adds $merge, $patch keywords
   // https://github.com/ajv-validator/ajv-merge-patch
-  require('ajv-merge-patch')(ajv)
+  // Kirill: temporarily disabled, as it creates a noise of CVE warnings
+  // require('ajv-merge-patch')(ajv)
 
   return ajv
 }