@intuned/runtime-dev 1.2.0-cli.1 → 1.2.0-cli.11

package/dist/commands/intuned-cli/commands/helpers.js

@@ -1,134 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.CLIError = exports.CLIAssertionError = void 0;
-exports.assertApiFileExists = assertApiFileExists;
-exports.assertAuthConsistent = assertAuthConsistent;
-exports.assertAuthEnabled = assertAuthEnabled;
-exports.logInvalidInput = logInvalidInput;
-exports.parseUrlProxy = parseUrlProxy;
-exports.withCLIContext = withCLIContext;
-exports.withErrorLogging = withErrorLogging;
-exports.withTimeout = withTimeout;
-var _utils = require("../../cli-auth-sessions/utils");
-var _nanoid = require("nanoid");
-var _asyncLocalStorage = require("../../../common/asyncLocalStorage");
-var _enums = require("../../../runtime/enums");
-var _terminal = require("../terminal");
-var _path = _interopRequireDefault(require("path"));
-var _fsExtra = require("fs-extra");
-var _runApi = require("../../../common/runApi");
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-class CLIError extends Error {
-  constructor(message, options) {
-    super(message);
-    this.name = "CLIError";
-    this.autoColor = options?.autoColor ?? true;
-  }
-}
-exports.CLIError = CLIError;
-class CLIAssertionError extends CLIError {
-  constructor(message, options) {
-    super(message, options);
-    this.name = "CLIAssertionError";
-  }
-}
-exports.CLIAssertionError = CLIAssertionError;
-function logInvalidInput(result) {
-  (0, _terminal.terminal)("^r^+Invalid input parameters:^: ^R" + result.error.errors.map(({
-    message
-  }) => `^R${message}^:`).join(", ") + "\n");
-}
-async function assertAuthEnabled() {
-  if (!(await (0, _utils.isAuthEnabled)())) {
-    throw new CLIAssertionError("Auth session is not enabled, enable it in Intuned.json to use it");
-  }
-}
-async function assertAuthConsistent(authSession) {
-  const _isAuthEnabled = await (0, _utils.isAuthEnabled)();
-  if (_isAuthEnabled && !authSession) {
-    throw new CLIAssertionError("Auth session is enabled, but no auth session is provided. Please provide an auth session ID.");
-  }
-  if (!_isAuthEnabled && authSession) {
-    throw new CLIAssertionError("Auth session is not enabled, enable it in Intuned.json to use it");
-  }
-}
-function withErrorLogging(fn) {
-  return async (...args) => {
-    try {
-      await fn(...args);
-      process.exit(0);
-    } catch (error) {
-      if (error instanceof CLIError) {
-        if (error.autoColor) {
-          (0, _terminal.terminal)(`^r^+${error.message}^:\n`);
-        } else {
-          (0, _terminal.terminal)(`${error.message}\n`);
-        }
-      } else if (error instanceof _runApi.AutomationError) {
-        (0, _terminal.terminal)(`^r^+An error occurred while running the API:^:\n`);
-        (0, _terminal.terminal)(`^r${error.error.message}^:\n`);
-        if (error.error.stack) {
-          (0, _terminal.terminal)(`^r^+Stack trace:^:\n`);
-          (0, _terminal.terminal)(`^r${error.error.stack}^:\n`);
-        }
-      } else {
-        (0, _terminal.terminal)(`^r^+An error occurred:^: ^R${error.message}^:\n^r^+Please report this issue to the Intuned team.^:\n`);
-      }
-      process.exit(1);
-    }
-  };
-}
-function parseUrlProxy(proxyUrl) {
-  try {
-    const url = new URL(proxyUrl);
-    const username = url.username;
-    const password = url.password;
-    const proxy = url.hostname;
-    const port = url.port ? `:${url.port}` : "";
-    const domain = `${url.protocol}//${proxy}${port}`;
-    return {
-      password,
-      username,
-      server: domain
-    };
-  } catch (error) {
-    return;
-  }
-}
-function withTimeout(fn, timeout) {
-  let reject;
-  const timeoutPromise = new Promise((_, _reject) => {
-    reject = _reject;
-  });
-  const timeoutId = setTimeout(() => {
-    reject(new CLIError("Timed out"));
-  }, timeout);
-  const fnWithWrapper = async (...args) => {
-    return Promise.race([fn(...args), timeoutPromise]);
-  };
-  (0, _asyncLocalStorage.getExecutionContext)().timeoutInfo.extendTimeoutCallback = async () => {
-    timeoutId.refresh();
-  };
-  return fnWithWrapper;
-}
-function withCLIContext(fn) {
-  const runId = (0, _nanoid.nanoid)();
-  return async (...args) => (0, _asyncLocalStorage.runWithContext)({
-    runEnvironment: _enums.RunEnvironment.IDE,
-    runId,
-    extendedPayloads: [],
-    timeoutInfo: {}
-  }, fn, ...args);
-}
-async function assertApiFileExists(dirname, api) {
-  const file = `${dirname}/${api}.ts`;
-  const filePath = _path.default.join(process.cwd(), file);
-  if (!(await (0, _fsExtra.exists)(filePath))) {
-    throw new CLIAssertionError(`^+^r API^ ^+${dirname}/${api}^ ^r^+is not implemented.^:`, {
-      autoColor: false
-    });
-  }
-}

package/dist/commands/intuned-cli/terminal.d.ts

@@ -1 +0,0 @@
-export declare const terminal: import("terminal-kit/Terminal");

package/dist/commands/run-api-cli/run-api.d.ts

@@ -1,2 +0,0 @@
-#!/usr/bin/env node
-export {};

package/dist/commands/run-api-cli/run-api.js

@@ -1,57 +0,0 @@
-#!/usr/bin/env node
-"use strict";
-
-var _commander = require("commander");
-var _chalk = _interopRequireDefault(require("chalk"));
-var _nanoid = require("nanoid");
-var _dotenv = _interopRequireDefault(require("dotenv"));
-var _utils = require("./utils");
-var _enums = require("../../runtime/enums");
-var _asyncLocalStorage = require("../../common/asyncLocalStorage");
-var _utils2 = require("../cli-auth-sessions/utils");
-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("-i, --parameters-file <file>", "JSON file containing API parameters").option("-a, --auth-session <session>", "Name of the auth session instance to use").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 _isAuthEnabled = await (0, _utils2.isAuthEnabled)();
-    if (!_isAuthEnabled && options.authSession) {
-      throw new Error("Auth session is not enabled, enable it in Intuned.json to be able to use it");
-    }
-    if (_isAuthEnabled && !options.authSession) {
-      throw new Error("Auth session is enabled but no auth session provided, please provide it");
-    }
-    const inputData = await (0, _utils.loadParameters)(options.parametersFile);
-    const runId = (0, _nanoid.nanoid)();
-    const {
-      result,
-      payloadToAppend
-    } = await (0, _asyncLocalStorage.runWithContext)({
-      runEnvironment: _enums.RunEnvironment.IDE,
-      extendedPayloads: [],
-      runId
-    }, () => (0, _utils.runApiViaCLI)(apiName, inputData, {
-      authSession: options.authSession
-    }));
-    if (!result) {
-      console.log(_chalk.default.yellow("No result returned from the API"));
-      return;
-    }
-    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)(runId, result, payloadToAppend);
-  } catch (error) {
-    console.error(_chalk.default.red(`\nError: ${error.message}`));
-  } finally {
-    process.exit(0);
-  }
-});
-_commander.program.parse(process.argv);

package/dist/commands/run-api-cli/utils.d.ts

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

package/dist/commands/run-api-cli/utils.js

@@ -1,144 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.loadParameters = loadParameters;
-exports.runApiViaCLI = runApiViaCLI;
-exports.writeResultToFile = writeResultToFile;
-var _path = _interopRequireDefault(require("path"));
-var fs = _interopRequireWildcard(require("fs-extra"));
-var _Logger = require("../../common/Logger");
-var _chalk = _interopRequireDefault(require("chalk"));
-var _runApi = require("../../common/runApi");
-var _tsNodeImport = require("../common/tsNodeImport");
-var _utils = require("../cli-auth-sessions/utils");
-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; }
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-async function loadParameters(parametersFile) {
-  if (!parametersFile) {
-    return {};
-  }
-  try {
-    const filePath = _path.default.join(process.cwd(), parametersFile);
-    await fs.access(filePath);
-    let inputData = null;
-    if (parametersFile) {
-      inputData = await fs.readJSON(filePath);
-    } else {
-      inputData = {};
-    }
-    return inputData;
-  } catch (error) {
-    if (error.code === "ENOENT") {
-      throw new Error(`Parameters file not found: ${parametersFile}`);
-    } else if (error instanceof SyntaxError) {
-      throw new Error(`Invalid JSON in parameters file: ${error.message}`);
-    }
-    throw new Error(`Error reading parameters file: ${error.message}`);
-  }
-}
-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(resultsPath, result, {
-      spaces: 2
-    });
-    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) {
-  let authSessionPathToUse = null;
-  if (options?.authSession) {
-    const {
-      authSessionInstanceStoragePath
-    } = await (0, _utils.retrieveAuthSessionInstance)(options?.authSession, true);
-    authSessionPathToUse = authSessionInstanceStoragePath;
-  }
-  if (authSessionPathToUse) {
-    const checkApiExists = await (0, _utils.ensureAuthApi)("check");
-    if (!checkApiExists) {
-      throw new Error("Auth session check API not implemented, please create it in the auth sessions specified directory");
-    }
-    const checkResult = await (0, _utils.runCheckApiViaCLI)(authSessionPathToUse);
-    if (!checkResult) {
-      console.log(_chalk.default.yellow("Auth session check failed, trying to refresh it..."));
-      const createApiExists = await (0, _utils.ensureAuthApi)("create");
-      if (!createApiExists) {
-        throw new Error("Auth session creation API not implemented, please create it in the auth sessions specified directory");
-      }
-      const {
-        metadata
-      } = await (0, _utils.retrieveAuthSessionInstance)(options?.authSession);
-      if (metadata?.authSessionType === "MANUAL") {
-        throw new Error("Expired Auth session is recorder-based, please provide a new one or refresh it manually");
-      }
-      const authSessionInput = metadata?.authSessionInput ?? {};
-      try {
-        const refresehAuthSessionInstance = await (0, _utils.runCreateApiViaCLI)(authSessionInput);
-        if (!refresehAuthSessionInstance) {
-          throw new Error("Failed to refresh auth session");
-        }
-        await (0, _utils.storeAuthSessionInstance)(refresehAuthSessionInstance, options?.authSession, authSessionInput);
-        const checkResult = await (0, _utils.runCheckApiViaCLI)(authSessionPathToUse);
-        if (!checkResult) {
-          throw new Error("Failed to refresh auth session");
-        }
-        console.log(_chalk.default.green("✓ Auth session refreshed successfully on this run"));
-      } catch (error) {
-        throw new Error(`Failed to refresh auth session: ${error.message}`);
-      }
-    }
-  }
-  const runApiResult = await (0, _runApi.runApi)({
-    automationFunction: {
-      name: `api/${apiName}`,
-      params: inputData
-    },
-    runOptions: {
-      headless: false,
-      environment: "standalone"
-    },
-    auth: authSessionPathToUse ? {
-      session: {
-        type: "file",
-        path: authSessionPathToUse
-      },
-      runCheck: false
-    } : undefined,
-    importFunction: _tsNodeImport.tsNodeImport
-  });
-  if (runApiResult.isErr()) {
-    if (runApiResult.error instanceof _runApi.AutomationError) {
-      throw runApiResult.error.error;
-    }
-    console.error(runApiResult.error);
-    throw new Error("An error occurred while running the API");
-  }
-  const {
-    result,
-    extendedPayloads: payloadToAppend
-  } = runApiResult.value;
-  const hasPayloadToAppend = payloadToAppend && payloadToAppend.length > 0;
-  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,
-    payloadToAppend
-  };
-}

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

@@ -1 +0,0 @@
-export declare const cliReadme = "# Intuned CLI\n## Introduction\nThe Intuned CLI exposes a variety of commands to develop your Intuned projects locally\n\n## Development Commands\n\nFor each command, add `--help` to see more details and options.\n\n### Initialize a Project\n`npx -p @intuned/runtime init`\n\n### Run an API\n`yarn intuned run <api-name>`\nor\n`npm run intuned run <api-name>`\n\n\n### Build a Project\n`yarn intuned build`\n\n### Deploy a Project\n`yarn intuned deploy [project-name]`\nor\n`npm run intuned deploy [project-name]`\n\n\n\n### Create an auth session\n`yarn intuned authsession create <parameters>`\nor\n`npm intuned authsession create <parameters>`\n\n\n\n### Validate an auth session\n`yarn intuned authsession validate <auth-session-name>`\nor\n`npm intuned authsession validate <auth-session-name>`\n\n## Configuration\n\n### Environment Variables and Settings\n- `workspaceId`: Your Intuned workspace ID ([How to get your workspaceId](https://docs.intunedhq.com/docs/guides/platform/how-to-get-a-workspace-id))\n  - Set in `intuned.json` file under the `workspaceId` property\n  - Or provide via CLI with `--workspace-id` flag during deployment\n  \n- `projectName`: The name of your Intuned project\n  - Set in `intuned.json` file under the `projectName` property\n  - Or override via command line when deploying with `yarn deploy my-project-name` or `npm run deploy my-project-name`\n  \n- `INTUNED_API_KEY`: Your Intuned API key\n  - Set as an environment variable: `export INTUNED_API_KEY=your_api_key_here`\n  - Or include in your .env file for development\n  - Or provide via CLI with `--api-key` flag during deployment\n\n## Project Structure\n\n### Generated Artifacts\n- `./intuned.json`: Project configuration file\n- `./api`: Folder containing API implementation files\n- `./auth-sessions`: Folder containing auth APIs\n- `./parameters`: Folder for API parameters injection\n- `./output`: Folder containing generated output files\n- `./auth-sessions-instances`: Folder containing auth session instances\n\n## Types of auth sessions\n- `MANUAL`: Manual auth session, records the session using a recorder and stores it in the `auth-sessions-instances` folder\n- `API`: Auth session created via create API, stores the session in the `auth-sessions-instances` folder\n\n### Notes\n- You can use either `yarn` or `npm run` to execute commands\n- All commands must be run from the project root directory\n- Verify you're in the correct location by confirming the presence of package.json and intuned.json\n- Running commands from subdirectories may result in errors\n- You can manage your deployed projects through the Intuned platform\n- WARNING: \u26A0\uFE0F Changes to TS Config may break some Intuned functionalities\n";