@superblocksteam/cli 0.0.21 → 0.0.22

package/README.md

@@ -12,7 +12,7 @@ $ npm install -g @superblocksteam/cli
 $ superblocks COMMAND
 running command...
 $ superblocks (--version)
-@superblocksteam/cli/0.0.21 linux-x64 node-v18.17.0
+@superblocksteam/cli/0.0.22 linux-x64 node-v18.17.0
 $ superblocks --help [COMMAND]
 USAGE
   $ superblocks COMMAND

package/assets/custom-components/setup/gitignore_will_rename

@@ -0,0 +1,2 @@
+node_modules/
+dist/

package/assets/custom-components/setup/package.json

@@ -7,7 +7,7 @@
     "lint:fix": "npx eslint . --fix"
   },
   "dependencies": {
-    "@superblocksteam/custom-components": "0.0.21",
+    "@superblocksteam/custom-components": "0.0.22",
     "react": "^18",
     "react-dom": "^18"
   },

package/dist/commands/components/create.js

@@ -116,8 +116,11 @@ class CreateComponent extends authenticated_command_1.AuthenticatedApplicationCo
                     path: propertyPath,
                     dataType: propertyType,
                     propertiesPanelDisplay,
+                    // Optional but include them by default
+                    isExternallyReadable: true,
+                    isExternallySettable: true,
                 });
-                this.log(`You can configure the remaining display attributes (tooltip, placeholder, etc) in the config.ts file directly.`);
+                this.log(`You can configure the remaining display attributes (placeholder, etc) in the config.ts file directly.`);
                 this.log();
                 const addAnotherProperty = (await (0, enquirer_1.prompt)({
                     type: "confirm",
@@ -190,6 +193,9 @@ class CreateComponent extends authenticated_command_1.AuthenticatedApplicationCo
         const componentTsx = (0, create_component_defaults_1.getDefaultComponentTsx)(properties, events.map((prop) => prop.path));
         if (isFirstTimeCreate) {
             await fs.copy(DEFAULT_PACKAGE_JSON_TEMPLATE_PATH, ".");
+            // There is a very old npm bug where it won't publish .gitignore files
+            // https://github.com/npm/npm/issues/3763
+            await fs.move("./gitignore_will_rename", "./.gitignore");
         }
         await fs.ensureDir("components/" + name);
         await fs.writeFile(`components/${name}/config.ts`, configTs);
@@ -214,6 +220,8 @@ class CreateComponent extends authenticated_command_1.AuthenticatedApplicationCo
                         placeholder: "{ taskId: { taskName: 'Task Name', taskStatus: 'complete' | 'todo' } }",
                         controlType: "js-expr",
                     },
+                    isExternallyReadable: true,
+                    isExternallySettable: true,
                 },
             ],
             events: [
@@ -292,7 +300,10 @@ class CreateComponent extends authenticated_command_1.AuthenticatedApplicationCo
             }
             core_1.ux.action.stop();
         }
-        this.registerComponents();
+        const headers = {
+            [util_1.COMPONENT_EVENT_HEADER]: util_1.ComponentEvent.CREATE,
+        };
+        this.registerComponents(headers);
     }
 }
 CreateComponent.description = "Creates a new Superblocks component in the current application folder";

package/dist/commands/components/register.js

@@ -1,9 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const util_1 = require("@superblocksteam/util");
 const authenticated_command_1 = require("../../common/authenticated-command");
 class Register extends authenticated_command_1.AuthenticatedApplicationCommand {
     async run() {
-        await this.registerComponents();
+        const headers = {
+            [util_1.COMPONENT_EVENT_HEADER]: util_1.ComponentEvent.REGISTER,
+        };
+        await this.registerComponents(headers);
     }
 }
 Register.description = "Registers all local component config files";

package/dist/commands/components/upload.js

@@ -20,7 +20,10 @@ class Upload extends authenticated_command_1.AuthenticatedApplicationCommand {
                 exit: 1,
             });
         }
-        const configs = await this.registerComponents();
+        const headers = {
+            [util_1.COMPONENT_EVENT_HEADER]: util_1.ComponentEvent.REGISTER,
+        };
+        const configs = await this.registerComponents(headers);
         if (!configs)
             return;
         // Map component name to component path- each name is a separate entry point

package/dist/commands/components/watch.js

@@ -3,6 +3,7 @@ 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");
@@ -29,7 +30,10 @@ function healthEndpointMiddleware() {
 exports.healthEndpointMiddleware = healthEndpointMiddleware;
 class Watch extends authenticated_command_1.AuthenticatedApplicationCommand {
     async run() {
-        await this.registerComponents();
+        const headers = {
+            [util_1.COMPONENT_EVENT_HEADER]: util_1.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();
         const port = 3002;

package/dist/commands/init.js

@@ -62,7 +62,13 @@ class Initialize extends authenticated_command_1.AuthenticatedCommand {
                         task: async (ctx, task) => {
                             const [resourceId, resourceType] = getResourceIdFromUrl(args.resourceUrl);
                             if (resourceType === "APPLICATION") {
-                                const application = await this.getSdk().fetchApplication(resourceId);
+                                const headers = {
+                                    [util_1.COMPONENT_EVENT_HEADER]: util_1.ComponentEvent.INIT,
+                                };
+                                const application = await this.getSdk().fetchApplication({
+                                    applicationId: resourceId,
+                                    headers,
+                                });
                                 ctx.fetchedResources[application.application.id] = {
                                     resourceType,
                                     name: application.application.name,
@@ -104,7 +110,14 @@ class Initialize extends authenticated_command_1.AuthenticatedCommand {
                                 subtasks.push({
                                     title: `Fetching application ${resource.name}...`,
                                     task: async (_ctx, task) => {
-                                        const application = await this.getSdk().fetchApplication(resourceId, ctx.viewMode);
+                                        const headers = {
+                                            [util_1.COMPONENT_EVENT_HEADER]: util_1.ComponentEvent.INIT,
+                                        };
+                                        const application = await this.getSdk().fetchApplication({
+                                            applicationId: resourceId,
+                                            viewMode: ctx.viewMode,
+                                            headers,
+                                        });
                                         task.title += `: fetched`;
                                         ctx.writtenResources[resourceId] =
                                             await (0, version_control_1.writeResourceToDisk)("APPLICATION", resourceId, application, now, process.cwd());

package/dist/commands/pull.js

@@ -51,7 +51,14 @@ class Pull extends authenticated_command_1.AuthenticatedCommand {
                                 subtasks.push({
                                     title: `Pulling application ${resource.location}...`,
                                     task: async (_ctx, task) => {
-                                        const application = await this.getSdk().fetchApplication(resourceId, viewMode);
+                                        const headers = {
+                                            [util_1.COMPONENT_EVENT_HEADER]: util_1.ComponentEvent.PULL,
+                                        };
+                                        const application = await this.getSdk().fetchApplication({
+                                            applicationId: resourceId,
+                                            viewMode,
+                                            headers,
+                                        });
                                         task.title += `: fetched`;
                                         ctx.writtenResources[resourceId] =
                                             await (0, version_control_1.writeResourceToDisk)("APPLICATION", resourceId, application, now, superblocksRootPath, resource.location);

package/dist/common/authenticated-command.d.ts

@@ -12,5 +12,5 @@ export declare abstract class AuthenticatedApplicationCommand extends Authentica
     applicationConfig: SuperblocksApplicationConfig;
     protected getEditModeUrl(): Promise<string>;
     protected init(): Promise<void>;
-    protected registerComponents(): Promise<Record<string, any> | undefined>;
+    protected registerComponents(injectedHeaders?: Record<string, string>): Promise<Record<string, any> | undefined>;
 }

package/dist/common/authenticated-command.js

@@ -139,7 +139,7 @@ class AuthenticatedApplicationCommand extends AuthenticatedCommand {
             this.warn(`Could not read page.yaml to determine version compatibility: ${e.message}`);
         }
     }
-    async registerComponents() {
+    async registerComponents(injectedHeaders) {
         var _a;
         core_1.ux.action.start("Checking CLI version compatibility...");
         try {
@@ -185,7 +185,7 @@ ${(0, colorette_1.cyan)("superblocks migrate")}`);
         core_1.ux.action.stop();
         try {
             core_1.ux.action.start("Registering components...");
-            await this.getSdk().registerComponents(this.applicationConfig.id, configs);
+            await this.getSdk().registerComponents(this.applicationConfig.id, configs, injectedHeaders);
             core_1.ux.action.stop();
         }
         catch (e) {

package/dist/util/migrationWarningsForApplications.js

@@ -17,8 +17,8 @@ const BREAKING_APPLICATION_VERSIONS = [
         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: `${(0, colorette_1.red)("Warning")}: You will not be able to use CLI commands on custom components until you manually migrate your components,
-due to breaking changes in the config.ts format and custom component API.
+        message: `${(0, colorette_1.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.
     
 ${(0, colorette_1.bold)("Your existing components are safe.")}
 

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.0.21",
+  "version": "0.0.22",
   "commands": {
     "init": {
       "id": "init",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@superblocksteam/cli",
-  "version": "0.0.21",
+  "version": "0.0.22",
   "description": "Official Superblocks CLI",
   "bin": {
     "superblocks": "bin/run"