@naturalcycles/nodejs-lib 12.70.0 → 12.72.0

package/dist/bin/json2env.js

@@ -19,6 +19,11 @@ const script_1 = require("../script");
             desc: 'Populate $BASH_ENV file if BASH_ENV env variable exists',
             default: true,
         },
+        githubEnv: {
+            type: 'boolean',
+            desc: 'Populate $GITHUB_ENV file if GITHUB_ENV env variable exists',
+            default: true,
+        },
         fail: {
             type: 'boolean',
             desc: 'Fail (exit status 1) on non-existing input file',
@@ -31,7 +36,7 @@ const script_1 = require("../script");
             type: 'boolean',
         },
     });
-    const { _: args, prefix, saveEnvFile, bashEnv, fail, debug, silent } = argv;
+    const { _: args, prefix, saveEnvFile, bashEnv, githubEnv, fail, debug, silent } = argv;
     if (debug)
         console.log({ argv });
     const jsonPath = args[0];
@@ -40,6 +45,7 @@ const script_1 = require("../script");
         prefix,
         saveEnvFile,
         bashEnv,
+        githubEnv,
         fail,
         debug,
         silent,

package/dist/fs/json2env.d.ts

@@ -9,6 +9,10 @@ export interface Json2EnvOptions {
      * @default true
      */
     bashEnv?: boolean;
+    /**
+     * @default true
+     */
+    githubEnv?: boolean;
     /**
      * @default true
      */
@@ -29,3 +33,15 @@ export declare function json2env(opt: Json2EnvOptions): void;
  * export b="c"
  */
 export declare function objectToShellExport(o: any, prefix?: string): string;
+/**
+ * Turns Object with keys/values into a file of key-value pairs
+ *
+ * @example
+ * { a: 'b', b: 'c'}
+ *
+ * will turn into:
+ *
+ * a=b
+ * b=c
+ */
+export declare function objectToGithubActionsEnv(o: any, prefix?: string): string;

package/dist/fs/json2env.js

@@ -1,15 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.objectToShellExport = exports.json2env = void 0;
+exports.objectToGithubActionsEnv = exports.objectToShellExport = exports.json2env = void 0;
 const fs = require("fs-extra");
 const colors_1 = require("../colors");
 const JSON2ENV_OPT_DEF = {
     saveEnvFile: true,
     bashEnv: true,
+    githubEnv: true,
     fail: true,
 };
 function json2env(opt) {
-    const { jsonPath, prefix, saveEnvFile, bashEnv, fail, debug, silent } = {
+    const { jsonPath, prefix, saveEnvFile, bashEnv, githubEnv, fail, debug, silent } = {
         ...JSON2ENV_OPT_DEF,
         ...opt,
     };
@@ -28,8 +29,9 @@ function json2env(opt) {
     // read file
     const json = fs.readJsonSync(jsonPath);
     const exportStr = objectToShellExport(json, prefix);
+    const githubStr = objectToGithubActionsEnv(json, prefix);
     if (debug) {
-        console.log(json, exportStr);
+        console.log(json, exportStr, githubStr);
     }
     if (saveEnvFile) {
         const shPath = `${jsonPath}.sh`;
@@ -42,6 +44,9 @@ function json2env(opt) {
     if (bashEnv) {
         appendBashEnv(exportStr);
     }
+    if (githubEnv) {
+        appendGithubEnv(githubStr);
+    }
 }
 exports.json2env = json2env;
 function appendBashEnv(exportStr) {
@@ -51,6 +56,13 @@ function appendBashEnv(exportStr) {
         console.log(`BASH_ENV file appended (${(0, colors_1.dimGrey)(BASH_ENV)})`);
     }
 }
+function appendGithubEnv(exportStr) {
+    const { GITHUB_ENV } = process.env;
+    if (GITHUB_ENV) {
+        fs.appendFileSync(GITHUB_ENV, exportStr + '\n');
+        console.log(`GITHUB_ENV file appended (${(0, colors_1.dimGrey)(GITHUB_ENV)})`);
+    }
+}
 /**
  * Turns Object with keys/values into a *.sh script that exports all keys as values.
  *
@@ -74,3 +86,26 @@ function objectToShellExport(o, prefix = '') {
         .join('\n');
 }
 exports.objectToShellExport = objectToShellExport;
+/**
+ * Turns Object with keys/values into a file of key-value pairs
+ *
+ * @example
+ * { a: 'b', b: 'c'}
+ *
+ * will turn into:
+ *
+ * a=b
+ * b=c
+ */
+function objectToGithubActionsEnv(o, prefix = '') {
+    return Object.keys(o)
+        .map(k => {
+        const v = o[k];
+        if (v) {
+            return `${prefix}${k}=${v}`;
+        }
+    })
+        .filter(Boolean)
+        .join('\n');
+}
+exports.objectToGithubActionsEnv = objectToGithubActionsEnv;

package/dist/got/getGot.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getGot = void 0;
+const url_1 = require("url");
 const js_lib_1 = require("@naturalcycles/js-lib");
 const got_1 = require("got");
 const __1 = require("..");
@@ -180,7 +181,9 @@ function gotBeforeRetryHook(opt) {
         const statusCode = err?.response?.statusCode || 0;
         if (statusCode && statusCode < 300) {
             // todo: possibly remove the log message completely in the future
-            opt.logger.log(`skipping got.beforeRetry hook as statusCode is ${statusCode}, err.msg is ${err?.message}`);
+            // opt.logger!.log(
+            //   `skipping got.beforeRetry hook as statusCode is ${statusCode}, err.msg is ${err?.message}`,
+            // )
             return;
         }
         const { method, url, prefixUrl } = options;
@@ -242,6 +245,10 @@ function gotAfterResponseHook(opt = {}) {
     };
 }
 function getShortUrl(opt, url, prefixUrl) {
+    if (url.password) {
+        url = new url_1.URL(url.toString()); // prevent original url mutation
+        url.password = '[redacted]';
+    }
     let shortUrl = url.toString();
     if (opt.logWithSearchParams === false) {
         shortUrl = shortUrl.split('?')[0];

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

@@ -1,4 +1,5 @@
 /// <reference types="node" />
+/// <reference types="node" />
 import { ZlibOptions } from 'zlib';
 import { NDJsonStats } from './ndjson.model';
 import { TransformJsonParseOptions } from './transformJsonParse';

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

@@ -1,4 +1,5 @@
 /// <reference types="node" />
+/// <reference types="node" />
 import { ZlibOptions } from 'zlib';
 import { NDJsonStats } from './ndjson.model';
 import { TransformToNDJsonOptions } from './transformToNDJson';

package/dist/stream/pipeline/pipeline.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="node" />
+/// <reference types="node" />
 import { Readable, Transform } from 'stream';
 import { DeferredPromise } from '@naturalcycles/js-lib';
 declare type AnyStream = NodeJS.ReadableStream | NodeJS.WritableStream | NodeJS.ReadWriteStream;

package/dist/util/lruMemoCache.d.ts

@@ -1,5 +1,5 @@
 import { MemoCache } from '@naturalcycles/js-lib';
-import LRUCache = require('lru-cache');
+import * as LRUCache from 'lru-cache';
 export declare type LRUMemoCacheOptions<KEY, VALUE> = Partial<LRUCache.Options<KEY, VALUE>>;
 /**
  * @example

package/dist/util/zip.util.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="node" />
+/// <reference types="node" />
 import { ZlibOptions } from 'zlib';
 /**
  * deflateBuffer uses `deflate`.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@naturalcycles/nodejs-lib",
-  "version": "12.70.0",
+  "version": "12.72.0",
   "scripts": {
     "prepare": "husky install",
     "docs-serve": "vuepress dev docs",
@@ -15,7 +15,6 @@
   },
   "dependencies": {
     "@naturalcycles/js-lib": "^14.0.0",
-    "@types/lru-cache": "^7.4.0",
     "@types/through2-concurrent": "^2.0.0",
     "ajv": "^8.6.2",
     "ajv-formats": "^2.1.0",
@@ -42,7 +41,7 @@
     "@naturalcycles/dev-lib": "^12.0.0",
     "@types/node": "^17.0.0",
     "@types/yargs": "^16.0.0",
-    "jest": "^27.0.1",
+    "jest": "^28.0.3",
     "nock": "^13.0.2",
     "patch-package": "^6.2.1",
     "prettier": "^2.0.0",

package/src/bin/json2env.ts

@@ -19,6 +19,11 @@ runScript(() => {
       desc: 'Populate $BASH_ENV file if BASH_ENV env variable exists',
       default: true,
     },
+    githubEnv: {
+      type: 'boolean',
+      desc: 'Populate $GITHUB_ENV file if GITHUB_ENV env variable exists',
+      default: true,
+    },
     fail: {
       type: 'boolean',
       desc: 'Fail (exit status 1) on non-existing input file',
@@ -32,7 +37,7 @@ runScript(() => {
     },
   })
 
-  const { _: args, prefix, saveEnvFile, bashEnv, fail, debug, silent } = argv
+  const { _: args, prefix, saveEnvFile, bashEnv, githubEnv, fail, debug, silent } = argv
   if (debug) console.log({ argv })
 
   const jsonPath = args[0] as string
@@ -42,6 +47,7 @@ runScript(() => {
     prefix,
     saveEnvFile,
     bashEnv,
+    githubEnv,
     fail,
     debug,
     silent,

package/src/fs/json2env.ts

@@ -15,6 +15,11 @@ export interface Json2EnvOptions {
    */
   bashEnv?: boolean
 
+  /**
+   * @default true
+   */
+  githubEnv?: boolean
+
   /**
    * @default true
    */
@@ -27,11 +32,12 @@ export interface Json2EnvOptions {
 const JSON2ENV_OPT_DEF: Partial<Json2EnvOptions> = {
   saveEnvFile: true,
   bashEnv: true,
+  githubEnv: true,
   fail: true,
 }
 
 export function json2env(opt: Json2EnvOptions): void {
-  const { jsonPath, prefix, saveEnvFile, bashEnv, fail, debug, silent } = {
+  const { jsonPath, prefix, saveEnvFile, bashEnv, githubEnv, fail, debug, silent } = {
     ...JSON2ENV_OPT_DEF,
     ...opt,
   }
@@ -56,8 +62,10 @@ export function json2env(opt: Json2EnvOptions): void {
   const json = fs.readJsonSync(jsonPath)
 
   const exportStr = objectToShellExport(json, prefix)
+  const githubStr = objectToGithubActionsEnv(json, prefix)
+
   if (debug) {
-    console.log(json, exportStr)
+    console.log(json, exportStr, githubStr)
   }
 
   if (saveEnvFile) {
@@ -73,6 +81,10 @@ export function json2env(opt: Json2EnvOptions): void {
   if (bashEnv) {
     appendBashEnv(exportStr)
   }
+
+  if (githubEnv) {
+    appendGithubEnv(githubStr)
+  }
 }
 
 function appendBashEnv(exportStr: string): void {
@@ -84,6 +96,15 @@ function appendBashEnv(exportStr: string): void {
   }
 }
 
+function appendGithubEnv(exportStr: string): void {
+  const { GITHUB_ENV } = process.env
+  if (GITHUB_ENV) {
+    fs.appendFileSync(GITHUB_ENV, exportStr + '\n')
+
+    console.log(`GITHUB_ENV file appended (${dimGrey(GITHUB_ENV)})`)
+  }
+}
+
 /**
  * Turns Object with keys/values into a *.sh script that exports all keys as values.
  *
@@ -106,3 +127,26 @@ export function objectToShellExport(o: any, prefix = ''): string {
     .filter(Boolean)
     .join('\n')
 }
+
+/**
+ * Turns Object with keys/values into a file of key-value pairs
+ *
+ * @example
+ * { a: 'b', b: 'c'}
+ *
+ * will turn into:
+ *
+ * a=b
+ * b=c
+ */
+export function objectToGithubActionsEnv(o: any, prefix = ''): string {
+  return Object.keys(o)
+    .map(k => {
+      const v = o[k]
+      if (v) {
+        return `${prefix}${k}=${v}`
+      }
+    })
+    .filter(Boolean)
+    .join('\n')
+}

package/src/got/getGot.ts

@@ -207,9 +207,9 @@ function gotBeforeRetryHook(opt: GetGotOptions): BeforeRetryHook {
 
     if (statusCode && statusCode < 300) {
       // todo: possibly remove the log message completely in the future
-      opt.logger!.log(
-        `skipping got.beforeRetry hook as statusCode is ${statusCode}, err.msg is ${err?.message}`,
-      )
+      // opt.logger!.log(
+      //   `skipping got.beforeRetry hook as statusCode is ${statusCode}, err.msg is ${err?.message}`,
+      // )
       return
     }
 
@@ -284,6 +284,11 @@ function gotAfterResponseHook(opt: GetGotOptions = {}): AfterResponseHook {
 }
 
 function getShortUrl(opt: GetGotOptions, url: URL, prefixUrl?: string): string {
+  if (url.password) {
+    url = new URL(url.toString()) // prevent original url mutation
+    url.password = '[redacted]'
+  }
+
   let shortUrl = url.toString()
 
   if (opt.logWithSearchParams === false) {

package/src/util/lruMemoCache.ts

@@ -1,5 +1,5 @@
 import { MemoCache } from '@naturalcycles/js-lib'
-import LRUCache = require('lru-cache')
+import * as LRUCache from 'lru-cache'
 
 // Partial, to be able to provide default `max`
 export type LRUMemoCacheOptions<KEY, VALUE> = Partial<LRUCache.Options<KEY, VALUE>>