@superblocksteam/util 0.0.21 → 0.0.22

package/dist/events.d.ts

@@ -0,0 +1,9 @@
+export declare enum ComponentEvent {
+    CREATE = "create",
+    INIT = "init",
+    LOGIN = "login",
+    MIGRATE = "migrate",
+    PULL = "pull",
+    REGISTER = "register",
+    UPLOAD = "upload"
+}

package/dist/events.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ComponentEvent = void 0;
+var ComponentEvent;
+(function (ComponentEvent) {
+    ComponentEvent["CREATE"] = "create";
+    ComponentEvent["INIT"] = "init";
+    ComponentEvent["LOGIN"] = "login";
+    ComponentEvent["MIGRATE"] = "migrate";
+    ComponentEvent["PULL"] = "pull";
+    ComponentEvent["REGISTER"] = "register";
+    ComponentEvent["UPLOAD"] = "upload";
+})(ComponentEvent || (exports.ComponentEvent = ComponentEvent = {}));

package/dist/file-uploader.d.ts

@@ -1 +1,2 @@
+export declare const COMPONENT_EVENT_HEADER = "x-superblocks-component-event";
 export declare const getBucketeerUrlFromSuperblocksUrl: (superblocksBaseUrl: string) => string;

package/dist/file-uploader.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getBucketeerUrlFromSuperblocksUrl = void 0;
+exports.getBucketeerUrlFromSuperblocksUrl = exports.COMPONENT_EVENT_HEADER = void 0;
 const lodash_1 = require("lodash");
+exports.COMPONENT_EVENT_HEADER = "x-superblocks-component-event";
 // retrieves bucketeer base URL given the superblocks server base URL
 const getBucketeerUrlFromSuperblocksUrl = (superblocksBaseUrl) => {
     // if superblocks base URL is an EE, return bucketeer's dev URL

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 export * from "./constants";
 export * from "./component-configs";
+export * from "./events";
 export * from "./file-uploader";
 export * from "./login";
 export * from "./resource-configs";

package/dist/index.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./constants"), exports);
 tslib_1.__exportStar(require("./component-configs"), exports);
+tslib_1.__exportStar(require("./events"), exports);
 tslib_1.__exportStar(require("./file-uploader"), exports);
 tslib_1.__exportStar(require("./login"), exports);
 tslib_1.__exportStar(require("./resource-configs"), exports);

package/dist/types.d.ts

@@ -2,25 +2,69 @@
 import { type UUID } from "node:crypto";
 import { type DataType } from "./data-types";
 interface PropertiesPanelDisplay {
+    /**
+     * Determines what form item type is shown in the Superblocks properties panel.
+     */
     controlType: "text" | "js-expr" | "switch";
+    /**
+     * Determines form item label in the Superblocks properties panel.
+     */
     label: string;
+    /**
+     * Placeholder text appears as gray text in the properties panel. This only applies
+     * to text-like inputs.
+     */
     placeholder?: string;
+    /**
+     * This shows up in the popover as a user types into the properties panel.
+     * This is a documentation field that helps users understand what type of data is accepted
+     * by this property.
+     */
     exampleData?: string;
 }
 export interface Property {
     path: string;
     dataType: DataType;
+    /**
+     * The presence of this object determines whether or not this property
+     * shows up in the Superblocks properties panel.
+     **/
     propertiesPanelDisplay?: PropertiesPanelDisplay;
+    /**
+     * A description of this property. This is used in the Superblocks properties panel
+     * as well as in the custom component's autocomplete.
+     **/
     description?: string;
+    /**
+     * By default, all your properties are readable from anywhere in Superblocks using dot notation
+     * (e.g. `myComponent.myProperty`). If you want to hide a property from the outside world,
+     * set this to false
+     * @default true
+     */
+    isExternallyReadable?: boolean;
+    /**
+     * By default, all properties can have be used with Set Component Property and Reset Component to Default.
+     * @default true
+     **/
+    isExternallySettable?: boolean;
 }
 export interface ComponentConfig {
     id: UUID;
+    /**
+     * @example: "myComponent"
+     */
     name: string;
+    /**
+     * @example "My Component"
+     */
     displayName: string;
+    /**
+     * @example "components/myComponent/component.tsx"
+     */
     componentPath: string;
     properties: Property[];
     /**
-     * Example: [{
+     * @example [{
      *  label: "On Click",
      *  path: "onClick",
      * }]

package/dist/validation.js

@@ -52,6 +52,8 @@ const componentSchema = {
                     additionalProperties: false,
                 },
                 description: { type: "string" },
+                isExternallySettable: { type: "boolean" },
+                isExternallyReadable: { type: "boolean" },
             },
             type: "object",
             additionalProperties: false,

package/package.json

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

package/src/events.ts

@@ -0,0 +1,9 @@
+export enum ComponentEvent {
+  CREATE = "create",
+  INIT = "init",
+  LOGIN = "login",
+  MIGRATE = "migrate",
+  PULL = "pull",
+  REGISTER = "register",
+  UPLOAD = "upload",
+}

package/src/file-uploader.ts

@@ -1,5 +1,7 @@
 import { isEmpty } from "lodash";
 
+export const COMPONENT_EVENT_HEADER = "x-superblocks-component-event";
+
 // retrieves bucketeer base URL given the superblocks server base URL
 export const getBucketeerUrlFromSuperblocksUrl = (
   superblocksBaseUrl: string

package/src/index.ts

@@ -1,5 +1,6 @@
 export * from "./constants";
 export * from "./component-configs";
+export * from "./events";
 export * from "./file-uploader";
 export * from "./login";
 export * from "./resource-configs";

package/src/types.ts

@@ -2,19 +2,27 @@ import { type UUID } from "node:crypto";
 import { type DataType } from "./data-types";
 
 interface PropertiesPanelDisplay {
-  // Determines what form item type is shown in the Superblocks properties panel.
+  /**
+   * Determines what form item type is shown in the Superblocks properties panel.
+   */
   controlType: "text" | "js-expr" | "switch";
 
-  // Determines form item label in the Superblocks properties panel.
+  /**
+   * Determines form item label in the Superblocks properties panel.
+   */
   label: string;
 
-  // Placeholder text appears as gray text in the properties panel. This only applies
-  // to text-like inputs.
+  /**
+   * Placeholder text appears as gray text in the properties panel. This only applies
+   * to text-like inputs.
+   */
   placeholder?: string;
 
-  // This shows up in the popover as a user types into the properties panel.
-  // This is a documentation field that helps users understand what type of data is accepted
-  // by this property.
+  /**
+   * This shows up in the popover as a user types into the properties panel.
+   * This is a documentation field that helps users understand what type of data is accepted
+   * by this property.
+   */
   exampleData?: string;
 }
 
@@ -22,31 +30,55 @@ export interface Property {
   path: string;
   dataType: DataType;
 
-  // The presence of this object determines whether or not this property
-  // shows up in the Superblocks properties panel.
+  /**
+   * The presence of this object determines whether or not this property
+   * shows up in the Superblocks properties panel.
+   **/
   propertiesPanelDisplay?: PropertiesPanelDisplay;
 
-  // A description of this property. This is used in the Superblocks properties panel
-  // as well as in the custom component's autocomplete.
+  /**
+   * A description of this property. This is used in the Superblocks properties panel
+   * as well as in the custom component's autocomplete.
+   **/
   description?: string;
+
+  /**
+   * By default, all your properties are readable from anywhere in Superblocks using dot notation
+   * (e.g. `myComponent.myProperty`). If you want to hide a property from the outside world,
+   * set this to false
+   * @default true
+   */
+  isExternallyReadable?: boolean;
+
+  /**
+   * By default, all properties can have be used with Set Component Property and Reset Component to Default.
+   * @default true
+   **/
+  isExternallySettable?: boolean;
 }
 
 export interface ComponentConfig {
   id: UUID;
 
-  // Example: "myComponent"
+  /**
+   * @example: "myComponent"
+   */
   name: string;
 
-  // Example: "My Component"
+  /**
+   * @example "My Component"
+   */
   displayName: string;
 
-  // Example: "components/myComponent/component.tsx"
+  /**
+   * @example "components/myComponent/component.tsx"
+   */
   componentPath: string;
 
   properties: Property[];
 
   /**
-   * Example: [{
+   * @example [{
    *  label: "On Click",
    *  path: "onClick",
    * }]

package/src/validation.ts

@@ -50,6 +50,8 @@ const componentSchema: Schema = {
           additionalProperties: false,
         },
         description: { type: "string" },
+        isExternallySettable: { type: "boolean" },
+        isExternallyReadable: { type: "boolean" },
       },
       type: "object",
       additionalProperties: false,