topkat-utils 1.2.51 → 1.2.53

package/backend.js

@@ -0,0 +1 @@
+module.exports = require('./dist/backend')

package/backend.ts

@@ -0,0 +1,78 @@
+
+
+import { C } from './src/logger-utils'
+import { exec } from 'child_process'
+
+
+/**
+ * @param {String} command cli command to execute
+ * @param {Obect} config
+ * * logOutputStream
+ * * stringOrRegexpToSearchForConsideringDone => when the output contain this string or matches this regexp, process is considered done. Else it will wait for exit
+ * * timeout => timeout before killing process in seconds
+ * * execOptions => see nodeJs exec command
+ * * keyCodeToSend => { a: 1000, b: 2000 } keyCode: afterNMs; Eg: key a will be triggered after N milliseconds
+ * * errorHandle (log: log the error as an error) (throw: throw the error)
+ * * streamConsoleOutput: output => { } callback for streaming output
+ */
+export async function execWaitForOutput(
+    command: string,
+    config = {} as Partial<{
+        logOutputStream: boolean
+        stringOrRegexpToSearchForConsideringDone: string
+        nbSecondsBeforeKillingProcess: number
+        keyCodeToSend: { [keyCode: string]: number },
+        errorHandle: 'log' | 'error'
+        streamConsoleOutput: (outputStr: string) => any,
+        execOptions: {cwd?: string, [seeNodeJsDocOnExec: string]: any}
+    }>
+): Promise<string | undefined> {
+
+    let outputStream = ''
+    let execOptions
+
+    const { nbSecondsBeforeKillingProcess = 20, streamConsoleOutput = () => true, errorHandle = 'throw', logOutputStream = true, stringOrRegexpToSearchForConsideringDone, keyCodeToSend = {} } = config
+
+    try {
+        return await new Promise((res, reject) => {
+            const to = setTimeout(() => {
+                C.error(`Exec timeout for ${command}`)
+                reject(`Exec timeout for ${command}`)
+            }, nbSecondsBeforeKillingProcess * 1000)
+
+            const process2 = exec(command, execOptions)
+            const resolve = () => {
+                process2?.kill('SIGINT')
+                clearTimeout(to)
+                res(outputStream)
+            }
+            const stdCallback = data => {
+                if (logOutputStream) C.log(data)
+                streamConsoleOutput(data)
+                outputStream += data
+                if (stringOrRegexpToSearchForConsideringDone) {
+                    const regexp = typeof stringOrRegexpToSearchForConsideringDone === 'string' ? new RegExp(stringOrRegexpToSearchForConsideringDone) : stringOrRegexpToSearchForConsideringDone
+                    if (regexp.test(data)) resolve()
+                }
+            }
+            const exitCallback = exitCode => {
+                if (exitCode === 0) resolve()
+                else if (stringOrRegexpToSearchForConsideringDone || typeof exitCode === 'number' && exitCode !== 0) reject(exitCode)
+                else resolve()
+            }
+            process2.stderr?.on('data', stdCallback)
+            process2.stdout?.on('data', stdCallback)
+            process2.on('exit', exitCallback)
+            process2.on('close', exitCallback)
+            for (const keyCode in keyCodeToSend) {
+                setTimeout(() => {
+                    process2.stdin?.write(keyCode)
+                    if (logOutputStream) C.log('Sending charcode to stdin: ' + keyCode)
+                }, keyCodeToSend[keyCode])
+            }
+        })
+    } catch (error) {
+        if (errorHandle === 'log') C.error(`Something went wrong using this command: ${command}\nPlease check this log:\n${outputStream}`)
+        else throw `Something went wrong using this command: ${command}\nPlease check this log:\n${outputStream}`
+    }
+}

package/dist/backend.d.ts

@@ -0,0 +1,25 @@
+/**
+ * @param {String} command cli command to execute
+ * @param {Obect} config
+ * * logOutputStream
+ * * stringOrRegexpToSearchForConsideringDone => when the output contain this string or matches this regexp, process is considered done. Else it will wait for exit
+ * * timeout => timeout before killing process in seconds
+ * * execOptions => see nodeJs exec command
+ * * keyCodeToSend => { a: 1000, b: 2000 } keyCode: afterNMs; Eg: key a will be triggered after N milliseconds
+ * * errorHandle (log: log the error as an error) (throw: throw the error)
+ * * streamConsoleOutput: output => { } callback for streaming output
+ */
+export declare function execWaitForOutput(command: string, config?: Partial<{
+    logOutputStream: boolean;
+    stringOrRegexpToSearchForConsideringDone: string;
+    nbSecondsBeforeKillingProcess: number;
+    keyCodeToSend: {
+        [keyCode: string]: number;
+    };
+    errorHandle: 'log' | 'error';
+    streamConsoleOutput: (outputStr: string) => any;
+    execOptions: {
+        [seeNodeJsDocOnExec: string]: any;
+        cwd?: string | undefined;
+    };
+}>): Promise<string | undefined>;

package/dist/backend.js

@@ -0,0 +1,75 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.execWaitForOutput = void 0;
+const logger_utils_1 = require("./src/logger-utils");
+const child_process_1 = require("child_process");
+/**
+ * @param {String} command cli command to execute
+ * @param {Obect} config
+ * * logOutputStream
+ * * stringOrRegexpToSearchForConsideringDone => when the output contain this string or matches this regexp, process is considered done. Else it will wait for exit
+ * * timeout => timeout before killing process in seconds
+ * * execOptions => see nodeJs exec command
+ * * keyCodeToSend => { a: 1000, b: 2000 } keyCode: afterNMs; Eg: key a will be triggered after N milliseconds
+ * * errorHandle (log: log the error as an error) (throw: throw the error)
+ * * streamConsoleOutput: output => { } callback for streaming output
+ */
+async function execWaitForOutput(command, config = {}) {
+    let outputStream = '';
+    let execOptions;
+    const { nbSecondsBeforeKillingProcess = 20, streamConsoleOutput = () => true, errorHandle = 'throw', logOutputStream = true, stringOrRegexpToSearchForConsideringDone, keyCodeToSend = {} } = config;
+    try {
+        return await new Promise((res, reject) => {
+            var _a, _b;
+            const to = setTimeout(() => {
+                logger_utils_1.C.error(`Exec timeout for ${command}`);
+                reject(`Exec timeout for ${command}`);
+            }, nbSecondsBeforeKillingProcess * 1000);
+            const process2 = (0, child_process_1.exec)(command, execOptions);
+            const resolve = () => {
+                process2 === null || process2 === void 0 ? void 0 : process2.kill('SIGINT');
+                clearTimeout(to);
+                res(outputStream);
+            };
+            const stdCallback = data => {
+                if (logOutputStream)
+                    logger_utils_1.C.log(data);
+                streamConsoleOutput(data);
+                outputStream += data;
+                if (stringOrRegexpToSearchForConsideringDone) {
+                    const regexp = typeof stringOrRegexpToSearchForConsideringDone === 'string' ? new RegExp(stringOrRegexpToSearchForConsideringDone) : stringOrRegexpToSearchForConsideringDone;
+                    if (regexp.test(data))
+                        resolve();
+                }
+            };
+            const exitCallback = exitCode => {
+                if (exitCode === 0)
+                    resolve();
+                else if (stringOrRegexpToSearchForConsideringDone || typeof exitCode === 'number' && exitCode !== 0)
+                    reject(exitCode);
+                else
+                    resolve();
+            };
+            (_a = process2.stderr) === null || _a === void 0 ? void 0 : _a.on('data', stdCallback);
+            (_b = process2.stdout) === null || _b === void 0 ? void 0 : _b.on('data', stdCallback);
+            process2.on('exit', exitCallback);
+            process2.on('close', exitCallback);
+            for (const keyCode in keyCodeToSend) {
+                setTimeout(() => {
+                    var _a;
+                    (_a = process2.stdin) === null || _a === void 0 ? void 0 : _a.write(keyCode);
+                    if (logOutputStream)
+                        logger_utils_1.C.log('Sending charcode to stdin: ' + keyCode);
+                }, keyCodeToSend[keyCode]);
+            }
+        });
+    }
+    catch (error) {
+        if (errorHandle === 'log')
+            logger_utils_1.C.error(`Something went wrong using this command: ${command}\nPlease check this log:\n${outputStream}`);
+        else
+            throw `Something went wrong using this command: ${command}\nPlease check this log:\n${outputStream}`;
+    }
+}
+exports.execWaitForOutput = execWaitForOutput;
+//# sourceMappingURL=backend.js.map

package/dist/backend.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"backend.js","sourceRoot":"","sources":["../backend.ts"],"names":[],"mappings":";;;AAEA,qDAAsC;AACtC,iDAAoC;AAGpC;;;;;;;;;;GAUG;AACI,KAAK,UAAU,iBAAiB,CACnC,OAAe,EACf,SAAS,EAQP;IAGF,IAAI,YAAY,GAAG,EAAE,CAAA;IACrB,IAAI,WAAW,CAAA;IAEf,MAAM,EAAE,6BAA6B,GAAG,EAAE,EAAE,mBAAmB,GAAG,GAAG,EAAE,CAAC,IAAI,EAAE,WAAW,GAAG,OAAO,EAAE,eAAe,GAAG,IAAI,EAAE,wCAAwC,EAAE,aAAa,GAAG,EAAE,EAAE,GAAG,MAAM,CAAA;IAEpM,IAAI;QACA,OAAO,MAAM,IAAI,OAAO,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE;;YACrC,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE;gBACvB,gBAAC,CAAC,KAAK,CAAC,oBAAoB,OAAO,EAAE,CAAC,CAAA;gBACtC,MAAM,CAAC,oBAAoB,OAAO,EAAE,CAAC,CAAA;YACzC,CAAC,EAAE,6BAA6B,GAAG,IAAI,CAAC,CAAA;YAExC,MAAM,QAAQ,GAAG,IAAA,oBAAI,EAAC,OAAO,EAAE,WAAW,CAAC,CAAA;YAC3C,MAAM,OAAO,GAAG,GAAG,EAAE;gBACjB,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,IAAI,CAAC,QAAQ,CAAC,CAAA;gBACxB,YAAY,CAAC,EAAE,CAAC,CAAA;gBAChB,GAAG,CAAC,YAAY,CAAC,CAAA;YACrB,CAAC,CAAA;YACD,MAAM,WAAW,GAAG,IAAI,CAAC,EAAE;gBACvB,IAAI,eAAe;oBAAE,gBAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;gBAChC,mBAAmB,CAAC,IAAI,CAAC,CAAA;gBACzB,YAAY,IAAI,IAAI,CAAA;gBACpB,IAAI,wCAAwC,EAAE;oBAC1C,MAAM,MAAM,GAAG,OAAO,wCAAwC,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,wCAAwC,CAAC,CAAC,CAAC,CAAC,wCAAwC,CAAA;oBAC7K,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;wBAAE,OAAO,EAAE,CAAA;iBACnC;YACL,CAAC,CAAA;YACD,MAAM,YAAY,GAAG,QAAQ,CAAC,EAAE;gBAC5B,IAAI,QAAQ,KAAK,CAAC;oBAAE,OAAO,EAAE,CAAA;qBACxB,IAAI,wCAAwC,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,KAAK,CAAC;oBAAE,MAAM,CAAC,QAAQ,CAAC,CAAA;;oBAChH,OAAO,EAAE,CAAA;YAClB,CAAC,CAAA;YACD,MAAA,QAAQ,CAAC,MAAM,0CAAE,EAAE,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;YACxC,MAAA,QAAQ,CAAC,MAAM,0CAAE,EAAE,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;YACxC,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,YAAY,CAAC,CAAA;YACjC,QAAQ,CAAC,EAAE,CAAC,OAAO,EAAE,YAAY,CAAC,CAAA;YAClC,KAAK,MAAM,OAAO,IAAI,aAAa,EAAE;gBACjC,UAAU,CAAC,GAAG,EAAE;;oBACZ,MAAA,QAAQ,CAAC,KAAK,0CAAE,KAAK,CAAC,OAAO,CAAC,CAAA;oBAC9B,IAAI,eAAe;wBAAE,gBAAC,CAAC,GAAG,CAAC,6BAA6B,GAAG,OAAO,CAAC,CAAA;gBACvE,CAAC,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC,CAAA;aAC7B;QACL,CAAC,CAAC,CAAA;KACL;IAAC,OAAO,KAAK,EAAE;QACZ,IAAI,WAAW,KAAK,KAAK;YAAE,gBAAC,CAAC,KAAK,CAAC,4CAA4C,OAAO,6BAA6B,YAAY,EAAE,CAAC,CAAA;;YAC7H,MAAM,4CAA4C,OAAO,6BAA6B,YAAY,EAAE,CAAA;KAC5G;AACL,CAAC;AA5DD,8CA4DC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "topkat-utils",
-  "version": "1.2.51",
+  "version": "1.2.53",
   "type": "commonjs",
   "types": "index.ts",
   "main": "dist",

package/tsconfig.json

@@ -18,6 +18,7 @@
     },
     "include": [
         "./**/*.ts",
-        "index.ts"
+        "index.ts",
+        "backend.ts"
     ],
 }