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

package/src/validators/CommandValidator.ts

@@ -22,16 +22,14 @@
  * SOFTWARE.
  ********************************************************************************/
 
-import type { CommandOptions } from "../models/index.js";
-
 /**
  * Command validator interface.
  */
-export interface CommandValidator {
+export interface CommandValidator<TOptions> {
     /**
-     * Validate command options.
-     * @param options - Command arguments provided by user.
-     * @returns Promise.
+     * Validate command options provided by user.
+     * @param options - Command specific options.
+     * @returns Promise that resolves when the options are valid.
      */
-    validate(options: CommandOptions): Promise<void>;
+    validate(options: TOptions): Promise<void>;
 }

package/src/validators/SetupCommandValidator.ts

@@ -31,20 +31,19 @@ import isValidDomain from "is-valid-domain";
 import process from "process";
 import "reflect-metadata";
 import { AnalyticsErrorMarkers } from "../AnalyticsMarkers.js";
-import type { SetupCommandOptions } from "../models/index.js";
+import type { SetupCommandOptions } from "../models/SetupCommandOptions.js";
 import type { CommandValidator } from "./CommandValidator.js";
 
 /**
  * Setup command validator implementation class.
  */
 @injectable()
-export class SetupCommandValidator implements CommandValidator {
+export class SetupCommandValidator implements CommandValidator<SetupCommandOptions> {
     private readonly _analyticsService: AnalyticsService;
     private readonly _logger: Logger;
 
     /**
      * Instantiate {@link SetupCommandValidator}.
-     * @param accountService - {@link AccountService} reference.
      * @param analyticsService - {@link AnalyticsService} reference.
      * @param logger - {@link Logger} reference.
      * @returns Reference to a new {@link SetupCommandValidator} instance.

package/src/validators/index.ts

@@ -22,5 +22,5 @@
  * SOFTWARE.
  ********************************************************************************/
 
-export * from "./CommandValidator.js";
+export type * from "./CommandValidator.js";
 export * from "./SetupCommandValidator.js";

package/dist/app/WxpSSLReader.d.ts

@@ -1,67 +0,0 @@
-/********************************************************************************
- * MIT License
-
- * © Copyright 2023 Adobe. All rights reserved.
-
- * 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.
- ********************************************************************************/
-import type { Logger, Preferences } from "@adobe/ccweb-add-on-core";
-import "reflect-metadata";
-import type { SSLData } from "../models/index.js";
-/**
- * Implementation class for reading the SSL artifacts.
- */
-export declare class WxpSSLReader {
-    private readonly _preferences;
-    private readonly _logger;
-    /**
-     * Instantiate {@link WxpSSLReader}.
-     * @param Preferences - {@link Preferences} reference.
-     * @param logger - {@link Logger} reference.
-     * @returns Reference to a new {@link WxpSSLReader} instance.
-     */
-    constructor(preferences: Preferences, 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;
-    /**
-     * 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;
-    /**
-     * Read the SSL artifacts.
-     * @param hostname - Hostname in the SSL certificate.
-     * @param port - Port where the add-on is being hosted.
-     * @returns Promise of {@link SSLData}.
-     */
-    read(hostname: string, port: number): Promise<SSLData>;
-    private _getUserDefinedSSL;
-    private _handleExpiredSSLCertificate;
-    private _handleNearingExpirySSLCertificate;
-    private _handleNoSSLCertificateFound;
-    private _handleInvalidUserSSLCertificate;
-    private _handleUnknownExpirySSLCertificate;
-    private _recreateSSLCertificate;
-}
-//# sourceMappingURL=WxpSSLReader.d.ts.map

package/dist/app/WxpSSLReader.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"WxpSSLReader.d.ts","sourceRoot":"","sources":["../../src/app/WxpSSLReader.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;kFAsBkF;AAElF,OAAO,KAAK,EAAE,MAAM,EAAE,WAAW,EAAe,MAAM,0BAA0B,CAAC;AAKjF,OAAO,kBAAkB,CAAC;AAE1B,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAElD;;GAEG;AACH,qBACa,YAAY;IACrB,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAc;IAC3C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IAEjC;;;;;OAKG;gBACyC,WAAW,EAAE,WAAW,EAA6B,MAAM,EAAE,MAAM;IAK/G;;;;OAIG;IACH,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;IAItC;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;IAInC;;;;;OAKG;IACG,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IA8C5D,OAAO,CAAC,kBAAkB;IAS1B,OAAO,CAAC,4BAA4B;IAMpC,OAAO,CAAC,kCAAkC;IAK1C,OAAO,CAAC,4BAA4B;IAMpC,OAAO,CAAC,gCAAgC;IAKxC,OAAO,CAAC,kCAAkC;IAO1C,OAAO,CAAC,uBAAuB;CAOlC"}

package/dist/app/WxpSSLReader.js

@@ -1,167 +0,0 @@
-/********************************************************************************
- * MIT License
-
- * © Copyright 2023 Adobe. All rights reserved.
-
- * 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.
- ********************************************************************************/
-import { __decorate, __metadata, __param } from "tslib";
-import { ITypes as ICoreTypes, isFile } 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";
-/**
- * Implementation class for reading the SSL artifacts.
- */
-let WxpSSLReader = class WxpSSLReader {
-    _preferences;
-    _logger;
-    /**
-     * Instantiate {@link WxpSSLReader}.
-     * @param Preferences - {@link Preferences} reference.
-     * @param logger - {@link Logger} reference.
-     * @returns Reference to a new {@link WxpSSLReader} instance.
-     */
-    constructor(preferences, 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) {
-        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) {
-        return devcert.hasCertificateFor(hostname);
-    }
-    /**
-     * Read the SSL artifacts.
-     * @param hostname - Hostname in the SSL certificate.
-     * @param port - Port where the add-on is being hosted.
-     * @returns Promise of {@link SSLData}.
-     */
-    async read(hostname, port) {
-        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);
-    }
-    _getUserDefinedSSL(hostname) {
-        const { ssl } = this._preferences.get();
-        if (ssl === undefined) {
-            return undefined;
-        }
-        return ssl.get(hostname);
-    }
-    _handleExpiredSSLCertificate() {
-        this._logger.error(LOGS.noValidSSLCertificateFound);
-        this._logger.error(LOGS.expiredSSLCertificate);
-        this._recreateSSLCertificate();
-    }
-    _handleNearingExpirySSLCertificate(expiry) {
-        this._logger.warning(format(LOGS.nearingExpirySSLCertificate, { expiry }));
-        this._recreateSSLCertificate();
-    }
-    _handleNoSSLCertificateFound() {
-        this._logger.error(LOGS.noValidSSLCertificateFound);
-        this._logger.error(LOGS.invalidatedSSLCertificate);
-        this._recreateSSLCertificate();
-    }
-    _handleInvalidUserSSLCertificate(errorMessage) {
-        this._logger.error(errorMessage);
-        this._recreateSSLCertificate();
-    }
-    _handleUnknownExpirySSLCertificate(hostname, port) {
-        this._logger.warning(LOGS.undeterminedExpirySSLCertificate);
-        this._logger.warning(LOGS.unableToSideloadAddOn);
-        this._logger.warning(format(LOGS.checkCertificateValidity, { hostname, port }));
-        this._recreateSSLCertificate();
-    }
-    _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 });
-    }
-};
-WxpSSLReader = __decorate([
-    injectable(),
-    __param(0, inject(ICoreTypes.Preferences)),
-    __param(1, inject(ICoreTypes.Logger)),
-    __metadata("design:paramtypes", [Object, Object])
-], WxpSSLReader);
-export { WxpSSLReader };
-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"
-};
-//# sourceMappingURL=WxpSSLReader.js.map

package/dist/models/Types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Types.d.ts","sourceRoot":"","sources":["../../src/models/Types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;kFAsBkF;AAElF,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAEpE;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,mBAAmB,CAAC;AAEjD;;GAEG;AACH,oBAAY,cAAc;IACtB,aAAa,kBAAkB;IAC/B,QAAQ,aAAa;CACxB;AAED;;GAEG;AACH,oBAAY,eAAe;IACvB,MAAM,WAAW;IACjB,IAAI,SAAS;CAChB;AAED;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG;IAClB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC;IAEtB;;OAEG;IACH,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;CACxB,CAAC"}

package/src/app/WxpSSLReader.ts

@@ -1,187 +0,0 @@
-/********************************************************************************
- * MIT License
-
- * © Copyright 2023 Adobe. All rights reserved.
-
- * 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.
- ********************************************************************************/
-
-import type { Logger, Preferences, SSLSettings } from "@adobe/ccweb-add-on-core";
-import { ITypes as ICoreTypes, isFile } 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/index.js";
-
-/**
- * Implementation class for reading the SSL artifacts.
- */
-@injectable()
-export class WxpSSLReader {
-    private readonly _preferences: Preferences;
-    private readonly _logger: Logger;
-
-    /**
-     * Instantiate {@link WxpSSLReader}.
-     * @param Preferences - {@link Preferences} reference.
-     * @param logger - {@link Logger} reference.
-     * @returns Reference to a new {@link WxpSSLReader} instance.
-     */
-    constructor(@inject(ICoreTypes.Preferences) preferences: Preferences, @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 {
-        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 {
-        return devcert.hasCertificateFor(hostname);
-    }
-
-    /**
-     * Read the SSL artifacts.
-     * @param hostname - Hostname in the SSL certificate.
-     * @param port - Port where the add-on is being hosted.
-     * @returns Promise of {@link 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"
-};