@intuned/runtime-dev 0.1.0-test.13 → 0.1.0-test.15

package/dist/runtime/RunError.js

@@ -1,12 +1,12 @@
 export class RunError extends Error {
-    constructor(message, options) {
-        super(message);
-        this.message = message;
-        this.name = "USER_GENERATED_ERROR";
-        this.options = options ?? {
-            retryable: false,
-        };
-        Object.setPrototypeOf(this, RunError.prototype);
-    }
+  constructor(message, options) {
+    super(message);
+    this.message = message;
+    this.name = "USER_GENERATED_ERROR";
+    this.options = options ?? {
+      retryable: false
+    };
+    Object.setPrototypeOf(this, RunError.prototype);
+  }
 }
-new RunError("", {});
+new RunError("", {});

package/dist/runtime/downloadDirectory.js

@@ -1,13 +1,13 @@
 import { getExecutionContext } from "..";
 import { ensureDirSync } from "fs-extra";
 export function getDownloadDirectoryPath() {
-    const context = getExecutionContext();
-    if (!context) {
-        throw new Error("ExecutionContext not found");
-    }
-    const path = `/tmp/downloads/${context.runId}`;
-    ensureDirSync(path, {
-        mode: 0o2775,
-    });
-    return path;
-}
+  const context = getExecutionContext();
+  if (!context) {
+    throw new Error("ExecutionContext not found");
+  }
+  const path = `/tmp/downloads/${context.runId}`;
+  ensureDirSync(path, {
+    mode: 0o2775
+  });
+  return path;
+}

package/dist/runtime/enums.d.ts

@@ -1 +1,11 @@
-export {};
+export declare enum RunEnvironment {
+  IDE = "IDE",
+  DEPLOYED = "DEPLOYED",
+}
+
+export declare enum RunType {
+  SYNC = "SYNC",
+  ASYNC = "ASYNC",
+  JOB = "JOB",
+  QUEUE = "QUEUE",
+}

package/dist/runtime/enums.js

@@ -1,12 +1,12 @@
-export var RunEnvironment;
-(function (RunEnvironment) {
-    RunEnvironment["IDE"] = "IDE";
-    RunEnvironment["DEPLOYED"] = "DEPLOYED";
-})(RunEnvironment || (RunEnvironment = {}));
-export var RunType;
-(function (RunType) {
-    RunType["SYNC"] = "SYNC";
-    RunType["ASYNC"] = "ASYNC";
-    RunType["JOB"] = "JOB";
-    RunType["QUEUE"] = "QUEUE";
-})(RunType || (RunType = {}));
+export let RunEnvironment = function (RunEnvironment) {
+  RunEnvironment["IDE"] = "IDE";
+  RunEnvironment["DEPLOYED"] = "DEPLOYED";
+  return RunEnvironment;
+}({});
+export let RunType = function (RunType) {
+  RunType["SYNC"] = "SYNC";
+  RunType["ASYNC"] = "ASYNC";
+  RunType["JOB"] = "JOB";
+  RunType["QUEUE"] = "QUEUE";
+  return RunType;
+}({});

package/dist/runtime/export.d.ts

@@ -1 +1,202 @@
-export {};
+import { RunEnvironment } from "./enums.js";
+
+/**
+ * ## Description
+ * In the context of a job, extendTimeout will increase the timeout of the currently executing payload.
+ * This is useful when the payload is expected to take a long time. For example, when running pagination code.
+ *
+ * @example
+ * ```typescript Example
+ * import { extendTimeout } from "@intuned/sdk/runtime"
+ *
+ * extendTimeout();
+ * ```
+ *
+ */
+export declare function extendTimeout(): void;
+
+/**
+ * ## Description
+ * In the context of a job or queue execution, extendPayload appends new payloads to the end of the queue of job.
+ * Calling extendPayload will also call extendTimeout.
+ *
+ * @param {Payload | Payload[]} payload - The payload or array of payloads to extend. you can specify the api name and what parameters you want to pass it, the new added apis will use the same proxy and auth-session settings as the api that extended them
+ *
+ * @example
+ * ```typescript Single payload
+ * import { extendPayload } from "@intuned/sdk/runtime"
+ *
+ * // this function will append the exampleApi to the end of the queue or job it's executing in.
+ * extendPayload({ api: 'exampleApi', parameters: { key: 'value' } });
+ * ```
+ *
+ * @example
+ * ```typescript Array of payloads
+ * import { extendPayload } from "@intuned/sdk/runtime"
+ *
+ * const payloadArray: Payload[] = [
+ *   { api: 'exampleApi1', parameters: { key1: 'value1' } },
+ *   { api: 'exampleApi2', parameters: { key2: 'value2' } }
+ * ];
+ *
+ * // this function will append 2 apis to the end of the queue or job it's executing in.
+ * extendPayload(payloadArray);
+ * ```
+ */
+export declare function extendPayload(payload: Payload | Payload[]): void;
+
+/**
+ * @interface Payload
+ * @property {string} api - The API path you want to extend.
+ * @property {Record<string, any>} parameters - A record of key-value pairs representing the parameters to be sent to the API
+ *
+ * @example
+ *
+ * ```typescript payload
+ * import { Payload } from "@intuned/sdk/runtime"
+ *
+ * const payload: Payload = {
+ *   api: 'exampleApi',
+ *   parameters: {
+ *     key1: 'value1',
+ *     key2: 'value2'
+ *   }
+ * };
+ * ```
+ */
+export interface Payload {
+  api: string;
+  parameters: Record<string, any>;
+}
+
+/**
+ * Retrieves information about the current run environment.
+ *
+ * @returns {RunInfo} An object containing details about the run environment and the run ID.
+ *
+ * @example
+ * ```typescript runInfo
+ * import { runInfo } from "@intuned/sdk/runtime"
+ *
+ * const info = runInfo();
+ * console.log(info.runEnvironment); // Outputs the run environment, IDE or DEPLOYED
+ * console.log(info.runId); // Outputs the run ID, if available, in IDE run id will be undefined
+ * ```
+ */
+export declare function runInfo(): RunInfo;
+
+/**
+ * Represents information about the current run.
+ *
+ * @interface RunInfo
+ * @property {RunEnvironment} runEnvironment - the run environment `IDE` or `DEPLOYED`
+ * @property {string} [runId] - Optional. The ID of the current run, in IDE environment, run id will be undefined
+ */
+export interface RunInfo {
+  runEnvironment: RunEnvironment;
+  runId?: string;
+  jobId?: string;
+  jobRunId?: string;
+  queueId?: string;
+  proxy?: string;
+}
+
+/**
+ * @interface RunErrorOptions
+ * @property {boolean} [retryable] - Optional. Indicates whether the error is retryable.
+ * @property {number} [status_code] - Optional. The HTTP status code associated with the error.
+ * @property {string} [error_code] - Optional. A specific error code to identify the type of error.
+ *
+ * @example
+ * ```typescript RunErrorOptions
+ * import { RunErrorOptions } from "@intuned/sdk/runtime"
+ *
+ * const options: RunErrorOptions = {
+ *   retryable: true,
+ *   status_code: 500,
+ *   error_code: 'SERVER_ERROR'
+ * };
+ * ```
+ */
+export interface RunErrorOptions {
+  retryable?: boolean;
+  status_code?: number;
+  error_code?: string;
+}
+
+/**
+ * Represents an error that occurs during a run.
+ *
+ * @class
+ * @extends Error
+ *
+ * @param {string} message - The error message.
+ * @param {RunErrorOptions} [options] - Optional. Additional options for the error.
+ *
+ * @property {RunErrorOptions} options - The options associated with the error.
+ *
+ * @example
+ * ```typescript RunError
+ * import { RunError } from "@intuned/sdk/runtime"
+ *
+ * throw new RunError('An error occurred', {
+ *   retryable: true,
+ *   status_code: 500,
+ *   error_code: 'SERVER_ERROR'
+ * });
+ *
+ * ```
+ */
+export declare class RunError extends Error {
+  constructor(message: string, options?: RunErrorOptions);
+  options: RunErrorOptions;
+}
+
+/**
+ * in the create auth session flow, you might to need a multiple choice answer from the user, requestMultipleChoice prompts the user with the question and possible options and returns their selection.
+ *
+ * **Note:** This function is currently in beta and may be subject to changes.
+ *
+ * @param {string} message - The message to display to the user.
+ * @param {string[]} choices - An array of choices to present to the user.
+ *
+ * @example
+ * ```typescript requestMultipleChoice
+ * // in auth-sessions/create.ts
+ *
+ * import { requestMultipleChoice } from "@intuned/sdk/runtime"
+ *
+ * const message = "What is your favorite color?";
+ * const choices = ["Red", "Blue", "Green", "Yellow"];
+ *
+ * const selectedChoice = yield requestMultipleChoice(message, choices);
+ *
+ * console.log(selectedChoice);
+ * ```
+ */
+export declare function requestMultipleChoice(
+  message: string,
+  choices: string[]
+): unknown;
+
+/**
+ * **Note:** This function is currently in beta and may be subject to changes.
+ *
+ * requestOTP help you to ask the user for an otp in the create auth-session flow.
+ *
+ * @param {string} message - The message to display to the user.
+ *
+ * @example
+ * ```typescript requestOTP
+ * // in auth-sessions/create.ts
+ *
+ * import { requestOTP } from "@intuned/sdk/runtime"
+ *
+ * const message = "please submit and OTP from your authenticator app";
+ *
+ * const otp = yield requestOTP(message);
+ *
+ * console.log(otp);
+ * ```
+ */
+export declare function requestOTP(message: string): unknown;

package/dist/runtime/extendPayload.js

@@ -1,15 +1,15 @@
 import { getExecutionContext } from "../common/asyncLocalStorage";
 import { extendTimeout } from "./extendTimeout.js";
 export function extendPayload(payload) {
-    const context = getExecutionContext();
-    if (!context) {
-        throw new Error("extendPayload failed due to an internal error.");
-    }
-    const items = Array.isArray(payload) ? payload : [payload];
-    if (!context.extendedPayloads) {
-        context.extendedPayloads = [...items];
-        return;
-    }
-    context?.extendedPayloads.push(...items);
-    extendTimeout();
-}
+  const context = getExecutionContext();
+  if (!context) {
+    throw new Error("extendPayload failed due to an internal error.");
+  }
+  const items = Array.isArray(payload) ? payload : [payload];
+  if (!context.extendedPayloads) {
+    context.extendedPayloads = [...items];
+    return;
+  }
+  context === null || context === void 0 || context.extendedPayloads.push(...items);
+  extendTimeout();
+}

package/dist/runtime/extendTimeout.js

@@ -1,23 +1,24 @@
 import { getExecutionContext } from "../common/asyncLocalStorage";
 const _DEBOUNCE_TIME = 60_000;
 export function extendTimeout() {
-    const context = getExecutionContext();
-    if (!context) {
-        throw new Error("extendTimeout failed due to an internal error.");
+  const context = getExecutionContext();
+  if (!context) {
+    throw new Error("extendTimeout failed due to an internal error.");
+  }
+  const {
+    timeoutInfo
+  } = context;
+  if (!timeoutInfo) {
+    return;
+  }
+  if (timeoutInfo.timeoutTimestamp !== undefined && timeoutInfo.timeoutDuration !== undefined) {
+    const newTimeoutStamp = Date.now() + timeoutInfo.timeoutDuration;
+    if (newTimeoutStamp - timeoutInfo.timeoutTimestamp < _DEBOUNCE_TIME) {
+      return;
     }
-    const { timeoutInfo } = context;
-    if (!timeoutInfo) {
-        return;
-    }
-    if (timeoutInfo.timeoutTimestamp !== undefined &&
-        timeoutInfo.timeoutDuration !== undefined) {
-        const newTimeoutStamp = Date.now() + timeoutInfo.timeoutDuration;
-        if (newTimeoutStamp - timeoutInfo.timeoutTimestamp < _DEBOUNCE_TIME) {
-            return;
-        }
-        timeoutInfo.timeoutTimestamp = newTimeoutStamp;
-    }
-    if (timeoutInfo.extendTimeoutCallback !== undefined) {
-        void timeoutInfo.extendTimeoutCallback().catch(() => undefined);
-    }
-}
+    timeoutInfo.timeoutTimestamp = newTimeoutStamp;
+  }
+  if (timeoutInfo.extendTimeoutCallback !== undefined) {
+    void timeoutInfo.extendTimeoutCallback().catch(() => undefined);
+  }
+}

package/dist/runtime/index.js

@@ -3,4 +3,4 @@ export { extendTimeout } from "./extendTimeout.js";
 export { runInfo } from "./runInfo.js";
 export { RunError } from "./RunError.js";
 export { requestMultipleChoice, requestOTP } from "./requestMoreInfo.js";
-export { getDownloadDirectoryPath } from "./downloadDirectory.js";
+export { getDownloadDirectoryPath } from "./downloadDirectory.js";

package/dist/runtime/requestMoreInfo.js

@@ -1,18 +1,18 @@
 const REQUEST_MORE_INFO_KEY = Symbol("REQUEST_MORE_INFO");
 export function requestOTP(messageToUser) {
-    return {
-        [REQUEST_MORE_INFO_KEY]: true,
-        action: "request_more_info",
-        messageToUser,
-        requestType: "otp",
-    };
+  return {
+    [REQUEST_MORE_INFO_KEY]: true,
+    action: "request_more_info",
+    messageToUser,
+    requestType: "otp"
+  };
 }
 export function requestMultipleChoice(messageToUser, choices) {
-    return {
-        [REQUEST_MORE_INFO_KEY]: true,
-        action: "request_more_info",
-        messageToUser,
-        requestType: "multiple_choice",
-        choices,
-    };
-}
+  return {
+    [REQUEST_MORE_INFO_KEY]: true,
+    action: "request_more_info",
+    messageToUser,
+    requestType: "multiple_choice",
+    choices
+  };
+}

package/dist/runtime/runInfo.js

@@ -1,14 +1,15 @@
 import { getExecutionContext } from "../common/asyncLocalStorage";
 import { RunEnvironment } from "./enums.js";
 export function runInfo() {
-    const context = getExecutionContext();
-    if (!context) {
-        return {
-            runEnvironment: RunEnvironment.IDE,
-            // runType: RunType.SYNC,
-        };
-    }
-    //remove extendedPayloads from the user exposed data
-    const { extendedPayloads: _extendedPayloads, ...rest } = context;
-    return rest;
-}
+  const context = getExecutionContext();
+  if (!context) {
+    return {
+      runEnvironment: RunEnvironment.IDE
+    };
+  }
+  const {
+    extendedPayloads: _extendedPayloads,
+    ...rest
+  } = context;
+  return rest;
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@intuned/runtime-dev",
   "type": "module",
-  "version": "0.1.0-test.13",
+  "version": "0.1.0-test.15",
   "description": "Intuned runtime",
   "exports": {
     ".": "./dist/index.js",
@@ -29,7 +29,7 @@
     "intuned-auth-session-refresh": "vite-node ./src/commands/auth/run-refresh.ts",
     "intuned-auth-session-load": "vite-node ./src/commands/auth/load.ts",
     "intuned-ts-check": "yarn prepublishOnly && vite-node ./src/commands/ts-check.ts",
-    "build": "rm -rf dist && tsc -p tsconfig.json  && yarn copy-dts && babel src --out-dir dist --extensions '.ts' --keep-file-extension &&  cp -r ./src/common/assets dist/common/assets",
+    "build": "rm -rf dist && tsc -p tsconfig.json  && yarn copy-dts && babel src --out-dir dist --extensions '.ts' &&  cp -r ./src/common/assets dist/common/assets",
     "test": "vitest run",
     "test:watch": "vitest",
     "e2e": "yarn playwright test --config ./playwright.config.ts",
@@ -92,7 +92,6 @@
     "source-map": "^0.7.4",
     "stack-utils": "^2.0.6",
     "ts-morph": "^21.0.1",
-    "ts-node": "^10.9.1",
     "tslib": "^2.6.0",
     "typescript": "^5.1.6",
     "wait-on": "^7.2.0",

package/dist/commands/api/run.ts

@@ -1,105 +0,0 @@
-#!/usr/bin/env node
-import { program, Argument } from "commander";
-import * as fs from "fs-extra";
-import { getSettings } from "../common/utils/settings";
-import dotenv from "dotenv";
-import { runWithContext } from "../../common/asyncLocalStorage";
-import { RunEnvironment } from "../../runtime/enums";
-import { cleanEnvironmentVariables } from "../../common/cleanEnvironmentVariables";
-import { logger } from "../../common/Logger";
-import { nanoid } from "nanoid";
-import chalk from "chalk";
-import { runApi } from "../../common/runApi";
-import { AutomationError } from "../../common/runApi";
-dotenv.config({
-  path: `.env`
-});
-export async function executeCLI(apiName, mode, inputData, options) {
-  cleanEnvironmentVariables();
-  let authSessionPathToUse = null;
-  const settings = await getSettings();
-  if (settings.authSessions.enabled) {
-    if (!options.authSessionPath) {
-      throw new Error("Auth session is enabled but no auth session provided");
-    }
-    authSessionPathToUse = options.authSessionPath;
-  } else {
-    if (options.authSessionPath) {
-      throw new Error("Auth session is not enabled but auth session provided. To use auth session please enable it in Intuned.json");
-    }
-  }
-  const runApiResult = await runApi({
-    automationFunction: {
-      name: `api/${apiName}`,
-      params: inputData ?? {}
-    },
-    auth: authSessionPathToUse ? {
-      session: {
-        type: "file",
-        path: authSessionPathToUse
-      },
-      runCheck: false
-    } : undefined,
-    runOptions: {
-      environment: "ide",
-      cdpAddress: options.cdpAddress,
-      mode
-    }
-  });
-  if (runApiResult.isErr()) {
-    if (runApiResult.error instanceof AutomationError) {
-      throw runApiResult.error.error;
-    }
-    console.error("An error occurred while running the API", runApiResult.error);
-    return;
-  }
-  const {
-    result,
-    extendedPayloads: payloadToAppend
-  } = runApiResult.value;
-  const isResponseObject = typeof result === "object" && result !== null;
-  const hasMoreThank5Keys = isResponseObject && Object.keys(result).length > 5;
-  const hasNestedObjects = isResponseObject && Object.values(result).some(value => typeof value === "object");
-  const shouldWriteToFile = isResponseObject && (hasMoreThank5Keys || hasNestedObjects);
-  const resultsDir = "/tmp/run-results";
-  if (options.outputFileId && shouldWriteToFile) {
-    logger.info(chalk.underline.bgBlue.white(`Click to Open: Results saved (Run: ${options.outputFileId})`));
-    fs.ensureDirSync(resultsDir);
-    const path = `${resultsDir}/${options.outputFileId}.json`;
-    await fs.writeJson(path, result, {
-      spaces: 2
-    });
-  } else {
-    console.log("result:", result);
-  }
-  const hasPayloadToAppend = payloadToAppend && payloadToAppend.length > 0;
-  if (hasPayloadToAppend && options.outputFileId) {
-    logger.info(chalk.underline.bgBlue.white(`Click to Open: payloads to append (Run: ${options.outputFileId})`));
-    fs.ensureDirSync(resultsDir);
-    const path = `${resultsDir}/${options.outputFileId}-payloads-to-append.json`;
-    await fs.writeJson(path, payloadToAppend, {
-      spaces: 2
-    });
-  } else if (hasPayloadToAppend) {
-    logger.info("payload to append:", payloadToAppend);
-    logger.info("This will only take an effect if this API run was part of a job.");
-  }
-}
-program.description("run the user function in the cli for testing purposes").option("-i, --input [file]", "input json file").option("-j, --json [json]", "input json string").option("--cdpAddress <cdpAddress>", "CDP address", "http://localhost:9222").option("--authSessionPath <authSession>", "auth session to use when executing the api").option("--outputFileId <outputFileId>", "the output file id to save the result in").option("--proxy <proxy>", "proxy to use").argument("[apiName]", "name of the api", "default").allowUnknownOption().addArgument(new Argument("<mode>", "mode of execution").choices(["vanilla", "playwright", "playwright-standalone", "playwright-headless"]).default("playwright-standalone").argOptional()).action(async (apiName, mode, options) => {
-  let inputData = null;
-  if (options.input) {
-    inputData = await fs.readJSON(options.input);
-  } else if (options.json) {
-    inputData = JSON.parse(options.json);
-  } else {
-    inputData = {};
-  }
-  await runWithContext({
-    runEnvironment: RunEnvironment.IDE,
-    extendedPayloads: [],
-    runId: nanoid(),
-    proxy: options.proxy
-  }, () => executeCLI(apiName, mode, inputData, options));
-  process.exit(0);
-});
-program.parse(process.argv);

package/dist/commands/auth-sessions/load.ts

@@ -1,30 +0,0 @@
-#!/usr/bin/env node
-import { program } from "commander";
-import { getRemotePlaywrightContext } from "../../common/getPlaywrightConstructs";
-import { getSettings } from "../common/utils/settings";
-import dotenv from "dotenv";
-import { loadSessionToContext } from "../../common/getPlaywrightConstructs";
-dotenv.config({
-  path: `.env`
-});
-program.description("load auth session to browser").option("--cdpAddress <cdpAddress>", "CDP address", "http://localhost:9222").option("--authSessionPath <authSession>", "auth session to use when executing the api").allowUnknownOption().action(async ({
-  cdpAddress,
-  authSessionPath
-}) => {
-  const setting = await getSettings();
-  if (!setting.authSessions.enabled) {
-    throw new Error("Auth session is not enabled");
-  }
-  const {
-    context
-  } = await getRemotePlaywrightContext(cdpAddress);
-  await loadSessionToContext({
-    context,
-    session: {
-      type: "file",
-      path: authSessionPath
-    }
-  });
-  process.exit(0);
-});
-program.parse(process.argv);

package/dist/commands/auth-sessions/run-check.ts

@@ -1,51 +0,0 @@
-#!/usr/bin/env node
-import { Argument, program } from "commander";
-import * as fs from "fs-extra";
-import { getFullPathInProject } from "../common/utils/fileUtils";
-import { getSettings } from "../common/utils/settings";
-import dotenv from "dotenv";
-import { AUTH_SESSIONS_FOLDER_NAME } from "../../common/constants";
-import { runApi } from "../../common/runApi";
-dotenv.config({
-  path: `.env`
-});
-program.description("run auth session check").option("--cdpAddress <cdpAddress>", "CDP address", "http://localhost:9222").option("--authSessionPath <authSession>", "auth session to use when executing the check").allowUnknownOption().addArgument(new Argument("<mode>", "mode of execution").choices(["vanilla", "playwright", "playwright-standalone"]).default("playwright-standalone").argOptional()).action(async (mode, {
-  cdpAddress,
-  authSessionPath
-}) => {
-  const setting = await getSettings();
-  if (!setting.authSessions.enabled) {
-    throw new Error("auth session is not enabled");
-  }
-  const checkFilePath = getFullPathInProject(AUTH_SESSIONS_FOLDER_NAME, "check");
-  if (!fs.exists(checkFilePath)) {
-    throw new Error("auth session check file not found");
-  }
-  const runApiResult = await runApi({
-    automationFunction: {
-      name: `${AUTH_SESSIONS_FOLDER_NAME}/check`
-    },
-    runOptions: {
-      environment: "ide",
-      mode,
-      cdpAddress
-    },
-    auth: {
-      session: {
-        type: "file",
-        path: authSessionPath
-      },
-      runCheck: false
-    }
-  });
-  if (runApiResult.isErr()) {
-    throw new Error(runApiResult.error);
-  }
-  const result = runApiResult.value.result;
-  console.log("check result", result);
-  if (!result) {
-    throw new Error("auth session check failed");
-  }
-  process.exit(0);
-});
-program.parse(process.argv);