@bpmn-io/form-js-editor 1.8.8 → 1.9.1

package/LICENSE

@@ -1,23 +1,23 @@
-Copyright (c) 2021-present Camunda Services GmbH
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of
-this software and associated documentation files (the "Software"), to deal in the
-Software without restriction, including without limitation the rights to use, copy,
-modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
-and to permit persons to whom the Software is furnished to do so, subject to the
-following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-The source code responsible for displaying the bpmn.io project watermark that
-links back to https://bpmn.io as part of rendered diagrams MUST NOT be
-removed or changed. When this software is being used in a website or application,
-the watermark must stay fully visible and not visually overlapped by other elements.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
-INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
-PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
+Copyright (c) 2021-present Camunda Services GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in the
+Software without restriction, including without limitation the rights to use, copy,
+modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
+and to permit persons to whom the Software is furnished to do so, subject to the
+following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+The source code responsible for displaying the bpmn.io project watermark that
+links back to https://bpmn.io as part of rendered diagrams MUST NOT be
+removed or changed. When this software is being used in a website or application,
+the watermark must stay fully visible and not visually overlapped by other elements.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
+PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
 OR OTHER DEALINGS IN THE SOFTWARE.

package/dist/index.cjs

@@ -9030,83 +9030,64 @@ function hasIntegerPathSegment(path) {
   return path.split('.').some(segment => /^\d+$/.test(segment));
 }
 
-function useService(type, strict) {
+const headerlessTypes = ['spacer', 'separator', 'expression', 'html'];
+function getPropertiesPanelHeaderProvider(options = {}) {
   const {
-    getService
-  } = hooks.useContext(FormPropertiesPanelContext);
-  return getService(type, strict);
-}
-
-/**
- * Retrieve list of variables from the form schema.
- *
- * @returns { string[] } list of variables used in form schema
- */
-function useVariables() {
-  const form = useService('formEditor');
-  const schema = form.getSchema();
-  return formJsViewer.getSchemaVariables(schema);
+    getDocumentationRef,
+    formFields
+  } = options;
+  return {
+    getElementLabel: field => {
+      const {
+        type
+      } = field;
+      if (headerlessTypes.includes(type)) {
+        return '';
+      }
+      if (type === 'text') {
+        return textToLabel(field.text);
+      }
+      if (type === 'image') {
+        return field.alt;
+      }
+      if (type === 'default') {
+        return field.id;
+      }
+      return field.label;
+    },
+    getElementIcon: field => {
+      const {
+        type
+      } = field;
+      const fieldDefinition = formFields.get(type).config;
+      const Icon = fieldDefinition.icon || formJsViewer.iconsByType(type);
+      if (Icon) {
+        return () => jsxRuntime.jsx(Icon, {
+          width: "36",
+          height: "36",
+          viewBox: "0 0 54 54"
+        });
+      } else if (fieldDefinition.iconUrl) {
+        return getPaletteIcon({
+          iconUrl: fieldDefinition.iconUrl,
+          label: fieldDefinition.label
+        });
+      }
+    },
+    getTypeLabel: field => {
+      const {
+        type
+      } = field;
+      if (type === 'default') {
+        return 'Form';
+      }
+      const fieldDefinition = formFields.get(type).config;
+      return fieldDefinition.label || type;
+    },
+    getDocumentationRef
+  };
 }
 
-const headerlessTypes = ['spacer', 'separator', 'expression', 'html'];
-const PropertiesPanelHeaderProvider = {
-  getElementLabel: field => {
-    const {
-      type
-    } = field;
-    if (headerlessTypes.includes(type)) {
-      return '';
-    }
-    if (type === 'text') {
-      return textToLabel(field.text);
-    }
-    if (type === 'image') {
-      return field.alt;
-    }
-    if (type === 'default') {
-      return field.id;
-    }
-    return field.label;
-  },
-  getElementIcon: field => {
-    const {
-      type
-    } = field;
-
-    // @Note: We know that we are inside the properties panel context,
-    // so we can savely use the hook here.
-    // eslint-disable-next-line react-hooks/rules-of-hooks
-    const fieldDefinition = useService('formFields').get(type).config;
-    const Icon = fieldDefinition.icon || formJsViewer.iconsByType(type);
-    if (Icon) {
-      return () => jsxRuntime.jsx(Icon, {
-        width: "36",
-        height: "36",
-        viewBox: "0 0 54 54"
-      });
-    } else if (fieldDefinition.iconUrl) {
-      return getPaletteIcon({
-        iconUrl: fieldDefinition.iconUrl,
-        label: fieldDefinition.label
-      });
-    }
-  },
-  getTypeLabel: field => {
-    const {
-      type
-    } = field;
-    if (type === 'default') {
-      return 'Form';
-    }
-
-    // @Note: We know that we are inside the properties panel context,
-    // so we can savely use the hook here.
-    // eslint-disable-next-line react-hooks/rules-of-hooks
-    const fieldDefinition = useService('formFields').get(type).config;
-    return fieldDefinition.label || type;
-  }
-};
-
 /**
  * Provide placeholders for empty and multiple state.
  */
@@ -9123,6 +9104,7 @@ const PropertiesPanelPlaceholderProvider = {
   }
 };
 
+const EMPTY = {};
 function PropertiesPanel(props) {
   const {
     eventBus,
@@ -9132,7 +9114,7 @@ function PropertiesPanel(props) {
   const formEditor = injector.get('formEditor');
   const modeling = injector.get('modeling');
   const selectionModule = injector.get('selection');
-  const propertiesPanelConfig = injector.get('config.propertiesPanel') || {};
+  const propertiesPanelConfig = injector.get('config.propertiesPanel') || EMPTY;
   const {
     feelPopupContainer
   } = propertiesPanelConfig;
@@ -9186,6 +9168,11 @@ function PropertiesPanel(props) {
       return updater(groups);
     }, []);
   }, [providers, selectedFormField, editField]);
+  const formFields = getService('formFields');
+  const PropertiesPanelHeaderProvider = hooks.useMemo(() => getPropertiesPanelHeaderProvider({
+    getDocumentationRef: propertiesPanelConfig.getDocumentationRef,
+    formFields
+  }), [formFields, propertiesPanelConfig]);
   return jsxRuntime.jsx("div", {
     class: "fjs-properties-panel",
     "data-field": selectedFormField && selectedFormField.id,
@@ -9359,6 +9346,24 @@ function Action(props) {
   });
 }
 
+function useService(type, strict) {
+  const {
+    getService
+  } = hooks.useContext(FormPropertiesPanelContext);
+  return getService(type, strict);
+}
+
+/**
+ * Retrieve list of variables from the form schema.
+ *
+ * @returns { string[] } list of variables used in form schema
+ */
+function useVariables() {
+  const form = useService('formEditor');
+  const schema = form.getSchema();
+  return formJsViewer.getSchemaVariables(schema);
+}
+
 function AltTextEntry(props) {
   const {
     editField,