sf-browserforce 1.0.0

package/lib/browserforce.js

@@ -0,0 +1,163 @@
+var __addDisposableResource = (this && this.__addDisposableResource) || function (env, value, async) {
+    if (value !== null && value !== void 0) {
+        if (typeof value !== "object" && typeof value !== "function") throw new TypeError("Object expected.");
+        var dispose, inner;
+        if (async) {
+            if (!Symbol.asyncDispose) throw new TypeError("Symbol.asyncDispose is not defined.");
+            dispose = value[Symbol.asyncDispose];
+        }
+        if (dispose === void 0) {
+            if (!Symbol.dispose) throw new TypeError("Symbol.dispose is not defined.");
+            dispose = value[Symbol.dispose];
+            if (async) inner = dispose;
+        }
+        if (typeof dispose !== "function") throw new TypeError("Object not disposable.");
+        if (inner) dispose = function() { try { inner.call(this); } catch (e) { return Promise.reject(e); } };
+        env.stack.push({ value: value, dispose: dispose, async: async });
+    }
+    else if (async) {
+        env.stack.push({ async: true });
+    }
+    return value;
+};
+var __disposeResources = (this && this.__disposeResources) || (function (SuppressedError) {
+    return function (env) {
+        function fail(e) {
+            env.error = env.hasError ? new SuppressedError(e, env.error, "An error was suppressed during disposal.") : e;
+            env.hasError = true;
+        }
+        var r, s = 0;
+        function next() {
+            while (r = env.stack.pop()) {
+                try {
+                    if (!r.async && s === 1) return s = 0, env.stack.push(r), Promise.resolve().then(next);
+                    if (r.dispose) {
+                        var result = r.dispose.call(r.value);
+                        if (r.async) return s |= 2, Promise.resolve(result).then(next, function(e) { fail(e); return next(); });
+                    }
+                    else s |= 1;
+                }
+                catch (e) {
+                    fail(e);
+                }
+            }
+            if (s === 1) return env.hasError ? Promise.reject(env.error) : Promise.resolve();
+            if (env.hasError) throw env.error;
+        }
+        return next();
+    };
+})(typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
+    var e = new Error(message);
+    return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
+});
+import pRetry from 'p-retry';
+import { LoginPage } from './pages/login.js';
+const VF_IFRAME_SELECTOR = 'force-aloha-page iframe[name^=vfFrameId]';
+export class Browserforce {
+    connection;
+    browserContext;
+    logger;
+    retryConfig;
+    constructor(connection, browserContext, options) {
+        this.connection = connection;
+        this.browserContext = browserContext;
+        this.logger = options?.logger;
+        this.retryConfig = options?.retry ?? {
+            retries: 0,
+        };
+    }
+    async login() {
+        const env_1 = { stack: [], error: void 0, hasError: false };
+        try {
+            const page = __addDisposableResource(env_1, await this.browserContext.newPage(), true);
+            const loginPage = new LoginPage(page);
+            await loginPage.login(this.connection);
+            return this;
+        }
+        catch (e_1) {
+            env_1.error = e_1;
+            env_1.hasError = true;
+        }
+        finally {
+            const result_1 = __disposeResources(env_1);
+            if (result_1)
+                await result_1;
+        }
+    }
+    // path instead of url
+    async openPage(urlPath) {
+        let page;
+        const result = await this.retry(async () => {
+            page = await this.browserContext.newPage();
+            const setupUrl = urlPath.startsWith('/lightning') ? await this.getLightningSetupUrl() : this.getInstanceUrl();
+            const url = `${setupUrl}${urlPath}`;
+            const response = await page.goto(url);
+            if (response && !response.ok()) {
+                await Promise.race([
+                    (async () => {
+                        await page.waitForTimeout(5_000);
+                        throw new Error(`${response.status()}: ${response.url()}`);
+                    })(),
+                    waitForPageErrors(page, 6_000),
+                ]);
+            }
+            return page;
+        });
+        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.connection.instanceUrl?.replace(/\/$/, '');
+    }
+    /**
+     * @returns the setup url (e.g. https://[MyDomainName].my.salesforce-setup.com)
+     */
+    async getLightningSetupUrl() {
+        return `https://${this.getMyDomain()}.my.salesforce-setup.com`;
+    }
+    async retry(input) {
+        const res = await pRetry(input, {
+            ...this.retryConfig,
+            onFailedAttempt: (context) => {
+                this.logger?.warn(`retrying ${context.retriesLeft} more time(s) because of "${context.error}"`);
+            },
+        });
+        return res;
+    }
+}
+export async function waitForPageErrors(page, timeout = 90_000) {
+    const anyErrorsLocator = page.locator(`#error, #errorTitle, #errorDesc, #validationError, div.errorMsg`);
+    await anyErrorsLocator.first().waitFor({ state: 'attached', timeout });
+    const errorMessages = (await anyErrorsLocator.allInnerTexts()).map((t) => t.trim()).filter(Boolean);
+    if (errorMessages.length === 1) {
+        throw new Error(errorMessages[0]);
+    }
+    else if (errorMessages.length > 1) {
+        throw new Error(errorMessages.join('\n'));
+    }
+}
+//# 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,MAAmC,MAAM,SAAS,CAAC;AAE1D,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAE7C,MAAM,kBAAkB,GAAG,0CAA0C,CAAC;AAStE,MAAM,OAAO,YAAY;IAChB,UAAU,CAAa;IACvB,cAAc,CAAiB;IAC/B,MAAM,CAAM;IACX,WAAW,CAAgB;IAEnC,YAAY,UAAsB,EAAE,cAA8B,EAAE,OAA6B;QAC/F,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,IAAI,CAAC,MAAM,GAAG,OAAO,EAAE,MAAM,CAAC;QAC9B,IAAI,CAAC,WAAW,GAAG,OAAO,EAAE,KAAK,IAAI;YACnC,OAAO,EAAE,CAAC;SACX,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,KAAK;;;YAChB,MAAY,IAAI,kCAAG,MAAM,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,OAAA,CAAC;YACvD,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,IAAI,CAAC,CAAC;YACtC,MAAM,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YACvC,OAAO,IAAI,CAAC;;;;;;;;;;;KACb;IAED,sBAAsB;IACf,KAAK,CAAC,QAAQ,CAAC,OAA0B;QAC9C,IAAI,IAAU,CAAC;QACf,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE;YACzC,IAAI,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,CAAC;YAC3C,MAAM,QAAQ,GAAG,OAAO,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,oBAAoB,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;YAC9G,MAAM,GAAG,GAAG,GAAG,QAAQ,GAAG,OAAO,EAAE,CAAC;YACpC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACtC,IAAI,QAAQ,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,CAAC;gBAC/B,MAAM,OAAO,CAAC,IAAI,CAAC;oBACjB,CAAC,KAAK,IAAI,EAAE;wBACV,MAAM,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;wBACjC,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,KAAK,QAAQ,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;oBAC7D,CAAC,CAAC,EAAE;oBACJ,iBAAiB,CAAC,IAAI,EAAE,KAAK,CAAC;iBAC/B,CAAC,CAAC;YACL,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC,CAAC,CAAC;QACH,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,kEAAkE;IAClE,6DAA6D;IAC7D,wCAAwC;IACjC,KAAK,CAAC,4BAA4B,CAAC,IAAU,EAAE,QAAgB;QACpE,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,UAAU,CAAC,WAAW,EAAE,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IACzD,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,oBAAoB;QAC/B,OAAO,WAAW,IAAI,CAAC,WAAW,EAAE,0BAA0B,CAAC;IACjE,CAAC;IAEM,KAAK,CAAC,KAAK,CAAI,KAAmD;QACvE,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,KAAK,EAAE;YAC9B,GAAG,IAAI,CAAC,WAAW;YACnB,eAAe,EAAE,CAAC,OAAO,EAAE,EAAE;gBAC3B,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,YAAY,OAAO,CAAC,WAAW,6BAA6B,OAAO,CAAC,KAAK,GAAG,CAAC,CAAC;YAClG,CAAC;SACF,CAAC,CAAC;QACH,OAAO,GAAG,CAAC;IACb,CAAC;CACF;AAED,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAAC,IAAyB,EAAE,OAAO,GAAG,MAAM;IACjF,MAAM,gBAAgB,GAAG,IAAI,CAAC,OAAO,CAAC,iEAAiE,CAAC,CAAC;IACzG,MAAM,gBAAgB,CAAC,KAAK,EAAE,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,OAAO,EAAE,CAAC,CAAC;IACvE,MAAM,aAAa,GAAG,CAAC,MAAM,gBAAgB,CAAC,aAAa,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IACpG,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC/B,MAAM,IAAI,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;IACpC,CAAC;SAAM,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACpC,MAAM,IAAI,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC5C,CAAC;AACH,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,83 @@
+import { readFileSync } from 'fs';
+import { BrowserforceCommand } from '../../browserforce-command.js';
+import { maskSensitiveValues } from '../../plugins/utils.js';
+// Convert camelCase to kebab-case (e.g., "authProviders" -> "auth-providers")
+function camelToKebab(str) {
+    return str.replace(/([a-z0-9])([A-Z])/g, '$1-$2').toLowerCase();
+}
+// Load schema for a plugin
+function loadPluginSchema(pluginName) {
+    try {
+        // Resolve schema path relative to the plugins directory
+        // Since we're in src/commands/browserforce/, we need to go up to src/plugins/
+        const schemaPath = new URL(`../../plugins/${camelToKebab(pluginName)}/schema.json`, import.meta.url);
+        const schemaContent = readFileSync(schemaPath, 'utf8');
+        return JSON.parse(schemaContent);
+    }
+    catch (error) {
+        // Schema file not found or invalid - return undefined to fall back to pattern matching
+        return undefined;
+    }
+}
+export class BrowserforceApply extends BrowserforceCommand {
+    static description = 'apply a plan from a config file';
+    static examples = [
+        `$ <%= config.bin %> <%= command.id %> -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
+  `,
+    ];
+    async run() {
+        const { flags } = await this.parse(BrowserforceApply);
+        this.log(`Applying config file ${flags.definitionfile} to org ${flags['target-org'].getUsername()}`);
+        for (const setting of this.settings) {
+            const driver = setting.Driver;
+            const instance = new driver(this.browserforce);
+            this.spinner.start(`[${driver.name}] retrieving state`);
+            await this.browserforce.browserContext.tracing.group(driver.name);
+            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);
+            const action = flags['dry-run'] ? 'would change' : 'changing';
+            if (diff !== undefined) {
+                // Load schema for this plugin to check for password fields
+                const schema = loadPluginSchema(setting.key);
+                // Mask sensitive values before logging (using schema if available)
+                const maskedDiff = maskSensitiveValues(diff, '', schema);
+                this.spinner.start(`[${driver.name}] ${Object.keys(maskedDiff)
+                    .map((key) => {
+                    return `${action} '${key}' to '${JSON.stringify(maskedDiff[key])}'`;
+                })
+                    .join('\n')}`);
+                if (!flags['dry-run']) {
+                    try {
+                        await instance.apply(diff);
+                    }
+                    catch (err) {
+                        this.spinner.stop('failed');
+                        throw err;
+                    }
+                    this.spinner.stop();
+                }
+                await this.browserforce.browserContext.tracing.groupEnd();
+            }
+            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,YAAY,EAAE,MAAM,IAAI,CAAC;AAClC,OAAO,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AACpE,OAAO,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAE7D,8EAA8E;AAC9E,SAAS,YAAY,CAAC,GAAW;IAC/B,OAAO,GAAG,CAAC,OAAO,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAC,WAAW,EAAE,CAAC;AAClE,CAAC;AAED,2BAA2B;AAC3B,SAAS,gBAAgB,CAAC,UAAkB;IAC1C,IAAI,CAAC;QACH,wDAAwD;QACxD,8EAA8E;QAC9E,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,iBAAiB,YAAY,CAAC,UAAU,CAAC,cAAc,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACrG,MAAM,aAAa,GAAG,YAAY,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;QACvD,OAAO,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;IACnC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,uFAAuF;QACvF,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAMD,MAAM,OAAO,iBAAkB,SAAQ,mBAA8C;IAC5E,MAAM,CAAC,WAAW,GAAG,iCAAiC,CAAC;IACvD,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,CAAC,wBAAwB,KAAK,CAAC,cAAc,WAAW,KAAK,CAAC,YAAY,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;QACrG,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,YAAY,CAAC,CAAC;YAC/C,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,IAAI,oBAAoB,CAAC,CAAC;YACxD,MAAM,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YAClE,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,MAAM,MAAM,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,UAAU,CAAC;YAC9D,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;gBACvB,2DAA2D;gBAC3D,MAAM,MAAM,GAAG,gBAAgB,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;gBAC7C,mEAAmE;gBACnE,MAAM,UAAU,GAAG,mBAAmB,CAAC,IAAI,EAAE,EAAE,EAAE,MAAM,CAAgB,CAAC;gBACxE,IAAI,CAAC,OAAO,CAAC,KAAK,CAChB,IAAI,MAAM,CAAC,IAAI,KAAK,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC;qBACxC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;oBACX,OAAO,GAAG,MAAM,KAAK,GAAG,SAAS,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC;gBACtE,CAAC,CAAC;qBACD,IAAI,CAAC,IAAI,CAAC,EAAE,CAChB,CAAC;gBACF,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC;oBACtB,IAAI,CAAC;wBACH,MAAM,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;oBAC7B,CAAC;oBAAC,OAAO,GAAG,EAAE,CAAC;wBACb,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;wBAC5B,MAAM,GAAG,CAAC;oBACZ,CAAC;oBACD,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;gBACtB,CAAC;gBACD,MAAM,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;YAC5D,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/playwright.d.ts

@@ -0,0 +1,9 @@
+import { SfCommand } from '@salesforce/sf-plugins-core';
+export declare class BrowserforcePlaywrightCommand extends SfCommand<string> {
+    static description: string;
+    static examples: string[];
+    static strict: boolean;
+    static enableJsonFlag: boolean;
+    static baseFlags: any;
+    run(): Promise<string>;
+}

package/lib/commands/browserforce/playwright.js

@@ -0,0 +1,53 @@
+import { SfCommand } from '@salesforce/sf-plugins-core';
+import { spawn } from 'child_process';
+import { dirname } from 'node:path';
+import { fileURLToPath } from 'node:url';
+const __dirname = dirname(fileURLToPath(import.meta.url));
+export class BrowserforcePlaywrightCommand extends SfCommand {
+    static description = 'access the Playwright CLI';
+    static examples = [
+        `$ <%= config.bin %> <%= command.id %> -- --help`,
+        `$ <%= config.bin %> <%= command.id %> -- --version`,
+        `$ <%= config.bin %> <%= command.id %> -- install --list`,
+        `$ <%= config.bin %> <%= command.id %> -- install chromium`,
+    ];
+    static strict = false;
+    static enableJsonFlag = false;
+    static baseFlags = undefined;
+    async run() {
+        const { argv } = await this.parse(BrowserforcePlaywrightCommand);
+        const args = argv;
+        const isTest = process.env.NODE_ENV === 'test' || process.env.npm_lifecycle_event === 'test';
+        const child = spawn('npx', ['playwright', ...args], {
+            // Run this command wherever browserforce has been installed to.
+            // When running npx playwright install in another folder, it needs to be downloaded first
+            // AND it could resolve to another playwright version not compatible with sfdx-browserforce-plugin.
+            cwd: __dirname,
+            stdio: 'pipe',
+        });
+        return new Promise((resolve, reject) => {
+            let stdout = '';
+            if (!isTest) {
+                child.stdout?.pipe(process.stdout);
+                child.stderr?.pipe(process.stderr);
+            }
+            else {
+                child.stdout.on('data', (chunk) => {
+                    stdout += chunk.toString();
+                });
+            }
+            child.on('close', (code) => {
+                if (code === 0) {
+                    resolve(stdout);
+                }
+                else {
+                    process.exit(code || 1);
+                }
+            });
+            child.on('error', (error) => {
+                reject(error);
+            });
+        });
+    }
+}
+//# sourceMappingURL=playwright.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"playwright.js","sourceRoot":"","sources":["../../../src/commands/browserforce/playwright.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAC;AACxD,OAAO,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AACtC,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzC,MAAM,SAAS,GAAG,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AAE1D,MAAM,OAAO,6BAA8B,SAAQ,SAAiB;IAC3D,MAAM,CAAC,WAAW,GAAG,2BAA2B,CAAC;IACjD,MAAM,CAAC,QAAQ,GAAG;QACvB,iDAAiD;QACjD,oDAAoD;QACpD,yDAAyD;QACzD,2DAA2D;KAC5D,CAAC;IAEK,MAAM,CAAC,MAAM,GAAG,KAAK,CAAC;IACtB,MAAM,CAAC,cAAc,GAAG,KAAK,CAAC;IAC9B,MAAM,CAAC,SAAS,GAAG,SAAS,CAAC;IAE7B,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,6BAA6B,CAAC,CAAC;QACjE,MAAM,IAAI,GAAG,IAAgB,CAAC;QAC9B,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,MAAM,IAAI,OAAO,CAAC,GAAG,CAAC,mBAAmB,KAAK,MAAM,CAAC;QAC7F,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,EAAE,CAAC,YAAY,EAAE,GAAG,IAAI,CAAC,EAAE;YAClD,gEAAgE;YAChE,yFAAyF;YACzF,mGAAmG;YACnG,GAAG,EAAE,SAAS;YACd,KAAK,EAAE,MAAM;SACd,CAAC,CAAC;QAEH,OAAO,IAAI,OAAO,CAAS,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC7C,IAAI,MAAM,GAAG,EAAE,CAAC;YAChB,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;gBACnC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YACrC,CAAC;iBAAM,CAAC;gBACN,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE;oBAChC,MAAM,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;gBAC7B,CAAC,CAAC,CAAC;YACL,CAAC;YAED,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,EAAE;gBACzB,IAAI,IAAI,KAAK,CAAC,EAAE,CAAC;oBACf,OAAO,CAAC,MAAM,CAAC,CAAC;gBAClB,CAAC;qBAAM,CAAC;oBACN,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC;gBAC1B,CAAC;YACH,CAAC,CAAC,CAAC;YAEH,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;gBAC1B,MAAM,CAAC,KAAK,CAAC,CAAC;YAChB,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,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,CAAC,gCAAgC,UAAU,oBAAoB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBACxG,CAAC;YACH,CAAC;QACH,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,+CAA+C,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACzF,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"}

package/lib/pages/login.d.ts

@@ -0,0 +1,7 @@
+import { type Connection } from '@salesforce/core';
+import { type Page } from 'playwright';
+export declare class LoginPage {
+    private page;
+    constructor(page: Page);
+    login(connection: Connection): Promise<this>;
+}

package/lib/pages/login.js

@@ -0,0 +1,17 @@
+import { Org } from '@salesforce/core';
+import { waitForPageErrors } from '../browserforce.js';
+const POST_LOGIN_PATH = '/setup/forcecomHomepage.apexp';
+export class LoginPage {
+    page;
+    constructor(page) {
+        this.page = page;
+    }
+    async login(connection) {
+        const org = await Org.create({ connection });
+        const frontDoorUrl = await org.getFrontDoorUrl(POST_LOGIN_PATH);
+        await this.page.goto(frontDoorUrl);
+        await Promise.race([this.page.waitForURL((url) => url.pathname === POST_LOGIN_PATH), waitForPageErrors(this.page)]);
+        return this;
+    }
+}
+//# sourceMappingURL=login.js.map

package/lib/pages/login.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"login.js","sourceRoot":"","sources":["../../src/pages/login.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAmB,MAAM,kBAAkB,CAAC;AAExD,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAEvD,MAAM,eAAe,GAAG,+BAA+B,CAAC;AAExD,MAAM,OAAO,SAAS;IACZ,IAAI,CAAO;IAEnB,YAAY,IAAU;QACpB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,UAAsB;QAChC,MAAM,GAAG,GAAG,MAAM,GAAG,CAAC,MAAM,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC;QAC7C,MAAM,YAAY,GAAG,MAAM,GAAG,CAAC,eAAe,CAAC,eAAe,CAAC,CAAC;QAChE,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QACnC,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,KAAK,eAAe,CAAC,EAAE,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACpH,OAAO,IAAI,CAAC;IACd,CAAC;CACF"}

package/lib/plugin.d.ts

@@ -0,0 +1,15 @@
+import { Browserforce } from './browserforce.js';
+export declare abstract class BrowserforcePlugin {
+    protected browserforce: Browserforce;
+    constructor(browserforce: Browserforce);
+    abstract retrieve(definition?: unknown): Promise<unknown>;
+    /**
+     * deep diff
+     * @param state
+     * @param definition
+     * @returns undefined when there is no diff
+     */
+    diff(state: unknown, definition: unknown): unknown;
+    abstract apply(plan: unknown): Promise<unknown>;
+    run(definition: unknown): Promise<unknown>;
+}

package/lib/plugin.js

@@ -0,0 +1,28 @@
+import { deepDiff } from './plugins/utils.js';
+export class BrowserforcePlugin {
+    browserforce;
+    constructor(browserforce) {
+        this.browserforce = browserforce;
+    }
+    /**
+     * deep diff
+     * @param state
+     * @param definition
+     * @returns undefined when there is no diff
+     */
+    diff(state, definition) {
+        return deepDiff(state, definition);
+    }
+    async run(definition) {
+        const state = await this.retrieve(definition);
+        const diff = this.diff(state, definition);
+        if (diff !== undefined) {
+            const result = await this.apply(diff);
+            return result;
+        }
+        return {
+            message: 'no action necessary',
+        };
+    }
+}
+//# sourceMappingURL=plugin.js.map

package/lib/plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAE9C,MAAM,OAAgB,kBAAkB;IAC5B,YAAY,CAAe;IAErC,YAAmB,YAA0B;QAC3C,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;IACnC,CAAC;IAED;;;;;OAKG;IACI,IAAI,CAAC,KAAc,EAAE,UAAmB;QAC7C,OAAO,QAAQ,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;IACrC,CAAC;IAEM,KAAK,CAAC,GAAG,CAAC,UAAmB;QAClC,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;QAC9C,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;QAC1C,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACtC,OAAO,MAAM,CAAC;QAChB,CAAC;QACD,OAAO;YACL,OAAO,EAAE,qBAAqB;SAC/B,CAAC;IACJ,CAAC;CACF"}

package/lib/plugins/activity-settings/index.d.ts

@@ -0,0 +1,9 @@
+import { BrowserforcePlugin } from '../../plugin.js';
+type Config = {
+    allowUsersToRelateMultipleContactsToTasksAndEvents: boolean;
+};
+export declare class ActivitySettings extends BrowserforcePlugin {
+    retrieve(): Promise<Config>;
+    apply(config: Config): Promise<void>;
+}
+export {};

package/lib/plugins/activity-settings/index.e2e-spec.d.ts

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

package/lib/plugins/activity-settings/index.e2e-spec.js

@@ -0,0 +1,36 @@
+import assert from 'assert';
+import { ActivitySettings } from './index.js';
+describe(ActivitySettings.name, function () {
+    let plugin;
+    before(() => {
+        plugin = new ActivitySettings(global.browserforce);
+    });
+    describe('allowUsersToRelateMultipleContactsToTasksAndEvents', () => {
+        const configEnabled = {
+            allowUsersToRelateMultipleContactsToTasksAndEvents: true,
+        };
+        const configDisabled = {
+            allowUsersToRelateMultipleContactsToTasksAndEvents: false,
+        };
+        it('should enable', async () => {
+            await plugin.run(configEnabled);
+        });
+        it('should be enabled', async () => {
+            const res = await plugin.retrieve();
+            assert.deepStrictEqual(res, configEnabled);
+        });
+        it('should fail to disable', async () => {
+            let err;
+            try {
+                await plugin.apply(configDisabled);
+            }
+            catch (e) {
+                err = e;
+            }
+            assert.throws(() => {
+                throw err;
+            }, /can only be disabled/);
+        });
+    });
+});
+//# sourceMappingURL=index.e2e-spec.js.map

package/lib/plugins/activity-settings/index.e2e-spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.e2e-spec.js","sourceRoot":"","sources":["../../../src/plugins/activity-settings/index.e2e-spec.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAE9C,QAAQ,CAAC,gBAAgB,CAAC,IAAI,EAAE;IAC9B,IAAI,MAAwB,CAAC;IAC7B,MAAM,CAAC,GAAG,EAAE;QACV,MAAM,GAAG,IAAI,gBAAgB,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;IACrD,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,oDAAoD,EAAE,GAAG,EAAE;QAClE,MAAM,aAAa,GAAG;YACpB,kDAAkD,EAAE,IAAI;SACzD,CAAC;QACF,MAAM,cAAc,GAAG;YACrB,kDAAkD,EAAE,KAAK;SAC1D,CAAC;QAEF,EAAE,CAAC,eAAe,EAAE,KAAK,IAAI,EAAE;YAC7B,MAAM,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;QAClC,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,mBAAmB,EAAE,KAAK,IAAI,EAAE;YACjC,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,QAAQ,EAAE,CAAC;YACpC,MAAM,CAAC,eAAe,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,wBAAwB,EAAE,KAAK,IAAI,EAAE;YACtC,IAAI,GAAG,CAAC;YACR,IAAI,CAAC;gBACH,MAAM,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;YACrC,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,GAAG,GAAG,CAAC,CAAC;YACV,CAAC;YACD,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE;gBACjB,MAAM,GAAG,CAAC;YACZ,CAAC,EAAE,sBAAsB,CAAC,CAAC;QAC7B,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}