sf-browserforce 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Matthias Rolke <mr.amtrack@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,266 @@
+# sfdx-browserforce-plugin
+
+> 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 [release notes](https://github.com/amtrack/sfdx-browserforce-plugin/releases) for migration instructions.
+
+✅ 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`.
+
+|                                                                                   |                                                                   |
+| --------------------------------------------------------------------------------- | ----------------------------------------------------------------- |
+| ![Account Settings in the Salesforce Setup Menu](./examples/account-settings.png) | ![AccountSettings Metadata](./examples/account-settings-meta.png) |
+
+⚡ **BUT**
+
+> Not all feature settings are available in the Metadata API. See [Unsupported Metadata Types](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_unsupported_types.htm) for information on which feature settings are not available.
+>
+> Source: [Metadata API Developer Guide | Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm)
+
+For example, the Currency Locale in `Setup -> Company Settings -> Company Information` is not represented in any Metadata.
+
+![unsupported setting for currency locale](examples/unsupported-currency-locale.png)
+
+👉 This is where Browserforce (sfdx-browserforce-plugin) comes to the rescue. It fills this gap by applying these unsupported settings through browser automation!
+
+## Example
+
+To change the Currency Locale, the Browserforce config file (here: `./config/currency.json`) looks like this:
+
+```json
+{
+  "$schema": "https://raw.githubusercontent.com/amtrack/sfdx-browserforce-plugin/main/src/plugins/schema.json",
+  "settings": {
+    "companyInformation": {
+      "defaultCurrencyIsoCode": "English (South Africa) - ZAR"
+    }
+  }
+}
+```
+
+Apply the config:
+
+```console
+$ sf browserforce apply -f ./config/currency.json --target-org myOrg@example.com
+  logging in... done
+  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
+```
+
+Apply the config again: 👉 No action necessary
+
+```console
+$ sf browserforce apply -f ./config/currency.json --target-org myOrg@example.com
+  logging in... done
+  Applying config file ./config/currency.json to org myOrg@example.com
+  [CompanyInformation] retrieving state... done
+  [CompanyInformation] no action necessary
+  logging out... done
+```
+
+## 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
+
+Top settings:
+
+- Change Currency Locale
+- Delete inactive record types
+- Replace (and delete) picklist values
+- Manage (create/modify/delete) Field Dependencies on CustomFields
+- Set Email Deliverability Access Level to "No access", "System email only" and "All email"
+- Enable the 'Sales Cloud for Slack' Slack App
+- Change active Lightning Theme
+- Enable Salesforce To Salesforce
+- Import certificates from a keystore in Java Keystore (JKS) format
+
+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
+
+```shell
+sf plugins install sfdx-browserforce-plugin
+```
+
+> [!IMPORTANT]
+> Playwright does not come with a browser automatically
+
+You might need to install a browser explicitly or configure Browserforce to use an existing browser.
+
+> [!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.
+
+### Option 1: Install a browser using our Playwright wrapper command
+
+```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
+
+You can use any of the following environment variables:
+
+```shell
+BROWSERFORCE_BROWSER_CHANNEL="chrome"
+BROWSERFORCE_BROWSER_CHANNEL="chromium"
+BROWSERFORCE_BROWSER_EXECUTABLE_PATH="/usr/bin/google-chrome"
+CHROME_BIN="/usr/bin/google-chrome"
+```
+
+## Usage
+
+<!-- commands -->
+* [`sf browserforce apply`](#sf-browserforce-apply)
+* [`sf browserforce playwright`](#sf-browserforce-playwright)
+
+## `sf browserforce apply`
+
+apply a plan from a config file
+
+```
+USAGE
+  $ sf browserforce apply -o <value> [--json] [--flags-dir <value>] [-f <value>] [-d] [--headless] [--slow-mo <value>]
+    [--timeout <value>] [--trace] [--browser-executable-path <value>] [--browser-channel <value>] [--max-retries
+    <value>] [--retry-timeout <value>]
+
+FLAGS
+  -d, --dry-run                 [env: BROWSERFORCE_DRY_RUN] dry run
+  -f, --definitionfile=<value>  path to a browserforce config file
+  -o, --target-org=<value>      (required) Username or alias of the target org. Not required if the `target-org`
+                                configuration variable is already set.
+
+BROWSER CONFIGURATION FLAGS
+  --browser-channel=<value>          [env: BROWSERFORCE_BROWSER_CHANNEL] the channel (e.g. chromium or chrome) to use
+  --browser-executable-path=<value>  [default: /usr/bin/google-chrome, env: BROWSERFORCE_BROWSER_EXECUTABLE_PATH] the
+                                     path to a browser executable
+  --[no-]headless                    [env: BROWSERFORCE_HEADLESS] run in headless mode (default: true)
+  --slow-mo=<value>                  [env: BROWSERFORCE_SLOWMO] slow motion in milliseconds (default: 0)
+  --timeout=<value>                  [default: 90000, env: BROWSERFORCE_NAVIGATION_TIMEOUT_MS] the default navigation
+                                     timeout in milliseconds
+  --trace                            [env: BROWSERFORCE_TRACE] create a Playwright trace file
+
+GLOBAL FLAGS
+  --flags-dir=<value>  Import flag values from a directory.
+  --json               Format output as json.
+
+RETRY CONFIGURATION FLAGS
+  --max-retries=<value>    [default: 6, env: BROWSERFORCE_RETRY_MAX_RETRIES] the maximum number of retries for retryable
+                           actions
+  --retry-timeout=<value>  [default: 4000, env: BROWSERFORCE_RETRY_TIMEOUT_MS] the inital timeout in milliseconds for
+                           retryable actions (exponentially increased)
+
+DESCRIPTION
+  apply a plan from a config file
+
+EXAMPLES
+  $ sf browserforce apply -f ./config/currency.json --target-org myOrg@example.com
+    logging in... done
+    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
+  
+
+FLAG DESCRIPTIONS
+  -d, --dry-run  dry run
+
+    Retrieve the config and show the diff, but don't apply it.
+
+  --browser-channel=<value>  the channel (e.g. chromium or chrome) to use
+
+    Playwright will try to figure out the path to the browser executable automatically.
+
+  --browser-executable-path=<value>  the path to a browser executable
+
+    Note: The environment variable CHROME_BIN can also be used. On GitHub Actions with ubuntu-latest, CHROME_BIN is set
+    to /usr/bin/google-chrome.
+
+  --trace  create a Playwright trace file
+
+    The trace file can be viewed with "sf browserforce playwright -- show-trace trace-<date>.zip".
+```
+
+_See code: [src/commands/browserforce/apply.ts](https://github.com/jrupesh/sfdx-browserforce-plugin/blob/v1.0.0/src/commands/browserforce/apply.ts)_
+
+## `sf browserforce playwright`
+
+access the Playwright CLI
+
+```
+USAGE
+  $ sf browserforce playwright
+
+DESCRIPTION
+  access the Playwright CLI
+
+EXAMPLES
+  $ sf browserforce playwright -- --help
+
+  $ sf browserforce playwright -- --version
+
+  $ sf browserforce playwright -- install --list
+
+  $ sf browserforce playwright -- install chromium
+```
+
+_See code: [src/commands/browserforce/playwright.ts](https://github.com/jrupesh/sfdx-browserforce-plugin/blob/v1.0.0/src/commands/browserforce/playwright.ts)_
+<!-- commandsstop -->
+
+## Playwright
+
+We use [Playwright](https://playwright.dev/) for browser automation.
+
+For more information on browser automation best practices, see the [Playwright documentation](./docs/PLAYWRIGHT.md).
+
+## Alternative Installation
+
+You can also install the `sfdx-browserforce-plugin` NPM package without `sf`. The package exports a `sfdx-browserforce-plugin` executable:
+
+Example:
+
+```shell
+npm install --save-dev sfdx-browserforce-plugin
+npx sfdx-browserforce-plugin browserforce -h
+```
+
+## Troubleshooting
+
+If no browser is installed or launching fails, you'll get an error message from Playwright with a suggestion.
+
+Typically this will guide you to install a browser.
+If you've installed sfdx-browserforce-plugin using `sf`, you can replace the following:
+
+```diff
+- npx playwright install chromium
++ sf browserforce playwright -- install chromium
+```
+
+## Contributing
+
+Please see [CONTRIBUTING.md](CONTRIBUTING.md) for getting started.
+
+## Sponsors
+
+- [PARX](https://www.parx.com)
+- [IPfolio](https://www.ipfolio.com)
+
+## License
+
+MIT © [Matthias Rolke](mailto:mr.amtrack@gmail.com)

package/bin/run

@@ -0,0 +1,9 @@
+#!/usr/bin/env node
+
+// eslint-disable-next-line node/shebang
+async function main() {
+  const { execute } = await import('@oclif/core');
+  await execute({ dir: import.meta.url });
+}
+
+await main();

package/bin/run.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\run" %*

package/lib/browserforce-command.d.ts

@@ -0,0 +1,27 @@
+import { type Interfaces } from '@oclif/core';
+import { SfCommand } from '@salesforce/sf-plugins-core';
+import { Browserforce } from './browserforce.js';
+export declare abstract class BrowserforceCommand<T> extends SfCommand<T> {
+    static baseFlags: {
+        'target-org': Interfaces.OptionFlag<import("@salesforce/core").Org, Interfaces.CustomOptions>;
+        definitionfile: Interfaces.OptionFlag<string, Interfaces.CustomOptions>;
+        'dry-run': Interfaces.BooleanFlag<boolean>;
+        headless: Interfaces.BooleanFlag<boolean>;
+        'slow-mo': Interfaces.OptionFlag<number, Interfaces.CustomOptions>;
+        timeout: Interfaces.OptionFlag<number, Interfaces.CustomOptions>;
+        trace: Interfaces.BooleanFlag<boolean>;
+        'browser-executable-path': Interfaces.OptionFlag<string, Interfaces.CustomOptions>;
+        'browser-channel': Interfaces.OptionFlag<string, Interfaces.CustomOptions>;
+        'max-retries': Interfaces.OptionFlag<number, Interfaces.CustomOptions>;
+        'retry-timeout': Interfaces.OptionFlag<number, Interfaces.CustomOptions>;
+        'flags-dir': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    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

@@ -0,0 +1,162 @@
+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';
+import * as DRIVERS from './plugins/index.js';
+export class BrowserforceCommand extends SfCommand {
+    static baseFlags = {
+        ...SfCommand.baseFlags,
+        'target-org': Flags.requiredOrg(),
+        definitionfile: Flags.string({
+            char: 'f',
+            summary: 'path to a browserforce config file',
+        }),
+        'dry-run': Flags.boolean({
+            char: 'd',
+            summary: 'dry run',
+            description: `Retrieve the config and show the diff, but don't apply it.`,
+            env: 'BROWSERFORCE_DRY_RUN',
+        }),
+        // 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 file',
+            description: 'The trace file can be viewed with "sf browserforce playwright -- show-trace trace-<date>.zip".',
+            env: 'BROWSERFORCE_TRACE',
+        }),
+        'browser-executable-path': Flags.string({
+            helpGroup: 'Browser Configuration',
+            summary: 'the path to a browser executable',
+            description: 'Note: The environment variable CHROME_BIN can also be used. On GitHub Actions with ubuntu-latest, CHROME_BIN is set to /usr/bin/google-chrome.',
+            env: 'BROWSERFORCE_BROWSER_EXECUTABLE_PATH',
+            default: process.env.CHROME_BIN?.length ? process.env.CHROME_BIN : undefined,
+        }),
+        'browser-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: 'BROWSERFORCE_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,
+        }),
+    };
+    browserforce;
+    settings;
+    retryConfig;
+    async init() {
+        await super.init();
+        const { flags } = await this.parse({
+            baseFlags: BrowserforceCommand.baseFlags,
+        });
+        let definition;
+        if (flags.definitionfile) {
+            const definitionFileData = await promises.readFile(path.resolve(flags.definitionfile), 'utf8');
+            try {
+                definition = JSON.parse(definitionFileData);
+            }
+            catch (err) {
+                throw new Error('Failed parsing config file');
+            }
+        }
+        handleDeprecations(definition);
+        this.settings = ConfigParser.parse(DRIVERS, definition);
+        const connection = flags['target-org'].getConnection();
+        const browserContext = await createBrowserContextFromFlags(flags);
+        const options = {
+            logger: new Ux({ jsonEnabled: this.jsonEnabled() }),
+            retry: createRetryOptionsFromFlags(flags),
+        };
+        this.browserforce = new Browserforce(connection, browserContext, options);
+        this.spinner.start('logging in');
+        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?.toString());
+        if (err?.cause instanceof Error) {
+            this.logToStderr(`Cause: ${err.cause.toString()}`);
+        }
+        if (this.browserforce) {
+            this.spinner.start('logging out');
+            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['browser-channel']
+            ? {
+                channel: flags['browser-channel'],
+            }
+            : {}),
+        ...(flags['browser-executable-path']
+            ? {
+                executablePath: flags['browser-executable-path'],
+            }
+            : {}),
+        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

@@ -0,0 +1 @@
+{"version":3,"file":"browserforce-command.js","sourceRoot":"","sources":["../src/browserforce-command.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,EAAE,EAAE,MAAM,6BAA6B,CAAC;AACnE,OAAO,EAAE,QAAQ,EAAE,MAAM,IAAI,CAAC;AAE9B,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,YAAY,EAA4B,MAAM,mBAAmB,CAAC;AAC3E,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,OAAO,EAAE,oCAAoC;SAC9C,CAAC;QACF,SAAS,EAAE,KAAK,CAAC,OAAO,CAAC;YACvB,IAAI,EAAE,GAAG;YACT,OAAO,EAAE,SAAS;YAClB,WAAW,EAAE,4DAA4D;YACzE,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,gCAAgC;YACzC,WAAW,EAAE,gGAAgG;YAC7G,GAAG,EAAE,oBAAoB;SAC1B,CAAC;QACF,yBAAyB,EAAE,KAAK,CAAC,MAAM,CAAC;YACtC,SAAS,EAAE,uBAAuB;YAClC,OAAO,EAAE,kCAAkC;YAC3C,WAAW,EACT,gJAAgJ;YAClJ,GAAG,EAAE,sCAAsC;YAC3C,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS;SAC7E,CAAC;QACF,iBAAiB,EAAE,KAAK,CAAC,MAAM,CAAC;YAC9B,SAAS,EAAE,uBAAuB;YAClC,OAAO,EAAE,8CAA8C;YACvD,WAAW,EAAE,qFAAqF;YAClG,GAAG,EAAE,8BAA8B;SACpC,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,GAAwB;YACnC,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;YACnD,KAAK,EAAE,2BAA2B,CAAC,KAAK,CAAC;SAC1C,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;;AAKH,KAAK,UAAU,6BAA6B,CAAC,KAAwB;IACnE,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,MAAM,CAAC;QACpC,GAAG,CAAC,KAAK,CAAC,iBAAiB,CAAC;YAC1B,CAAC,CAAC;gBACE,OAAO,EAAE,KAAK,CAAC,iBAAiB,CAAC;aAClC;YACH,CAAC,CAAC,EAAE,CAAC;QACP,GAAG,CAAC,KAAK,CAAC,yBAAyB,CAAC;YAClC,CAAC,CAAC;gBACE,cAAc,EAAE,KAAK,CAAC,yBAAyB,CAAC;aACjD;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,KAAwB;IAC3D,OAAO;QACL,OAAO,EAAE,KAAK,CAAC,aAAa,CAAC;QAC7B,UAAU,EAAE,KAAK,CAAC,eAAe,CAAC;KACnC,CAAC;AACJ,CAAC"}

package/lib/browserforce.d.ts

@@ -0,0 +1,27 @@
+import { type Connection } from '@salesforce/core';
+import { type Ux } from '@salesforce/sf-plugins-core';
+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 {
+    connection: Connection;
+    browserContext: BrowserContext;
+    logger?: Ux;
+    private retryConfig?;
+    constructor(connection: Connection, browserContext: BrowserContext, options?: BrowserforceOptions);
+    login(): Promise<Browserforce>;
+    openPage(urlPath: SalesforceUrlPath): Promise<Page>;
+    waitForSelectorInFrameOrPage(page: Page, selector: string): Promise<Page | FrameLocator>;
+    getMyDomain(): string | null;
+    getInstanceUrl(): string;
+    /**
+     * @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 | FrameLocator, timeout?: number): Promise<void>;