@intuned/runtime-dev 1.3.27-dev7 → 1.3.28-dev1

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # UNRELEASED
 
+# 1.3.27
+
+- add profile templates support
+
 # 1.3.26
 
 - change default browser dimensions

package/dist/common/launchBrowser.d.ts

@@ -1,6 +1,7 @@
 /// <reference types="node" />
 import * as playwright from "playwright";
 import { Result } from "neverthrow";
+import type { ProfileMode } from "@intuned/runtime-interface";
 export declare function getEncryptedProfileChromeArgs({ encryptedProfile, platform, disableMacKeychainPrompts, }: {
     encryptedProfile?: boolean;
     platform?: NodeJS.Platform;
@@ -30,6 +31,7 @@ export type LaunchChromiumStandaloneOptions = {
     ignoreHttpErrors?: boolean;
     profileTemplatePath?: string;
     encryptedProfile?: boolean;
+    profileMode?: ProfileMode;
     timeout?: number;
 };
 export type LaunchChromiumCdpOptions = {
@@ -37,6 +39,7 @@ export type LaunchChromiumCdpOptions = {
     cdpTargetId?: string;
     profileTemplatePath?: string;
     encryptedProfile?: boolean;
+    profileMode?: ProfileMode;
     timeout?: number;
 };
 export declare function launchChromium(options: LaunchChromiumStandaloneOptions): Promise<LaunchBrowserResult>;

package/dist/common/launchBrowser.js

@@ -50,7 +50,21 @@ const DEFAULT_USER_PREFERENCES = {
     password_manager_enabled: false
   }
 };
-async function createUserDirWithPreferences(profileTemplatePath) {
+async function createUserDirWithPreferences(profileTemplatePath, profileMode = "persistent") {
+  if (profileMode === "persistent" && profileTemplatePath && (await fs.pathExists(profileTemplatePath))) {
+    const defaultDir = (0, _path.join)(profileTemplatePath, "Default");
+    const preferencesPath = (0, _path.join)(defaultDir, "Preferences");
+    await (0, _fsExtra.mkdir)(defaultDir, {
+      recursive: true
+    });
+    if (!(await fs.pathExists(preferencesPath))) {
+      await (0, _fsExtra.writeFile)(preferencesPath, JSON.stringify(DEFAULT_USER_PREFERENCES));
+    }
+    return {
+      userDir: profileTemplatePath,
+      ephemeral: false
+    };
+  }
   const playwrightTempDir = await (0, _fsExtra.mkdtemp)("/tmp/pw-");
   const userDir = (0, _path.join)(playwrightTempDir, "userdir");
   const defaultDir = (0, _path.join)(userDir, "Default");
@@ -73,13 +87,19 @@ async function createUserDirWithPreferences(profileTemplatePath) {
     }
     const mergedPreferences = mergePreferences(templatePreferences, DEFAULT_USER_PREFERENCES);
     await (0, _fsExtra.writeFile)(preferencesPath, JSON.stringify(mergedPreferences));
-    return userDir;
+    return {
+      userDir,
+      ephemeral: true
+    };
   }
   await (0, _fsExtra.mkdir)(defaultDir, {
     recursive: true
   });
   await (0, _fsExtra.writeFile)(preferencesPath, JSON.stringify(DEFAULT_USER_PREFERENCES));
-  return userDir;
+  return {
+    userDir,
+    ephemeral: true
+  };
 }
 function isPlainObject(value) {
   return typeof value === "object" && value !== null && !Array.isArray(value);
@@ -152,6 +172,7 @@ async function launchChromium(options) {
     ignoreHttpErrors: ignoreHttpErrorsParam,
     profileTemplatePath,
     encryptedProfile,
+    profileMode,
     timeout
   } = options;
   let {
@@ -168,7 +189,10 @@ async function launchChromium(options) {
   if (stealthConfig.enabled) {
     extraArgs.push("--stealth-mode");
   }
-  const userDataDir = await createUserDirWithPreferences(profileTemplatePath);
+  const {
+    userDir: userDataDir,
+    ephemeral: shouldCleanupUserDir
+  } = await createUserDirWithPreferences(profileTemplatePath, profileMode);
   if ((0, _extensionsHelpers.isIntunedExtensionLoaded)()) {
     const extensionsList = (0, _extensionsHelpers.buildExtensionsList)();
     const extensions = extensionsList.join(",");
@@ -224,12 +248,14 @@ async function launchChromium(options) {
   }
   context.once("close", async () => {
     try {
-      await (0, _fsExtra.rm)(userDataDir, {
-        recursive: true,
-        force: true,
-        retryDelay: 1000,
-        maxRetries: 5
-      });
+      if (shouldCleanupUserDir) {
+        await (0, _fsExtra.rm)(userDataDir, {
+          recursive: true,
+          force: true,
+          retryDelay: 1000,
+          maxRetries: 5
+        });
+      }
       if (await (0, _extensionsHelpers.isIntunedExtensionEnabled)()) {
         await (0, _intunedExtensionServer.cleanIntunedExtensionServer)();
       }

package/dist/common/playwrightContext.d.ts

@@ -1,7 +1,7 @@
 import type * as playwright from "playwright";
 import { Err, Ok } from "neverthrow";
 import { type Proxy } from "./launchBrowser";
-import { ImportFunction, RunAutomationError, RunApiSession } from "@intuned/runtime-interface";
+import { ImportFunction, RunAutomationError, RunApiSession, type ProfileMode } from "@intuned/runtime-interface";
 type WithPlaywrightContextParameters = {
     importFunction: ImportFunction;
     apiName: string;
@@ -20,12 +20,14 @@ export declare function withPlaywrightContext<R>(options: {
     ignoreHttpErrors?: boolean;
     profileTemplatePath?: string;
     encryptedProfile?: boolean;
+    profileMode?: ProfileMode;
 } & WithPlaywrightContextParameters, fn: WithPlaywrightContextWrappedFunction<R>): Promise<Ok<R, any> | Err<any, RunAutomationError>>;
 export declare function withPlaywrightContext<R>(options: {
     cdpAddress: string;
     cdpTargetId?: string;
     profileTemplatePath?: string;
     encryptedProfile?: boolean;
+    profileMode?: ProfileMode;
 } & WithPlaywrightContextParameters, fn: WithPlaywrightContextWrappedFunction<R>): Promise<Ok<R, any> | Err<any, RunAutomationError>>;
 export declare function loadSessionToContext({ context, session, }: {
     context: playwright.BrowserContext;

package/dist/common/playwrightContext.js

@@ -23,6 +23,7 @@ async function withPlaywrightContext({
   ignoreHttpErrors: cliIgnoreHttpErrors,
   profileTemplatePath,
   encryptedProfile,
+  profileMode,
   importFunction,
   apiName,
   apiParameters
@@ -47,7 +48,8 @@ async function withPlaywrightContext({
           cdpAddress,
           cdpTargetId,
           profileTemplatePath,
-          encryptedProfile
+          encryptedProfile,
+          profileMode
         }));
       } else {
         ({
@@ -59,7 +61,8 @@ async function withPlaywrightContext({
           downloadsPath,
           ignoreHttpErrors,
           profileTemplatePath,
-          encryptedProfile
+          encryptedProfile,
+          profileMode
         }));
       }
       return await fn(context, page);
@@ -74,7 +77,8 @@ async function withPlaywrightContext({
         cdpAddress,
         cdpTargetId,
         profileTemplatePath,
-        encryptedProfile
+        encryptedProfile,
+        profileMode
       }));
     } else {
       const port = await (0, _portfinder.getPort)({
@@ -90,7 +94,8 @@ async function withPlaywrightContext({
         cdpPort: port,
         ignoreHttpErrors,
         profileTemplatePath,
-        encryptedProfile
+        encryptedProfile,
+        profileMode
       }));
       hookCdpUrl = (0, _launchBrowser.getLocalCdpAddress)(port);
     }

package/dist/common/runApi/index.js

@@ -150,6 +150,7 @@ async function runApi({
           ignoreHttpErrors: runOptions.ignoreHttpErrors,
           profileTemplatePath: runOptions.profileTemplatePath,
           encryptedProfile: runOptions.encryptedProfile,
+          profileMode: runOptions.profileMode,
           ...playwrightContextParameters
         }, runAutomationWithContext);
       } finally {
@@ -161,6 +162,7 @@ async function runApi({
         cdpTargetId: runOptions.cdpTargetId,
         profileTemplatePath: runOptions.profileTemplatePath,
         encryptedProfile: runOptions.encryptedProfile,
+        profileMode: runOptions.profileMode,
         ...playwrightContextParameters
       }, runAutomationWithContext);
     }

package/dist/vendor/runtime-interface.js

@@ -165,7 +165,7 @@ var require_types = __commonJS({
       return mod && mod.__esModule ? mod : { "default": mod };
     };
     Object.defineProperty(exports2, "__esModule", { value: true });
-    exports2.outputRunApiSchema = exports2.pongMessageSchema = exports2.doneMessageSchema = exports2.extendMessageSchema = exports2.runApiInputSchema = exports2.pingSchema = exports2.tokenUpdateSchema = exports2.abortRunApiSchema = exports2.startRunApiSchema = exports2.startRunApiParametersSchema = exports2.runApiParametersSchema = exports2.runApiRunOptionsSchema = exports2.runApiCdpRunOptionsSchema = exports2.runApiStandaloneRunOptionsSchema = exports2.runApiProxySchema = exports2.runApiAuthSchema = exports2.runApiTracingSchema = exports2.runApiAutomationFunctionSchema = exports2.runApiSessionSchema = exports2.runApiStorageStateSchema = void 0;
+    exports2.outputRunApiSchema = exports2.pongMessageSchema = exports2.doneMessageSchema = exports2.extendMessageSchema = exports2.runApiInputSchema = exports2.pingSchema = exports2.tokenUpdateSchema = exports2.abortRunApiSchema = exports2.startRunApiSchema = exports2.startRunApiParametersSchema = exports2.runApiParametersSchema = exports2.runApiRunOptionsSchema = exports2.runApiCdpRunOptionsSchema = exports2.runApiStandaloneRunOptionsSchema = exports2.profileModeSchema = exports2.runApiProxySchema = exports2.runApiAuthSchema = exports2.runApiTracingSchema = exports2.runApiAutomationFunctionSchema = exports2.runApiSessionSchema = exports2.runApiStorageStateSchema = void 0;
     exports2.runApiResultOkSchema = runApiResultOkSchema;
     exports2.runApiResultWithSessionOkSchema = runApiResultWithSessionOkSchema;
     var zod_1 = __importDefault(require("zod"));
@@ -222,20 +222,23 @@ var require_types = __commonJS({
       username: zod_1.default.string(),
       password: zod_1.default.string()
     });
+    exports2.profileModeSchema = zod_1.default.enum(["isolated", "persistent"]).default("persistent");
     exports2.runApiStandaloneRunOptionsSchema = zod_1.default.object({
       environment: zod_1.default.literal("standalone"),
       headless: zod_1.default.boolean().default(true),
       proxy: exports2.runApiProxySchema.optional(),
       ignoreHttpErrors: zod_1.default.boolean().optional(),
       profileTemplatePath: zod_1.default.string().optional(),
-      encryptedProfile: zod_1.default.boolean().optional()
+      encryptedProfile: zod_1.default.boolean().optional(),
+      profileMode: exports2.profileModeSchema
     });
     exports2.runApiCdpRunOptionsSchema = zod_1.default.object({
       environment: zod_1.default.literal("cdp"),
       cdpAddress: zod_1.default.string(),
       cdpTargetId: zod_1.default.string().optional(),
       profileTemplatePath: zod_1.default.string().optional(),
-      encryptedProfile: zod_1.default.boolean().optional()
+      encryptedProfile: zod_1.default.boolean().optional(),
+      profileMode: exports2.profileModeSchema
     });
     exports2.runApiRunOptionsSchema = zod_1.default.discriminatedUnion("environment", [
       exports2.runApiStandaloneRunOptionsSchema,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@intuned/runtime-dev",
-  "version": "1.3.27-dev7",
+  "version": "1.3.28-dev1",
   "description": "Intuned runtime",
   "packageManager": "yarn@4.12.0",
   "main": "./dist/index.js",