@bpmn-io/properties-panel 1.4.0 → 1.5.1

package/dist/index.js

@@ -10,6 +10,7 @@ var jsxRuntime = require('../preact/jsx-runtime');
 var minDom = require('min-dom');
 var preact = require('../preact');
 var FeelEditor = require('@bpmn-io/feel-editor');
+var feelers = require('feelers');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
@@ -961,7 +962,7 @@ function ListItem(props) {
   });
 }
 
-const noop$2 = () => {};
+const noop$3 = () => {};
 
 /**
  * @param {import('../PropertiesPanel').ListGroupDefinition} props
@@ -1070,7 +1071,7 @@ function ListGroup(props) {
     ref: groupRef,
     children: [jsxRuntime.jsxs("div", {
       class: classnames__default["default"]('bio-properties-panel-group-header', hasItems ? '' : 'empty', hasItems && open ? 'open' : '', sticky && open ? 'sticky' : ''),
-      onClick: hasItems ? toggleOpen : noop$2,
+      onClick: hasItems ? toggleOpen : noop$3,
       children: [jsxRuntime.jsx("div", {
         title: label,
         class: "bio-properties-panel-group-header-title",
@@ -1251,7 +1252,7 @@ function CheckboxEntry(props) {
     })]
   });
 }
-function isEdited$7(node) {
+function isEdited$8(node) {
   return node && !!node.checked;
 }
 
@@ -1261,7 +1262,7 @@ function prefixId$7(id) {
   return `bio-properties-panel-${id}`;
 }
 
-const useBufferedFocus = function (editor, ref) {
+const useBufferedFocus$1 = function (editor, ref) {
   const [buffer, setBuffer] = hooks.useState(undefined);
   ref.current = hooks.useMemo(() => ({
     focus: offset => {
@@ -1282,7 +1283,7 @@ const useBufferedFocus = function (editor, ref) {
     }
   }, [editor, buffer]);
 };
-const CodeEditor = compat.forwardRef((props, ref) => {
+const CodeEditor$1 = compat.forwardRef((props, ref) => {
   const {
     value,
     onInput,
@@ -1295,7 +1296,7 @@ const CodeEditor = compat.forwardRef((props, ref) => {
   const inputRef = hooks.useRef();
   const [editor, setEditor] = hooks.useState();
   const [localValue, setLocalValue] = hooks.useState(value || '');
-  useBufferedFocus(editor, ref);
+  useBufferedFocus$1(editor, ref);
   const handleInput = useStaticCallback(newValue => {
     onInput(newValue);
     setLocalValue(newValue);
@@ -1377,7 +1378,7 @@ function FeelIndicator(props) {
   });
 }
 
-const noop$1 = () => {};
+const noop$2 = () => {};
 
 /**
  * @param {Object} props
@@ -1390,7 +1391,7 @@ function FeelIcon(props) {
     feel = false,
     active,
     disabled = false,
-    onClick = noop$1
+    onClick = noop$2
   } = props;
   const feelRequiredLabel = ' must be a FEEL expression';
   const feelOptionalLabel = ' can optionally be a FEEL expression';
@@ -1411,7 +1412,7 @@ function FeelIcon(props) {
   });
 }
 
-const noop = () => {};
+const noop$1 = () => {};
 function FeelTextfield(props) {
   const {
     debounce,
@@ -1551,7 +1552,7 @@ function FeelTextfield(props) {
         active: feelActive,
         disabled: feel !== 'optional' || disabled,
         onClick: handleFeelToggle
-      }), feelActive ? jsxRuntime.jsx(CodeEditor, {
+      }), feelActive ? jsxRuntime.jsx(CodeEditor$1, {
         id: prefixId$6(id),
         name: id,
         onInput: handleLocalInput,
@@ -1664,10 +1665,17 @@ const OptionalFeelTextArea = compat.forwardRef((props, ref) => {
  * @param {String} props.description
  * @param {Boolean} props.debounce
  * @param {Boolean} props.disabled
+ * @param {Boolean} props.feel
  * @param {String} props.label
  * @param {Function} props.getValue
  * @param {Function} props.setValue
+ * @param {Function} props.tooltipContainer
  * @param {Function} props.validate
+ * @param {Function} props.show
+ * @param {Function} props.example
+ * @param {Function} props.variables
+ * @param {Function} props.onFocus
+ * @param {Function} props.onBlur
  */
 function FeelEntry(props) {
   const {
@@ -1682,7 +1690,7 @@ function FeelEntry(props) {
     setValue,
     tooltipContainer,
     validate,
-    show = noop,
+    show = noop$1,
     example,
     variables,
     onFocus,
@@ -1759,12 +1767,17 @@ function FeelEntry(props) {
  * @param {String} props.description
  * @param {Boolean} props.debounce
  * @param {Boolean} props.disabled
+ * @param {Boolean} props.feel
  * @param {String} props.label
  * @param {Function} props.getValue
  * @param {Function} props.setValue
+ * @param {Function} props.tooltipContainer
+ * @param {Function} props.validate
+ * @param {Function} props.show
+ * @param {Function} props.example
+ * @param {Function} props.variables
  * @param {Function} props.onFocus
  * @param {Function} props.onBlur
- * @param {Function} props.validate
  */
 function FeelTextArea(props) {
   return jsxRuntime.jsx(FeelEntry, {
@@ -1773,7 +1786,7 @@ function FeelTextArea(props) {
     ...props
   });
 }
-function isEdited$6(node) {
+function isEdited$7(node) {
   return node && (!!node.value || node.classList.contains('edited'));
 }
 
@@ -1783,6 +1796,260 @@ function prefixId$6(id) {
   return `bio-properties-panel-${id}`;
 }
 
+const useBufferedFocus = function (editor, ref) {
+  const [buffer, setBuffer] = hooks.useState(undefined);
+  ref.current = hooks.useMemo(() => ({
+    focus: offset => {
+      if (editor) {
+        editor.focus(offset);
+      } else {
+        if (typeof offset === 'undefined') {
+          offset = Infinity;
+        }
+        setBuffer(offset);
+      }
+    }
+  }), [editor]);
+  hooks.useEffect(() => {
+    if (typeof buffer !== 'undefined' && editor) {
+      editor.focus(buffer);
+      setBuffer(false);
+    }
+  }, [editor, buffer]);
+};
+const CodeEditor = compat.forwardRef((props, ref) => {
+  const {
+    value,
+    onInput,
+    onLint = () => {},
+    contentAttributes = {},
+    disabled,
+    tooltipContainer,
+    useGutters = false,
+    darkMode = false
+  } = props;
+  const inputRef = hooks.useRef();
+  const [editor, setEditor] = hooks.useState();
+  const [localValue, setLocalValue] = hooks.useState(value || '');
+  useBufferedFocus(editor, ref);
+  const handleInput = useStaticCallback(newValue => {
+    onInput(newValue);
+    setLocalValue(newValue);
+  });
+  hooks.useEffect(() => {
+    let editor;
+    editor = new feelers.FeelersEditor({
+      container: inputRef.current,
+      onChange: handleInput,
+      onLint: onLint,
+      contentAttributes: contentAttributes,
+      tooltipContainer: tooltipContainer,
+      value: localValue,
+      darkMode: darkMode,
+      enableGutters: useGutters
+    });
+    setEditor(editor);
+    return () => {
+      onLint([]);
+      inputRef.current.innerHTML = '';
+      setEditor(null);
+    };
+  }, []);
+  hooks.useEffect(() => {
+    if (!editor) {
+      return;
+    }
+    if (value === localValue) {
+      return;
+    }
+    editor.setValue(value);
+    setLocalValue(value);
+  }, [value]);
+  const handleClick = () => {
+    ref.current.focus();
+  };
+  return jsxRuntime.jsx("div", {
+    name: props.name,
+    class: classnames__default["default"]('bio-properties-panel-feelers-editor bio-properties-panel-input', localValue ? 'edited' : null, disabled ? 'disabled' : null),
+    ref: inputRef,
+    onClick: handleClick
+  });
+});
+
+const noop = () => {};
+
+/**
+ * @param {Object} props
+ * @param {Object} props.element
+ * @param {String} props.id
+ * @param {String} props.description
+ * @param {Boolean} props.debounce
+ * @param {Boolean} props.disabled
+ * @param {String} props.label
+ * @param {Function} props.getValue
+ * @param {Function} props.setValue
+ * @param {Function} props.tooltipContainer
+ * @param {Function} props.validate
+ * @param {Function} props.show
+ */
+function FeelTemplatingEntry(props) {
+  const {
+    element,
+    id,
+    description,
+    debounce,
+    disabled,
+    label,
+    getValue,
+    setValue,
+    tooltipContainer,
+    validate,
+    show = noop
+  } = props;
+  const [cachedInvalidValue, setCachedInvalidValue] = hooks.useState(null);
+  const [validationError, setValidationError] = hooks.useState(null);
+  const [localError, setLocalError] = hooks.useState(null);
+  let value = getValue(element);
+  const previousValue = usePrevious(value);
+  hooks.useEffect(() => {
+    if (minDash.isFunction(validate)) {
+      const newValidationError = validate(value) || null;
+      setValidationError(newValidationError);
+    }
+  }, [value]);
+  const onInput = useStaticCallback(newValue => {
+    let newValidationError = null;
+    if (minDash.isFunction(validate)) {
+      newValidationError = validate(newValue) || null;
+    }
+    if (newValidationError) {
+      setCachedInvalidValue(newValue);
+    } else {
+      // don't create multiple commandStack entries for the same value
+      if (newValue !== value) {
+        setValue(newValue);
+      }
+    }
+    setValidationError(newValidationError);
+  });
+  const onError = hooks.useCallback(err => {
+    setLocalError(err);
+  }, []);
+  if (previousValue === value && validationError) {
+    value = cachedInvalidValue;
+  }
+  const temporaryError = useError(id);
+  const error = localError || temporaryError || validationError;
+  return jsxRuntime.jsxs("div", {
+    class: classnames__default["default"]('bio-properties-panel-entry', error ? 'has-error' : ''),
+    "data-entry-id": id,
+    children: [jsxRuntime.jsx(FeelTemplating, {
+      debounce: debounce,
+      disabled: disabled,
+      id: id,
+      label: label,
+      onInput: onInput,
+      onError: onError,
+      show: show,
+      value: value,
+      tooltipContainer: tooltipContainer
+    }, element), error && jsxRuntime.jsx("div", {
+      class: "bio-properties-panel-error",
+      children: error
+    }), jsxRuntime.jsx(Description, {
+      forId: id,
+      element: element,
+      value: description
+    })]
+  });
+}
+function FeelTemplating(props) {
+  const {
+    debounce,
+    id,
+    label,
+    onInput,
+    onError,
+    value = '',
+    disabled = false,
+    tooltipContainer
+  } = props;
+  const [localValue, setLocalValue] = hooks.useState(value);
+  const editorRef = useShowEntryEvent(id);
+  const containerRef = hooks.useRef();
+  const [focus, _setFocus] = hooks.useState(undefined);
+  const setFocus = (offset = 0) => {
+    const hasFocus = containerRef.current.contains(document.activeElement);
+
+    // Keep caret position if it is already focused, otherwise focus at the end
+    const position = hasFocus ? document.activeElement.selectionStart : Infinity;
+    _setFocus(position + offset);
+  };
+  const handleInputCallback = hooks.useMemo(() => {
+    return debounce(newValue => onInput(newValue.length ? newValue : undefined));
+  }, [onInput, debounce]);
+  const handleInput = newValue => {
+    handleInputCallback(newValue);
+    setLocalValue(newValue);
+  };
+  const handleLint = useStaticCallback(lint => {
+    const errors = lint && lint.length && lint.filter(e => e.severity === 'error') || [];
+    if (!errors.length) {
+      onError(undefined);
+      return;
+    }
+    const error = lint[0];
+    const message = `${error.source}: ${error.message}`;
+    onError(message);
+  });
+  hooks.useEffect(() => {
+    if (typeof focus !== 'undefined') {
+      editorRef.current.focus(focus);
+      _setFocus(undefined);
+    }
+  }, [focus]);
+  hooks.useEffect(() => {
+    if (value === localValue) {
+      return;
+    }
+    setLocalValue(value ? value : '');
+  }, [value]);
+  return jsxRuntime.jsxs("div", {
+    class: "bio-properties-panel-feelers",
+    children: [jsxRuntime.jsx("label", {
+      id: prefixIdLabel(id),
+      class: "bio-properties-panel-label",
+      onClick: () => setFocus(),
+      children: label
+    }), jsxRuntime.jsx("div", {
+      class: "bio-properties-panel-feelers-input",
+      ref: containerRef,
+      children: jsxRuntime.jsx(CodeEditor, {
+        name: id,
+        onInput: handleInput,
+        contentAttributes: {
+          'aria-labelledby': prefixIdLabel(id)
+        },
+        disabled: disabled,
+        onLint: handleLint,
+        value: localValue,
+        useGutters: false,
+        ref: editorRef,
+        tooltipContainer: tooltipContainer
+      })
+    })]
+  });
+}
+function isEdited$6(node) {
+  return node && (!!node.value || node.classList.contains('edited'));
+}
+
+// helpers /////////////////
+
+function prefixIdLabel(id) {
+  return `bio-properties-panel-feelers-${id}-label`;
+}
+
 function List(props) {
   const {
     id,
@@ -2715,6 +2982,7 @@ exports.ExternalLinkIcon = ExternalLinkIcon;
 exports.FeelEntry = FeelEntry;
 exports.FeelOptionalIcon = FeelOptionalIcon;
 exports.FeelRequiredIcon = FeelRequiredIcon;
+exports.FeelTemplatingEntry = FeelTemplatingEntry;
 exports.FeelTextAreaEntry = FeelTextArea;
 exports.Group = Group;
 exports.Header = Header;
@@ -2732,8 +3000,9 @@ exports.SimpleEntry = Simple;
 exports.TextAreaEntry = TextAreaEntry;
 exports.TextFieldEntry = TextfieldEntry;
 exports.ToggleSwitchEntry = ToggleSwitchEntry;
-exports.isCheckboxEntryEdited = isEdited$7;
-exports.isFeelEntryEdited = isEdited$6;
+exports.isCheckboxEntryEdited = isEdited$8;
+exports.isFeelEntryEdited = isEdited$7;
+exports.isFeelTemplatingEntryEdited = isEdited$6;
 exports.isNumberFieldEntryEdited = isEdited$5;
 exports.isSelectEntryEdited = isEdited$4;
 exports.isSimpleEntryEdited = isEdited$3;