formeo 2.3.1 → 3.0.1

package/dist/formeo.es.js

@@ -1,7 +1,7 @@
 
 /**
 formeo - https://formeo.io
-Version: 2.3.0
+Version: 3.0.0
 Author: Draggable https://draggable.io
 */
 
@@ -434,7 +434,7 @@ if (window !== void 0) {
   window.SmartTooltip = SmartTooltip;
 }
 const name$1 = "formeo";
-const version$2 = "2.3.0";
+const version$2 = "3.0.0";
 const type = "module";
 const main = "dist/formeo.cjs.js";
 const module = "dist/formeo.es.js";
@@ -501,6 +501,7 @@ const scripts = {
   "build:lib": "vite build --config vite.config.lib.mjs",
   build: "npm-run-all -p build:icons build:demo",
   prebuild: "npm run build:lib",
+  postbuild: "npm run generate:jsonSchema",
   "build:demo": "vite build --mode demo",
   "build:demo:watch": "vite build --mode demo --watch",
   "build:icons": "node ./tools/generate-sprite",
@@ -515,7 +516,8 @@ const scripts = {
   "travis-deploy-once": "travis-deploy-once --pro",
   prepush: "npm test",
   prepare: "lefthook install",
-  postmerge: "lefthook install"
+  postmerge: "lefthook install",
+  "generate:jsonSchema": "node --experimental-strip-types --no-warnings ./tools/generate-json-schema.ts"
 };
 const devDependencies = {
   "@biomejs/biome": "^1.9.3",
@@ -526,7 +528,7 @@ const devDependencies = {
   "@semantic-release/npm": "^12.0.1",
   jsdom: "^25.0.1",
   lefthook: "^1.7.18",
-  "npm-run-all": "^4.1.5",
+  "npm-run-all": "^2.1.0",
   "sass-embedded": "^1.80.1",
   "semantic-release": "^24.1.2",
   "svg-sprite": "^2.0.4",
@@ -534,7 +536,9 @@ const devDependencies = {
   "vite-plugin-banner": "^0.8.0",
   "vite-plugin-compression": "^0.5.1",
   "vite-plugin-html": "^3.2.2",
-  "vite-plugin-static-copy": "^2.0.0"
+  "vite-plugin-static-copy": "^2.0.0",
+  zod: "^3.23.8",
+  "zod-to-json-schema": "^3.23.5"
 };
 const dependencies = {
   "@draggable/formeo-languages": "^3.1.3",
@@ -2658,6 +2662,25 @@ class Data {
     });
     __publicField(this, "setCallbacks", {});
     __publicField(this, "configVal", /* @__PURE__ */ Object.create(null));
+    /**
+     * Parses the provided data argument. If the argument is a string, it attempts to parse it as JSON.
+     * If the parsing fails, it logs an error and returns an empty object.
+     * If the argument is not a string, it returns the argument as is.
+     *
+     * @param {string|Object} dataArg - The data to be parsed. Can be a JSON string or an object.
+     * @returns {Object} - The parsed object or the original object if the input was not a string.
+     */
+    __publicField(this, "parseformData", (dataArg = /* @__PURE__ */ Object.create(null)) => {
+      if (typeof dataArg === "string") {
+        try {
+          return JSON.parse(dataArg);
+        } catch (e) {
+          console.error("Invalid JSON string provided:", e);
+          return /* @__PURE__ */ Object.create(null);
+        }
+      }
+      return dataArg;
+    });
     this.name = name2;
     this.data = data;
     this.dataPath = "";
@@ -5242,10 +5265,10 @@ const labelCount = (arr, label) => {
   return count > 1 ? `(${count})` : "";
 };
 const getComponentLabel = ({ name: name2, id, ...component }) => {
-  const labelPaths = ["config.label", "attrs.id", "meta.id"];
+  const labelPaths = ["config.label", "config.controlId", "meta.id", "attrs.id"];
   const label = labelPaths.reduce((acc, cur) => {
     if (!acc) {
-      acc = component.get(cur);
+      return component.get(cur);
     }
     return acc;
   }, null);
@@ -6002,7 +6025,8 @@ class EditPanel {
      * @param {String} attr
      * @param {String|Array} val
      */
-    __publicField(this, "addAttribute", (attr, val) => {
+    __publicField(this, "addAttribute", (attr, valArg) => {
+      let val = valArg;
       const safeAttr = slugify(attr);
       const itemKey = `attrs.${safeAttr}`;
       if (!mi18n.current[itemKey]) {
@@ -6025,15 +6049,15 @@ class EditPanel {
      * Add option to options panel
      */
     __publicField(this, "addOption", () => {
-      const metaId = this.field.data.meta.id;
+      const controlId = this.field.data.config.controlId;
       const fieldOptionData = this.field.get("options");
-      const type2 = metaId === "select" ? "option" : metaId;
+      const type2 = controlId === "select" ? "option" : controlId;
       const newOptionLabel = mi18n.get("newOptionLabel", { type: type2 }) || "New Option";
       const itemKey = `options.${this.data.length}`;
       const lastOptionData = fieldOptionData[fieldOptionData.length - 1];
       const optionTemplate = fieldOptionData.length ? lastOptionData : {};
       const itemData = { ...optionTemplate, label: newOptionLabel };
-      if (metaId !== "button") {
+      if (controlId !== "button") {
         itemData.value = slugify(newOptionLabel);
       }
       const newOption = new EditPanelItem({
@@ -6547,6 +6571,7 @@ class Component extends Data {
   }
   /**
    * Method for handling onAdd for all components
+   * @todo improve readability of this method
    * @param  {Object} evt
    * @return {Object} Component
    */
@@ -6588,10 +6613,13 @@ class Component extends Data {
     ]);
     const onAddConditions = {
       controls: () => {
-        const { controlData } = Controls$2.get(item.id);
         const {
-          meta: { id: metaId }
-        } = controlData;
+          controlData: {
+            meta: { id: metaId },
+            ...elementData
+          }
+        } = Controls$2.get(item.id);
+        set(elementData, "config.controlId", metaId);
         const controlType = metaId.startsWith("layout-") ? metaId.replace(/^layout-/, "") : "field";
         const targets = {
           stage: {
@@ -6614,7 +6642,7 @@ class Component extends Data {
         const depth = get(targets, `${this.name}.${controlType}`);
         const action = depthMap.get(depth)();
         dom.remove(item);
-        const component2 = action(controlData, newIndex2);
+        const component2 = action(elementData, newIndex2);
         return component2;
       },
       row: () => {
@@ -6664,10 +6692,23 @@ class Component extends Data {
     }
     events2.onRender && dom.onRender(this.dom, events2.onRender);
   }
+  /**
+   * Sets the configuration for the component. See src/demo/js/options/config.js for example
+   * @param {Object} config - Configuration object with possible structures:
+   * @param {Object} [config.all] - Global configuration applied to all components
+   * @param {Object} [config[controlId]] - Configuration specific to a control type
+   * @param {Object} [config[id]] - Configuration specific to a component instance
+   * @description Merges configurations in order of precedence:
+   * 1. Existing config (this.configVal)
+   * 2. Global config (all)
+   * 3. Control type specific config
+   * 4. Instance specific config
+   * The merged result is stored in this.configVal
+   */
   set config(config2) {
-    const metaId = get(this.data, "meta.id");
     const allConfig = get(config2, "all");
-    const typeConfig = metaId && get(config2, metaId);
+    const controlId = get(this.data, "config.controlId");
+    const typeConfig = controlId && get(config2, controlId);
     const idConfig = get(config2, this.id);
     const mergedConfig = [allConfig, typeConfig, idConfig].reduce(
       (acc, cur) => cur ? merge(acc, cur) : acc,
@@ -6834,7 +6875,7 @@ class Field extends Component {
   get labelConfig() {
     const hideLabel = !!this.get("config.hideLabel");
     if (hideLabel) {
-      return;
+      return null;
     }
     const labelVal = this.get("config.editorLabel") || this.get("config.label");
     const required = this.get("attrs.required");
@@ -6986,7 +7027,7 @@ class Field extends Component {
   fieldPreview() {
     var _a;
     const prevData = clone$1(this.data);
-    const { action = {} } = Controls$2.get(prevData.meta.id);
+    const { action = {} } = Controls$2.get(prevData.config.controlId);
     prevData.id = `prev-${this.id}`;
     prevData.action = action;
     if ((_a = this.data) == null ? void 0 : _a.config.editableContent) {
@@ -7438,7 +7479,7 @@ class ButtonControl extends Control {
       options: [
         {
           label: mi18n.get("button"),
-          type: ["button", "submit", "reset"].map((buttonType, index2) => ({
+          type: ["button", "submit", "reset"].map((buttonType) => ({
             label: buttonType,
             type: buttonType
           })),
@@ -7669,21 +7710,25 @@ const defaultElements = [...formControls, ...htmlControls, ...layoutControls];
 let Controls$1 = class Controls {
   constructor() {
     __publicField(this, "groupLabel", (key) => mi18n.get(key) || key || "");
+    __publicField(this, "layoutTypes", {
+      row: () => Stages2.active.addChild(),
+      column: () => this.layoutTypes.row().addChild(),
+      field: (controlData) => this.layoutTypes.column().addChild(controlData)
+    });
     /**
      * Append an element to the stage
      * @param {String} id of elements
      */
     __publicField(this, "addElement", (id) => {
-      const controlData = get(this.get(id), "controlData");
       const {
-        meta: { group, id: metaId }
-      } = controlData;
-      const layoutTypes = {
-        row: () => Stages2.active.addChild(),
-        column: () => layoutTypes.row().addChild(),
-        field: (controlData2) => layoutTypes.column().addChild(controlData2)
-      };
-      return group !== "layout" ? layoutTypes.field(controlData) : layoutTypes[metaId.replace("layout-", "")]();
+        meta: { group, id: metaId },
+        ...elementData
+      } = get(this.get(id), "controlData");
+      set(elementData, "config.controlId", metaId);
+      if (group === "layout") {
+        return this.layoutTypes[metaId.replace("layout-", "")]();
+      }
+      return this.layoutTypes.field(elementData);
     });
     __publicField(this, "applyOptions", async (controlOptions = {}) => {
       const { container, elements, groupOrder, ...options } = merge(defaultOptions, controlOptions);
@@ -7763,16 +7808,16 @@ let Controls$1 = class Controls {
       elements = orderObjectsBy(elements, group.elementOrder, "meta.id");
       groupConfig.content = elements.filter((control) => {
         const { controlData: field } = this.get(control.id);
-        const fieldId = field.meta.id || "";
+        const controlId = field.meta.id || "";
         const filters = [
-          match(fieldId, this.options.disable.elements),
+          match(controlId, this.options.disable.elements),
           field.meta.group === group.id,
-          !usedElementIds.includes(field.meta.id)
+          !usedElementIds.includes(controlId)
         ];
         let shouldFilter = true;
         shouldFilter = filters.every((val) => val === true);
         if (shouldFilter) {
-          usedElementIds.push(fieldId);
+          usedElementIds.push(controlId);
         }
         return shouldFilter;
       });
@@ -7966,15 +8011,28 @@ const Controls$2 = new Controls$1();
 class ComponentData extends Data {
   constructor() {
     super(...arguments);
-    __publicField(this, "load", (data = /* @__PURE__ */ Object.create(null)) => {
+    __publicField(this, "load", (dataArg) => {
+      const data = this.parseformData(dataArg);
       this.empty();
-      if (typeof data === "string") {
-        data = JSON.parse(data);
+      for (const [key, val] of Object.entries(data)) {
+        this.add(key, val);
       }
-      Object.entries(data).forEach(([key, val]) => this.add(key, val));
       return this.data;
     });
+    /**
+     * Retrieves data from the specified path or adds new data if no path is provided.
+     *
+     * @param {string} [path] - The path to retrieve data from. If not provided, new data will be added.
+     * @returns {*} The data retrieved from the specified path or the result of adding new data.
+     */
     __publicField(this, "get", (path) => path ? get(this.data, path) : this.add());
+    /**
+     * Adds a new component with the given id and data.
+     *
+     * @param {string} id - The unique identifier for the component. If not provided, a new UUID will be generated.
+     * @param {Object} [data=Object.create(null)] - The data to initialize the component with.
+     * @returns {Object} The newly created component.
+     */
     __publicField(this, "add", (id, data = /* @__PURE__ */ Object.create(null)) => {
       const elemId = id || uuid();
       const component = this.Component({ ...data, id: elemId });
@@ -7988,14 +8046,20 @@ class ComponentData extends Data {
      */
     __publicField(this, "remove", (componentId) => {
       if (Array.isArray(componentId)) {
-        componentId.forEach((id) => {
+        for (const id of componentId) {
           this.get(id).remove();
-        });
+        }
       } else {
         this.get(componentId).remove();
       }
       return this.data;
     });
+    /**
+     * Deletes a component from the data object.
+     *
+     * @param {string} componentId - The ID of the component to delete.
+     * @returns {string} The ID of the deleted component.
+     */
     __publicField(this, "delete", (componentId) => {
       delete this.data[componentId];
       return componentId;
@@ -8575,16 +8639,24 @@ class Column extends Component {
         field.panels.nav.refresh();
       }
     });
+    /**
+     * Sets the width data and style for the column
+     * @param {string} width - The width value to be set for the column
+     * @returns {void}
+     */
+    __publicField(this, "setDomWidth", (width) => {
+      this.dom.dataset.colWidth = width;
+      this.dom.style.width = width;
+    });
     /**
      * Sets a columns width
      * @param {String} width percent or pixel
      */
     __publicField(this, "setWidth", (width) => {
-      this.dom.dataset.colWidth = width;
-      this.dom.style.width = width;
+      this.setDomWidth(width);
       return this.set("config.width", width);
     });
-    const children = this.createChildWrap();
+    const childWrap = this.createChildWrap();
     this.dom = dom.create({
       tag: "li",
       className: [COLUMN_CLASSNAME, "empty"],
@@ -8597,17 +8669,17 @@ class Column extends Component {
         this.getActionButtons(),
         DOM_CONFIGS.editWindow(),
         DOM_CONFIGS.resizeHandle(new ResizeColumn()),
-        children
+        childWrap
       ]
     });
-    this.processConfig(this.dom);
+    this.processConfig();
     events.columnResized = new window.CustomEvent("columnResized", {
       detail: {
         column: this.dom,
         instance: this
       }
     });
-    Sortable.create(children, {
+    Sortable.create(childWrap, {
       animation: 150,
       fallbackClass: "field-moving",
       forceFallback: true,
@@ -8636,11 +8708,10 @@ class Column extends Component {
    * Process column configuration data
    * @param  {Object} column
    */
-  processConfig(column) {
+  processConfig() {
     const columnWidth = helpers.get(this.data, "config.width");
     if (columnWidth) {
-      column.dataset.colWidth = columnWidth;
-      column.style.width = columnWidth;
+      this.setDomWidth(columnWidth);
     }
   }
 }
@@ -8691,6 +8762,35 @@ let Fields$1 = class Fields extends ComponentData {
       }
       return found;
     });
+    __publicField(this, "getData", () => {
+      return Object.entries(this.data).reduce((acc, [key, val]) => {
+        const { conditions, ...data } = (val == null ? void 0 : val.getData()) || val;
+        if (conditions == null ? void 0 : conditions.length) {
+          let hasConditions = true;
+          if (conditions.length === 1) {
+            const [firstCondition] = conditions;
+            hasConditions = Boolean(firstCondition.if[0].source && firstCondition.then[0].target);
+          }
+          if (hasConditions) {
+            data.conditions = conditions;
+          }
+        }
+        acc[key] = data;
+        return acc;
+      }, {});
+    });
+    __publicField(this, "load", (dataArg = /* @__PURE__ */ Object.create(null)) => {
+      const allFieldData = this.parseformData(dataArg);
+      this.empty();
+      for (const [key, val] of Object.entries(allFieldData)) {
+        const { meta, ...data } = val;
+        if (meta == null ? void 0 : meta.id) {
+          set(data, "config.controlId", meta == null ? void 0 : meta.id);
+        }
+        this.add(key, data);
+      }
+      return this.data;
+    });
     this.config = { all: DEFAULT_CONFIG };
   }
   Component(data) {
@@ -8769,7 +8869,10 @@ class Components extends Data {
     }, acculumator);
   }
   get json() {
-    return window.JSON.stringify(this.formData);
+    return window.JSON.stringify({
+      $schema: `https://cdn.jsdelivr.net/npm/formeo@${version$1}/dist/formData_schema.json`,
+      ...this.formData
+    });
   }
   get formData() {
     return {
@@ -9826,51 +9929,59 @@ let FormeoRenderer$1 = class FormeoRenderer {
         (column) => this.cacheComponent(this.processColumn(column))
       );
     });
-    __publicField(this, "processFieldsOrig", (fieldIds) => {
-      return this.orderChildren("fields", fieldIds).map(
-        ({ id, ...field }) => this.cacheComponent(Object.assign({}, field, { id: this.prefixId(id) }))
-      );
-    });
-    __publicField(this, "processFields", (fieldIds) => {
-      return this.orderChildren("fields", fieldIds).map(({ id, ...field }) => {
-        const { action = {}, dependencies: dependencies2 = {} } = this.elements[field.meta.id] || {};
-        if (dependencies2) {
-          fetchDependencies(dependencies2);
-        }
-        const mergedFieldData = merge({ action }, field);
-        return this.cacheComponent({ ...mergedFieldData, id: this.prefixId(id) });
-      });
-    });
+    __publicField(this, "processFields", (fieldIds) => this.orderChildren("fields", fieldIds).map(({ id, ...field }) => {
+      var _a, _b;
+      const controlId = ((_a = field.config) == null ? void 0 : _a.controlId) || ((_b = field.meta) == null ? void 0 : _b.id);
+      const { action = {}, dependencies: dependencies2 = {} } = this.elements[controlId] || {};
+      if (dependencies2) {
+        fetchDependencies(dependencies2);
+      }
+      const mergedFieldData = merge({ action }, field);
+      return this.cacheComponent({ ...mergedFieldData, id: this.prefixId(id) });
+    }));
     /**
      * Evaulate and execute conditions for fields by creating listeners for input and changes
      * @return {Array} flattened array of conditions
      */
+    __publicField(this, "handleComponentCondition", (component, ifRest, thenConditions) => {
+      const listenerEvent = LISTEN_TYPE_MAP(component);
+      if (listenerEvent) {
+        component.addEventListener(
+          listenerEvent,
+          (evt) => {
+            if (this.evaluateCondition(ifRest, evt)) {
+              for (const thenCondition of thenConditions) {
+                this.execResult(thenCondition, evt);
+              }
+            }
+          },
+          false
+        );
+      }
+      const fakeEvt = { target: component };
+      if (this.evaluateCondition(ifRest, fakeEvt)) {
+        for (const thenCondition of thenConditions) {
+          this.execResult(thenCondition, fakeEvt);
+        }
+      }
+    });
     __publicField(this, "applyConditions", () => {
-      Object.values(this.components).forEach(({ conditions }) => {
+      for (const { conditions } of Object.values(this.components)) {
         if (conditions) {
-          conditions.forEach((condition, i) => {
+          for (const condition of conditions) {
             const { if: ifConditions, then: thenConditions } = condition;
-            ifConditions.forEach((ifCondition) => {
+            for (const ifCondition of ifConditions) {
               const { source, ...ifRest } = ifCondition;
               if (isAddress(source)) {
                 const components2 = this.getComponents(source);
-                components2.forEach((component) => {
-                  const listenerEvent = LISTEN_TYPE_MAP(component);
-                  if (listenerEvent) {
-                    component.addEventListener(
-                      listenerEvent,
-                      (evt) => this.evaluateCondition(ifRest, evt) && thenConditions.forEach((thenCondition) => this.execResult(thenCondition, evt)),
-                      false
-                    );
-                  }
-                  const fakeEvt = { target: component };
-                  this.evaluateCondition(ifRest, fakeEvt) && thenConditions.forEach((thenCondition) => this.execResult(thenCondition, fakeEvt));
-                });
+                for (const component of components2) {
+                  this.handleComponentCondition(component, ifRest, thenConditions);
+                }
               }
-            });
-          });
+            }
+          }
         }
-      });
+      }
     });
     /**
      * Evaulate conditions