@intuned/runtime-dev 1.2.1-hooks.9 → 1.2.1-results.0

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,73 +156,65 @@ export declare class RunError extends Error {
 }
 
 /**
- * Retrieves the parameters for the authentication session currently being used.
+ * 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.
  *
- * @returns {AuthSessionParameters} An object containing the parameters for the current authentication session.
+ * **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 getAuthSessionParameters
- * import { getAuthSessionParameters } from "@intuned/sdk/runtime"
+ * ```typescript requestMultipleChoice
+ * // in auth-sessions/create.ts
  *
- * const authSessionParams = getAuthSessionParameters();
- * console.log(authSessionParams);
+ * 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 getAuthSessionParameters(): Promise<any>;
+export declare function requestMultipleChoice(
+  message: string,
+  choices: string[]
+): unknown;
 
 /**
- * @interface Store
- * @property {function} get - Retrieves a value from the store by key
- * @property {function} set - Sets a value in the store by key
+ * **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 Store usage
- * import { store } from "@intuned/sdk/runtime"
+ * ```typescript requestOTP
+ * // in auth-sessions/create.ts
+ *
+ * import { requestOTP } from "@intuned/sdk/runtime"
  *
- * // Set a value in the store
- * store.set('userPreference', { theme: 'dark' });
+ * const message = "please submit and OTP from your authenticator app";
  *
- * // Get a value from the store
- * const preference = store.get('userPreference');
+ * const otp = yield requestOTP(message);
+ *
+ * console.log(otp);
  * ```
  */
-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;
-}
+export declare function requestOTP(message: string): unknown;
 
 /**
- * ## 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 Store usage
- * import { store } from "@intuned/sdk/runtime"
+ * Retrieves the parameters for the authentication session currently being used.
  *
- * // Set a value in the store
- * store.set('sessionData', { userId: '123', token: 'abc' });
+ * @returns {AuthSessionParameters} An object containing the parameters for the current authentication session.
  *
- * // Get a value from the store
- * const sessionData = store.get('sessionData');
- * console.log(sessionData.userId); // '123'
+ * @example
+ * ```typescript getAuthSessionParameters
+ * import { getAuthSessionParameters } from "@intuned/sdk/runtime"
  *
- * // Handle missing values
- * const missingData = store.get('nonexistent'); // undefined
+ * const authSessionParams = getAuthSessionParameters();
+ * console.log(authSessionParams);
  * ```
  */
-export declare const store: Store;
+export declare function getAuthSessionParameters(): Promise<any>;

package/dist/runtime/index.d.ts

@@ -1,7 +1,8 @@
 export { extendPayload } from "./extendPayload";
 export { extendTimeout } from "./extendTimeout";
-export { store } from "./store";
 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

@@ -33,22 +33,28 @@ Object.defineProperty(exports, "getDownloadDirectoryPath", {
     return _downloadDirectory.getDownloadDirectoryPath;
   }
 });
-Object.defineProperty(exports, "runInfo", {
+Object.defineProperty(exports, "requestMultipleChoice", {
   enumerable: true,
   get: function () {
-    return _runInfo.runInfo;
+    return _requestMoreInfo.requestMultipleChoice;
+  }
+});
+Object.defineProperty(exports, "requestOTP", {
+  enumerable: true,
+  get: function () {
+    return _requestMoreInfo.requestOTP;
   }
 });
-Object.defineProperty(exports, "store", {
+Object.defineProperty(exports, "runInfo", {
   enumerable: true,
   get: function () {
-    return _store.store;
+    return _runInfo.runInfo;
   }
 });
 var _extendPayload = require("./extendPayload");
 var _extendTimeout = require("./extendTimeout");
-var _store = require("./store");
 var _getAuthSessionParameters = require("./getAuthSessionParameters");
 var _runInfo = require("./runInfo");
 var _RunError = require("./RunError");
+var _requestMoreInfo = require("./requestMoreInfo");
 var _downloadDirectory = require("./downloadDirectory");

package/dist/runtime/requestMoreInfo.d.ts

@@ -0,0 +1,18 @@
+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

@@ -0,0 +1,25 @@
+"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
+  };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@intuned/runtime-dev",
-  "version": "1.2.1-hooks.9",
+  "version": "1.2.1-results.0",
   "description": "Intuned runtime",
   "exports": {
     ".": "./dist/index.js",
@@ -70,7 +70,6 @@
     "cross-fetch": "^4.0.0",
     "dotenv": "^16.3.1",
     "fs-extra": "^11.3.0",
-    "get-port-please": "^3.2.0",
     "image-size": "^1.1.1",
     "inquirer": "12.6.0",
     "jsonwebtoken": "9.0.2",
@@ -119,7 +118,6 @@
     "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/initializeContextHook.d.ts

@@ -1,16 +0,0 @@
-import type * as playwright from "playwright";
-import type { RunAutomationError } from "./runApi/errors";
-import type { Err, Ok } from "neverthrow";
-import { type ImportFunction } from "./runApi/importUsingImportFunction";
-export type InitializeContextHookOptions = {
-    apiName: string;
-    apiParameters: any;
-    cdpUrl: string;
-};
-export type InitializeContextHook = (options: InitializeContextHookOptions) => Promise<{
-    page: playwright.Page | null;
-    context: playwright.BrowserContext;
-} | null>;
-export declare function loadInitializeContextHook({ importFunction, }: {
-    importFunction: ImportFunction;
-}): Promise<Ok<InitializeContextHook | null, any> | Err<any, RunAutomationError>>;

package/dist/common/initializeContextHook.js

@@ -1,15 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.loadInitializeContextHook = loadInitializeContextHook;
-var _importUsingImportFunction = require("./runApi/importUsingImportFunction");
-async function loadInitializeContextHook({
-  importFunction
-}) {
-  return await (0, _importUsingImportFunction.importUsingImportFunction)({
-    path: "hooks/initializeContext",
-    importFunction
-  });
-}

package/dist/common/playwrightContext.d.ts

@@ -1,49 +0,0 @@
-import * as playwright from "playwright";
-import { RunAutomationError } from "./runApi/errors";
-import type { RunApiSession } from "./runApi/types";
-import { Err, Ok } from "neverthrow";
-import { type ImportFunction } from "./runApi/importUsingImportFunction";
-export interface Proxy {
-    server: string;
-    username: string;
-    password: string;
-}
-export declare function launchChromium(options: {
-    proxy?: Proxy;
-    headless: boolean;
-    downloadsPath?: string;
-    cdpPort?: number;
-}): Promise<{
-    page: playwright.Page;
-    context: playwright.BrowserContext;
-}>;
-export declare function launchChromium(options: {
-    cdpAddress: string;
-}): Promise<{
-    page: playwright.Page;
-    context: playwright.BrowserContext;
-}>;
-export declare const browserScriptsFile: string;
-type WithPlaywrightContextParameters = {
-    importFunction: ImportFunction;
-    apiName: string;
-    apiParameters: any;
-};
-export type WithPlaywrightContextWrappedFunction<R> = (context: playwright.BrowserContext, page: playwright.Page) => Promise<Ok<R, any> | Err<any, RunAutomationError>>;
-export declare function withPlaywrightContext<R>(options: {
-    proxy?: Proxy;
-    headless: boolean;
-    downloadsPath: string;
-} & WithPlaywrightContextParameters, fn: WithPlaywrightContextWrappedFunction<R>): Promise<Ok<R, any> | Err<any, RunAutomationError>>;
-export declare function withPlaywrightContext<R>(options: {
-    cdpAddress: string;
-} & WithPlaywrightContextParameters, fn: WithPlaywrightContextWrappedFunction<R>): Promise<Ok<R, any> | Err<any, RunAutomationError>>;
-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/runApi/importUsingImportFunction.d.ts

@@ -1,9 +0,0 @@
-import { Result } from "neverthrow";
-import { RunAutomationError } from "./errors";
-import { ExtendedRunApiParameters } from "./types";
-export type ImportFunction = ExtendedRunApiParameters["importFunction"];
-export declare function importUsingImportFunction<_ReturnType = any>({ path, allowGenerators, importFunction, }: {
-    path: string;
-    importFunction: ImportFunction;
-    allowGenerators?: boolean;
-}): Promise<Result<(..._: any) => Promise<_ReturnType>, RunAutomationError>>;

package/dist/common/runApi/importUsingImportFunction.js

@@ -1,46 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.importUsingImportFunction = importUsingImportFunction;
-var _neverthrow = require("neverthrow");
-var _errors = require("./errors");
-async function importUsingImportFunction({
-  path,
-  allowGenerators = true,
-  importFunction
-}) {
-  try {
-    const importedResult = await importFunction(path);
-    if (importedResult.isErr()) {
-      if (importedResult.error.type === "not_found") {
-        return (0, _neverthrow.err)(new _errors.ApiNotFoundError(path));
-      }
-      return (0, _neverthrow.err)(new _errors.AutomationError(importedResult.error.error));
-    }
-    const imported = importedResult.value;
-    if (!imported || !imported.default || !imported.default.constructor) {
-      return (0, _neverthrow.err)(new _errors.InvalidApiError(`${path} does not have a default export`));
-    }
-    if (imported.default.constructor.name === "AsyncGeneratorFunction") {
-      if (!allowGenerators) {
-        return (0, _neverthrow.err)(new _errors.InvalidApiError(`${path} default export must be an async function`));
-      }
-      return (0, _neverthrow.ok)(async (...args) => {
-        const generator = imported.default(...args);
-        const result = await generator.next();
-        if (!result.done) {
-          throw new Error("Yield is not supported");
-        }
-        return result.value;
-      });
-    }
-    if (imported.default.constructor.name === "AsyncFunction") {
-      return (0, _neverthrow.ok)(imported.default);
-    }
-    return (0, _neverthrow.err)(new _errors.InvalidApiError(`${path} default export must be an async function`));
-  } catch (error) {
-    return (0, _neverthrow.err)(new _errors.AutomationError(error));
-  }
-}

package/dist/runtime/store.d.ts

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

package/dist/runtime/store.js

@@ -1,23 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.store = void 0;
-var _asyncLocalStorage = require("../common/asyncLocalStorage");
-const store = exports.store = 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;
-  }
-});