@superblocksteam/util 0.0.18 → 0.0.20

package/dist/file-uploader.js

@@ -4,7 +4,6 @@ exports.getBucketeerUrlFromSuperblocksUrl = void 0;
 const lodash_1 = require("lodash");
 // retrieves bucketeer base URL given the superblocks server base URL
 const getBucketeerUrlFromSuperblocksUrl = (superblocksBaseUrl) => {
-    superblocksBaseUrl = superblocksBaseUrl.replace(/\/$/, "");
     // if superblocks base URL is an EE, return bucketeer's dev URL
     if (!(0, lodash_1.isEmpty)(superblocksBaseUrl.match(new RegExp("pr-.*.superblocks.dev")))) {
         return "https://bucketeer.dev.superblocks.com";

package/dist/generate-component-types.js

@@ -22,19 +22,12 @@ function generateComponentTypesFile(config) {
 // All stateful properties of your component are defined here.
 // These are the properties which are surfaced in the Superblocks properties panel
 // and can be referenced throughout your Superblocks Application
-export interface StatefulProperties {
+export interface Props {
 ${statefulProperties
         .map((v) => renderInputTypeAsTS(v.path, v.inputType, ";", 2) + "\n")
         .join("")}}
 
-export interface Props extends StatefulProperties {
-  /**
-   * Update one (or more) of your component's stateful properties. This will cause the component to rerender,
-   * and will also notify any other components in your Application which depend on the updated properties, so they also rerender
-   * @param props An object with the properties to update along with their new values
-   */
-  updateStatefulProperties: (props: Partial<StatefulProperties>) => void;
-
+export interface EventTriggers {
   // Call the subsequent function(s) to trigger event(s) in Superblocks from your component.
   // These events can be wired up to event handlers in your Superblocks App
 ${eventHandlers.length === 0

package/dist/index.d.ts

@@ -4,3 +4,4 @@ export * from "./file-uploader";
 export * from "./login";
 export * from "./resource-configs";
 export * from "./input-types";
+export * from "./types";

package/dist/index.js

@@ -7,3 +7,4 @@ tslib_1.__exportStar(require("./file-uploader"), exports);
 tslib_1.__exportStar(require("./login"), exports);
 tslib_1.__exportStar(require("./resource-configs"), exports);
 tslib_1.__exportStar(require("./input-types"), exports);
+tslib_1.__exportStar(require("./types"), exports);

package/dist/resource-configs.d.ts

@@ -1,12 +1,9 @@
 export type SuperblocksMetadata = {
     cliVersion: string;
-    lastUpdated: string;
-    created: string;
 };
 export type SuperblocksResourceType = "APPLICATION" | "BACKEND";
 export type VersionedResourceConfig = {
     location: string;
-    lastUpdated: string;
     resourceType: SuperblocksResourceType;
 };
 export type SuperblocksResourceConfig = {
@@ -31,6 +28,7 @@ export type SuperblocksConfig = SuperblocksMonorepoConfig | SuperblocksApplicati
  * @param checkParentDir Whether to recursively check the parent directory for a Superblocks config file
  */
 export declare function getSuperblocksMonorepoConfigJson(checkParentDir?: boolean, pathPrefix?: string): Promise<[SuperblocksMonorepoConfig, string]>;
+export declare function updatedMonorepoConfig(version: string): Promise<void>;
 export declare function getSuperblocksApplicationConfigJson(): Promise<SuperblocksApplicationConfig>;
 export declare function getSuperblocksBackendConfigJson(): Promise<SuperblocksBackendConfig>;
 export declare function getSuperblocksResourceConfigIfExists(): Promise<SuperblocksResourceConfig | undefined>;

package/dist/resource-configs.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getSuperblocksResourceConfigIfExists = exports.getSuperblocksBackendConfigJson = exports.getSuperblocksApplicationConfigJson = exports.getSuperblocksMonorepoConfigJson = void 0;
+exports.getSuperblocksResourceConfigIfExists = exports.getSuperblocksBackendConfigJson = exports.getSuperblocksApplicationConfigJson = exports.updatedMonorepoConfig = exports.getSuperblocksMonorepoConfigJson = void 0;
 const tslib_1 = require("tslib");
 const fs = tslib_1.__importStar(require("fs-extra"));
 const constants_1 = require("./constants");
@@ -35,6 +35,21 @@ async function getSuperblocksMonorepoConfigJson(checkParentDir = false, pathPref
     }
 }
 exports.getSuperblocksMonorepoConfigJson = getSuperblocksMonorepoConfigJson;
+async function updatedMonorepoConfig(version) {
+    try {
+        const [previousConfig, configPath] = await getSuperblocksMonorepoConfigJson(true);
+        if (previousConfig.metadata.cliVersion !== version) {
+            const newConfig = JSON.parse(JSON.stringify(previousConfig));
+            newConfig.metadata.cliVersion = version;
+            // update superblocks.json file
+            await fs.writeFile(configPath, JSON.stringify(updatedMonorepoConfig, null, 2));
+        }
+    }
+    catch {
+        // This might fail for a brand-new project folder, which is deliberately ignored
+    }
+}
+exports.updatedMonorepoConfig = updatedMonorepoConfig;
 async function getSuperblocksApplicationConfigJson() {
     let superblocksConfig;
     try {

package/dist/types.d.ts

@@ -0,0 +1,26 @@
+/// <reference types="node" />
+import { type UUID } from "node:crypto";
+import { type InputType } from "./input-types";
+export interface StatefulProperty {
+    label: string;
+    path: string;
+    inputType: InputType;
+    placeholder?: string;
+}
+export interface ComponentConfig {
+    id: UUID;
+    name: string;
+    displayName: string;
+    componentPath: string;
+    statefulProperties: StatefulProperty[];
+    /**
+     * Example: [{
+     *  label: "On Click",
+     *  path: "onClick",
+     * }]
+     */
+    eventHandlers: Array<{
+        label: string;
+        path: string;
+    }>;
+}

package/dist/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@superblocksteam/util",
-  "version": "0.0.18",
+  "version": "0.0.20",
   "main": "dist/index.js",
   "homepage": "https://www.superblocks.com",
   "scripts": {

package/src/file-uploader.ts

@@ -4,7 +4,6 @@ import { isEmpty } from "lodash";
 export const getBucketeerUrlFromSuperblocksUrl = (
   superblocksBaseUrl: string
 ): string => {
-  superblocksBaseUrl = superblocksBaseUrl.replace(/\/$/, "");
   // if superblocks base URL is an EE, return bucketeer's dev URL
   if (!isEmpty(superblocksBaseUrl.match(new RegExp("pr-.*.superblocks.dev")))) {
     return "https://bucketeer.dev.superblocks.com";

package/src/generate-component-types.ts

@@ -30,19 +30,12 @@ export function generateComponentTypesFile(config: any) {
 // All stateful properties of your component are defined here.
 // These are the properties which are surfaced in the Superblocks properties panel
 // and can be referenced throughout your Superblocks Application
-export interface StatefulProperties {
+export interface Props {
 ${statefulProperties
   .map((v: any) => renderInputTypeAsTS(v.path, v.inputType, ";", 2) + "\n")
   .join("")}}
 
-export interface Props extends StatefulProperties {
-  /**
-   * Update one (or more) of your component's stateful properties. This will cause the component to rerender,
-   * and will also notify any other components in your Application which depend on the updated properties, so they also rerender
-   * @param props An object with the properties to update along with their new values
-   */
-  updateStatefulProperties: (props: Partial<StatefulProperties>) => void;
-
+export interface EventTriggers {
   // Call the subsequent function(s) to trigger event(s) in Superblocks from your component.
   // These events can be wired up to event handlers in your Superblocks App
 ${

package/src/index.ts

@@ -4,3 +4,4 @@ export * from "./file-uploader";
 export * from "./login";
 export * from "./resource-configs";
 export * from "./input-types";
+export * from "./types";

package/src/resource-configs.ts

@@ -3,15 +3,12 @@ import { RESOURCE_CONFIG_PATH } from "./constants";
 
 export type SuperblocksMetadata = {
   cliVersion: string;
-  lastUpdated: string;
-  created: string;
 };
 
 export type SuperblocksResourceType = "APPLICATION" | "BACKEND";
 
 export type VersionedResourceConfig = {
   location: string;
-  lastUpdated: string;
   resourceType: SuperblocksResourceType;
 };
 
@@ -78,6 +75,25 @@ export async function getSuperblocksMonorepoConfigJson(
   }
 }
 
+export async function updatedMonorepoConfig(version: string) {
+  try {
+    const [previousConfig, configPath] = await getSuperblocksMonorepoConfigJson(
+      true
+    );
+    if (previousConfig.metadata.cliVersion !== version) {
+      const newConfig = JSON.parse(JSON.stringify(previousConfig));
+      newConfig.metadata.cliVersion = version;
+      // update superblocks.json file
+      await fs.writeFile(
+        configPath,
+        JSON.stringify(updatedMonorepoConfig, null, 2)
+      );
+    }
+  } catch {
+    // This might fail for a brand-new project folder, which is deliberately ignored
+  }
+}
+
 export async function getSuperblocksApplicationConfigJson(): Promise<SuperblocksApplicationConfig> {
   let superblocksConfig;
   try {

package/src/types.ts

@@ -0,0 +1,35 @@
+import { type UUID } from "node:crypto";
+import { type InputType } from "./input-types";
+
+export interface StatefulProperty {
+  label: string;
+  path: string;
+  inputType: InputType;
+  placeholder?: string;
+}
+
+export interface ComponentConfig {
+  id: UUID;
+
+  // Example: "myComponent"
+  name: string;
+
+  // Example: "My Component"
+  displayName: string;
+
+  // Example: "components/myComponent/component.tsx"
+  componentPath: string;
+
+  statefulProperties: StatefulProperty[];
+
+  /**
+   * Example: [{
+   *  label: "On Click",
+   *  path: "onClick",
+   * }]
+   */
+  eventHandlers: Array<{
+    label: string;
+    path: string;
+  }>;
+}