@atlaskit/editor-synced-block-provider 2.1.2 → 2.2.1

package/dist/types-ts4.5/{common → providers}/syncBlockProvider.d.ts

@@ -1,5 +1,6 @@
 import type { JSONNode } from '@atlaskit/editor-json-transformer/types';
-import { SyncBlockDataProvider, type ADFFetchProvider, type ADFWriteProvider, type FetchSyncBlockDataResult, type SyncBlockData, type SyncBlockNode } from './types';
+import type { SyncBlockData, SyncBlockNode } from '../common/types';
+import { SyncBlockDataProvider, type ADFFetchProvider, type ADFWriteProvider, type FetchSyncBlockDataResult } from '../providers/types';
 export declare class SyncBlockProvider extends SyncBlockDataProvider {
     name: string;
     private fetchProvider;

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

@@ -0,0 +1,17 @@
+import { NodeDataProvider } from '@atlaskit/node-data-provider';
+import type { SyncBlockData, ResourceId, SyncBlockStatus, SyncBlockNode } from '../common/types';
+export type FetchSyncBlockDataResult = SyncBlockData | {
+    resourceId?: ResourceId;
+    status: SyncBlockStatus;
+};
+export interface ADFFetchProvider {
+    fetchData: (resourceId: ResourceId) => Promise<FetchSyncBlockDataResult>;
+}
+export interface ADFWriteProvider {
+    writeData: (data: SyncBlockData) => Promise<string>;
+}
+export declare abstract class SyncBlockDataProvider extends NodeDataProvider<SyncBlockNode, FetchSyncBlockDataResult> {
+    abstract writeNodesData(nodes: SyncBlockNode[], data: SyncBlockData[]): Promise<Array<ResourceId | undefined>>;
+    abstract getSourceId(): ResourceId;
+    abstract retrieveSyncBlockSourceUrl(node: SyncBlockNode): Promise<string | undefined>;
+}

package/dist/types-ts4.5/store-manager/referenceSyncBlockStoreManager.d.ts

@@ -0,0 +1,23 @@
+import { type Node as PMNode } from '@atlaskit/editor-prosemirror/model';
+import type { BlockInstanceId } from '../common/types';
+import type { FetchSyncBlockDataResult, SyncBlockDataProvider } from '../providers/types';
+export declare class ReferenceSyncBlockStoreManager {
+    private dataProvider?;
+    private syncBlockCache;
+    private syncBlockURLRequests;
+    constructor(dataProvider?: SyncBlockDataProvider);
+    /**
+     *
+     * @param localId - The local ID of the sync block to get the source URL for
+     * @param resourceId - The resource ID of the sync block to get the source URL for
+     * Fetches source URl for a sync block and updates sync block data with the source URL asynchronously.
+     */
+    private fetchSyncBlockSourceURL;
+    fetchSyncBlockData(syncBlockNode: PMNode): Promise<FetchSyncBlockDataResult>;
+    /**
+     * Get the URL for a sync block.
+     * @param localId - The local ID of the sync block to get the URL for
+     * @returns
+     */
+    getSyncBlockURL(localId: BlockInstanceId): string | undefined;
+}

package/dist/types-ts4.5/store-manager/sourceSyncBlockStoreManager.d.ts

@@ -0,0 +1,31 @@
+import { type Node as PMNode } from '@atlaskit/editor-prosemirror/model';
+import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
+import type { EditorView } from '@atlaskit/editor-prosemirror/view';
+import type { SyncBlockAttrs, SyncBlockNode } from '../common/types';
+import type { SyncBlockDataProvider } from '../providers/types';
+export type ConfirmationCallback = () => Promise<boolean>;
+export declare class SourceSyncBlockStoreManager {
+    private dataProvider?;
+    private editorView?;
+    private syncBlockCache;
+    private confirmationCallback?;
+    private confirmationTransaction?;
+    constructor(dataProvider?: SyncBlockDataProvider);
+    /**
+     * Add/update a sync block node to/from the local cache
+     * @param syncBlockNode - The sync block node to update
+     */
+    updateSyncBlockData(syncBlockNode: PMNode): void;
+    /**
+     * Save content of bodiedSyncBlock nodes in local cache to backend
+     *
+     * @returns true if saving all nodes successfully, false if fail to save some/all nodes
+     */
+    flushBodiedSyncBlocks(): Promise<boolean>;
+    setEditorView(editorView: EditorView | undefined): void;
+    registerConfirmationCallback(callback: ConfirmationCallback): () => void;
+    requireConfirmationBeforeDelete(): boolean;
+    createSyncBlockNode(): SyncBlockNode;
+    deleteSyncBlocksWithConfirmation(tr: Transaction, syncBlockIds: SyncBlockAttrs[]): Promise<void>;
+    rebaseTransaction(incomingTr: Transaction, state: EditorState): void;
+}

package/dist/types-ts4.5/store-manager/syncBlockStoreManager.d.ts

@@ -0,0 +1,36 @@
+import type { EditorView } from '@atlaskit/editor-prosemirror/dist/types/view';
+import { type Node as PMNode } from '@atlaskit/editor-prosemirror/model';
+import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
+import type { BlockInstanceId, SyncBlockAttrs, SyncBlockNode } from '../common/types';
+import type { FetchSyncBlockDataResult, SyncBlockDataProvider } from '../providers/types';
+import { type ConfirmationCallback } from './sourceSyncBlockStoreManager';
+export declare class SyncBlockStoreManager {
+    private referenceSyncBlockStoreManager;
+    private sourceSyncBlockStoreManager;
+    constructor(dataProvider?: SyncBlockDataProvider);
+    fetchSyncBlockData(syncBlockNode: PMNode): Promise<FetchSyncBlockDataResult | undefined>;
+    /**
+     * Add/update a sync block node to/from the local cache
+     * @param syncBlockNode - The sync block node to update
+     */
+    updateSyncBlockData(syncBlockNode: PMNode): void;
+    /**
+     * Save content of bodiedSyncBlock nodes in local cache to backend
+     *
+     * @returns true if saving all nodes successfully, false if fail to save some/all nodes
+     */
+    flushBodiedSyncBlocks(): Promise<boolean>;
+    /**
+     * Get the URL for a sync block.
+     * @param localId - The local ID of the sync block to get the URL for
+     * @returns
+     */
+    getSyncBlockURL(localId: BlockInstanceId): string | undefined;
+    setEditorView(editorView: EditorView | undefined): void;
+    isSourceBlock(node: PMNode): boolean;
+    registerConfirmationCallback(callback: ConfirmationCallback): () => void;
+    requireConfirmationBeforeDelete(): boolean;
+    createSyncBlockNode(): SyncBlockNode;
+    deleteSyncBlocksWithConfirmation(tr: Transaction, syncBlockIds: SyncBlockAttrs[]): Promise<void>;
+    rebaseTransaction(incomingTr: Transaction, state: EditorState): void;
+}

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

@@ -1,6 +1,5 @@
 import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
-import type { SyncBlockData, SyncBlockNode } from '../common/types';
+import type { SyncBlockData } from '../common/types';
 import type { PAGE_TYPE } from './ari';
-export declare const convertSyncBlockPMNodeToSyncBlockNode: (node: PMNode, includeContent?: boolean) => SyncBlockNode;
 export declare const convertSyncBlockPMNodeToSyncBlockData: (node: PMNode) => SyncBlockData;
 export declare const isBlogPageType: (pageType: PAGE_TYPE) => boolean;

package/package.json

@@ -29,8 +29,8 @@
 		"@atlaskit/css": "^0.15.0",
 		"@atlaskit/editor-json-transformer": "^8.31.0",
 		"@atlaskit/editor-prosemirror": "7.0.0",
-		"@atlaskit/node-data-provider": "^7.2.0",
-		"@atlaskit/primitives": "^16.0.0",
+		"@atlaskit/node-data-provider": "^7.3.0",
+		"@atlaskit/primitives": "^16.1.0",
 		"@atlaskit/tokens": "^7.0.0",
 		"@babel/runtime": "^7.0.0",
 		"@compiled/react": "^0.18.6",
@@ -82,7 +82,7 @@
 		}
 	},
 	"name": "@atlaskit/editor-synced-block-provider",
-	"version": "2.1.2",
+	"version": "2.2.1",
 	"description": "Synced Block Provider for @atlaskit/editor-plugin-synced-block",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",

package/dist/cjs/common/syncBlockStoreManager.js

@@ -1,330 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.SyncBlockStoreManager = void 0;
-exports.useFetchSyncBlockData = useFetchSyncBlockData;
-exports.useHandleContentChanges = useHandleContentChanges;
-var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
-var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
-var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
-var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
-var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
-var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
-var _react = require("react");
-var _uuid = _interopRequireDefault(require("uuid"));
-var _ari = require("../utils/ari");
-var _utils = require("../utils/utils");
-var _rebaseTransaction2 = require("./rebase-transaction");
-var _types = require("./types");
-function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
-function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
-// Do this typedef to make it clear that
-// this is a local identifier for a resource for local use
-// A store manager responsible for the lifecycle and state management of sync blocks in an editor instance.
-// Supports create, read, update, and delete operations for sync blocks.
-// Designed to manage local in-memory state and synchronize with an external data provider.
-// Handles caching, debouncing updates, and publish/subscribe for local changes.
-// Ensures consistency between local and remote state, and can be used in both editor and renderer contexts.
-var SyncBlockStoreManager = exports.SyncBlockStoreManager = /*#__PURE__*/function () {
-  function SyncBlockStoreManager(dataProvider) {
-    (0, _classCallCheck2.default)(this, SyncBlockStoreManager);
-    this.syncBlocks = new Map();
-    this.syncBlockURLRequests = new Map();
-    this.dataProvider = dataProvider;
-  }
-
-  /**
-   *
-   * @param node - The sync block node to get the source URL for
-   * @returns The source URL for the sync block node if it exists. Otherwise trigger fetch and return undefined, syncBlock will update with URL asynchronously.
-   */
-  return (0, _createClass2.default)(SyncBlockStoreManager, [{
-    key: "getSyncBlockSourceURL",
-    value: function getSyncBlockSourceURL(node) {
-      var _this = this;
-      var _node$attrs = node.attrs,
-        localId = _node$attrs.localId,
-        resourceId = _node$attrs.resourceId;
-      if (!localId || !resourceId || !this.dataProvider) {
-        return undefined;
-      }
-      var existingSyncBlock = this.syncBlocks.get(localId);
-      if (!existingSyncBlock) {
-        return undefined;
-      }
-      var sourceURL = existingSyncBlock.sourceURL;
-      if (sourceURL) {
-        return sourceURL;
-      }
-
-      // if the sync block is a reference block, we need to fetch the URL to the source
-      // we could optimise this further by checking if the sync block is on the same page as the source
-      if (!this.isSourceBlock(node) && !this.syncBlockURLRequests.get(localId)) {
-        var syncBlockNode = (0, _utils.convertSyncBlockPMNodeToSyncBlockNode)(node, false);
-        this.syncBlockURLRequests.set(localId, true);
-        this.dataProvider.retrieveSyncBlockSourceUrl(syncBlockNode).then(function (sourceURL) {
-          var existingSyncBlock = _this.syncBlocks.get(localId);
-          if (existingSyncBlock) {
-            var syncBlock = _objectSpread(_objectSpread({}, existingSyncBlock), {}, {
-              sourceURL: sourceURL
-            });
-            _this.syncBlocks.set(localId, syncBlock);
-          }
-        }).finally(function () {
-          _this.syncBlockURLRequests.set(localId, false);
-        });
-      }
-      return undefined;
-    }
-  }, {
-    key: "fetchSyncBlockData",
-    value: function () {
-      var _fetchSyncBlockData = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(syncBlockNode) {
-        var syncNode, data, sourceURL, fetchSyncBlockDataResult;
-        return _regenerator.default.wrap(function _callee$(_context) {
-          while (1) switch (_context.prev = _context.next) {
-            case 0:
-              if (['bodiedSyncBlock', 'syncBlock'].includes(syncBlockNode.type.name)) {
-                _context.next = 2;
-                break;
-              }
-              throw new Error('Node is not a sync block');
-            case 2:
-              syncNode = (0, _utils.convertSyncBlockPMNodeToSyncBlockNode)(syncBlockNode, false);
-              if (this.dataProvider) {
-                _context.next = 5;
-                break;
-              }
-              throw new Error('Data provider not set');
-            case 5:
-              _context.next = 7;
-              return this.dataProvider.fetchNodesData([syncNode]);
-            case 7:
-              data = _context.sent;
-              if (data) {
-                _context.next = 10;
-                break;
-              }
-              throw new Error('Failed to fetch sync block node data');
-            case 10:
-              sourceURL = this.getSyncBlockSourceURL(syncBlockNode);
-              fetchSyncBlockDataResult = data[0];
-              if (!('status' in fetchSyncBlockDataResult)) {
-                // only adds it to the map if it did not error out
-                this.syncBlocks.set(syncBlockNode.attrs.localId, {
-                  syncNode: syncNode,
-                  sourceURL: sourceURL,
-                  syncBlockData: fetchSyncBlockDataResult
-                });
-              }
-              return _context.abrupt("return", fetchSyncBlockDataResult);
-            case 14:
-            case "end":
-              return _context.stop();
-          }
-        }, _callee, this);
-      }));
-      function fetchSyncBlockData(_x) {
-        return _fetchSyncBlockData.apply(this, arguments);
-      }
-      return fetchSyncBlockData;
-    }()
-    /**
-     * Add/update a sync block node to/from the store.
-     * @param syncBlockNode - The sync block node to update
-     * @param newContent - The updated node content to use for the sync block node
-     * @returns True if the sync block node was added/updated
-     */
-  }, {
-    key: "updateSyncBlockData",
-    value: function updateSyncBlockData(syncBlockNode) {
-      if (!this.isSourceBlock(syncBlockNode)) {
-        throw new Error('Node is not a source sync block');
-      }
-      if (!this.dataProvider) {
-        throw new Error('Data provider not set');
-      }
-      var _syncBlockNode$attrs = syncBlockNode.attrs,
-        localId = _syncBlockNode$attrs.localId,
-        resourceId = _syncBlockNode$attrs.resourceId;
-      if (!localId || !resourceId) {
-        throw new Error('Local ID or resource ID is not set');
-      }
-      var existingSyncBlock = this.syncBlocks.get(localId);
-      var sourceURL = existingSyncBlock === null || existingSyncBlock === void 0 ? void 0 : existingSyncBlock.sourceURL;
-      var syncBlock = {
-        syncNode: (0, _utils.convertSyncBlockPMNodeToSyncBlockNode)(syncBlockNode),
-        sourceURL: sourceURL,
-        syncBlockData: _objectSpread(_objectSpread({}, (0, _utils.convertSyncBlockPMNodeToSyncBlockData)(syncBlockNode)), {}, {
-          sourceDocumentAri: resourceId // same as resourceId ARI when content property API
-        })
-      };
-      this.syncBlocks.set(localId, syncBlock);
-
-      //TODO: EDITOR-1921 - add error analytics
-      return !this.isSourceBlock(syncBlockNode) ? Promise.resolve(true) : this.dataProvider.writeNodesData([syncBlock.syncNode], [syncBlock.syncBlockData]).then(function (resourceIds) {
-        return resourceIds.every(function (resourceId) {
-          return resourceId !== undefined;
-        });
-      }).catch(function () {
-        return false;
-      });
-    }
-
-    /**
-     * Get the URL for a sync block.
-     * @param localId - The local ID of the sync block to get the URL for
-     * @returns
-     */
-  }, {
-    key: "getSyncBlockURL",
-    value: function getSyncBlockURL(localId) {
-      var syncBlock = this.syncBlocks.get(localId);
-      return syncBlock === null || syncBlock === void 0 ? void 0 : syncBlock.sourceURL;
-    }
-  }, {
-    key: "setEditorView",
-    value: function setEditorView(editorView) {
-      this.editorView = editorView;
-    }
-  }, {
-    key: "isSourceBlock",
-    value: function isSourceBlock(node) {
-      var _this$dataProvider;
-      if (node.type.name !== 'bodiedSyncBlock') {
-        return false;
-      }
-      var _node$attrs2 = node.attrs,
-        resourceId = _node$attrs2.resourceId,
-        localId = _node$attrs2.localId;
-      var sourceId = (_this$dataProvider = this.dataProvider) === null || _this$dataProvider === void 0 ? void 0 : _this$dataProvider.getSourceId();
-      if (!sourceId) {
-        return false;
-      }
-      return typeof resourceId === 'string' && typeof sourceId === 'string' && typeof localId === 'string' && resourceId === (0, _ari.resourceIdFromSourceAndLocalId)(sourceId, localId);
-    }
-  }, {
-    key: "registerConfirmationCallback",
-    value: function registerConfirmationCallback(callback) {
-      var _this2 = this;
-      this.confirmationCallback = callback;
-      return function () {
-        _this2.confirmationCallback = undefined;
-      };
-    }
-  }, {
-    key: "requireConfirmationBeforeDelete",
-    value: function requireConfirmationBeforeDelete() {
-      return !!this.confirmationCallback;
-    }
-  }, {
-    key: "createSyncBlockNode",
-    value: function createSyncBlockNode() {
-      var _this$dataProvider2;
-      var blockInstanceId = (0, _uuid.default)();
-      var sourceId = (_this$dataProvider2 = this.dataProvider) === null || _this$dataProvider2 === void 0 ? void 0 : _this$dataProvider2.getSourceId();
-      if (!sourceId) {
-        throw new Error('Provider of sync block plugin is not set');
-      }
-
-      // This should be generated by the data provider implementation as it differs between data providers
-      var resourceId = (0, _ari.resourceIdFromSourceAndLocalId)(sourceId, blockInstanceId);
-      var syncBlockNode = {
-        attrs: {
-          resourceId: resourceId,
-          localId: blockInstanceId
-        },
-        type: 'syncBlock'
-      };
-      return syncBlockNode;
-    }
-  }, {
-    key: "deleteSyncBlocksWithConfirmation",
-    value: function () {
-      var _deleteSyncBlocksWithConfirmation = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(tr, syncBlockIds) {
-        var _this3 = this;
-        var confirmed, _this$editorView;
-        return _regenerator.default.wrap(function _callee2$(_context2) {
-          while (1) switch (_context2.prev = _context2.next) {
-            case 0:
-              if (!this.confirmationCallback) {
-                _context2.next = 7;
-                break;
-              }
-              this.confirmationTransaction = tr;
-              _context2.next = 4;
-              return this.confirmationCallback();
-            case 4:
-              confirmed = _context2.sent;
-              if (confirmed) {
-                (_this$editorView = this.editorView) === null || _this$editorView === void 0 || _this$editorView.dispatch(this.confirmationTransaction.setMeta('isConfirmedSyncBlockDeletion', true));
-                // Need to update the BE on deletion
-                syncBlockIds.forEach(function (_ref) {
-                  var localId = _ref.localId;
-                  return _this3.syncBlocks.delete(localId);
-                });
-              }
-              this.confirmationTransaction = undefined;
-            case 7:
-            case "end":
-              return _context2.stop();
-          }
-        }, _callee2, this);
-      }));
-      function deleteSyncBlocksWithConfirmation(_x2, _x3) {
-        return _deleteSyncBlocksWithConfirmation.apply(this, arguments);
-      }
-      return deleteSyncBlocksWithConfirmation;
-    }()
-  }, {
-    key: "rebaseTransaction",
-    value: function rebaseTransaction(incomingTr, state) {
-      if (!this.confirmationTransaction) {
-        return;
-      }
-      this.confirmationTransaction = (0, _rebaseTransaction2.rebaseTransaction)(this.confirmationTransaction, incomingTr, state);
-    }
-  }]);
-}();
-function useFetchSyncBlockData(manager, syncBlockNode) {
-  var _useState = (0, _react.useState)(null),
-    _useState2 = (0, _slicedToArray2.default)(_useState, 2),
-    fetchSyncBlockDataResult = _useState2[0],
-    setFetchSyncBlockDataResult = _useState2[1];
-  var fetchSyncBlockNode = (0, _react.useCallback)(function () {
-    manager.fetchSyncBlockData(syncBlockNode).then(function (data) {
-      if ('status' in data) {
-        // if there is an error, we don't want to replace real existing data with the error data
-        if (!fetchSyncBlockDataResult || 'status' in fetchSyncBlockDataResult) {
-          setFetchSyncBlockDataResult(data);
-        }
-      } else {
-        setFetchSyncBlockDataResult(data);
-      }
-    }).catch(function () {
-      //TODO: EDITOR-1921 - add error analytics
-      if (!fetchSyncBlockDataResult || 'status' in fetchSyncBlockDataResult) {
-        setFetchSyncBlockDataResult({
-          status: _types.SyncBlockStatus.Errored
-        });
-      }
-    });
-  }, [manager, syncBlockNode, fetchSyncBlockDataResult]);
-  (0, _react.useEffect)(function () {
-    fetchSyncBlockNode();
-    var interval = window.setInterval(fetchSyncBlockNode, 3000);
-    return function () {
-      window.clearInterval(interval);
-    };
-  }, [fetchSyncBlockNode]);
-  return fetchSyncBlockDataResult;
-}
-function useHandleContentChanges(manager, syncBlockNode) {
-  (0, _react.useEffect)(function () {
-    //TODO: EDITOR-1921 - add error analytics
-    manager.updateSyncBlockData(syncBlockNode);
-  }, [manager, syncBlockNode]);
-}