@superblocksteam/cli 1.9.3 → 1.12.0

package/dist/commands/components/{upload.js → upload.mjs}

@@ -1,30 +1,38 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-const path_1 = tslib_1.__importDefault(require("path"));
-const core_1 = require("@oclif/core");
-const css_plugin_1 = require("@superblocksteam/css-plugin");
-const react_shim_1 = require("@superblocksteam/react-shim");
-const util_1 = require("@superblocksteam/util");
-const plugin_react_1 = tslib_1.__importDefault(require("@vitejs/plugin-react"));
-const colorette_1 = require("colorette");
-const fs = tslib_1.__importStar(require("fs-extra"));
-const vite_1 = require("vite");
-const authenticated_command_1 = require("../../common/authenticated-command");
-class Upload extends authenticated_command_1.AuthenticatedApplicationCommand {
+import path from "path";
+import { Flags, ux } from "@oclif/core";
+import { COMPONENT_EVENT_HEADER, CUSTOM_COMPONENTS_PATH, ComponentEvent, } from "@superblocksteam/util";
+import react from "@vitejs/plugin-react";
+import { bold, green } from "colorette";
+import fs from "fs-extra";
+import { createLogger, build } from "vite";
+import { AuthenticatedApplicationCommand } from "../../common/authenticated-command.mjs";
+import { productionCssPlugin } from "../../productionCssPlugin.mjs";
+import { injectReactVersionsPlugin } from "../../reactShimPlugin.mjs";
+export default class Upload extends AuthenticatedApplicationCommand {
+    static description = "Upload creates a production-ready bundle and saves the files for use outside of Local Development mode.";
+    static examples = [
+        "<%= config.bin %> components upload",
+        "<%= config.bin %> components upload -b feature-branch",
+    ];
+    static flags = {
+        branch: Flags.string({
+            char: "b",
+            description: "Superblocks branch to push to, the current (local) git branch will be used by default",
+        }),
+    };
     async run() {
         const { flags } = await this.parse(Upload);
-        core_1.ux.action.start("Scanning for Superblocks components...");
-        const exists = await fs.pathExists(util_1.CUSTOM_COMPONENTS_PATH);
+        ux.action.start("Scanning for Superblocks components...");
+        const exists = await fs.pathExists(CUSTOM_COMPONENTS_PATH);
         if (!exists) {
-            core_1.ux.action.stop();
+            ux.action.stop();
             this.error("No components folder found in current directory, please run 'superblocks components create' first", {
                 exit: 1,
             });
         }
-        const { branchName } = await this.validateApplicationGitSetup(util_1.ComponentEvent.UPLOAD, flags.branch);
+        const { branchName } = await this.validateApplicationGitSetup(ComponentEvent.UPLOAD, flags.branch);
         const headers = {
-            [util_1.COMPONENT_EVENT_HEADER]: util_1.ComponentEvent.REGISTER,
+            [COMPONENT_EVENT_HEADER]: ComponentEvent.REGISTER,
         };
         const configs = await this.registerComponents(headers);
         if (!configs)
@@ -34,13 +42,13 @@ class Upload extends authenticated_command_1.AuthenticatedApplicationCommand {
             config.name,
             config.componentPath,
         ]));
-        const viteLogger = (0, vite_1.createLogger)();
+        const viteLogger = createLogger();
         viteLogger.info = (message) => {
             this.log(message);
         };
-        core_1.ux.action.start("Building components...");
+        ux.action.start("Building components...");
         await (async () => {
-            await (0, vite_1.build)({
+            await build({
                 configFile: false,
                 build: {
                     rollupOptions: {
@@ -56,9 +64,9 @@ class Upload extends authenticated_command_1.AuthenticatedApplicationCommand {
                 },
                 customLogger: viteLogger,
                 plugins: [
-                    (0, plugin_react_1.default)(),
-                    (0, react_shim_1.injectReactVersionsPlugin)(),
-                    (0, css_plugin_1.productionCssPlugin)(),
+                    react(),
+                    injectReactVersionsPlugin(),
+                    productionCssPlugin(),
                     {
                         name: "remove-node-module-maps",
                         apply: "build",
@@ -71,7 +79,7 @@ class Upload extends authenticated_command_1.AuthenticatedApplicationCommand {
                 ],
             });
         })();
-        core_1.ux.action.stop();
+        ux.action.stop();
         /*
         1. Build
         2. Get S3 prefix
@@ -80,7 +88,7 @@ class Upload extends authenticated_command_1.AuthenticatedApplicationCommand {
         5. Auto-commit DSL
         */
         try {
-            core_1.ux.action.start("Uploading components...");
+            ux.action.start("Uploading components...");
             const fileRelativePaths = [];
             const excluded = [
                 ".superblocks",
@@ -93,34 +101,22 @@ class Upload extends authenticated_command_1.AuthenticatedApplicationCommand {
             await walkThroughDirectory(".", fileRelativePaths, excluded);
             this.log(fileRelativePaths.join("\n"));
             await this.getSdk().uploadComponents(this.applicationConfig.id, configs, fileRelativePaths, branchName);
-            core_1.ux.action.stop();
+            ux.action.stop();
         }
         catch (e) {
-            core_1.ux.action.stop();
+            ux.action.stop();
             this.error(`Failed to upload components - ${e.message}`, { exit: 1 });
         }
         this.log("You can now disable local dev mode and test your production assets");
-        this.log((0, colorette_1.bold)((0, colorette_1.green)("Once you are done developing please remember to commit your changes in the Superblocks UI.")));
+        this.log(bold(green("Once you are done developing please remember to commit your changes in the Superblocks UI.")));
     }
 }
-Upload.description = "Upload creates a production-ready bundle and saves the files for use outside of Local Development mode.";
-Upload.examples = [
-    "<%= config.bin %> components upload",
-    "<%= config.bin %> components upload -b feature-branch",
-];
-Upload.flags = {
-    branch: core_1.Flags.string({
-        char: "b",
-        description: "Superblocks branch to push to, the current (local) git branch will be used by default",
-    }),
-};
-exports.default = Upload;
 async function walkThroughDirectory(directory, mutableFiles, excluded) {
     const files = await fs.readdir(directory);
     for (const file of files) {
         if (excluded.includes(file))
             continue;
-        const absolute = path_1.default.join(directory, file);
+        const absolute = path.join(directory, file);
         if ((await fs.stat(absolute)).isDirectory()) {
             await walkThroughDirectory(absolute, mutableFiles, excluded);
         }

package/dist/commands/components/{watch.d.ts → watch.d.mts}

@@ -1,5 +1,5 @@
 import { Plugin } from "vite";
-import { AuthenticatedApplicationCommand } from "../../common/authenticated-command";
+import { AuthenticatedApplicationCommand } from "../../common/authenticated-command.mjs";
 export declare function healthEndpointMiddleware(getBranch: () => Promise<string | null>): Plugin;
 export default class Watch extends AuthenticatedApplicationCommand {
     static description: string;

package/dist/commands/components/{watch.js → watch.mjs}

@@ -1,16 +1,12 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.healthEndpointMiddleware = void 0;
-const tslib_1 = require("tslib");
-const react_shim_1 = require("@superblocksteam/react-shim");
-const util_1 = require("@superblocksteam/util");
-const vite_custom_component_reload_plugin_1 = require("@superblocksteam/vite-custom-component-reload-plugin");
-const plugin_react_1 = tslib_1.__importDefault(require("@vitejs/plugin-react"));
-const colorette_1 = require("colorette");
-const vite_1 = require("vite");
-const authenticated_command_1 = require("../../common/authenticated-command");
-const version_control_1 = require("../../common/version-control");
-function healthEndpointMiddleware(getBranch) {
+import { COMPONENT_EVENT_HEADER, ComponentEvent } from "@superblocksteam/util";
+import react from "@vitejs/plugin-react";
+import { bold, green, yellow, red, magenta } from "colorette";
+import { createLogger, createServer } from "vite";
+import { appendHotReloadEventPlugin } from "../../appendHotReloadEventPlugin.mjs";
+import { AuthenticatedApplicationCommand } from "../../common/authenticated-command.mjs";
+import { getCurrentGitBranchIfGit } from "../../common/version-control.mjs";
+import { injectReactVersionsPlugin } from "../../reactShimPlugin.mjs";
+export function healthEndpointMiddleware(getBranch) {
     return {
         name: "health-endpoint-middleware",
         configureServer: (server) => {
@@ -33,18 +29,18 @@ function healthEndpointMiddleware(getBranch) {
         },
     };
 }
-exports.healthEndpointMiddleware = healthEndpointMiddleware;
-class Watch extends authenticated_command_1.AuthenticatedApplicationCommand {
+export default class Watch extends AuthenticatedApplicationCommand {
+    static description = "watch for changes to your custom components";
     async run() {
         const headers = {
-            [util_1.COMPONENT_EVENT_HEADER]: util_1.ComponentEvent.REGISTER,
+            [COMPONENT_EVENT_HEADER]: ComponentEvent.REGISTER,
         };
         await this.registerComponents(headers);
-        this.log((0, colorette_1.yellow)("Remember to refresh your application to see any newly registered components."));
+        this.log(yellow("Remember to refresh your application to see any newly registered components."));
         this.log();
         const editModeUrl = new URL(await this.getEditModeUrl());
         editModeUrl.searchParams.set("devMode", "true");
-        const { branchName, localBranchName } = await this.validateApplicationGitSetup(util_1.ComponentEvent.REGISTER);
+        const { branchName, localBranchName } = await this.validateApplicationGitSetup(ComponentEvent.REGISTER);
         if (branchName) {
             editModeUrl.searchParams.set("branch", branchName);
         }
@@ -54,9 +50,9 @@ class Watch extends authenticated_command_1.AuthenticatedApplicationCommand {
         const getBranch = async () => {
             let curLocalBranchName;
             try {
-                curLocalBranchName = await (0, version_control_1.getCurrentGitBranchIfGit)();
+                curLocalBranchName = await getCurrentGitBranchIfGit();
             }
-            catch (e) {
+            catch {
                 curLocalBranchName = null;
             }
             if (curLocalBranchName === lastLocalBranchName) {
@@ -65,30 +61,29 @@ class Watch extends authenticated_command_1.AuthenticatedApplicationCommand {
             }
             else {
                 // the quick check indicates that the branch has changed, so we need to make an API call to validate the new branch
-                const { branchName, localBranchName } = await this.validateApplicationGitSetup(util_1.ComponentEvent.REGISTER);
+                const { branchName, localBranchName } = await this.validateApplicationGitSetup(ComponentEvent.REGISTER);
                 lastBranchName = branchName;
                 lastLocalBranchName = localBranchName;
                 return branchName;
             }
         };
         const port = 3002;
-        const viteLogger = (0, vite_1.createLogger)();
+        const viteLogger = createLogger();
         viteLogger.info = (message) => {
             this.log(message);
         };
         viteLogger.warn = (msg) => {
-            this.log((0, colorette_1.yellow)(msg));
+            this.log(yellow(msg));
         };
         viteLogger.warnOnce = (msg) => {
-            this.log((0, colorette_1.yellow)(msg));
+            this.log(yellow(msg));
         };
         viteLogger.error = (msg) => {
-            this.log((0, colorette_1.red)(msg));
+            this.log(red(msg));
         };
-        // eslint-disable-next-line @typescript-eslint/no-empty-function
         viteLogger.clearScreen = () => { };
         await (async () => {
-            const server = await (0, vite_1.createServer)({
+            const server = await createServer({
                 configFile: false,
                 base: `http://localhost:${port}`,
                 server: {
@@ -101,20 +96,18 @@ class Watch extends authenticated_command_1.AuthenticatedApplicationCommand {
                 customLogger: viteLogger,
                 plugins: [
                     healthEndpointMiddleware(getBranch),
-                    (0, plugin_react_1.default)(),
-                    (0, vite_custom_component_reload_plugin_1.appendHotReloadEventPlugin)(getBranch),
-                    (0, react_shim_1.injectReactVersionsPlugin)(),
+                    react(),
+                    appendHotReloadEventPlugin(getBranch),
+                    injectReactVersionsPlugin(),
                 ],
             });
             await server.listen();
-            this.log((0, colorette_1.green)(`Local server started at port ${port}`));
-            this.log((0, colorette_1.green)(`Visit your application at:`));
+            this.log(green(`Local server started at port ${port}`));
+            this.log(green(`Visit your application at:`));
             this.log();
-            this.log((0, colorette_1.bold)((0, colorette_1.magenta)(editModeUrl.href)));
+            this.log(bold(magenta(editModeUrl.href)));
             this.log();
-            this.log((0, colorette_1.yellow)(`Please ensure that Local Dev Mode is enabled in your Application so that the component is fetched from your local dev server. Learn more about Local Dev Mode here: ${(0, colorette_1.magenta)("https://docs.superblocks.com/applications/custom-components/development-lifecycle#local-development-mode")}`));
+            this.log(yellow(`Please ensure that Local Dev Mode is enabled in your Application so that the component is fetched from your local dev server. Learn more about Local Dev Mode here: ${magenta("https://docs.superblocks.com/applications/custom-components/development-lifecycle#local-development-mode")}`));
         })();
     }
 }
-Watch.description = "watch for changes to your custom components";
-exports.default = Watch;

package/dist/commands/config/{set.d.ts → set.d.mts}

@@ -3,8 +3,8 @@ export default class SetSuperblocksConfig extends Command {
     static description: string;
     static examples: string[];
     static args: {
-        property: import("@oclif/core/lib/interfaces/parser").Arg<string, Record<string, unknown>>;
-        value: import("@oclif/core/lib/interfaces/parser").Arg<string, Record<string, unknown>>;
+        property: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+        value: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
     };
     run(): Promise<void>;
     validateDomain(domain: string): Promise<void>;

package/dist/commands/config/{set.js → set.mjs}

@@ -1,11 +1,24 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-const dns_1 = tslib_1.__importDefault(require("dns"));
-const util_1 = require("util");
-const core_1 = require("@oclif/core");
-const util_2 = require("@superblocksteam/util");
-class SetSuperblocksConfig extends core_1.Command {
+import dns from "dns";
+import { promisify } from "util";
+import { Args, Command } from "@oclif/core";
+import { getLocalTokenWithUrlIfExists, saveApiToken, } from "@superblocksteam/util";
+export default class SetSuperblocksConfig extends Command {
+    static description = "Sets the specified property in your Superblocks configuration. A property governs the behavior of the Superblocks CLI, such as Superblocks region to interact with";
+    static examples = [
+        "<%= config.bin %> <%= command.id %> domain eu.superblocks.com",
+        "<%= config.bin %> <%= command.id %> domain app.superblocks.com",
+    ];
+    static args = {
+        property: Args.string({
+            description: "Superblocks config name, e.g. domain",
+            options: ["domain"],
+            required: true,
+        }),
+        value: Args.string({
+            description: "Superblocks config value",
+            required: true,
+        }),
+    };
     async run() {
         const { args } = await this.parse(SetSuperblocksConfig);
         try {
@@ -14,26 +27,26 @@ class SetSuperblocksConfig extends core_1.Command {
                     const newDomain = args.value;
                     const newSuperblocksBaseUrl = `https://${newDomain}/`;
                     await this.validateDomain(newDomain);
-                    const result = await (0, util_2.getLocalTokenWithUrlIfExists)();
+                    const result = await getLocalTokenWithUrlIfExists();
                     if (result) {
                         if (!("token" in result)) {
                             // domain only, no token
-                            await (0, util_2.saveApiToken)(newSuperblocksBaseUrl);
+                            await saveApiToken(newSuperblocksBaseUrl);
                             break;
                         }
                         // existing token with domain
                         const { token, superblocksBaseUrl } = result;
                         const tokenToSave = newSuperblocksBaseUrl === superblocksBaseUrl ? token : undefined;
                         if (tokenToSave) {
-                            await (0, util_2.saveApiToken)(newSuperblocksBaseUrl, tokenToSave);
+                            await saveApiToken(newSuperblocksBaseUrl, tokenToSave);
                         }
                         else {
-                            await (0, util_2.saveApiToken)(newSuperblocksBaseUrl);
+                            await saveApiToken(newSuperblocksBaseUrl);
                         }
                     }
                     else {
                         // no existing token
-                        await (0, util_2.saveApiToken)(newSuperblocksBaseUrl);
+                        await saveApiToken(newSuperblocksBaseUrl);
                     }
                     break;
                 }
@@ -51,29 +64,12 @@ class SetSuperblocksConfig extends core_1.Command {
         if (!domainRegex.test(domain)) {
             throw new Error(errorMessage);
         }
-        const lookup = (0, util_1.promisify)(dns_1.default.lookup);
+        const lookup = promisify(dns.lookup);
         try {
             await lookup(domain);
         }
-        catch (error) {
+        catch {
             throw new Error(errorMessage);
         }
     }
 }
-SetSuperblocksConfig.description = "Sets the specified property in your Superblocks configuration. A property governs the behavior of the Superblocks CLI, such as Superblocks region to interact with";
-SetSuperblocksConfig.examples = [
-    "<%= config.bin %> <%= command.id %> domain eu.superblocks.com",
-    "<%= config.bin %> <%= command.id %> domain app.superblocks.com",
-];
-SetSuperblocksConfig.args = {
-    property: core_1.Args.string({
-        description: "Superblocks config name, e.g. domain",
-        options: ["domain"],
-        required: true,
-    }),
-    value: core_1.Args.string({
-        description: "Superblocks config value",
-        required: true,
-    }),
-};
-exports.default = SetSuperblocksConfig;

package/dist/commands/{init.d.ts → init.d.mts}

@@ -1,13 +1,13 @@
-import { AuthenticatedCommand } from "../common/authenticated-command";
+import { AuthenticatedCommand } from "../common/authenticated-command.mjs";
 export default class Initialize extends AuthenticatedCommand {
     static description: string;
     static examples: string[];
     static flags: {
-        mode: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
-        "skip-signing-verification": import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        mode: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        "skip-signing-verification": import("@oclif/core/interfaces").BooleanFlag<boolean>;
     };
     static args: {
-        resource_url: import("@oclif/core/lib/interfaces/parser").Arg<string | undefined, Record<string, unknown>>;
+        resource_url: import("@oclif/core/interfaces").Arg<string | undefined, Record<string, unknown>>;
     };
     run(): Promise<void>;
     private createTasks;