feat: add Einstein Bots plugin to enable/disable Einstein Bots

src/plugins/einstein-bots/disable.json

@@ -0,0 +1,9 @@
+{
+  "$schema": "../schema.json",
+  "settings": {
+    "einsteinBots": {
+      "enabled": false
+    }
+  }
+}
+

src/plugins/einstein-bots/enable.json

@@ -0,0 +1,9 @@
+{
+  "$schema": "../schema.json",
+  "settings": {
+    "einsteinBots": {
+      "enabled": true
+    }
+  }
+}
+

src/plugins/einstein-bots/index.e2e-spec.ts

@@ -0,0 +1,36 @@
+import assert from 'assert';
+import { EinsteinBots } from './index.js';
+
+describe(EinsteinBots.name, function () {
+  this.timeout('10m');
+  let plugin: EinsteinBots;
+  before(() => {
+    plugin = new EinsteinBots(global.browserforce);
+  });
+
+  const configEnabled = {
+    enabled: true,
+  };
+  const configDisabled = {
+    enabled: false,
+  };
+
+  it('should enable Einstein Bots', async () => {
+    await plugin.run(configEnabled);
+  });
+
+  it('should verify Einstein Bots is enabled', async () => {
+    const res = await plugin.retrieve();
+    assert.deepStrictEqual(res, configEnabled);
+  });
+
+  it('should disable Einstein Bots', async () => {
+    await plugin.run(configDisabled);
+  });
+
+  it('should verify Einstein Bots is disabled', async () => {
+    const res = await plugin.retrieve();
+    assert.deepStrictEqual(res, configDisabled);
+  });
+});
+

src/plugins/einstein-bots/index.ts

@@ -0,0 +1,48 @@
+import { BrowserforcePlugin } from '../../plugin.js';
+
+const BASE_PATH = '/lightning/setup/EinsteinBots/home';
+
+// The checkbox input element (for reading state and clicking)
+const TOGGLE_INPUT_SELECTOR = 'input[type="checkbox"][aria-label*="Einstein Bots"]';
+
+type Config = {
+  enabled: boolean;
+};
+
+export class EinsteinBots extends BrowserforcePlugin {
+  public async retrieve(): Promise<Config> {
+    await using page = await this.browserforce.openPage(BASE_PATH);
+    await page.locator(TOGGLE_INPUT_SELECTOR).waitFor();
+    const response = {
+      enabled: await page.locator(TOGGLE_INPUT_SELECTOR).isChecked(),
+    };
+    return response;
+  }
+
+  public async apply(config: Config): Promise<void> {
+    await using page = await this.browserforce.openPage(BASE_PATH);
+    await page.locator(TOGGLE_INPUT_SELECTOR).waitFor();
+    const currentState = await page.locator(TOGGLE_INPUT_SELECTOR).isChecked();
+    // Only click if the state needs to change
+    if (currentState !== config.enabled) {
+      if (!config.enabled) {
+        // When disabling, click the toggle and wait for the confirmation dialog
+        await page.locator(TOGGLE_INPUT_SELECTOR).click({ force: true });
+
+        // Wait for the "Disable Einstein Bots" dialog and click Yes
+        const disableDialog = page.getByRole('dialog', { name: 'Disable Einstein Bots' });
+        await disableDialog.waitFor({ timeout: 5000 });
+        await disableDialog.getByRole('button', { name: 'Yes' }).click();
+
+        // Wait for the dialog to close (this is when the save happens)
+        await disableDialog.waitFor({ state: 'hidden', timeout: 10000 });
+      } else {
+        // When enabling, just click the toggle
+        await page.locator(TOGGLE_INPUT_SELECTOR).click({ force: true });
+      }
+
+      // Wait for the save to complete
+      await page.waitForTimeout(2000);
+    }
+  }
+}

src/plugins/einstein-bots/schema.json

@@ -0,0 +1,14 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "https://github.com/amtrack/sfdx-browserforce-plugin/src/plugins/einstein-bots/schema.json",
+  "title": "Einstein Bots",
+  "type": "object",
+  "properties": {
+    "enabled": {
+      "title": "Einstein Bots",
+      "description": "Enable or disable Einstein Bots. Setup -> Einstein Bots -> Einstein Bots toggle.",
+      "type": "boolean"
+    }
+  }
+}
+

src/plugins/index.ts

@@ -2,6 +2,7 @@ import { ActivitySettings as activitySettings } from './activity-settings/index.
 import { CompanyInformation as companyInformation } from './company-information/index.js';
 import { CustomerPortal as customerPortal } from './customer-portal/index.js';
 import { DensitySettings as densitySettings } from './density-settings/index.js';
+import { EinsteinBots as einsteinBots } from './einstein-bots/index.js';
 import { EmailDeliverability as emailDeliverability } from './email-deliverability/index.js';
 import { HighVelocitySalesSettings as highVelocitySalesSettings } from './high-velocity-sales-settings/index.js';
 import { HistoryTracking as historyTracking } from './history-tracking/index.js';
@@ -27,6 +28,7 @@ export {
   companyInformation,
   customerPortal,
   densitySettings,
+  einsteinBots,
   emailDeliverability,
   highVelocitySalesSettings,
   historyTracking,

src/plugins/schema.json

@@ -46,6 +46,9 @@
         "densitySettings": {
           "$ref": "./density-settings/schema.json"
         },
+        "einsteinBots": {
+          "$ref": "./einstein-bots/schema.json"
+        },
         "historyTracking": {
           "$ref": "./history-tracking/schema.json"
         },