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

package/dist/common/runApi/index.js

@@ -4,11 +4,13 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 var _exportNames = {
+  runApiGenerator: true,
   runApi: true,
   checkAuthSessionWithRetries: true
 };
 exports.checkAuthSessionWithRetries = checkAuthSessionWithRetries;
 exports.runApi = runApi;
+exports.runApiGenerator = runApiGenerator;
 var _downloadDirectory = require("../../runtime/downloadDirectory");
 var _asyncLocalStorage = require("../asyncLocalStorage");
 var _fsExtra = _interopRequireWildcard(require("fs-extra"));
@@ -28,7 +30,7 @@ Object.keys(_errors).forEach(function (key) {
   });
 });
 var _constants = require("../constants");
-var _playwrightContext = require("../playwrightContext");
+var _getPlaywrightConstructs = require("../getPlaywrightConstructs");
 var _types = require("./types");
 Object.keys(_types).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
@@ -43,13 +45,19 @@ Object.keys(_types).forEach(function (key) {
 });
 var _formatZodError = require("../formatZodError");
 var _cleanEnvironmentVariables = require("../cleanEnvironmentVariables");
-var _importUsingImportFunction = require("./importUsingImportFunction");
 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 runApi({
+function getObjectSizeInBytes(obj) {
+  try {
+    return new TextEncoder().encode(JSON.stringify(obj)).length;
+  } catch (error) {
+    return new TextEncoder().encode(String(obj)).length;
+  }
+}
+async function* runApiGenerator({
+  retrieveSession = false,
   abortSignal,
   importFunction,
-  retrieveSession = false,
   ...input
 }) {
   let traceStarted = false;
@@ -58,10 +66,7 @@ async function runApi({
     return (0, _neverthrow.err)(new _errors.InternalInvalidInputError("Input validation failed", (0, _formatZodError.formatZodError)(inputParseResult.error)));
   }
   const {
-    automationFunction: {
-      name,
-      params
-    },
+    automationFunction,
     runOptions,
     tracing,
     auth
@@ -73,103 +78,166 @@ async function runApi({
       resolve(abortSymbol);
     });
   });
-  async function runAutomation() {
-    const validatedModuleResult = await (0, _importUsingImportFunction.importUsingImportFunction)({
-      path: name,
-      importFunction
-    });
+  let context;
+  let downloadsPath;
+  async function saveTraceIfNeeded({
+    errorMessage
+  }) {
+    if (!tracing.enabled || !traceStarted) {
+      return;
+    }
+    try {
+      await context?.tracing.stop({
+        path: tracing.filePath
+      });
+    } catch (error) {
+      console.log(errorMessage, error?.message);
+      await (0, _fsExtra.remove)(tracing.filePath);
+    }
+  }
+  async function* runAutomation() {
+    let page;
+    const validatedModuleResult = await importUsingImportFunction(automationFunction.name, importFunction);
     if (validatedModuleResult.isErr()) {
       return (0, _neverthrow.err)(validatedModuleResult.error);
     }
-    const automationFunction = validatedModuleResult.value;
+    const importedModule = validatedModuleResult.value;
+    let checkFn;
+    if (auth?.runCheck) {
+      if (!auth.session) {
+        return (0, _neverthrow.err)(new _errors.AuthRequiredError());
+      }
+      const checkImportResult = await importUsingImportFunction(`${_constants.AUTH_SESSIONS_FOLDER_NAME}/check`, importFunction);
+      if (checkImportResult.isErr()) {
+        return (0, _neverthrow.err)(checkImportResult.error);
+      }
+      if (checkImportResult.value.type !== "async") {
+        return (0, _neverthrow.err)(new _errors.InvalidCheckError("Check function is not an async function"));
+      }
+      checkFn = checkImportResult.value.func;
+    }
     if (auth && auth.session.type === "state") {
       const state = auth.session.state;
       if (state === undefined || state === null) {
         return (0, _neverthrow.err)(new _errors.AuthRequiredError());
       }
     }
-    const playwrightContextParameters = {
-      apiName: name,
-      apiParameters: params,
-      importFunction
-    };
-    const runAutomationWithContext = async (context, page) => {
-      async function saveTraceIfNeeded({
-        errorMessage
-      }) {
-        if (!tracing.enabled || !traceStarted) {
-          return;
-        }
-        try {
-          await context?.tracing.stop({
-            path: tracing.filePath
-          });
-        } catch (error) {
-          console.log(errorMessage, error?.message);
-          await (0, _fsExtra.remove)(tracing.filePath);
-        }
-      }
-      if (auth) {
-        await (0, _playwrightContext.loadSessionToContext)({
-          context,
-          session: auth.session
-        });
-      }
-      const scriptContent = await fs.readFile(_playwrightContext.browserScriptsFile, "utf-8");
-      await context.addInitScript({
-        content: scriptContent
+    if (runOptions.environment === "standalone") {
+      downloadsPath = (0, _downloadDirectory.getDownloadDirectoryPath)();
+      const {
+        headless,
+        proxy
+      } = runOptions;
+      ({
+        page,
+        context
+      } = await (0, _getPlaywrightConstructs.getProductionPlaywrightConstructs)({
+        headless,
+        proxy,
+        downloadsPath,
+        storageState: auth?.session
+      }));
+    } else {
+      const {
+        mode,
+        cdpAddress
+      } = runOptions;
+      ({
+        page,
+        context
+      } = await (0, _getPlaywrightConstructs.getPlaywrightConstructsForMode)(mode, cdpAddress, auth?.session));
+    }
+    if (tracing.enabled) {
+      await context.tracing.start({
+        screenshots: true,
+        snapshots: true,
+        sources: true
       });
-      for (const page of context.pages()) {
-        await page.evaluate(scriptContent);
-      }
-      if (tracing.enabled) {
-        await context.tracing.start({
-          screenshots: true,
-          snapshots: true,
-          sources: true
-        });
-        traceStarted = true;
-      }
-      (0, _cleanEnvironmentVariables.cleanEnvironmentVariables)();
-      const automationFunctionParameters = [...(params !== undefined ? [params] : []), page, context];
+      traceStarted = true;
+    }
+    (0, _cleanEnvironmentVariables.cleanEnvironmentVariables)();
+    if (checkFn !== undefined) {
       try {
-        return (0, _neverthrow.ok)({
-          result: await automationFunction(...automationFunctionParameters),
-          extendedPayloads: (0, _asyncLocalStorage.getExecutionContext)()?.extendedPayloads,
-          session: retrieveSession ? await (0, _contextStorageStateHelpers.getStorageState)(context) : undefined
-        });
+        console.log("Running auth check");
+        const authCheckResult = await checkAuthSessionWithRetries(page, context, checkFn, 2);
+        if (authCheckResult.isErr()) {
+          const error = authCheckResult.error;
+          if (["APINotFoundError", "InvalidAPIError"].includes(error.code)) {
+            return (0, _neverthrow.err)(new _errors.InvalidCheckError(`Auth session check function failed`, error));
+          }
+          return authCheckResult;
+        }
+        if (!authCheckResult.value) {
+          return (0, _neverthrow.err)(new _errors.AuthCheckFailedError());
+        }
       } catch (error) {
-        return (0, _neverthrow.err)(new _errors.AutomationError(error));
-      } finally {
-        await saveTraceIfNeeded({
-          errorMessage: "failed to save trace"
-        });
+        return (0, _neverthrow.err)(new _errors.AuthCheckFailedError());
       }
-    };
-    if (runOptions.environment === "standalone") {
-      const downloadsPath = (0, _downloadDirectory.getDownloadDirectoryPath)();
-      try {
-        return await (0, _playwrightContext.withPlaywrightContext)({
-          headless: runOptions.headless,
-          proxy: runOptions.proxy,
-          downloadsPath,
-          ...playwrightContextParameters
-        }, runAutomationWithContext);
-      } finally {
-        await fs.remove(downloadsPath);
+    }
+    const automationFunctionParameters = [...(automationFunction.params !== undefined ? [automationFunction.params] : []), page, context];
+    let result;
+    if (importedModule.type === "async-generator") {
+      const generator = importedModule.generator(...automationFunctionParameters);
+      let next = undefined;
+      while (true) {
+        const generatorResult = await generator.next(...(next ? [next] : []));
+        if (!generatorResult.done) {
+          next = yield generatorResult.value;
+          continue;
+        }
+        result = generatorResult.value;
+        break;
       }
     } else {
-      return await (0, _playwrightContext.withPlaywrightContext)({
-        cdpAddress: runOptions.cdpAddress,
-        ...playwrightContextParameters
-      }, runAutomationWithContext);
+      result = await importedModule.func(...automationFunctionParameters);
+    }
+    const MAX_RESULT_SIZE_BYTES = 2 * 1024 * 1024;
+    const resultSizeInBytes = getObjectSizeInBytes(result);
+    if (resultSizeInBytes > MAX_RESULT_SIZE_BYTES) {
+      return (0, _neverthrow.err)(new _errors.ResultTooBigError(resultSizeInBytes, MAX_RESULT_SIZE_BYTES));
+    }
+    return (0, _neverthrow.ok)({
+      result,
+      extendedPayloads: (0, _asyncLocalStorage.getExecutionContext)()?.extendedPayloads,
+      session: retrieveSession ? await (0, _contextStorageStateHelpers.getStorageState)(context) : undefined
+    });
+  }
+  try {
+    const generator = runAutomation();
+    let next = undefined;
+    while (true) {
+      const result = await Promise.race([generator.next(await next), abortPromise]);
+      if (result === abortSymbol) {
+        return (0, _neverthrow.err)(new _errors.AbortedError());
+      }
+      if (!result.done) {
+        next = yield result.value;
+        continue;
+      }
+      return result.value;
+    }
+  } catch (error) {
+    return (0, _neverthrow.err)(new _errors.AutomationError(error));
+  } finally {
+    await saveTraceIfNeeded({
+      errorMessage: "failed to save trace"
+    });
+    await context?.close();
+    if (downloadsPath !== undefined) {
+      await fs.remove(downloadsPath);
     }
   }
-  const result = await Promise.race([await runAutomation(), abortPromise]);
-  if (result === abortSymbol) {
-    return (0, _neverthrow.err)(new _errors.AbortedError());
+}
+async function runApi(params) {
+  const generator = runApiGenerator(params);
+  const {
+    value,
+    done
+  } = await generator.next();
+  if (done) {
+    return value;
   }
-  return result;
+  return (0, _neverthrow.err)(new _errors.InvalidApiError("Expected API to be async function, got async generator"));
 }
 async function checkAuthSessionWithRetries(page, context, checkFn, retries = 3) {
   if (retries === 0) {
@@ -183,4 +251,34 @@ async function checkAuthSessionWithRetries(page, context, checkFn, retries = 3)
     tryNumber++;
   }
   return (0, _neverthrow.ok)(false);
+}
+async function importUsingImportFunction(path, 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("API file path does not have a default export"));
+    }
+    if (imported.default.constructor.name === "AsyncGeneratorFunction") {
+      return (0, _neverthrow.ok)({
+        type: "async-generator",
+        generator: imported.default
+      });
+    }
+    if (imported.default.constructor.name === "AsyncFunction") {
+      return (0, _neverthrow.ok)({
+        type: "async",
+        func: imported.default
+      });
+    }
+    return (0, _neverthrow.err)(new _errors.InvalidApiError("API file path does not have a default async function/generator export"));
+  } catch (error) {
+    return (0, _neverthrow.err)(new _errors.AutomationError(error));
+  }
 }

package/dist/common/runApi/types.d.ts

@@ -36,18 +36,18 @@ export declare const runApiStorageStateSchema: z.ZodObject<{
         secure: z.ZodBoolean;
         sameSite: z.ZodEnum<["Strict", "Lax", "None"]>;
     }, "strip", z.ZodTypeAny, {
-        path: string;
         value: string;
         name: string;
+        path: string;
         domain: string;
         expires: number;
         httpOnly: boolean;
         secure: boolean;
         sameSite: "Strict" | "Lax" | "None";
     }, {
-        path: string;
         value: string;
         name: string;
+        path: string;
         domain: string;
         expires: number;
         httpOnly: boolean;
@@ -106,9 +106,9 @@ export declare const runApiStorageStateSchema: z.ZodObject<{
     }>, "many">>;
 }, "strip", z.ZodTypeAny, {
     cookies: {
-        path: string;
         value: string;
         name: string;
+        path: string;
         domain: string;
         expires: number;
         httpOnly: boolean;
@@ -131,9 +131,9 @@ export declare const runApiStorageStateSchema: z.ZodObject<{
     }[] | undefined;
 }, {
     cookies: {
-        path: string;
         value: string;
         name: string;
+        path: string;
         domain: string;
         expires: number;
         httpOnly: boolean;
@@ -178,18 +178,18 @@ export declare const runApiSessionSchema: z.ZodDiscriminatedUnion<"type", [z.Zod
             secure: z.ZodBoolean;
             sameSite: z.ZodEnum<["Strict", "Lax", "None"]>;
         }, "strip", z.ZodTypeAny, {
-            path: string;
             value: string;
             name: string;
+            path: string;
             domain: string;
             expires: number;
             httpOnly: boolean;
             secure: boolean;
             sameSite: "Strict" | "Lax" | "None";
         }, {
-            path: string;
             value: string;
             name: string;
+            path: string;
             domain: string;
             expires: number;
             httpOnly: boolean;
@@ -248,9 +248,9 @@ export declare const runApiSessionSchema: z.ZodDiscriminatedUnion<"type", [z.Zod
         }>, "many">>;
     }, "strip", z.ZodTypeAny, {
         cookies: {
-            path: string;
             value: string;
             name: string;
+            path: string;
             domain: string;
             expires: number;
             httpOnly: boolean;
@@ -273,9 +273,9 @@ export declare const runApiSessionSchema: z.ZodDiscriminatedUnion<"type", [z.Zod
         }[] | undefined;
     }, {
         cookies: {
-            path: string;
             value: string;
             name: string;
+            path: string;
             domain: string;
             expires: number;
             httpOnly: boolean;
@@ -301,9 +301,9 @@ export declare const runApiSessionSchema: z.ZodDiscriminatedUnion<"type", [z.Zod
     type: "state";
     state?: {
         cookies: {
-            path: string;
             value: string;
             name: string;
+            path: string;
             domain: string;
             expires: number;
             httpOnly: boolean;
@@ -329,9 +329,9 @@ export declare const runApiSessionSchema: z.ZodDiscriminatedUnion<"type", [z.Zod
     type: "state";
     state?: {
         cookies: {
-            path: string;
             value: string;
             name: string;
+            path: string;
             domain: string;
             expires: number;
             httpOnly: boolean;
@@ -404,18 +404,18 @@ export declare const runApiParametersSchema: z.ZodObject<{
                     secure: z.ZodBoolean;
                     sameSite: z.ZodEnum<["Strict", "Lax", "None"]>;
                 }, "strip", z.ZodTypeAny, {
-                    path: string;
                     value: string;
                     name: string;
+                    path: string;
                     domain: string;
                     expires: number;
                     httpOnly: boolean;
                     secure: boolean;
                     sameSite: "Strict" | "Lax" | "None";
                 }, {
-                    path: string;
                     value: string;
                     name: string;
+                    path: string;
                     domain: string;
                     expires: number;
                     httpOnly: boolean;
@@ -474,9 +474,9 @@ export declare const runApiParametersSchema: z.ZodObject<{
                 }>, "many">>;
             }, "strip", z.ZodTypeAny, {
                 cookies: {
-                    path: string;
                     value: string;
                     name: string;
+                    path: string;
                     domain: string;
                     expires: number;
                     httpOnly: boolean;
@@ -499,9 +499,9 @@ export declare const runApiParametersSchema: z.ZodObject<{
                 }[] | undefined;
             }, {
                 cookies: {
-                    path: string;
                     value: string;
                     name: string;
+                    path: string;
                     domain: string;
                     expires: number;
                     httpOnly: boolean;
@@ -527,9 +527,9 @@ export declare const runApiParametersSchema: z.ZodObject<{
             type: "state";
             state?: {
                 cookies: {
-                    path: string;
                     value: string;
                     name: string;
+                    path: string;
                     domain: string;
                     expires: number;
                     httpOnly: boolean;
@@ -555,9 +555,9 @@ export declare const runApiParametersSchema: z.ZodObject<{
             type: "state";
             state?: {
                 cookies: {
-                    path: string;
                     value: string;
                     name: string;
+                    path: string;
                     domain: string;
                     expires: number;
                     httpOnly: boolean;
@@ -580,6 +580,7 @@ export declare const runApiParametersSchema: z.ZodObject<{
                 }[] | undefined;
             } | null | undefined;
         }>]>;
+        runCheck: z.ZodDefault<z.ZodBoolean>;
     }, "strip", z.ZodTypeAny, {
         session: {
             path: string;
@@ -588,9 +589,9 @@ export declare const runApiParametersSchema: z.ZodObject<{
             type: "state";
             state?: {
                 cookies: {
-                    path: string;
                     value: string;
                     name: string;
+                    path: string;
                     domain: string;
                     expires: number;
                     httpOnly: boolean;
@@ -613,6 +614,7 @@ export declare const runApiParametersSchema: z.ZodObject<{
                 }[] | undefined;
             } | null | undefined;
         };
+        runCheck: boolean;
     }, {
         session: {
             path: string;
@@ -621,9 +623,9 @@ export declare const runApiParametersSchema: z.ZodObject<{
             type: "state";
             state?: {
                 cookies: {
-                    path: string;
                     value: string;
                     name: string;
+                    path: string;
                     domain: string;
                     expires: number;
                     httpOnly: boolean;
@@ -646,6 +648,7 @@ export declare const runApiParametersSchema: z.ZodObject<{
                 }[] | undefined;
             } | null | undefined;
         };
+        runCheck?: boolean | undefined;
     }>>;
     runOptions: z.ZodDefault<z.ZodDiscriminatedUnion<"environment", [z.ZodObject<{
         environment: z.ZodLiteral<"standalone">;
@@ -726,9 +729,9 @@ export declare const runApiParametersSchema: z.ZodObject<{
             type: "state";
             state?: {
                 cookies: {
-                    path: string;
                     value: string;
                     name: string;
+                    path: string;
                     domain: string;
                     expires: number;
                     httpOnly: boolean;
@@ -751,6 +754,7 @@ export declare const runApiParametersSchema: z.ZodObject<{
                 }[] | undefined;
             } | null | undefined;
         };
+        runCheck: boolean;
     } | undefined;
 }, {
     automationFunction: {
@@ -771,9 +775,9 @@ export declare const runApiParametersSchema: z.ZodObject<{
             type: "state";
             state?: {
                 cookies: {
-                    path: string;
                     value: string;
                     name: string;
+                    path: string;
                     domain: string;
                     expires: number;
                     httpOnly: boolean;
@@ -796,6 +800,7 @@ export declare const runApiParametersSchema: z.ZodObject<{
                 }[] | undefined;
             } | null | undefined;
         };
+        runCheck?: boolean | undefined;
     } | undefined;
     runOptions?: {
         environment: "standalone";
@@ -832,4 +837,3 @@ export type RunApiResultWithSessionOk<R = any> = RunApiResultOk<R> & {
     session: RunApiStorageState;
 };
 export type RunApiResult<R = any, FullResult extends RunApiResultOk<R> = RunApiResultOk<R>> = Result<FullResult, RunAutomationError>;
-export type { ImportFunction } from "./importUsingImportFunction";

package/dist/common/runApi/types.js

@@ -53,7 +53,8 @@ const runApiParametersSchema = exports.runApiParametersSchema = _zod.default.obj
     enabled: false
   }),
   auth: _zod.default.object({
-    session: runApiSessionSchema
+    session: runApiSessionSchema,
+    runCheck: _zod.default.boolean().default(false)
   }).optional(),
   runOptions: _zod.default.discriminatedUnion("environment", [_zod.default.object({
     environment: _zod.default.literal("standalone"),

package/dist/index.d.ts

@@ -1,3 +1,4 @@
-export { extendPayload, extendTimeout, runInfo, RunError, getAuthSessionParameters, store, } from "./runtime";
+export { extendPayload, extendTimeout, runInfo, RunError, requestMultipleChoice, requestOTP, getAuthSessionParameters, } from "./runtime";
 export { runWithContext, getExecutionContext, } from "./common/asyncLocalStorage";
 export { getDownloadDirectoryPath } from "./runtime/downloadDirectory";
+export { getProductionPlaywrightConstructs } from "./common/getPlaywrightConstructs";

package/dist/index.js

@@ -39,24 +39,37 @@ Object.defineProperty(exports, "getExecutionContext", {
     return _asyncLocalStorage.getExecutionContext;
   }
 });
-Object.defineProperty(exports, "runInfo", {
+Object.defineProperty(exports, "getProductionPlaywrightConstructs", {
   enumerable: true,
   get: function () {
-    return _runtime.runInfo;
+    return _getPlaywrightConstructs.getProductionPlaywrightConstructs;
   }
 });
-Object.defineProperty(exports, "runWithContext", {
+Object.defineProperty(exports, "requestMultipleChoice", {
   enumerable: true,
   get: function () {
-    return _asyncLocalStorage.runWithContext;
+    return _runtime.requestMultipleChoice;
+  }
+});
+Object.defineProperty(exports, "requestOTP", {
+  enumerable: true,
+  get: function () {
+    return _runtime.requestOTP;
   }
 });
-Object.defineProperty(exports, "store", {
+Object.defineProperty(exports, "runInfo", {
+  enumerable: true,
+  get: function () {
+    return _runtime.runInfo;
+  }
+});
+Object.defineProperty(exports, "runWithContext", {
   enumerable: true,
   get: function () {
-    return _runtime.store;
+    return _asyncLocalStorage.runWithContext;
   }
 });
 var _runtime = require("./runtime");
 var _asyncLocalStorage = require("./common/asyncLocalStorage");
-var _downloadDirectory = require("./runtime/downloadDirectory");
+var _downloadDirectory = require("./runtime/downloadDirectory");
+var _getPlaywrightConstructs = require("./common/getPlaywrightConstructs");