@atlaskit/editor-plugin-synced-block 5.3.13 → 5.3.14

package/dist/esm/pm-plugins/utils/handle-bodied-sync-block-creation.js

@@ -0,0 +1,134 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+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 { TextSelection } from '@atlaskit/editor-prosemirror/state';
+import { FLAG_ID } from '../../types';
+import { syncedBlockPluginKey } from '../main';
+var onRetry = function onRetry(api, resourceId) {
+  return function () {
+    var _api$core, _api$core2;
+    api === null || api === void 0 || (_api$core = api.core) === null || _api$core === void 0 || _api$core.actions.focus();
+    api === null || api === void 0 || (_api$core2 = api.core) === null || _api$core2 === void 0 || _api$core2.actions.execute(function (_ref) {
+      var _api$syncedBlock, _api$syncedBlock2;
+      var tr = _ref.tr;
+      var pos = api === null || api === void 0 || (_api$syncedBlock = api.syncedBlock) === null || _api$syncedBlock === void 0 || (_api$syncedBlock = _api$syncedBlock.sharedState.currentState()) === null || _api$syncedBlock === void 0 || (_api$syncedBlock = _api$syncedBlock.retryCreationPosMap) === null || _api$syncedBlock === void 0 ? void 0 : _api$syncedBlock.get(resourceId);
+      var from = pos === null || pos === void 0 ? void 0 : pos.from;
+      var to = pos === null || pos === void 0 ? void 0 : pos.to;
+      if (from === undefined || to === undefined) {
+        return tr;
+      }
+      tr.setSelection(TextSelection.create(tr.doc, from, to)).setMeta(syncedBlockPluginKey, {
+        activeFlag: false
+      });
+      api === null || api === void 0 || (_api$syncedBlock2 = api.syncedBlock) === null || _api$syncedBlock2 === void 0 || _api$syncedBlock2.commands.insertSyncedBlock()({
+        tr: tr
+      });
+      return tr;
+    });
+  };
+};
+var getRevertCreationPos = function getRevertCreationPos(api, doc, resourceId) {
+  var _api$syncedBlock3;
+  var retryCreationPos = api === null || api === void 0 || (_api$syncedBlock3 = api.syncedBlock) === null || _api$syncedBlock3 === void 0 || (_api$syncedBlock3 = _api$syncedBlock3.sharedState.currentState()) === null || _api$syncedBlock3 === void 0 || (_api$syncedBlock3 = _api$syncedBlock3.retryCreationPosMap) === null || _api$syncedBlock3 === void 0 ? void 0 : _api$syncedBlock3.get(resourceId);
+  if (retryCreationPos) {
+    return retryCreationPos;
+  }
+
+  // Fallback to find the positions in case BE call returns before plugin state becomes available
+  // which is highly unlikely
+  var currentPos;
+  doc.descendants(function (node, pos) {
+    if (currentPos) {
+      return false;
+    }
+    if (node.type.name === 'bodiedSyncBlock' && resourceId === node.attrs.resourceId) {
+      currentPos = {
+        from: pos,
+        to: pos + node.nodeSize
+      };
+      return false;
+    }
+  });
+  return currentPos;
+};
+var buildRevertCreationTr = function buildRevertCreationTr(tr, pos) {
+  var _tr$doc$nodeAt;
+  var content = (_tr$doc$nodeAt = tr.doc.nodeAt(pos.from)) === null || _tr$doc$nodeAt === void 0 ? void 0 : _tr$doc$nodeAt.content;
+  if (content) {
+    tr.replaceWith(pos.from, pos.to, content);
+    var contentFrom = tr.mapping.map(pos.from);
+    tr.setSelection(TextSelection.create(tr.doc, contentFrom, contentFrom + content.size));
+  } else {
+    tr.delete(pos.from, pos.to);
+  }
+  return tr;
+};
+
+/**
+ *
+ * Save the new bodiedSyncBlock to backend with empty content and handles revert (if failed) and retry flow
+ */
+export var handleBodiedSyncBlockCreation = function handleBodiedSyncBlockCreation(bodiedSyncBlockAdded, editorState, api) {
+  var syncBlockStore = syncedBlockPluginKey.getState(editorState).syncBlockStore;
+  bodiedSyncBlockAdded.forEach(function (node) {
+    if (node.from === undefined || node.to === undefined) {
+      return;
+    }
+    var retryCreationPos = {
+      from: node.from,
+      to: node.to
+    };
+    var resourceId = node.attrs.resourceId;
+    setTimeout(function () {
+      var _api$core3;
+      api === null || api === void 0 || (_api$core3 = api.core) === null || _api$core3 === void 0 || _api$core3.actions.execute(function (_ref2) {
+        var tr = _ref2.tr;
+        return tr.setMeta(syncedBlockPluginKey, {
+          retryCreationPos: {
+            resourceId: resourceId,
+            pos: retryCreationPos
+          }
+        });
+      });
+    });
+    syncBlockStore.sourceManager.createBodiedSyncBlockNode(node.attrs, function (success) {
+      if (success) {
+        var _api$core4, _api$core5;
+        api === null || api === void 0 || (_api$core4 = api.core) === null || _api$core4 === void 0 || _api$core4.actions.execute(function (_ref3) {
+          var tr = _ref3.tr;
+          return tr.setMeta(syncedBlockPluginKey, {
+            retryCreationPos: {
+              resourceId: resourceId,
+              pos: undefined
+            }
+          });
+        });
+        api === null || api === void 0 || (_api$core5 = api.core) === null || _api$core5 === void 0 || _api$core5.actions.focus();
+      } else {
+        var _api$core6;
+        api === null || api === void 0 || (_api$core6 = api.core) === null || _api$core6 === void 0 || _api$core6.actions.execute(function (_ref4) {
+          var tr = _ref4.tr;
+          var revertCreationPos = getRevertCreationPos(api, tr.doc, resourceId);
+          if (!revertCreationPos) {
+            return tr;
+          }
+          var revertTr = buildRevertCreationTr(tr, revertCreationPos);
+          return revertTr.setMeta('isConfirmedSyncBlockDeletion', true).setMeta('addToHistory', false).setMeta(syncedBlockPluginKey, {
+            activeFlag: {
+              id: FLAG_ID.CANNOT_CREATE_SYNC_BLOCK,
+              onRetry: onRetry(api, resourceId),
+              onDismissed: function onDismissed(tr) {
+                return tr.setMeta(syncedBlockPluginKey, _objectSpread(_objectSpread({}, tr.getMeta(syncedBlockPluginKey)), {}, {
+                  retryCreationPos: {
+                    resourceId: resourceId,
+                    pos: undefined
+                  }
+                }));
+              }
+            }
+          });
+        });
+      }
+    }, node.node);
+  });
+};

package/dist/esm/pm-plugins/utils/track-sync-blocks.js

@@ -69,6 +69,7 @@ export var trackSyncBlocks = function trackSyncBlocks(predicate, tr, state) {
         var syncBlockAttr = node.attrs;
         syncBlockMapNew[syncBlockAttr.localId] = {
           attrs: syncBlockAttr,
+          node: node,
           from: offset,
           to: offset + node.nodeSize
         };

package/dist/esm/syncedBlockPlugin.js

@@ -143,11 +143,13 @@ export var syncedBlockPlugin = function syncedBlockPlugin(_ref) {
       var _syncedBlockPluginKey = syncedBlockPluginKey.getState(editorState),
         activeFlag = _syncedBlockPluginKey.activeFlag,
         currentSyncBlockStore = _syncedBlockPluginKey.syncBlockStore,
-        bodiedSyncBlockDeletionStatus = _syncedBlockPluginKey.bodiedSyncBlockDeletionStatus;
+        bodiedSyncBlockDeletionStatus = _syncedBlockPluginKey.bodiedSyncBlockDeletionStatus,
+        retryCreationPosMap = _syncedBlockPluginKey.retryCreationPosMap;
       return {
         activeFlag: activeFlag,
         syncBlockStore: currentSyncBlockStore,
-        bodiedSyncBlockDeletionStatus: bodiedSyncBlockDeletionStatus
+        bodiedSyncBlockDeletionStatus: bodiedSyncBlockDeletionStatus,
+        retryCreationPosMap: retryCreationPosMap
       };
     }
   };

package/dist/esm/types/index.js

@@ -5,6 +5,7 @@ export var FLAG_ID = /*#__PURE__*/function (FLAG_ID) {
   FLAG_ID["FAIL_TO_DELETE"] = "fail-to-delete";
   FLAG_ID["SYNC_BLOCK_COPIED"] = "sync-block-copied";
   FLAG_ID["UNPUBLISHED_SYNC_BLOCK_PASTED"] = "unpublished-sync-block-pasted";
+  FLAG_ID["CANNOT_CREATE_SYNC_BLOCK"] = "cannot-create-sync-block";
   return FLAG_ID;
 }({});
 export var SYNCED_BLOCK_BUTTON_TEST_ID = {

package/dist/esm/ui/Flag.js

@@ -11,7 +11,7 @@ import StatusSuccessIcon from '@atlaskit/icon/core/status-success';
 import StatusWarningIcon from '@atlaskit/icon/core/status-warning';
 import { syncedBlockPluginKey } from '../pm-plugins/main';
 import { FLAG_ID } from '../types';
-var flagMap = _defineProperty(_defineProperty(_defineProperty(_defineProperty(_defineProperty(_defineProperty({}, FLAG_ID.CANNOT_DELETE_WHEN_OFFLINE, {
+var flagMap = _defineProperty(_defineProperty(_defineProperty(_defineProperty(_defineProperty(_defineProperty(_defineProperty({}, FLAG_ID.CANNOT_DELETE_WHEN_OFFLINE, {
   title: messages.failToDeleteTitle,
   description: messages.failToDeleteWhenOfflineDescription,
   type: 'error'
@@ -34,6 +34,10 @@ var flagMap = _defineProperty(_defineProperty(_defineProperty(_defineProperty(_d
   title: messages.unpublishedSyncBlockPastedTitle,
   description: messages.unpublishedSyncBlockPastedDescription,
   type: 'info'
+}), FLAG_ID.CANNOT_CREATE_SYNC_BLOCK, {
+  title: messages.cannotCreateSyncBlockTitle,
+  description: messages.CannotCreateSyncBlockDescription,
+  type: 'error'
 });
 export var Flag = function Flag(_ref) {
   var api = _ref.api;

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

@@ -23,6 +23,9 @@ export var getToolbarConfig = function getToolbarConfig(state, intl, api, syncBl
   if (!syncBlockObject) {
     return;
   }
+  if (syncBlockStore.sourceManager.isPendingCreation(syncBlockObject.node.attrs.resourceId) && fg('platform_synced_block_patch_1')) {
+    return;
+  }
   var syncBlockInstance = syncBlockStore.referenceManager.getFromCache(syncBlockObject.node.attrs.resourceId);
   var isUnsyncedBlock = (syncBlockInstance === null || syncBlockInstance === void 0 || (_syncBlockInstance$er = syncBlockInstance.error) === null || _syncBlockInstance$er === void 0 ? void 0 : _syncBlockInstance$er.type) === SyncBlockError.NotFound;
   var isErroredBlock = syncBlockInstance === null || syncBlockInstance === void 0 ? void 0 : syncBlockInstance.error;

package/dist/types/pm-plugins/main.d.ts

@@ -4,11 +4,12 @@ import { PluginKey } from '@atlaskit/editor-prosemirror/state';
 import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
 import { type SyncBlockStoreManager } from '@atlaskit/editor-synced-block-provider';
 import type { SyncedBlockPlugin, SyncedBlockPluginOptions } from '../syncedBlockPluginType';
-import { type ActiveFlag, type BodiedSyncBlockDeletionStatus } from '../types';
+import { type ActiveFlag, type BodiedSyncBlockDeletionStatus, type RetryCreationPosMap } from '../types';
 export declare const syncedBlockPluginKey: PluginKey<any>;
 type SyncedBlockPluginState = {
     activeFlag: ActiveFlag;
     bodiedSyncBlockDeletionStatus?: BodiedSyncBlockDeletionStatus;
+    retryCreationPosMap: RetryCreationPosMap;
     selectionDecorationSet: DecorationSet;
     syncBlockStore: SyncBlockStoreManager;
 };

package/dist/types/pm-plugins/utils/handle-bodied-sync-block-creation.d.ts

@@ -0,0 +1,9 @@
+import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import { type EditorState } from '@atlaskit/editor-prosemirror/state';
+import type { SyncedBlockPlugin } from '../../syncedBlockPluginType';
+import { type SyncBlockInfo } from '../../types';
+/**
+ *
+ * Save the new bodiedSyncBlock to backend with empty content and handles revert (if failed) and retry flow
+ */
+export declare const handleBodiedSyncBlockCreation: (bodiedSyncBlockAdded: SyncBlockInfo[], editorState: EditorState, api: ExtractInjectionAPI<SyncedBlockPlugin> | undefined) => void;

package/dist/types/pm-plugins/utils/handle-bodied-sync-block-removal.d.ts

@@ -3,7 +3,7 @@ import type { Transaction } from '@atlaskit/editor-prosemirror/state';
 import type { DeletionReason, SyncBlockStoreManager } from '@atlaskit/editor-synced-block-provider';
 import type { SyncedBlockPlugin } from '../../syncedBlockPluginType';
 import { type SyncBlockInfo } from '../../types';
-export type ConfirmationTransactionRef = {
+export type TransactionRef = {
     current: Transaction | undefined;
 };
-export declare const handleBodiedSyncBlockRemoval: (bodiedSyncBlockRemoved: SyncBlockInfo[], syncBlockStore: SyncBlockStoreManager, api: ExtractInjectionAPI<SyncedBlockPlugin> | undefined, confirmationTransactionRef: ConfirmationTransactionRef, deletionReason: DeletionReason) => boolean;
+export declare const handleBodiedSyncBlockRemoval: (bodiedSyncBlockRemoved: SyncBlockInfo[], syncBlockStore: SyncBlockStoreManager, api: ExtractInjectionAPI<SyncedBlockPlugin> | undefined, confirmationTransactionRef: TransactionRef, deletionReason: DeletionReason) => boolean;

package/dist/types/types/index.d.ts

@@ -1,3 +1,4 @@
+import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import type { Transaction } from '@atlaskit/editor-prosemirror/state';
 import type { SyncBlockStoreManager } from '@atlaskit/editor-synced-block-provider';
 export declare enum FLAG_ID {
@@ -6,7 +7,8 @@ export declare enum FLAG_ID {
     CANNOT_CREATE_WHEN_OFFLINE = "cannot-create-when-offline",
     FAIL_TO_DELETE = "fail-to-delete",
     SYNC_BLOCK_COPIED = "sync-block-copied",
-    UNPUBLISHED_SYNC_BLOCK_PASTED = "unpublished-sync-block-pasted"
+    UNPUBLISHED_SYNC_BLOCK_PASTED = "unpublished-sync-block-pasted",
+    CANNOT_CREATE_SYNC_BLOCK = "cannot-create-sync-block"
 }
 type FlagConfig = {
     id: FLAG_ID;
@@ -15,6 +17,15 @@ type FlagConfig = {
 };
 export type BodiedSyncBlockDeletionStatus = 'none' | 'processing' | 'completed';
 export type ActiveFlag = FlagConfig | false;
+type RetryCreationPos = {
+    from: number;
+    to: number;
+};
+export type RetryCreationPosMap = Map<string, RetryCreationPos>;
+export type RetryCreationPosEntry = {
+    pos?: RetryCreationPos;
+    resourceId: string;
+};
 export type SyncedBlockSharedState = {
     /**
      * Whether to show a flag (usually for errors, e.g. fail to delete)
@@ -24,6 +35,12 @@ export type SyncedBlockSharedState = {
      * Whether the plugin is currently saving bodiedSyncBlock deletion to backend
      */
     bodiedSyncBlockDeletionStatus?: BodiedSyncBlockDeletionStatus;
+    /**
+     * Positions of pending creations keyed by resourceId, used for retry/revert flow.
+     * When a new bodiedSyncBlock is added, a new entry is added to map for mapping. The entry is removed when creation succeeds or retry option is dismissed.
+     *
+     */
+    retryCreationPosMap?: RetryCreationPosMap;
     /**
      * The current sync block store manager, used to manage fetching and updating sync block data
      */
@@ -36,6 +53,7 @@ export type SyncBlockAttrs = {
 export type SyncBlockInfo = {
     attrs: SyncBlockAttrs;
     from?: number;
+    node?: PMNode;
     to?: number;
 };
 export type SyncBlockMap = {

package/dist/types-ts4.5/pm-plugins/main.d.ts

@@ -4,11 +4,12 @@ import { PluginKey } from '@atlaskit/editor-prosemirror/state';
 import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
 import { type SyncBlockStoreManager } from '@atlaskit/editor-synced-block-provider';
 import type { SyncedBlockPlugin, SyncedBlockPluginOptions } from '../syncedBlockPluginType';
-import { type ActiveFlag, type BodiedSyncBlockDeletionStatus } from '../types';
+import { type ActiveFlag, type BodiedSyncBlockDeletionStatus, type RetryCreationPosMap } from '../types';
 export declare const syncedBlockPluginKey: PluginKey<any>;
 type SyncedBlockPluginState = {
     activeFlag: ActiveFlag;
     bodiedSyncBlockDeletionStatus?: BodiedSyncBlockDeletionStatus;
+    retryCreationPosMap: RetryCreationPosMap;
     selectionDecorationSet: DecorationSet;
     syncBlockStore: SyncBlockStoreManager;
 };

package/dist/types-ts4.5/pm-plugins/utils/handle-bodied-sync-block-creation.d.ts

@@ -0,0 +1,9 @@
+import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import { type EditorState } from '@atlaskit/editor-prosemirror/state';
+import type { SyncedBlockPlugin } from '../../syncedBlockPluginType';
+import { type SyncBlockInfo } from '../../types';
+/**
+ *
+ * Save the new bodiedSyncBlock to backend with empty content and handles revert (if failed) and retry flow
+ */
+export declare const handleBodiedSyncBlockCreation: (bodiedSyncBlockAdded: SyncBlockInfo[], editorState: EditorState, api: ExtractInjectionAPI<SyncedBlockPlugin> | undefined) => void;

package/dist/types-ts4.5/pm-plugins/utils/handle-bodied-sync-block-removal.d.ts

@@ -3,7 +3,7 @@ import type { Transaction } from '@atlaskit/editor-prosemirror/state';
 import type { DeletionReason, SyncBlockStoreManager } from '@atlaskit/editor-synced-block-provider';
 import type { SyncedBlockPlugin } from '../../syncedBlockPluginType';
 import { type SyncBlockInfo } from '../../types';
-export type ConfirmationTransactionRef = {
+export type TransactionRef = {
     current: Transaction | undefined;
 };
-export declare const handleBodiedSyncBlockRemoval: (bodiedSyncBlockRemoved: SyncBlockInfo[], syncBlockStore: SyncBlockStoreManager, api: ExtractInjectionAPI<SyncedBlockPlugin> | undefined, confirmationTransactionRef: ConfirmationTransactionRef, deletionReason: DeletionReason) => boolean;
+export declare const handleBodiedSyncBlockRemoval: (bodiedSyncBlockRemoved: SyncBlockInfo[], syncBlockStore: SyncBlockStoreManager, api: ExtractInjectionAPI<SyncedBlockPlugin> | undefined, confirmationTransactionRef: TransactionRef, deletionReason: DeletionReason) => boolean;

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

@@ -1,3 +1,4 @@
+import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import type { Transaction } from '@atlaskit/editor-prosemirror/state';
 import type { SyncBlockStoreManager } from '@atlaskit/editor-synced-block-provider';
 export declare enum FLAG_ID {
@@ -6,7 +7,8 @@ export declare enum FLAG_ID {
     CANNOT_CREATE_WHEN_OFFLINE = "cannot-create-when-offline",
     FAIL_TO_DELETE = "fail-to-delete",
     SYNC_BLOCK_COPIED = "sync-block-copied",
-    UNPUBLISHED_SYNC_BLOCK_PASTED = "unpublished-sync-block-pasted"
+    UNPUBLISHED_SYNC_BLOCK_PASTED = "unpublished-sync-block-pasted",
+    CANNOT_CREATE_SYNC_BLOCK = "cannot-create-sync-block"
 }
 type FlagConfig = {
     id: FLAG_ID;
@@ -15,6 +17,15 @@ type FlagConfig = {
 };
 export type BodiedSyncBlockDeletionStatus = 'none' | 'processing' | 'completed';
 export type ActiveFlag = FlagConfig | false;
+type RetryCreationPos = {
+    from: number;
+    to: number;
+};
+export type RetryCreationPosMap = Map<string, RetryCreationPos>;
+export type RetryCreationPosEntry = {
+    pos?: RetryCreationPos;
+    resourceId: string;
+};
 export type SyncedBlockSharedState = {
     /**
      * Whether to show a flag (usually for errors, e.g. fail to delete)
@@ -24,6 +35,12 @@ export type SyncedBlockSharedState = {
      * Whether the plugin is currently saving bodiedSyncBlock deletion to backend
      */
     bodiedSyncBlockDeletionStatus?: BodiedSyncBlockDeletionStatus;
+    /**
+     * Positions of pending creations keyed by resourceId, used for retry/revert flow.
+     * When a new bodiedSyncBlock is added, a new entry is added to map for mapping. The entry is removed when creation succeeds or retry option is dismissed.
+     *
+     */
+    retryCreationPosMap?: RetryCreationPosMap;
     /**
      * The current sync block store manager, used to manage fetching and updating sync block data
      */
@@ -36,6 +53,7 @@ export type SyncBlockAttrs = {
 export type SyncBlockInfo = {
     attrs: SyncBlockAttrs;
     from?: number;
+    node?: PMNode;
     to?: number;
 };
 export type SyncBlockMap = {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-synced-block",
-	"version": "5.3.13",
+	"version": "5.3.14",
 	"description": "SyncedBlock plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",