@atlaskit/editor-plugin-synced-block 4.0.1 → 4.1.0

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @atlaskit/editor-plugin-synced-block
 
+## 4.1.0
+
+### Minor Changes
+
+- [`261fa27c56fd0`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/261fa27c56fd0) -
+  EDITOR-2533 implement retry function for sync-block renderer
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 4.0.1
 
 ### Patch Changes

package/dist/cjs/nodeviews/syncedBlock.js

@@ -46,18 +46,23 @@ var SyncBlock = /*#__PURE__*/function (_ReactNodeView) {
       if (!((_this$options = this.options) !== null && _this$options !== void 0 && _this$options.getSyncedBlockRenderer)) {
         return null;
       }
+      var _this$node$attrs = this.node.attrs,
+        resourceId = _this$node$attrs.resourceId,
+        localId = _this$node$attrs.localId;
+      if (!resourceId || !localId) {
+        return null;
+      }
 
       // get document node from data provider
-
       return /*#__PURE__*/_react.default.createElement(_SyncBlockRendererWrapper.SyncBlockRendererWrapper, {
         localId: this.node.attrs.localId,
         getSyncedBlockRenderer: (_this$options2 = this.options) === null || _this$options2 === void 0 ? void 0 : _this$options2.getSyncedBlockRenderer,
         syncBlockRendererDataProviders: (_this$options3 = this.options) === null || _this$options3 === void 0 ? void 0 : _this$options3.syncBlockRendererDataProviders,
-        useFetchSyncBlockData: function useFetchSyncBlockData() {
-          return (0, _editorSyncedBlockProvider.useFetchSyncBlockData)(_this2.syncBlockStore, _this2.node);
-        },
         useFetchSyncBlockTitle: function useFetchSyncBlockTitle() {
           return (0, _editorSyncedBlockProvider.useFetchSyncBlockTitle)(_this2.syncBlockStore, _this2.node);
+        },
+        useFetchSyncBlockData: function useFetchSyncBlockData() {
+          return (0, _editorSyncedBlockProvider.useFetchSyncBlockData)(_this2.syncBlockStore, resourceId, localId);
         }
       });
     }
@@ -65,9 +70,6 @@ var SyncBlock = /*#__PURE__*/function (_ReactNodeView) {
     key: "destroy",
     value: function destroy() {
       var _this$unsubscribe;
-      if (this.fetchIntervalId) {
-        window.clearInterval(this.fetchIntervalId);
-      }
       (_this$unsubscribe = this.unsubscribe) === null || _this$unsubscribe === void 0 || _this$unsubscribe.call(this);
       _superPropGet(SyncBlock, "destroy", this, 3)([]);
     }

package/dist/cjs/ui/SyncBlockRefresher.js

@@ -3,9 +3,9 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.SyncBlockRefresher = void 0;
+exports.SyncBlockRefresher = exports.SYNC_BLOCK_FETCH_INTERVAL = void 0;
 var _react = require("react");
-var REFRESH_INTERVAL = 3000;
+var SYNC_BLOCK_FETCH_INTERVAL = exports.SYNC_BLOCK_FETCH_INTERVAL = 3000;
 
 // Component that refreshes synced block subscriptions at regular intervals
 // this is a workaround for the subscription mechanism not being real-time
@@ -18,7 +18,7 @@ var SyncBlockRefresher = exports.SyncBlockRefresher = function SyncBlockRefreshe
       if (((_document = document) === null || _document === void 0 ? void 0 : _document.visibilityState) === 'visible') {
         syncBlockStoreManager.refreshSubscriptions();
       }
-    }, REFRESH_INTERVAL);
+    }, SYNC_BLOCK_FETCH_INTERVAL);
     return function () {
       window.clearInterval(interval);
     };

package/dist/es2019/nodeviews/syncedBlock.js

@@ -19,22 +19,25 @@ class SyncBlock extends ReactNodeView {
     if (!((_this$options = this.options) !== null && _this$options !== void 0 && _this$options.getSyncedBlockRenderer)) {
       return null;
     }
+    const {
+      resourceId,
+      localId
+    } = this.node.attrs;
+    if (!resourceId || !localId) {
+      return null;
+    }
 
     // get document node from data provider
-
     return /*#__PURE__*/React.createElement(SyncBlockRendererWrapper, {
       localId: this.node.attrs.localId,
       getSyncedBlockRenderer: (_this$options2 = this.options) === null || _this$options2 === void 0 ? void 0 : _this$options2.getSyncedBlockRenderer,
       syncBlockRendererDataProviders: (_this$options3 = this.options) === null || _this$options3 === void 0 ? void 0 : _this$options3.syncBlockRendererDataProviders,
-      useFetchSyncBlockData: () => useFetchSyncBlockData(this.syncBlockStore, this.node),
-      useFetchSyncBlockTitle: () => useFetchSyncBlockTitle(this.syncBlockStore, this.node)
+      useFetchSyncBlockTitle: () => useFetchSyncBlockTitle(this.syncBlockStore, this.node),
+      useFetchSyncBlockData: () => useFetchSyncBlockData(this.syncBlockStore, resourceId, localId)
     });
   }
   destroy() {
     var _this$unsubscribe;
-    if (this.fetchIntervalId) {
-      window.clearInterval(this.fetchIntervalId);
-    }
     (_this$unsubscribe = this.unsubscribe) === null || _this$unsubscribe === void 0 ? void 0 : _this$unsubscribe.call(this);
     super.destroy();
   }

package/dist/es2019/ui/SyncBlockRefresher.js

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

package/dist/esm/nodeviews/syncedBlock.js

@@ -39,18 +39,23 @@ var SyncBlock = /*#__PURE__*/function (_ReactNodeView) {
       if (!((_this$options = this.options) !== null && _this$options !== void 0 && _this$options.getSyncedBlockRenderer)) {
         return null;
       }
+      var _this$node$attrs = this.node.attrs,
+        resourceId = _this$node$attrs.resourceId,
+        localId = _this$node$attrs.localId;
+      if (!resourceId || !localId) {
+        return null;
+      }
 
       // get document node from data provider
-
       return /*#__PURE__*/React.createElement(SyncBlockRendererWrapper, {
         localId: this.node.attrs.localId,
         getSyncedBlockRenderer: (_this$options2 = this.options) === null || _this$options2 === void 0 ? void 0 : _this$options2.getSyncedBlockRenderer,
         syncBlockRendererDataProviders: (_this$options3 = this.options) === null || _this$options3 === void 0 ? void 0 : _this$options3.syncBlockRendererDataProviders,
-        useFetchSyncBlockData: function useFetchSyncBlockData() {
-          return _useFetchSyncBlockData(_this2.syncBlockStore, _this2.node);
-        },
         useFetchSyncBlockTitle: function useFetchSyncBlockTitle() {
           return _useFetchSyncBlockTitle(_this2.syncBlockStore, _this2.node);
+        },
+        useFetchSyncBlockData: function useFetchSyncBlockData() {
+          return _useFetchSyncBlockData(_this2.syncBlockStore, resourceId, localId);
         }
       });
     }
@@ -58,9 +63,6 @@ var SyncBlock = /*#__PURE__*/function (_ReactNodeView) {
     key: "destroy",
     value: function destroy() {
       var _this$unsubscribe;
-      if (this.fetchIntervalId) {
-        window.clearInterval(this.fetchIntervalId);
-      }
       (_this$unsubscribe = this.unsubscribe) === null || _this$unsubscribe === void 0 || _this$unsubscribe.call(this);
       _superPropGet(SyncBlock, "destroy", this, 3)([]);
     }

package/dist/esm/ui/SyncBlockRefresher.js

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

package/dist/types/syncedBlockPluginType.d.ts

@@ -9,7 +9,7 @@ import type { DecorationsPlugin } from '@atlaskit/editor-plugin-decorations';
 import type { FloatingToolbarPlugin } from '@atlaskit/editor-plugin-floating-toolbar';
 import type { SelectionPlugin } from '@atlaskit/editor-plugin-selection';
 import type { EditorView } from '@atlaskit/editor-prosemirror/dist/types/view';
-import type { SyncBlockInstance, SyncBlockDataProvider } from '@atlaskit/editor-synced-block-provider';
+import type { SyncBlockDataProvider, UseFetchSyncBlockDataResult } from '@atlaskit/editor-synced-block-provider';
 export type SyncedBlockEditorProps = {
     defaultDocument: JSONDocNode;
     onChange: (editorView: EditorView, meta: {
@@ -34,7 +34,7 @@ export type SyncedBlockEditorProps = {
 };
 export type SyncedBlockRendererProps = {
     syncBlockRendererDataProviders: SyncedBlockRendererDataProviders;
-    useFetchSyncBlockData: () => SyncBlockInstance | null;
+    useFetchSyncBlockData: () => UseFetchSyncBlockDataResult;
 };
 export type SyncedBlockPluginOptions = {
     getSyncedBlockRenderer: (props: SyncedBlockRendererProps) => React.JSX.Element;

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

@@ -4,5 +4,5 @@ type SyncBlockLabelProps = {
     localId: string;
     useFetchSyncBlockTitle?: () => string | undefined;
 };
-export declare const SyncBlockLabel: React.MemoExoticComponent<({ isSource, useFetchSyncBlockTitle, localId }: SyncBlockLabelProps) => React.JSX.Element>;
+export declare const SyncBlockLabel: React.MemoExoticComponent<({ isSource, useFetchSyncBlockTitle, localId, }: SyncBlockLabelProps) => React.JSX.Element>;
 export {};

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

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

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

@@ -1,12 +1,12 @@
 import React from 'react';
 import type { SyncedBlockRendererDataProviders } from '@atlaskit/editor-common/provider-factory';
-import type { SyncBlockInstance } from '@atlaskit/editor-synced-block-provider';
+import type { UseFetchSyncBlockDataResult } from '@atlaskit/editor-synced-block-provider';
 import type { SyncedBlockRendererProps } from '../syncedBlockPluginType';
 type Props = {
     getSyncedBlockRenderer: (props: SyncedBlockRendererProps) => React.JSX.Element;
     localId: string;
     syncBlockRendererDataProviders: SyncedBlockRendererDataProviders;
-    useFetchSyncBlockData: () => SyncBlockInstance | null;
+    useFetchSyncBlockData: () => UseFetchSyncBlockDataResult;
     useFetchSyncBlockTitle: () => string | undefined;
 };
 export declare const SyncBlockRendererWrapper: React.MemoExoticComponent<({ getSyncedBlockRenderer, useFetchSyncBlockData, syncBlockRendererDataProviders, localId, useFetchSyncBlockTitle, }: Props) => React.JSX.Element>;

package/dist/types-ts4.5/syncedBlockPluginType.d.ts

@@ -9,7 +9,7 @@ import type { DecorationsPlugin } from '@atlaskit/editor-plugin-decorations';
 import type { FloatingToolbarPlugin } from '@atlaskit/editor-plugin-floating-toolbar';
 import type { SelectionPlugin } from '@atlaskit/editor-plugin-selection';
 import type { EditorView } from '@atlaskit/editor-prosemirror/dist/types/view';
-import type { SyncBlockInstance, SyncBlockDataProvider } from '@atlaskit/editor-synced-block-provider';
+import type { SyncBlockDataProvider, UseFetchSyncBlockDataResult } from '@atlaskit/editor-synced-block-provider';
 export type SyncedBlockEditorProps = {
     defaultDocument: JSONDocNode;
     onChange: (editorView: EditorView, meta: {
@@ -34,7 +34,7 @@ export type SyncedBlockEditorProps = {
 };
 export type SyncedBlockRendererProps = {
     syncBlockRendererDataProviders: SyncedBlockRendererDataProviders;
-    useFetchSyncBlockData: () => SyncBlockInstance | null;
+    useFetchSyncBlockData: () => UseFetchSyncBlockDataResult;
 };
 export type SyncedBlockPluginOptions = {
     getSyncedBlockRenderer: (props: SyncedBlockRendererProps) => React.JSX.Element;

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

@@ -4,5 +4,5 @@ type SyncBlockLabelProps = {
     localId: string;
     useFetchSyncBlockTitle?: () => string | undefined;
 };
-export declare const SyncBlockLabel: React.MemoExoticComponent<({ isSource, useFetchSyncBlockTitle, localId }: SyncBlockLabelProps) => React.JSX.Element>;
+export declare const SyncBlockLabel: React.MemoExoticComponent<({ isSource, useFetchSyncBlockTitle, localId, }: SyncBlockLabelProps) => React.JSX.Element>;
 export {};

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

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

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

@@ -1,12 +1,12 @@
 import React from 'react';
 import type { SyncedBlockRendererDataProviders } from '@atlaskit/editor-common/provider-factory';
-import type { SyncBlockInstance } from '@atlaskit/editor-synced-block-provider';
+import type { UseFetchSyncBlockDataResult } from '@atlaskit/editor-synced-block-provider';
 import type { SyncedBlockRendererProps } from '../syncedBlockPluginType';
 type Props = {
     getSyncedBlockRenderer: (props: SyncedBlockRendererProps) => React.JSX.Element;
     localId: string;
     syncBlockRendererDataProviders: SyncedBlockRendererDataProviders;
-    useFetchSyncBlockData: () => SyncBlockInstance | null;
+    useFetchSyncBlockData: () => UseFetchSyncBlockDataResult;
     useFetchSyncBlockTitle: () => string | undefined;
 };
 export declare const SyncBlockRendererWrapper: React.MemoExoticComponent<({ getSyncedBlockRenderer, useFetchSyncBlockData, syncBlockRendererDataProviders, localId, useFetchSyncBlockTitle, }: Props) => React.JSX.Element>;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-synced-block",
-	"version": "4.0.1",
+	"version": "4.1.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.5.0",
+		"@atlaskit/editor-synced-block-provider": "^2.6.0",
 		"@atlaskit/editor-tables": "^2.9.0",
 		"@atlaskit/editor-toolbar": "^0.17.0",
 		"@atlaskit/icon": "28.5.3",
@@ -52,7 +52,7 @@
 		"react-intl-next": "npm:react-intl@^5.18.1"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^110.21.0",
+		"@atlaskit/editor-common": "^110.22.0",
 		"react": "^18.2.0"
 	},
 	"devDependencies": {