@atlaskit/editor-plugin-synced-block 3.9.2 → 3.10.0

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @atlaskit/editor-plugin-synced-block
 
+## 3.10.0
+
+### Minor Changes
+
+- [`6f9f13ab4687d`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/6f9f13ab4687d) -
+  EDITOR-2451 update sync-block refreshed logic based on experience principles
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 3.9.2
 
 ### Patch Changes

package/dist/cjs/editor-commands/index.js

@@ -85,11 +85,11 @@ var editSyncedBlockSource = exports.editSyncedBlockSource = function editSyncedB
   return function (state, dispatch, _view) {
     var _syncBlock$node;
     var syncBlock = (0, _utils2.findSyncBlock)(state);
-    var localId = syncBlock === null || syncBlock === void 0 || (_syncBlock$node = syncBlock.node) === null || _syncBlock$node === void 0 || (_syncBlock$node = _syncBlock$node.attrs) === null || _syncBlock$node === void 0 ? void 0 : _syncBlock$node.localId;
-    if (!localId) {
+    var resourceId = syncBlock === null || syncBlock === void 0 || (_syncBlock$node = syncBlock.node) === null || _syncBlock$node === void 0 || (_syncBlock$node = _syncBlock$node.attrs) === null || _syncBlock$node === void 0 ? void 0 : _syncBlock$node.resourceId;
+    if (!resourceId) {
       return false;
     }
-    var syncBlockURL = syncBlockStore.getSyncBlockURL(localId);
+    var syncBlockURL = syncBlockStore.getSyncBlockURL(resourceId);
     if (syncBlockURL) {
       window.open(syncBlockURL, '_blank');
     } else {

package/dist/cjs/syncedBlockPlugin.js

@@ -14,8 +14,9 @@ var _editorActions = require("./editor-actions");
 var _editorCommands = require("./editor-commands");
 var _main = require("./pm-plugins/main");
 var _blockMenuComponents = require("./ui/block-menu-components");
-var _ContentComponent = require("./ui/ContentComponent");
+var _DeleteConfirmationModal = require("./ui/DeleteConfirmationModal");
 var _floatingToolbar = require("./ui/floating-toolbar");
+var _SyncBlockRefresher = require("./ui/SyncBlockRefresher");
 var syncedBlockPlugin = exports.syncedBlockPlugin = function syncedBlockPlugin(_ref) {
   var _api$blockMenu;
   var config = _ref.config,
@@ -86,9 +87,11 @@ var syncedBlockPlugin = exports.syncedBlockPlugin = function syncedBlockPlugin(_
       }
     },
     contentComponent: function contentComponent() {
-      return /*#__PURE__*/_react.default.createElement(_ContentComponent.ContentComponent, {
+      return /*#__PURE__*/_react.default.createElement(_react.default.Fragment, null, /*#__PURE__*/_react.default.createElement(_SyncBlockRefresher.SyncBlockRefresher, {
         syncBlockStoreManager: syncBlockStore
-      });
+      }), /*#__PURE__*/_react.default.createElement(_DeleteConfirmationModal.DeleteConfirmationModal, {
+        syncBlockStoreManager: syncBlockStore
+      }));
     }
   };
 };

package/dist/cjs/ui/{ContentComponent.js → DeleteConfirmationModal.js}

@@ -5,13 +5,13 @@ var _typeof = require("@babel/runtime/helpers/typeof");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.ContentComponent = void 0;
+exports.DeleteConfirmationModal = void 0;
 var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
 var _react = _interopRequireWildcard(require("react"));
 var _new = _interopRequireDefault(require("@atlaskit/button/new"));
 var _modalDialog = _interopRequireWildcard(require("@atlaskit/modal-dialog"));
 function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function _interopRequireWildcard(e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != _typeof(e) && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (var _t in e) "default" !== _t && {}.hasOwnProperty.call(e, _t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, _t)) && (i.get || i.set) ? o(f, _t, i) : f[_t] = e[_t]); return f; })(e, t); }
-var ContentComponent = exports.ContentComponent = function ContentComponent(_ref) {
+var DeleteConfirmationModal = exports.DeleteConfirmationModal = function DeleteConfirmationModal(_ref) {
   var syncBlockStoreManager = _ref.syncBlockStoreManager;
   var _useState = (0, _react.useState)(false),
     _useState2 = (0, _slicedToArray2.default)(_useState, 2),

package/dist/cjs/ui/SyncBlockRefresher.js

@@ -0,0 +1,27 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.SyncBlockRefresher = void 0;
+var _react = require("react");
+var REFRESH_INTERVAL = 3000;
+
+// Component that refreshes synced block subscriptions at regular intervals
+// this is a workaround for the subscription mechanism not being real-time
+var SyncBlockRefresher = exports.SyncBlockRefresher = function SyncBlockRefresher(_ref) {
+  var syncBlockStoreManager = _ref.syncBlockStoreManager;
+  (0, _react.useEffect)(function () {
+    var interval = window.setInterval(function () {
+      var _document;
+      // check if document is visible to avoid unnecessary refreshes
+      if (((_document = document) === null || _document === void 0 ? void 0 : _document.visibilityState) === 'visible') {
+        syncBlockStoreManager.refreshSubscriptions();
+      }
+    }, REFRESH_INTERVAL);
+    return function () {
+      window.clearInterval(interval);
+    };
+  }, [syncBlockStoreManager]);
+  return null;
+};

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

@@ -54,7 +54,7 @@ var getToolbarConfig = exports.getToolbarConfig = function getToolbarConfig(stat
     onClick: (0, _editorCommands.copySyncedBlockReferenceToClipboard)(api)
   }, hoverDecorationProps(nodeType, _consts.akEditorSelectedNodeClassName));
   items.push(copyButton);
-  var disabled = !syncBlockStore.getSyncBlockURL(syncBlockObject.node.attrs.localId);
+  var disabled = !syncBlockStore.getSyncBlockURL(syncBlockObject.node.attrs.resourceId);
   if (!isBodiedSyncBlock) {
     var editSourceButton = _objectSpread({
       id: 'editor.syncedBlock.editSource',

package/dist/es2019/editor-commands/index.js

@@ -88,11 +88,11 @@ export const copySyncedBlockReferenceToClipboard = api => (state, _dispatch, _vi
 export const editSyncedBlockSource = (syncBlockStore, api) => (state, dispatch, _view) => {
   var _syncBlock$node, _syncBlock$node$attrs;
   const syncBlock = findSyncBlock(state);
-  const localId = syncBlock === null || syncBlock === void 0 ? void 0 : (_syncBlock$node = syncBlock.node) === null || _syncBlock$node === void 0 ? void 0 : (_syncBlock$node$attrs = _syncBlock$node.attrs) === null || _syncBlock$node$attrs === void 0 ? void 0 : _syncBlock$node$attrs.localId;
-  if (!localId) {
+  const resourceId = syncBlock === null || syncBlock === void 0 ? void 0 : (_syncBlock$node = syncBlock.node) === null || _syncBlock$node === void 0 ? void 0 : (_syncBlock$node$attrs = _syncBlock$node.attrs) === null || _syncBlock$node$attrs === void 0 ? void 0 : _syncBlock$node$attrs.resourceId;
+  if (!resourceId) {
     return false;
   }
-  const syncBlockURL = syncBlockStore.getSyncBlockURL(localId);
+  const syncBlockURL = syncBlockStore.getSyncBlockURL(resourceId);
   if (syncBlockURL) {
     window.open(syncBlockURL, '_blank');
   } else {

package/dist/es2019/syncedBlockPlugin.js

@@ -7,8 +7,9 @@ import { flushBodiedSyncBlocks } from './editor-actions';
 import { createSyncedBlock } from './editor-commands';
 import { createPlugin } from './pm-plugins/main';
 import { getBlockMenuComponents } from './ui/block-menu-components';
-import { ContentComponent } from './ui/ContentComponent';
+import { DeleteConfirmationModal } from './ui/DeleteConfirmationModal';
 import { getToolbarConfig } from './ui/floating-toolbar';
+import { SyncBlockRefresher } from './ui/SyncBlockRefresher';
 export const syncedBlockPlugin = ({
   config,
   api
@@ -70,9 +71,11 @@ export const syncedBlockPlugin = ({
       floatingToolbar: (state, intl, providerFactory) => getToolbarConfig(state, intl, config, providerFactory, api, syncBlockStore)
     },
     contentComponent: () => {
-      return /*#__PURE__*/React.createElement(ContentComponent, {
+      return /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement(SyncBlockRefresher, {
         syncBlockStoreManager: syncBlockStore
-      });
+      }), /*#__PURE__*/React.createElement(DeleteConfirmationModal, {
+        syncBlockStoreManager: syncBlockStore
+      }));
     }
   };
 };

package/dist/es2019/ui/{ContentComponent.js → DeleteConfirmationModal.js}

@@ -1,7 +1,7 @@
 import React, { useCallback, useEffect, useState } from 'react';
 import Button from '@atlaskit/button/new';
 import ModalDialog, { ModalBody, ModalFooter, ModalHeader, ModalTitle, ModalTransition } from '@atlaskit/modal-dialog';
-export const ContentComponent = ({
+export const DeleteConfirmationModal = ({
   syncBlockStoreManager
 }) => {
   const [isOpen, setIsOpen] = useState(false);

package/dist/es2019/ui/SyncBlockRefresher.js

@@ -0,0 +1,22 @@
+import { useEffect } from 'react';
+const REFRESH_INTERVAL = 3000;
+
+// Component that refreshes synced block subscriptions at regular intervals
+// this is a workaround for the subscription mechanism not being real-time
+export const SyncBlockRefresher = ({
+  syncBlockStoreManager
+}) => {
+  useEffect(() => {
+    const interval = window.setInterval(() => {
+      var _document;
+      // check if document is visible to avoid unnecessary refreshes
+      if (((_document = document) === null || _document === void 0 ? void 0 : _document.visibilityState) === 'visible') {
+        syncBlockStoreManager.refreshSubscriptions();
+      }
+    }, REFRESH_INTERVAL);
+    return () => {
+      window.clearInterval(interval);
+    };
+  }, [syncBlockStoreManager]);
+  return null;
+};

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

@@ -45,7 +45,7 @@ export const getToolbarConfig = (state, intl, _options = {}, _providerFactory, a
     ...hoverDecorationProps(nodeType, akEditorSelectedNodeClassName)
   };
   items.push(copyButton);
-  const disabled = !syncBlockStore.getSyncBlockURL(syncBlockObject.node.attrs.localId);
+  const disabled = !syncBlockStore.getSyncBlockURL(syncBlockObject.node.attrs.resourceId);
   if (!isBodiedSyncBlock) {
     const editSourceButton = {
       id: 'editor.syncedBlock.editSource',

package/dist/esm/editor-commands/index.js

@@ -78,11 +78,11 @@ export var editSyncedBlockSource = function editSyncedBlockSource(syncBlockStore
   return function (state, dispatch, _view) {
     var _syncBlock$node;
     var syncBlock = findSyncBlock(state);
-    var localId = syncBlock === null || syncBlock === void 0 || (_syncBlock$node = syncBlock.node) === null || _syncBlock$node === void 0 || (_syncBlock$node = _syncBlock$node.attrs) === null || _syncBlock$node === void 0 ? void 0 : _syncBlock$node.localId;
-    if (!localId) {
+    var resourceId = syncBlock === null || syncBlock === void 0 || (_syncBlock$node = syncBlock.node) === null || _syncBlock$node === void 0 || (_syncBlock$node = _syncBlock$node.attrs) === null || _syncBlock$node === void 0 ? void 0 : _syncBlock$node.resourceId;
+    if (!resourceId) {
       return false;
     }
-    var syncBlockURL = syncBlockStore.getSyncBlockURL(localId);
+    var syncBlockURL = syncBlockStore.getSyncBlockURL(resourceId);
     if (syncBlockURL) {
       window.open(syncBlockURL, '_blank');
     } else {

package/dist/esm/syncedBlockPlugin.js

@@ -7,8 +7,9 @@ import { flushBodiedSyncBlocks as _flushBodiedSyncBlocks } from './editor-action
 import { createSyncedBlock } from './editor-commands';
 import { createPlugin } from './pm-plugins/main';
 import { getBlockMenuComponents } from './ui/block-menu-components';
-import { ContentComponent } from './ui/ContentComponent';
+import { DeleteConfirmationModal } from './ui/DeleteConfirmationModal';
 import { getToolbarConfig } from './ui/floating-toolbar';
+import { SyncBlockRefresher } from './ui/SyncBlockRefresher';
 export var syncedBlockPlugin = function syncedBlockPlugin(_ref) {
   var _api$blockMenu;
   var config = _ref.config,
@@ -79,9 +80,11 @@ export var syncedBlockPlugin = function syncedBlockPlugin(_ref) {
       }
     },
     contentComponent: function contentComponent() {
-      return /*#__PURE__*/React.createElement(ContentComponent, {
+      return /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement(SyncBlockRefresher, {
         syncBlockStoreManager: syncBlockStore
-      });
+      }), /*#__PURE__*/React.createElement(DeleteConfirmationModal, {
+        syncBlockStoreManager: syncBlockStore
+      }));
     }
   };
 };

package/dist/esm/ui/{ContentComponent.js → DeleteConfirmationModal.js}

@@ -2,7 +2,7 @@ import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
 import React, { useCallback, useEffect, useState } from 'react';
 import Button from '@atlaskit/button/new';
 import ModalDialog, { ModalBody, ModalFooter, ModalHeader, ModalTitle, ModalTransition } from '@atlaskit/modal-dialog';
-export var ContentComponent = function ContentComponent(_ref) {
+export var DeleteConfirmationModal = function DeleteConfirmationModal(_ref) {
   var syncBlockStoreManager = _ref.syncBlockStoreManager;
   var _useState = useState(false),
     _useState2 = _slicedToArray(_useState, 2),

package/dist/esm/ui/SyncBlockRefresher.js

@@ -0,0 +1,21 @@
+import { useEffect } from 'react';
+var REFRESH_INTERVAL = 3000;
+
+// Component that refreshes synced block subscriptions at regular intervals
+// this is a workaround for the subscription mechanism not being real-time
+export var SyncBlockRefresher = function SyncBlockRefresher(_ref) {
+  var syncBlockStoreManager = _ref.syncBlockStoreManager;
+  useEffect(function () {
+    var interval = window.setInterval(function () {
+      var _document;
+      // check if document is visible to avoid unnecessary refreshes
+      if (((_document = document) === null || _document === void 0 ? void 0 : _document.visibilityState) === 'visible') {
+        syncBlockStoreManager.refreshSubscriptions();
+      }
+    }, REFRESH_INTERVAL);
+    return function () {
+      window.clearInterval(interval);
+    };
+  }, [syncBlockStoreManager]);
+  return null;
+};

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

@@ -45,7 +45,7 @@ export var getToolbarConfig = function getToolbarConfig(state, intl) {
     onClick: copySyncedBlockReferenceToClipboard(api)
   }, hoverDecorationProps(nodeType, akEditorSelectedNodeClassName));
   items.push(copyButton);
-  var disabled = !syncBlockStore.getSyncBlockURL(syncBlockObject.node.attrs.localId);
+  var disabled = !syncBlockStore.getSyncBlockURL(syncBlockObject.node.attrs.resourceId);
   if (!isBodiedSyncBlock) {
     var editSourceButton = _objectSpread({
       id: 'editor.syncedBlock.editSource',

package/dist/{types-ts4.5/ui/ContentComponent.d.ts → types/ui/DeleteConfirmationModal.d.ts}

@@ -1,5 +1,5 @@
 import React from 'react';
 import type { SyncBlockStoreManager } from '@atlaskit/editor-synced-block-provider';
-export declare const ContentComponent: ({ syncBlockStoreManager, }: {
+export declare const DeleteConfirmationModal: ({ syncBlockStoreManager, }: {
     syncBlockStoreManager: SyncBlockStoreManager;
 }) => React.JSX.Element;

package/dist/types/ui/SyncBlockRefresher.d.ts

@@ -0,0 +1,4 @@
+import type { SyncBlockStoreManager } from '@atlaskit/editor-synced-block-provider';
+export declare const SyncBlockRefresher: ({ syncBlockStoreManager, }: {
+    syncBlockStoreManager: SyncBlockStoreManager;
+}) => null;

package/dist/{types/ui/ContentComponent.d.ts → types-ts4.5/ui/DeleteConfirmationModal.d.ts}

@@ -1,5 +1,5 @@
 import React from 'react';
 import type { SyncBlockStoreManager } from '@atlaskit/editor-synced-block-provider';
-export declare const ContentComponent: ({ syncBlockStoreManager, }: {
+export declare const DeleteConfirmationModal: ({ syncBlockStoreManager, }: {
     syncBlockStoreManager: SyncBlockStoreManager;
 }) => React.JSX.Element;

package/dist/types-ts4.5/ui/SyncBlockRefresher.d.ts

@@ -0,0 +1,4 @@
+import type { SyncBlockStoreManager } from '@atlaskit/editor-synced-block-provider';
+export declare const SyncBlockRefresher: ({ syncBlockStoreManager, }: {
+    syncBlockStoreManager: SyncBlockStoreManager;
+}) => null;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-synced-block",
-	"version": "3.9.2",
+	"version": "3.10.0",
 	"description": "SyncedBlock plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -38,7 +38,7 @@
 		"@atlaskit/editor-plugin-selection": "^6.1.0",
 		"@atlaskit/editor-prosemirror": "7.0.0",
 		"@atlaskit/editor-shared-styles": "^3.8.0",
-		"@atlaskit/editor-synced-block-provider": "^2.2.0",
+		"@atlaskit/editor-synced-block-provider": "^2.3.0",
 		"@atlaskit/editor-tables": "^2.9.0",
 		"@atlaskit/editor-toolbar": "^0.17.0",
 		"@atlaskit/icon": "28.5.3",