@atlaskit/editor-synced-block-provider 2.2.0 → 2.2.2

package/dist/esm/common/syncBlockStoreManager.js

@@ -1,370 +0,0 @@
-import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
-import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
-import _defineProperty from "@babel/runtime/helpers/defineProperty";
-import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
-import _createClass from "@babel/runtime/helpers/createClass";
-import _regeneratorRuntime from "@babel/runtime/regenerator";
-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) { _defineProperty(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; }
-import { useCallback, useEffect, useState } from 'react';
-import uuid from 'uuid';
-import { resourceIdFromSourceAndLocalId } from '../utils/ari';
-import { convertSyncBlockPMNodeToSyncBlockData, convertSyncBlockPMNodeToSyncBlockNode } from '../utils/utils';
-import { rebaseTransaction as _rebaseTransaction } from './rebase-transaction';
-import { SyncBlockStatus } from './types';
-
-// 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.
-export var SyncBlockStoreManager = /*#__PURE__*/function () {
-  function SyncBlockStoreManager(dataProvider) {
-    _classCallCheck(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 _createClass(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 = 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 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(syncBlockNode) {
-        var syncNode, data, sourceURL, fetchSyncBlockDataResult;
-        return _regeneratorRuntime.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 = 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 local cache
-     * @param syncBlockNode - The sync block node to update
-     */
-  }, {
-    key: "updateSyncBlockData",
-    value: function updateSyncBlockData(syncBlockNode) {
-      try {
-        if (!this.isSourceBlock(syncBlockNode)) {
-          throw new Error('Node is not a source sync block');
-        }
-        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: convertSyncBlockPMNodeToSyncBlockNode(syncBlockNode),
-          sourceURL: sourceURL,
-          syncBlockData: _objectSpread(_objectSpread({}, convertSyncBlockPMNodeToSyncBlockData(syncBlockNode)), {}, {
-            sourceDocumentAri: resourceId // same as resourceId ARI when content property API
-          })
-        };
-        this.syncBlocks.set(localId, syncBlock);
-      } catch (_unused) {
-        //TODO: EDITOR-1921 - add error analytics
-      }
-    }
-
-    /**
-     * 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
-     */
-  }, {
-    key: "flushBodiedSyncBlocks",
-    value: (function () {
-      var _flushBodiedSyncBlocks = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2() {
-        var bodiedSyncBlockNodes, bodiedSyncBlockData, resourceIds;
-        return _regeneratorRuntime.wrap(function _callee2$(_context2) {
-          while (1) switch (_context2.prev = _context2.next) {
-            case 0:
-              _context2.prev = 0;
-              if (this.dataProvider) {
-                _context2.next = 3;
-                break;
-              }
-              throw new Error('Data provider not set');
-            case 3:
-              bodiedSyncBlockNodes = [];
-              bodiedSyncBlockData = [];
-              Array.from(this.syncBlocks.values()).forEach(function (syncBlock) {
-                if (syncBlock.syncNode.type === 'bodiedSyncBlock') {
-                  bodiedSyncBlockNodes.push(syncBlock.syncNode);
-                  bodiedSyncBlockData.push(syncBlock.syncBlockData);
-                }
-              });
-              if (!(bodiedSyncBlockNodes.length === 0)) {
-                _context2.next = 8;
-                break;
-              }
-              return _context2.abrupt("return", Promise.resolve(true));
-            case 8:
-              _context2.next = 10;
-              return this.dataProvider.writeNodesData(bodiedSyncBlockNodes, bodiedSyncBlockData);
-            case 10:
-              resourceIds = _context2.sent;
-              return _context2.abrupt("return", resourceIds.every(function (resourceId) {
-                return resourceId !== undefined;
-              }));
-            case 14:
-              _context2.prev = 14;
-              _context2.t0 = _context2["catch"](0);
-              return _context2.abrupt("return", false);
-            case 17:
-            case "end":
-              return _context2.stop();
-          }
-        }, _callee2, this, [[0, 14]]);
-      }));
-      function flushBodiedSyncBlocks() {
-        return _flushBodiedSyncBlocks.apply(this, arguments);
-      }
-      return flushBodiedSyncBlocks;
-    }()
-    /**
-     * 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 === 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 = uuid();
-      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 = resourceIdFromSourceAndLocalId(sourceId, blockInstanceId);
-      var syncBlockNode = {
-        attrs: {
-          resourceId: resourceId,
-          localId: blockInstanceId
-        },
-        type: 'bodiedSyncBlock'
-      };
-      return syncBlockNode;
-    }
-  }, {
-    key: "deleteSyncBlocksWithConfirmation",
-    value: function () {
-      var _deleteSyncBlocksWithConfirmation = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee3(tr, syncBlockIds) {
-        var _this3 = this;
-        var confirmed, _this$editorView;
-        return _regeneratorRuntime.wrap(function _callee3$(_context3) {
-          while (1) switch (_context3.prev = _context3.next) {
-            case 0:
-              if (!this.confirmationCallback) {
-                _context3.next = 7;
-                break;
-              }
-              this.confirmationTransaction = tr;
-              _context3.next = 4;
-              return this.confirmationCallback();
-            case 4:
-              confirmed = _context3.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 _context3.stop();
-          }
-        }, _callee3, 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 = _rebaseTransaction(this.confirmationTransaction, incomingTr, state);
-    }
-  }]);
-}();
-export function useFetchSyncBlockData(manager, syncBlockNode) {
-  var _useState = useState(null),
-    _useState2 = _slicedToArray(_useState, 2),
-    fetchSyncBlockDataResult = _useState2[0],
-    setFetchSyncBlockDataResult = _useState2[1];
-  var fetchSyncBlockNode = 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: SyncBlockStatus.Errored
-        });
-      }
-    });
-  }, [manager, syncBlockNode, fetchSyncBlockDataResult]);
-  useEffect(function () {
-    fetchSyncBlockNode();
-    var interval = window.setInterval(fetchSyncBlockNode, 3000);
-    return function () {
-      window.clearInterval(interval);
-    };
-  }, [fetchSyncBlockNode]);
-  return fetchSyncBlockDataResult;
-}
-export function useHandleContentChanges(manager, syncBlockNode) {
-  useEffect(function () {
-    //TODO: EDITOR-1921 - add error analytics
-    manager.updateSyncBlockData(syncBlockNode);
-  }, [manager, syncBlockNode]);
-}