@bpmn-io/form-js-playground 1.7.2 → 1.8.0

package/dist/index.cjs

@@ -147,7 +147,7 @@ function completions(context) {
   };
 }
 
-const NO_LINT_CLS = 'fjs-no-json-lint';
+const NO_LINT_CLS = 'fjs-cm-no-lint';
 
 /**
  * @param {object} options
@@ -162,67 +162,53 @@ function JSONEditor(options = {}) {
     readonly = false
   } = options;
   const emitter = mitt();
-  let language = new state.Compartment().of(langJson.json());
-  let tabSize = new state.Compartment().of(state.EditorState.tabSize.of(2));
+  const languageCompartment = new state.Compartment().of(langJson.json());
+  const tabSizeCompartment = new state.Compartment().of(state.EditorState.tabSize.of(2));
+  const autocompletionConfCompartment = new state.Compartment();
+  const placeholderLinterExtension = createPlaceholderLinterExtension();
   let container = null;
-
-  /**
-   * @typedef {Array<string>} Variables
-   */
-
-  const autocompletionConf = new state.Compartment();
-  const linterExtension = lint.linter(langJson.jsonParseLinter());
-
-  // this sets no-linting mode if placeholders are present
-  const placeholderLinterExtension = lint.linter(view => {
-    const placeholders = view.dom.querySelectorAll('.cm-placeholder');
-    if (placeholders.length > 0) {
-      set(container, NO_LINT_CLS);
-    } else {
-      unset(container, NO_LINT_CLS);
-    }
-    return [];
-  });
-  function createState(doc, extensions = [], variables = []) {
-    return state.EditorState.create({
-      doc,
-      extensions: [codemirror.basicSetup, language, tabSize, linterExtension, placeholderLinterExtension, lint.lintGutter(), autocompletionConf.of(variablesFacet.of(variables)), autocompletionExtension(), view.keymap.of([commands.indentWithTab]), editorPlaceholder ? view.placeholder(editorPlaceholder) : [], ...extensions]
-    });
-  }
-  function createView(readonly) {
-    const updateListener = view.EditorView.updateListener.of(update => {
+  function createState(doc, variables = []) {
+    const extensions = [codemirror.basicSetup, languageCompartment, tabSizeCompartment, lint.lintGutter(), lint.linter(langJson.jsonParseLinter()), placeholderLinterExtension, autocompletionConfCompartment.of(variablesFacet.of(variables)), autocompletionExtension(), view.keymap.of([commands.indentWithTab]), editorPlaceholder ? view.placeholder(editorPlaceholder) : [], view.EditorView.updateListener.of(update => {
       if (update.docChanged) {
         emitter.emit('changed', {
-          value: update.view.state.doc.toString()
+          value: update.state.doc.toString()
         });
       }
+    }), view.EditorView.editable.of(!readonly), view.EditorView.contentAttributes.of(contentAttributes)];
+    return state.EditorState.create({
+      doc,
+      extensions
     });
-    const editable = view.EditorView.editable.of(!readonly);
-    const contentAttributesExtension = view.EditorView.contentAttributes.of(contentAttributes);
-    const view$1 = new view.EditorView({
-      state: createState('', [updateListener, editable, contentAttributesExtension])
-    });
-    view$1.setValue = function (value) {
-      this.setState(createState(value, [updateListener, editable, contentAttributesExtension]));
-    };
-    view$1.setVariables = function (variables) {
-      this.setState(createState(view$1.state.doc.toString(), [updateListener, editable, contentAttributesExtension], variables));
-    };
-    return view$1;
   }
-  const view$1 = this._view = createView(readonly);
-  this.setValue = function (value) {
-    view$1.setValue(value);
+  const view$1 = new view.EditorView({
+    state: createState('')
+  });
+  this.setValue = function (newValue) {
+    const oldValue = view$1.state.doc.toString();
+    const diff = findDiff(oldValue, newValue);
+    if (diff) {
+      view$1.dispatch({
+        changes: {
+          from: diff.start,
+          to: diff.end,
+          insert: diff.text
+        },
+        selection: {
+          anchor: diff.start + diff.text.length
+        }
+      });
+    }
   };
   this.getValue = function () {
     return view$1.state.doc.toString();
   };
-
-  /**
-   * @param {Variables} variables
-   */
   this.setVariables = function (variables) {
-    view$1.setVariables(variables);
+    view$1.dispatch({
+      effects: autocompletionConfCompartment.reconfigure(variablesFacet.of(variables))
+    });
+  };
+  this.getView = function () {
+    return view$1;
   };
   this.on = emitter.on;
   this.off = emitter.off;
@@ -230,24 +216,56 @@ function JSONEditor(options = {}) {
   this.attachTo = function (_container) {
     container = _container;
     container.appendChild(view$1.dom);
+    minDom.classes(container, document.body).add('fjs-json-editor');
   };
   this.destroy = function () {
-    if (view$1.dom.parentNode) {
-      view$1.dom.parentNode.removeChild(view$1.dom);
+    if (container && view$1.dom) {
+      container.removeChild(view$1.dom);
+      minDom.classes(container, document.body).remove('fjs-json-editor');
     }
     view$1.destroy();
   };
+  function createPlaceholderLinterExtension() {
+    return lint.linter(view => {
+      const placeholders = view.dom.querySelectorAll('.cm-placeholder');
+      if (placeholders.length > 0) {
+        minDom.classes(container, document.body).add(NO_LINT_CLS);
+      } else {
+        minDom.classes(container, document.body).remove(NO_LINT_CLS);
+      }
+      return [];
+    });
+  }
 }
-
-// helpers //////////////////////
-
-function set(node, cls) {
-  const classes = minDom.classes(node, document.body);
-  classes.add(cls);
-}
-function unset(node, cls) {
-  const classes = minDom.classes(node, document.body);
-  classes.remove(cls);
+function findDiff(oldStr, newStr) {
+  if (oldStr === newStr) {
+    return null;
+  }
+  oldStr = oldStr || '';
+  newStr = newStr || '';
+  let minLength = Math.min(oldStr.length, newStr.length);
+  let start = 0;
+  while (start < minLength && oldStr[start] === newStr[start]) {
+    start++;
+  }
+  if (start === minLength) {
+    return {
+      start: start,
+      text: newStr.slice(start),
+      end: oldStr.length
+    };
+  }
+  let endOld = oldStr.length;
+  let endNew = newStr.length;
+  while (endOld > start && endNew > start && oldStr[endOld - 1] === newStr[endNew - 1]) {
+    endOld--;
+    endNew--;
+  }
+  return {
+    start: start,
+    text: newStr.slice(start, endNew),
+    end: endOld
+  };
 }
 
 function Section(props) {
@@ -281,90 +299,69 @@ Section.HeaderItem = function (props) {
   return props.children;
 };
 
-function PlaygroundRoot(props) {
+function PlaygroundRoot(config) {
   const {
-    additionalModules = [],
+    additionalModules,
     // goes into both editor + viewer
-    actions: actionsConfig = {},
+    actions: actionsConfig,
     emit,
-    exporter: exporterConfig = {},
-    viewerProperties = {},
-    editorProperties = {},
-    viewerAdditionalModules = [],
-    editorAdditionalModules = [],
-    propertiesPanel: propertiesPanelConfig = {},
-    onInit: onPlaygroundInit,
-    onStateChanged
-  } = props;
+    exporter: exporterConfig,
+    viewerProperties,
+    editorProperties,
+    viewerAdditionalModules,
+    editorAdditionalModules,
+    propertiesPanel: propertiesPanelConfig,
+    apiLinkTarget
+  } = config;
   const {
     display: displayActions = true
-  } = actionsConfig;
-  const paletteContainerRef = hooks.useRef();
+  } = actionsConfig || {};
   const editorContainerRef = hooks.useRef();
-  const formContainerRef = hooks.useRef();
-  const dataContainerRef = hooks.useRef();
-  const resultContainerRef = hooks.useRef();
+  const paletteContainerRef = hooks.useRef();
   const propertiesPanelContainerRef = hooks.useRef();
-  const paletteRef = hooks.useRef();
+  const viewerContainerRef = hooks.useRef();
+  const inputDataContainerRef = hooks.useRef();
+  const outputDataContainerRef = hooks.useRef();
   const formEditorRef = hooks.useRef();
-  const formRef = hooks.useRef();
-  const dataEditorRef = hooks.useRef();
-  const resultViewRef = hooks.useRef();
-  const propertiesPanelRef = hooks.useRef();
+  const formViewerRef = hooks.useRef();
+  const inputDataRef = hooks.useRef();
+  const outputDataRef = hooks.useRef();
   const [showEmbed, setShowEmbed] = hooks.useState(false);
-  const [initialData] = hooks.useState(props.data || undefined);
-  const [initialSchema, setInitialSchema] = hooks.useState(props.schema);
-  const [data, setData] = hooks.useState(props.data || {});
-  const [schema, setSchema] = hooks.useState(props.schema);
-  const [resultData, setResultData] = hooks.useState({});
+  const [schema, setSchema] = hooks.useState();
+  const [data, setData] = hooks.useState();
+  const load = hooks.useCallback((schema, data) => {
+    formEditorRef.current.importSchema(schema, data);
+    inputDataRef.current.setValue(toString(data));
+    setSchema(schema);
+    setData(data);
+  }, []);
 
-  // pipe to playground API
+  // initialize and link the editors
   hooks.useEffect(() => {
-    onPlaygroundInit({
-      attachDataContainer: node => dataEditorRef.current.attachTo(node),
-      attachEditorContainer: node => formEditorRef.current.attachTo(node),
-      attachFormContainer: node => formRef.current.attachTo(node),
-      attachPaletteContainer: node => paletteRef.current.attachTo(node),
-      attachPropertiesPanelContainer: node => propertiesPanelRef.current.attachTo(node),
-      attachResultContainer: node => resultViewRef.current.attachTo(node),
-      get: (name, strict) => formEditorRef.current.get(name, strict),
-      getDataEditor: () => dataEditorRef.current,
-      getEditor: () => formEditorRef.current,
-      getForm: () => formRef.current,
-      getResultView: () => resultViewRef.current,
-      getSchema: () => formEditorRef.current.getSchema(),
-      setSchema: setInitialSchema,
-      saveSchema: () => formEditorRef.current.saveSchema()
-    });
-  }, [onPlaygroundInit]);
-  hooks.useEffect(() => {
-    setInitialSchema(props.schema || {});
-  }, [props.schema]);
-  hooks.useEffect(() => {
-    const dataEditor = dataEditorRef.current = new JSONEditor({
-      value: toString(data),
+    const inputDataEditor = inputDataRef.current = new JSONEditor({
       contentAttributes: {
         'aria-label': 'Form Input',
         tabIndex: 0
       },
       placeholder: createDataEditorPlaceholder()
     });
-    const resultView = resultViewRef.current = new JSONEditor({
+    const outputDataEditor = outputDataRef.current = new JSONEditor({
       readonly: true,
-      value: toString(resultData),
       contentAttributes: {
         'aria-label': 'Form Output',
         tabIndex: 0
       }
     });
-    const form = formRef.current = new formJsViewer.Form({
-      additionalModules: [...additionalModules, ...viewerAdditionalModules],
+    const formViewer = formViewerRef.current = new formJsViewer.Form({
+      container: viewerContainerRef.current,
+      additionalModules: [...(additionalModules || []), ...(viewerAdditionalModules || [])],
       properties: {
-        ...viewerProperties,
+        ...(viewerProperties || {}),
         'ariaLabel': 'Form Preview'
       }
     });
     const formEditor = formEditorRef.current = new formJsEditor.FormEditor({
+      container: editorContainerRef.current,
       renderer: {
         compact: true
       },
@@ -373,17 +370,15 @@ function PlaygroundRoot(props) {
       },
       propertiesPanel: {
         parent: propertiesPanelContainerRef.current,
-        ...propertiesPanelConfig
+        ...(propertiesPanelConfig || {})
       },
       exporter: exporterConfig,
       properties: {
-        ...editorProperties,
+        ...(editorProperties || {}),
         'ariaLabel': 'Form Definition'
       },
-      additionalModules: [...additionalModules, ...editorAdditionalModules]
+      additionalModules: [...(additionalModules || []), ...(editorAdditionalModules || [])]
     });
-    paletteRef.current = formEditor.get('palette');
-    propertiesPanelRef.current = formEditor.get('propertiesPanel');
     formEditor.on('formField.add', ({
       formField
     }) => {
@@ -409,7 +404,7 @@ function PlaygroundRoot(props) {
           ...currentData,
           [id]: initialDemoData
         };
-        dataEditorRef.current.setValue(toString(newData));
+        inputDataRef.current.setValue(toString(newData));
         return newData;
       });
     });
@@ -420,10 +415,13 @@ function PlaygroundRoot(props) {
       // notify interested parties after render
       emit('formPlayground.rendered');
     });
-    form.on('changed', () => {
-      setResultData(form._getSubmitData());
+
+    // pipe viewer changes to output data editor
+    formViewer.on('changed', () => {
+      const submitData = formViewer._getSubmitData();
+      outputDataEditor.setValue(toString(submitData));
     });
-    dataEditor.on('changed', event => {
+    inputDataEditor.on('changed', event => {
       try {
         setData(JSON.parse(event.value));
       } catch (error) {
@@ -431,48 +429,68 @@ function PlaygroundRoot(props) {
         emit('formPlayground.inputDataError', error);
       }
     });
-    const formContainer = formContainerRef.current;
-    const editorContainer = editorContainerRef.current;
-    const dataContainer = dataContainerRef.current;
-    const resultContainer = resultContainerRef.current;
-    dataEditor.attachTo(dataContainer);
-    resultView.attachTo(resultContainer);
-    form.attachTo(formContainer);
-    formEditor.attachTo(editorContainer);
+    inputDataEditor.attachTo(inputDataContainerRef.current);
+    outputDataEditor.attachTo(outputDataContainerRef.current);
     return () => {
-      dataEditor.destroy();
-      resultView.destroy();
-      form.destroy();
+      inputDataEditor.destroy();
+      outputDataEditor.destroy();
+      formViewer.destroy();
       formEditor.destroy();
     };
-  }, []);
-  hooks.useEffect(() => {
-    dataEditorRef.current.setValue(toString(initialData));
-  }, [initialData]);
+  }, [additionalModules, editorAdditionalModules, editorProperties, emit, exporterConfig, propertiesPanelConfig, viewerAdditionalModules, viewerProperties]);
+
+  // initialize data through props
   hooks.useEffect(() => {
-    if (initialSchema) {
-      formEditorRef.current.importSchema(initialSchema);
-      dataEditorRef.current.setVariables(formJsViewer.getSchemaVariables(initialSchema));
+    if (!config.initialSchema) {
+      return;
     }
-  }, [initialSchema]);
+    load(config.initialSchema, config.initialData || {});
+  }, [config.initialSchema, config.initialData, load]);
+  hooks.useEffect(() => {
+    schema && formViewerRef.current.importSchema(schema, data);
+  }, [schema, data]);
   hooks.useEffect(() => {
-    if (schema && dataContainerRef.current) {
+    if (schema && inputDataContainerRef.current) {
       const variables = formJsViewer.getSchemaVariables(schema);
-      dataEditorRef.current.setVariables(variables);
+      inputDataRef.current.setVariables(variables);
     }
   }, [schema]);
+
+  // exposes api to parent
   hooks.useEffect(() => {
-    schema && formRef.current.importSchema(schema, data);
-  }, [schema, data]);
-  hooks.useEffect(() => {
-    resultViewRef.current.setValue(toString(resultData));
-  }, [resultData]);
+    if (!apiLinkTarget) {
+      return;
+    }
+    apiLinkTarget.api = {
+      attachDataContainer: node => inputDataRef.current.attachTo(node),
+      attachResultContainer: node => outputDataRef.current.attachTo(node),
+      attachFormContainer: node => formViewerRef.current.attachTo(node),
+      attachEditorContainer: node => formEditorRef.current.attachTo(node),
+      attachPaletteContainer: node => formEditorRef.current.get('palette').attachTo(node),
+      attachPropertiesPanelContainer: node => formEditorRef.current.get('propertiesPanel').attachTo(node),
+      get: (name, strict) => formEditorRef.current.get(name, strict),
+      getDataEditor: () => inputDataRef.current,
+      getEditor: () => formEditorRef.current,
+      getForm: () => formViewerRef.current,
+      getResultView: () => outputDataRef.current,
+      getSchema: () => formEditorRef.current.getSchema(),
+      saveSchema: () => formEditorRef.current.saveSchema(),
+      setSchema: setSchema,
+      setData: setData
+    };
+  }, [apiLinkTarget]);
+
+  // separate effect for state to avoid re-creating the api object every time
   hooks.useEffect(() => {
-    onStateChanged && onStateChanged({
+    if (!apiLinkTarget) {
+      return;
+    }
+    apiLinkTarget.api.getState = () => ({
       schema,
       data
     });
-  }, [onStateChanged, schema, data]);
+    apiLinkTarget.api.load = load;
+  }, [apiLinkTarget, schema, data, load]);
   const handleDownload = hooks.useCallback(() => {
     download(JSON.stringify(schema, null, '  '), 'form.json', 'text/json');
   }, [schema]);
@@ -520,19 +538,19 @@ function PlaygroundRoot(props) {
       }), jsxRuntime.jsx(Section, {
         name: "Form Preview",
         children: jsxRuntime.jsx("div", {
-          ref: formContainerRef,
+          ref: viewerContainerRef,
           class: "fjs-pgl-form-container"
         })
       }), jsxRuntime.jsx(Section, {
         name: "Form Input",
         children: jsxRuntime.jsx("div", {
-          ref: dataContainerRef,
+          ref: inputDataContainerRef,
           class: "fjs-pgl-text-container"
         })
       }), jsxRuntime.jsx(Section, {
         name: "Form Output",
         children: jsxRuntime.jsx("div", {
-          ref: resultContainerRef,
+          ref: outputDataContainerRef,
           class: "fjs-pgl-text-container"
         })
       })]
@@ -557,16 +575,11 @@ function createDataEditorPlaceholder() {
 function Playground(options) {
   const {
     container: parent,
-    schema,
-    data,
+    schema: initialSchema,
+    data: initialData,
     ...rest
   } = options;
   const emitter = mitt();
-  let state = {
-    data,
-    schema
-  };
-  let ref;
   const container = document.createElement('div');
   container.classList.add('fjs-pgl-parent');
   if (parent) {
@@ -576,63 +589,52 @@ function Playground(options) {
     const file = files[0];
     if (file) {
       try {
-        ref.setSchema(JSON.parse(file.contents));
+        this.api.setSchema(JSON.parse(file.contents));
       } catch (err) {
 
         // TODO(nikku): indicate JSON parse error
       }
     }
   });
-  const withRef = function (fn) {
+  const safe = function (fn) {
     return function (...args) {
-      if (!ref) {
+      if (!this.api) {
         throw new Error('Playground is not initialized.');
       }
       return fn(...args);
     };
   };
-  const onInit = function (_ref) {
-    ref = _ref;
-    emitter.emit('formPlayground.init');
-  };
   container.addEventListener('dragover', handleDrop);
   preact.render(jsxRuntime.jsx(PlaygroundRoot, {
-    data: data,
+    initialSchema: initialSchema,
+    initialData: initialData,
     emit: emitter.emit,
-    onInit: onInit,
-    onStateChanged: _state => state = _state,
-    schema: schema,
+    apiLinkTarget: this,
     ...rest
   }), container);
   this.on = emitter.on;
   this.off = emitter.off;
   this.emit = emitter.emit;
-  this.on('destroy', function () {
+  this.on('destroy', () => {
     preact.render(null, container);
-  });
-  this.on('destroy', function () {
     parent.removeChild(container);
   });
-  this.getState = function () {
-    return state;
-  };
-  this.getSchema = withRef(() => ref.getSchema());
-  this.setSchema = withRef(schema => ref.setSchema(schema));
-  this.saveSchema = withRef(() => ref.saveSchema());
-  this.get = withRef((name, strict) => ref.get(name, strict));
-  this.getDataEditor = withRef(() => ref.getDataEditor());
-  this.getEditor = withRef(() => ref.getEditor());
-  this.getForm = withRef((name, strict) => ref.getForm(name, strict));
-  this.getResultView = withRef(() => ref.getResultView());
-  this.destroy = function () {
-    this.emit('destroy');
-  };
-  this.attachEditorContainer = withRef(node => ref.attachEditorContainer(node));
-  this.attachPreviewContainer = withRef(node => ref.attachFormContainer(node));
-  this.attachDataContainer = withRef(node => ref.attachDataContainer(node));
-  this.attachResultContainer = withRef(node => ref.attachResultContainer(node));
-  this.attachPaletteContainer = withRef(node => ref.attachPaletteContainer(node));
-  this.attachPropertiesPanelContainer = withRef(node => ref.attachPropertiesPanelContainer(node));
+  this.destroy = () => this.emit('destroy');
+  this.getState = safe(() => this.api.getState());
+  this.getSchema = safe(() => this.api.getSchema());
+  this.setSchema = safe(schema => this.api.setSchema(schema));
+  this.saveSchema = safe(() => this.api.saveSchema());
+  this.get = safe((name, strict) => this.api.get(name, strict));
+  this.getDataEditor = safe(() => this.api.getDataEditor());
+  this.getEditor = safe(() => this.api.getEditor());
+  this.getForm = safe((name, strict) => this.api.getForm(name, strict));
+  this.getResultView = safe(() => this.api.getResultView());
+  this.attachEditorContainer = safe(node => this.api.attachEditorContainer(node));
+  this.attachPreviewContainer = safe(node => this.api.attachFormContainer(node));
+  this.attachDataContainer = safe(node => this.api.attachDataContainer(node));
+  this.attachResultContainer = safe(node => this.api.attachResultContainer(node));
+  this.attachPaletteContainer = safe(node => this.api.attachPaletteContainer(node));
+  this.attachPropertiesPanelContainer = safe(node => this.api.attachPropertiesPanelContainer(node));
 }
 
 exports.Playground = Playground;