@superblocksteam/cli 1.10.0 → 1.12.0

package/dist/index.js

@@ -1,5 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.run = void 0;
-var core_1 = require("@oclif/core");
-Object.defineProperty(exports, "run", { enumerable: true, get: function () { return core_1.run; } });
+export { run } from "@oclif/core";

package/dist/{productionCssPlugin.js → productionCssPlugin.mjs}

@@ -1,8 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.productionCssPlugin = void 0;
-const tslib_1 = require("tslib");
-const node_path_1 = tslib_1.__importDefault(require("node:path"));
+import path from "node:path";
 // CSS is located at a path like "assets/component-8625163d.css", so
 // we need to get the full URL to it by using import.meta.url
 function getInjector(path) {
@@ -17,14 +13,13 @@ function getInjector(path) {
 // But we want to avoid inline CSS because we can't guarantee components are
 // all used on the page- so by using <link> tags, the browser does not have to
 // download unused CSS
-const productionCssPlugin = () => {
+export const productionCssPlugin = () => {
     return {
         name: "css-reference",
         enforce: "post",
         apply: "build",
         renderChunk(code, chunk) {
-            var _a;
-            if ((_a = chunk.viteMetadata) === null || _a === void 0 ? void 0 : _a.importedCss.size) {
+            if (chunk.viteMetadata?.importedCss.size) {
                 const cssFiles = Array.from(chunk.viteMetadata.importedCss);
                 if (chunk.isEntry) {
                     return {
@@ -40,7 +35,7 @@ const productionCssPlugin = () => {
                             .map((p) => {
                             // Converts a path like "assets/component-8625163d.css" to
                             // a path like "component-8625163d.css", which resolves as a URL
-                            const relativePath = node_path_1.default.relative(node_path_1.default.dirname(chunk.fileName), p);
+                            const relativePath = path.relative(path.dirname(chunk.fileName), p);
                             return getInjector(relativePath);
                         })
                             .join("\n")}
@@ -53,4 +48,3 @@ const productionCssPlugin = () => {
         },
     };
 };
-exports.productionCssPlugin = productionCssPlugin;

package/dist/{reactShimPlugin.js → reactShimPlugin.mjs}

@@ -1,39 +1,33 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.injectReactVersionsPlugin = void 0;
-const tslib_1 = require("tslib");
-const path_1 = tslib_1.__importDefault(require("path"));
-const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
-const semver_1 = tslib_1.__importDefault(require("semver"));
-const vite_1 = require("vite");
+import path from "path";
+import fs from "fs-extra";
+import semver from "semver";
+import { searchForWorkspaceRoot, mergeConfig, normalizePath, } from "vite";
 const shimIdForBuild = "injectedReactShim";
 const shimFileNameDev = `${shimIdForBuild}.jsx`;
 const shimFileNameBuild = `${shimIdForBuild}.js`;
-const pathToInjectedReactShim17 = (0, vite_1.normalizePath)(path_1.default.join(__dirname, `../assets/${shimIdForBuild}17.jsx`));
-const pathToInjectedReactShim18 = (0, vite_1.normalizePath)(path_1.default.join(__dirname, `../assets/${shimIdForBuild}18.jsx`));
+const pathToInjectedReactShim17 = normalizePath(path.join(new URL(import.meta.url).pathname, `../../assets/${shimIdForBuild}17.jsx`));
+const pathToInjectedReactShim18 = normalizePath(path.join(new URL(import.meta.url).pathname, `../../assets/${shimIdForBuild}18.jsx`));
 // This plugin works in both dev and build mode
 // In dev mode, the UI makes a request to localhost:3002/@superblocksteam/react-shim
 // In build mode, the plugin injects an additional entry point for the shim
-const injectReactVersionsPlugin = () => {
-    var _a;
-    const packageJson = fs_extra_1.default.readJsonSync(path_1.default.join((0, vite_1.searchForWorkspaceRoot)(process.cwd()), "package.json"));
-    if (!((_a = packageJson.dependencies) === null || _a === void 0 ? void 0 : _a.react)) {
+export const injectReactVersionsPlugin = () => {
+    const packageJson = fs.readJsonSync(path.join(searchForWorkspaceRoot(process.cwd()), "package.json"));
+    if (!packageJson.dependencies?.react) {
         throw new Error("React is not installed");
     }
-    const version = semver_1.default.minVersion(packageJson.dependencies.react);
+    const version = semver.minVersion(packageJson.dependencies.react);
     if (!version)
         throw new Error("React is not installed");
-    const isReact17 = semver_1.default.satisfies(version, "^17");
-    const isReact18 = semver_1.default.satisfies(version, "^18");
+    const isReact17 = semver.satisfies(version, "^17");
+    const isReact18 = semver.satisfies(version, "^18");
     return {
         name: "react-versions-plugin",
         enforce: "pre",
         config(config) {
-            var _a, _b, _c, _d;
-            config.server = (0, vite_1.mergeConfig)((_a = config.server) !== null && _a !== void 0 ? _a : {}, {
+            config.server = mergeConfig(config.server ?? {}, {
                 fs: {
                     allow: [
-                        (0, vite_1.searchForWorkspaceRoot)(process.cwd()),
+                        searchForWorkspaceRoot(process.cwd()),
                         pathToInjectedReactShim17,
                         pathToInjectedReactShim18,
                     ],
@@ -45,15 +39,15 @@ const injectReactVersionsPlugin = () => {
                 // We can't add `react-dom` because the dependency is `react-dom/client`
                 // for React 18 while it's `react-dom` for React 17. We'd need to detect
                 // what React version the user has installed.
-                config.optimizeDeps = (0, vite_1.mergeConfig)((_b = config.optimizeDeps) !== null && _b !== void 0 ? _b : {}, {
+                config.optimizeDeps = mergeConfig(config.optimizeDeps ?? {}, {
                     include: ["react", "react-dom", "react-dom/client"],
                 });
-                config.resolve = (0, vite_1.mergeConfig)((_c = config.resolve) !== null && _c !== void 0 ? _c : {}, {
+                config.resolve = mergeConfig(config.resolve ?? {}, {
                     dedupe: ["react", "react-dom", "react-dom/client"],
                 });
             }
             else if (isReact17) {
-                config.optimizeDeps = (0, vite_1.mergeConfig)((_d = config.optimizeDeps) !== null && _d !== void 0 ? _d : {}, {
+                config.optimizeDeps = mergeConfig(config.optimizeDeps ?? {}, {
                     include: ["react", "react-dom"],
                 });
             }
@@ -131,4 +125,3 @@ if (import.meta.hot) {
         },
     };
 };
-exports.injectReactVersionsPlugin = injectReactVersionsPlugin;

package/dist/util/migrationWarningsForApplications.mjs

@@ -0,0 +1,47 @@
+import { bold, magenta, red } from "colorette";
+import semver from "semver";
+// If you are changing how application files work on disk, for example changing the directory layout,
+// you need to tell the user how to upgrade manually.
+const BREAKING_APPLICATION_VERSIONS = [
+    {
+        version: "0.0.20",
+        // This is an example message because 0.0.20 does not have a docs page for any migrations. This will be added
+        // in a future release
+        message: `${red("Warning")}: Your code must be updated due to a breaking change in custom component definitions. See docs.`,
+    },
+    {
+        version: "0.0.21",
+        // This is an example message because 0.0.21 does not have a docs page for any migrations. This will be added
+        // in a future release
+        message: `${red("Error")}: This version of the CLI is incompatible with any Custom Components you've previously used,
+due to breaking changes introduced in the config.ts format and Custom Components React API.
+    
+${bold("Your existing components are safe.")}
+
+To manually migrate:
+
+1. Rename "eventHandlers" to "events".
+2. Update your properties to use the new format: ${magenta("https://docs.superblocks.com/applications/custom-components/development-lifecycle#configts")}
+`,
+    },
+    {
+        version: "0.0.23",
+        message: `${red("Warning")}: Type definitions for custom components have changed to include null values,
+which were missing from previous types. The previous types were not accurate.
+Superblocks represents missing/undefined properties as null.
+
+To manually update, you should follow Typescript errors in your IDE and update your code
+to handle null values.
+
+${bold("Your existing components are safe.")}
+
+See changelog: ${magenta("https://github.com/superblocksteam/superblocks-cli/blob/main/CHANGELOG.md")}
+`,
+    },
+];
+export function getWarningsForApplicationMigration(previousVersion, newVersion) {
+    const firstBreakingChange = BREAKING_APPLICATION_VERSIONS.find(({ version }) => {
+        return (semver.lt(previousVersion, version) && semver.lte(version, newVersion));
+    });
+    return firstBreakingChange?.message;
+}

package/dist/util/{migrationsForDotfiles.js → migrationsForDotfiles.mjs}

@@ -1,8 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isDotfileMigrationNeeded = exports.migrateSuperblocksEntityConfig = exports.migrateSuperblocksMonorepoConfig = void 0;
-const tslib_1 = require("tslib");
-const semver_1 = tslib_1.__importDefault(require("semver"));
+import semver from "semver";
 // These migrations are used to upgrade the Superblocks config files as needed.
 // For example if we add a new required field
 const MonorepoMigratorsFromOldVersion = [
@@ -12,10 +8,9 @@ const MonorepoMigratorsFromOldVersion = [
     },
 ];
 // Recursively migrate configs to the latest version
-async function migrateSuperblocksMonorepoConfig(config, options) {
+export async function migrateSuperblocksMonorepoConfig(config, options) {
     return await sharedMigrator(MonorepoMigratorsFromOldVersion, config, options);
 }
-exports.migrateSuperblocksMonorepoConfig = migrateSuperblocksMonorepoConfig;
 // These migrations are used to upgrade the Superblocks config files as needed.
 // For example if we add a new required field
 const EntityMigratorsFromOldVersion = [
@@ -24,23 +19,21 @@ const EntityMigratorsFromOldVersion = [
         migrator: (config) => config,
     },
 ];
-async function migrateSuperblocksEntityConfig(config, options) {
+export async function migrateSuperblocksEntityConfig(config, options) {
     return await sharedMigrator(EntityMigratorsFromOldVersion, config, options);
 }
-exports.migrateSuperblocksEntityConfig = migrateSuperblocksEntityConfig;
-function isDotfileMigrationNeeded(previousVersion, currentVersion) {
+export function isDotfileMigrationNeeded(previousVersion, currentVersion) {
     return (previousVersion !== currentVersion &&
-        (MonorepoMigratorsFromOldVersion.some(({ migrateWhenUpgradingTo }) => semver_1.default.gt(migrateWhenUpgradingTo, previousVersion) &&
-            semver_1.default.lte(migrateWhenUpgradingTo, currentVersion)) ||
-            EntityMigratorsFromOldVersion.some(({ migrateWhenUpgradingTo }) => semver_1.default.gt(migrateWhenUpgradingTo, previousVersion) &&
-                semver_1.default.lte(migrateWhenUpgradingTo, currentVersion))));
+        (MonorepoMigratorsFromOldVersion.some(({ migrateWhenUpgradingTo }) => semver.gt(migrateWhenUpgradingTo, previousVersion) &&
+            semver.lte(migrateWhenUpgradingTo, currentVersion)) ||
+            EntityMigratorsFromOldVersion.some(({ migrateWhenUpgradingTo }) => semver.gt(migrateWhenUpgradingTo, previousVersion) &&
+                semver.lte(migrateWhenUpgradingTo, currentVersion))));
 }
-exports.isDotfileMigrationNeeded = isDotfileMigrationNeeded;
 async function sharedMigrator(migratorObject, config, { previousVersion, currentVersion, }) {
     let newConfig = JSON.parse(JSON.stringify(config));
     // Find all migrators in the range between previousVersion and currentVersion
-    const migratorFns = migratorObject.filter(({ migrateWhenUpgradingTo }) => semver_1.default.gt(migrateWhenUpgradingTo, previousVersion) &&
-        semver_1.default.lte(migrateWhenUpgradingTo, currentVersion));
+    const migratorFns = migratorObject.filter(({ migrateWhenUpgradingTo }) => semver.gt(migrateWhenUpgradingTo, previousVersion) &&
+        semver.lte(migrateWhenUpgradingTo, currentVersion));
     migratorFns.forEach(({ migrator, migrateWhenUpgradingTo }) => {
         try {
             newConfig = migrator(newConfig);