@adobe/ccweb-add-on-ssl 3.0.1 → 3.1.0

package/src/app/PurgeCommandExecutor.ts

@@ -24,8 +24,8 @@
 
 import type { AnalyticsService } from "@adobe/ccweb-add-on-analytics";
 import { ITypes as IAnalyticsTypes } from "@adobe/ccweb-add-on-analytics";
-import type { Logger, Preferences } from "@adobe/ccweb-add-on-core";
-import { ITypes as ICoreTypes } from "@adobe/ccweb-add-on-core";
+import type { Logger } from "@adobe/ccweb-add-on-core";
+import { ITypes as ICoreTypes, UserPreferences } from "@adobe/ccweb-add-on-core";
 import devcert from "@adobe/ccweb-add-on-devcert";
 import chalk from "chalk";
 import fs from "fs-extra";
@@ -33,7 +33,7 @@ import { inject, injectable } from "inversify";
 import prompts from "prompts";
 import "reflect-metadata";
 import { AnalyticsErrorMarkers, AnalyticsSuccessMarkers } from "../AnalyticsMarkers.js";
-import { SSLRemoveOption } from "../models/Types.js";
+import { SSLRemoveOption } from "../models/SSLTypes.js";
 import type { CommandExecutor } from "./CommandExecutor.js";
 
 /**
@@ -41,19 +41,19 @@ import type { CommandExecutor } from "./CommandExecutor.js";
  */
 @injectable()
 export class PurgeCommandExecutor implements CommandExecutor {
-    private readonly _preferences: Preferences;
+    private readonly _preferences: UserPreferences;
     private readonly _analyticsService: AnalyticsService;
     private readonly _logger: Logger;
 
     /**
      * Instantiate {@link PurgeCommandExecutor}.
-     * @param preferences - {@link Preferences} reference.
+     * @param preferences - {@link UserPreferences} reference.
      * @param analyticsService - {@link AnalyticsService} reference.
      * @param logger - {@link Logger} reference.
      * @returns Reference to a new {@link PurgeCommandExecutor} instance.
      */
     constructor(
-        @inject(ICoreTypes.Preferences) preferences: Preferences,
+        @inject(ICoreTypes.UserPreferences) preferences: UserPreferences,
         @inject(IAnalyticsTypes.AnalyticsService) analyticsService: AnalyticsService,
         @inject(ICoreTypes.Logger) logger: Logger
     ) {
@@ -79,7 +79,7 @@ export class PurgeCommandExecutor implements CommandExecutor {
         });
 
         if (!response || !response.purgeConfirmation) {
-            this._analyticsService.postEvent(
+            void this._analyticsService.postEvent(
                 AnalyticsErrorMarkers.ERROR_SSL_PURGE,
                 LOGS.sslPurgeOptionNotSpecified,
                 false
@@ -109,14 +109,14 @@ export class PurgeCommandExecutor implements CommandExecutor {
             userPreference.ssl = undefined;
             this._preferences.set(userPreference);
 
-            this._analyticsService.postEvent(AnalyticsSuccessMarkers.SUCCESSFUL_SSL_MANUAL_PURGE, "", true);
+            void this._analyticsService.postEvent(AnalyticsSuccessMarkers.SUCCESSFUL_SSL_MANUAL_PURGE, "", true);
         }
     }
 
     private _purgeWxpSSL(): void {
         if (fs.existsSync(devcert.location())) {
             devcert.removeAll();
-            this._analyticsService.postEvent(AnalyticsSuccessMarkers.SUCCESSFUL_SSL_AUTOMATIC_PURGE, "", true);
+            void this._analyticsService.postEvent(AnalyticsSuccessMarkers.SUCCESSFUL_SSL_AUTOMATIC_PURGE, "", true);
         }
     }
 

package/src/app/SSLReader.ts

@@ -22,25 +22,54 @@
  * SOFTWARE.
  ********************************************************************************/
 
-import type { SSLData } from "../models/index.js";
+import type { Logger, SSLSettings } from "@adobe/ccweb-add-on-core";
+import { ITypes as ICoreTypes, isFile, UserPreferences } from "@adobe/ccweb-add-on-core";
+import devcert from "@adobe/ccweb-add-on-devcert";
+import fs from "fs-extra";
+import { inject, injectable } from "inversify";
+import "reflect-metadata";
+import format from "string-template";
+import type { SSLData } from "../models/SSLTypes.js";
 
 /**
- * Contracts for reading the SSL artifacts.
+ * Implementation class for reading the SSL artifacts.
  */
-export interface SSLReader {
+@injectable()
+export class SSLReader {
+    private readonly _preferences: UserPreferences;
+    private readonly _logger: Logger;
+
+    /**
+     * Instantiate {@link SSLReader}.
+     * @param Preferences - {@link UserPreferences} reference.
+     * @param logger - {@link Logger} reference.
+     * @returns Reference to a new {@link SSLReader} instance.
+     */
+    constructor(
+        @inject(ICoreTypes.UserPreferences) preferences: UserPreferences,
+        @inject(ICoreTypes.Logger) logger: Logger
+    ) {
+        this._preferences = preferences;
+        this._logger = logger;
+    }
+
     /**
      * Is SSL set up manually by the user.
      * @param hostname - Hostname in the SSL certificate.
      * @returns Boolean value representing whether SSL is set up manually.
      */
-    isCustomSSL(hostname: string): boolean;
+    isCustomSSL(hostname: string): boolean {
+        return this._getUserDefinedSSL(hostname) !== undefined;
+    }
 
     /**
      * Is SSL set up automatically by the tool.
      * @param hostname - Hostname in the SSL certificate.
      * @returns Boolean value representing whether SSL is set up automatically.
      */
-    isWxpSSL(hostname: string): boolean;
+    isWxpSSL(hostname: string): boolean {
+        return devcert.hasCertificateFor(hostname);
+    }
 
     /**
      * Read the SSL artifacts.
@@ -48,5 +77,114 @@ export interface SSLReader {
      * @param port - Port where the add-on is being hosted.
      * @returns Promise of {@link SSLData}.
      */
-    read(hostname: string, port: number): Promise<SSLData>;
+    async read(hostname: string, port: number): Promise<SSLData> {
+        const sslSettings = this._getUserDefinedSSL(hostname);
+
+        // When SSL is set up manuually by the `user`.
+        if (sslSettings !== undefined) {
+            const { certificatePath, keyPath } = sslSettings;
+            if (!certificatePath || !isFile(certificatePath)) {
+                this._handleInvalidUserSSLCertificate(LOGS.invalidCertificatePath);
+                return process.exit(1);
+            }
+
+            if (!keyPath || !isFile(keyPath)) {
+                this._handleInvalidUserSSLCertificate(LOGS.invalidKeyPath);
+                return process.exit(1);
+            }
+
+            this._handleUnknownExpirySSLCertificate(hostname, port);
+
+            return {
+                cert: fs.readFileSync(certificatePath),
+                key: fs.readFileSync(keyPath)
+            };
+        }
+
+        // When SSL is set up automatically by `devcert`.
+        if (this.isWxpSSL(hostname)) {
+            const caExpiry = devcert.caExpiryInDays();
+            const certificateExpiry = devcert.certificateExpiryInDays(hostname);
+
+            const expiry = Math.min(certificateExpiry, caExpiry);
+            if (expiry <= 0) {
+                this._handleExpiredSSLCertificate();
+                return process.exit(1);
+            }
+
+            if (expiry <= 7) {
+                this._handleNearingExpirySSLCertificate(expiry);
+            }
+
+            return await devcert.certificateFor(hostname);
+        }
+
+        this._handleNoSSLCertificateFound();
+        return process.exit(1);
+    }
+
+    private _getUserDefinedSSL(hostname: string): SSLSettings | undefined {
+        const { ssl } = this._preferences.get();
+        if (ssl === undefined) {
+            return undefined;
+        }
+
+        return ssl.get(hostname);
+    }
+
+    private _handleExpiredSSLCertificate() {
+        this._logger.error(LOGS.noValidSSLCertificateFound);
+        this._logger.error(LOGS.expiredSSLCertificate);
+        this._recreateSSLCertificate();
+    }
+
+    private _handleNearingExpirySSLCertificate(expiry: number) {
+        this._logger.warning(format(LOGS.nearingExpirySSLCertificate, { expiry }));
+        this._recreateSSLCertificate();
+    }
+
+    private _handleNoSSLCertificateFound() {
+        this._logger.error(LOGS.noValidSSLCertificateFound);
+        this._logger.error(LOGS.invalidatedSSLCertificate);
+        this._recreateSSLCertificate();
+    }
+
+    private _handleInvalidUserSSLCertificate(errorMessage: string) {
+        this._logger.error(errorMessage);
+        this._recreateSSLCertificate();
+    }
+
+    private _handleUnknownExpirySSLCertificate(hostname: string, port: number) {
+        this._logger.warning(LOGS.undeterminedExpirySSLCertificate);
+        this._logger.warning(LOGS.unableToSideloadAddOn);
+        this._logger.warning(format(LOGS.checkCertificateValidity, { hostname, port }));
+        this._recreateSSLCertificate();
+    }
+
+    private _recreateSSLCertificate() {
+        this._logger.warning(LOGS.recreateSSLCertificate, { prefix: LOGS.newLine });
+        this._logger.information(LOGS.setupSSLCommand, { prefix: LOGS.tab });
+
+        this._logger.warning(LOGS.example, { prefix: LOGS.newLine });
+        this._logger.information(LOGS.setupSSLCommandExample, { prefix: LOGS.tab, postfix: LOGS.newLine });
+    }
 }
+
+const LOGS = {
+    newLine: "\n",
+    tab: "  ",
+    invalidCertificatePath: "Invalid SSL certificate file path.",
+    invalidKeyPath: "Invalid SSL key file path.",
+    noValidSSLCertificateFound: "Could not locate a valid SSL certificate to host the add-on.",
+    expiredSSLCertificate: "The SSL certificate has expired.",
+    nearingExpirySSLCertificate: "Your SSL certificate will expire in {expiry} days.",
+    invalidatedSSLCertificate:
+        "If you had previously set it up, it may have been invalidated due to a version upgrade.",
+    undeterminedExpirySSLCertificate: "Could not determine the expiry of your SSL certificate.",
+    unableToSideloadAddOn: "If you are unable to sideload your add-on, please check the validity of:",
+    checkCertificateValidity: "https://{hostname}:{port} certificate in your browser.",
+    recreateSSLCertificate: "To re-create the SSL certificate, you may run:",
+    setupSSLCommand: "npx @adobe/ccweb-add-on-ssl setup --hostname [hostname]",
+    example: "Example:",
+    setupSSLCommandExample: "npx @adobe/ccweb-add-on-ssl setup --hostname localhost"
+};

package/src/app/SetupCommandExecutor.ts

@@ -24,8 +24,8 @@
 
 import type { AnalyticsService } from "@adobe/ccweb-add-on-analytics";
 import { ITypes as IAnalyticsTypes } from "@adobe/ccweb-add-on-analytics";
-import type { Logger, Preferences } from "@adobe/ccweb-add-on-core";
-import { ITypes as ICoreTypes, isFile } from "@adobe/ccweb-add-on-core";
+import type { Logger } from "@adobe/ccweb-add-on-core";
+import { ITypes as ICoreTypes, isFile, UserPreferences } from "@adobe/ccweb-add-on-core";
 import devcert from "@adobe/ccweb-add-on-devcert";
 import chalk from "chalk";
 import { inject, injectable } from "inversify";
@@ -37,7 +37,7 @@ import format from "string-template";
 import { AnalyticsErrorMarkers, AnalyticsSuccessMarkers } from "../AnalyticsMarkers.js";
 import { ITypes } from "../config/inversify.types.js";
 import type { SetupCommandOptions } from "../models/SetupCommandOptions.js";
-import { SSLRemoveOption, SSLSetupOption } from "../models/Types.js";
+import { SSLRemoveOption, SSLSetupOption } from "../models/SSLTypes.js";
 import type { CommandExecutor } from "./CommandExecutor.js";
 import type { SSLReader } from "./SSLReader.js";
 
@@ -47,22 +47,22 @@ const MAX_PROMPT_RETRIES = 3;
  * Setup command execution implementation class.
  */
 @injectable()
-export class SetupCommandExecutor implements CommandExecutor {
-    private readonly _preferences: Preferences;
+export class SetupCommandExecutor implements CommandExecutor<SetupCommandOptions> {
+    private readonly _preferences: UserPreferences;
     private readonly _sslReader: SSLReader;
     private readonly _analyticsService: AnalyticsService;
     private readonly _logger: Logger;
 
     /**
      * Instantiate {@link SetupCommandExecutor}.
-     * @param preferences - {@link Preferences} reference.
+     * @param preferences - {@link UserPreferences} reference.
      * @param sslReader - {@link SSLReader} reference.
      * @param analyticsService - {@link AnalyticsService} reference.
      * @param logger - {@link Logger} reference.
      * @returns Reference to a new {@link SetupCommandExecutor} instance.
      */
     constructor(
-        @inject(ICoreTypes.Preferences) preferences: Preferences,
+        @inject(ICoreTypes.UserPreferences) preferences: UserPreferences,
         @inject(ITypes.SSLReader) sslReader: SSLReader,
         @inject(IAnalyticsTypes.AnalyticsService) analyticsService: AnalyticsService,
         @inject(ICoreTypes.Logger) logger: Logger
@@ -98,7 +98,7 @@ export class SetupCommandExecutor implements CommandExecutor {
         });
 
         if (!response || !response.sslSetupType) {
-            this._analyticsService.postEvent(
+            void this._analyticsService.postEvent(
                 AnalyticsErrorMarkers.ERROR_SSL_SETUP,
                 LOGS.sslSetupOptionNotSpecified,
                 false
@@ -109,14 +109,14 @@ export class SetupCommandExecutor implements CommandExecutor {
 
         if (response.sslSetupType === SSLSetupOption.Manually) {
             await this._setupSSLManually(options.hostname);
-            this._analyticsService.postEvent(
+            void this._analyticsService.postEvent(
                 AnalyticsSuccessMarkers.SUCCESSFUL_SSL_MANUAL_SETUP,
                 options.hostname,
                 true
             );
         } else {
             await this._setupSSLAutomatically(options.hostname);
-            this._analyticsService.postEvent(
+            void this._analyticsService.postEvent(
                 AnalyticsSuccessMarkers.SUCCESSFUL_SSL_AUTOMATIC_SETUP,
                 options.hostname,
                 true
@@ -199,7 +199,7 @@ export class SetupCommandExecutor implements CommandExecutor {
 
         // If no response is obtained, which indicates something has gone wrong, then exit.
         if (!response || !response.shouldRemove) {
-            this._analyticsService.postEvent(
+            void this._analyticsService.postEvent(
                 AnalyticsErrorMarkers.ERROR_SSL_REMOVE,
                 LOGS.sslRemoveOptionNotSpecified,
                 false
@@ -219,7 +219,7 @@ export class SetupCommandExecutor implements CommandExecutor {
             userPreference.ssl!.delete(options.hostname);
             this._preferences.set(userPreference);
 
-            this._analyticsService.postEvent(
+            void this._analyticsService.postEvent(
                 AnalyticsSuccessMarkers.SUCCESSFUL_SSL_MANUAL_REMOVE,
                 options.hostname,
                 true
@@ -233,7 +233,7 @@ export class SetupCommandExecutor implements CommandExecutor {
                 await devcert.removeDomain(options.hostname);
             }
 
-            this._analyticsService.postEvent(
+            void this._analyticsService.postEvent(
                 AnalyticsSuccessMarkers.SUCCESSFUL_SSL_AUTOMATIC_REMOVE,
                 options.hostname,
                 true
@@ -270,7 +270,7 @@ export class SetupCommandExecutor implements CommandExecutor {
             this._logger.error(format(LOGS.invalidPathSpecified, { asset }));
         }
 
-        this._analyticsService.postEvent(
+        void this._analyticsService.postEvent(
             AnalyticsErrorMarkers.ERROR_SSL_SETUP,
             format(LOGS.invalidPathSpecified, { asset }),
             false

package/src/app/index.ts

@@ -22,8 +22,7 @@
  * SOFTWARE.
  ********************************************************************************/
 
-export * from "./CommandExecutor.js";
+export type * from "./CommandExecutor.js";
 export * from "./PurgeCommandExecutor.js";
 export * from "./SetupCommandExecutor.js";
 export * from "./SSLReader.js";
-export * from "./WxpSSLReader.js";

package/src/commands/purge.ts

@@ -66,7 +66,7 @@ export class Purge extends BaseCommand {
     }
 
     async catch(error: { message: string }): Promise<void> {
-        this._analyticsService.postEvent(AnalyticsErrorMarkers.ERROR_SSL_PURGE, error.message, false);
+        void this._analyticsService.postEvent(AnalyticsErrorMarkers.ERROR_SSL_PURGE, error.message, false);
         throw error;
     }
 }

package/src/commands/setup.ts

@@ -40,8 +40,8 @@ import type { CommandValidator } from "../validators/CommandValidator.js";
  * SSL Setup command.
  */
 export class Setup extends BaseCommand {
-    private readonly _commandValidator: CommandValidator;
-    private readonly _commandExecutor: CommandExecutor;
+    private readonly _commandValidator: CommandValidator<SetupCommandOptions>;
+    private readonly _commandExecutor: CommandExecutor<SetupCommandOptions>;
 
     static description = "Setup a locally trusted SSL certificate for hosting an add-on.";
 
@@ -68,8 +68,14 @@ export class Setup extends BaseCommand {
     constructor(argv: string[], config: Config) {
         super(argv, config, new CLIProgram(PROGRAM_NAME, config.name + "@" + config.version));
 
-        this._commandValidator = IContainer.getNamed<CommandValidator>(ITypes.CommandValidator, "setup");
-        this._commandExecutor = IContainer.getNamed<CommandExecutor>(ITypes.CommandExecutor, "setup");
+        this._commandValidator = IContainer.getNamed<CommandValidator<SetupCommandOptions>>(
+            ITypes.CommandValidator,
+            "setup"
+        );
+        this._commandExecutor = IContainer.getNamed<CommandExecutor<SetupCommandOptions>>(
+            ITypes.CommandExecutor,
+            "setup"
+        );
     }
 
     async run(): Promise<void> {
@@ -90,7 +96,7 @@ export class Setup extends BaseCommand {
     }
 
     async catch(error: { message: string }): Promise<void> {
-        this._analyticsService.postEvent(AnalyticsErrorMarkers.ERROR_SSL_SETUP, error.message, false);
+        void this._analyticsService.postEvent(AnalyticsErrorMarkers.ERROR_SSL_SETUP, error.message, false);
         throw error;
     }
 }

package/src/config/inversify.config.ts

@@ -23,18 +23,21 @@
  ********************************************************************************/
 
 import { IContainer as ICoreContainer } from "@adobe/ccweb-add-on-core";
-import { Container } from "inversify";
+import type { Container } from "inversify";
 import "reflect-metadata";
-import type { CommandExecutor, SSLReader } from "../app/index.js";
-import { PurgeCommandExecutor, SetupCommandExecutor, WxpSSLReader } from "../app/index.js";
-import type { CommandValidator } from "../validators/index.js";
-import { SetupCommandValidator } from "../validators/index.js";
+import type { CommandExecutor } from "../app/CommandExecutor.js";
+import { PurgeCommandExecutor } from "../app/PurgeCommandExecutor.js";
+import { SetupCommandExecutor } from "../app/SetupCommandExecutor.js";
+import { SSLReader } from "../app/SSLReader.js";
+import type { SetupCommandOptions } from "../models/SetupCommandOptions.js";
+import type { CommandValidator } from "../validators/CommandValidator.js";
+import { SetupCommandValidator } from "../validators/SetupCommandValidator.js";
 import { ITypes } from "./inversify.types.js";
 
 const container: Container = ICoreContainer;
 
 container
-    .bind<CommandExecutor>(ITypes.CommandExecutor)
+    .bind<CommandExecutor<SetupCommandOptions>>(ITypes.CommandExecutor)
     .to(SetupCommandExecutor)
     .inSingletonScope()
     .whenTargetNamed("setup");
@@ -46,11 +49,11 @@ container
     .whenTargetNamed("purge");
 
 container
-    .bind<CommandValidator>(ITypes.CommandValidator)
+    .bind<CommandValidator<SetupCommandOptions>>(ITypes.CommandValidator)
     .to(SetupCommandValidator)
     .inSingletonScope()
     .whenTargetNamed("setup");
 
-container.bind<SSLReader>(ITypes.SSLReader).to(WxpSSLReader).inSingletonScope();
+container.bind<SSLReader>(ITypes.SSLReader).to(SSLReader).inSingletonScope();
 
 export { container as IContainer };

package/src/models/{Types.ts → SSLTypes.ts}

@@ -22,13 +22,6 @@
  * SOFTWARE.
  ********************************************************************************/
 
-import type { SetupCommandOptions } from "./SetupCommandOptions.js";
-
-/**
- * Union of supported command options.
- */
-export type CommandOptions = SetupCommandOptions;
-
 /**
  * SSL setup option.
  */

package/src/models/index.ts

@@ -23,4 +23,4 @@
  ********************************************************************************/
 
 export * from "./SetupCommandOptions.js";
-export * from "./Types.js";
+export * from "./SSLTypes.js";

package/src/test/app/PurgeCommandExecutor.spec.ts

@@ -23,7 +23,8 @@
  ********************************************************************************/
 
 import type { AnalyticsService } from "@adobe/ccweb-add-on-analytics";
-import { PreferenceJson, type Logger, type Preferences } from "@adobe/ccweb-add-on-core";
+import type { Logger, UserPreferences } from "@adobe/ccweb-add-on-core";
+import { PreferenceJson } from "@adobe/ccweb-add-on-core";
 import devcert from "@adobe/ccweb-add-on-devcert";
 import { assert } from "chai";
 import chalk from "chalk";
@@ -36,15 +37,15 @@ import sinon from "sinon";
 import type { StubbedInstance } from "ts-sinon";
 import { stubInterface } from "ts-sinon";
 import { AnalyticsErrorMarkers, AnalyticsSuccessMarkers } from "../../AnalyticsMarkers.js";
-import type { CommandExecutor } from "../../app/index.js";
-import { PurgeCommandExecutor } from "../../app/index.js";
-import { SSLRemoveOption } from "../../models/index.js";
+import type { CommandExecutor } from "../../app/CommandExecutor.js";
+import { PurgeCommandExecutor } from "../../app/PurgeCommandExecutor.js";
+import { SSLRemoveOption } from "../../models/SSLTypes.js";
 
 describe("PurgeCommandExecutor", () => {
     describe("execute", () => {
         let sandbox: SinonSandbox;
 
-        let preferences: StubbedInstance<Preferences>;
+        let preferences: StubbedInstance<UserPreferences>;
         let analyticsService: StubbedInstance<AnalyticsService>;
         let logger: StubbedInstance<Logger>;
 

package/src/test/app/{WxpSSLReader.spec.ts → SSLReader.spec.ts}

@@ -22,7 +22,7 @@
  * SOFTWARE.
  ********************************************************************************/
 
-import type { Logger, Preferences } from "@adobe/ccweb-add-on-core";
+import type { Logger, UserPreferences } from "@adobe/ccweb-add-on-core";
 import { ADD_ON_PREFERENCES_FILE, PreferenceJson } from "@adobe/ccweb-add-on-core";
 import devcert from "@adobe/ccweb-add-on-devcert";
 import chai, { assert, expect } from "chai";
@@ -33,15 +33,14 @@ import "mocha";
 import sinon from "sinon";
 import type { StubbedInstance } from "ts-sinon";
 import { stubInterface } from "ts-sinon";
-import type { SSLReader } from "../../app/index.js";
-import { WxpSSLReader } from "../../app/index.js";
+import { SSLReader } from "../../app/SSLReader.js";
 
 chai.use(chaiAsPromised);
 
-describe("WxpSSLReader", () => {
+describe("SSLReader", () => {
     let sandbox: sinon.SinonSandbox;
 
-    let preferences: StubbedInstance<Preferences>;
+    let preferences: StubbedInstance<UserPreferences>;
     let logger: StubbedInstance<Logger>;
     let sslReader: SSLReader;
 
@@ -53,7 +52,7 @@ describe("WxpSSLReader", () => {
 
         preferences = stubInterface();
         logger = stubInterface();
-        sslReader = new WxpSSLReader(preferences, logger);
+        sslReader = new SSLReader(preferences, logger);
     });
 
     afterEach(() => {

package/src/test/app/SetupCommandExecutor.spec.ts

@@ -23,7 +23,7 @@
  ********************************************************************************/
 
 import type { AnalyticsService } from "@adobe/ccweb-add-on-analytics";
-import type { Logger, Preferences } from "@adobe/ccweb-add-on-core";
+import type { Logger, UserPreferences } from "@adobe/ccweb-add-on-core";
 import { ADD_ON_PREFERENCES_FILE, PreferenceJson } from "@adobe/ccweb-add-on-core";
 import devcert from "@adobe/ccweb-add-on-devcert";
 import chai, { assert, expect } from "chai";
@@ -41,21 +41,23 @@ import format from "string-template";
 import type { StubbedInstance } from "ts-sinon";
 import { stubInterface } from "ts-sinon";
 import { AnalyticsErrorMarkers, AnalyticsSuccessMarkers } from "../../AnalyticsMarkers.js";
-import type { CommandExecutor, SSLReader } from "../../app/index.js";
-import { SetupCommandExecutor } from "../../app/index.js";
-import { SSLRemoveOption, SSLSetupOption, SetupCommandOptions } from "../../models/index.js";
+import type { CommandExecutor } from "../../app/CommandExecutor.js";
+import { SetupCommandExecutor } from "../../app/SetupCommandExecutor.js";
+import type { SSLReader } from "../../app/SSLReader.js";
+import { SetupCommandOptions } from "../../models/SetupCommandOptions.js";
+import { SSLRemoveOption, SSLSetupOption } from "../../models/SSLTypes.js";
 
 chai.use(chaiAsPromised);
 
 describe("SetupCommandExecutor", () => {
     let sandbox: SinonSandbox;
 
-    let preferences: StubbedInstance<Preferences>;
+    let preferences: StubbedInstance<UserPreferences>;
     let sslReader: StubbedInstance<SSLReader>;
     let analyticsService: StubbedInstance<AnalyticsService>;
     let logger: StubbedInstance<Logger>;
 
-    let commandExecutor: CommandExecutor;
+    let commandExecutor: CommandExecutor<SetupCommandOptions>;
 
     beforeEach(() => {
         sandbox = sinon.createSandbox();

package/src/test/commands/command.spec.ts

@@ -30,7 +30,8 @@ import "mocha";
 import sinon from "sinon";
 import type { StubbedInstance } from "ts-sinon";
 import { stubInterface } from "ts-sinon";
-import type { PurgeCommandExecutor, SetupCommandExecutor } from "../../app/index.js";
+import type { PurgeCommandExecutor } from "../../app/PurgeCommandExecutor.js";
+import type { SetupCommandExecutor } from "../../app/SetupCommandExecutor.js";
 import { IContainer, ITypes } from "../../config/index.js";
 import { SetupCommandOptions } from "../../models/SetupCommandOptions.js";
 import type { SetupCommandValidator } from "../../validators/SetupCommandValidator.js";

package/src/test/commands/purge.spec.ts

@@ -32,7 +32,7 @@ import sinon from "sinon";
 import type { StubbedInstance } from "ts-sinon";
 import { stubInterface } from "ts-sinon";
 import { AnalyticsErrorMarkers } from "../../AnalyticsMarkers.js";
-import { PurgeCommandExecutor } from "../../app/index.js";
+import type { PurgeCommandExecutor } from "../../app/PurgeCommandExecutor.js";
 import { Purge } from "../../commands/purge.js";
 import { IContainer, ITypes } from "../../config/index.js";
 import { PROGRAM_NAME } from "../../constants.js";

package/src/test/commands/setup.spec.ts

@@ -32,7 +32,7 @@ import sinon from "sinon";
 import type { StubbedInstance } from "ts-sinon";
 import { stubInterface } from "ts-sinon";
 import { AnalyticsErrorMarkers } from "../../AnalyticsMarkers.js";
-import type { SetupCommandExecutor } from "../../app/index.js";
+import type { SetupCommandExecutor } from "../../app/SetupCommandExecutor.js";
 import { Setup } from "../../commands/setup.js";
 import { IContainer, ITypes } from "../../config/index.js";
 import { PROGRAM_NAME } from "../../constants.js";

package/src/test/models/SetupCommandOptions.spec.ts

@@ -24,7 +24,7 @@
 
 import { assert } from "chai";
 import "mocha";
-import { SetupCommandOptions } from "../../models/index.js";
+import { SetupCommandOptions } from "../../models/SetupCommandOptions.js";
 
 describe("SetupCommandOptions", () => {
     describe("constructor", () => {

package/src/test/validators/SetupCommandValidator.spec.ts

@@ -33,8 +33,8 @@ import type { StubbedInstance } from "ts-sinon";
 import { stubInterface } from "ts-sinon";
 import { AnalyticsErrorMarkers } from "../../AnalyticsMarkers.js";
 import { SetupCommandOptions } from "../../models/SetupCommandOptions.js";
-import type { CommandValidator } from "../../validators/index.js";
-import { SetupCommandValidator } from "../../validators/index.js";
+import type { CommandValidator } from "../../validators/CommandValidator.js";
+import { SetupCommandValidator } from "../../validators/SetupCommandValidator.js";
 
 chai.use(chaiAsPromised);
 
@@ -46,7 +46,7 @@ describe("SetupCommandValidator", () => {
     let analyticsService: StubbedInstance<AnalyticsService>;
     let logger: StubbedInstance<Logger>;
 
-    let commandValidator: CommandValidator;
+    let commandValidator: CommandValidator<SetupCommandOptions>;
 
     beforeEach(() => {
         sandbox = sinon.createSandbox();