@superblocksteam/cli 1.0.0 → 1.0.2

package/README.md

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

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

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

package/dist/commands/components/create.js

@@ -14,7 +14,6 @@ const fs = tslib_1.__importStar(require("fs-extra"));
 const lodash_1 = require("lodash");
 const authenticated_command_1 = require("../../common/authenticated-command");
 const create_component_defaults_1 = require("../../common/defaults/create-component-defaults");
-const identifiers_1 = require("../../util/identifiers");
 // eslint-disable-next-line unicorn/prefer-module
 const rootDirectory = node_path_1.default.resolve(__dirname, "../../../");
 const DEFAULT_PACKAGE_JSON_TEMPLATE_PATH = node_path_1.default.resolve(rootDirectory, "assets/custom-components/setup");
@@ -53,8 +52,8 @@ class CreateComponent extends authenticated_command_1.AuthenticatedApplicationCo
             type: "input",
             name: "name",
             message: "What is the machine readable name of the component you want to create?",
-            validate: (response) => (0, identifiers_1.isValidIdentifier)(response) || "Invalid identifier",
-            initial: (0, identifiers_1.suggestIdentifier)(displayName, true) || "ToDoList",
+            validate: (response) => (0, util_1.isValidIdentifier)(response) || "Invalid identifier",
+            initial: (0, util_1.suggestIdentifier)(displayName, true) || "ToDoList",
         })).name;
         this.log();
         this.log(`${(0, colorette_1.cyanBright)("ℹ")}  Properties represent the state of the component. You will define how each property is made available to the rest of your App and whether each property is displayed in the Properties Panel. Read more about properties here: ${(0, colorette_1.magenta)("https://docs.superblocks.com/applications/custom-components/#properties--events")}`);
@@ -73,10 +72,12 @@ class CreateComponent extends authenticated_command_1.AuthenticatedApplicationCo
                     name: "path",
                     message: "What is the path of the property? This will be used to access the property in your code (e.g. currentTasks)",
                     validate: (response) => {
-                        if (!(0, identifiers_1.isValidIdentifier)(response))
+                        if (!(0, util_1.isValidIdentifier)(response))
                             return "Invalid identifier";
+                        if ((0, util_1.isReservedPropertyName)(response))
+                            return "Reserved property path (see https://docs.superblocks.com/applications/custom-components/faq#what-is-a-reserved-property)";
                         if (properties.some((v) => v.path === response))
-                            return "Duplicate property name";
+                            return "Duplicate property path";
                         return true;
                     },
                 })).path;
@@ -155,12 +156,14 @@ class CreateComponent extends authenticated_command_1.AuthenticatedApplicationCo
                     name: "value",
                     message: "What is the path of the event? This will be used to trigger the event in your code (e.g. onChange)",
                     type: "input",
-                    initial: (0, identifiers_1.suggestIdentifier)(eventHandlerName) || "onChange",
+                    initial: (0, util_1.suggestIdentifier)(eventHandlerName) || "onChange",
                     validate: (response) => {
-                        if (!(0, identifiers_1.isValidIdentifier)(response))
+                        if (!(0, util_1.isValidIdentifier)(response))
                             return "Invalid identifier";
+                        if ((0, util_1.isReservedPropertyName)(response))
+                            return "Reserved property path (see https://docs.superblocks.com/applications/custom-components/faq#what-is-a-reserved-property)";
                         if (events.some((v) => v.path === response))
-                            return "Duplicate property name";
+                            return "Duplicate property path";
                         return true;
                     },
                 })).value;

package/dist/common/version-control.js

@@ -119,17 +119,16 @@ async function writeResourceToDisk(resourceType, resourceId, resource, rootPath,
             };
             if (resource.apis) {
                 for (const api of resource.apis) {
-                    const apiName = slugifyName((_d = (_c = (_b = api.apiPb) === null || _b === void 0 ? void 0 : _b.metadata) === null || _c === void 0 ? void 0 : _c.name) !== null && _d !== void 0 ? _d : api.actions.name);
-                    // server is still sending actions for a backwards compatibility
-                    delete api.actions;
-                    const apiContent = (0, yaml_1.stringify)(api, {
+                    const originalApiName = (_d = (_c = (_b = api.apiPb) === null || _b === void 0 ? void 0 : _b.metadata) === null || _c === void 0 ? void 0 : _c.name) !== null && _d !== void 0 ? _d : api.actions.name;
+                    const apiName = slugifyName(originalApiName);
+                    const apiContent = (0, yaml_1.stringify)(api.apiPb, {
                         sortMapEntries: true,
                     });
                     const handleApi = async () => {
                         await fs.outputFile(`${apisDirName}/${apiName}.yaml`, apiContent);
                     };
                     apiPromises.push(handleApi());
-                    applicationConfig.apis[api.id] = apiName;
+                    applicationConfig.apis[api.id] = originalApiName;
                 }
                 await Promise.all(apiPromises);
             }
@@ -152,15 +151,13 @@ async function writeResourceToDisk(resourceType, resourceId, resource, rootPath,
         case "BACKEND": {
             const parentDirName = "backends";
             const apiName = slugifyName((_j = (_h = (_g = resource.apiPb) === null || _g === void 0 ? void 0 : _g.metadata) === null || _h === void 0 ? void 0 : _h.name) !== null && _j !== void 0 ? _j : resource.actions.name);
-            // server is still sending actions for a backwards compatibility
-            delete resource.actions;
             const newRelativeLocation = `${parentDirName}/${apiName}`;
             const relativeLocation = existingRelativeLocation !== null && existingRelativeLocation !== void 0 ? existingRelativeLocation : newRelativeLocation;
             const backendDirName = node_path_1.default.resolve(rootPath, relativeLocation);
             if (!(await fs.pathExists(backendDirName))) {
                 await fs.mkdir(backendDirName, { recursive: true });
             }
-            const backendContent = (0, yaml_1.stringify)(resource, {
+            const backendContent = (0, yaml_1.stringify)(resource.apiPb, {
                 sortMapEntries: true,
             });
             await fs.outputFile(`${backendDirName}/api.yaml`, backendContent);

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.0.0",
+  "version": "1.0.2",
   "commands": {
     "init": {
       "id": "init",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@superblocksteam/cli",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Official Superblocks CLI",
   "bin": {
     "superblocks": "bin/run"
@@ -18,11 +18,11 @@
     "@oclif/core": "^2.11.7",
     "@oclif/plugin-help": "^5.2.16",
     "@oclif/plugin-plugins": "^3.1.10",
-    "@superblocksteam/css-plugin": "1.0.0",
-    "@superblocksteam/react-shim": "1.0.0",
-    "@superblocksteam/sdk": "1.0.0",
-    "@superblocksteam/util": "1.0.0",
-    "@superblocksteam/vite-custom-component-reload-plugin": "1.0.0",
+    "@superblocksteam/css-plugin": "1.0.2",
+    "@superblocksteam/react-shim": "1.0.2",
+    "@superblocksteam/sdk": "1.0.2",
+    "@superblocksteam/util": "1.0.2",
+    "@superblocksteam/vite-custom-component-reload-plugin": "1.0.2",
     "@vitejs/plugin-react": "^4.0.4",
     "colorette": "^2.0.19",
     "enquirer": "^2.3.6",
@@ -45,7 +45,7 @@
     "@typescript-eslint/eslint-plugin": "^5.60.1",
     "@typescript-eslint/parser": "^5.60.1",
     "chai": "^4",
-    "eslint": "^8.45.0",
+    "eslint": "^8.48.0",
     "eslint-config-prettier": "8.8.0",
     "eslint-plugin-import": "2.27.5",
     "eslint-plugin-prettier": "4.2.1",
@@ -59,6 +59,7 @@
     "typescript": "^5.1.6"
   },
   "scripts": {
+    "preinstall": "node -e 'if (process.versions.node.split(`.`)[0] < 16) { console.error(`Incompatible Node version: Please use Node.js v16 or higher`); process.exit(1);}'",
     "build": "tsc --build",
     "clean": "npm run clean:build && rm -rf node_modules",
     "clean:build": "tsc --build --clean && rm -rf dist tsconfig.tsbuildinfo",

package/dist/util/identifiers.d.ts

@@ -1,7 +0,0 @@
-/**
- * Suggest an identifier based on a label, e.g. `My Component` -> `myComponent`.
- * @param label The label to suggest an identifier for.
- * @param capitalizeFirst Whether to capitalize the first letter of the identifier.
- */
-export declare function suggestIdentifier(label: string, capitalizeFirst?: boolean): string;
-export declare function isValidIdentifier(str: string): boolean;

package/dist/util/identifiers.js

@@ -1,37 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isValidIdentifier = exports.suggestIdentifier = void 0;
-// convert a string to upper camel case, e.g. "123 & this is my component, foo-bar" -> "123ThisIsMyComponentFooBar"
-function wordsToUpperCamelCase(str) {
-    return str
-        .split(/[^A-Za-z0-9_]+/)
-        .filter(Boolean)
-        .map((word) => word[0].toUpperCase() + word.slice(1))
-        .join("");
-}
-const digits = "Zero One Two Three Four Five Six Seven Eight Nine".split(" ");
-// convert digits to words, e.g. "123" -> "OneTwoThree"
-function digitsToWords(str) {
-    return str.replace(/\d/g, (char) => { var _a; return (_a = digits[parseInt(char, 10)]) !== null && _a !== void 0 ? _a : char; });
-}
-/**
- * Suggest an identifier based on a label, e.g. `My Component` -> `myComponent`.
- * @param label The label to suggest an identifier for.
- * @param capitalizeFirst Whether to capitalize the first letter of the identifier.
- */
-function suggestIdentifier(label, capitalizeFirst = false) {
-    const upperCamelCase = wordsToUpperCamelCase(label)
-        // convert any digits at the start of the string to words as these are not valid in identifiers
-        .replace(/^\d+/, digitsToWords);
-    if (capitalizeFirst) {
-        return upperCamelCase;
-    }
-    else {
-        return upperCamelCase[0].toLowerCase() + upperCamelCase.slice(1);
-    }
-}
-exports.suggestIdentifier = suggestIdentifier;
-function isValidIdentifier(str) {
-    return /^[a-zA-Z_][a-zA-Z0-9_]*$/.test(str);
-}
-exports.isValidIdentifier = isValidIdentifier;