@comet/upgrade 1.1.0

package/LICENSE

@@ -0,0 +1,25 @@
+BSD 2-Clause License
+
+Copyright (c) 2022, Vivid Planet Software GmbH
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+-   Redistributions of source code must retain the above copyright notice, this
+    list of conditions and the following disclaimer.
+
+-   Redistributions in binary form must reproduce the above copyright notice,
+    this list of conditions and the following disclaimer in the documentation
+    and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,55 @@
+# @comet/upgrade
+
+Upgrade scripts for Comet DXP
+
+## Usage
+
+```sh
+npx @comet/upgrade <target-version>
+```
+
+For example:
+
+```sh
+npx @comet/upgrade v4
+```
+
+## Create a new upgrade script
+
+1. Start the development process:
+
+    ```sh
+    yarn start
+    ```
+
+2. Add a new script for the version you want to upgrade to, for instance, `src/v4/change-something.ts`.
+   The script **must have a function as default export** that performs the changes. See [src/v4/remove-clear-types-script.ts](src/v4/remove-clear-types-script.ts) for an example.
+
+3. Test the upgrade script
+
+    Navigate to the project you want to upgrade:
+
+    ```sh
+    cd project-you-want-to-upgrade/
+    ```
+
+    Create a new branch to test the script:
+
+    ```sh
+    git checkout -b upgrade-comet-to-4
+    ```
+
+    Execute the local @comet/upgrade binary:
+
+    ```sh
+    ../comet-upgrade/bin/index.js 4 # comet-upgrade directory
+
+    ```
+
+    Verify the changes in your project. If something is not as expected, adapt the upgrade script accordingly and then run it again on a clean state:
+
+    ```sh
+    git reset --hard HEAD
+
+    ../comet-upgrade/bin/index.js 4
+    ```

package/bin/index.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+require("../lib/index");

package/lib/index.js

@@ -0,0 +1,171 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const child_process_1 = require("child_process");
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const semver_1 = __importDefault(require("semver"));
+const VERSION_NUMBER = /^v?\d+$/;
+function main() {
+    return __awaiter(this, void 0, void 0, function* () {
+        let targetVersionArg = process.argv[2];
+        if (targetVersionArg === undefined) {
+            console.error("Missing target version! Usage: npx @comet/upgrade <version>");
+            process.exit(-1);
+        }
+        if (!VERSION_NUMBER.test(targetVersionArg)) {
+            console.error("Can't parse version number. Example usage: npx @comet/upgrade v4");
+            process.exit(-1);
+        }
+        if (targetVersionArg.startsWith("v")) {
+            targetVersionArg = targetVersionArg.substring(1);
+        }
+        const targetVersion = Number(targetVersionArg);
+        const scriptsFolder = path_1.default.join(__dirname, `v${targetVersion}`);
+        if (!fs_1.default.existsSync(scriptsFolder)) {
+            console.error(`Can't find target version 'v${targetVersionArg}'`);
+            listTargetVersions();
+            process.exit(-1);
+        }
+        const currentVersion = getCurrentVersion();
+        console.info(`Upgrading from v${currentVersion} to v${targetVersion}`);
+        console.info("Updating dependencies");
+        yield updateDependencies(targetVersion);
+        yield runUpgradeScripts(targetVersion);
+    });
+}
+function getCurrentVersion() {
+    var _a;
+    if (!fs_1.default.existsSync("admin/package.json")) {
+        console.error(`File 'admin/package.json' doesn't exist. Make sure to call the script in the root of your project`);
+        process.exit(-1);
+    }
+    const packageJson = JSON.parse(fs_1.default.readFileSync("admin/package.json").toString());
+    const versionRange = (_a = packageJson.dependencies) === null || _a === void 0 ? void 0 : _a["@comet/admin"];
+    if (versionRange === undefined) {
+        console.error(`Package '@comet/admin' isn't listed as a dependency. Is this a Comet DXP project?`);
+        process.exit(-1);
+    }
+    // ^3.0.0 | ~3.0.0 | 3.0.0-canary -> 3.0.0
+    const versionMatches = versionRange.match(/\d\.\d\.\d/);
+    if (versionMatches === null) {
+        console.error(`Unsupported version range '${versionRange}'. Example range: ^3.0.0`);
+        process.exit(-1);
+    }
+    const version = versionMatches[0];
+    return semver_1.default.major(version);
+}
+function updateDependencies(targetVersion) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const microservices = ["api", "admin", "site"];
+        const packages = {
+            api: ["@comet/blocks-api", "@comet/cms-api"],
+            admin: [
+                "@comet/admin",
+                "@comet/admin-color-picker",
+                "@comet/admin-date-time",
+                "@comet/admin-icons",
+                "@comet/admin-react-select",
+                "@comet/admin-rte",
+                "@comet/admin-theme",
+                "@comet/blocks-admin",
+                "@comet/cms-admin",
+            ],
+            site: ["@comet/cms-site"],
+        };
+        for (const microservice of microservices) {
+            if (!fs_1.default.existsSync(`${microservice}/package.json`)) {
+                console.warn(`File '${microservice}/package.json' doesn't exist. Skipping microservice`);
+                continue;
+            }
+            const packageJson = JSON.parse(fs_1.default.readFileSync(`${microservice}/package.json`).toString());
+            const dependencies = packages[microservice].filter((packageName) => { var _a; return ((_a = packageJson.dependencies) === null || _a === void 0 ? void 0 : _a[packageName]) !== undefined; });
+            const devDependencies = ["@comet/cli", "@comet/eslint-config"].filter((packageName) => { var _a; return ((_a = packageJson.devDependencies) === null || _a === void 0 ? void 0 : _a[packageName]) !== undefined; });
+            if (dependencies.length === 0 && devDependencies.length === 0) {
+                console.warn(`Microservice '${microservice}' has no Comet DXP dependencies. Skipping install`);
+                continue;
+            }
+            yield executeCommand("npm", [
+                "install",
+                "--prefix",
+                microservice,
+                "--no-audit",
+                "--loglevel",
+                "error",
+                ...dependencies.map((dependency) => `${dependency}@${targetVersion}`),
+                ...devDependencies.map((dependency) => `${dependency}@${targetVersion}`),
+            ]);
+        }
+    });
+}
+// Inspired by https://github.com/facebook/create-react-app/blob/main/packages/create-react-app/createReactApp.js#L383
+function executeCommand(command, args = []) {
+    return new Promise((resolve, reject) => {
+        const child = (0, child_process_1.spawn)(command, args, { stdio: "inherit" });
+        child.on("close", (code) => {
+            if (code !== 0) {
+                reject({
+                    command: `${command} ${args.join(" ")}`,
+                });
+                return;
+            }
+            resolve();
+        });
+    });
+}
+function runUpgradeScripts(targetVersion) {
+    return __awaiter(this, void 0, void 0, function* () {
+        var _a;
+        const scriptsFolder = path_1.default.join(__dirname, `v${targetVersion}`);
+        for (const fileName of fs_1.default.readdirSync(scriptsFolder)) {
+            const upgradeScript = yield (_a = path_1.default.join(scriptsFolder, fileName), Promise.resolve().then(() => __importStar(require(_a))));
+            try {
+                yield upgradeScript.default();
+            }
+            catch (error) {
+                console.error(`Script 'v${targetVersion}/${fileName}' failed to execute. See original error below`);
+                console.error(error);
+            }
+        }
+    });
+}
+function listTargetVersions() {
+    console.info("Available target versions");
+    const targetVersions = fs_1.default.readdirSync(__dirname).filter((entry) => entry.startsWith("v"));
+    console.info(targetVersions.map((version) => `- ${version}`).join("\n"));
+}
+main();

package/lib/v4/remove-clear-types-script.js

@@ -0,0 +1,39 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs_1 = __importDefault(require("fs"));
+const prettier_1 = __importDefault(require("prettier"));
+/**
+ * Removes unnecessary clear:types script before GraphQL code generation that interferes with block code generation.
+ */
+function removeClearTypesScript() {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!fs_1.default.existsSync("site/package.json")) {
+            return;
+        }
+        const sitePackageJson = JSON.parse(fs_1.default.readFileSync("site/package.json").toString());
+        if (sitePackageJson.scripts["clear:types"]) {
+            delete sitePackageJson.scripts["clear:types"];
+        }
+        if (sitePackageJson.scripts["gql:types"]) {
+            sitePackageJson.scripts["gql:types"] = sitePackageJson.scripts["gql:types"].replace("npm run clear:types && ", "");
+        }
+        if (sitePackageJson.scripts["gql:watch"]) {
+            sitePackageJson.scripts["gql:watch"] = sitePackageJson.scripts["gql:watch"].replace("npm run clear:types && ", "");
+        }
+        const prettierConfig = yield prettier_1.default.resolveConfig(process.cwd());
+        fs_1.default.writeFileSync("site/package.json", prettier_1.default.format(JSON.stringify(sitePackageJson), Object.assign(Object.assign({}, prettierConfig), { parser: "json" })));
+    });
+}
+exports.default = removeClearTypesScript;

package/package.json

@@ -0,0 +1,55 @@
+{
+    "name": "@comet/upgrade",
+    "version": "1.1.0",
+    "description": "Upgrade scripts for Comet DXP",
+    "homepage": "https://github.com/vivid-planet/comet-upgrade#readme",
+    "bugs": {
+        "url": "https://github.com/vivid-planet/comet-upgrade/issues"
+    },
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/vivid-planet/comet-upgrade"
+    },
+    "license": "BSD-2-Clause",
+    "author": "Vivid Planet Software GmbH <office@vivid-planet.com> (https://www.vivid-planet.com/)",
+    "main": "lib/index.js",
+    "bin": "bin/index.js",
+    "files": [
+        "bin/index.js",
+        "lib/**/*.js"
+    ],
+    "scripts": {
+        "build": "yarn clean && tsc",
+        "clean": "rimraf lib/",
+        "lint": "run-p lint:eslint lint:tsc",
+        "lint:eslint": "eslint --max-warnings 0 src/",
+        "lint:tsc": "tsc --noEmit",
+        "prepare": "husky install",
+        "start": "yarn clean && tsc --watch"
+    },
+    "dependencies": {
+        "prettier": "^2.8.1",
+        "semver": "^7.3.8"
+    },
+    "devDependencies": {
+        "@comet/eslint-config": "^3.2.1",
+        "@types/node": "^14.18.34",
+        "@types/prettier": "^2.7.1",
+        "@types/semver": "^7.3.13",
+        "eslint": "^8.29.0",
+        "husky": "^8.0.2",
+        "lint-staged": "^13.1.0",
+        "rimraf": "^3.0.2",
+        "typescript": "^4.9.4",
+        "yarn-run-all": "^3.1.1"
+    },
+    "packageManager": "yarn@3.3.0",
+    "engines": {
+        "node": "14",
+        "yarn": "3"
+    },
+    "publishConfig": {
+        "access": "public",
+        "registry": "https://registry.npmjs.org"
+    }
+}