@atlaskit/editor-plugin-synced-block 2.0.1 → 2.1.1

package/dist/es2019/nodeviews/syncedBlock.js

@@ -1,105 +1,141 @@
-/* eslint-disable @atlaskit/ui-styling-standard/enforce-style-prop */
-import React, { useMemo, useRef, useState } from 'react';
+import React from 'react';
 import ReactNodeView from '@atlaskit/editor-common/react-node-view';
-export const defaultSyncBlockDocument = {
+import { NodeSelection } from '@atlaskit/editor-prosemirror/state';
+import { SyncBlockEditorWrapper, SyncBlockEditorWrapperDataId } from '../ui/SyncBlockEditorWrapper';
+import { SyncBlockRendererWrapper } from '../ui/SyncBlockRendererWrapper';
+const defaultSyncBlockEditorDocument = {
   version: 1,
   type: 'doc',
   content: [{
     type: 'paragraph',
     content: [{
       type: 'text',
-      text: 'This is a synced block. Edit the source to update the content.'
+      text: 'This is a source sync block. Edit me to update the content.'
     }]
   }]
 };
-const SyncBlockEditorWrapperDataId = 'sync-block-plugin-editor-wrapper';
-export const SyncBlockPluginComponent = ({
-  config,
-  dom
-}) => {
-  const innerEditorView = useRef(null);
-
-  /* Tmp solution to demonstrate the synced block renderer */
-  const [rendererDocument, setRendererDocument] = useState(defaultSyncBlockDocument);
-  const onChange = (editorView, _meta) => {
-    const content = editorView.state.doc.toJSON().content;
-    const rendererDocument = {
-      version: 1,
-      type: 'doc',
-      content
-    };
-    setRendererDocument(rendererDocument);
-  };
-  const onEditorReady = ({
-    editorView
-  }) => {
-    innerEditorView.current = editorView || null;
-  };
-  const boundariesElement = useMemo(() => {
-    // eslint-disable-next-line @atlaskit/editor/no-as-casting
-    return dom.closest('.fabric-editor-popup-scroll-parent');
-  }, [dom]);
-  if (!boundariesElement || !(boundariesElement instanceof HTMLElement)) {
-    return null;
-  }
-  if (!(config !== null && config !== void 0 && config.getSyncedBlockEditor) || !(config !== null && config !== void 0 && config.getSyncedBlockRenderer)) {
-    return null;
-  }
-  return /*#__PURE__*/React.createElement("div", {
-    "data-testid": SyncBlockEditorWrapperDataId
-  }, config.getSyncedBlockEditor({
-    boundariesElement: boundariesElement,
-    defaultDocument: defaultSyncBlockDocument,
-    mountPoint: dom,
-    onChange: onChange,
-    onEditorReady: onEditorReady
-  }), /*#__PURE__*/React.createElement("div", {
-    style: {
-      width: '100%',
-      height: '1px',
-      // eslint-disable-next-line @atlaskit/design-system/ensure-design-token-usage
-      backgroundColor: 'purple'
-    }
-  }), config.getSyncedBlockRenderer({
-    docNode: rendererDocument
-  }));
+const defaultSyncBlockRendererDocument = {
+  version: 1,
+  type: 'doc',
+  content: [{
+    type: 'paragraph',
+    content: [{
+      type: 'text',
+      text: 'This is a reference sync block. Stay tuned for updates...'
+    }]
+  }]
 };
 class SyncBlock extends ReactNodeView {
+  constructor(props) {
+    super(props.node, props.view, props.getPos, props.portalProviderAPI, props.eventDispatcher, props);
+    const {
+      resourceId,
+      localId
+    } = props.node.attrs;
+    // Temporary solution to identify the source
+    this.isSource = resourceId === localId;
+    this.options = props.options;
+  }
   createDomRef() {
     const domRef = document.createElement('div');
-    domRef.setAttribute('style', 'border: purple solid 1px;');
     return domRef;
   }
-  render() {
-    return /*#__PURE__*/React.createElement(SyncBlockPluginComponent, {
-      config: this.reactComponentProps.config,
-      dom: this.dom
+  handleContentChanges(_updatedDoc) {
+    // write data
+  }
+  setInnerEditorView(_editorView) {
+    // set inner editor view
+  }
+  renderEditor() {
+    var _this$options, _this$options2;
+    const popupsBoundariesElement = this.dom.closest('.fabric-editor-popup-scroll-parent');
+    if (!(popupsBoundariesElement instanceof HTMLElement)) {
+      return null;
+    }
+    if (!((_this$options = this.options) !== null && _this$options !== void 0 && _this$options.getSyncedBlockEditor)) {
+      return null;
+    }
+    return /*#__PURE__*/React.createElement(SyncBlockEditorWrapper, {
+      popupsBoundariesElement: popupsBoundariesElement,
+      popupsMountPoint: this.dom,
+      defaultDocument: defaultSyncBlockEditorDocument,
+      handleContentChanges: this.handleContentChanges,
+      setInnerEditorView: this.setInnerEditorView,
+      getSyncedBlockEditor: (_this$options2 = this.options) === null || _this$options2 === void 0 ? void 0 : _this$options2.getSyncedBlockEditor
+    });
+  }
+  renderRenderer() {
+    var _this$options3, _this$options4;
+    if (!((_this$options3 = this.options) !== null && _this$options3 !== void 0 && _this$options3.getSyncedBlockRenderer)) {
+      return null;
+    }
+
+    // get document node from data provider
+    const docNode = defaultSyncBlockRendererDocument;
+    return /*#__PURE__*/React.createElement(SyncBlockRendererWrapper, {
+      docNode: docNode,
+      getSyncedBlockRenderer: (_this$options4 = this.options) === null || _this$options4 === void 0 ? void 0 : _this$options4.getSyncedBlockRenderer
     });
   }
+  render() {
+    if (this.isSource) {
+      return this.renderEditor();
+    }
+    return this.renderRenderer();
+  }
   stopEvent(event) {
     var _target$closest;
     const target = event.target;
     if (!target) {
       return false;
     }
-    return ((_target$closest = target.closest) === null || _target$closest === void 0 ? void 0 : _target$closest.call(target, `[data-testid="${SyncBlockEditorWrapperDataId}"]`)) != null;
+    const isInNestedEditor = ((_target$closest = target.closest) === null || _target$closest === void 0 ? void 0 : _target$closest.call(target, `[data-testid="${SyncBlockEditorWrapperDataId}"]`)) != null;
+    if (isInNestedEditor) {
+      this.selectNode();
+      return true;
+    }
+    return false;
+  }
+  selectNode() {
+    this.selectSyncBlockNode(undefined);
   }
   destroy() {
     var _this$unsubscribe;
     (_this$unsubscribe = this.unsubscribe) === null || _this$unsubscribe === void 0 ? void 0 : _this$unsubscribe.call(this);
     super.destroy();
   }
+  selectSyncBlockNode(relativeSelectionPos) {
+    var _this$reactComponentP, _this$reactComponentP2;
+    const getPos = typeof this.getPos === 'function' ? this.getPos() : 0;
+    const selectionAPI = (_this$reactComponentP = this.reactComponentProps.api) === null || _this$reactComponentP === void 0 ? void 0 : (_this$reactComponentP2 = _this$reactComponentP.selection) === null || _this$reactComponentP2 === void 0 ? void 0 : _this$reactComponentP2.actions;
+    if (!selectionAPI) {
+      return;
+    }
+    const tr = selectionAPI.selectNearNode({
+      selectionRelativeToNode: relativeSelectionPos,
+      selection: NodeSelection.create(this.view.state.doc, getPos !== null && getPos !== void 0 ? getPos : 0)
+    })(this.view.state);
+    if (tr) {
+      this.view.dispatch(tr);
+    }
+  }
 }
 export const syncBlockNodeView = ({
-  config,
-  pmPluginFactoryParams
+  options,
+  pmPluginFactoryParams,
+  api
 }) => (node, view, getPos) => {
   const {
     portalProviderAPI,
     eventDispatcher
   } = pmPluginFactoryParams;
-  const reactComponentProps = {
-    config
-  };
-  return new SyncBlock(node, view, getPos, portalProviderAPI, eventDispatcher, reactComponentProps, undefined).init();
+  return new SyncBlock({
+    api,
+    options,
+    node,
+    view,
+    getPos,
+    portalProviderAPI,
+    eventDispatcher
+  }).init();
 };

package/dist/es2019/pm-plugins/actions.js

@@ -1,19 +1,34 @@
+import uuid from 'uuid';
+import { toDOM, copyDomNode } from '@atlaskit/editor-common/copy-button';
+import { NodeSelection } from '@atlaskit/editor-prosemirror/state';
 import { safeInsert } from '@atlaskit/editor-prosemirror/utils';
-const getRandomId = () => {
-  if (!globalThis.crypto || typeof globalThis.crypto.randomUUID !== 'function') {
-    return new Date().toISOString();
-  }
-  return globalThis.crypto.randomUUID();
-};
 export const createSyncedBlock = state => {
+  const id = uuid();
   const tr = state.tr;
   // const { breakout } = state.schema.marks;
   const node = state.schema.nodes.syncBlock.createChecked({
-    resourceId: getRandomId(),
-    localId: getRandomId()
+    resourceId: id,
+    localId: id
   }, null
   // [breakout.create({ mode: 'wide' })],
   );
   safeInsert(node)(tr);
   return tr;
+};
+export const copySyncedBlockReferenceToClipboard = (state, _dispatch, _view) => {
+  const {
+    schema,
+    selection
+  } = state;
+  if (selection instanceof NodeSelection) {
+    const nodeType = selection.node.type;
+    const domNode = toDOM(selection.node, schema);
+    // clear local-id
+    if (domNode instanceof HTMLElement) {
+      domNode.setAttribute('data-local-id', '');
+    }
+    copyDomNode(domNode, nodeType, selection);
+    return true;
+  }
+  return false;
 };

package/dist/es2019/pm-plugins/main.js

@@ -5,7 +5,7 @@ export const syncedBlockPluginKey = new PluginKey('syncedBlockPlugin');
 
 // eslint-disable-next-line @typescript-eslint/no-empty-object-type
 
-export const createPlugin = (config, pmPluginFactoryParams) => {
+export const createPlugin = (options, pmPluginFactoryParams, _syncBlockStore, api) => {
   return new SafePlugin({
     key: syncedBlockPluginKey,
     state: {
@@ -23,8 +23,9 @@ export const createPlugin = (config, pmPluginFactoryParams) => {
     props: {
       nodeViews: {
         syncBlock: lazySyncBlockView({
-          config,
-          pmPluginFactoryParams
+          options,
+          pmPluginFactoryParams,
+          api
         })
       }
     }

package/dist/es2019/pm-plugins/utils/utils.js

@@ -0,0 +1,7 @@
+import { findParentNodeOfType, findSelectedNodeOfType } from '@atlaskit/editor-prosemirror/utils';
+export const findSyncBlock = (state, selection) => {
+  const {
+    syncBlock
+  } = state.schema.nodes;
+  return findSelectedNodeOfType(syncBlock)(selection || state.selection) || findParentNodeOfType(syncBlock)(selection || state.selection);
+};

package/dist/es2019/syncedBlockPlugin.js

@@ -1,40 +1,45 @@
 import React from 'react';
 import { syncBlock } from '@atlaskit/adf-schema';
+import { SyncBlockStoreManager } from '@atlaskit/editor-common/sync-block';
 import SmartLinkIcon from '@atlaskit/icon/core/smart-link';
 import { createSyncedBlock } from './pm-plugins/actions';
 import { createPlugin } from './pm-plugins/main';
 import { getToolbarConfig } from './ui/floating-toolbar';
 export const syncedBlockPlugin = ({
-  config
-}) => ({
-  name: 'syncedBlock',
-  nodes() {
-    return [{
-      name: 'syncBlock',
-      node: syncBlock
-    }];
-  },
-  pmPlugins() {
-    return [{
-      name: 'syncedBlockPlugin',
-      plugin: params => createPlugin(config, params)
-    }];
-  },
-  pluginsOptions: {
-    quickInsert: () => [{
-      id: 'syncBlock',
-      title: 'Synced Block',
-      description: 'Create a synced block',
-      priority: 800,
-      keywords: ['synced', 'block', 'synced-block', 'sync', 'sync-block'],
-      keyshortcut: '',
-      icon: () => /*#__PURE__*/React.createElement(SmartLinkIcon, {
-        label: "Synced Block"
-      }),
-      action: (_insert, state) => {
-        return createSyncedBlock(state);
-      }
-    }],
-    floatingToolbar: getToolbarConfig()
-  }
-});
+  config,
+  api
+}) => {
+  const syncBlockStore = new SyncBlockStoreManager(config === null || config === void 0 ? void 0 : config.dataProvider);
+  return {
+    name: 'syncedBlock',
+    nodes() {
+      return [{
+        name: 'syncBlock',
+        node: syncBlock
+      }];
+    },
+    pmPlugins() {
+      return [{
+        name: 'syncedBlockPlugin',
+        plugin: params => createPlugin(config, params, syncBlockStore, api)
+      }];
+    },
+    pluginsOptions: {
+      quickInsert: () => [{
+        id: 'syncBlock',
+        title: 'Synced Block',
+        description: 'Create a synced block',
+        priority: 800,
+        keywords: ['synced', 'block', 'synced-block', 'sync', 'sync-block'],
+        keyshortcut: '',
+        icon: () => /*#__PURE__*/React.createElement(SmartLinkIcon, {
+          label: "Synced Block"
+        }),
+        action: (_insert, state) => {
+          return createSyncedBlock(state);
+        }
+      }],
+      floatingToolbar: (state, intl, providerFactory) => getToolbarConfig(state, intl, config, providerFactory)
+    }
+  };
+};

package/dist/es2019/ui/SyncBlockEditorWrapper.js

@@ -0,0 +1,28 @@
+import React from 'react';
+export const SyncBlockEditorWrapperDataId = 'sync-block-plugin-editor-wrapper';
+const SyncBlockEditorWrapperComponent = ({
+  defaultDocument,
+  getSyncedBlockEditor,
+  popupsBoundariesElement,
+  popupsMountPoint,
+  setInnerEditorView,
+  handleContentChanges
+}) => {
+  return (
+    /*#__PURE__*/
+    // eslint-disable-next-line @atlaskit/ui-styling-standard/enforce-style-prop, @atlaskit/design-system/ensure-design-token-usage
+    React.createElement("div", {
+      "data-testid": SyncBlockEditorWrapperDataId,
+      style: {
+        border: 'purple solid 1px'
+      }
+    }, getSyncedBlockEditor({
+      popupsBoundariesElement,
+      defaultDocument,
+      popupsMountPoint,
+      onChange: value => handleContentChanges(value.state.doc),
+      onEditorReady: value => setInnerEditorView(value.editorView)
+    }))
+  );
+};
+export const SyncBlockEditorWrapper = /*#__PURE__*/React.memo(SyncBlockEditorWrapperComponent);

package/dist/es2019/ui/SyncBlockRendererWrapper.js

@@ -0,0 +1,20 @@
+import React from 'react';
+const SyncBlockRendererWrapperDataId = 'sync-block-plugin-renderer-wrapper';
+const SyncBlockRendererWrapperComponent = ({
+  getSyncedBlockRenderer,
+  docNode
+}) => {
+  return (
+    /*#__PURE__*/
+    // eslint-disable-next-line @atlaskit/ui-styling-standard/enforce-style-prop, @atlaskit/design-system/ensure-design-token-usage
+    React.createElement("div", {
+      "data-testid": SyncBlockRendererWrapperDataId,
+      style: {
+        border: 'blue solid 1px'
+      }
+    }, getSyncedBlockRenderer({
+      docNode
+    }))
+  );
+};
+export const SyncBlockRendererWrapper = /*#__PURE__*/React.memo(SyncBlockRendererWrapperComponent);

package/dist/es2019/ui/floating-toolbar.js

@@ -1,3 +1,57 @@
-export const getToolbarConfig = () => (_state, _intl) => {
-  return undefined;
+import { findDomRefAtPos } from '@atlaskit/editor-prosemirror/utils';
+import CopyIcon from '@atlaskit/icon/core/copy';
+import LinkExternalIcon from '@atlaskit/icon/core/link-external';
+import { copySyncedBlockReferenceToClipboard } from '../pm-plugins/actions';
+import { findSyncBlock } from '../pm-plugins/utils/utils';
+export const getToolbarConfig = (state, _intl, _options = {}, _providerFactory) => {
+  const syncBlockObject = findSyncBlock(state);
+  if (!syncBlockObject) {
+    return;
+  }
+  const nodeType = state.schema.nodes.syncBlock;
+  const items = [];
+  const copyButton = {
+    id: 'editor.syncedBlock.copy',
+    type: 'button',
+    appearance: 'subtle',
+    icon: CopyIcon,
+    title: 'Copy',
+    showTitle: true,
+    tooltipContent: 'Copy reference to clipboard',
+    onClick: copySyncedBlockReferenceToClipboard
+  };
+  items.push(copyButton);
+  if (syncBlockObject.node.attrs.resourceId !== syncBlockObject.node.attrs.localId) {
+    const editSourceButton = {
+      id: 'editor.syncedBlock.editSource',
+      type: 'button',
+      appearance: 'subtle',
+      icon: LinkExternalIcon,
+      title: 'Edit source',
+      showTitle: true,
+      tooltipContent: 'Navigate to source page of the sync block',
+      disabled: true,
+      onClick: (_state, _dispatch, view) => {
+        if (!view) {
+          return false;
+        }
+        // to be implemented in a follow up PR
+        return true;
+      }
+    };
+    items.push(editSourceButton);
+  }
+  const getDomRef = editorView => {
+    const domAtPos = editorView.domAtPos.bind(editorView);
+    const element = findDomRefAtPos(syncBlockObject.pos, domAtPos);
+    return element;
+  };
+  return {
+    title: 'Synced Block floating controls',
+    getDomRef,
+    nodeType,
+    items,
+    scrollable: true,
+    groupLabel: 'Synced blocks'
+  };
 };