@adobe/create-ccweb-add-on 2.5.0 → 3.1.0

package/dist/app/WxpAddOnFactory.js

@@ -1,159 +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 IAnalyticsTypes } from "@adobe/ccweb-add-on-analytics";
-import { ITypes as ICoreTypes } from "@adobe/ccweb-add-on-core";
-import { ITypes as IScaffolderTypes, PACKAGE_JSON, ScaffolderOptions } from "@adobe/ccweb-add-on-scaffolder";
-import fs from "fs-extra";
-import { inject, injectable } from "inversify";
-import os from "os";
-import path from "path";
-import process from "process";
-import "reflect-metadata";
-import format from "string-template";
-import url from "url";
-import { AnalyticsErrorMarkers, AnalyticsSuccessMarkers } from "../AnalyticsMarkers.js";
-import { ITypes } from "../config/inversify.types.js";
-import { TEMP_TEMPLATE_PATH } from "../constants.js";
-import { AddOnManager } from "./AddOnManager.js";
-/**
- * AddOn factory implementation class.
- */
-let WxpAddOnFactory = class WxpAddOnFactory {
-    _directoryValidator;
-    _environmentValidator;
-    _templateSelector;
-    _scaffolder;
-    _process;
-    _logger;
-    _analyticsService;
-    /**
-     * Instantiate {@link WxpAddOnFactory}.
-     * @param directoryValidator - {@link DirectoryValidator} reference.
-     * @param environmentValidator - {@link EnvironmentValidator} reference.
-     * @param templateSelector - {@link TemplateSelector} reference.
-     * @param scaffolder - {@link AddOnScaffolder} reference.
-     * @param cliProcess - {@link Process} reference.
-     * @param logger - {@link Logger} reference.
-     * @param analyticsService - {@link AnalyticsService} reference.
-     * @returns Reference to a new {@link WxpAddOnFactory} instance.
-     */
-    constructor(directoryValidator, environmentValidator, templateSelector, scaffolder, cliProcess, logger, analyticsService) {
-        this._directoryValidator = directoryValidator;
-        this._environmentValidator = environmentValidator;
-        this._templateSelector = templateSelector;
-        this._scaffolder = scaffolder;
-        this._process = cliProcess;
-        this._logger = logger;
-        this._analyticsService = analyticsService;
-    }
-    /**
-     * Create the Add-on project.
-     * @param options - {@link CLIOptions}.
-     */
-    async create(options) {
-        let addOnDirectory = "";
-        try {
-            await this._environmentValidator.validateNodeVersion();
-            await this._environmentValidator.validateNpmVersion();
-            await this._environmentValidator.validateNpmConfiguration();
-            await this._directoryValidator.validateAddOnName(options.addOnName);
-            addOnDirectory = path.resolve(options.addOnName);
-            await this._directoryValidator.validateAddOnDirectory(addOnDirectory, options.addOnName);
-            this._logger.information(LOGS.creatingWxpAddOn);
-            this._logger.message(LOGS.mayTakeAMinute);
-            const templateName = await this._templateSelector.setupTemplate(options);
-            const packageJson = AddOnManager.getPackageJson(options.addOnKind, options.addOnName);
-            const packageJsonPath = path.join(addOnDirectory, PACKAGE_JSON);
-            fs.writeFileSync(packageJsonPath, packageJson.toJSON() + os.EOL);
-            this._copyTemplateFiles(addOnDirectory, templateName);
-            const rootDirectory = process.cwd();
-            process.chdir(addOnDirectory);
-            const devDependencyArgs = [
-                "install",
-                "--save-dev",
-                "@adobe/ccweb-add-on-scripts",
-                "@types/adobe__ccweb-add-on-sdk"
-            ];
-            if (options.verbose) {
-                devDependencyArgs.push("--verbose");
-            }
-            this._logger.information(LOGS.installingDevDependencies, { prefix: LOGS.newLine });
-            await this._process.execute("npm", devDependencyArgs, { stdio: "inherit" });
-            const scaffolderOptions = new ScaffolderOptions(addOnDirectory, options.addOnName, options.addOnKind, rootDirectory, templateName, options.verbose);
-            this._logger.information(format(LOGS.scaffoldingProjectFromTemplate, { templateName }), {
-                prefix: LOGS.newLine
-            });
-            await this._scaffolder.run(scaffolderOptions);
-            const analyticsEventData = [
-                "--addOnName",
-                options.addOnName,
-                "--kind",
-                options.addOnKind,
-                "--template",
-                templateName
-            ];
-            await this._analyticsService.postEvent(AnalyticsSuccessMarkers.SUCCESS, analyticsEventData.join(" "), true);
-        }
-        catch (error) {
-            this._process.handleError(error);
-            this._process.removeAddOn(addOnDirectory, options.addOnName);
-            await this._analyticsService.postEvent(AnalyticsErrorMarkers.ERROR_UNKNOWN_REASON, error.message, false);
-            return process.exit(0);
-        }
-    }
-    _copyTemplateFiles(addOnDirectory, templateName) {
-        const targetPath = path.join(addOnDirectory, TEMP_TEMPLATE_PATH);
-        fs.ensureDirSync(targetPath);
-        const templateDirectory = path.join(url.fileURLToPath(import.meta.url), "..", "..", "templates", templateName);
-        if (fs.existsSync(templateDirectory)) {
-            fs.copySync(templateDirectory, targetPath);
-        }
-        else {
-            this._logger.error(LOGS.templateNotFound);
-            process.exit(1);
-        }
-    }
-};
-WxpAddOnFactory = __decorate([
-    injectable(),
-    __param(0, inject(ITypes.DirectoryValidator)),
-    __param(1, inject(ITypes.EnvironmentValidator)),
-    __param(2, inject(ITypes.TemplateSelector)),
-    __param(3, inject(IScaffolderTypes.AddOnScaffolder)),
-    __param(4, inject(ICoreTypes.Process)),
-    __param(5, inject(ICoreTypes.Logger)),
-    __param(6, inject(IAnalyticsTypes.AnalyticsService)),
-    __metadata("design:paramtypes", [Object, Object, Object, Object, Object, Object, Object])
-], WxpAddOnFactory);
-export { WxpAddOnFactory };
-const LOGS = {
-    newLine: "\n",
-    creatingWxpAddOn: "Creating a new Add-on ...",
-    mayTakeAMinute: "This may take a minute ...",
-    installingDevDependencies: "Installing dev dependencies ...",
-    scaffoldingProjectFromTemplate: "Scaffolding project from template: {templateName} ...",
-    templateNotFound: "Could not find the artifacts for the selected template."
-};
-//# sourceMappingURL=WxpAddOnFactory.js.map

package/dist/validators/AddOnDirectoryValidator.d.ts

@@ -1,55 +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 { AnalyticsService } from "@adobe/ccweb-add-on-analytics";
-import type { Logger } from "@adobe/ccweb-add-on-core";
-import "reflect-metadata";
-import type { DirectoryValidator } from "./DirectoryValidator.js";
-/**
- * Directory validator implementation class to validate
- * whether the directory can be used to create the add-on project.
- */
-export declare class AddOnDirectoryValidator implements DirectoryValidator {
-    private readonly _logger;
-    private readonly _analyticsService;
-    /**
-     * Instantiate {@link AddOnDirectoryValidator}.
-     * @param logger - {@link Logger} reference.
-     * @param analyticsService - {@link AnalyticsService} reference.
-     * @returns Reference to a new {@link AddOnDirectoryValidator} instance.
-     */
-    constructor(logger: Logger, analyticsService: AnalyticsService);
-    /**
-     * Validate the Add-on name.
-     * @param addOnName - Name of the Add-on.
-     */
-    validateAddOnName(addOnName: string): Promise<void>;
-    /**
-     * Validate the addOn directory.
-     * @param addOnDirectory - Root directory of the addOn.
-     * @param addOnName - Name of the addOn.
-     */
-    validateAddOnDirectory(addOnDirectory: string, addOnName: string): Promise<void>;
-    private _chooseDifferentAddOnName;
-}
-//# sourceMappingURL=AddOnDirectoryValidator.d.ts.map

package/dist/validators/AddOnDirectoryValidator.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"AddOnDirectoryValidator.d.ts","sourceRoot":"","sources":["../../src/validators/AddOnDirectoryValidator.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;kFAsBkF;AAElF,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAEtE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,0BAA0B,CAAC;AAMvD,OAAO,kBAAkB,CAAC;AAM1B,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAElE;;;GAGG;AACH,qBACa,uBAAwB,YAAW,kBAAkB;IAC9D,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAmB;IAErD;;;;;OAKG;gBAE4B,MAAM,EAAE,MAAM,EACC,gBAAgB,EAAE,gBAAgB;IAMhF;;;OAGG;IACG,iBAAiB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IA4CzD;;;;OAIG;IACG,sBAAsB,CAAC,cAAc,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IA+DtF,OAAO,CAAC,yBAAyB;CAQpC"}

package/dist/validators/AddOnDirectoryValidator.js

@@ -1,176 +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 IAnalyticsTypes } from "@adobe/ccweb-add-on-analytics";
-import { ITypes as ICoreTypes, isNullOrWhiteSpace } from "@adobe/ccweb-add-on-core";
-import fs from "fs-extra";
-import { inject, injectable } from "inversify";
-import path from "path";
-import process from "process";
-import "reflect-metadata";
-import format from "string-template";
-import validate from "validate-npm-package-name";
-import { AnalyticsErrorMarkers } from "../AnalyticsMarkers.js";
-import { PROGRAM_NAME } from "../constants.js";
-/**
- * Directory validator implementation class to validate
- * whether the directory can be used to create the add-on project.
- */
-let AddOnDirectoryValidator = class AddOnDirectoryValidator {
-    _logger;
-    _analyticsService;
-    /**
-     * Instantiate {@link AddOnDirectoryValidator}.
-     * @param logger - {@link Logger} reference.
-     * @param analyticsService - {@link AnalyticsService} reference.
-     * @returns Reference to a new {@link AddOnDirectoryValidator} instance.
-     */
-    constructor(logger, analyticsService) {
-        this._logger = logger;
-        this._analyticsService = analyticsService;
-    }
-    /**
-     * Validate the Add-on name.
-     * @param addOnName - Name of the Add-on.
-     */
-    async validateAddOnName(addOnName) {
-        if (isNullOrWhiteSpace(addOnName)) {
-            this._logger.warning(LOGS.specifyAddOnName);
-            this._chooseDifferentAddOnName();
-            await this._analyticsService.postEvent(AnalyticsErrorMarkers.ERROR_NO_ADD_ON_NAME, LOGS.analyticsNoAddOnName, false);
-            return process.exit(0);
-        }
-        const isValid = validate(addOnName).validForNewPackages;
-        if (!isValid) {
-            this._logger.warning(format(LOGS.npmNamingRestriction, { addOnName }));
-            this._chooseDifferentAddOnName();
-            await this._analyticsService.postEvent(AnalyticsErrorMarkers.ERROR_INVALID_NAME_NPM, LOGS.analyticsInvalidAddOnNameNPM, false);
-            return process.exit(0);
-        }
-        const dependencies = new Set([
-            "@adobe/create-ccweb-add-on",
-            "create-ccweb-add-on",
-            "@adobe/ccweb-add-on-scripts",
-            "ccweb-add-on-scripts",
-            "@adobe/ccweb-add-on-scaffolder",
-            "ccweb-add-on-scaffolder"
-        ]);
-        if (dependencies.has(addOnName)) {
-            this._logger.warning(format(LOGS.dependencyNamingRestriction, { addOnName }));
-            this._chooseDifferentAddOnName();
-            await this._analyticsService.postEvent(AnalyticsErrorMarkers.ERROR_INVALID_NAME_DEP, LOGS.analyticsInvalidAddOnNameDependency, false);
-            return process.exit(0);
-        }
-    }
-    /**
-     * Validate the addOn directory.
-     * @param addOnDirectory - Root directory of the addOn.
-     * @param addOnName - Name of the addOn.
-     */
-    async validateAddOnDirectory(addOnDirectory, addOnName) {
-        fs.ensureDirSync(addOnName);
-        const validFiles = [
-            ".DS_Store",
-            ".git",
-            ".gitattributes",
-            ".gitignore",
-            ".gitlab-ci.yml",
-            ".hg",
-            ".hgcheck",
-            ".hgignore",
-            ".idea",
-            ".npmignore",
-            ".travis.yml",
-            "docs",
-            "LICENSE",
-            "README.md",
-            "mkdocs.yml",
-            "Thumbs.db"
-        ];
-        const errorLogFilePatterns = ["npm-debug.log"];
-        const isErrorLog = (file) => {
-            return errorLogFilePatterns.some(pattern => file.startsWith(pattern));
-        };
-        const existingFiles = fs.readdirSync(addOnDirectory, { withFileTypes: true });
-        const conflictingFiles = existingFiles
-            .filter(file => !validFiles.includes(file.name))
-            .filter(file => !/\.iml$/.test(file.name))
-            .filter(file => !isErrorLog(file.name));
-        if (conflictingFiles.length === 0) {
-            return;
-        }
-        this._logger.warning(format(LOGS.directoryContainsFiles, { addOnName }), {
-            postfix: LOGS.newLine
-        });
-        for (const file of conflictingFiles) {
-            try {
-                if (fs.lstatSync(path.join(addOnDirectory, file.name)).isDirectory()) {
-                    this._logger.warning(`${file.name}/`, { prefix: LOGS.tab });
-                }
-                else {
-                    this._logger.warning(`${file.name}`, { prefix: LOGS.tab });
-                }
-            }
-            catch {
-                this._logger.warning(`${file.name}`, { prefix: LOGS.tab });
-            }
-        }
-        this._logger.information(LOGS.newAddOnOrRemoveFiles, { prefix: LOGS.newLine });
-        await this._analyticsService.postEvent(AnalyticsErrorMarkers.ERROR_INVALID_NAME_DIR, LOGS.analyticsInvalidAddOnDir, false);
-        return process.exit(0);
-    }
-    _chooseDifferentAddOnName() {
-        this._logger.warning(format(LOGS.executeProgram, { PROGRAM_NAME }), { prefix: LOGS.tab });
-        this._logger.message(LOGS.forExample, { prefix: LOGS.newLine });
-        this._logger.information(format(LOGS.executeProgramExample, { PROGRAM_NAME }), {
-            prefix: LOGS.tab,
-            postfix: LOGS.newLine
-        });
-    }
-};
-AddOnDirectoryValidator = __decorate([
-    injectable(),
-    __param(0, inject(ICoreTypes.Logger)),
-    __param(1, inject(IAnalyticsTypes.AnalyticsService)),
-    __metadata("design:paramtypes", [Object, Object])
-], AddOnDirectoryValidator);
-export { AddOnDirectoryValidator };
-const LOGS = {
-    newLine: "\n",
-    tab: "  ",
-    specifyAddOnName: "Please specify an Add-on name",
-    executeProgram: "{PROGRAM_NAME} <add-on-name> --kind <panel> --template <javascript>",
-    executeProgramExample: "{PROGRAM_NAME} my-add-on --kind panel --template javascript",
-    forExample: "For example:",
-    npmNamingRestriction: "Cannot create a project named {addOnName} because of NPM naming restrictions.",
-    dependencyNamingRestriction: "Cannot create a project named {addOnName} because a dependency with the same name exists.",
-    chooseDifferentAddOnName: "Please choose a different Add-on name:",
-    directoryContainsFiles: "The directory {addOnName} contains files that could conflict:",
-    newAddOnOrRemoveFiles: "Either try using a new Add-on name, or remove the files listed above.",
-    analyticsNoAddOnName: "Add-on name was not specified",
-    analyticsInvalidAddOnNameNPM: "Invalid Add-on name. Npm name check failed",
-    analyticsInvalidAddOnNameDependency: "Invalid Add-on name. Dependency with same name exists",
-    analyticsInvalidAddOnDir: "Invalid Add-on name. Conflicting directory with same name exists"
-};
-//# sourceMappingURL=AddOnDirectoryValidator.js.map

package/dist/validators/NodeEnvironmentValidator.d.ts

@@ -1,58 +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 { AnalyticsService } from "@adobe/ccweb-add-on-analytics";
-import type { Logger, Process } from "@adobe/ccweb-add-on-core";
-import "reflect-metadata";
-import type { EnvironmentValidator } from "./EnvironmentValidator.js";
-/**
- * Environment validator implementation class to validate
- * the system requirements required for running the app.
- */
-export declare class NodeEnvironmentValidator implements EnvironmentValidator {
-    private readonly _process;
-    private readonly _logger;
-    private readonly _analyticsService;
-    /**
-     * Instantiate {@link NodeEnvironmentValidator}.
-     *
-     * @param processHandler - {@link Process} reference.
-     * @param logger - {@link Logger} reference.
-     * @param analyticsService - {@link AnalyticsService} reference.
-     * @returns Reference to a new {@link NodeEnvironmentValidator} instance.
-     */
-    constructor(processHandler: Process, logger: Logger, analyticsService: AnalyticsService);
-    /**
-     * Validate the node version in the user's system.
-     */
-    validateNodeVersion(): Promise<void>;
-    /**
-     * Validate the npm version in the user's system.
-     */
-    validateNpmVersion(): Promise<void>;
-    /**
-     * Validate the npm configuration in the user's system.
-     */
-    validateNpmConfiguration(): Promise<void>;
-}
-//# sourceMappingURL=NodeEnvironmentValidator.d.ts.map

package/dist/validators/NodeEnvironmentValidator.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"NodeEnvironmentValidator.d.ts","sourceRoot":"","sources":["../../src/validators/NodeEnvironmentValidator.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;kFAsBkF;AAElF,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAEtE,OAAO,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,0BAA0B,CAAC;AAIhE,OAAO,kBAAkB,CAAC;AAK1B,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AAEtE;;;GAGG;AACH,qBACa,wBAAyB,YAAW,oBAAoB;IACjE,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAU;IACnC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAmB;IACrD;;;;;;;OAOG;gBAE6B,cAAc,EAAE,OAAO,EACxB,MAAM,EAAE,MAAM,EACC,gBAAgB,EAAE,gBAAgB;IAOhF;;OAEG;IACG,mBAAmB,IAAI,OAAO,CAAC,IAAI,CAAC;IA2B1C;;OAEG;IACG,kBAAkB,IAAI,OAAO,CAAC,IAAI,CAAC;IAwCzC;;OAEG;IACG,wBAAwB,IAAI,OAAO,CAAC,IAAI,CAAC;CAmClD"}

package/dist/validators/NodeEnvironmentValidator.js

@@ -1,173 +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 IAnalyticsTypes } from "@adobe/ccweb-add-on-analytics";
-import { ITypes as ICoreTypes } from "@adobe/ccweb-add-on-core";
-import { inject, injectable } from "inversify";
-import process from "process";
-import "reflect-metadata";
-import semver from "semver";
-import format from "string-template";
-import { AnalyticsErrorMarkers } from "../AnalyticsMarkers.js";
-import { PROGRAM_NAME } from "../constants.js";
-/**
- * Environment validator implementation class to validate
- * the system requirements required for running the app.
- */
-let NodeEnvironmentValidator = class NodeEnvironmentValidator {
-    _process;
-    _logger;
-    _analyticsService;
-    /**
-     * Instantiate {@link NodeEnvironmentValidator}.
-     *
-     * @param processHandler - {@link Process} reference.
-     * @param logger - {@link Logger} reference.
-     * @param analyticsService - {@link AnalyticsService} reference.
-     * @returns Reference to a new {@link NodeEnvironmentValidator} instance.
-     */
-    constructor(processHandler, logger, analyticsService) {
-        this._process = processHandler;
-        this._logger = logger;
-        this._analyticsService = analyticsService;
-    }
-    /**
-     * Validate the node version in the user's system.
-     */
-    async validateNodeVersion() {
-        const minNode = "16.0.0";
-        try {
-            const result = this._process.executeSync("node", ["--version"]);
-            const nodeVersion = String(result?.data)?.trim();
-            const hasMinNode = semver.gte(nodeVersion, minNode);
-            if (!hasMinNode) {
-                this._logger.warning(format(LOGS.usingNodeVersion, { nodeVersion }));
-                this._logger.information(format(LOGS.requiresHigherNode, {
-                    PROGRAM_NAME,
-                    minNode
-                }));
-                this._logger.information(LOGS.updateNodeVersion);
-                await this._analyticsService.postEvent(AnalyticsErrorMarkers.ERROR_INVALID_NODE, format(LOGS.analyticsInvalidNode, { nodeVersion }), false);
-                return process.exit(0);
-            }
-        }
-        catch (error) {
-            this._process.handleError(error);
-        }
-    }
-    /**
-     * Validate the npm version in the user's system.
-     */
-    async validateNpmVersion() {
-        const minNpm = "8.0.0";
-        try {
-            const result = this._process.executeSync("npm", ["--version"]);
-            const npmVersion = result.data ? String(result.data)?.trim() : undefined;
-            if (!npmVersion) {
-                this._logger.warning(LOGS.notUsingNpm);
-                this._logger.information(format(LOGS.requiresHigherNpm, {
-                    PROGRAM_NAME,
-                    minNpm
-                }));
-                this._logger.information(LOGS.installNpm);
-                await this._analyticsService.postEvent(AnalyticsErrorMarkers.ERROR_NO_NPM, LOGS.analyticsNoNpm, false);
-                return process.exit(0);
-            }
-            const hasMinNpm = semver.gte(npmVersion, minNpm);
-            if (!hasMinNpm) {
-                this._logger.warning(format(LOGS.usingNpmVersion, { npmVersion }));
-                this._logger.information(format(LOGS.requiresHigherNpm, {
-                    PROGRAM_NAME,
-                    minNpm
-                }));
-                this._logger.information(LOGS.updateNpm);
-                await this._analyticsService.postEvent(AnalyticsErrorMarkers.ERROR_INVALID_NPM, format(LOGS.analyticsInvalidNpm, { npmVersion }), false);
-                return process.exit(0);
-            }
-        }
-        catch (error) {
-            this._process.handleError(error);
-        }
-    }
-    /**
-     * Validate the npm configuration in the user's system.
-     */
-    async validateNpmConfiguration() {
-        try {
-            const cwd = process.cwd();
-            const configList = this._process.executeSync("npm", ["config", "list"])?.data;
-            if (!configList) {
-                return;
-            }
-            const prefix = "; cwd = ";
-            const configLines = configList.split("\n");
-            const cwdLine = configLines.find(line => line.startsWith(prefix));
-            if (!cwdLine) {
-                return;
-            }
-            const npmCWD = cwdLine.substring(prefix.length);
-            if (npmCWD === cwd) {
-                return;
-            }
-            this._logger.warning(LOGS.couldNotStartNpmProcess);
-            this._logger.information(format(LOGS.currentDirectory, { cwd }));
-            this._logger.information(format(LOGS.newNpmProcessRunsIn, { npmCWD }));
-            this._logger.information(LOGS.misconfiguredTerminalShell);
-            await this._analyticsService.postEvent(AnalyticsErrorMarkers.ERROR_NPM_NOT_STARTED, LOGS.analyticsNotStartNpm, false);
-            return process.exit(0);
-        }
-        catch (error) {
-            return;
-        }
-    }
-};
-NodeEnvironmentValidator = __decorate([
-    injectable(),
-    __param(0, inject(ICoreTypes.Process)),
-    __param(1, inject(ICoreTypes.Logger)),
-    __param(2, inject(IAnalyticsTypes.AnalyticsService)),
-    __metadata("design:paramtypes", [Object, Object, Object])
-], NodeEnvironmentValidator);
-export { NodeEnvironmentValidator };
-const LOGS = {
-    newLine: "\n",
-    tab: "  ",
-    usingNodeVersion: "You are using node {nodeVersion}.",
-    requiresHigherNode: "{PROGRAM_NAME} requires node {minNode} or higher.",
-    updateNodeVersion: "Please update your version of node.",
-    notUsingNpm: "You are not using npm.",
-    requiresHigherNpm: "{PROGRAM_NAME} requires npm {minNpm} or higher.",
-    installNpm: "Please install npm.",
-    usingNpmVersion: "You are using npm {npmVersion}.",
-    updateNpm: "Please update your version of npm.",
-    couldNotStartNpmProcess: "Could not start an npm process in the right directory.",
-    currentDirectory: "The current directory is: {cwd}",
-    newNpmProcessRunsIn: "However, a newly started npm process runs in: {npmCWD}",
-    misconfiguredTerminalShell: "This is probably caused by a misconfigured system terminal shell.",
-    analyticsInvalidNode: "Invalid node version: {nodeVersion}",
-    analyticsNoNpm: "npm is not present",
-    analyticsInvalidNpm: "Invalid npm version: {npmVersion}",
-    analyticsNotStartNpm: "npm process could not be started"
-};
-//# sourceMappingURL=NodeEnvironmentValidator.js.map