@metricinsights/cs-helper 0.3.2 → 0.5.0

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# [0.4.0-beta.1](https://github.com/mi-examples/cs-helper/compare/v0.3.2...v0.4.0-beta.1) (2026-01-28)
+
+
+### Features
+
+* add log util and export from package ([d0ebd74](https://github.com/mi-examples/cs-helper/commit/d0ebd747b8717977f406b02e90ed11a3062aeec8))
+* **build:** add script source hash and build checksum in banner ([35196ba](https://github.com/mi-examples/cs-helper/commit/35196ba4bfb7b3f90edfaf64bbe3f854bc095e85))

package/README.md

@@ -29,10 +29,11 @@ Run command to build your code `npm run build`
 
 #### API options
 
-| Option    | Description                        | Default |
-|-----------|------------------------------------|---------|
-| `--clean` | Clean dist folder before build     | `false` |
-| `--v7`    | CS will be compatible only with v7 | `false` |
+| Option           | Description                                                      | Default |
+|------------------|------------------------------------------------------------------|---------|
+| `--clean`        | Clean dist folder before build                                  | `false` |
+| `--v7`           | CS will be compatible only with v7                              | `false` |
+| `--readme <path>` | Path to README.md file to include in the built script banner    | Auto-detect `README.md` in project root |
 
 ### Basic usage
 
@@ -48,6 +49,42 @@ setTimeout(() => {
 
 ### Utils usage
 
+#### Log utility
+
+Provides logging utilities with log level support for custom scripts. Logs are only visible if their level is greater than or equal to the current log level.
+
+```javascript
+import {
+  log,
+  setLogLevel,
+  getLogLevel,
+  LOG_LEVEL_DEBUG,
+  LOG_LEVEL_INFO,
+  LOG_LEVEL_WARN,
+  LOG_LEVEL_ERROR,
+} from '@metricinsights/cs-helper/utils';
+
+// Set the current log level (defaults to INFO/1)
+// Only logs with level >= current level will be visible
+setLogLevel(LOG_LEVEL_INFO); // or setLogLevel(1) or setLogLevel('info')
+
+// Get current log level
+const currentLevel = getLogLevel(); // Returns: 1
+
+// Log messages with different levels
+log('Debug information', LOG_LEVEL_DEBUG); // Level 0 - NOT visible (current level is 1)
+log('Info message', LOG_LEVEL_INFO);        // Level 1 - VISIBLE ✓
+log('Warning message', LOG_LEVEL_WARN);     // Level 2 - VISIBLE ✓
+log('Error occurred', LOG_LEVEL_ERROR);     // Level 3 - VISIBLE ✓
+
+// Change log level to show debug messages too
+setLogLevel(LOG_LEVEL_DEBUG); // Now level 0
+log('Debug information', LOG_LEVEL_DEBUG); // Level 0 - VISIBLE ✓
+
+// Log levels (lower number = more verbose):
+// debug (0), info (1), warn (2), error (3), emergency (4), silent (10)
+```
+
 #### Data convertor
 
 Contains methods to apply metadata for MI datasets
@@ -58,7 +95,7 @@ import {
   buildMetadataTransformer,
   applyMetadata,
   transformDataset,
-} from '@metricinsights/cs-helper/dist/utils';
+} from '@metricinsights/cs-helper/utils';
 
 async function main() {
   const dataset = await new Promise((resolve, reject) => {
@@ -85,3 +122,61 @@ async function main() {
 
 main();
 ```
+
+## Build Output
+
+The built script includes a banner with metadata:
+
+- **Script source hash**: SHA-256 hash (first 16 hex chars) of the main file and all imported files (relative imports only). This helps verify the source code hasn't changed.
+- **Checksum**: SHA-256 hash (first 16 hex chars) of the built output file. To verify the built file hasn't been modified, replace the checksum value with `0000000000000000` in the banner, then hash the file; the result should match the stored checksum.
+- **Params Base64**: Base64-encoded JSON containing structured parameter metadata extracted from all `parseParams` calls in your code. This includes parameter names, types, default values, required flags, available values (for enum-like parameters), and descriptions. The encoded data can be decoded to access parameter information programmatically.
+
+All metadata is included automatically in the banner when building your custom script.
+
+### Banner Example
+
+Here's an example of what the banner looks like in the built script:
+
+```
+***** DO NOT EDIT! THIS CODE IS GENERATED BY THE PACKAGE @metricinsights/cs-helper (https://github.com/mi-examples/cs-helper) *****
+
+Please, go to code sources and add your changes!
+
+Code sources:
+  Package name: my-custom-script
+  Package version: 1.0.0
+  Package repository: https://github.com/user/my-custom-script
+  Build command: npm run build
+  Built at: 2026-02-02T12:00:00.000Z
+  Script source hash: a1b2c3d4e5f6g7h8
+  Checksum: 1a2b3c4d5e6f7g8h
+
+  ***** ----- * PARAMS BASE64 * ----- *****
+  eyJpc1BhcmFtZXRlcnNSZXF1aXJlZCI6ZmFsc2UsInBhcmFtZXRlcnMiOlt7Im5hbWUiOiJkZWZhdWx0VmFsdWUiLCJ0eXBlIjoibnVtYmVyIiwicmVxdWlyZWQiOmZhbHNlfV19
+  ***** ----- * END PARAMS BASE64 * ----- *****
+
+***** ----- ----- ----- ----- ----- ----- *****
+***** PARAMETERS DESCRIPTION *****
+
+parseParams call #1 (src/index.ts:43):
+
+## Params
+
+| Name        | Type   | Required | Default |
+|:------------|:------:|:--------:|:-------:|
+| defaultValue | number |          |    1    |
+
+### Params description
+
+- **defaultValue**: Example: `1`.
+
+***** ------------------------- *****
+
+***** README.md *****
+
+# My Custom Script
+
+This is my custom script description...
+
+***** --------- *****
+```

package/dist/bin/build.d.ts

@@ -1,5 +1,8 @@
 #!/usr/bin/env node
 declare const path: any;
-declare const rmSync: any, readFileSync: any, readdirSync: any;
+declare const nodeCrypto: any;
+declare const rmSync: any, readFileSync: any, readdirSync: any, existsSync: any, writeFileSync: any;
+declare const paramsDocs: any;
+declare const paramsBase64: any;
 type Webpack = typeof import('webpack');
 type Configuration = Parameters<Webpack>[0][number];

package/dist/bin/build.js

@@ -1,7 +1,10 @@
 #!/usr/bin/env node
 "use strict";
 const path = require('path');
-const { rmSync, readFileSync, readdirSync } = require('fs');
+const nodeCrypto = require('crypto');
+const { rmSync, readFileSync, readdirSync, existsSync, writeFileSync } = require('fs');
+const paramsDocs = require('./params-docs');
+const paramsBase64 = require('./params-base64');
 (async function () {
     const { default: webpack } = (await import('webpack'));
     const { default: chalk } = await import('chalk');
@@ -18,6 +21,20 @@ const { rmSync, readFileSync, readdirSync } = require('fs');
         }
     }
     const V7 = process.argv.includes('--v7');
+    const readmeFile = process.argv.find((arg) => arg.startsWith('--readme=') || arg.startsWith('--readme '));
+    let readmeContent = '';
+    if (readmeFile) {
+        const readmePath = readmeFile.split('=')[1] || readmeFile.split(' ')[1];
+        if (existsSync(readmePath)) {
+            readmeContent = readFileSync(readmePath, {
+                encoding: 'utf-8',
+                flag: 'r',
+            });
+        }
+        else {
+            throw new Error(chalk.red(`Readme file not found: ${readmePath}`));
+        }
+    }
     const helperPackage = require(path.resolve(__dirname, '..', '..', 'package.json'));
     const packageFile = require(path.resolve(process.cwd(), 'package.json'));
     const packageDir = readdirSync(process.cwd(), {
@@ -36,18 +53,30 @@ const { rmSync, readFileSync, readdirSync } = require('fs');
         : {
             targets: 'ie 11',
         };
+    const paramsDescription = paramsDocs.analyzeParseParams(filename);
+    const paramsData = paramsDocs.analyzeParseParamsData(filename);
+    const paramsBase64String = paramsBase64.generateParamsBase64(paramsData);
+    const sourceFiles = paramsDocs.getSourceFilesFromEntry(filename);
+    const hasher = nodeCrypto.createHash('sha256');
+    for (const file of sourceFiles.sort()) {
+        hasher.update(readFileSync(file, { encoding: 'utf-8', flag: 'r' }));
+    }
+    const hash = hasher.digest('hex').slice(0, 16);
     const compiler = webpack({
         mode: 'production',
         plugins: [
             new webpack.BannerPlugin({
                 banner: function () {
                     const { repository, name, version } = packageFile;
-                    let readme;
-                    if (packageDir.length) {
+                    let readme = readmeContent;
+                    if (packageDir.length && !readmeContent) {
                         const regExp = /^readme\.md$/i;
                         for (const object of packageDir) {
                             if (regExp.test(object)) {
-                                readme = readFileSync(object, { encoding: 'utf-8', flag: 'r' });
+                                readme = readFileSync(object, {
+                                    encoding: 'utf-8',
+                                    flag: 'r',
+                                });
                                 break;
                             }
                         }
@@ -60,7 +89,8 @@ const { rmSync, readFileSync, readdirSync } = require('fs');
                         helperRepository = helperPackage.repository;
                     }
                     else if (typeof helperPackage.repository === 'object') {
-                        helperRepository = helperPackage.repository.url?.slice(helperPackage.repository.url?.indexOf('http'));
+                        helperRepository =
+                            helperPackage.repository.url?.slice(helperPackage.repository.url?.indexOf('http')) ?? '';
                     }
                     return `***** DO NOT EDIT! THIS CODE IS GENERATED BY THE PACKAGE ${helperPackage.name} (${helperRepository}) *****
 
@@ -72,9 +102,15 @@ Code sources:
   Package repository: ${repository ? repository : 'Not defined'}
   Build command: npm run ${process.env.npm_lifecycle_event}
   Built at: ${new Date().toISOString()}
+  Script source hash: ${hash}
+  Checksum: 0000000000000000
   ${V7 ? 'Compatibility: v7 ONLY\n' : ''}
-***** ----- ----- ----- ----- ----- ----- *****
-${readme ? `\n***** README.md *****\n\n${readme}\n***** --------- *****` : ''}`;
+
+  ***** ----- * PARAMS BASE64 * ----- *****
+  ${paramsBase64String}
+  ***** ----- * END PARAMS BASE64 * ----- *****
+
+***** ----- ----- ----- ----- ----- ----- *****${paramsDescription}${readme ? `\n\n***** README.md *****\n\n${readme}\n***** --------- *****` : ''}`;
                 },
             }),
             new webpack.NormalModuleReplacementPlugin(/-TARGET_EXTENSION$/, function (resource) {
@@ -125,6 +161,8 @@ ${readme ? `\n***** README.md *****\n\n${readme}\n***** --------- *****` : ''}`;
             extensions: ['.tsx', '.ts', '.js', '.mjs', '.cjs'],
         },
     });
+    const outputBasename = `${path.parse(filename).name}.js`;
+    const BUILD_HASH_PLACEHOLDER = '0000000000000000';
     await new Promise((resolve) => {
         compiler.run((err, stats) => resolve({ err, stats }));
     }).then(({ err, stats }) => {
@@ -139,6 +177,14 @@ ${readme ? `\n***** README.md *****\n\n${readme}\n***** --------- *****` : ''}`;
         }
         else {
             console.log(stats?.toString({ colors: true }));
+            const outputPath = path.join(DIST_DIR, outputBasename);
+            const content = readFileSync(outputPath, { encoding: 'utf-8' });
+            const buildHasher = nodeCrypto.createHash('sha256');
+            buildHasher.update(content);
+            const buildHash = buildHasher.digest('hex').slice(0, 16);
+            const contentWithHash = content.replace(`Checksum: ${BUILD_HASH_PLACEHOLDER}`, `Checksum: ${buildHash}`);
+            console.log(chalk.green(`Checksum: ${buildHash}`));
+            writeFileSync(outputPath, contentWithHash);
             console.log(chalk.green('Done'));
         }
     });

package/dist/bin/build.js.map

@@ -1 +1 @@
-{"version":3,"file":"build.js","sourceRoot":"","sources":["../../bin/build.ts"],"names":[],"mappings":";;AAEA,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;AAC7B,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;AAM5D,CAAC,KAAK;IAEJ,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,CAAC,MAAM,MAAM,CAAC,SAAS,CAAC,CAEpD,CAAC;IAEF,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,CAAC;IAEjD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE;QACpB,MAAM,IAAI,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,kCAAkC,CAAC,CAAC,CAAC;KAChE;IAED,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,MAAM,CAAC,CAAC;IAErD,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAEpD,IAAI,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE;QACpC,IAAI;YACF,MAAM,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;SACpD;QAAC,MAAM;SAEP;KACF;IAED,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAEzC,MAAM,aAAa,GAAG,OAAO,CAC3B,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,cAAc,CAAC,CACpD,CAAC;IAEF,MAAM,WAAW,GAEb,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,cAAc,CAAC,CAAC,CAAC;IACzD,MAAM,UAAU,GAAG,WAAW,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE;QAC5C,QAAQ,EAAE,OAAO;QACjB,IAAI,EAAE,GAAG;KACV,CAAC,CAAC;IAEH,MAAM,SAAS,GAAG,EAAE;QAClB,CAAC,CAAC;YACE,WAAW,EAAE,OAAO;YACpB,MAAM,EAAE,KAAK;YACb,OAAO,EAAE;gBACP,MAAM,EAAE,EAAE;aACX;YACD,OAAO,EAAE,KAAK;SACf;QACH,CAAC,CAAC;YACE,OAAO,EAAE,OAAO;SACjB,CAAC;IAEN,MAAM,QAAQ,GAAG,OAAO,CAAC;QACvB,IAAI,EAAE,YAAY;QAClB,OAAO,EAAE;YACP,IAAI,OAAO,CAAC,YAAY,CAAC;gBACvB,MAAM,EAAE;oBACN,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,WAAW,CAAC;oBAElD,IAAI,MAAe,CAAC;oBAEpB,IAAI,UAAU,CAAC,MAAM,EAAE;wBACrB,MAAM,MAAM,GAAG,eAAe,CAAC;wBAE/B,KAAK,MAAM,MAAM,IAAI,UAAU,EAAE;4BAC/B,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE;gCACvB,MAAM,GAAG,YAAY,CAAC,MAAM,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC;gCAEhE,MAAM;6BACP;yBACF;qBACF;oBAED,IAAI,CAAC,UAAU,EAAE;wBACf,OAAO,CAAC,IAAI,CACV,KAAK,CAAC,MAAM,CACV,2DAA2D,CAC5D,CACF,CAAC;qBACH;oBAED,IAAI,gBAAgB,GAAG,EAAE,CAAC;oBAE1B,IAAI,OAAO,aAAa,CAAC,UAAU,KAAK,QAAQ,EAAE;wBAChD,gBAAgB,GAAG,aAAa,CAAC,UAAU,CAAC;qBAC7C;yBAAM,IAAI,OAAO,aAAa,CAAC,UAAU,KAAK,QAAQ,EAAE;wBACvD,gBAAgB,GAAG,aAAa,CAAC,UAAU,CAAC,GAAG,EAAE,KAAK,CACpD,aAAa,CAAC,UAAU,CAAC,GAAG,EAAE,OAAO,CAAC,MAAM,CAAC,CAC9C,CAAC;qBACH;oBAED,OAAO,4DACL,aAAa,CAAC,IAChB,KAAK,gBAAgB;;;;;kBAKb,IAAI;qBACD,OAAO;wBACJ,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,aAAa;2BACpC,OAAO,CAAC,GAAG,CAAC,mBAAmB;cAC5C,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;IAClC,EAAE,CAAC,CAAC,CAAC,0BAA0B,CAAC,CAAC,CAAC,EAAE;;EAEtC,MAAM,CAAC,CAAC,CAAC,8BAA8B,MAAM,yBAAyB,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;gBACxE,CAAC;aACF,CAAC;YACF,IAAI,OAAO,CAAC,6BAA6B,CAAC,oBAAoB,EAAE,UAC9D,QAAQ;gBAER,QAAQ,CAAC,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAC,OAAO,CACzC,mBAAmB,EACnB,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,CACvB,CAAC;gBAEF,IAAI,QAAQ,CAAC,UAAU,EAAE;oBACvB,QAAQ,CAAC,UAAU,CAAC,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAC;iBAChD;YACH,CAAC,CAAC;SACH;QACD,YAAY,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE;QACjC,MAAM,EAAE,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC;QACvC,KAAK,EAAE,QAAQ;QACf,MAAM,EAAE;YACN,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,IAAI,KAAK;SAC5C;QACD,KAAK,EAAE,iBAAiB;QACxB,MAAM,EAAE;YACN,KAAK,EAAE;gBACL;oBACE,IAAI,EAAE,SAAS;oBACf,OAAO,EAAE,cAAc;oBACvB,GAAG,EAAE;wBACH,MAAM,EAAE,cAAc;wBACtB,OAAO,EAAE;4BACP,OAAO,EAAE;gCACP,CAAC,mBAAmB,EAAE,SAAS,CAAC;gCAChC,0BAA0B;6BAC3B;yBACF;qBACF;iBACF;gBACD;oBACE,IAAI,EAAE,YAAY;oBAClB,OAAO,EAAE;wBACP,GAAG,EAAE,CAAC,cAAc,CAAC;qBACtB;oBACD,GAAG,EAAE;wBACH,MAAM,EAAE,cAAc;wBACtB,OAAO,EAAE;4BACP,OAAO,EAAE,CAAC,CAAC,mBAAmB,EAAE,SAAS,CAAC,CAAC;yBAC5C;qBACF;iBACF;aACF;SACF;QACD,OAAO,EAAE;YACP,UAAU,EAAE,CAAC,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC;SACnD;KACsB,CAAC,CAAC;IAE3B,MAAM,IAAI,OAAO,CAGd,CAAC,OAAO,EAAE,EAAE;QACb,QAAQ,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;IACxD,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE,EAAE;QACzB,IAAI,GAAG,IAAI,KAAK,EAAE,SAAS,EAAE,EAAE;YAC7B,IAAI,GAAG,EAAE;gBACP,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;aACpB;iBAAM;gBACL,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;aAChD;YAED,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAC,CAAC;SACpD;aAAM;YACL,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;YAC/C,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;SAClC;IACH,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,EAAE,CAAC"}
+{"version":3,"file":"build.js","sourceRoot":"","sources":["../../bin/build.ts"],"names":[],"mappings":";;AAEA,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;AAC7B,MAAM,UAAU,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;AACrC,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,WAAW,EAAE,UAAU,EAAE,aAAa,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;AACvF,MAAM,UAAU,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;AAC5C,MAAM,YAAY,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;AAMhD,CAAC,KAAK;IAEJ,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,CAAC,MAAM,MAAM,CAAC,SAAS,CAAC,CAEpD,CAAC;IAEF,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,CAAC;IAEjD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE;QACpB,MAAM,IAAI,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,kCAAkC,CAAC,CAAC,CAAC;KAChE;IAED,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,MAAM,CAAC,CAAC;IACrD,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAEpD,IAAI,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE;QACpC,IAAI;YACF,MAAM,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;SACpD;QAAC,MAAM;SAEP;KACF;IAED,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAUzC,MAAM,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAClC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,UAAU,CAAC,WAAW,CAAC,IAAI,GAAG,CAAC,UAAU,CAAC,WAAW,CAAC,CACpE,CAAC;IACF,IAAI,aAAa,GAAG,EAAE,CAAC;IAEvB,IAAI,UAAU,EAAE;QACd,MAAM,UAAU,GAAG,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QAExE,IAAI,UAAU,CAAC,UAAU,CAAC,EAAE;YAC1B,aAAa,GAAG,YAAY,CAAC,UAAU,EAAE;gBACvC,QAAQ,EAAE,OAAO;gBACjB,IAAI,EAAE,GAAG;aACV,CAAC,CAAC;SACJ;aAAM;YACL,MAAM,IAAI,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,0BAA0B,UAAU,EAAE,CAAC,CAAC,CAAC;SACpE;KACF;IAED,MAAM,aAAa,GAAG,OAAO,CAC3B,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,cAAc,CAAC,CACpD,CAAC;IAEF,MAAM,WAAW,GAEb,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,cAAc,CAAC,CAAC,CAAC;IACzD,MAAM,UAAU,GAAG,WAAW,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE;QAC5C,QAAQ,EAAE,OAAO;QACjB,IAAI,EAAE,GAAG;KACV,CAAC,CAAC;IAEH,MAAM,SAAS,GAAG,EAAE;QAClB,CAAC,CAAC;YACE,WAAW,EAAE,OAAO;YACpB,MAAM,EAAE,KAAK;YACb,OAAO,EAAE;gBACP,MAAM,EAAE,EAAE;aACX;YACD,OAAO,EAAE,KAAK;SACf;QACH,CAAC,CAAC;YACE,OAAO,EAAE,OAAO;SACjB,CAAC;IAGN,MAAM,iBAAiB,GAAG,UAAU,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IAClE,MAAM,UAAU,GAAG,UAAU,CAAC,sBAAsB,CAAC,QAAQ,CAAC,CAAC;IAE/D,MAAM,kBAAkB,GAAG,YAAY,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;IAGzE,MAAM,WAAW,GAAG,UAAU,CAAC,uBAAuB,CAAC,QAAQ,CAAC,CAAC;IACjE,MAAM,MAAM,GAAG,UAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IAE/C,KAAK,MAAM,IAAI,IAAI,WAAW,CAAC,IAAI,EAAE,EAAE;QACrC,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;KACrE;IAED,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IAE/C,MAAM,QAAQ,GAAG,OAAO,CAAC;QACvB,IAAI,EAAE,YAAY;QAClB,OAAO,EAAE;YACP,IAAI,OAAO,CAAC,YAAY,CAAC;gBACvB,MAAM,EAAE;oBACN,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,WAAW,CAAC;oBAClD,IAAI,MAAM,GAAW,aAAa,CAAC;oBAEnC,IAAI,UAAU,CAAC,MAAM,IAAI,CAAC,aAAa,EAAE;wBACvC,MAAM,MAAM,GAAG,eAAe,CAAC;wBAE/B,KAAK,MAAM,MAAM,IAAI,UAAU,EAAE;4BAC/B,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE;gCACvB,MAAM,GAAG,YAAY,CAAC,MAAM,EAAE;oCAC5B,QAAQ,EAAE,OAAO;oCACjB,IAAI,EAAE,GAAG;iCACV,CAAC,CAAC;gCAEH,MAAM;6BACP;yBACF;qBACF;oBAED,IAAI,CAAC,UAAU,EAAE;wBACf,OAAO,CAAC,IAAI,CACV,KAAK,CAAC,MAAM,CACV,2DAA2D,CAC5D,CACF,CAAC;qBACH;oBAED,IAAI,gBAAgB,GAAG,EAAE,CAAC;oBAE1B,IAAI,OAAO,aAAa,CAAC,UAAU,KAAK,QAAQ,EAAE;wBAChD,gBAAgB,GAAG,aAAa,CAAC,UAAU,CAAC;qBAC7C;yBAAM,IAAI,OAAO,aAAa,CAAC,UAAU,KAAK,QAAQ,EAAE;wBACvD,gBAAgB;4BACd,aAAa,CAAC,UAAU,CAAC,GAAG,EAAE,KAAK,CACjC,aAAa,CAAC,UAAU,CAAC,GAAG,EAAE,OAAO,CAAC,MAAM,CAAC,CAC9C,IAAI,EAAE,CAAC;qBACX;oBAED,OAAO,4DACL,aAAa,CAAC,IAChB,KAAK,gBAAgB;;;;;kBAKb,IAAI;qBACD,OAAO;wBACJ,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,aAAa;2BACpC,OAAO,CAAC,GAAG,CAAC,mBAAmB;cAC5C,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;wBACd,IAAI;;IAExB,EAAE,CAAC,CAAC,CAAC,0BAA0B,CAAC,CAAC,CAAC,EAAE;;;IAGpC,kBAAkB;;;iDAG2B,iBAAiB,GAAG,MAAM,CAAC,CAAC,CAAC,gCAAgC,MAAM,yBAAyB,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;gBAC7I,CAAC;aACF,CAAC;YACF,IAAI,OAAO,CAAC,6BAA6B,CAAC,oBAAoB,EAAE,UAC9D,QAAQ;gBAER,QAAQ,CAAC,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAC,OAAO,CACzC,mBAAmB,EACnB,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,CACvB,CAAC;gBAEF,IAAI,QAAQ,CAAC,UAAU,EAAE;oBACvB,QAAQ,CAAC,UAAU,CAAC,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAC;iBAChD;YACH,CAAC,CAAC;SACH;QACD,YAAY,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE;QACjC,MAAM,EAAE,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC;QACvC,KAAK,EAAE,QAAQ;QACf,MAAM,EAAE;YACN,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,IAAI,KAAK;SAC5C;QACD,KAAK,EAAE,iBAAiB;QACxB,MAAM,EAAE;YACN,KAAK,EAAE;gBACL;oBACE,IAAI,EAAE,SAAS;oBACf,OAAO,EAAE,cAAc;oBACvB,GAAG,EAAE;wBACH,MAAM,EAAE,cAAc;wBACtB,OAAO,EAAE;4BACP,OAAO,EAAE;gCACP,CAAC,mBAAmB,EAAE,SAAS,CAAC;gCAChC,0BAA0B;6BAC3B;yBACF;qBACF;iBACF;gBACD;oBACE,IAAI,EAAE,YAAY;oBAClB,OAAO,EAAE;wBACP,GAAG,EAAE,CAAC,cAAc,CAAC;qBACtB;oBACD,GAAG,EAAE;wBACH,MAAM,EAAE,cAAc;wBACtB,OAAO,EAAE;4BACP,OAAO,EAAE,CAAC,CAAC,mBAAmB,EAAE,SAAS,CAAC,CAAC;yBAC5C;qBACF;iBACF;aACF;SACF;QACD,OAAO,EAAE;YACP,UAAU,EAAE,CAAC,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC;SACnD;KACsB,CAAC,CAAC;IAE3B,MAAM,cAAc,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,IAAI,KAAK,CAAC;IAIzD,MAAM,sBAAsB,GAAG,kBAAkB,CAAC;IAElD,MAAM,IAAI,OAAO,CAGd,CAAC,OAAO,EAAE,EAAE;QACb,QAAQ,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;IACxD,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE,EAAE;QACzB,IAAI,GAAG,IAAI,KAAK,EAAE,SAAS,EAAE,EAAE;YAC7B,IAAI,GAAG,EAAE;gBACP,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;aACpB;iBAAM;gBACL,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;aAChD;YAED,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAC,CAAC;SACpD;aAAM;YACL,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;YAE/C,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;YACvD,MAAM,OAAO,GAAG,YAAY,CAAC,UAAU,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC;YAChE,MAAM,WAAW,GAAG,UAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;YAEpD,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YAE5B,MAAM,SAAS,GAAG,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YACzD,MAAM,eAAe,GAAG,OAAO,CAAC,OAAO,CACrC,aAAa,sBAAsB,EAAE,EACrC,aAAa,SAAS,EAAE,CACzB,CAAC;YAEF,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,aAAa,SAAS,EAAE,CAAC,CAAC,CAAC;YACnD,aAAa,CAAC,UAAU,EAAE,eAAe,CAAC,CAAC;YAE3C,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;SAClC;IACH,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,EAAE,CAAC"}

package/dist/bin/params-base64.d.ts

@@ -0,0 +1,23 @@
+type ParamType = 'string' | 'number' | 'boolean' | 'password' | 'unknown';
+interface ParamHash {
+    name: string;
+    default_value?: string;
+    available_values?: string[];
+    type: string;
+    required: boolean;
+    description?: string;
+}
+interface ParamsHashData {
+    hostname?: string;
+    customScriptId?: number;
+    customScriptName?: string;
+    isParametersRequired: boolean;
+    parameters: ParamHash[];
+}
+declare function removeQuotes(value: string): string;
+declare function mapParamRowToHash(row: ParamRow, defaultParams: Record<string, any>): ParamHash;
+declare function generateParamsBase64(parseParamsCalls: ParseParamsCallInfo[], options?: {
+    hostname?: string;
+    customScriptId?: number;
+    customScriptName?: string;
+}): string;

package/dist/bin/params-base64.js

@@ -0,0 +1,60 @@
+"use strict";
+function removeQuotes(value) {
+    const str = String(value).trim();
+    if ((str.startsWith('"') && str.endsWith('"')) ||
+        (str.startsWith("'") && str.endsWith("'"))) {
+        return str.slice(1, -1);
+    }
+    return str;
+}
+function mapParamRowToHash(row, defaultParams) {
+    const paramHash = {
+        name: row.name,
+        type: row.typeStr,
+        required: !row.optional,
+    };
+    if (row.name in defaultParams) {
+        paramHash.default_value = removeQuotes(defaultParams[row.name]);
+    }
+    if (row.acceptsValues && row.acceptsValues.length > 0) {
+        paramHash.available_values = row.acceptsValues;
+    }
+    if (row.description) {
+        paramHash.description = row.description;
+    }
+    return paramHash;
+}
+function generateParamsBase64(parseParamsCalls, options) {
+    const hashData = {
+        isParametersRequired: false,
+        parameters: [],
+    };
+    if (options?.hostname) {
+        hashData.hostname = options.hostname;
+    }
+    if (options?.customScriptId !== undefined) {
+        hashData.customScriptId = options.customScriptId;
+    }
+    if (options?.customScriptName) {
+        hashData.customScriptName = options.customScriptName;
+    }
+    const allParams = new Map();
+    for (const call of parseParamsCalls) {
+        if (call.typeInfoTable && call.typeInfoTable.length > 0) {
+            for (const row of call.typeInfoTable) {
+                if (/^\[.+\:\s*.+\]$/.test(row.name)) {
+                    continue;
+                }
+                const paramHash = mapParamRowToHash(row, call.defaultParams);
+                allParams.set(row.name, paramHash);
+                if (!row.optional) {
+                    hashData.isParametersRequired = true;
+                }
+            }
+        }
+    }
+    hashData.parameters = Array.from(allParams.values());
+    return Buffer.from(JSON.stringify(hashData)).toString('base64');
+}
+module.exports = { generateParamsBase64 };
+//# sourceMappingURL=params-base64.js.map

package/dist/bin/params-base64.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"params-base64.js","sourceRoot":"","sources":["../../bin/params-base64.ts"],"names":[],"mappings":";AAuBA,SAAS,YAAY,CAAC,KAAa;IACjC,MAAM,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,CAAC;IACjC,IACE,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QAC1C,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,EAC1C;QACA,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;KACzB;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAKD,SAAS,iBAAiB,CACxB,GAAa,EACb,aAAkC;IAElC,MAAM,SAAS,GAAc;QAC3B,IAAI,EAAE,GAAG,CAAC,IAAI;QACd,IAAI,EAAE,GAAG,CAAC,OAAO;QACjB,QAAQ,EAAE,CAAC,GAAG,CAAC,QAAQ;KACxB,CAAC;IAGF,IAAI,GAAG,CAAC,IAAI,IAAI,aAAa,EAAE;QAC7B,SAAS,CAAC,aAAa,GAAG,YAAY,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;KACjE;IAGD,IAAI,GAAG,CAAC,aAAa,IAAI,GAAG,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE;QACrD,SAAS,CAAC,gBAAgB,GAAG,GAAG,CAAC,aAAa,CAAC;KAChD;IAGD,IAAI,GAAG,CAAC,WAAW,EAAE;QACnB,SAAS,CAAC,WAAW,GAAG,GAAG,CAAC,WAAW,CAAC;KACzC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAKD,SAAS,oBAAoB,CAC3B,gBAAuC,EACvC,OAIC;IAED,MAAM,QAAQ,GAAmB;QAC/B,oBAAoB,EAAE,KAAK;QAC3B,UAAU,EAAE,EAAE;KACf,CAAC;IAGF,IAAI,OAAO,EAAE,QAAQ,EAAE;QACrB,QAAQ,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;KACtC;IAED,IAAI,OAAO,EAAE,cAAc,KAAK,SAAS,EAAE;QACzC,QAAQ,CAAC,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;KAClD;IAED,IAAI,OAAO,EAAE,gBAAgB,EAAE;QAC7B,QAAQ,CAAC,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAC;KACtD;IAID,MAAM,SAAS,GAAG,IAAI,GAAG,EAAqB,CAAC;IAE/C,KAAK,MAAM,IAAI,IAAI,gBAAgB,EAAE;QACnC,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE;YAEvD,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,aAAa,EAAE;gBAGpC,IAAI,iBAAiB,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;oBACpC,SAAS;iBACV;gBAGD,MAAM,SAAS,GAAG,iBAAiB,CAAC,GAAG,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;gBAE7D,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;gBAGnC,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE;oBACjB,QAAQ,CAAC,oBAAoB,GAAG,IAAI,CAAC;iBACtC;aACF;SACF;KACF;IAED,QAAQ,CAAC,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC;IAErD,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;AAClE,CAAC;AAED,MAAM,CAAC,OAAO,GAAG,EAAE,oBAAoB,EAAE,CAAC"}

package/dist/bin/params-docs.d.ts

@@ -0,0 +1,44 @@
+declare const pathLib: any;
+declare const fs: any;
+type ParamRow = {
+    name: string;
+    typeStr: string;
+    optional: boolean;
+    description: string;
+    example?: string;
+    acceptsValues?: string[];
+};
+type ParseParamsCallInfo = {
+    filePath: string;
+    typeInfo: string;
+    typeInfoTable?: ParamRow[];
+    defaultParams: Record<string, any>;
+    line: number;
+};
+declare function getSourceFilesFromEntry(entryFile: string): string[];
+type JSDocParamInfo = {
+    description: string;
+    example: string;
+    password?: boolean;
+};
+declare function parseJSDocInner(inner: string): JSDocParamInfo;
+declare function getJSDocFromLeadingTrivia(text: string, fullStart: number, start: number): string;
+declare function getJSDocParamInfo(ts: any, decl: any): JSDocParamInfo;
+declare function getGenericTypeDisplay(checker: any, type: any, seen?: Set<number>): string;
+declare function getAcceptableValues(checker: any, type: any, seen?: Set<number>): string[];
+declare function expandTypeToParamRows(ts: any, checker: any, typeNode: any, sourceCode: string): ParamRow[] | null;
+declare function isNumericValue(s: string): boolean;
+declare function resolveDefaultValue(ts: any, checker: any, initializer: any, sourceCode: string, depth?: number): string;
+declare function formatParamsTable(rows: ParamRow[], defaultParams: Record<string, any>): string;
+declare function analyzeParseParamsInFile(sourceFile: string, options?: {
+    checker?: any;
+    program?: any;
+    ts?: any;
+}): ParseParamsCallInfo[];
+declare const parseParamsCache: Map<string, ParseParamsCallInfo[]>;
+declare function getParseParamsFromCode(entryFile: string): ParseParamsCallInfo[];
+declare function formatParseParamsForDocs(calls: ParseParamsCallInfo[], projectRoot?: string): string;
+declare function analyzeParseParams(entryFile: string): string;
+declare function analyzeParseParamsData(entryFile: string): ParseParamsCallInfo[];
+declare function clearParseParamsCache(): void;
+declare function clearParseParamsCacheEntry(entryFile: string): void;