@intuned/runtime 1.2.0 → 1.3.1

package/dist/runtime/index.d.ts

@@ -1,8 +1,7 @@
 export { extendPayload } from "./extendPayload";
 export { extendTimeout } from "./extendTimeout";
+export { attemptStore } from "./attemptStore";
 export { getAuthSessionParameters } from "./getAuthSessionParameters";
 export { runInfo } from "./runInfo";
 export { RunError } from "./RunError";
-export { requestMultipleChoice, requestOTP } from "./requestMoreInfo";
-export type { RequestMoreInfoDetails } from "./requestMoreInfo";
 export { getDownloadDirectoryPath } from "./downloadDirectory";

package/dist/runtime/index.js

@@ -9,6 +9,12 @@ Object.defineProperty(exports, "RunError", {
     return _RunError.RunError;
   }
 });
+Object.defineProperty(exports, "attemptStore", {
+  enumerable: true,
+  get: function () {
+    return _attemptStore.attemptStore;
+  }
+});
 Object.defineProperty(exports, "extendPayload", {
   enumerable: true,
   get: function () {
@@ -33,18 +39,6 @@ Object.defineProperty(exports, "getDownloadDirectoryPath", {
     return _downloadDirectory.getDownloadDirectoryPath;
   }
 });
-Object.defineProperty(exports, "requestMultipleChoice", {
-  enumerable: true,
-  get: function () {
-    return _requestMoreInfo.requestMultipleChoice;
-  }
-});
-Object.defineProperty(exports, "requestOTP", {
-  enumerable: true,
-  get: function () {
-    return _requestMoreInfo.requestOTP;
-  }
-});
 Object.defineProperty(exports, "runInfo", {
   enumerable: true,
   get: function () {
@@ -53,8 +47,8 @@ Object.defineProperty(exports, "runInfo", {
 });
 var _extendPayload = require("./extendPayload");
 var _extendTimeout = require("./extendTimeout");
+var _attemptStore = require("./attemptStore");
 var _getAuthSessionParameters = require("./getAuthSessionParameters");
 var _runInfo = require("./runInfo");
 var _RunError = require("./RunError");
-var _requestMoreInfo = require("./requestMoreInfo");
 var _downloadDirectory = require("./downloadDirectory");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@intuned/runtime",
-  "version": "1.2.0",
+  "version": "1.3.1",
   "description": "Intuned runtime",
   "exports": {
     ".": "./dist/index.js",
@@ -79,6 +79,7 @@
     "nanoid": "3",
     "neverthrow": "6.1.0",
     "playwright-extra": "4.3.6",
+    "portfinder": "^1.0.37",
     "prettier": "2.8.0",
     "promptly": "3.2.0",
     "rollup": "3.26.2",
@@ -118,7 +119,7 @@
     "eslint-plugin-deprecation": "^1.3.3",
     "eslint-plugin-prettier": "^4.2.1",
     "msw": "^2.1.2",
-    "playwright": "1.44.1",
+    "playwright": "^1.55.0",
     "typedoc": "^0.25.13",
     "typedoc-plugin-frontmatter": "^1.0.0",
     "typedoc-plugin-markdown": "^4.0.2",

package/.npmrc.d

@@ -1 +0,0 @@
-//registry.npmjs.org/:_authToken=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

package/dist/commands/intuned-cli/constants/readme.d.ts

@@ -1 +0,0 @@
-export declare const readme = "# Intuned CLI\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 intuned init`\n\n### Run an API\n`yarn intuned run api <api-name> <parameters>`\nor\n`npm run intuned run api <api-name> <parameters>`\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 run authsession create <parameters>`\nor\n`npm run intuned run authsession create <parameters>`\n\n\n\n### Validate an auth session\n`yarn intuned run authsession validate <auth-session-name>`\nor\n`npm run intuned run 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 intuned deploy my-project-name` or `npm run intuned 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-session APIs if you use them\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- \u26A0\uFE0F WARNING: Changes to TS Config may break some Intuned functionalities\n\n## `Intuned.json` Reference\n```jsonc\n{\n  // Your Intuned workspace ID. \n  // Optional - If not provided here, it must be supplied via the `--workspace-id` flag during deployment.\n  \"workspaceId\": \"your_workspace_id\",\n\n  // The name of your Intuned project. \n  // Optional - If not provided here, it must be supplied via the command line when deploying.\n  \"projectName\": \"your_project_name\",\n\n  // Replication settings\n  \"replication\": {\n    // The maximum number of concurrent executions allowed via Intuned API. This does not affect jobs.\n    // A number of machines equal to this will be allocated to handle API requests.\n    // Not applicable if api access is disabled.\n    \"maxConcurrentRequests\": 1,\n\n    // The machine size to use for this project. This is applicable for both API requests and jobs.\n    // \"standard\": Standard machine size (6 shared vCPUs, 2GB RAM)\n    // \"large\": Large machine size (8 shared vCPUs, 4GB RAM)\n    // \"xlarge\": Extra large machine size (1 performance vCPU, 8GB RAM)\n    \"size\": \"standard\"\n  }\n\n  // Auth session settings\n  \"authSessions\": {\n    // Whether auth sessions are enabled for this project.\n    // If enabled, \"auth-sessions/check.ts\" API must be implemented to validate the auth session.\n    \"enabled\": true,\n\n    // Whether to save Playwright traces for auth session runs.\n    \"saveTraces\": false,\n\n    // The type of auth session to use.\n    // \"API\" type requires implementing \"auth-sessions/create.ts\" API to create/recreate the auth session programmatically.\n    // \"MANUAL\" type uses a recorder to manually create the auth session.\n    \"type\": \"API\",\n    \n\n    // Recorder start URL for the recorder to navigate to when creating the auth session.\n    // Required if \"type\" is \"MANUAL\". Not used if \"type\" is \"API\".\n    \"startUrl\": \"https://example.com/login\",\n\n    // Recorder finish URL for the recorder. Once this URL is reached, the recorder stops and saves the auth session.\n    // Required if \"type\" is \"MANUAL\". Not used if \"type\" is \"API\".\n    \"finishUrl\": \"https://example.com/dashboard\",\n\n    // Recorder browser mode\n    // \"fullscreen\": Launches the browser in fullscreen mode.\n    // \"kiosk\": Launches the browser in kiosk mode (no address bar, no navigation controls).\n    // Only applicable for \"MANUAL\" type.\n    \"browserMode\": \"fullscreen\"\n  }\n  \n  // API access settings\n  \"apiAccess\": {\n    // Whether to enable consumption through Intuned API. If this is false, the project can only be consumed through jobs.\n    // This is required for projects that use auth sessions.\n    \"enabled\": true\n  },\n\n  // Whether to run the deployed API in a headful browser. Running in headful can help with some anti-bot detections. However, it requires more resources and may work slower or crash if the machine size is \"standard\".\n  \"headful\": false,\n\n  // The region where your Intuned project is hosted.\n  // For a list of available regions, contact support or refer to the documentation.\n  // Optional - Default: \"us\"\n  \"region\": \"us\"\n}\n```\n";

package/dist/commands/intuned-cli/constants/readme.js

@@ -1,150 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.readme = void 0;
-const readme = exports.readme = `# Intuned CLI
-## Development Commands
-
-For each command, add \`--help\` to see more details and options.
-
-### Initialize a Project
-\`npx -p @intuned/runtime intuned init\`
-
-### Run an API
-\`yarn intuned run api <api-name> <parameters>\`
-or
-\`npm run intuned run api <api-name> <parameters>\`
-
-
-### Build a Project
-\`yarn intuned build\`
-
-### Deploy a Project
-\`yarn intuned deploy [project-name]\`
-or
-\`npm run intuned deploy [project-name]\`
-
-
-
-### Create an auth session
-\`yarn intuned run authsession create <parameters>\`
-or
-\`npm run intuned run authsession create <parameters>\`
-
-
-
-### Validate an auth session
-\`yarn intuned run authsession validate <auth-session-name>\`
-or
-\`npm run intuned run authsession validate <auth-session-name>\`
-
-## Configuration
-
-### Environment Variables and Settings
-- \`workspaceId\`: Your Intuned workspace ID ([How to get your workspaceId](https://docs.intunedhq.com/docs/guides/platform/how-to-get-a-workspace-id))
-  - Set in \`intuned.json\` file under the \`workspaceId\` property
-  - Or provide via CLI with \`--workspace-id\` flag during deployment
-  
-- \`projectName\`: The name of your Intuned project
-  - Set in \`intuned.json\` file under the \`projectName\` property
-  - Or override via command line when deploying with \`yarn intuned deploy my-project-name\` or \`npm run intuned deploy my-project-name\`
-
-- \`INTUNED_API_KEY\`: Your Intuned API key
-  - Set as an environment variable: \`export INTUNED_API_KEY=your_api_key_here\`
-  - Or include in your .env file for development
-  - Or provide via CLI with \`--api-key\` flag during deployment
-
-## Project Structure
-
-### Generated Artifacts
-- \`./intuned.json\`: Project configuration file
-- \`./api\`: Folder containing API implementation files
-- \`./auth-sessions\`: Folder containing auth-session APIs if you use them
-- \`./auth-sessions-instances\`: Folder containing auth session instances
-
-## Types of auth sessions
-- \`MANUAL\`: Manual auth session, records the session using a recorder and stores it in the \`auth-sessions-instances\` folder
-- \`API\`: Auth session created via create API, stores the session in the \`auth-sessions-instances\` folder
-
-### Notes
-- You can use either \`yarn\` or \`npm run\` to execute commands
-- All commands must be run from the project root directory
-- Verify you're in the correct location by confirming the presence of package.json and intuned.json
-- Running commands from subdirectories may result in errors
-- You can manage your deployed projects through the Intuned platform
-- ⚠️ WARNING: Changes to TS Config may break some Intuned functionalities
-
-## \`Intuned.json\` Reference
-\`\`\`jsonc
-{
-  // Your Intuned workspace ID. 
-  // Optional - If not provided here, it must be supplied via the \`--workspace-id\` flag during deployment.
-  "workspaceId": "your_workspace_id",
-
-  // The name of your Intuned project. 
-  // Optional - If not provided here, it must be supplied via the command line when deploying.
-  "projectName": "your_project_name",
-
-  // Replication settings
-  "replication": {
-    // The maximum number of concurrent executions allowed via Intuned API. This does not affect jobs.
-    // A number of machines equal to this will be allocated to handle API requests.
-    // Not applicable if api access is disabled.
-    "maxConcurrentRequests": 1,
-
-    // The machine size to use for this project. This is applicable for both API requests and jobs.
-    // "standard": Standard machine size (6 shared vCPUs, 2GB RAM)
-    // "large": Large machine size (8 shared vCPUs, 4GB RAM)
-    // "xlarge": Extra large machine size (1 performance vCPU, 8GB RAM)
-    "size": "standard"
-  }
-
-  // Auth session settings
-  "authSessions": {
-    // Whether auth sessions are enabled for this project.
-    // If enabled, "auth-sessions/check.ts" API must be implemented to validate the auth session.
-    "enabled": true,
-
-    // Whether to save Playwright traces for auth session runs.
-    "saveTraces": false,
-
-    // The type of auth session to use.
-    // "API" type requires implementing "auth-sessions/create.ts" API to create/recreate the auth session programmatically.
-    // "MANUAL" type uses a recorder to manually create the auth session.
-    "type": "API",
-    
-
-    // Recorder start URL for the recorder to navigate to when creating the auth session.
-    // Required if "type" is "MANUAL". Not used if "type" is "API".
-    "startUrl": "https://example.com/login",
-
-    // Recorder finish URL for the recorder. Once this URL is reached, the recorder stops and saves the auth session.
-    // Required if "type" is "MANUAL". Not used if "type" is "API".
-    "finishUrl": "https://example.com/dashboard",
-
-    // Recorder browser mode
-    // "fullscreen": Launches the browser in fullscreen mode.
-    // "kiosk": Launches the browser in kiosk mode (no address bar, no navigation controls).
-    // Only applicable for "MANUAL" type.
-    "browserMode": "fullscreen"
-  }
-  
-  // API access settings
-  "apiAccess": {
-    // Whether to enable consumption through Intuned API. If this is false, the project can only be consumed through jobs.
-    // This is required for projects that use auth sessions.
-    "enabled": true
-  },
-
-  // Whether to run the deployed API in a headful browser. Running in headful can help with some anti-bot detections. However, it requires more resources and may work slower or crash if the machine size is "standard".
-  "headful": false,
-
-  // The region where your Intuned project is hosted.
-  // For a list of available regions, contact support or refer to the documentation.
-  // Optional - Default: "us"
-  "region": "us"
-}
-\`\`\`
-`;

package/dist/commands/intuned-cli/controller/init.d.ts

@@ -1,5 +0,0 @@
-import { FileSystemTree, TemplateId } from "../types";
-export declare function mountFiles(cwd: string, tree: FileSystemTree): Promise<void>;
-export declare function checkEmptyDirectory(): Promise<boolean>;
-export declare function selectTemplate(templateName: string): Promise<TemplateId>;
-export declare function scaffoldProject(templateId: string, isTargetDirectoryEmpty: boolean): Promise<void>;

package/dist/commands/intuned-cli/controller/init.js

@@ -1,136 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.checkEmptyDirectory = checkEmptyDirectory;
-exports.mountFiles = mountFiles;
-exports.scaffoldProject = scaffoldProject;
-exports.selectTemplate = selectTemplate;
-var fs = _interopRequireWildcard(require("fs-extra"));
-var _types = require("../types");
-var _path = _interopRequireDefault(require("path"));
-var _projectExclusions = _interopRequireDefault(require("../../common/projectExclusions"));
-var _constants = require("../constants");
-var _helpers = require("../helpers");
-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; }
-function isDirectoryNode(node) {
-  return node.directory !== undefined;
-}
-function isFileNode(node) {
-  return node.file !== undefined;
-}
-async function mountFiles(cwd, tree) {
-  for (const name in tree) {
-    const fullPath = _path.default.join(cwd, name);
-    const node = tree[name];
-    if (isDirectoryNode(node)) {
-      await fs.ensureDir(fullPath);
-      await mountFiles(fullPath, node.directory);
-    } else if (isFileNode(node)) {
-      await fs.writeFile(fullPath, node.file.contents);
-    }
-  }
-}
-async function checkEmptyDirectory() {
-  const currentDir = process.cwd();
-  try {
-    const stats = await fs.stat(currentDir);
-    if (!stats.isDirectory()) {
-      throw new _helpers.CLIError("The current path is not a directory.");
-    }
-    const files = await fs.readdir(currentDir);
-    const significantFiles = files.filter(file => !_projectExclusions.default.includes(file));
-    return significantFiles.length === 0;
-  } catch (error) {
-    if (error.code === "ENOENT") {
-      throw new _helpers.CLIError("The specified directory does not exist.");
-    }
-    throw error;
-  }
-}
-async function selectTemplate(templateName) {
-  if (templateName) {
-    if (!_types.templateIds.includes(templateName)) {
-      throw new _helpers.CLIError(`Template "${templateName}" not found.`);
-    }
-    return templateName;
-  }
-  (0, _helpers.terminal)("^+Select a template (ESC to cancel):^:\n");
-  const {
-    promise: selectedCommandPromise
-  } = _helpers.terminal.singleColumnMenu(_types.templateIds, {
-    cancelable: true
-  });
-  const selectedTemplateIndex = (await selectedCommandPromise).selectedIndex;
-  if (selectedTemplateIndex === undefined) {
-    throw new _helpers.CLIError("^y^+Project initialization cancelled.^:\n", {
-      autoColor: false
-    });
-  }
-  return _types.templateIds[selectedTemplateIndex];
-}
-async function scaffoldProject(templateId, isTargetDirectoryEmpty) {
-  if (!isTargetDirectoryEmpty) {
-    (0, _helpers.terminal)("^+The current directory is not empty. Do you want to proceed and override files?^: (y/N)");
-    const {
-      promise
-    } = _helpers.terminal.yesOrNo({
-      no: ["n", "ENTER", "ESCAPE"],
-      yes: ["y"],
-      echoNo: " no\n",
-      echoYes: " yes\n"
-    });
-    const confirm = await promise;
-    if (!confirm) {
-      throw new _helpers.CLIError("^y^+Project initialization cancelled^:\n", {
-        autoColor: false
-      });
-    }
-  }
-  const cwd = process.cwd();
-  (0, _helpers.terminal)(`^c🚀 Initializing ^:^+${templateId}^:^c project...\n`);
-  const template = await fetchProjectTemplate(templateId);
-  (0, _helpers.terminal)(`^c🔨 Creating project files...^:\n`);
-  const codeTree = template;
-  await prepareCLITemplate(codeTree);
-  await mountFiles(cwd, codeTree);
-  (0, _helpers.terminal)(`^g^+🎉 Project initialized successfully!^ ^GRun ^:^+yarn^:^G to install dependencies and start coding!\n`);
-}
-async function fetchProjectTemplate(templateId) {
-  const baseUrl = (0, _helpers.getBaseUrl)();
-  const url = `${baseUrl}/api/templates/${templateId}`;
-  const response = await fetch(url);
-  if (!response.ok) {
-    throw new _helpers.CLIError(`^r^+Error fetching template:\n^:^R${response.statusText} ${response.status}\n^r^+Failed to initialize project^:\n`, {
-      autoColor: false
-    });
-  }
-  const data = await response.json();
-  if (!data) {
-    throw new _helpers.CLIError("Error fetching template: Template not found");
-  }
-  return data.template;
-}
-async function prepareCLITemplate(codeTree) {
-  codeTree["parameters"] = {
-    directory: {}
-  };
-  codeTree["tsconfig.json"] = {
-    file: {
-      contents: JSON.stringify(_constants.tsConfigCli, null, 2)
-    }
-  };
-  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: _constants.readme
-    }
-  };
-}

package/dist/common/getPlaywrightConstructs.d.ts

@@ -1,30 +0,0 @@
-import * as playwright from "playwright";
-import type { RunApiSession } from "./runApi";
-interface Proxy {
-    server: string;
-    username: string;
-    password: string;
-}
-interface GetPlaywrightConstructsOptions {
-    proxy?: Proxy;
-    headless?: boolean;
-    storageState?: RunApiSession;
-    downloadsPath: string;
-}
-export declare function getProductionPlaywrightConstructs({ proxy, headless, storageState, downloadsPath, }: GetPlaywrightConstructsOptions): Promise<{
-    page: playwright.Page;
-    context: playwright.BrowserContext;
-}>;
-export declare function getPlaywrightConstructsForMode(mode: "vanilla" | "playwright" | "playwright-standalone" | "playwright-headless", cdpAddress: string | undefined, authSession?: RunApiSession): Promise<{
-    page: playwright.Page;
-    context: playwright.BrowserContext;
-}>;
-export declare function loadSessionToContext({ context, session, }: {
-    context: playwright.BrowserContext;
-    session: RunApiSession;
-}): Promise<void>;
-export declare function getRemotePlaywrightContext(cdpAddress: string): Promise<{
-    browser: playwright.Browser;
-    context: playwright.BrowserContext;
-}>;
-export {};

package/dist/runtime/requestMoreInfo.d.ts

@@ -1,18 +0,0 @@
-interface RequestMoreInfoReturnTypeBase {
-    [REQUEST_MORE_INFO_KEY]: true;
-    action: "request_more_info";
-}
-interface RequestMultipleChoiceReturnType extends RequestMoreInfoReturnTypeBase {
-    messageToUser: string;
-    choices: string[];
-    requestType: "multiple_choice";
-}
-interface RequestOtpReturnType extends RequestMoreInfoReturnTypeBase {
-    messageToUser: string;
-    requestType: "otp";
-}
-declare const REQUEST_MORE_INFO_KEY: unique symbol;
-export declare function requestOTP(messageToUser: string): RequestOtpReturnType;
-export declare function requestMultipleChoice(messageToUser: string, choices: string[]): RequestMultipleChoiceReturnType;
-export type RequestMoreInfoDetails = RequestMultipleChoiceReturnType | RequestOtpReturnType;
-export {};

package/dist/runtime/requestMoreInfo.js

@@ -1,25 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.requestMultipleChoice = requestMultipleChoice;
-exports.requestOTP = requestOTP;
-const REQUEST_MORE_INFO_KEY = Symbol("REQUEST_MORE_INFO");
-function requestOTP(messageToUser) {
-  return {
-    [REQUEST_MORE_INFO_KEY]: true,
-    action: "request_more_info",
-    messageToUser,
-    requestType: "otp"
-  };
-}
-function requestMultipleChoice(messageToUser, choices) {
-  return {
-    [REQUEST_MORE_INFO_KEY]: true,
-    action: "request_more_info",
-    messageToUser,
-    requestType: "multiple_choice",
-    choices
-  };
-}