@bpmn-io/form-js-viewer 0.5.1 → 0.7.1

package/dist/index.es.js

@@ -1,5 +1,5 @@
 import Ids from 'ids';
-import { isArray, isFunction, isNumber, bind, assign, get, set, isString } from 'min-dash';
+import { isArray, isFunction, isNumber, bind, assign, isNil, get, isUndefined, set, isString } from 'min-dash';
 import snarkdown from '@bpmn-io/snarkdown';
 import { jsx, jsxs } from 'preact/jsx-runtime';
 import { useContext, useState, useCallback } from 'preact/hooks';
@@ -8,109 +8,6 @@ import Markup from 'preact-markup';
 import { createPortal } from 'preact/compat';
 import { Injector } from 'didi';
 
-function createInjector(bootstrapModules) {
-  const modules = [],
-        components = [];
-
-  function hasModule(module) {
-    return modules.includes(module);
-  }
-
-  function addModule(module) {
-    modules.push(module);
-  }
-
-  function visit(module) {
-    if (hasModule(module)) {
-      return;
-    }
-
-    (module.__depends__ || []).forEach(visit);
-
-    if (hasModule(module)) {
-      return;
-    }
-
-    addModule(module);
-    (module.__init__ || []).forEach(function (component) {
-      components.push(component);
-    });
-  }
-
-  bootstrapModules.forEach(visit);
-  const injector = new Injector(modules);
-  components.forEach(function (component) {
-    try {
-      injector[typeof component === 'string' ? 'get' : 'invoke'](component);
-    } catch (err) {
-      console.error('Failed to instantiate component');
-      console.error(err.stack);
-      throw err;
-    }
-  });
-  return injector;
-}
-
-/**
- * @param {string?} prefix
- *
- * @returns Element
- */
-function createFormContainer(prefix = 'fjs') {
-  const container = document.createElement('div');
-  container.classList.add(`${prefix}-container`);
-  return container;
-}
-
-function findErrors(errors, path) {
-  return errors[pathStringify(path)];
-}
-function isRequired(field) {
-  return field.required;
-}
-function pathParse(path) {
-  if (!path) {
-    return [];
-  }
-
-  return path.split('.').map(key => {
-    return isNaN(parseInt(key)) ? key : parseInt(key);
-  });
-}
-function pathsEqual(a, b) {
-  return a && b && a.length === b.length && a.every((value, index) => value === b[index]);
-}
-function pathStringify(path) {
-  if (!path) {
-    return '';
-  }
-
-  return path.join('.');
-}
-const indices = {};
-function generateIndexForType(type) {
-  if (type in indices) {
-    indices[type]++;
-  } else {
-    indices[type] = 1;
-  }
-
-  return indices[type];
-}
-function generateIdForType(type) {
-  return `${type}${generateIndexForType(type)}`;
-}
-/**
- * @template T
- * @param {T} data
- * @param {(this: any, key: string, value: any) => any} [replacer]
- * @return {T}
- */
-
-function clone(data, replacer) {
-  return JSON.parse(JSON.stringify(data, replacer));
-}
-
 var FN_REF = '__fn';
 var DEFAULT_PRIORITY = 1000;
 var slice = Array.prototype.slice;
@@ -600,7 +497,7 @@ class Validator {
       errors = [...errors, `Field must match pattern ${validate.pattern}.`];
     }
 
-    if (validate.required && (typeof value === 'undefined' || value === '')) {
+    if (validate.required && (isNil(value) || value === '')) {
       errors = [...errors, 'Field is required.'];
     }
 
@@ -624,6 +521,7 @@ class Validator {
   }
 
 }
+Validator.$inject = [];
 
 class FormFieldRegistry {
   constructor(eventBus) {
@@ -689,6 +587,109 @@ class FormFieldRegistry {
 }
 FormFieldRegistry.$inject = ['eventBus'];
 
+function createInjector(bootstrapModules) {
+  const modules = [],
+        components = [];
+
+  function hasModule(module) {
+    return modules.includes(module);
+  }
+
+  function addModule(module) {
+    modules.push(module);
+  }
+
+  function visit(module) {
+    if (hasModule(module)) {
+      return;
+    }
+
+    (module.__depends__ || []).forEach(visit);
+
+    if (hasModule(module)) {
+      return;
+    }
+
+    addModule(module);
+    (module.__init__ || []).forEach(function (component) {
+      components.push(component);
+    });
+  }
+
+  bootstrapModules.forEach(visit);
+  const injector = new Injector(modules);
+  components.forEach(function (component) {
+    try {
+      injector[typeof component === 'string' ? 'get' : 'invoke'](component);
+    } catch (err) {
+      console.error('Failed to instantiate component');
+      console.error(err.stack);
+      throw err;
+    }
+  });
+  return injector;
+}
+
+/**
+ * @param {string?} prefix
+ *
+ * @returns Element
+ */
+function createFormContainer(prefix = 'fjs') {
+  const container = document.createElement('div');
+  container.classList.add(`${prefix}-container`);
+  return container;
+}
+
+function findErrors(errors, path) {
+  return errors[pathStringify(path)];
+}
+function isRequired(field) {
+  return field.required;
+}
+function pathParse(path) {
+  if (!path) {
+    return [];
+  }
+
+  return path.split('.').map(key => {
+    return isNaN(parseInt(key)) ? key : parseInt(key);
+  });
+}
+function pathsEqual(a, b) {
+  return a && b && a.length === b.length && a.every((value, index) => value === b[index]);
+}
+function pathStringify(path) {
+  if (!path) {
+    return '';
+  }
+
+  return path.join('.');
+}
+const indices = {};
+function generateIndexForType(type) {
+  if (type in indices) {
+    indices[type]++;
+  } else {
+    indices[type] = 1;
+  }
+
+  return indices[type];
+}
+function generateIdForType(type) {
+  return `${type}${generateIndexForType(type)}`;
+}
+/**
+ * @template T
+ * @param {T} data
+ * @param {(this: any, key: string, value: any) => any} [replacer]
+ * @return {T}
+ */
+
+function clone(data, replacer) {
+  return JSON.parse(JSON.stringify(data, replacer));
+}
+
 class Importer {
   /**
    * @constructor
@@ -716,8 +717,8 @@ class Importer {
     const warnings = [];
 
     try {
-      const importedData = clone(data);
-      const importedSchema = this.importFormField(clone(schema), importedData);
+      const importedSchema = this.importFormField(clone(schema)),
+            importedData = this.importData(clone(data));
       return {
         warnings,
         schema: importedSchema,
@@ -730,14 +731,13 @@ class Importer {
   }
   /**
    * @param {any} formField
-   * @param {Object} [data]
    * @param {string} [parentId]
    *
-   * @return {any} field
+   * @return {any} importedField
    */
 
 
-  importFormField(formField, data = {}, parentId) {
+  importFormField(formField, parentId) {
     const {
       components,
       key,
@@ -760,10 +760,13 @@ class Importer {
         throw new Error(`form field with key <${key}> already exists`);
       }
 
-      this._formFieldRegistry._keys.claim(key, formField); // set form field path
+      this._formFieldRegistry._keys.claim(key, formField); // TODO: buttons should not have key
 
 
-      formField._path = [key];
+      if (type !== 'button') {
+        // set form field path
+        formField._path = [key];
+      }
     }
 
     if (id) {
@@ -781,17 +784,44 @@ class Importer {
     this._formFieldRegistry.add(formField);
 
     if (components) {
-      this.importFormFields(components, data, id);
+      this.importFormFields(components, id);
     }
 
     return formField;
   }
 
-  importFormFields(components, data = {}, parentId) {
+  importFormFields(components, parentId) {
     components.forEach(component => {
-      this.importFormField(component, data, parentId);
+      this.importFormField(component, parentId);
     });
   }
+  /**
+   * @param {Object} data
+   *
+   * @return {Object} importedData
+   */
+
+
+  importData(data) {
+    return this._formFieldRegistry.getAll().reduce((importedData, formField) => {
+      const {
+        defaultValue,
+        _path,
+        type
+      } = formField;
+
+      if (!_path) {
+        return importedData;
+      } // (1) try to get value from data
+      // (2) try to get default value from form field
+      // (3) get empty value from form field
+
+
+      return { ...importedData,
+        [_path[0]]: get(data, _path, isUndefined(defaultValue) ? this._formFields.get(type).emptyValue : defaultValue)
+      };
+    }, {});
+  }
 
 }
 Importer.$inject = ['formFieldRegistry', 'formFields'];
@@ -1115,6 +1145,7 @@ Checkbox.create = function (options = {}) {
 Checkbox.type = type$5;
 Checkbox.label = 'Checkbox';
 Checkbox.keyed = true;
+Checkbox.emptyValue = false;
 
 function useService (type, strict) {
   const {
@@ -1355,7 +1386,7 @@ function Number(props) {
     const parsedValue = parseInt(target.value, 10);
     props.onChange({
       field,
-      value: isNaN(parsedValue) ? undefined : parsedValue
+      value: isNaN(parsedValue) ? null : parsedValue
     });
   };
 
@@ -1391,6 +1422,7 @@ Number.create = function (options = {}) {
 Number.type = type$4;
 Number.keyed = true;
 Number.label = 'Number';
+Number.emptyValue = null;
 
 const type$3 = 'radio';
 function Radio(props) {
@@ -1439,7 +1471,7 @@ function Radio(props) {
           type: "radio",
           onClick: () => onChange(v.value)
         })
-      }, v.value);
+      }, `${id}-${index}`);
     }), jsx(Description, {
       description: description
     }), jsx(Errors, {
@@ -1461,6 +1493,7 @@ Radio.create = function (options = {}) {
 Radio.type = type$3;
 Radio.label = 'Radio';
 Radio.keyed = true;
+Radio.emptyValue = null;
 
 const type$2 = 'select';
 function Select(props) {
@@ -1486,7 +1519,7 @@ function Select(props) {
   }) => {
     props.onChange({
       field,
-      value: target.value === '' ? undefined : target.value
+      value: target.value === '' ? null : target.value
     });
   };
 
@@ -1507,11 +1540,11 @@ function Select(props) {
       value: value || '',
       children: [jsx("option", {
         value: ""
-      }), values.map(v => {
+      }), values.map((v, index) => {
         return jsx("option", {
           value: v.value,
           children: v.label
-        }, v.value);
+        }, `${id}-${index}`);
       })]
     }), jsx(Description, {
       description: description
@@ -1534,6 +1567,7 @@ Select.create = function (options = {}) {
 Select.type = type$2;
 Select.label = 'Select';
 Select.keyed = true;
+Select.emptyValue = null;
 
 const type$1 = 'text';
 function Text(props) {
@@ -1621,6 +1655,7 @@ Textfield.create = function (options = {}) {
 Textfield.type = type;
 Textfield.label = 'Text Field';
 Textfield.keyed = true;
+Textfield.emptyValue = '';
 
 const formFields = [Button, Checkbox, Default, Number, Radio, Select, Text, Textfield];
 
@@ -1731,6 +1766,10 @@ var core = {
  *   properties: FormProperties,
  *   schema: Schema
  * } } State
+ *
+ * @typedef { (type:FormEvent, priority:number, handler:Function) => void } OnEventWithPriority
+ * @typedef { (type:FormEvent, handler:Function) => void } OnEventWithOutPriority
+ * @typedef { OnEventWithPriority & OnEventWithOutPriority } OnEventType
  */
 
 const ids = new Ids([32, 36, 1]);
@@ -1744,10 +1783,16 @@ class Form {
    * @param {FormOptions} options
    */
   constructor(options = {}) {
+    /**
+     * @public
+     * @type {OnEventType}
+     */
+    this.on = this._onEvent;
     /**
      * @public
      * @type {String}
      */
+
     this._id = ids.next();
     /**
      * @private
@@ -1862,21 +1907,22 @@ class Form {
       throw new Error('form is read-only');
     }
 
-    const formFieldRegistry = this.get('formFieldRegistry'); // do not submit disabled form fields
-
+    const formFieldRegistry = this.get('formFieldRegistry');
     const data = formFieldRegistry.getAll().reduce((data, field) => {
       const {
         disabled,
         _path
-      } = field;
+      } = field; // do not submit disabled form fields
 
-      if (disabled) {
-        // strip disabled field value
-        set(data, _path, undefined);
+      if (disabled || !_path) {
+        return data;
       }
 
-      return data;
-    }, clone(this._getState().data));
+      const value = get(this._getState().data, _path);
+      return { ...data,
+        [_path[0]]: value
+      };
+    }, {});
     const errors = this.validate();
 
     this._emit('submit', {
@@ -1993,16 +2039,6 @@ class Form {
       properties
     });
   }
-  /**
-   * @param {FormEvent} type
-   * @param {number} priority
-   * @param {Function} handler
-   */
-
-
-  on(type, priority, handler) {
-    this.get('eventBus').on(type, priority, handler);
-  }
   /**
    * @param {FormEvent} type
    * @param {Function} handler
@@ -2097,10 +2133,18 @@ class Form {
 
     this._emit('changed', this._getState());
   }
+  /**
+   * @internal
+   */
+
+
+  _onEvent(type, priority, handler) {
+    this.get('eventBus').on(type, priority, handler);
+  }
 
 }
 
-const schemaVersion = 2;
+const schemaVersion = 4;
 /**
  * @typedef { import('./types').CreateFormOptions } CreateFormOptions
  */