@intuned/runtime-dev 1.3.1-api-token.6 → 1.3.4-dev.0

package/dist/index.js

@@ -9,6 +9,12 @@ Object.defineProperty(exports, "RunError", {
     return _runtime.RunError;
   }
 });
+Object.defineProperty(exports, "attemptStore", {
+  enumerable: true,
+  get: function () {
+    return _runtime.attemptStore;
+  }
+});
 Object.defineProperty(exports, "extendPayload", {
   enumerable: true,
   get: function () {
@@ -39,24 +45,6 @@ Object.defineProperty(exports, "getExecutionContext", {
     return _asyncLocalStorage.getExecutionContext;
   }
 });
-Object.defineProperty(exports, "getProductionPlaywrightConstructs", {
-  enumerable: true,
-  get: function () {
-    return _getPlaywrightConstructs.getProductionPlaywrightConstructs;
-  }
-});
-Object.defineProperty(exports, "requestMultipleChoice", {
-  enumerable: true,
-  get: function () {
-    return _runtime.requestMultipleChoice;
-  }
-});
-Object.defineProperty(exports, "requestOTP", {
-  enumerable: true,
-  get: function () {
-    return _runtime.requestOTP;
-  }
-});
 Object.defineProperty(exports, "runInfo", {
   enumerable: true,
   get: function () {
@@ -69,7 +57,13 @@ Object.defineProperty(exports, "runWithContext", {
     return _asyncLocalStorage.runWithContext;
   }
 });
+Object.defineProperty(exports, "withPlaywrightContext", {
+  enumerable: true,
+  get: function () {
+    return _playwrightContext.withPlaywrightContext;
+  }
+});
 var _runtime = require("./runtime");
 var _asyncLocalStorage = require("./common/asyncLocalStorage");
 var _downloadDirectory = require("./runtime/downloadDirectory");
-var _getPlaywrightConstructs = require("./common/getPlaywrightConstructs");
+var _playwrightContext = require("./common/playwrightContext");

package/dist/runtime/attemptStore.d.ts

@@ -0,0 +1,2 @@
+import { Store } from "./export";
+export declare const attemptStore: Store;

package/dist/runtime/attemptStore.js

@@ -0,0 +1,23 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.attemptStore = void 0;
+var _asyncLocalStorage = require("../common/asyncLocalStorage");
+const attemptStore = exports.attemptStore = Object.freeze({
+  get: key => {
+    const context = (0, _asyncLocalStorage.getExecutionContext)();
+    return context?.store ? context.store[key] : undefined;
+  },
+  set: (key, value) => {
+    const context = (0, _asyncLocalStorage.getExecutionContext)();
+    if (!context) {
+      throw new Error("store.set failed due to an internal error.");
+    }
+    if (!context.store) {
+      context.store = {};
+    }
+    context.store[key] = value;
+  }
+});

package/dist/runtime/export.d.ts

@@ -126,6 +126,8 @@ export interface RunErrorOptions {
 }
 
 /**
+ * @deprecated This error is deprecated. it will be treated like any normal error
+ *
  * Represents an error that occurs during a run.
  *
  * @class
@@ -154,65 +156,73 @@ export declare class RunError extends Error {
 }
 
 /**
- * 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.
+ * Retrieves the parameters for the authentication session currently being used.
  *
- * @param {string} message - The message to display to the user.
- * @param {string[]} choices - An array of choices to present to the user.
+ * @returns {AuthSessionParameters} An object containing the parameters for the current authentication session.
  *
  * @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);
+ * ```typescript getAuthSessionParameters
+ * import { getAuthSessionParameters } from "@intuned/sdk/runtime"
  *
- * console.log(selectedChoice);
+ * const authSessionParams = getAuthSessionParameters();
+ * console.log(authSessionParams);
  * ```
  */
-export declare function requestMultipleChoice(
-  message: string,
-  choices: string[]
-): unknown;
+export declare function getAuthSessionParameters(): Promise<any>;
 
 /**
- * **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.
+ * @interface Store
+ * @property {function} get - Retrieves a value from the store by key
+ * @property {function} set - Sets a value in the store by key
  *
  * @example
- * ```typescript requestOTP
- * // in auth-sessions/create.ts
- *
- * import { requestOTP } from "@intuned/sdk/runtime"
+ * ```typescript Store usage
+ * import { store } from "@intuned/sdk/runtime"
  *
- * const message = "please submit and OTP from your authenticator app";
+ * // Set a value in the store
+ * store.set('userPreference', { theme: 'dark' });
  *
- * const otp = yield requestOTP(message);
- *
- * console.log(otp);
+ * // Get a value from the store
+ * const preference = store.get('userPreference');
  * ```
  */
-export declare function requestOTP(message: string): unknown;
+export interface Store {
+  /**
+   * Retrieves a value from the store by key.
+   *
+   * @param {string} key - The key to retrieve the value for
+   * @returns {any} The value associated with the key, or undefined if not found
+   */
+  get(key: string): any;
+
+  /**
+   * Sets a value in the store by key.
+   *
+   * @param {string} key - The key to set the value for
+   * @param {any} value - The value to store
+   * @throws {Error} Throws an error if the store operation fails
+   */
+  set(key: string, value: any): void;
+}
 
 /**
- * Retrieves the parameters for the authentication session currently being used.
- *
- * @returns {AuthSessionParameters} An object containing the parameters for the current authentication session.
+ * ## Description
+ * A persistent key-value store that maintains data within the execution context.
+ * This store allows you to share data between different parts of your API execution.
  *
  * @example
- * ```typescript getAuthSessionParameters
- * import { getAuthSessionParameters } from "@intuned/sdk/runtime"
+ * ```typescript Store usage
+ * import { store } from "@intuned/sdk/runtime"
  *
- * const authSessionParams = getAuthSessionParameters();
- * console.log(authSessionParams);
+ * // Set a value in the store
+ * store.set('sessionData', { userId: '123', token: 'abc' });
+ *
+ * // Get a value from the store
+ * const sessionData = store.get('sessionData');
+ * console.log(sessionData.userId); // '123'
+ *
+ * // Handle missing values
+ * const missingData = store.get('nonexistent'); // undefined
  * ```
  */
-export declare function getAuthSessionParameters(): Promise<any>;
+export declare const attemptStore: Store;

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-dev",
-  "version": "1.3.1-api-token.6",
+  "version": "1.3.4-dev.0",
   "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,6 +119,7 @@
     "eslint-plugin-deprecation": "^1.3.3",
     "eslint-plugin-prettier": "^4.2.1",
     "msw": "^2.1.2",
+    "playwright": "^1.55.0",
     "typedoc": "^0.25.13",
     "typedoc-plugin-frontmatter": "^1.0.0",
     "typedoc-plugin-markdown": "^4.0.2",

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/common/getPlaywrightConstructs.js

@@ -1,188 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.getPlaywrightConstructsForMode = getPlaywrightConstructsForMode;
-exports.getProductionPlaywrightConstructs = getProductionPlaywrightConstructs;
-exports.getRemotePlaywrightContext = getRemotePlaywrightContext;
-exports.loadSessionToContext = loadSessionToContext;
-var playwright = _interopRequireWildcard(require("playwright"));
-var _fsExtra = _interopRequireWildcard(require("fs-extra"));
-var fs = _fsExtra;
-var _contextStorageStateHelpers = require("./contextStorageStateHelpers");
-var _path = _interopRequireWildcard(require("path"));
-var _fileUtils = require("../commands/common/utils/fileUtils");
-var _waitOn = _interopRequireDefault(require("wait-on"));
-var _runtime = require("../runtime");
-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; }
-async function createUserDirWithPreferences() {
-  const playwrightTempDir = await (0, _fsExtra.mkdtemp)("/tmp/pw-");
-  const userDir = (0, _path.join)(playwrightTempDir, "userdir");
-  const defaultDir = (0, _path.join)(userDir, "Default");
-  await (0, _fsExtra.mkdir)(defaultDir, {
-    recursive: true
-  });
-  const preferences = {
-    plugins: {
-      always_open_pdf_externally: true
-    }
-  };
-  await (0, _fsExtra.writeFile)((0, _path.join)(defaultDir, "Preferences"), JSON.stringify(preferences));
-  return userDir;
-}
-async function getProductionPlaywrightConstructs({
-  proxy,
-  headless = true,
-  storageState,
-  downloadsPath
-}) {
-  const extraArgs = ["--no-first-run", "--disable-sync", "--disable-translate", "--disable-features=TranslateUI", "--disable-features=NetworkService", "--lang=en"];
-  if (headless) {
-    extraArgs.push("--headless=new");
-  }
-  const userDataDir = await createUserDirWithPreferences();
-  const context = await playwright.chromium.launchPersistentContext(userDataDir, {
-    headless,
-    viewport: null,
-    proxy,
-    downloadsPath
-  });
-  context.once("close", async () => {
-    try {
-      await (0, _fsExtra.rm)(userDataDir, {
-        recursive: true,
-        force: true,
-        retryDelay: 1000,
-        maxRetries: 5
-      });
-    } catch (error) {
-      console.error("Failed to remove user data dir", error);
-    }
-  });
-  if (storageState) {
-    await loadSessionToContext({
-      context,
-      session: storageState
-    });
-  }
-  const assetsFile = _path.default.join(__dirname, "./assets/browser_scripts.js");
-  await context.addInitScript({
-    path: assetsFile
-  });
-  let page = context.pages().at(0);
-  if (page) {
-    const scriptString = await (0, _fsExtra.readFile)(assetsFile, "utf8");
-    await page.evaluate(scriptString);
-  } else {
-    page = await context.newPage();
-  }
-  return {
-    page,
-    context
-  };
-}
-async function getPlaywrightConstructsForMode(mode, cdpAddress, authSession) {
-  if (mode == "playwright-standalone") {
-    if (!cdpAddress) {
-      throw new Error("cdpAddress is required");
-    }
-    const {
-      context
-    } = await getRemotePlaywrightContext(cdpAddress);
-    if (!context) {
-      throw new Error("no context found");
-    }
-    const assetsFile = _path.default.join(__dirname, "./assets/browser_scripts.js");
-    await context.addInitScript({
-      path: assetsFile
-    });
-    const pages = await context.pages();
-    let page = null;
-    if (pages.length > 0) {
-      page = pages[0];
-      const scriptString = await fs.readFile(assetsFile, "utf8");
-      await page.evaluate(scriptString);
-    } else {
-      page = await context.newPage();
-    }
-    if (authSession) {
-      await loadSessionToContext({
-        context,
-        session: authSession
-      });
-    }
-    return {
-      page,
-      context
-    };
-  }
-  const downloadsPath = (0, _runtime.getDownloadDirectoryPath)();
-  if (mode === "playwright" || mode === "playwright-headless") {
-    const productionConstructs = await getProductionPlaywrightConstructs({
-      headless: mode === "playwright-headless",
-      downloadsPath
-    });
-    if (authSession) {
-      await loadSessionToContext({
-        context: productionConstructs.context,
-        session: authSession
-      });
-    }
-    return {
-      ...productionConstructs
-    };
-  }
-  throw "invalid mode";
-}
-async function loadSessionToContext({
-  context,
-  session
-}) {
-  let sessionToLoad;
-  if (session.type === "state") {
-    const state = session.state;
-    if (state === undefined || state === null) {
-      return;
-    }
-    sessionToLoad = state;
-  } else {
-    const fullPath = (0, _fileUtils.getFullPathInProject)(session.path);
-    sessionToLoad = await fs.readJson(fullPath);
-  }
-  await (0, _contextStorageStateHelpers.setStorageState)(context, sessionToLoad);
-}
-async function getRemotePlaywrightContext(cdpAddress) {
-  const playwright = await Promise.resolve().then(() => _interopRequireWildcard(require("playwright")));
-  let browser = null;
-  if (!cdpAddress) {
-    throw new Error("cdpAddress is required");
-  }
-  const cdpAddressWithoutProtocol = cdpAddress.replace("http://", "").replace("https://", "").replace("localhost", "127.0.0.1");
-  try {
-    await (0, _waitOn.default)({
-      resources: [`http-get://${cdpAddressWithoutProtocol}/json/version`],
-      delay: 100,
-      interval: 100,
-      timeout: 5000,
-      tcpTimeout: 1000,
-      window: 1000
-    });
-  } catch (error) {
-    console.error("Failed to connect to the browser");
-    process.exit(128 + 9);
-  }
-  try {
-    browser = await playwright.chromium.connectOverCDP(cdpAddress);
-  } catch (e) {
-    console.log(e);
-    throw new Error("failed to connect to the browser");
-  }
-  const context = browser.contexts()[0];
-  return {
-    browser,
-    context
-  };
-}

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
-  };
-}