@intuned/runtime-dev 1.0.6-cli.8.2.1 → 1.0.6-cli.8.2.3

package/dist/commands/init/utils.js

@@ -15,6 +15,7 @@ var _inquirer = _interopRequireDefault(require("inquirer"));
 var _path = _interopRequireDefault(require("path"));
 var _boxen = _interopRequireDefault(require("boxen"));
 var _projectExclusions = _interopRequireDefault(require("../common/projectExclusions"));
+var _constants = require("../../common/cli/constants");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
 function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
@@ -158,9 +159,37 @@ function prepareCLITemplate(codeTree) {
   codeTree["parameters"] = {
     directory: {}
   };
+  if (_isFileNode(codeTree["package.json"]) && codeTree["package.json"].file) {
+    const packageJson = JSON.parse(codeTree["package.json"].file.contents);
+    packageJson.scripts = _constants.userCLIScripts;
+    codeTree["package.json"].file.contents = JSON.stringify(packageJson, null, 2);
+  }
   codeTree["README.md"] = {
     file: {
-      contents: `# Intuned CLI Project`
+      contents: `# Intuned CLI Project
+
+## Usage Instructions
+
+This CLI project is built with Intuned and provides the following commands:
+
+### Running the project
+\`\`\`
+npm run intuned-run
+\`\`\`
+
+### Building the project
+\`\`\`
+npm run intuned-build
+\`\`\`
+
+### Deploying the project
+\`\`\`
+npm run intuned-deploy
+\`\`\`
+
+### Storage
+Results from your runs will be stored in the \`./output/[runId]\` directory structure.
+`
     }
   };
 }

package/dist/commands/intuned-run/intuned-run.js

@@ -12,31 +12,32 @@ function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e
 _dotenv.default.config({
   path: `.env`
 });
-_commander.program.name("intuned-run").description("Run an Intuned API with parameters").argument("<api-name>", "Name of the API to run").option("-p, --parameters-file <file>", "JSON file containing API parameters").option("-o, --output-file <file>", "File to write the API output to").action(async (apiName, options) => {
+_commander.program.name("intuned-run").description("Run an Intuned API with parameters").argument("<api-name>", "Name of the API to run").option("-i, --parameters-file <file>", "JSON file containing API parameters").option("-s, --store-results", "Store the results of the running API in a dedicated folder").action(async (apiName, options) => {
   try {
     if (!apiName) {
       throw new Error("API name is required, please provide it");
     }
     const inputData = await (0, _utils.loadParameters)(options.parametersFile);
-    const outputFileId = options.outputFile;
-    const result = await (0, _asyncLocalStorage.runWithContext)({
+    const runId = (0, _nanoid.nanoid)();
+    const {
+      result,
+      payloadToAppend
+    } = await (0, _asyncLocalStorage.runWithContext)({
       runEnvironment: _enums.RunEnvironment.IDE,
       extendedPayloads: [],
-      runId: (0, _nanoid.nanoid)()
-    }, () => (0, _utils.runApiViaCLI)(apiName, inputData, {
-      outputFileId
-    }));
+      runId
+    }, () => (0, _utils.runApiViaCLI)(apiName, inputData));
     if (!result) {
       console.log(_chalk.default.yellow("No result returned from the API"));
       return;
     }
-    if (!options.outputFile) {
+    if (!options.storeResults) {
       console.log(_chalk.default.green(`✓ API executed successfully`));
       console.log(_chalk.default.green("Result:"));
       console.log(_chalk.default.white(JSON.stringify(result, null, 2)));
       return;
     }
-    await (0, _utils.writeResultToFile)(outputFileId, result);
+    await (0, _utils.writeResultToFile)(runId, result, payloadToAppend);
   } catch (error) {
     console.error(_chalk.default.red(`\nError: ${error.message}`));
     process.exit(1);

package/dist/commands/intuned-run/utils.d.ts

@@ -1,5 +1,7 @@
+import { Payload } from "../../runtime/export";
 export declare function loadParameters(parametersFile: string): Promise<object | null>;
-export declare function writeResultToFile(outputFileId: string, result: any, runId?: string): Promise<void>;
-export declare function runApiViaCLI(apiName: string, inputData: object | null | undefined, options: {
-    outputFileId?: string;
-}): Promise<any>;
+export declare function writeResultToFile(runId: string, result: any, payloadToAppend?: Payload[]): Promise<void>;
+export declare function runApiViaCLI(apiName: string, inputData: object | null | undefined): Promise<{
+    result: any;
+    payloadToAppend: Payload[] | undefined;
+}>;

package/dist/commands/intuned-run/utils.js

@@ -38,19 +38,28 @@ async function loadParameters(parametersFile) {
     throw new Error(`Error reading parameters file: ${error.message}`);
   }
 }
-async function writeResultToFile(outputFileId, result, runId) {
-  const outputPath = _path.default.join(process.cwd(), `${outputFileId}.json`);
-  await fs.ensureDir(_path.default.dirname(outputPath));
+async function writeResultToFile(runId, result, payloadToAppend) {
+  const outputDir = _path.default.join(process.cwd(), "output", runId);
+  const resultsPath = _path.default.join(outputDir, "results.json");
+  const extendedPayloadsPath = _path.default.join(outputDir, "extendedPayloads.json");
+  await fs.ensureDir(outputDir);
   try {
-    await fs.writeJSON(outputPath, result, {
+    await fs.writeJSON(resultsPath, result, {
       spaces: 2
     });
-    console.log(_chalk.default.green(`✓ API executed successfully. Result written to ${outputPath}`));
+    if (payloadToAppend && payloadToAppend.length > 0) {
+      await fs.writeJSON(extendedPayloadsPath, payloadToAppend, {
+        spaces: 2
+      });
+      _Logger.logger.info(_chalk.default.underline.green.white(`Payloads to append saved into (${extendedPayloadsPath})`));
+    }
+    console.log(_chalk.default.underline.green.white(`✓ API executed successfully. Results stored in ${outputDir}`));
+    console.log(_chalk.default.blue(`Run ID: ${runId}`));
   } catch (error) {
     _Logger.logger.error(`Failed to write result to file: ${error.message}`);
   }
 }
-async function runApiViaCLI(apiName, inputData, options) {
+async function runApiViaCLI(apiName, inputData) {
   const runApiResult = await (0, _runApi.runApi)({
     automationFunction: {
       name: `api/${apiName}`,
@@ -74,17 +83,12 @@ async function runApiViaCLI(apiName, inputData, options) {
     extendedPayloads: payloadToAppend
   } = runApiResult.value;
   const hasPayloadToAppend = payloadToAppend && payloadToAppend.length > 0;
-  if (hasPayloadToAppend && options.outputFileId) {
-    const fileKey = `${options.outputFileId}-payloads-to-append.json`;
-    const outputPath = _path.default.join(process.cwd(), fileKey);
-    await fs.ensureDir(_path.default.dirname(outputPath));
-    await fs.writeJson(outputPath, payloadToAppend, {
-      spaces: 2
-    });
-    _Logger.logger.info(_chalk.default.underline.bgBlue.white(`Payloads to append saved into (${outputPath})`));
-  } else if (hasPayloadToAppend) {
+  if (hasPayloadToAppend) {
     _Logger.logger.info("payload to append:", payloadToAppend);
     _Logger.logger.info("This will only take an effect if this API run was part of a job.");
   }
-  return result;
+  return {
+    result,
+    payloadToAppend
+  };
 }

package/dist/common/cli/constants.d.ts

@@ -1,3 +1,8 @@
 export declare const CURRENT_PLAYWRIGHT_VERSION = "1.44.1";
 export declare const ProjectDeploymentStatus: string[];
 export declare const PROJECT_DEPLOY_TIMEOUT = 600000;
+export declare const userCLIScripts: {
+    "intuned-run": string;
+    "intuned-build": string;
+    "intuned-deploy": string;
+};

package/dist/common/cli/constants.js

@@ -3,7 +3,12 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.ProjectDeploymentStatus = exports.PROJECT_DEPLOY_TIMEOUT = exports.CURRENT_PLAYWRIGHT_VERSION = void 0;
+exports.userCLIScripts = exports.ProjectDeploymentStatus = exports.PROJECT_DEPLOY_TIMEOUT = exports.CURRENT_PLAYWRIGHT_VERSION = void 0;
 const CURRENT_PLAYWRIGHT_VERSION = exports.CURRENT_PLAYWRIGHT_VERSION = "1.44.1";
 const ProjectDeploymentStatus = exports.ProjectDeploymentStatus = ["completed", "failed", "pending", "not_found"];
-const PROJECT_DEPLOY_TIMEOUT = exports.PROJECT_DEPLOY_TIMEOUT = 600000;
+const PROJECT_DEPLOY_TIMEOUT = exports.PROJECT_DEPLOY_TIMEOUT = 600000;
+const userCLIScripts = exports.userCLIScripts = {
+  "intuned-run": "intuned-run",
+  "intuned-build": "intuned-build-project",
+  "intuned-deploy": "intuned-deploy"
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@intuned/runtime-dev",
-  "version": "1.0.6-cli.8.2.1",
+  "version": "1.0.6-cli.8.2.3",
   "description": "Intuned runtime",
   "exports": {
     ".": "./dist/index.js",