@atlaskit/editor-plugin-synced-block 8.1.2 → 8.2.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @atlaskit/editor-plugin-synced-block
 
+## 8.2.0
+
+### Minor Changes
+
+- [`c5fc2c5fb9fd1`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/c5fc2c5fb9fd1) -
+  Add discardUnpublishedSyncBlocks action to clean up orphaned synced blocks when user cancels
+  editing. Fetches block statuses from the backend on editor init and deletes all blocks with
+  'unpublished' status on cancel.
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 8.1.2
 
 ### Patch Changes

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

@@ -3,10 +3,13 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.flushSyncBlocks = exports.flushBodiedSyncBlocks = void 0;
+exports.flushSyncBlocks = exports.flushBodiedSyncBlocks = exports.discardUnpublishedSyncBlocks = void 0;
 var flushBodiedSyncBlocks = exports.flushBodiedSyncBlocks = function flushBodiedSyncBlocks(syncBlockStore) {
   return syncBlockStore.sourceManager.flush();
 };
 var flushSyncBlocks = exports.flushSyncBlocks = function flushSyncBlocks(syncBlockStore) {
   return syncBlockStore.referenceManager.flush();
+};
+var discardUnpublishedSyncBlocks = exports.discardUnpublishedSyncBlocks = function discardUnpublishedSyncBlocks(syncBlockStore) {
+  return syncBlockStore.sourceManager.discardUnpublishedBlocks();
 };

package/dist/cjs/pm-plugins/main.js

@@ -290,6 +290,11 @@ var createPlugin = exports.createPlugin = function createPlugin(options, pmPlugi
               syncBlockStore.sourceManager.updateSyncBlockData(node, false);
             }
           });
+
+          // Fetch statuses from the backend so we can identify unpublished blocks on cancel
+          if ((0, _platformFeatureFlags.fg)('platform_synced_block_patch_10')) {
+            syncBlockStore.sourceManager.fetchAndCacheStatuses();
+          }
         }
         return {
           selectionDecorationSet: (0, _selectionDecorations.calculateDecorations)(instance.doc, instance.selection, instance.schema),
@@ -508,6 +513,12 @@ var createPlugin = exports.createPlugin = function createPlugin(options, pmPlugi
               syncBlockStore.sourceManager.updateSyncBlockData(nodeInfo.node, tr.getMeta('isRemote'));
             }
           });
+
+          // Fetch statuses for remotely-added source sync blocks
+          // so we can identify unpublished blocks on cancel
+          if (sourceSyncBlockNodes.length > 0 && (0, _platformFeatureFlags.fg)('platform_synced_block_patch_10')) {
+            syncBlockStore.sourceManager.fetchAndCacheStatuses();
+          }
           var syncBlockNodes = referenceSyncBlockNodes.map(function (nodeInfo) {
             return nodeInfo.node;
           }).filter(function (node) {

package/dist/cjs/syncedBlockPlugin.js

@@ -90,6 +90,9 @@ var syncedBlockPlugin = exports.syncedBlockPlugin = function syncedBlockPlugin(_
       },
       flushSyncedBlocks: function flushSyncedBlocks() {
         return (0, _editorActions.flushSyncBlocks)(syncBlockStore);
+      },
+      discardUnpublishedSyncBlocks: function discardUnpublishedSyncBlocks() {
+        return (0, _editorActions.discardUnpublishedSyncBlocks)(syncBlockStore);
       }
     },
     pluginsOptions: {

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

@@ -3,4 +3,7 @@ export const flushBodiedSyncBlocks = syncBlockStore => {
 };
 export const flushSyncBlocks = syncBlockStore => {
   return syncBlockStore.referenceManager.flush();
+};
+export const discardUnpublishedSyncBlocks = syncBlockStore => {
+  return syncBlockStore.sourceManager.discardUnpublishedBlocks();
 };

package/dist/es2019/pm-plugins/main.js

@@ -257,6 +257,11 @@ export const createPlugin = (options, pmPluginFactoryParams, syncBlockStore, api
               syncBlockStore.sourceManager.updateSyncBlockData(node, false);
             }
           });
+
+          // Fetch statuses from the backend so we can identify unpublished blocks on cancel
+          if (fg('platform_synced_block_patch_10')) {
+            syncBlockStore.sourceManager.fetchAndCacheStatuses();
+          }
         }
         return {
           selectionDecorationSet: calculateDecorations(instance.doc, instance.selection, instance.schema),
@@ -474,6 +479,12 @@ export const createPlugin = (options, pmPluginFactoryParams, syncBlockStore, api
               syncBlockStore.sourceManager.updateSyncBlockData(nodeInfo.node, tr.getMeta('isRemote'));
             }
           });
+
+          // Fetch statuses for remotely-added source sync blocks
+          // so we can identify unpublished blocks on cancel
+          if (sourceSyncBlockNodes.length > 0 && fg('platform_synced_block_patch_10')) {
+            syncBlockStore.sourceManager.fetchAndCacheStatuses();
+          }
           const syncBlockNodes = referenceSyncBlockNodes.map(nodeInfo => nodeInfo.node).filter(node => node !== undefined);
           syncBlockStore.referenceManager.fetchSyncBlocksData(convertPMNodesToSyncBlockNodes(syncBlockNodes));
         }

package/dist/es2019/syncedBlockPlugin.js

@@ -2,7 +2,7 @@ import React from 'react';
 import { syncBlock, bodiedSyncBlock } from '@atlaskit/adf-schema';
 import { SyncBlockStoreManager } from '@atlaskit/editor-synced-block-provider';
 import { editorExperiment } from '@atlaskit/tmp-editor-statsig/experiments';
-import { flushBodiedSyncBlocks, flushSyncBlocks } from './editor-actions';
+import { flushBodiedSyncBlocks, flushSyncBlocks, discardUnpublishedSyncBlocks } from './editor-actions';
 import { copySyncedBlockReferenceToClipboardEditorCommand, createSyncedBlock } from './editor-commands';
 import { bodiedSyncBlockNodeWithToDOMFixed } from './nodeviews/bodiedSyncBlockNodeWithToDOMFixed';
 import { createPlugin, syncedBlockPluginKey } from './pm-plugins/main';
@@ -77,6 +77,9 @@ export const syncedBlockPlugin = ({
       },
       flushSyncedBlocks: () => {
         return flushSyncBlocks(syncBlockStore);
+      },
+      discardUnpublishedSyncBlocks: () => {
+        return discardUnpublishedSyncBlocks(syncBlockStore);
       }
     },
     pluginsOptions: {

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

@@ -3,4 +3,7 @@ export var flushBodiedSyncBlocks = function flushBodiedSyncBlocks(syncBlockStore
 };
 export var flushSyncBlocks = function flushSyncBlocks(syncBlockStore) {
   return syncBlockStore.referenceManager.flush();
+};
+export var discardUnpublishedSyncBlocks = function discardUnpublishedSyncBlocks(syncBlockStore) {
+  return syncBlockStore.sourceManager.discardUnpublishedBlocks();
 };

package/dist/esm/pm-plugins/main.js

@@ -283,6 +283,11 @@ export var createPlugin = function createPlugin(options, pmPluginFactoryParams,
               syncBlockStore.sourceManager.updateSyncBlockData(node, false);
             }
           });
+
+          // Fetch statuses from the backend so we can identify unpublished blocks on cancel
+          if (fg('platform_synced_block_patch_10')) {
+            syncBlockStore.sourceManager.fetchAndCacheStatuses();
+          }
         }
         return {
           selectionDecorationSet: calculateDecorations(instance.doc, instance.selection, instance.schema),
@@ -501,6 +506,12 @@ export var createPlugin = function createPlugin(options, pmPluginFactoryParams,
               syncBlockStore.sourceManager.updateSyncBlockData(nodeInfo.node, tr.getMeta('isRemote'));
             }
           });
+
+          // Fetch statuses for remotely-added source sync blocks
+          // so we can identify unpublished blocks on cancel
+          if (sourceSyncBlockNodes.length > 0 && fg('platform_synced_block_patch_10')) {
+            syncBlockStore.sourceManager.fetchAndCacheStatuses();
+          }
           var syncBlockNodes = referenceSyncBlockNodes.map(function (nodeInfo) {
             return nodeInfo.node;
           }).filter(function (node) {

package/dist/esm/syncedBlockPlugin.js

@@ -2,7 +2,7 @@ import React from 'react';
 import { syncBlock, bodiedSyncBlock } from '@atlaskit/adf-schema';
 import { SyncBlockStoreManager } from '@atlaskit/editor-synced-block-provider';
 import { editorExperiment } from '@atlaskit/tmp-editor-statsig/experiments';
-import { flushBodiedSyncBlocks as _flushBodiedSyncBlocks, flushSyncBlocks } from './editor-actions';
+import { flushBodiedSyncBlocks as _flushBodiedSyncBlocks, flushSyncBlocks, discardUnpublishedSyncBlocks as _discardUnpublishedSyncBlocks } from './editor-actions';
 import { copySyncedBlockReferenceToClipboardEditorCommand, createSyncedBlock } from './editor-commands';
 import { bodiedSyncBlockNodeWithToDOMFixed } from './nodeviews/bodiedSyncBlockNodeWithToDOMFixed';
 import { createPlugin, syncedBlockPluginKey } from './pm-plugins/main';
@@ -83,6 +83,9 @@ export var syncedBlockPlugin = function syncedBlockPlugin(_ref) {
       },
       flushSyncedBlocks: function flushSyncedBlocks() {
         return flushSyncBlocks(syncBlockStore);
+      },
+      discardUnpublishedSyncBlocks: function discardUnpublishedSyncBlocks() {
+        return _discardUnpublishedSyncBlocks(syncBlockStore);
       }
     },
     pluginsOptions: {

package/dist/types/editor-actions/index.d.ts

@@ -1,3 +1,4 @@
 import type { SyncBlockStoreManager } from '@atlaskit/editor-synced-block-provider';
 export declare const flushBodiedSyncBlocks: (syncBlockStore: SyncBlockStoreManager) => Promise<boolean>;
 export declare const flushSyncBlocks: (syncBlockStore: SyncBlockStoreManager) => Promise<boolean>;
+export declare const discardUnpublishedSyncBlocks: (syncBlockStore: SyncBlockStoreManager) => Promise<boolean>;

package/dist/types/syncedBlockPluginType.d.ts

@@ -58,6 +58,14 @@ export interface SyncedBlockPluginOptions extends LongPressSelectionPluginOption
 }
 export type SyncedBlockPlugin = NextEditorPlugin<'syncedBlock', {
     actions: {
+        /**
+         * Delete all source sync blocks with 'unpublished' status.
+         * Used to clean up orphaned blocks when a user cancels editing
+         * without saving.
+         *
+         * @returns true if all deletions succeeded, false otherwise
+         */
+        discardUnpublishedSyncBlocks: () => Promise<boolean>;
         /**
          * Save content of bodiedSyncBlock nodes in local cache to backend.
          * This action allows bodiedSyncBlock to be saved in sync with product saving experience

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

@@ -1,3 +1,4 @@
 import type { SyncBlockStoreManager } from '@atlaskit/editor-synced-block-provider';
 export declare const flushBodiedSyncBlocks: (syncBlockStore: SyncBlockStoreManager) => Promise<boolean>;
 export declare const flushSyncBlocks: (syncBlockStore: SyncBlockStoreManager) => Promise<boolean>;
+export declare const discardUnpublishedSyncBlocks: (syncBlockStore: SyncBlockStoreManager) => Promise<boolean>;

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

@@ -58,6 +58,14 @@ export interface SyncedBlockPluginOptions extends LongPressSelectionPluginOption
 }
 export type SyncedBlockPlugin = NextEditorPlugin<'syncedBlock', {
     actions: {
+        /**
+         * Delete all source sync blocks with 'unpublished' status.
+         * Used to clean up orphaned blocks when a user cancels editing
+         * without saving.
+         *
+         * @returns true if all deletions succeeded, false otherwise
+         */
+        discardUnpublishedSyncBlocks: () => Promise<boolean>;
         /**
          * Save content of bodiedSyncBlock nodes in local cache to backend.
          * This action allows bodiedSyncBlock to be saved in sync with product saving experience

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-synced-block",
-	"version": "8.1.2",
+	"version": "8.2.0",
 	"description": "SyncedBlock plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -43,7 +43,7 @@
 		"@atlaskit/editor-plugin-user-intent": "^8.0.0",
 		"@atlaskit/editor-prosemirror": "^7.3.0",
 		"@atlaskit/editor-shared-styles": "^3.10.0",
-		"@atlaskit/editor-synced-block-provider": "^6.3.0",
+		"@atlaskit/editor-synced-block-provider": "^6.4.0",
 		"@atlaskit/editor-toolbar": "^1.0.0",
 		"@atlaskit/flag": "^17.11.0",
 		"@atlaskit/icon": "34.3.0",
@@ -54,17 +54,17 @@
 		"@atlaskit/platform-feature-flags": "^1.1.0",
 		"@atlaskit/primitives": "^19.0.0",
 		"@atlaskit/spinner": "19.1.2",
-		"@atlaskit/tmp-editor-statsig": "^74.0.0",
+		"@atlaskit/tmp-editor-statsig": "^74.5.0",
 		"@atlaskit/tokens": "13.0.2",
 		"@atlaskit/tooltip": "^21.2.0",
-		"@atlaskit/visually-hidden": "^3.0.0",
+		"@atlaskit/visually-hidden": "^3.1.0",
 		"@babel/runtime": "^7.0.0",
 		"@compiled/react": "^0.20.0",
 		"bind-event-listener": "^3.0.0",
 		"date-fns": "^2.17.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^114.15.0",
+		"@atlaskit/editor-common": "^114.18.0",
 		"react": "^18.2.0",
 		"react-intl": "^5.25.1 || ^6.0.0 || ^7.0.0"
 	},