@superblocksteam/util 2.0.158 → 2.0.159-next.0

package/dist/types.d.ts

@@ -1,105 +0,0 @@
-import type { UUID } from "node:crypto";
-import type { DataType } from "./data-types.js";
-interface PropertiesPanelDisplay<T extends DataType> {
-    /**
-     * Determines what form item type is shown in the Superblocks properties panel.
-     *
-     * Only booleans are allowed to use the "switch" control
-     */
-    controlType: T extends "boolean" ? "text" | "js-expr" | "switch" : "text" | "js-expr";
-    /**
-     * 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. You should give a specific example, not a generic type
-     *
-     * @example {
-     *   label: "My Label",
-     *   value: "myValue"
-     * }
-     */
-    exampleData?: 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. Typescript notation is recommended.
-     *
-     * @example "Array<{ label: string; value: string; }>"
-     */
-    expectedType?: string;
-    /**
-     * The default value should match the dataType of the property.
-     */
-    defaultValue?: T;
-    /**
-     * The default value to use when adding a property.
-     */
-    defaultOnAdd?: T;
-}
-interface PropertyForData<T extends DataType> {
-    path: string;
-    dataType: T;
-    /**
-     * The presence of this object determines whether or not this property
-     * shows up in the Superblocks properties panel.
-     **/
-    propertiesPanelDisplay?: PropertiesPanelDisplay<T>;
-    /**
-     * 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 true
-     * @default false
-     */
-    isExternallyReadable?: boolean;
-    /**
-     * By default, all properties can have be used with Set Component Property and Reset Component to Default.
-     * @default true
-     **/
-    isExternallySettable?: boolean;
-}
-export type Property = PropertyForData<"string"> | PropertyForData<"number"> | PropertyForData<"boolean"> | PropertyForData<"any">;
-export interface ComponentConfig {
-    id: UUID;
-    /**
-     * @example: "myComponent"
-     */
-    name: string;
-    /**
-     * @example "My Component"
-     */
-    displayName: string;
-    /**
-     * @example "components/myComponent/component.tsx"
-     */
-    componentPath: string;
-    properties: Array<PropertyForData<"string"> | PropertyForData<"number"> | PropertyForData<"boolean"> | PropertyForData<"any">>;
-    /**
-     * @example [{
-     *  label: "On Click",
-     *  path: "onClick",
-     * }]
-     */
-    events: Array<{
-        label: string;
-        path: string;
-    }>;
-    gridDimensions?: {
-        initialColumns: number;
-        initialRows: number;
-    };
-}
-export {};
-//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AAExC,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAEhD,UAAU,sBAAsB,CAAC,CAAC,SAAS,QAAQ;IACjD;;;;OAIG;IACH,WAAW,EAAE,CAAC,SAAS,SAAS,GAC5B,MAAM,GAAG,SAAS,GAAG,QAAQ,GAC7B,MAAM,GAAG,SAAS,CAAC;IAEvB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;;;;;OASG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;;OAMG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,YAAY,CAAC,EAAE,CAAC,CAAC;IAEjB;;OAEG;IACH,YAAY,CAAC,EAAE,CAAC,CAAC;CAClB;AAED,UAAU,eAAe,CAAC,CAAC,SAAS,QAAQ;IAC1C,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,CAAC,CAAC;IAEZ;;;QAGI;IACJ,sBAAsB,CAAC,EAAE,sBAAsB,CAAC,CAAC,CAAC,CAAC;IAEnD;;;QAGI;IACJ,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;OAKG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAE/B;;;QAGI;IACJ,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAChC;AAED,MAAM,MAAM,QAAQ,GAChB,eAAe,CAAC,QAAQ,CAAC,GACzB,eAAe,CAAC,QAAQ,CAAC,GACzB,eAAe,CAAC,SAAS,CAAC,GAC1B,eAAe,CAAC,KAAK,CAAC,CAAC;AAE3B,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,IAAI,CAAC;IAET;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB,UAAU,EAAE,KAAK,CAIb,eAAe,CAAC,QAAQ,CAAC,GACzB,eAAe,CAAC,QAAQ,CAAC,GACzB,eAAe,CAAC,SAAS,CAAC,GAC1B,eAAe,CAAC,KAAK,CAAC,CACzB,CAAC;IAEF;;;;;OAKG;IACH,MAAM,EAAE,KAAK,CAAC;QACZ,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,EAAE,MAAM,CAAC;KACd,CAAC,CAAC;IAEH,cAAc,CAAC,EAAE;QACf,cAAc,EAAE,MAAM,CAAC;QACvB,WAAW,EAAE,MAAM,CAAC;KACrB,CAAC;CACH"}

package/dist/types.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/dist/unreachable.d.ts

@@ -1,2 +0,0 @@
-export declare function unreachable(value: never, errMsg?: string): never;
-//# sourceMappingURL=unreachable.d.ts.map

package/dist/unreachable.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"unreachable.d.ts","sourceRoot":"","sources":["../src/unreachable.ts"],"names":[],"mappings":"AAAA,wBAAgB,WAAW,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,KAAK,CAIhE"}

package/dist/unreachable.js

@@ -1,7 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.unreachable = unreachable;
-function unreachable(value, errMsg) {
-    throw new TypeError(errMsg ?? "Encountered impossible value: " + JSON.stringify(value));
-}
-//# sourceMappingURL=unreachable.js.map

package/dist/unreachable.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"unreachable.js","sourceRoot":"","sources":["../src/unreachable.ts"],"names":[],"mappings":";;AAAA,kCAIC;AAJD,SAAgB,WAAW,CAAC,KAAY,EAAE,MAAe;IACvD,MAAM,IAAI,SAAS,CACjB,MAAM,IAAI,gCAAgC,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CACnE,CAAC;AACJ,CAAC"}

package/dist/validation.d.ts

@@ -1,5 +0,0 @@
-export declare function validateCustomComponents(data: any): {
-    valid: boolean;
-    message?: string;
-};
-//# sourceMappingURL=validation.d.ts.map

package/dist/validation.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"validation.d.ts","sourceRoot":"","sources":["../src/validation.ts"],"names":[],"mappings":"AA4IA,wBAAgB,wBAAwB,CAAC,IAAI,EAAE,GAAG,GAAG;IACnD,KAAK,EAAE,OAAO,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAWA"}

package/dist/validation.js

@@ -1,152 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateCustomComponents = validateCustomComponents;
-const ajv_1 = __importDefault(require("ajv"));
-const better_ajv_errors_1 = __importDefault(require("better-ajv-errors"));
-const identifiers_js_1 = require("./identifiers.js");
-const ajv = new ajv_1.default();
-ajv.addKeyword({
-    keyword: "stringFormat",
-    compile: (schema) => {
-        let validateFunc;
-        // schema is the value assigned to stringFormat in the schema
-        if (schema === "identifier") {
-            validateFunc = (data) => {
-                if (typeof data != "string")
-                    return false;
-                if (!(0, identifiers_js_1.isValidIdentifier)(data)) {
-                    validateFunc.errors = [
-                        {
-                            keyword: "format",
-                            message: "must be a valid identifier starting with a-z or underscore and containing only a-z, 0-9, and underscores",
-                        },
-                    ];
-                    return false;
-                }
-                if ((0, identifiers_js_1.isReservedPropertyName)(data)) {
-                    validateFunc.errors = [
-                        {
-                            keyword: "format",
-                            message: "must not match a reserved property path",
-                        },
-                    ];
-                    return false;
-                }
-                return true;
-            };
-        }
-        else {
-            throw new Error(`Unknown stringFormat: ${schema}`);
-        }
-        return validateFunc;
-    },
-    errors: true,
-});
-const componentSchema = {
-    type: "object",
-    properties: {
-        id: { type: "string" },
-        name: { type: "string" },
-        displayName: { type: "string" },
-        componentPath: { type: "string" },
-        properties: {
-            type: "array",
-            items: {
-                $ref: "#/definitions/Property",
-            },
-        },
-        events: {
-            type: "array",
-            items: {
-                $ref: "#/definitions/EventHandler",
-            },
-        },
-        gridDimensions: {
-            type: "object",
-            properties: {
-                initialColumns: { type: "number" },
-                initialRows: { type: "number" },
-            },
-            additionalProperties: false,
-            required: ["initialColumns", "initialRows"],
-        },
-    },
-    required: [
-        "id",
-        "name",
-        "displayName",
-        "componentPath",
-        "properties",
-        "events",
-    ],
-    additionalProperties: false,
-    definitions: {
-        Property: {
-            properties: {
-                path: { $ref: "#/definitions/Identifier" },
-                dataType: { enum: ["number", "boolean", "string", "any"] },
-                propertiesPanelDisplay: {
-                    type: "object",
-                    properties: {
-                        label: { type: "string" },
-                        controlType: { enum: ["text", "js-expr", "switch"] },
-                        defaultValue: {
-                            oneOf: [
-                                {
-                                    type: "string",
-                                },
-                                {
-                                    type: "boolean",
-                                },
-                                {
-                                    type: "number",
-                                },
-                            ],
-                        },
-                        placeholder: { type: "string" },
-                        exampleData: { type: "string" },
-                        expectedType: { type: "string" },
-                    },
-                    required: ["controlType", "label"],
-                    additionalProperties: false,
-                },
-                description: { type: "string" },
-                isExternallySettable: { type: "boolean" },
-                isExternallyReadable: { type: "boolean" },
-            },
-            type: "object",
-            additionalProperties: false,
-            required: ["path", "dataType"],
-        },
-        EventHandler: {
-            properties: {
-                label: { type: "string" },
-                path: { $ref: "#/definitions/Identifier" },
-            },
-            type: "object",
-            additionalProperties: false,
-            required: ["label", "path"],
-        },
-        Identifier: {
-            type: "string",
-            stringFormat: "identifier",
-        },
-    },
-};
-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 };
-}
-//# sourceMappingURL=validation.js.map

package/dist/validation.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"validation.js","sourceRoot":"","sources":["../src/validation.ts"],"names":[],"mappings":";;;;;AA4IA,4DAcC;AA1JD,8CAAsB;AAGtB,0EAAgD;AAEhD,qDAA6E;AAE7E,MAAM,GAAG,GAAG,IAAI,aAAG,EAAE,CAAC;AAEtB,GAAG,CAAC,UAAU,CAAC;IACb,OAAO,EAAE,cAAc;IACvB,OAAO,EAAE,CAAC,MAAW,EAAE,EAAE;QACvB,IAAI,YAAkC,CAAC;QACvC,6DAA6D;QAC7D,IAAI,MAAM,KAAK,YAAY,EAAE,CAAC;YAC5B,YAAY,GAAG,CAAC,IAAS,EAAE,EAAE;gBAC3B,IAAI,OAAO,IAAI,IAAI,QAAQ;oBAAE,OAAO,KAAK,CAAC;gBAC1C,IAAI,CAAC,IAAA,kCAAiB,EAAC,IAAI,CAAC,EAAE,CAAC;oBAC7B,YAAY,CAAC,MAAM,GAAG;wBACpB;4BACE,OAAO,EAAE,QAAQ;4BACjB,OAAO,EACL,0GAA0G;yBAC7G;qBACF,CAAC;oBACF,OAAO,KAAK,CAAC;gBACf,CAAC;gBACD,IAAI,IAAA,uCAAsB,EAAC,IAAI,CAAC,EAAE,CAAC;oBACjC,YAAY,CAAC,MAAM,GAAG;wBACpB;4BACE,OAAO,EAAE,QAAQ;4BACjB,OAAO,EAAE,yCAAyC;yBACnD;qBACF,CAAC;oBACF,OAAO,KAAK,CAAC;gBACf,CAAC;gBACD,OAAO,IAAI,CAAC;YACd,CAAC,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,yBAAyB,MAAM,EAAE,CAAC,CAAC;QACrD,CAAC;QACD,OAAO,YAAY,CAAC;IACtB,CAAC;IACD,MAAM,EAAE,IAAI;CACb,CAAC,CAAC;AAEH,MAAM,eAAe,GAAW;IAC9B,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,EAAE,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QACtB,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QACxB,WAAW,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC/B,aAAa,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QACjC,UAAU,EAAE;YACV,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACL,IAAI,EAAE,wBAAwB;aAC/B;SACF;QACD,MAAM,EAAE;YACN,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACL,IAAI,EAAE,4BAA4B;aACnC;SACF;QACD,cAAc,EAAE;YACd,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE;gBACV,cAAc,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;gBAClC,WAAW,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;aAChC;YACD,oBAAoB,EAAE,KAAK;YAC3B,QAAQ,EAAE,CAAC,gBAAgB,EAAE,aAAa,CAAC;SAC5C;KACF;IACD,QAAQ,EAAE;QACR,IAAI;QACJ,MAAM;QACN,aAAa;QACb,eAAe;QACf,YAAY;QACZ,QAAQ;KACT;IACD,oBAAoB,EAAE,KAAK;IAC3B,WAAW,EAAE;QACX,QAAQ,EAAE;YACR,UAAU,EAAE;gBACV,IAAI,EAAE,EAAE,IAAI,EAAE,0BAA0B,EAAE;gBAC1C,QAAQ,EAAE,EAAE,IAAI,EAAE,CAAC,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,KAAK,CAAC,EAAE;gBAC1D,sBAAsB,EAAE;oBACtB,IAAI,EAAE,QAAQ;oBACd,UAAU,EAAE;wBACV,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;wBACzB,WAAW,EAAE,EAAE,IAAI,EAAE,CAAC,MAAM,EAAE,SAAS,EAAE,QAAQ,CAAC,EAAE;wBACpD,YAAY,EAAE;4BACZ,KAAK,EAAE;gCACL;oCACE,IAAI,EAAE,QAAQ;iCACf;gCACD;oCACE,IAAI,EAAE,SAAS;iCAChB;gCACD;oCACE,IAAI,EAAE,QAAQ;iCACf;6BACF;yBACF;wBACD,WAAW,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;wBAC/B,WAAW,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;wBAC/B,YAAY,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;qBACjC;oBACD,QAAQ,EAAE,CAAC,aAAa,EAAE,OAAO,CAAC;oBAClC,oBAAoB,EAAE,KAAK;iBAC5B;gBACD,WAAW,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;gBAC/B,oBAAoB,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;gBACzC,oBAAoB,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;aAC1C;YACD,IAAI,EAAE,QAAQ;YACd,oBAAoB,EAAE,KAAK;YAC3B,QAAQ,EAAE,CAAC,MAAM,EAAE,UAAU,CAAC;SAC/B;QACD,YAAY,EAAE;YACZ,UAAU,EAAE;gBACV,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;gBACzB,IAAI,EAAE,EAAE,IAAI,EAAE,0BAA0B,EAAE;aAC3C;YACD,IAAI,EAAE,QAAQ;YACd,oBAAoB,EAAE,KAAK;YAC3B,QAAQ,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC;SAC5B;QACD,UAAU,EAAE;YACV,IAAI,EAAE,QAAQ;YACd,YAAY,EAAE,YAAY;SAC3B;KACF;CACF,CAAC;AAEF,MAAM,QAAQ,GAAG,GAAG,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;AAE9C,SAAgB,wBAAwB,CAAC,IAAS;IAIhD,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC7B,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAO;YACL,KAAK,EAAE,KAAK;YACZ,OAAO,EAAE,IAAA,2BAAe,EAAC,eAAe,EAAE,IAAI,EAAE,QAAQ,CAAC,MAAa,EAAE;gBACtE,MAAM,EAAE,CAAC;aACV,CAAC;SACH,CAAC;IACJ,CAAC;IACD,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;AACzB,CAAC"}