@superblocksteam/util 0.0.14 → 0.0.15

package/.eslintrc.json

@@ -0,0 +1,51 @@
+{
+  "parser": "@typescript-eslint/parser",
+  "plugins": [
+    "@typescript-eslint",
+    "prettier",
+    "import",
+    "unicorn"
+  ],
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:prettier/recommended",
+    "prettier",
+    "plugin:import/typescript"
+  ],
+  "parserOptions": {
+    "ecmaVersion": 2020,
+    "sourceType": "module",
+    "project": true
+  },
+  "rules": {
+    "@typescript-eslint/explicit-module-boundary-types": "off",
+    "@typescript-eslint/no-explicit-any": "off",
+    "@typescript-eslint/no-unused-vars": "error",
+    "@typescript-eslint/no-var-requires": "off",
+    "@typescript-eslint/no-unsafe-return": "off",
+    "@typescript-eslint/no-unsafe-assignment": "off",
+    "@typescript-eslint/no-unsafe-member-access": "off",
+    "import/order": [
+      "error",
+      {
+        "alphabetize": { "order": "asc" },
+        "groups": [
+          "builtin",
+          "external",
+          "internal",
+          "parent",
+          "sibling",
+          "index",
+          "object",
+          "type"
+        ]
+      }
+    ],
+    "import/no-cycle": "error",
+    "no-template-curly-in-string": "off",
+    "no-useless-escape": "off",
+    "no-void": ["error", { "allowAsStatement": true }]
+  },
+  "ignorePatterns": ["public", "build", "node_modules", "dist", "tsup.config.ts"]
+}

package/dist/component-configs.d.ts

@@ -1 +1,4 @@
-export declare function getComponentConfigs(): Promise<Record<string, any>>;
+export declare function getComponentConfigs(): Promise<{
+    configs: Record<string, any>;
+    hasError: boolean;
+}>;

package/dist/component-configs.js

@@ -2,17 +2,36 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getComponentConfigs = void 0;
 const tslib_1 = require("tslib");
-const node_path_1 = tslib_1.__importDefault(require("node:path"));
+const child_process_1 = require("child_process");
 const node_os_1 = tslib_1.__importDefault(require("node:os"));
+const node_path_1 = tslib_1.__importDefault(require("node:path"));
 const fs = tslib_1.__importStar(require("fs-extra"));
 const constants_1 = require("./constants");
-const child_process_1 = require("child_process");
+const validation_1 = require("./validation");
 const compileTypeScript = (inputFilePath, outputDir) => {
     return new Promise((resolve, reject) => {
         try {
             const tscPath = require.resolve("typescript/bin/tsc");
             if (tscPath) {
-                (0, child_process_1.execFile)(tscPath, [node_path_1.default.resolve(inputFilePath), "--outDir", outputDir, "--jsx", "react-jsx", "--target", "es2019", "--esModuleInterop", "true", "--moduleResolution", "node", "--module", "commonjs", "--strict", "true", "--skipLibCheck", "true"], (error, stdout, stderr) => {
+                (0, child_process_1.execFile)(tscPath, [
+                    node_path_1.default.resolve(inputFilePath),
+                    "--outDir",
+                    outputDir,
+                    "--jsx",
+                    "react-jsx",
+                    "--target",
+                    "es2019",
+                    "--esModuleInterop",
+                    "true",
+                    "--moduleResolution",
+                    "node",
+                    "--module",
+                    "commonjs",
+                    "--strict",
+                    "true",
+                    "--skipLibCheck",
+                    "true",
+                ], (error, stdout, stderr) => {
                     if (error) {
                         // Print any Typescript output to the user, such as errors
                         console.log(stdout);
@@ -49,6 +68,7 @@ async function getFolderPaths() {
 }
 async function getComponentConfigs() {
     const folderPaths = await getFolderPaths();
+    let hasError = false;
     const promiseConfigFiles = folderPaths.map(async (ccpath) => {
         try {
             const ret = await fs.readJSON(`${ccpath}/config.json`);
@@ -72,7 +92,13 @@ async function getComponentConfigs() {
             await compileTypeScript(fileName, outputDirectory);
             console.log(`Typescript compiled to ${ccpath}`);
             const ret = (await Promise.resolve(`${outputDirectory + "/config.js"}`).then(s => tslib_1.__importStar(require(s)))).default;
-            console.log(`Found component in ${ccpath}`);
+            const isValid = (0, validation_1.validateCustomComponents)(ret);
+            if (!isValid.valid) {
+                // Not throwing because we don't need a stack trace here
+                console.log(`Invalid config.ts file found`);
+                console.log(isValid.message);
+                hasError = true;
+            }
             return ret;
         }
         catch (e) {
@@ -87,6 +113,9 @@ async function getComponentConfigs() {
         acc[config.id] = config;
         return acc;
     }, {});
-    return configFiles;
+    return {
+        configs: configFiles,
+        hasError,
+    };
 }
 exports.getComponentConfigs = getComponentConfigs;

package/dist/resource-configs.d.ts

@@ -4,10 +4,11 @@ export type SuperblocksMetadata = {
     lastUpdated: string;
     created: string;
 };
+export type SuperblocksResourceType = "APPLICATION" | "BACKEND";
 export type VersionedResourceConfig = {
     location: string;
     lastUpdated: string;
-    resourceType: "APPLICATION" | "BACKEND";
+    resourceType: SuperblocksResourceType;
 };
 export type SuperblocksResourceConfig = {
     id: string;

package/dist/resource-configs.js

@@ -70,11 +70,15 @@ async function getSuperblocksResourceConfigIfExists() {
     try {
         config = await getSuperblocksApplicationConfigJson();
     }
-    catch { }
+    catch {
+        // Noop
+    }
     try {
         config = await getSuperblocksBackendConfigJson();
     }
-    catch { }
+    catch {
+        // Noop
+    }
     return config;
 }
 exports.getSuperblocksResourceConfigIfExists = getSuperblocksResourceConfigIfExists;

package/dist/validation.d.ts

@@ -0,0 +1,4 @@
+export declare function validateCustomComponents(data: any): {
+    valid: boolean;
+    message?: string;
+};

package/dist/validation.js

@@ -0,0 +1,73 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateCustomComponents = void 0;
+const tslib_1 = require("tslib");
+const ajv_1 = tslib_1.__importDefault(require("ajv"));
+const better_ajv_errors_1 = tslib_1.__importDefault(require("better-ajv-errors"));
+const ajv = new ajv_1.default();
+const componentSchema = {
+    type: "object",
+    properties: {
+        id: { type: "string" },
+        name: { type: "string" },
+        displayName: { type: "string" },
+        componentPath: { type: "string" },
+        statefulProperties: {
+            type: "array",
+            items: {
+                $ref: "#/definitions/StatefulProperty",
+            },
+        },
+        eventHandlers: {
+            type: "array",
+            items: {
+                $ref: "#/definitions/EventHandler",
+            },
+        },
+    },
+    required: [
+        "id",
+        "name",
+        "displayName",
+        "componentPath",
+        "statefulProperties",
+        "eventHandlers",
+    ],
+    additionalProperties: false,
+    definitions: {
+        StatefulProperty: {
+            properties: {
+                label: { type: "string" },
+                path: { type: "string" },
+                inputType: { enum: ["text", "number", "boolean", "js"] },
+                placeholder: { type: "string" },
+            },
+            type: "object",
+            additionalProperties: false,
+            required: ["label", "path", "inputType"],
+        },
+        EventHandler: {
+            properties: {
+                label: { type: "string" },
+                path: { type: "string" },
+            },
+            type: "object",
+            additionalProperties: false,
+            required: ["label", "path"],
+        },
+    },
+};
+const validate = ajv.compile(componentSchema);
+function validateCustomComponents(data) {
+    const valid = validate(data);
+    if (!valid) {
+        return {
+            valid: false,
+            message: (0, better_ajv_errors_1.default)(componentSchema, data, validate.errors, {
+                indent: 2,
+            }),
+        };
+    }
+    return { valid: true };
+}
+exports.validateCustomComponents = validateCustomComponents;

package/package.json

@@ -1,17 +1,28 @@
 {
   "name": "@superblocksteam/util",
-  "version": "0.0.14",
+  "version": "0.0.15",
   "main": "dist/index.js",
   "homepage": "https://www.superblocks.com",
   "scripts": {
     "dev": "tsc --watch",
     "build": "tsc --build",
     "clean": "npm run clean:build && rm -rf node_modules",
-    "clean:build": "tsc --build --clean && rm -rf dist tsconfig.tsbuildinfo"
+    "clean:build": "tsc --build --clean && rm -rf dist tsconfig.tsbuildinfo",
+    "lint": "eslint . --ext .ts --config .eslintrc.json",
+    "lint:fix": "eslint . --ext .ts --config .eslintrc.json --fix"
   },
   "license": "Superblocks Community Software License",
   "description": "",
+  "dependencies": {
+    "ajv": "^8.12.0",
+    "better-ajv-errors": "^1.2.0"
+  },
   "devDependencies": {
-    "typescript": "^5.0.4"
+    "@typescript-eslint/eslint-plugin": "^5.60.1",
+    "@typescript-eslint/parser": "^5.60.1",
+    "eslint": "^8.45.0",
+    "eslint-plugin-unicorn": "^47.0.0",
+    "prettier": "^2.8.8",
+    "typescript": "^5.1.3"
   }
 }

package/src/component-configs.ts

@@ -1,8 +1,9 @@
-import path from "node:path";
+import { execFile } from "child_process";
 import os from "node:os";
+import path from "node:path";
 import * as fs from "fs-extra";
 import { CUSTOM_COMPONENTS_PATH } from "./constants";
-import { execFile } from "child_process";
+import { validateCustomComponents } from "./validation";
 
 const compileTypeScript = (inputFilePath: string, outputDir: string) => {
   return new Promise((resolve, reject) => {
@@ -11,7 +12,25 @@ const compileTypeScript = (inputFilePath: string, outputDir: string) => {
       if (tscPath) {
         execFile(
           tscPath,
-          [path.resolve(inputFilePath), "--outDir", outputDir, "--jsx", "react-jsx", "--target", "es2019", "--esModuleInterop", "true", "--moduleResolution", "node", "--module", "commonjs", "--strict", "true", "--skipLibCheck", "true"],
+          [
+            path.resolve(inputFilePath),
+            "--outDir",
+            outputDir,
+            "--jsx",
+            "react-jsx",
+            "--target",
+            "es2019",
+            "--esModuleInterop",
+            "true",
+            "--moduleResolution",
+            "node",
+            "--module",
+            "commonjs",
+            "--strict",
+            "true",
+            "--skipLibCheck",
+            "true",
+          ],
           (error, stdout, stderr) => {
             if (error) {
               // Print any Typescript output to the user, such as errors
@@ -28,7 +47,11 @@ const compileTypeScript = (inputFilePath: string, outputDir: string) => {
         );
       }
     } catch (e) {
-      reject(new Error("Could not find TypeScript, please install it globally (npm install -g typescript)"));
+      reject(
+        new Error(
+          "Could not find TypeScript, please install it globally (npm install -g typescript)"
+        )
+      );
     }
   });
 };
@@ -52,8 +75,12 @@ async function getFolderPaths() {
   }
 }
 
-export async function getComponentConfigs(): Promise<Record<string, any>> {
+export async function getComponentConfigs(): Promise<{
+  configs: Record<string, any>;
+  hasError: boolean;
+}> {
   const folderPaths = await getFolderPaths();
+  let hasError = false;
   const promiseConfigFiles = folderPaths.map(async (ccpath) => {
     try {
       const ret = await fs.readJSON(`${ccpath}/config.json`);
@@ -79,7 +106,14 @@ export async function getComponentConfigs(): Promise<Record<string, any>> {
       await compileTypeScript(fileName, outputDirectory);
       console.log(`Typescript compiled to ${ccpath}`);
       const ret = (await import(outputDirectory + "/config.js")).default;
-      console.log(`Found component in ${ccpath}`);
+
+      const isValid = validateCustomComponents(ret);
+      if (!isValid.valid) {
+        // Not throwing because we don't need a stack trace here
+        console.log(`Invalid config.ts file found`);
+        console.log(isValid.message);
+        hasError = true;
+      }
       return ret;
     } catch (e: any) {
       console.error(e);
@@ -93,5 +127,8 @@ export async function getComponentConfigs(): Promise<Record<string, any>> {
       acc[config.id] = config;
       return acc;
     }, {});
-  return configFiles;
+  return {
+    configs: configFiles,
+    hasError,
+  };
 }

package/src/resource-configs.ts

@@ -8,10 +8,12 @@ export type SuperblocksMetadata = {
   created: string;
 };
 
+export type SuperblocksResourceType = "APPLICATION" | "BACKEND";
+
 export type VersionedResourceConfig = {
   location: string;
   lastUpdated: string;
-  resourceType: "APPLICATION" | "BACKEND";
+  resourceType: SuperblocksResourceType;
 };
 
 export type SuperblocksResourceConfig = {
@@ -123,9 +125,13 @@ export async function getSuperblocksResourceConfigIfExists(): Promise<
   let config: SuperblocksResourceConfig | undefined;
   try {
     config = await getSuperblocksApplicationConfigJson();
-  } catch {}
+  } catch {
+    // Noop
+  }
   try {
     config = await getSuperblocksBackendConfigJson();
-  } catch {}
+  } catch {
+    // Noop
+  }
   return config;
 }

package/src/validation.ts

@@ -0,0 +1,75 @@
+import Ajv, { Schema } from "ajv";
+import betterAjvErrors from "better-ajv-errors";
+
+const ajv = new Ajv();
+
+const componentSchema: Schema = {
+  type: "object",
+  properties: {
+    id: { type: "string" },
+    name: { type: "string" },
+    displayName: { type: "string" },
+    componentPath: { type: "string" },
+    statefulProperties: {
+      type: "array",
+      items: {
+        $ref: "#/definitions/StatefulProperty",
+      },
+    },
+    eventHandlers: {
+      type: "array",
+      items: {
+        $ref: "#/definitions/EventHandler",
+      },
+    },
+  },
+  required: [
+    "id",
+    "name",
+    "displayName",
+    "componentPath",
+    "statefulProperties",
+    "eventHandlers",
+  ],
+  additionalProperties: false,
+  definitions: {
+    StatefulProperty: {
+      properties: {
+        label: { type: "string" },
+        path: { type: "string" },
+        inputType: { enum: ["text", "number", "boolean", "js"] },
+        placeholder: { type: "string" },
+      },
+      type: "object",
+      additionalProperties: false,
+      required: ["label", "path", "inputType"],
+    },
+    EventHandler: {
+      properties: {
+        label: { type: "string" },
+        path: { type: "string" },
+      },
+      type: "object",
+      additionalProperties: false,
+      required: ["label", "path"],
+    },
+  },
+};
+
+const validate = ajv.compile(componentSchema);
+
+export function validateCustomComponents(data: any): {
+  valid: boolean;
+  message?: string;
+} {
+  const valid = validate(data);
+  if (!valid) {
+    return {
+      valid: false,
+      message: betterAjvErrors(componentSchema, data, validate.errors as any, {
+        indent: 2,
+      }),
+    };
+  }
+  return { valid: true };
+}