sfdx-browserforce-plugin 5.2.0-next.5 → 6.0.0-next.10

package/README.md

@@ -1,9 +1,12 @@
 # sfdx-browserforce-plugin
 
-> sfdx plugin to apply settings in the Salesforce Setup Menu using browser automation
+> sf plugin to apply settings in the Salesforce Setup Menu using browser automation
 
 [![Actions Status](https://github.com/amtrack/sfdx-browserforce-plugin/actions/workflows/default.yml/badge.svg?branch=main)](https://github.com/amtrack/sfdx-browserforce-plugin/actions?query=branch:main)
 
+> [!NOTE]
+> Since v6 we're using Playwright instead of Puppeteer. Please see the [MIGRATION](./docs/MIGRATION.md) guide.
+
 ✅ Most settings in the Salesforce Setup Menu are represented as [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm) in the Metadata API.
 
 For example, the highlighted checkbox "Show View Hierarchy link on account pages" in Account Settings is indeed represented in the Metadata `AccountSettings` as `showViewHierarchyLink`.
@@ -24,7 +27,7 @@ For example, the Currency Locale in `Setup -> Company Settings -> Company Inform
 
 👉 This is where Browserforce (sfdx-browserforce-plugin) comes to the rescue. It fills this gap by applying these unsupported settings through browser automation!
 
-# Example
+## Example
 
 To change the Currency Locale, the Browserforce config file (here: `./config/currency.json`) looks like this:
 
@@ -44,19 +47,19 @@ Apply the config:
 ```console
 $ sf browserforce apply -f ./config/currency.json --target-org myOrg@example.com
   logging in... done
-  Applying definition file ./config/currency.json to org myOrg@example.com
+  Applying config file ./config/currency.json to org myOrg@example.com
   [CompanyInformation] retrieving state... done
   [CompanyInformation] changing 'defaultCurrencyIsoCode' to '"English (South Africa) - ZAR"'... done
   logging out... done
 ```
 
-# Key Concepts
+## Key Concepts
 
 - 🔧 configuration using JSON Schema (similar to the [Scratch Org Definition Configuration](https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_scratch_orgs_def_file.htm))
 - 🧠 idempotency of the `apply` command only applies what's necessary and allows re-execution (concept similar to [terraform](https://www.terraform.io/docs/commands/apply.html))
 - 🏎️ browser automation powered by Playwright, [learn more about Playwright and Browserforce](#playwright)
 
-# Supported Browserforce Settings
+## Supported Browserforce Settings
 
 Top settings:
 
@@ -75,129 +78,105 @@ But there's more:
 - Please see the [Browserforce Settings](https://github.com/amtrack/sfdx-browserforce-plugin/wiki/Browserforce-Settings) wiki page with screenshots.
 - Explore the JSON schema powered configuration using a [full-blown example](https://github.dev/amtrack/sfdx-browserforce-plugin/blob/main/examples/full.json) or start with an [empty configuration](https://github.dev/amtrack/sfdx-browserforce-plugin/blob/main/examples/empty.json).
 
-# Installation
-
-There are several different methods to install `sfdx-browserforce-plugin`:
+## Installation
 
-```console
-# as an sf plugin globally
+```shell
 sf plugins install sfdx-browserforce-plugin
+```
 
-# or standalone globally
-npm install --global sfdx-browserforce-plugin
+> [!IMPORTANT]
+> Playwright does not come with a browser automatically
 
-# or standalone locally (as a dependency in your Node.js project)
-npm install --save-dev sfdx-browserforce-plugin
-```
+You might need to install a browser explicitly or configure Browserforce to use an existing browser.
 
-# Usage
+> [!TIP]
+> If you're using Browserforce on GitHub Actions with the `ubuntu-latest` (v24) Docker image, we can use the preinstalled Google Chrome automatically.
+> No further configuration and installation needed, because the `CHROME_BIN` environment variable is already set.
 
-Depending on your choice of installation, you can find the `browserforce` namespace:
+### Option 1: Install a browser using our Playwright wrapper command
 
-```console
-# globally in the sf cli
-sf browserforce
+```shell
+sf browserforce playwright -- install chromium
+```
+
+> [!IMPORTANT]
+> The two hyphens `--` are intentional and separate the sf command from the arguments to be passed to the playwright executable.
+
+### Option 2: Configure Browserforce to use an existing browser
 
-# globally in the sfdx-browserforce-plugin executable
-sfdx-browserforce-plugin browserforce
+You can use one of the following environment variables:
 
-# locally in the sfdx-browserforce-plugin executable (npx is awesome!)
-npx sfdx-browserforce-plugin browserforce
+```shell
+PLAYWRIGHT_BROWSER_CHANNEL="chrome"
+PLAYWRIGHT_BROWSER_CHANNEL="chromium"
+# or
+PLAYWRIGHT_EXECUTABLE_PATH="/usr/bin/google-chrome"
+CHROME_BIN="/usr/bin/google-chrome"
 ```
 
+## Usage
+
 ```console
-$ sfdx-browserforce browserforce -h
-browser automation
+$ sf browserforce -h
+browser automation for Salesforce setup pages
 
 USAGE
-  $ sfdx-browserforce-plugin browserforce COMMAND
+  $ sf browserforce COMMAND
 
 COMMANDS
-  browserforce apply  apply a plan from a definition file
-  browserforce plan   retrieve state and generate plan file
+  browserforce apply        apply a plan from a config file
+  browserforce playwright   access the Playwright CLI
 ```
 
-Both the `browserforce apply` and `browserforce plan` commands expect a config file and a target username or alias for the org.
+Both the `apply` and `plan` commands expect a config file and a target username or alias for the org.
 
-# Environment Variables
+## Environment Variables
 
-- `BROWSER_DEBUG` run in non-headless mode (default: `false`)
+- `PLAYWRIGHT_BROWSER_CHANNEL`: let Playwright figure out the path to a browser (`chromium` or `chrome`)
+- `PLAYWRIGHT_EXECUTABLE_PATH` or `CHROME_BIN`: point Playwright to a specific browser executable (e.g. `/usr/bin/google-chrome`)
+- `BROWSERFORCE_HEADLESS`: run in headless mode (default: `true`)
 - `BROWSERFORCE_NAVIGATION_TIMEOUT_MS`: adjustable for slow internet connections (default: `90000`)
 - `BROWSERFORCE_RETRY_MAX_RETRIES`: number of retries on failures opening a page (default: `4`)
 - `BROWSERFORCE_RETRY_TIMEOUT_MS`: initial time between retries in exponential mode (default: `4000`)
 
-# Migration to Playwright
-
-**Important Notice for Next Version Release:**
-
-This project is transitioning from Puppeteer to Playwright for browser automation. The migration is planned for the next major version release.
+## Playwright
 
-## What This Means for Users
+We use [Playwright](https://playwright.dev/) for browser automation.
 
-### Current Version (Puppeteer-based)
-- Continues to work as expected
-- No action required from users
-- Maintained for stability
+For more information on browser automation best practices, see the [Playwright documentation](./docs/PLAYWRIGHT.md).
 
-### Next Version (Playwright-based)
-The upcoming release will include:
+## Alternative Installation
 
-1. **Improved Reliability**: Playwright offers better auto-waiting and more robust element interaction
-2. **Better Frame Support**: Native iframe handling without workarounds
-3. **Enhanced Debugging**: Built-in trace viewer and inspector tools
-4. **Modern API**: More intuitive locator-based API
+You can also install the `sfdx-browserforce-plugin` NPM package without `sf`. The package exports a `sfdx-browserforce-plugin` executable:
 
-### Migration Actions Required
+Example:
 
-**For Plugin Developers:**
-If you've created custom plugins or extended this project:
-
-1. **Update Browser Automation Code**:
-   - Replace `page.$()` with `page.locator()`
-   - Replace `page.$$()` with `page.locator().all()`
-   - Update `ElementHandle` references to `Locator`
-   - Review frame handling code (Playwright has better native support)
-
-2. **Update Dependencies**:
-   - Remove `puppeteer` dependency
-   - Add `playwright` or `@playwright/test` dependency
-
-3. **Review Documentation**:
-   - See [`docs/PLAYWRIGHT.md`](docs/PLAYWRIGHT.md) for best practices
-
-**For End Users:**
-- No configuration changes required
-- Browser download process remains similar
-- Environment variables remain compatible
-- All existing configuration files will continue to work
-
-# Playwright
-
-We use [Playwright](https://playwright.dev/) for browser automation which comes with its own Chromium browser.
-
-The Playwright [installation guide](https://playwright.dev/docs/intro) describes how this works:
-
-> Playwright comes with bundled browser binaries for Chromium, Firefox, and WebKit. When you install Playwright, it automatically downloads the Chromium browser to ensure consistent automation across different environments. The browser is downloaded to the OS-specific cache directory.
-
-In most cases this just works! If you want to skip the download and use another browser installation, you can do this as follows:
+```shell
+npm install --save-dev sfdx-browserforce-plugin
+npx sfdx-browserforce-plugin browserforce -h
+```
 
+## Troubleshooting
 
-For more information on browser automation best practices, see the [Playwright documentation](docs/PLAYWRIGHT.md).
+If no browser is installed or launching fails, you'll get an error message from Playwright with a suggestion.
 
-Troubleshooting:
+Typically this will guide you to install a browser.
+If you've installed sfdx-browserforce-plugin using `sf`, you can replace the following:
 
-- The installation is triggered via the `postinstall` hook of npm/yarn. If you've disabled running scripts with npm (`--ignore-scripts` or via config file), it will not download the browser.
-- If you encounter issues with browser downloads, you can manually install browsers with: `npx playwright install chromium`
+```diff
+- npx playwright install chromium
++ sf browserforce playwright -- install chromium
+```
 
-# Contributing
+## Contributing
 
 Please see [CONTRIBUTING.md](CONTRIBUTING.md) for getting started.
 
-# Sponsors
+## Sponsors
 
 - [PARX](https://www.parx.com)
 - [IPfolio](https://www.ipfolio.com)
 
-# License
+## License
 
 MIT © [Matthias Rolke](mailto:mr.amtrack@gmail.com)

package/lib/browserforce-command.d.ts

@@ -4,12 +4,23 @@ export declare abstract class BrowserforceCommand<T> extends SfCommand<T> {
     static baseFlags: {
         'target-org': import("@oclif/core/interfaces").OptionFlag<import("@salesforce/core").Org, import("@oclif/core/interfaces").CustomOptions>;
         definitionfile: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
-        planfile: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
-        statefile: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        'dry-run': import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        headless: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        'slow-mo': import("@oclif/core/interfaces").OptionFlag<number, import("@oclif/core/interfaces").CustomOptions>;
+        timeout: import("@oclif/core/interfaces").OptionFlag<number, import("@oclif/core/interfaces").CustomOptions>;
+        trace: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        exe: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        channel: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        'max-retries': import("@oclif/core/interfaces").OptionFlag<number, import("@oclif/core/interfaces").CustomOptions>;
+        'retry-timeout': import("@oclif/core/interfaces").OptionFlag<number, import("@oclif/core/interfaces").CustomOptions>;
         'flags-dir': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
     };
-    protected bf: Browserforce;
+    protected browserforce: Browserforce;
     protected settings: any[];
+    protected retryConfig?: {
+        retries: number;
+        minTimeout: number;
+    };
     init(): Promise<void>;
     finally(err?: Error): Promise<void>;
 }

package/lib/browserforce-command.js

@@ -1,6 +1,7 @@
 import { Flags, SfCommand, Ux } from '@salesforce/sf-plugins-core';
 import { promises } from 'fs';
 import * as path from 'path';
+import { chromium } from 'playwright';
 import { Browserforce } from './browserforce.js';
 import { ConfigParser } from './config-parser.js';
 import { handleDeprecations } from './plugins/deprecated.js';
@@ -11,21 +12,69 @@ export class BrowserforceCommand extends SfCommand {
         'target-org': Flags.requiredOrg(),
         definitionfile: Flags.string({
             char: 'f',
-            description: 'path to a browserforce state file',
+            description: 'path to a browserforce config file',
         }),
-        planfile: Flags.string({
-            char: 'p',
-            name: 'plan',
-            description: 'path to a browserforce plan file',
+        'dry-run': Flags.boolean({
+            char: 'd',
+            description: 'dry run',
+            env: 'BROWSERFORCE_DRY_RUN',
         }),
-        statefile: Flags.string({
-            char: 's',
-            name: 'state',
-            description: 'path to a browserforce definition file\nThe schema is similar to the scratch org definition file.\nSee https://github.com/amtrack/sfdx-browserforce-plugin#supported-org-preferences for supported values.',
+        // browser configuration
+        headless: Flags.boolean({
+            helpGroup: 'Browser Configuration',
+            summary: 'run in headless mode (default: true)',
+            allowNo: true,
+            env: 'BROWSERFORCE_HEADLESS',
+            default: !(process.env.BROWSER_DEBUG === 'true'), // for backwards-compatibility
+        }),
+        'slow-mo': Flags.integer({
+            helpGroup: 'Browser Configuration',
+            summary: 'slow motion in milliseconds (default: 0)',
+            env: 'BROWSERFORCE_SLOWMO',
+            default: Number(process.env.BROWSER_SLOWMO ?? '0'), // for backwards-compatibility
+        }),
+        timeout: Flags.integer({
+            helpGroup: 'Browser Configuration',
+            summary: 'the default navigation timeout in milliseconds',
+            env: 'BROWSERFORCE_NAVIGATION_TIMEOUT_MS',
+            default: 90_000,
+        }),
+        trace: Flags.boolean({
+            helpGroup: 'Browser Configuration',
+            summary: 'create a playwright trace',
+            description: 'The trace-date.zip file can be viewed with sf browserforce playwright show-trace trace-date.zip.',
+            env: 'PLAYWRIGHT_TRACE',
+        }),
+        exe: Flags.string({
+            helpGroup: 'Browser Configuration',
+            summary: 'the path to a browser executable',
+            description: 'on GitHub Actions with ubuntu-latest, this is set to /usr/bin/google-chrome',
+            env: 'PLAYWRIGHT_EXECUTABLE_PATH',
+            default: process.env.CHROME_BIN?.length ? process.env.CHROME_BIN : undefined,
+        }),
+        channel: Flags.string({
+            helpGroup: 'Browser Configuration',
+            summary: 'the channel (e.g. chromium or chrome) to use',
+            description: 'Playwright will try to figure out the path to the browser executable automatically.',
+            env: 'PLAYWRIGHT_BROWSER_CHANNEL',
+        }),
+        // retry config
+        'max-retries': Flags.integer({
+            helpGroup: 'Retry Configuration',
+            summary: 'the maximum number of retries for retryable actions',
+            env: 'BROWSERFORCE_RETRY_MAX_RETRIES',
+            default: 6,
+        }),
+        'retry-timeout': Flags.integer({
+            helpGroup: 'Retry Configuration',
+            summary: 'the inital timeout in milliseconds for retryable actions (exponentially increased)',
+            env: 'BROWSERFORCE_RETRY_TIMEOUT_MS',
+            default: 4_000,
         }),
     };
-    bf;
+    browserforce;
     settings;
+    retryConfig;
     async init() {
         await super.init();
         const { flags } = await this.parse({
@@ -38,24 +87,75 @@ export class BrowserforceCommand extends SfCommand {
                 definition = JSON.parse(definitionFileData);
             }
             catch (err) {
-                throw new Error('Failed parsing definitionfile');
+                throw new Error('Failed parsing config file');
             }
         }
         handleDeprecations(definition);
-        // TODO: use require.resolve to dynamically load plugins from npm packages
         this.settings = ConfigParser.parse(DRIVERS, definition);
-        this.bf = new Browserforce(flags['target-org'], new Ux({ jsonEnabled: this.jsonEnabled() }));
+        const connection = flags['target-org'].getConnection();
+        const browserContext = await createBrowserContextFromFlags(flags);
+        const options = {
+            logger: new Ux({ jsonEnabled: this.jsonEnabled() }),
+            ...createRetryOptionsFromFlags(flags),
+        };
+        this.browserforce = new Browserforce(connection, browserContext, options);
         this.spinner.start('logging in');
-        await this.bf.login();
+        await this.browserforce.browserContext.tracing.group('login');
+        await this.browserforce.login();
         this.spinner.stop();
+        await this.browserforce.browserContext.tracing.groupEnd();
     }
     async finally(err) {
-        this.spinner.stop(err?.message);
-        if (this.bf) {
+        this.spinner.stop(err?.toString());
+        if (err?.cause instanceof Error) {
+            this.logToStderr(`Cause: ${err.cause.toString()}`);
+        }
+        if (this.browserforce) {
             this.spinner.start('logging out');
-            await this.bf.logout();
+            try {
+                const timestamp = new Date().toISOString().replace(/[:.]/g, '-');
+                const tracePath = `trace-${timestamp}.zip`;
+                await this.browserforce.browserContext.tracing.stop({ path: tracePath });
+                this.logToStderr(`Playwright trace saved to: ${tracePath}`);
+            }
+            catch (_) { }
+            await this.browserforce.browserContext.browser().close();
             this.spinner.stop();
         }
     }
 }
+async function createBrowserContextFromFlags(flags) {
+    const browser = await chromium.launch({
+        ...(flags.channel
+            ? {
+                channel: flags.channel,
+            }
+            : {}),
+        ...(flags.exe
+            ? {
+                executablePath: flags.exe,
+            }
+            : {}),
+        headless: flags.headless,
+        slowMo: flags['slow-mo'],
+    });
+    const browserContext = await browser.newContext({
+        viewport: { width: 1280, height: 1536 },
+    });
+    browserContext.setDefaultNavigationTimeout(flags.timeout);
+    if (flags.trace) {
+        await browserContext.tracing.start({
+            screenshots: true,
+            snapshots: true,
+            sources: true,
+        });
+    }
+    return browserContext;
+}
+function createRetryOptionsFromFlags(flags) {
+    return {
+        retries: flags['max-retries'],
+        minTimeout: flags['retry-timeout'],
+    };
+}
 //# sourceMappingURL=browserforce-command.js.map

package/lib/browserforce-command.js.map

@@ -1 +1 @@
-{"version":3,"file":"browserforce-command.js","sourceRoot":"","sources":["../src/browserforce-command.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,EAAE,EAAE,MAAM,6BAA6B,CAAC;AACnE,OAAO,EAAE,QAAQ,EAAE,MAAM,IAAI,CAAC;AAC9B,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,KAAK,OAAO,MAAM,oBAAoB,CAAC;AAE9C,MAAM,OAAgB,mBAAuB,SAAQ,SAAY;IAC/D,MAAM,CAAC,SAAS,GAAG;QACjB,GAAG,SAAS,CAAC,SAAS;QACtB,YAAY,EAAE,KAAK,CAAC,WAAW,EAAE;QACjC,cAAc,EAAE,KAAK,CAAC,MAAM,CAAC;YAC3B,IAAI,EAAE,GAAG;YACT,WAAW,EAAE,mCAAmC;SACjD,CAAC;QACF,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC;YACrB,IAAI,EAAE,GAAG;YACT,IAAI,EAAE,MAAM;YACZ,WAAW,EAAE,kCAAkC;SAChD,CAAC;QACF,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC;YACtB,IAAI,EAAE,GAAG;YACT,IAAI,EAAE,OAAO;YACb,WAAW,EACT,4MAA4M;SAC/M,CAAC;KACH,CAAC;IACQ,EAAE,CAAe;IACjB,QAAQ,CAAQ;IAEnB,KAAK,CAAC,IAAI;QACf,MAAM,KAAK,CAAC,IAAI,EAAE,CAAC;QACnB,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC;YACjC,SAAS,EAAE,mBAAmB,CAAC,SAAS;SACzC,CAAC,CAAC;QACH,IAAI,UAAU,CAAC;QACf,IAAI,KAAK,CAAC,cAAc,EAAE,CAAC;YACzB,MAAM,kBAAkB,GAAG,MAAM,QAAQ,CAAC,QAAQ,CAChD,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,cAAc,CAAC,EAClC,MAAM,CACP,CAAC;YACF,IAAI,CAAC;gBACH,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;YAC9C,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;YACnD,CAAC;QACH,CAAC;QACD,kBAAkB,CAAC,UAAU,CAAC,CAAC;QAC/B,0EAA0E;QAC1E,IAAI,CAAC,QAAQ,GAAG,YAAY,CAAC,KAAK,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;QACxD,IAAI,CAAC,EAAE,GAAG,IAAI,YAAY,CACxB,KAAK,CAAC,YAAY,CAAC,EACnB,IAAI,EAAE,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC,CAC5C,CAAC;QACF,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QACjC,MAAM,IAAI,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC;QACtB,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;IACtB,CAAC;IAEM,KAAK,CAAC,OAAO,CAAC,GAAW;QAC9B,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QAChC,IAAI,IAAI,CAAC,EAAE,EAAE,CAAC;YACZ,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;YAClC,MAAM,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC;YACvB,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;QACtB,CAAC;IACH,CAAC"}
+{"version":3,"file":"browserforce-command.js","sourceRoot":"","sources":["../src/browserforce-command.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,EAAE,EAAE,MAAM,6BAA6B,CAAC;AACnE,OAAO,EAAE,QAAQ,EAAE,MAAM,IAAI,CAAC;AAC9B,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,KAAK,OAAO,MAAM,oBAAoB,CAAC;AAE9C,MAAM,OAAgB,mBAAuB,SAAQ,SAAY;IAC/D,MAAM,CAAC,SAAS,GAAG;QACjB,GAAG,SAAS,CAAC,SAAS;QACtB,YAAY,EAAE,KAAK,CAAC,WAAW,EAAE;QACjC,cAAc,EAAE,KAAK,CAAC,MAAM,CAAC;YAC3B,IAAI,EAAE,GAAG;YACT,WAAW,EAAE,oCAAoC;SAClD,CAAC;QACF,SAAS,EAAE,KAAK,CAAC,OAAO,CAAC;YACvB,IAAI,EAAE,GAAG;YACT,WAAW,EAAE,SAAS;YACtB,GAAG,EAAE,sBAAsB;SAC5B,CAAC;QACF,wBAAwB;QACxB,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC;YACtB,SAAS,EAAE,uBAAuB;YAClC,OAAO,EAAE,sCAAsC;YAC/C,OAAO,EAAE,IAAI;YACb,GAAG,EAAE,uBAAuB;YAC5B,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,KAAK,MAAM,CAAC,EAAE,8BAA8B;SACjF,CAAC;QACF,SAAS,EAAE,KAAK,CAAC,OAAO,CAAC;YACvB,SAAS,EAAE,uBAAuB;YAClC,OAAO,EAAE,0CAA0C;YACnD,GAAG,EAAE,qBAAqB;YAC1B,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,IAAI,GAAG,CAAC,EAAE,8BAA8B;SACnF,CAAC;QACF,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC;YACrB,SAAS,EAAE,uBAAuB;YAClC,OAAO,EAAE,gDAAgD;YACzD,GAAG,EAAE,oCAAoC;YACzC,OAAO,EAAE,MAAM;SAChB,CAAC;QACF,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC;YACnB,SAAS,EAAE,uBAAuB;YAClC,OAAO,EAAE,2BAA2B;YACpC,WAAW,EAAE,kGAAkG;YAC/G,GAAG,EAAE,kBAAkB;SACxB,CAAC;QACF,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC;YAChB,SAAS,EAAE,uBAAuB;YAClC,OAAO,EAAE,kCAAkC;YAC3C,WAAW,EAAE,6EAA6E;YAC1F,GAAG,EAAE,4BAA4B;YACjC,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS;SAC7E,CAAC;QACF,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC;YACpB,SAAS,EAAE,uBAAuB;YAClC,OAAO,EAAE,8CAA8C;YACvD,WAAW,EAAE,qFAAqF;YAClG,GAAG,EAAE,4BAA4B;SAClC,CAAC;QACF,eAAe;QACf,aAAa,EAAE,KAAK,CAAC,OAAO,CAAC;YAC3B,SAAS,EAAE,qBAAqB;YAChC,OAAO,EAAE,qDAAqD;YAC9D,GAAG,EAAE,gCAAgC;YACrC,OAAO,EAAE,CAAC;SACX,CAAC;QACF,eAAe,EAAE,KAAK,CAAC,OAAO,CAAC;YAC7B,SAAS,EAAE,qBAAqB;YAChC,OAAO,EAAE,oFAAoF;YAC7F,GAAG,EAAE,+BAA+B;YACpC,OAAO,EAAE,KAAK;SACf,CAAC;KACH,CAAC;IACQ,YAAY,CAAe;IAC3B,QAAQ,CAAQ;IAChB,WAAW,CAA2C;IAEzD,KAAK,CAAC,IAAI;QACf,MAAM,KAAK,CAAC,IAAI,EAAE,CAAC;QACnB,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC;YACjC,SAAS,EAAE,mBAAmB,CAAC,SAAS;SACzC,CAAC,CAAC;QACH,IAAI,UAAU,CAAC;QACf,IAAI,KAAK,CAAC,cAAc,EAAE,CAAC;YACzB,MAAM,kBAAkB,GAAG,MAAM,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC,CAAC;YAC/F,IAAI,CAAC;gBACH,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;YAC9C,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;YAChD,CAAC;QACH,CAAC;QACD,kBAAkB,CAAC,UAAU,CAAC,CAAC;QAC/B,IAAI,CAAC,QAAQ,GAAG,YAAY,CAAC,KAAK,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;QACxD,MAAM,UAAU,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC,aAAa,EAAE,CAAC;QACvD,MAAM,cAAc,GAAG,MAAM,6BAA6B,CAAC,KAAK,CAAC,CAAC;QAClE,MAAM,OAAO,GAAG;YACd,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;YACnD,GAAG,2BAA2B,CAAC,KAAK,CAAC;SACtC,CAAC;QACF,IAAI,CAAC,YAAY,GAAG,IAAI,YAAY,CAAC,UAAU,EAAE,cAAc,EAAE,OAAO,CAAC,CAAC;QAE1E,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QACjC,MAAM,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC9D,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,CAAC;QAChC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;QACpB,MAAM,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;IAC5D,CAAC;IAEM,KAAK,CAAC,OAAO,CAAC,GAAW;QAC9B,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC;QACnC,IAAI,GAAG,EAAE,KAAK,YAAY,KAAK,EAAE,CAAC;YAChC,IAAI,CAAC,WAAW,CAAC,UAAU,GAAG,CAAC,KAAK,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QACrD,CAAC;QACD,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACtB,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;YAClC,IAAI,CAAC;gBACH,MAAM,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;gBACjE,MAAM,SAAS,GAAG,SAAS,SAAS,MAAM,CAAC;gBAC3C,MAAM,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC;gBACzE,IAAI,CAAC,WAAW,CAAC,8BAA8B,SAAS,EAAE,CAAC,CAAC;YAC9D,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC,CAAA,CAAC;YACd,MAAM,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,CAAC;YACzD,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;QACtB,CAAC;IACH,CAAC;;AAGH,KAAK,UAAU,6BAA6B,CAAC,KAAK;IAChD,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,MAAM,CAAC;QACpC,GAAG,CAAC,KAAK,CAAC,OAAO;YACf,CAAC,CAAC;gBACE,OAAO,EAAE,KAAK,CAAC,OAAO;aACvB;YACH,CAAC,CAAC,EAAE,CAAC;QACP,GAAG,CAAC,KAAK,CAAC,GAAG;YACX,CAAC,CAAC;gBACE,cAAc,EAAE,KAAK,CAAC,GAAG;aAC1B;YACH,CAAC,CAAC,EAAE,CAAC;QACP,QAAQ,EAAE,KAAK,CAAC,QAAQ;QACxB,MAAM,EAAE,KAAK,CAAC,SAAS,CAAC;KACzB,CAAC,CAAC;IACH,MAAM,cAAc,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC;QAC9C,QAAQ,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE;KACxC,CAAC,CAAC;IACH,cAAc,CAAC,2BAA2B,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC1D,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;QAChB,MAAM,cAAc,CAAC,OAAO,CAAC,KAAK,CAAC;YACjC,WAAW,EAAE,IAAI;YACjB,SAAS,EAAE,IAAI;YACf,OAAO,EAAE,IAAI;SACd,CAAC,CAAC;IACL,CAAC;IACD,OAAO,cAAc,CAAC;AACxB,CAAC;AAED,SAAS,2BAA2B,CAAC,KAAK;IACxC,OAAO;QACL,OAAO,EAAE,KAAK,CAAC,aAAa,CAAC;QAC7B,UAAU,EAAE,KAAK,CAAC,eAAe,CAAC;KACnC,CAAC;AACJ,CAAC"}

package/lib/browserforce.d.ts

@@ -1,18 +1,20 @@
-import { Org } from '@salesforce/core';
+import { type Connection } from '@salesforce/core';
 import { type Ux } from '@salesforce/sf-plugins-core';
-import { type Browser, type BrowserContext, type Page, type FrameLocator } from 'playwright';
+import { Options as RetryOptions } from 'p-retry';
+import { type BrowserContext, type FrameLocator, type Page } from 'playwright';
+export type SalesforceUrlPath = `/${string}`;
+export type BrowserforceOptions = {
+    logger?: Ux;
+    retry?: RetryOptions;
+};
 export declare class Browserforce {
-    org: Org;
+    connection: Connection;
+    browserContext: BrowserContext;
     logger?: Ux;
-    browser: Browser;
-    context: BrowserContext;
-    page: Page;
-    lightningSetupUrl: string;
-    constructor(org: Org, logger?: Ux);
+    private retryConfig?;
+    constructor(connection: Connection, browserContext: BrowserContext, options?: BrowserforceOptions);
     login(): Promise<Browserforce>;
-    logout(): Promise<Browserforce>;
-    getNewPage(): Promise<Page>;
-    openPage(urlPath: string): Promise<Page>;
+    openPage(urlPath: SalesforceUrlPath): Promise<Page>;
     waitForSelectorInFrameOrPage(page: Page, selector: string): Promise<Page | FrameLocator>;
     getMyDomain(): string | null;
     getInstanceUrl(): string;
@@ -20,6 +22,6 @@ export declare class Browserforce {
      * @returns the setup url (e.g. https://[MyDomainName].my.salesforce-setup.com)
      */
     getLightningSetupUrl(): Promise<string>;
+    retry<T>(input: (attemptCount: number) => PromiseLike<T> | T): Promise<T>;
 }
 export declare function waitForPageErrors(page: Page, timeout?: number): Promise<void>;
-export declare function retry<T>(input: (attemptCount: number) => PromiseLike<T> | T): Promise<T>;