Merge pull request #631 from amtrack/feat/esm

feat: refactor package as ES module

_templates/plugin/new/index.e2e-spec.ejs.t

@@ -2,7 +2,7 @@
 to: src/plugins/<%= h.changeCase.paramCase(name) %>/index.e2e-spec.ts
 ---
 import assert from 'assert';
-import { type Config, <%= h.changeCase.pascalCase(name) %> } from '.';
+import { type Config, <%= h.changeCase.pascalCase(name) %> } from './index.js';
 
 describe(<%= h.changeCase.pascalCase(name) %>.name, function() {
   let plugin: <%= h.changeCase.pascalCase(name) %>;

_templates/plugin/new/index.ejs.t

@@ -2,7 +2,7 @@
 to: src/plugins/<%= h.changeCase.paramCase(name) %>/index.ts
 sh: "npx prettier --write 'src/plugins/<%= h.changeCase.paramCase(name) %>/*' 'src/plugins/index.ts'"
 ---
-import { BrowserforcePlugin } from '../../plugin';
+import { BrowserforcePlugin } from '../../plugin.js';
 
 const PATHS = {
   BASE: 'partnerbt/loginAccessPolicies.apexp'

_templates/plugin/new/plugins-index.ejs.t

@@ -3,4 +3,4 @@ to: src/plugins/index.ts
 inject: true
 before: export {
 ---
-import { <%= name %> as <%= h.changeCase.camelCase(name) %> } from './<%= h.changeCase.paramCase(name) %>';
+import { <%= name %> as <%= h.changeCase.camelCase(name) %> } from './<%= h.changeCase.paramCase(name) %>/index.js';

bin/run

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

package.json

@@ -3,6 +3,7 @@
   "version": "0.0.0-development",
   "description": "sfdx plugin for browser automation",
   "author": "Matthias Rolke <mr.amtrack@gmail.com>",
+  "type": "module",
   "bin": {
     "sfdx-browserforce-plugin": "bin/run"
   },
@@ -24,13 +25,9 @@
     "ts-node": "10.9.1",
     "typescript": "5.2.2"
   },
-  "engines": {
-    "node": ">=14.0.0"
-  },
   "files": [
     "/bin",
     "/lib",
-    "/messages",
     "/oclif.manifest.json"
   ],
   "keywords": [
@@ -52,6 +49,10 @@
       "-h"
     ]
   },
+  "mocha": {
+    "loader": "ts-node/esm",
+    "no-warnings": "ExperimentalWarning"
+  },
   "repository": "amtrack/sfdx-browserforce-plugin",
   "scripts": {
     "build": "rm -rf lib && tsc -p . && oclif manifest",
@@ -60,7 +61,7 @@
     "generate:plugin": "npx hygen plugin new",
     "prepack": "yarn build",
     "prepare": "yarn build",
-    "test": "tsc --resolveJsonModule -p test && nyc --reporter=lcov --reporter=text mocha --require ts-node/register \"test/**/*.test.ts\" \"src/**/*.test.ts\"",
-    "test:e2e": "tsc --resolveJsonModule -p test && mocha --require ts-node/register --slow 30s --timeout 2m --file test/e2e-setup.ts \"test/**/*.e2e-spec.ts\" \"src/**/*.e2e-spec.ts\""
+    "test": "tsc -p test && nyc --reporter=lcov --reporter=text mocha \"test/**/*.test.ts\" \"src/**/*.test.ts\"",
+    "test:e2e": "tsc -p test && mocha --slow 30s --timeout 2m --file test/e2e-setup.ts \"test/**/*.e2e-spec.ts\" \"src/**/*.e2e-spec.ts\""
   }
 }

prettier.config.js

@@ -1,6 +1,6 @@
-const salesforcePrettierConfig = require('@salesforce/prettier-config');
+import salesforcePrettierConfig from '@salesforce/prettier-config';
 
-module.exports = {
+export default {
   ...salesforcePrettierConfig,
-  trailingComma: 'none'
+  singleQuote: false
 };

src/browserforce-command.ts

@@ -1,42 +1,39 @@
-import { Messages } from '@salesforce/core';
 import { Flags, SfCommand, Ux, requiredOrgFlagWithDeprecations } from '@salesforce/sf-plugins-core';
 import { promises } from 'fs';
 import * as path from 'path';
-import { Browserforce } from './browserforce';
-import { ConfigParser } from './config-parser';
-import * as DRIVERS from './plugins';
+import { Browserforce } from './browserforce.js';
+import { ConfigParser } from './config-parser.js';
+import * as DRIVERS from './plugin.js';
 
-Messages.importMessagesDirectory(__dirname);
-const messages = Messages.loadMessages('sfdx-browserforce-plugin', 'browserforce');
+const baseFlags = {
+  'target-org': requiredOrgFlagWithDeprecations,
+  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.'
+  })
+};
 
-export class BrowserforceCommand extends SfCommand<unknown> {
-  public static readonly flags = {
-    'target-org': requiredOrgFlagWithDeprecations,
-    definitionfile: Flags.string({
-      char: 'f',
-      summary: messages.getMessage('definitionFileDescription'),
-      description: messages.getMessage('definitionFileDescription')
-    }),
-    planfile: Flags.string({
-      char: 'p',
-      name: 'plan',
-      summary: messages.getMessage('planFileDescription'),
-      description: messages.getMessage('planFileDescription')
-    }),
-    statefile: Flags.string({
-      char: 's',
-      name: 'state',
-      summary: messages.getMessage('stateFileDescription'),
-      description: messages.getMessage('stateFileDescription')
-    })
-  };
+export abstract class BrowserforceCommand<T> extends SfCommand<T> {
 
   protected bf: Browserforce;
   protected settings: any[];
 
   public async init(): Promise<void> {
-    const { flags } = await this.parse(BrowserforceCommand);
     await super.init();
+    const { flags } = await this.parse({
+      flags: this.ctor.flags,
+      baseFlags
+    });
     let definition;
     if (flags.definitionfile) {
       const definitionFileData = await promises.readFile(path.resolve(flags.definitionfile), 'utf8');
@@ -54,10 +51,6 @@ export class BrowserforceCommand extends SfCommand<unknown> {
     this.spinner.stop();
   }
 
-  public async run(): Promise<unknown> {
-    throw new Error('BrowserforceCommand should not be run directly');
-  }
-
   public async finally(err?: Error): Promise<void> {
     this.spinner.stop(err?.message);
     if (this.bf) {

src/browserforce.ts

@@ -2,7 +2,7 @@ import { Org } from '@salesforce/core';
 import { type Ux } from '@salesforce/sf-plugins-core';
 import pRetry from 'p-retry';
 import { Browser, Frame, launch, Page, WaitForOptions } from 'puppeteer';
-import { LoginPage } from './pages/login';
+import { LoginPage } from './pages/login.js';
 
 const ERROR_DIV_SELECTOR = '#errorTitle';
 const ERROR_DIVS_SELECTOR = 'div.errorMsg';

src/commands/browserforce/apply.ts

@@ -1,12 +1,11 @@
-import { Messages } from '@salesforce/core';
-import { BrowserforceCommand } from '../../browserforce-command';
+import { BrowserforceCommand } from '../../browserforce-command.js';
 
-Messages.importMessagesDirectory(__dirname);
-const messages = Messages.loadMessages('sfdx-browserforce-plugin', 'browserforce');
-
-export class BrowserforceApply extends BrowserforceCommand {
-  public static description = messages.getMessage('applyCommandDescription');
+type BrowserforceApplyResponse = {
+  success: boolean;
+}
 
+export class BrowserforceApply extends BrowserforceCommand<BrowserforceApplyResponse> {
+  public static description = 'apply a plan from a definition file';
   public static examples = [
     `$ <%= config.bin %> <%= command.id %> -f ./config/setup-admin-login-as-any.json --target-org myOrg@example.com
   logging in... done
@@ -17,7 +16,7 @@ export class BrowserforceApply extends BrowserforceCommand {
   `
   ];
 
-  public async run(): Promise<unknown> {
+  public async run(): Promise<BrowserforceApplyResponse> {
     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) {
@@ -52,6 +51,8 @@ export class BrowserforceApply extends BrowserforceCommand {
         this.log(`[${driver.name}] no action necessary`);
       }
     }
-    return { success: true };
+    return {
+      success: true
+    };
   }
 }

src/commands/browserforce/plan.ts

@@ -1,14 +1,13 @@
 import { writeFile } from 'fs/promises';
-import { Messages } from '@salesforce/core';
 import * as path from 'path';
-import { BrowserforceCommand } from '../../browserforce-command';
+import { BrowserforceCommand } from '../../browserforce-command.js';
 
-Messages.importMessagesDirectory(__dirname);
-const messages = Messages.loadMessages('sfdx-browserforce-plugin', 'browserforce');
-
-export class BrowserforcePlanCommand extends BrowserforceCommand {
-  public static description = messages.getMessage('planCommandDescription');
+type BrowserforceApplyResponse = {
+  success: boolean;
+}
 
+export class BrowserforcePlanCommand extends BrowserforceCommand<BrowserforceApplyResponse> {
+  public static description = 'retrieve state and generate plan file';
   public static examples = [
     `$ <%= config.bin %> <%= command.id %> -f ./config/setup-admin-login-as-any.json --target-org myOrg@example.com
   logging in... done
@@ -19,7 +18,7 @@ export class BrowserforcePlanCommand extends BrowserforceCommand {
   `
   ];
 
-  public async run(): Promise<unknown> {
+  public async run(): Promise<BrowserforceApplyResponse> {
     const { flags } = await this.parse(BrowserforcePlanCommand);
     this.log(
       `Generating plan with definition file ${flags.definitionfile} from org ${flags['target-org'].getUsername()}`
@@ -58,6 +57,6 @@ export class BrowserforcePlanCommand extends BrowserforceCommand {
       await writeFile(path.resolve(flags.planfile), JSON.stringify(plan, null, 2));
       this.spinner.stop();
     }
-    return { success: true, plan };
+    return { success: true };
   }
 }

src/config-parser.ts

@@ -1,4 +1,4 @@
-import { BrowserforcePlugin } from './plugin';
+import { BrowserforcePlugin } from './plugin.js';
 
 type Drivers = {
   [key: string]: typeof BrowserforcePlugin;

src/plugin.ts

@@ -1,6 +1,6 @@
 import { Org } from '@salesforce/core';
-import { Browserforce } from './browserforce';
-import { deepDiff } from './plugins/utils';
+import { Browserforce } from './browserforce.js';
+import { deepDiff } from './plugins/utils.js';
 
 export abstract class BrowserforcePlugin {
   protected browserforce: Browserforce;

src/plugins/activity-settings/index.e2e-spec.ts

@@ -1,5 +1,5 @@
 import assert from 'assert';
-import { ActivitySettings } from '.';
+import { ActivitySettings } from './index.js';
 
 describe(ActivitySettings.name, function () {
   let plugin: ActivitySettings;

src/plugins/activity-settings/index.ts

@@ -1,4 +1,4 @@
-import { BrowserforcePlugin } from '../../plugin';
+import { BrowserforcePlugin } from '../../plugin.js';
 
 const PATHS = {
   BASE: 'setup/activitiesSetupPage.apexp'

src/plugins/communities/index.e2e-spec.ts

@@ -1,5 +1,5 @@
 import assert from 'assert';
-import { Communities } from '.';
+import { Communities } from './index.js';
 
 describe.skip(Communities.name, function () {
   let plugin: Communities;

src/plugins/communities/index.ts

@@ -1,4 +1,4 @@
-import { BrowserforcePlugin } from '../../plugin';
+import { BrowserforcePlugin } from '../../plugin.js';
 
 const PATHS = {
   BASE: '_ui/networks/setup/NetworkSettingsPage'

src/plugins/company-information/index.e2e-spec.ts

@@ -1,5 +1,5 @@
 import assert from 'assert';
-import { CompanyInformation, Config } from '.';
+import { CompanyInformation, Config } from './index.js';
 
 describe(CompanyInformation.name, function () {
   let plugin: CompanyInformation;

src/plugins/company-information/index.ts

@@ -1,4 +1,4 @@
-import { BrowserforcePlugin } from '../../plugin';
+import { BrowserforcePlugin } from '../../plugin.js';
 
 const PATHS = (orgId: string) => ({
   BASE: `/${orgId}/e`

src/plugins/customer-portal/available-custom-objects/index.test.ts

@@ -1,5 +1,5 @@
 import assert from 'assert';
-import { type Config, CustomerPortalAvailableCustomObjects } from '.';
+import { type Config, CustomerPortalAvailableCustomObjects } from './index.js';
 
 type T = {
   description: string;

src/plugins/customer-portal/available-custom-objects/index.ts

@@ -1,6 +1,6 @@
 import type { Record } from 'jsforce';
-import { BrowserforcePlugin } from '../../../plugin';
-import { semanticallyCleanObject } from '../../utils';
+import { BrowserforcePlugin } from '../../../plugin.js';
+import { semanticallyCleanObject } from '../../utils.js';
 
 const SELECTORS = {
   SAVE_BUTTON: 'input[name="save"]',

src/plugins/customer-portal/enabled/index.test.ts

@@ -1,5 +1,5 @@
 import assert from 'assert';
-import { CustomerPortalEnable as CustomerPortalEnabled } from '.';
+import { CustomerPortalEnable as CustomerPortalEnabled } from './index.js';
 
 type T = {
   description: string;

src/plugins/customer-portal/enabled/index.ts

@@ -1,4 +1,4 @@
-import { BrowserforcePlugin } from '../../../plugin';
+import { BrowserforcePlugin } from '../../../plugin.js';
 
 const PATHS = {
   EDIT_VIEW: '_ui/core/portal/CustomerSuccessPortalSetup/e'

src/plugins/customer-portal/index.e2e-spec.ts

@@ -1,9 +1,12 @@
 import assert from 'assert';
 import * as child from 'child_process';
+import { fileURLToPath } from 'node:url';
 import * as path from 'path';
-import { CustomerPortalAvailableCustomObjects } from './available-custom-objects';
-import { CustomerPortalEnable } from './enabled';
-import { CustomerPortalSetup } from './portals';
+import { CustomerPortalAvailableCustomObjects } from './available-custom-objects/index.js';
+import { CustomerPortalEnable } from './enabled/index.js';
+import { CustomerPortalSetup } from './portals/index.js';
+
+const __dirname = fileURLToPath(new URL('.', import.meta.url));
 
 describe('CustomerPortal', () => {
   describe(CustomerPortalEnable.name, function () {

src/plugins/customer-portal/index.test.ts

@@ -1,5 +1,5 @@
 import assert from 'assert';
-import { CustomerPortal } from '.';
+import { CustomerPortal } from './index.js';
 
 const tests = [
   {

src/plugins/customer-portal/index.ts

@@ -1,10 +1,10 @@
-import { BrowserforcePlugin } from '../../plugin';
+import { BrowserforcePlugin } from '../../plugin.js';
 import {
   CustomerPortalAvailableCustomObjects,
   Config as CustomerPortalAvailableCustomObjectsConfig
-} from './available-custom-objects';
-import { CustomerPortalEnable, Config as CustomerPortalEnableConfig } from './enabled';
-import { CustomerPortalSetup, Config as CustomerPortalSetupConfig } from './portals';
+} from './available-custom-objects/index.js';
+import { CustomerPortalEnable, Config as CustomerPortalEnableConfig } from './enabled/index.js';
+import { CustomerPortalSetup, Config as CustomerPortalSetupConfig } from './portals/index.js';
 
 type Config = {
   enabled?: CustomerPortalEnableConfig;

src/plugins/customer-portal/portals/index.test.ts

@@ -1,5 +1,5 @@
 import assert from 'assert';
-import { CustomerPortalSetup } from '.';
+import { CustomerPortalSetup } from './index.js';
 
 const tests = [
   {