sfdx-browserforce-plugin 5.1.1 → 5.2.0-next.1

package/README.md

@@ -54,7 +54,7 @@ $ sf browserforce apply -f ./config/currency.json --target-org myOrg@example.com
 
 - 🔧 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 Puppeteer and "Chrome for Testing", [learn more about Puppeteer and Browserforce](#puppeteer)
+- 🏎️ browser automation powered by Playwright, [learn more about Playwright and Browserforce](#playwright)
 
 # Supported Browserforce Settings
 
@@ -126,30 +126,68 @@ Both the `browserforce apply` and `browserforce plan` commands expect a config f
 - `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`)
 
-# Puppeteer
+# Migration to Playwright
 
-We use [Puppeteer](https://github.com/puppeteer/puppeteer) for browser automation which comes with its own "Chrome for Testing" browser.
+**Important Notice for Next Version Release:**
 
-The puppeteer [installation doc](https://github.com/puppeteer/puppeteer#installation) describes how this works:
+This project is transitioning from Puppeteer to Playwright for browser automation. The migration is planned for the next major version release.
 
-> When you install Puppeteer, it automatically downloads a recent version of
-> [Chrome for Testing](https://goo.gle/chrome-for-testing) (~170MB macOS, ~282MB Linux, ~280MB Windows) that is [guaranteed to
-> work](https://pptr.dev/faq#q-why-doesnt-puppeteer-vxxx-work-with-chromium-vyyy)
-> with Puppeteer. The browser is downloaded to the `$HOME/.cache/puppeteer` folder
-> by default (starting with Puppeteer v19.0.0).
+## What This Means for Users
 
-In most of the cases this just works! If you still want to skip the download and use another browser installation, you can do this as follows:
+### Current Version (Puppeteer-based)
+- Continues to work as expected
+- No action required from users
+- Maintained for stability
 
-```console
-export PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=true
-sf plugins install sfdx-browserforce-plugin
-export PUPPETEER_EXECUTABLE_PATH=/usr/bin/chromium-browser
-sf browserforce:apply ...
-```
+### Next Version (Playwright-based)
+The upcoming release will include:
+
+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
+
+### Migration Actions Required
+
+**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:
+
+
+For more information on browser automation best practices, see the [Playwright documentation](docs/PLAYWRIGHT.md).
 
 Troubleshooting:
 
 - 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`
 
 # Contributing
 

package/lib/browserforce-command.d.ts

@@ -0,0 +1,15 @@
+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': 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>;
+        'flags-dir': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    protected bf: Browserforce;
+    protected settings: any[];
+    init(): Promise<void>;
+    finally(err?: Error): Promise<void>;
+}

package/lib/browserforce-command.js

@@ -0,0 +1,61 @@
+import { Flags, SfCommand, Ux } from '@salesforce/sf-plugins-core';
+import { promises } from 'fs';
+import * as path from 'path';
+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',
+            description: 'path to a browserforce state file',
+        }),
+        planfile: Flags.string({
+            char: 'p',
+            name: 'plan',
+            description: 'path to a browserforce plan file',
+        }),
+        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.',
+        }),
+    };
+    bf;
+    settings;
+    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 definitionfile');
+            }
+        }
+        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() }));
+        this.spinner.start('logging in');
+        await this.bf.login();
+        this.spinner.stop();
+    }
+    async finally(err) {
+        this.spinner.stop(err?.message);
+        if (this.bf) {
+            this.spinner.start('logging out');
+            await this.bf.logout();
+            this.spinner.stop();
+        }
+    }
+}
+//# 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":"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"}

package/lib/browserforce.d.ts

@@ -0,0 +1,29 @@
+import { Org } from '@salesforce/core';
+import { type Ux } from '@salesforce/sf-plugins-core';
+import { Browser, BrowserContext, Page, FrameLocator } from 'playwright';
+export declare class Browserforce {
+    org: Org;
+    logger?: Ux;
+    browser: Browser;
+    context: BrowserContext;
+    page: Page;
+    lightningSetupUrl: string;
+    constructor(org: Org, logger?: Ux);
+    login(): Promise<Browserforce>;
+    logout(): Promise<Browserforce>;
+    throwPageErrors(page: Page): Promise<void>;
+    getNewPage(): Promise<Page>;
+    openPage(urlPath: string, options?: {
+        waitUntil?: 'load' | 'domcontentloaded' | 'networkidle' | 'commit';
+    }): 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>;
+    waitForIdle(page: Page, maxWaitTime?: number): Promise<void>;
+}
+export declare function throwPageErrors(page: Page): Promise<void>;
+export declare function retry<T>(input: (attemptCount: number) => PromiseLike<T> | T): Promise<T>;

package/lib/browserforce.js

@@ -0,0 +1,194 @@
+import pRetry from 'p-retry';
+import { chromium, } from 'playwright';
+import { LoginPage } from './pages/login.js';
+const ERROR_DIV_SELECTOR = '#errorTitle';
+const ERROR_DIVS_SELECTOR = 'div.errorMsg';
+const VF_IFRAME_SELECTOR = 'force-aloha-page iframe[name^=vfFrameId]';
+export class Browserforce {
+    org;
+    logger;
+    browser;
+    context;
+    page;
+    lightningSetupUrl;
+    constructor(org, logger) {
+        this.org = org;
+        this.logger = logger;
+    }
+    async login() {
+        this.browser = await chromium.launch({
+            channel: process.env.CI ? 'chrome' : undefined,
+            args: ['--no-sandbox', '--disable-setuid-sandbox'],
+            headless: !(process.env.BROWSER_DEBUG === 'true'),
+            slowMo: parseInt(process.env.BROWSER_SLOWMO, 10) ?? 0,
+        });
+        this.context = await this.browser.newContext({
+            viewport: { width: 1024, height: 768 },
+        });
+        // Start tracing if PLAYWRIGHT_TRACE is set
+        if (process.env.PLAYWRIGHT_TRACE === 'true') {
+            await this.context.tracing.start({
+                screenshots: true,
+                snapshots: true,
+                sources: true,
+            });
+        }
+        const page = await this.getNewPage();
+        try {
+            const loginPage = new LoginPage(page);
+            await loginPage.login(this.org);
+        }
+        finally {
+            await page.close();
+        }
+        return this;
+    }
+    async logout() {
+        if (this.browser) {
+            // Stop tracing and save if it was started
+            if (process.env.PLAYWRIGHT_TRACE === 'true') {
+                const timestamp = new Date().toISOString().replace(/[:.]/g, '-');
+                const tracePath = `trace-${timestamp}.zip`;
+                await this.context.tracing.stop({ path: tracePath });
+                if (this.logger) {
+                    this.logger.log(`Playwright trace saved to: ${tracePath}`);
+                }
+            }
+            await this.browser.close();
+        }
+        return this;
+    }
+    async throwPageErrors(page) {
+        await throwPageErrors(page);
+    }
+    async getNewPage() {
+        const page = await this.context.newPage();
+        page.setDefaultNavigationTimeout(parseInt(process.env.BROWSERFORCE_NAVIGATION_TIMEOUT_MS ?? '90000', 10));
+        return page;
+    }
+    // path instead of url
+    async openPage(urlPath, options) {
+        let page;
+        const result = await pRetry(async () => {
+            page = await this.getNewPage();
+            const setupUrl = urlPath.startsWith('lightning')
+                ? await this.getLightningSetupUrl()
+                : this.getInstanceUrl();
+            const url = `${setupUrl}/${urlPath}`;
+            const response = await page.goto(url, options ?? { waitUntil: 'load' });
+            if (response) {
+                if (!response.ok()) {
+                    await this.throwPageErrors(page);
+                    throw new Error(`${response.status()}: ${response.statusText()}`);
+                }
+            }
+            return page;
+        }, {
+            onFailedAttempt: async (context) => {
+                if (this.logger) {
+                    this.logger.warn(`retrying ${context.retriesLeft} more time(s) because of "${context.error}"`);
+                }
+                if (page) {
+                    try {
+                        await page.close();
+                    }
+                    catch (e) {
+                        // not handled
+                    }
+                }
+            },
+            retries: parseInt(process.env.BROWSERFORCE_RETRY_MAX_RETRIES ?? '4', 10),
+            minTimeout: parseInt(process.env.BROWSERFORCE_RETRY_TIMEOUT_MS ?? '4000', 10),
+        });
+        return result;
+    }
+    // If LEX is enabled, the classic url will be opened in an iframe.
+    // Wait for either the selector in the page or in the iframe.
+    // returns the page or the frame locator
+    async waitForSelectorInFrameOrPage(page, selector) {
+        await page.locator(`${selector}, ${VF_IFRAME_SELECTOR}`).first().waitFor();
+        const iframeCount = await page.locator(VF_IFRAME_SELECTOR).count();
+        if (iframeCount > 0) {
+            const frameLocator = page.frameLocator(VF_IFRAME_SELECTOR);
+            await frameLocator.locator(selector).first().waitFor();
+            return frameLocator;
+        }
+        await page.locator(selector).first().waitFor();
+        return page;
+    }
+    getMyDomain() {
+        const instanceUrl = this.getInstanceUrl();
+        // acme.my.salesforce.com
+        // acme--<sandboxName>.csN.my.salesforce.com
+        const matches = instanceUrl.match(/https:\/\/(.*)\.my\.salesforce\.com/);
+        if (matches) {
+            return matches[1];
+        }
+        return null;
+    }
+    getInstanceUrl() {
+        // sometimes the instanceUrl includes a trailing slash
+        return this.org.getConnection().instanceUrl?.replace(/\/$/, '');
+    }
+    /**
+     * @returns the setup url (e.g. https://[MyDomainName].my.salesforce-setup.com)
+     */
+    async getLightningSetupUrl() {
+        if (!this.lightningSetupUrl) {
+            const page = await this.getNewPage();
+            try {
+                const lightningResponse = await page.goto(`${this.getInstanceUrl()}/lightning/setup/SetupOneHome/home`, { waitUntil: 'load' });
+                this.lightningSetupUrl = new URL(lightningResponse.url()).origin;
+            }
+            finally {
+                await page.close();
+            }
+        }
+        return this.lightningSetupUrl;
+    }
+    async waitForIdle(page, maxWaitTime = 2000) {
+        try {
+            await page.waitForLoadState('networkidle', { timeout: maxWaitTime });
+        }
+        catch {
+            console.log(`Waited ${maxWaitTime}ms, continuing regardless of network state`);
+        }
+    }
+}
+export async function throwPageErrors(page) {
+    const errorLocator = page.locator(ERROR_DIV_SELECTOR);
+    const errorCount = await errorLocator.count();
+    if (errorCount > 0) {
+        const errorMsg = await errorLocator.first().innerText();
+        if (errorMsg && errorMsg.trim()) {
+            throw new Error(errorMsg.trim());
+        }
+    }
+    const errorDivsLocator = page.locator(ERROR_DIVS_SELECTOR);
+    const errorDivsCount = await errorDivsLocator.count();
+    if (errorDivsCount > 0) {
+        const errorMessages = [];
+        for (let i = 0; i < errorDivsCount; i++) {
+            const text = await errorDivsLocator.nth(i).innerText();
+            errorMessages.push(text);
+        }
+        const errorMsg = errorMessages
+            .map((m) => m.trim())
+            .join(' ')
+            .trim();
+        if (errorMsg) {
+            throw new Error(errorMsg);
+        }
+    }
+}
+export async function retry(input) {
+    const res = await pRetry(input, {
+        onFailedAttempt: (context) => {
+            console.warn(`retrying ${context.retriesLeft} more time(s) because of "${context.error}"`);
+        },
+        retries: parseInt(process.env.BROWSERFORCE_RETRY_MAX_RETRIES ?? '6', 10),
+        minTimeout: parseInt(process.env.BROWSERFORCE_RETRY_TIMEOUT_MS ?? '4000', 10),
+    });
+    return res;
+}
+//# sourceMappingURL=browserforce.js.map

package/lib/browserforce.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"browserforce.js","sourceRoot":"","sources":["../src/browserforce.ts"],"names":[],"mappings":"AAEA,OAAO,MAAM,MAAM,SAAS,CAAC;AAC7B,OAAO,EACL,QAAQ,GAKT,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAE7C,MAAM,kBAAkB,GAAG,aAAa,CAAC;AACzC,MAAM,mBAAmB,GAAG,cAAc,CAAC;AAC3C,MAAM,kBAAkB,GAAG,0CAA0C,CAAC;AAEtE,MAAM,OAAO,YAAY;IAChB,GAAG,CAAM;IACT,MAAM,CAAM;IACZ,OAAO,CAAU;IACjB,OAAO,CAAiB;IACxB,IAAI,CAAO;IACX,iBAAiB,CAAS;IAEjC,YAAY,GAAQ,EAAE,MAAW;QAC/B,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAEM,KAAK,CAAC,KAAK;QAChB,IAAI,CAAC,OAAO,GAAG,MAAM,QAAQ,CAAC,MAAM,CAAC;YACnC,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS;YAC9C,IAAI,EAAE,CAAC,cAAc,EAAE,0BAA0B,CAAC;YAClD,QAAQ,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,KAAK,MAAM,CAAC;YACjD,MAAM,EAAE,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,EAAE,CAAC,IAAI,CAAC;SACtD,CAAC,CAAC;QACH,IAAI,CAAC,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC;YAC3C,QAAQ,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE;SACvC,CAAC,CAAC;QAEH,2CAA2C;QAC3C,IAAI,OAAO,CAAC,GAAG,CAAC,gBAAgB,KAAK,MAAM,EAAE,CAAC;YAC5C,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC;gBAC/B,WAAW,EAAE,IAAI;gBACjB,SAAS,EAAE,IAAI;gBACf,OAAO,EAAE,IAAI;aACd,CAAC,CAAC;QACL,CAAC;QACD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;QACrC,IAAI,CAAC;YACH,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,IAAI,CAAC,CAAC;YACtC,MAAM,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAClC,CAAC;gBAAS,CAAC;YACT,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;QACrB,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,KAAK,CAAC,MAAM;QACjB,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,0CAA0C;YAC1C,IAAI,OAAO,CAAC,GAAG,CAAC,gBAAgB,KAAK,MAAM,EAAE,CAAC;gBAC5C,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,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC;gBACrD,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;oBAChB,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,8BAA8B,SAAS,EAAE,CAAC,CAAC;gBAC7D,CAAC;YACH,CAAC;YACD,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;QAC7B,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,KAAK,CAAC,eAAe,CAAC,IAAU;QACrC,MAAM,eAAe,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC;IAEM,KAAK,CAAC,UAAU;QACrB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;QAC1C,IAAI,CAAC,2BAA2B,CAC9B,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,kCAAkC,IAAI,OAAO,EAAE,EAAE,CAAC,CACxE,CAAC;QACF,OAAO,IAAI,CAAC;IACd,CAAC;IAED,sBAAsB;IACf,KAAK,CAAC,QAAQ,CACnB,OAAe,EACf,OAEC;QAED,IAAI,IAAU,CAAC;QACf,MAAM,MAAM,GAAG,MAAM,MAAM,CACzB,KAAK,IAAI,EAAE;YACT,IAAI,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;YAC/B,MAAM,QAAQ,GAAG,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC;gBAC9C,CAAC,CAAC,MAAM,IAAI,CAAC,oBAAoB,EAAE;gBACnC,CAAC,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;YAC1B,MAAM,GAAG,GAAG,GAAG,QAAQ,IAAI,OAAO,EAAE,CAAC;YACrC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC,CAAC;YACxE,IAAI,QAAQ,EAAE,CAAC;gBACb,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,CAAC;oBACnB,MAAM,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;oBACjC,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,KAAK,QAAQ,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;gBACpE,CAAC;YACH,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC,EACD;YACE,eAAe,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;gBACjC,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;oBAChB,IAAI,CAAC,MAAM,CAAC,IAAI,CACd,YAAY,OAAO,CAAC,WAAW,6BAA6B,OAAO,CAAC,KAAK,GAAG,CAC7E,CAAC;gBACJ,CAAC;gBACD,IAAI,IAAI,EAAE,CAAC;oBACT,IAAI,CAAC;wBACH,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;oBACrB,CAAC;oBAAC,OAAO,CAAC,EAAE,CAAC;wBACX,cAAc;oBAChB,CAAC;gBACH,CAAC;YACH,CAAC;YACD,OAAO,EAAE,QAAQ,CACf,OAAO,CAAC,GAAG,CAAC,8BAA8B,IAAI,GAAG,EACjD,EAAE,CACH;YACD,UAAU,EAAE,QAAQ,CAClB,OAAO,CAAC,GAAG,CAAC,6BAA6B,IAAI,MAAM,EACnD,EAAE,CACH;SACF,CACF,CAAC;QACF,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,kEAAkE;IAClE,6DAA6D;IAC7D,wCAAwC;IACjC,KAAK,CAAC,4BAA4B,CACvC,IAAU,EACV,QAAgB;QAEhB,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,QAAQ,KAAK,kBAAkB,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE,CAAC;QAE3E,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC,KAAK,EAAE,CAAC;QAEnE,IAAI,WAAW,GAAG,CAAC,EAAE,CAAC;YACpB,MAAM,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC;YAC3D,MAAM,YAAY,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE,CAAC;YACvD,OAAO,YAAY,CAAC;QACtB,CAAC;QAED,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE,CAAC;QAC/C,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,WAAW;QAChB,MAAM,WAAW,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QAC1C,yBAAyB;QACzB,4CAA4C;QAC5C,MAAM,OAAO,GAAG,WAAW,CAAC,KAAK,CAAC,qCAAqC,CAAC,CAAC;QACzE,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO,OAAO,CAAC,CAAC,CAAC,CAAC;QACpB,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,cAAc;QACnB,sDAAsD;QACtD,OAAO,IAAI,CAAC,GAAG,CAAC,aAAa,EAAE,CAAC,WAAW,EAAE,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IAClE,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,oBAAoB;QAC/B,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC5B,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;YACrC,IAAI,CAAC;gBACH,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC,IAAI,CACvC,GAAG,IAAI,CAAC,cAAc,EAAE,oCAAoC,EAC5D,EAAE,SAAS,EAAE,MAAM,EAAE,CACtB,CAAC;gBACF,IAAI,CAAC,iBAAiB,GAAG,IAAI,GAAG,CAAC,iBAAiB,CAAC,GAAG,EAAE,CAAC,CAAC,MAAM,CAAC;YACnE,CAAC;oBAAS,CAAC;gBACT,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;YACrB,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAChC,CAAC;IAEM,KAAK,CAAC,WAAW,CAAC,IAAU,EAAE,WAAW,GAAG,IAAI;QACrD,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,gBAAgB,CAAC,aAAa,EAAE,EAAE,OAAO,EAAE,WAAW,EAAE,CAAC,CAAC;QACvE,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,CAAC,GAAG,CACT,UAAU,WAAW,4CAA4C,CAClE,CAAC;QACJ,CAAC;IACH,CAAC;CACF;AAED,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,IAAU;IAC9C,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;IACtD,MAAM,UAAU,GAAG,MAAM,YAAY,CAAC,KAAK,EAAE,CAAC;IAE9C,IAAI,UAAU,GAAG,CAAC,EAAE,CAAC;QACnB,MAAM,QAAQ,GAAG,MAAM,YAAY,CAAC,KAAK,EAAE,CAAC,SAAS,EAAE,CAAC;QACxD,IAAI,QAAQ,IAAI,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC;YAChC,MAAM,IAAI,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;QACnC,CAAC;IACH,CAAC;IAED,MAAM,gBAAgB,GAAG,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAC3D,MAAM,cAAc,GAAG,MAAM,gBAAgB,CAAC,KAAK,EAAE,CAAC;IAEtD,IAAI,cAAc,GAAG,CAAC,EAAE,CAAC;QACvB,MAAM,aAAa,GAAa,EAAE,CAAC;QACnC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,cAAc,EAAE,CAAC,EAAE,EAAE,CAAC;YACxC,MAAM,IAAI,GAAG,MAAM,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC;YACvD,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC3B,CAAC;QACD,MAAM,QAAQ,GAAG,aAAa;aAC3B,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;aACpB,IAAI,CAAC,GAAG,CAAC;aACT,IAAI,EAAE,CAAC;QACV,IAAI,QAAQ,EAAE,CAAC;YACb,MAAM,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC5B,CAAC;IACH,CAAC;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,KAAK,CACzB,KAAmD;IAEnD,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,KAAK,EAAE;QAC9B,eAAe,EAAE,CAAC,OAAO,EAAE,EAAE;YAC3B,OAAO,CAAC,IAAI,CACV,YAAY,OAAO,CAAC,WAAW,6BAA6B,OAAO,CAAC,KAAK,GAAG,CAC7E,CAAC;QACJ,CAAC;QACD,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,8BAA8B,IAAI,GAAG,EAAE,EAAE,CAAC;QACxE,UAAU,EAAE,QAAQ,CAClB,OAAO,CAAC,GAAG,CAAC,6BAA6B,IAAI,MAAM,EACnD,EAAE,CACH;KACF,CAAC,CAAC;IACH,OAAO,GAAG,CAAC;AACb,CAAC"}

package/lib/commands/browserforce/apply.d.ts

@@ -0,0 +1,10 @@
+import { BrowserforceCommand } from '../../browserforce-command.js';
+type BrowserforceApplyResponse = {
+    success: boolean;
+};
+export declare class BrowserforceApply extends BrowserforceCommand<BrowserforceApplyResponse> {
+    static description: string;
+    static examples: string[];
+    run(): Promise<BrowserforceApplyResponse>;
+}
+export {};

package/lib/commands/browserforce/apply.js

@@ -0,0 +1,54 @@
+import { BrowserforceCommand } from '../../browserforce-command.js';
+export class BrowserforceApply extends BrowserforceCommand {
+    static description = 'apply a plan from a definition file';
+    static examples = [
+        `$ <%= config.bin %> <%= command.id %> -f ./config/currency.json --target-org myOrg@example.com
+  logging in... done
+  Applying definition 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
+  `,
+    ];
+    async run() {
+        const { flags } = await this.parse(BrowserforceApply);
+        this.log(`Applying definition file ${flags.definitionfile} to org ${flags['target-org'].getUsername()}`);
+        for (const setting of this.settings) {
+            const driver = setting.Driver;
+            const instance = new driver(this.bf);
+            this.spinner.start(`[${driver.name}] retrieving state`);
+            let state;
+            try {
+                state = await instance.retrieve(setting.value);
+            }
+            catch (err) {
+                this.spinner.stop('failed');
+                throw err;
+            }
+            this.spinner.stop();
+            const diff = instance.diff(state, setting.value);
+            if (diff !== undefined) {
+                this.spinner.start(`[${driver.name}] ${Object.keys(diff)
+                    .map((key) => {
+                    return `changing '${key}' to '${JSON.stringify(diff[key])}'`;
+                })
+                    .join('\n')}`);
+                try {
+                    await instance.apply(diff);
+                }
+                catch (err) {
+                    this.spinner.stop('failed');
+                    throw err;
+                }
+                this.spinner.stop();
+            }
+            else {
+                this.log(`[${driver.name}] no action necessary`);
+            }
+        }
+        return {
+            success: true,
+        };
+    }
+}
+//# sourceMappingURL=apply.js.map

package/lib/commands/browserforce/apply.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"apply.js","sourceRoot":"","sources":["../../../src/commands/browserforce/apply.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AAMpE,MAAM,OAAO,iBAAkB,SAAQ,mBAA8C;IAC5E,MAAM,CAAC,WAAW,GAAG,qCAAqC,CAAC;IAC3D,MAAM,CAAC,QAAQ,GAAG;QACvB;;;;;;GAMD;KACA,CAAC;IAEK,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;QACtD,IAAI,CAAC,GAAG,CACN,4BAA4B,KAAK,CAAC,cAAc,WAAW,KAAK,CAC9D,YAAY,CACb,CAAC,WAAW,EAAE,EAAE,CAClB,CAAC;QACF,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YACpC,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;YAC9B,MAAM,QAAQ,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACrC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,IAAI,oBAAoB,CAAC,CAAC;YACxD,IAAI,KAAK,CAAC;YACV,IAAI,CAAC;gBACH,KAAK,GAAG,MAAM,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YACjD,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBAC5B,MAAM,GAAG,CAAC;YACZ,CAAC;YACD,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;YACpB,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;YACjD,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;gBACvB,IAAI,CAAC,OAAO,CAAC,KAAK,CAChB,IAAI,MAAM,CAAC,IAAI,KAAK,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;qBAClC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;oBACX,OAAO,aAAa,GAAG,SAAS,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC;gBAC/D,CAAC,CAAC;qBACD,IAAI,CAAC,IAAI,CAAC,EAAE,CAChB,CAAC;gBACF,IAAI,CAAC;oBACH,MAAM,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBAC7B,CAAC;gBAAC,OAAO,GAAG,EAAE,CAAC;oBACb,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;oBAC5B,MAAM,GAAG,CAAC;gBACZ,CAAC;gBACD,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;YACtB,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,GAAG,CAAC,IAAI,MAAM,CAAC,IAAI,uBAAuB,CAAC,CAAC;YACnD,CAAC;QACH,CAAC;QACD,OAAO;YACL,OAAO,EAAE,IAAI;SACd,CAAC;IACJ,CAAC"}

package/lib/commands/browserforce/plan.d.ts

@@ -0,0 +1,10 @@
+import { BrowserforceCommand } from '../../browserforce-command.js';
+type BrowserforceApplyResponse = {
+    success: boolean;
+};
+export declare class BrowserforcePlanCommand extends BrowserforceCommand<BrowserforceApplyResponse> {
+    static description: string;
+    static examples: string[];
+    run(): Promise<BrowserforceApplyResponse>;
+}
+export {};

package/lib/commands/browserforce/plan.js

@@ -0,0 +1,56 @@
+import { writeFile } from 'fs/promises';
+import * as path from 'path';
+import { BrowserforceCommand } from '../../browserforce-command.js';
+export class BrowserforcePlanCommand extends BrowserforceCommand {
+    static description = 'retrieve state and generate plan file';
+    static examples = [
+        `$ <%= config.bin %> <%= command.id %> -f ./config/currency.json --target-org myOrg@example.com
+  logging in... done
+  Generating plan with definition file ./config/currency.json from org myOrg@example.com
+  [CompanyInformation] retrieving state... done
+  [CompanyInformation] generating plan... done
+  logging out... done
+  `,
+    ];
+    async run() {
+        const { flags } = await this.parse(BrowserforcePlanCommand);
+        this.log(`Generating plan with definition file ${flags.definitionfile} from org ${flags['target-org'].getUsername()}`);
+        const state = {
+            settings: {},
+        };
+        const plan = {
+            settings: {},
+        };
+        for (const setting of this.settings) {
+            const driver = setting.Driver;
+            const instance = new driver(this.bf);
+            this.spinner.start(`[${driver.name}] retrieving state`);
+            let driverState;
+            try {
+                driverState = await instance.retrieve(setting.value);
+                state.settings[setting.key] = driverState;
+            }
+            catch (err) {
+                this.spinner.stop('failed');
+                throw err;
+            }
+            this.spinner.stop();
+            this.spinner.start(`[${driver.name}] generating plan`);
+            const driverPlan = instance.diff(driverState, setting.value);
+            plan.settings[setting.key] = driverPlan;
+            this.spinner.stop();
+        }
+        if (flags.statefile) {
+            this.spinner.start('writing state file');
+            await writeFile(path.resolve(flags.statefile), JSON.stringify(state, null, 2));
+            this.spinner.stop();
+        }
+        if (flags.planfile) {
+            this.spinner.start('writing plan file');
+            await writeFile(path.resolve(flags.planfile), JSON.stringify(plan, null, 2));
+            this.spinner.stop();
+        }
+        return { success: true };
+    }
+}
+//# sourceMappingURL=plan.js.map

package/lib/commands/browserforce/plan.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plan.js","sourceRoot":"","sources":["../../../src/commands/browserforce/plan.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AAMpE,MAAM,OAAO,uBAAwB,SAAQ,mBAA8C;IAClF,MAAM,CAAC,WAAW,GAAG,uCAAuC,CAAC;IAC7D,MAAM,CAAC,QAAQ,GAAG;QACvB;;;;;;GAMD;KACA,CAAC;IAEK,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAC;QAC5D,IAAI,CAAC,GAAG,CACN,wCACE,KAAK,CAAC,cACR,aAAa,KAAK,CAAC,YAAY,CAAC,CAAC,WAAW,EAAE,EAAE,CACjD,CAAC;QACF,MAAM,KAAK,GAAG;YACZ,QAAQ,EAAE,EAAE;SACb,CAAC;QACF,MAAM,IAAI,GAAG;YACX,QAAQ,EAAE,EAAE;SACb,CAAC;QACF,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YACpC,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;YAC9B,MAAM,QAAQ,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACrC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,IAAI,oBAAoB,CAAC,CAAC;YACxD,IAAI,WAAW,CAAC;YAChB,IAAI,CAAC;gBACH,WAAW,GAAG,MAAM,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;gBACrD,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,WAAW,CAAC;YAC5C,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBAC5B,MAAM,GAAG,CAAC;YACZ,CAAC;YACD,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;YACpB,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,IAAI,mBAAmB,CAAC,CAAC;YACvD,MAAM,UAAU,GAAG,QAAQ,CAAC,IAAI,CAAC,WAAW,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;YAC7D,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,UAAU,CAAC;YACxC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;QACtB,CAAC;QACD,IAAI,KAAK,CAAC,SAAS,EAAE,CAAC;YACpB,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC;YACzC,MAAM,SAAS,CACb,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,EAC7B,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAC/B,CAAC;YACF,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;QACtB,CAAC;QACD,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;YACnB,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC;YACxC,MAAM,SAAS,CACb,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,EAC5B,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAC9B,CAAC;YACF,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;QACtB,CAAC;QACD,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IAC3B,CAAC"}

package/lib/config-parser.d.ts

@@ -0,0 +1,16 @@
+import { BrowserforcePlugin } from './plugin.js';
+type Drivers = {
+    [key: string]: typeof BrowserforcePlugin;
+};
+type Data = {
+    settings?: unknown;
+};
+type Config = {
+    Driver: typeof BrowserforcePlugin;
+    key: string;
+    value: unknown;
+};
+export declare class ConfigParser {
+    static parse(drivers: Drivers, data: Data): Config[];
+}
+export {};

package/lib/config-parser.js

@@ -0,0 +1,24 @@
+export class ConfigParser {
+    static parse(drivers, data) {
+        const settings = [];
+        if (data?.settings) {
+            for (const driverName of Object.keys(data.settings)) {
+                if (drivers[driverName]) {
+                    settings.push({
+                        Driver: drivers[driverName],
+                        key: driverName,
+                        value: data.settings[driverName],
+                    });
+                }
+                else {
+                    throw new Error(`Could not find plugin named '${driverName}' in definition: ${JSON.stringify(data)}`);
+                }
+            }
+        }
+        else {
+            throw new Error(`Missing 'settings' attribute in definition: ${JSON.stringify(data)}`);
+        }
+        return settings;
+    }
+}
+//# sourceMappingURL=config-parser.js.map

package/lib/config-parser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config-parser.js","sourceRoot":"","sources":["../src/config-parser.ts"],"names":[],"mappings":"AAgBA,MAAM,OAAO,YAAY;IAChB,MAAM,CAAC,KAAK,CAAC,OAAgB,EAAE,IAAU;QAC9C,MAAM,QAAQ,GAAa,EAAE,CAAC;QAC9B,IAAI,IAAI,EAAE,QAAQ,EAAE,CAAC;YACnB,KAAK,MAAM,UAAU,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACpD,IAAI,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;oBACxB,QAAQ,CAAC,IAAI,CAAC;wBACZ,MAAM,EAAE,OAAO,CAAC,UAAU,CAAC;wBAC3B,GAAG,EAAE,UAAU;wBACf,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC;qBACjC,CAAC,CAAC;gBACL,CAAC;qBAAM,CAAC;oBACN,MAAM,IAAI,KAAK,CACb,gCAAgC,UAAU,oBAAoB,IAAI,CAAC,SAAS,CAC1E,IAAI,CACL,EAAE,CACJ,CAAC;gBACJ,CAAC;YACH,CAAC;QACH,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CACb,+CAA+C,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CACtE,CAAC;QACJ,CAAC;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF"}

package/lib/index.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/index.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":""}

package/lib/jsforce-utils.d.ts

@@ -0,0 +1,5 @@
+/**
+ * workaround as the Metadata API (converted from XML) returns an object instead of an array of length 1
+ * @param prop result of a Metadata API call (array or object)
+ */
+export declare function ensureArray<T>(prop: T | T[]): T[];

package/lib/jsforce-utils.js

@@ -0,0 +1,14 @@
+/**
+ * workaround as the Metadata API (converted from XML) returns an object instead of an array of length 1
+ * @param prop result of a Metadata API call (array or object)
+ */
+export function ensureArray(prop) {
+    if (Array.isArray(prop)) {
+        return prop;
+    }
+    if (prop === undefined || prop === null) {
+        return [];
+    }
+    return [prop];
+}
+//# sourceMappingURL=jsforce-utils.js.map

package/lib/jsforce-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"jsforce-utils.js","sourceRoot":"","sources":["../src/jsforce-utils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,UAAU,WAAW,CAAI,IAAa;IAC1C,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IACD,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;QACxC,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,OAAO,CAAC,IAAI,CAAC,CAAC;AAChB,CAAC"}