sfdx-deliverability-access 0.0.0

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Max Goldfarb
+
+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,38 @@
+
+sfdx-deliverability-access
+======================
+## `sfdx deliverability:access [-l <string>] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
+
+This SFDX Plugin was created to set Email Deliverability Access Level for an org easily and quickly. This project uses Selenium, Webdriver and headless browsing to open Setup in the target org and set Email Deliverability Access Level to the desired value.
+```
+USAGE
+  $ sfdx deliverability:access [-l <string>] [-u <string>] [--json] [--loglevel 
+  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
+
+OPTIONS
+  -l, --level=level
+      No access: None, none, n, 0
+      System email only: System, system, s, 1
+      All email: All, all, a, 2)
+
+  -u, --user=user
+      Username or alias for the target org; overrides default target org
+
+  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)
+      [default: warn] logging level for this command invocation
+
+EXAMPLES
+  sfdx deliverability:access --level All
+  sfdx deliverability:access --level None
+  sfdx deliverability:access --level System
+  sfdx deliverability:access --level a -u gfarb@github.com
+```
+## Version History
+
+* 0.1
+
+* Initial Release
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE.md file for details

package/lib/commands/deliverability/access.d.ts

@@ -0,0 +1,25 @@
+import { flags, SfdxCommand } from '@salesforce/command';
+export interface JsonResponse {
+    status: number;
+    result: Result;
+}
+export interface Result {
+    orgId: string;
+    url: string;
+    username: string;
+}
+export default class Access extends SfdxCommand {
+    static description: string;
+    static examples: string[];
+    static args: {
+        name: string;
+    }[];
+    protected static flagsConfig: {
+        level: flags.Discriminated<flags.String>;
+        user: flags.Discriminated<flags.String>;
+    };
+    protected static requiresProject: boolean;
+    run(): Promise<void>;
+    private parseOrgData;
+    private toggleDeliverability;
+}

package/lib/commands/deliverability/access.js

@@ -0,0 +1,100 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const os = require("os");
+const child_process_1 = require("child_process");
+const command_1 = require("@salesforce/command");
+const core_1 = require("@salesforce/core");
+const webdriver = require("selenium-webdriver");
+const chrome = require("selenium-webdriver/chrome");
+const until = require("selenium-webdriver/lib/until");
+require('chromedriver');
+const accessValuesMap = new Map([
+    ['none', '0'],
+    ['n', '0'],
+    ['0', '0'],
+    ['system', '1'],
+    ['s', '1'],
+    ['1', '1'],
+    ['all', '2'],
+    ['a', '2'],
+    ['2', '2'],
+]);
+core_1.Messages.importMessagesDirectory(__dirname);
+const messages = core_1.Messages.loadMessages('sfdx-deliverability-access', 'org');
+class Access extends command_1.SfdxCommand {
+    async run() {
+        this.ux.startSpinner('Attempting to set Email Deliverability Access Level');
+        const accessLevel = this.flags.level;
+        const childElementIndex = String(accessValuesMap.get(accessLevel.toLowerCase()));
+        if (Number(childElementIndex) > -1 && Number(childElementIndex) < 3) {
+            const accessUrl = await this.parseOrgData(String(this.flags.user));
+            void this.toggleDeliverability(accessUrl, childElementIndex);
+        }
+        else {
+            this.ux.stopSpinner('Access Level could not be set');
+            throw new core_1.SfdxError(`${accessLevel} is not a valid value for the Level flag.`, 'Invalid value for Level flag');
+        }
+    }
+    parseOrgData(user) {
+        return new Promise((resolve) => {
+            const orgDataCommand = (user === null || user === void 0 ? void 0 : user.length) > 0 ? `sfdx force:org:open -r --json -u ${user}` : 'sfdx force:org:open -r --json';
+            (0, child_process_1.exec)(orgDataCommand, (error, stdout, stderr) => {
+                if (error) {
+                    this.ux.stopSpinner('Access Level could not be set');
+                    throw new core_1.SfdxError(error.message, error.name);
+                }
+                if (stderr) {
+                    this.ux.stopSpinner('Access Level could not be set');
+                    throw new core_1.SfdxError(stderr, 'sfdx force:org:open');
+                }
+                if (stdout) {
+                    const response = JSON.parse(stdout);
+                    resolve(response.result.url.replace('my.salesforce', 'lightning.force') +
+                        '&retURL=/lightning/setup/OrgEmailSettings/home');
+                }
+            });
+        });
+    }
+    async toggleDeliverability(accessUrl, childElementIndex) {
+        const options = new chrome.Options();
+        // .addArguments('--no-sandbox')
+        // .addArguments('--disable-dev-shm-usage')
+        // .addArguments('--headless');
+        const driver = await new webdriver.Builder().forBrowser('chrome').setChromeOptions(options).build();
+        try {
+            await driver.manage().setTimeouts({ implicit: 30000, pageLoad: 30000, script: 30000 });
+            await driver.get(accessUrl);
+            await driver.wait(until.titleIs('Deliverability | Salesforce'), 30000);
+            await driver.sleep(3000);
+            await driver.switchTo().frame(0);
+            const scriptToSetAccessLevel = `document.getElementsByClassName('pbSubsection')[0].children[0].children[0].children[0].children[0].children[0].children[${childElementIndex}].selected=true`;
+            await driver.executeScript(scriptToSetAccessLevel);
+            await driver.findElement(webdriver.By.id('thePage:theForm:editBlock:buttons:saveBtn')).click();
+            await driver.sleep(1000);
+            this.ux.stopSpinner('Email Deliverability Access Level has been set!');
+        }
+        catch (error) {
+            this.ux.stopSpinner('Access Level could not be set');
+            this.ux.log(`The following error occurred:\n${String(error)}`);
+        }
+        finally {
+            await driver.quit();
+        }
+    }
+}
+exports.default = Access;
+Access.description = messages.getMessage('commandDescription');
+Access.examples = messages.getMessage('examples').split(os.EOL);
+Access.args = [{ name: 'file' }];
+Access.flagsConfig = {
+    level: command_1.flags.string({
+        char: 'l',
+        description: messages.getMessage('levelFlagDescription'),
+    }),
+    user: command_1.flags.string({
+        char: 'u',
+        description: messages.getMessage('userFlagDescription'),
+    }),
+};
+Access.requiresProject = false;
+//# sourceMappingURL=access.js.map

package/lib/commands/deliverability/access.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"access.js","sourceRoot":"","sources":["../../../src/commands/deliverability/access.ts"],"names":[],"mappings":";;AAAA,yBAAyB;AACzB,iDAAqC;AACrC,iDAAyD;AACzD,2CAAuD;AACvD,gDAAiD;AACjD,oDAAqD;AACrD,sDAAuD;AACvD,OAAO,CAAC,cAAc,CAAC,CAAC;AAExB,MAAM,eAAe,GAAG,IAAI,GAAG,CAAiB;IAC9C,CAAC,MAAM,EAAE,GAAG,CAAC;IACb,CAAC,GAAG,EAAE,GAAG,CAAC;IACV,CAAC,GAAG,EAAE,GAAG,CAAC;IACV,CAAC,QAAQ,EAAE,GAAG,CAAC;IACf,CAAC,GAAG,EAAE,GAAG,CAAC;IACV,CAAC,GAAG,EAAE,GAAG,CAAC;IACV,CAAC,KAAK,EAAE,GAAG,CAAC;IACZ,CAAC,GAAG,EAAE,GAAG,CAAC;IACV,CAAC,GAAG,EAAE,GAAG,CAAC;CACX,CAAC,CAAC;AAEH,eAAQ,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC;AAE5C,MAAM,QAAQ,GAAG,eAAQ,CAAC,YAAY,CAAC,4BAA4B,EAAE,KAAK,CAAC,CAAC;AAY5E,MAAqB,MAAO,SAAQ,qBAAW;IAoBtC,KAAK,CAAC,GAAG;QACd,IAAI,CAAC,EAAE,CAAC,YAAY,CAAC,qDAAqD,CAAC,CAAC;QAC5E,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,KAAe,CAAC;QAC/C,MAAM,iBAAiB,GAAG,MAAM,CAAC,eAAe,CAAC,GAAG,CAAC,WAAW,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;QACjF,IAAI,MAAM,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,IAAI,MAAM,CAAC,iBAAiB,CAAC,GAAG,CAAC,EAAE;YACnE,MAAM,SAAS,GAAW,MAAM,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;YAC3E,KAAK,IAAI,CAAC,oBAAoB,CAAC,SAAS,EAAE,iBAAiB,CAAC,CAAC;SAC9D;aAAM;YACL,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,+BAA+B,CAAC,CAAC;YACrD,MAAM,IAAI,gBAAS,CAAC,GAAG,WAAW,2CAA2C,EAAE,8BAA8B,CAAC,CAAC;SAChH;IACH,CAAC;IAEO,YAAY,CAAC,IAAY;QAC/B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAC7B,MAAM,cAAc,GAClB,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,IAAG,CAAC,CAAC,CAAC,CAAC,oCAAoC,IAAI,EAAE,CAAC,CAAC,CAAC,+BAA+B,CAAC;YAClG,IAAA,oBAAI,EAAC,cAAc,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE;gBAC7C,IAAI,KAAK,EAAE;oBACT,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,+BAA+B,CAAC,CAAC;oBACrD,MAAM,IAAI,gBAAS,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;iBAChD;gBACD,IAAI,MAAM,EAAE;oBACV,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,+BAA+B,CAAC,CAAC;oBACrD,MAAM,IAAI,gBAAS,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;iBACpD;gBACD,IAAI,MAAM,EAAE;oBACV,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAiB,CAAC;oBACpD,OAAO,CACL,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,eAAe,EAAE,iBAAiB,CAAC;wBAC7D,gDAAgD,CACnD,CAAC;iBACH;YACH,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,oBAAoB,CAAC,SAAiB,EAAE,iBAAyB;QAC7E,MAAM,OAAO,GAAG,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QACrC,gCAAgC;QAChC,2CAA2C;QAC3C,+BAA+B;QAC/B,MAAM,MAAM,GAAG,MAAM,IAAI,SAAS,CAAC,OAAO,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,CAAC;QACpG,IAAI;YACF,MAAM,MAAM,CAAC,MAAM,EAAE,CAAC,WAAW,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;YACvF,MAAM,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;YAC5B,MAAM,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,6BAA6B,CAAC,EAAE,KAAK,CAAC,CAAC;YACvE,MAAM,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACzB,MAAM,MAAM,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YACjC,MAAM,sBAAsB,GAAG,2HAA2H,iBAAiB,iBAAiB,CAAC;YAC7L,MAAM,MAAM,CAAC,aAAa,CAAC,sBAAsB,CAAC,CAAC;YACnD,MAAM,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE,CAAC,2CAA2C,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;YAC/F,MAAM,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACzB,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,iDAAiD,CAAC,CAAC;SACxE;QAAC,OAAO,KAAK,EAAE;YACd,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,+BAA+B,CAAC,CAAC;YACrD,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,kCAAkC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;SAChE;gBAAS;YACR,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;SACrB;IACH,CAAC;;AAhFH,yBAiFC;AAhFe,kBAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,oBAAoB,CAAC,CAAC;AAExD,eAAQ,GAAG,QAAQ,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;AAEzD,WAAI,GAAG,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;AAEvB,kBAAW,GAAG;IAC7B,KAAK,EAAE,eAAK,CAAC,MAAM,CAAC;QAClB,IAAI,EAAE,GAAG;QACT,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,sBAAsB,CAAC;KACzD,CAAC;IACF,IAAI,EAAE,eAAK,CAAC,MAAM,CAAC;QACjB,IAAI,EAAE,GAAG;QACT,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,qBAAqB,CAAC;KACxD,CAAC;CACH,CAAC;AAEe,sBAAe,GAAG,KAAK,CAAC"}

package/lib/index.d.ts

@@ -0,0 +1,2 @@
+declare const _default: {};
+export default _default;

package/lib/index.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = {};
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

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

package/messages/org.json

@@ -0,0 +1,10 @@
+{
+  "commandDescription": "Set Email Deliverability Access Level for an org.",
+  "userFlagDescription": "Username or alias for the target org; overrides default target org",
+  "levelFlagDescription": "No access: None, none, n, 0\nSystem email only: System, system, s, 1\nAll email: All, all, a, 2",
+  "examples": [
+    "sfdx deliverability:access --level All",
+    "sfdx deliverability:access --level None",
+    "sfdx deliverability:access --level System"
+  ]
+}

package/oclif.manifest.json

@@ -0,0 +1 @@
+{"version":"0.0.0","commands":{"deliverability:access":{"id":"deliverability:access","description":"Set Email Deliverability Access Level for an org.","usage":"<%= command.id %> [-l <string>] [-u <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"sfdx-deliverability-access","pluginType":"core","aliases":[],"examples":["sfdx deliverability:access --level All","sfdx deliverability:access --level None","sfdx deliverability:access --level System"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"level":{"name":"level","type":"option","char":"l","description":"No access: None, none, n, 0\nSystem email only: System, system, s, 1\nAll email: All, all, a, 2"},"user":{"name":"user","type":"option","char":"u","description":"Username or alias for the target org; overrides default target org"}},"args":[{"name":"file"}]}}}

package/package.json

@@ -0,0 +1,88 @@
+{
+  "name": "sfdx-deliverability-access",
+  "description": "email deliv",
+  "version": "0.0.0",
+  "author": "gfarb @gfarb",
+  "bugs": "https://github.com/gfarb/sfdx-deliverability-access/issues",
+  "dependencies": {
+    "@oclif/command": "^1",
+    "@oclif/config": "^1",
+    "@oclif/errors": "^1",
+    "@salesforce/command": "^4",
+    "@salesforce/core": "^2",
+    "chromedriver": "^99.0.0",
+    "selenium-webdriver": "^4.1.1",
+    "tslib": "^2"
+  },
+  "devDependencies": {
+    "@oclif/dev-cli": "^1",
+    "@oclif/plugin-help": "^3",
+    "@oclif/test": "^1",
+    "@salesforce/dev-config": "^2",
+    "@salesforce/dev-scripts": "^0",
+    "@salesforce/prettier-config": "^0",
+    "@salesforce/ts-sinon": "^1",
+    "@types/chai": "^4",
+    "@types/jsforce": "^1.9.29",
+    "@types/mocha": "^8",
+    "@types/selenium-webdriver": "^4.0.18",
+    "@typescript-eslint/eslint-plugin": "^4",
+    "@typescript-eslint/parser": "^4",
+    "chai": "^4",
+    "eslint": "^7",
+    "eslint-config-oclif": "^3.1",
+    "eslint-config-prettier": "^8",
+    "eslint-config-salesforce": "^0",
+    "eslint-config-salesforce-typescript": "^0",
+    "eslint-plugin-header": "^3",
+    "eslint-plugin-import": "^2",
+    "eslint-plugin-jsdoc": "^35",
+    "eslint-plugin-prettier": "^3",
+    "eslint-plugin-typescript": "^0",
+    "globby": "^11",
+    "husky": "^4",
+    "mocha": "^8",
+    "nyc": "^15",
+    "prettier": "^2",
+    "pretty-quick": "^3",
+    "sinon": "10.0.0",
+    "ts-node": "^10",
+    "typescript": "4"
+  },
+  "engines": {
+    "node": ">=12.0.0"
+  },
+  "files": [
+    "/lib",
+    "/messages",
+    "/npm-shrinkwrap.json",
+    "/oclif.manifest.json"
+  ],
+  "homepage": "https://github.com/gfarb/sfdx-deliverability-access",
+  "keywords": [
+    "sfdx-plugin"
+  ],
+  "license": "MIT",
+  "oclif": {
+    "commands": "./lib/commands",
+    "bin": "sfdx",
+    "topics": {
+      "hello": {
+        "description": "Commands to say hello."
+      }
+    },
+    "devPlugins": [
+      "@oclif/plugin-help"
+    ]
+  },
+  "repository": "gfarb/sfdx-deliverability-access",
+  "scripts": {
+    "build": "tsc -p .",
+    "lint": "eslint src/**/*.ts test/**/*.ts",
+    "postpack": "rm -f oclif.manifest.json",
+    "posttest": "eslint src/**/*.ts test/**/*.ts",
+    "prepack": "rm -rf lib && tsc -b && oclif-dev manifest && oclif-dev readme",
+    "test": "nyc --extension .ts --require ts-node/register mocha --forbid-only \"test/**/*.test.ts\"",
+    "version": "oclif-dev readme && git add README.md"
+  }
+}