@atlaskit/editor-plugin-extension 1.18.6 → 2.0.0

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @atlaskit/editor-plugin-extension
 
+## 2.0.0
+
+### Major Changes
+
+- [#166906](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/166906)
+  [`aac76c4a54baf`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/aac76c4a54baf) -
+  added **rendererExtensionOptions option to pass renderer extension handlers to extensions in
+  editor to allow displaying of renderer view for bodiedExtensions—optional not required. To use for
+  extension plugin, pass **rendererExtensionOptions to universal preset via its
+  initialPluginConfiguration prop. To use for referentialityPlugin, use \_\_rendererExtensionOptions
+  option. In a future release, changes will be added to use this new option. Note: option is not
+  fully supported currently and is intended for use for confluence live pages
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 1.18.6
 
 ### Patch Changes

package/dist/cjs/plugin.js

@@ -70,7 +70,7 @@ var extensionPlugin = exports.extensionPlugin = function extensionPlugin(_ref) {
           var extensionHandlers = options.extensionHandlers || {};
           return (0, _main.createPlugin)(dispatch, providerFactory, extensionHandlers, portalProviderAPI, eventDispatcher, _api, options.useLongPressSelection, {
             appearance: options.appearance
-          }, featureFlags, options.allowDragAndDrop, options === null || options === void 0 ? void 0 : options.__livePage);
+          }, featureFlags, options.allowDragAndDrop, options === null || options === void 0 ? void 0 : options.__rendererExtensionOptions);
         }
       }, {
         name: 'extensionKeymap',

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

@@ -192,7 +192,7 @@ var createPlugin = exports.createPlugin = function createPlugin(dispatch, provid
   var options = arguments.length > 7 && arguments[7] !== undefined ? arguments[7] : {};
   var featureFlags = arguments.length > 8 ? arguments[8] : undefined;
   var allowDragAndDrop = arguments.length > 9 && arguments[9] !== undefined ? arguments[9] : true;
-  var __livePage = arguments.length > 10 ? arguments[10] : undefined;
+  var __rendererExtensionOptions = arguments.length > 10 ? arguments[10] : undefined;
   var state = (0, _pluginFactory.createPluginState)(dispatch, {
     showEditButton: false,
     showContextPanel: false
@@ -204,7 +204,7 @@ var createPlugin = exports.createPlugin = function createPlugin(dispatch, provid
     showMacroInteractionDesignUpdates: (_featureFlags$macroIn = featureFlags === null || featureFlags === void 0 ? void 0 : featureFlags.macroInteractionUpdates) !== null && _featureFlags$macroIn !== void 0 ? _featureFlags$macroIn : false,
     showMacroButtonUpdates: (_featureFlags$macroIn2 = featureFlags === null || featureFlags === void 0 ? void 0 : featureFlags.macroInteractionButtonUpdates) !== null && _featureFlags$macroIn2 !== void 0 ? _featureFlags$macroIn2 : false
   };
-  var showLivePagesBodiedMacrosRendererView = !!(__livePage && featureFlags !== null && featureFlags !== void 0 && featureFlags.livePagesBodiedMacrosRendererView);
+  var showLivePagesBodiedMacrosRendererView = __rendererExtensionOptions === null || __rendererExtensionOptions === void 0 ? void 0 : __rendererExtensionOptions.isAllowedToUseRendererView;
   return new _safePlugin.SafePlugin({
     state: state,
     view: function view(editorView) {
@@ -317,7 +317,7 @@ var createPlugin = exports.createPlugin = function createPlugin(dispatch, provid
         // WARNING: referentiality-plugin also creates these nodeviews
         extension: (0, _lazyExtension.lazyExtensionNodeView)('extension', portalProviderAPI, eventDispatcher, providerFactory, extensionHandlers, extensionNodeViewOptions, pluginInjectionApi, macroInteractionDesignFeatureFlags),
         // WARNING: referentiality-plugin also creates these nodeviews
-        bodiedExtension: (0, _lazyExtension.lazyExtensionNodeView)('bodiedExtension', portalProviderAPI, eventDispatcher, providerFactory, extensionHandlers, extensionNodeViewOptions, pluginInjectionApi, macroInteractionDesignFeatureFlags, showLivePagesBodiedMacrosRendererView),
+        bodiedExtension: (0, _lazyExtension.lazyExtensionNodeView)('bodiedExtension', portalProviderAPI, eventDispatcher, providerFactory, extensionHandlers, extensionNodeViewOptions, pluginInjectionApi, macroInteractionDesignFeatureFlags, showLivePagesBodiedMacrosRendererView, __rendererExtensionOptions === null || __rendererExtensionOptions === void 0 ? void 0 : __rendererExtensionOptions.rendererExtensionHandlers),
         // WARNING: referentiality-plugin also creates these nodeviews
         inlineExtension: (0, _lazyExtension.lazyExtensionNodeView)('inlineExtension', portalProviderAPI, eventDispatcher, providerFactory, extensionHandlers, extensionNodeViewOptions, pluginInjectionApi, macroInteractionDesignFeatureFlags),
         multiBodiedExtension: (0, _lazyExtension.lazyExtensionNodeView)('multiBodiedExtension', portalProviderAPI, eventDispatcher, providerFactory, extensionHandlers, extensionNodeViewOptions, pluginInjectionApi, macroInteractionDesignFeatureFlags)

package/dist/es2019/plugin.js

@@ -64,7 +64,7 @@ export const extensionPlugin = ({
           const extensionHandlers = options.extensionHandlers || {};
           return createPlugin(dispatch, providerFactory, extensionHandlers, portalProviderAPI, eventDispatcher, api, options.useLongPressSelection, {
             appearance: options.appearance
-          }, featureFlags, options.allowDragAndDrop, options === null || options === void 0 ? void 0 : options.__livePage);
+          }, featureFlags, options.allowDragAndDrop, options === null || options === void 0 ? void 0 : options.__rendererExtensionOptions);
         }
       }, {
         name: 'extensionKeymap',

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

@@ -115,7 +115,7 @@ export const handleUpdate = ({
   }
   return true;
 };
-const createPlugin = (dispatch, providerFactory, extensionHandlers, portalProviderAPI, eventDispatcher, pluginInjectionApi, useLongPressSelection = false, options = {}, featureFlags, allowDragAndDrop = true, __livePage) => {
+const createPlugin = (dispatch, providerFactory, extensionHandlers, portalProviderAPI, eventDispatcher, pluginInjectionApi, useLongPressSelection = false, options = {}, featureFlags, allowDragAndDrop = true, __rendererExtensionOptions) => {
   var _featureFlags$macroIn, _featureFlags$macroIn2;
   const state = createPluginState(dispatch, {
     showEditButton: false,
@@ -128,7 +128,7 @@ const createPlugin = (dispatch, providerFactory, extensionHandlers, portalProvid
     showMacroInteractionDesignUpdates: (_featureFlags$macroIn = featureFlags === null || featureFlags === void 0 ? void 0 : featureFlags.macroInteractionUpdates) !== null && _featureFlags$macroIn !== void 0 ? _featureFlags$macroIn : false,
     showMacroButtonUpdates: (_featureFlags$macroIn2 = featureFlags === null || featureFlags === void 0 ? void 0 : featureFlags.macroInteractionButtonUpdates) !== null && _featureFlags$macroIn2 !== void 0 ? _featureFlags$macroIn2 : false
   };
-  const showLivePagesBodiedMacrosRendererView = !!(__livePage && featureFlags !== null && featureFlags !== void 0 && featureFlags.livePagesBodiedMacrosRendererView);
+  const showLivePagesBodiedMacrosRendererView = __rendererExtensionOptions === null || __rendererExtensionOptions === void 0 ? void 0 : __rendererExtensionOptions.isAllowedToUseRendererView;
   return new SafePlugin({
     state,
     view: editorView => {
@@ -250,7 +250,7 @@ const createPlugin = (dispatch, providerFactory, extensionHandlers, portalProvid
         // WARNING: referentiality-plugin also creates these nodeviews
         extension: lazyExtensionNodeView('extension', portalProviderAPI, eventDispatcher, providerFactory, extensionHandlers, extensionNodeViewOptions, pluginInjectionApi, macroInteractionDesignFeatureFlags),
         // WARNING: referentiality-plugin also creates these nodeviews
-        bodiedExtension: lazyExtensionNodeView('bodiedExtension', portalProviderAPI, eventDispatcher, providerFactory, extensionHandlers, extensionNodeViewOptions, pluginInjectionApi, macroInteractionDesignFeatureFlags, showLivePagesBodiedMacrosRendererView),
+        bodiedExtension: lazyExtensionNodeView('bodiedExtension', portalProviderAPI, eventDispatcher, providerFactory, extensionHandlers, extensionNodeViewOptions, pluginInjectionApi, macroInteractionDesignFeatureFlags, showLivePagesBodiedMacrosRendererView, __rendererExtensionOptions === null || __rendererExtensionOptions === void 0 ? void 0 : __rendererExtensionOptions.rendererExtensionHandlers),
         // WARNING: referentiality-plugin also creates these nodeviews
         inlineExtension: lazyExtensionNodeView('inlineExtension', portalProviderAPI, eventDispatcher, providerFactory, extensionHandlers, extensionNodeViewOptions, pluginInjectionApi, macroInteractionDesignFeatureFlags),
         multiBodiedExtension: lazyExtensionNodeView('multiBodiedExtension', portalProviderAPI, eventDispatcher, providerFactory, extensionHandlers, extensionNodeViewOptions, pluginInjectionApi, macroInteractionDesignFeatureFlags)

package/dist/esm/plugin.js

@@ -63,7 +63,7 @@ export var extensionPlugin = function extensionPlugin(_ref) {
           var extensionHandlers = options.extensionHandlers || {};
           return createPlugin(dispatch, providerFactory, extensionHandlers, portalProviderAPI, eventDispatcher, _api, options.useLongPressSelection, {
             appearance: options.appearance
-          }, featureFlags, options.allowDragAndDrop, options === null || options === void 0 ? void 0 : options.__livePage);
+          }, featureFlags, options.allowDragAndDrop, options === null || options === void 0 ? void 0 : options.__rendererExtensionOptions);
         }
       }, {
         name: 'extensionKeymap',

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

@@ -166,7 +166,7 @@ var createPlugin = function createPlugin(dispatch, providerFactory, extensionHan
   var options = arguments.length > 7 && arguments[7] !== undefined ? arguments[7] : {};
   var featureFlags = arguments.length > 8 ? arguments[8] : undefined;
   var allowDragAndDrop = arguments.length > 9 && arguments[9] !== undefined ? arguments[9] : true;
-  var __livePage = arguments.length > 10 ? arguments[10] : undefined;
+  var __rendererExtensionOptions = arguments.length > 10 ? arguments[10] : undefined;
   var state = createPluginState(dispatch, {
     showEditButton: false,
     showContextPanel: false
@@ -178,7 +178,7 @@ var createPlugin = function createPlugin(dispatch, providerFactory, extensionHan
     showMacroInteractionDesignUpdates: (_featureFlags$macroIn = featureFlags === null || featureFlags === void 0 ? void 0 : featureFlags.macroInteractionUpdates) !== null && _featureFlags$macroIn !== void 0 ? _featureFlags$macroIn : false,
     showMacroButtonUpdates: (_featureFlags$macroIn2 = featureFlags === null || featureFlags === void 0 ? void 0 : featureFlags.macroInteractionButtonUpdates) !== null && _featureFlags$macroIn2 !== void 0 ? _featureFlags$macroIn2 : false
   };
-  var showLivePagesBodiedMacrosRendererView = !!(__livePage && featureFlags !== null && featureFlags !== void 0 && featureFlags.livePagesBodiedMacrosRendererView);
+  var showLivePagesBodiedMacrosRendererView = __rendererExtensionOptions === null || __rendererExtensionOptions === void 0 ? void 0 : __rendererExtensionOptions.isAllowedToUseRendererView;
   return new SafePlugin({
     state: state,
     view: function view(editorView) {
@@ -291,7 +291,7 @@ var createPlugin = function createPlugin(dispatch, providerFactory, extensionHan
         // WARNING: referentiality-plugin also creates these nodeviews
         extension: lazyExtensionNodeView('extension', portalProviderAPI, eventDispatcher, providerFactory, extensionHandlers, extensionNodeViewOptions, pluginInjectionApi, macroInteractionDesignFeatureFlags),
         // WARNING: referentiality-plugin also creates these nodeviews
-        bodiedExtension: lazyExtensionNodeView('bodiedExtension', portalProviderAPI, eventDispatcher, providerFactory, extensionHandlers, extensionNodeViewOptions, pluginInjectionApi, macroInteractionDesignFeatureFlags, showLivePagesBodiedMacrosRendererView),
+        bodiedExtension: lazyExtensionNodeView('bodiedExtension', portalProviderAPI, eventDispatcher, providerFactory, extensionHandlers, extensionNodeViewOptions, pluginInjectionApi, macroInteractionDesignFeatureFlags, showLivePagesBodiedMacrosRendererView, __rendererExtensionOptions === null || __rendererExtensionOptions === void 0 ? void 0 : __rendererExtensionOptions.rendererExtensionHandlers),
         // WARNING: referentiality-plugin also creates these nodeviews
         inlineExtension: lazyExtensionNodeView('inlineExtension', portalProviderAPI, eventDispatcher, providerFactory, extensionHandlers, extensionNodeViewOptions, pluginInjectionApi, macroInteractionDesignFeatureFlags),
         multiBodiedExtension: lazyExtensionNodeView('multiBodiedExtension', portalProviderAPI, eventDispatcher, providerFactory, extensionHandlers, extensionNodeViewOptions, pluginInjectionApi, macroInteractionDesignFeatureFlags)

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

@@ -9,7 +9,7 @@ import type { EditorState } from '@atlaskit/editor-prosemirror/state';
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 import { createCommand, getPluginState } from '../plugin-factory';
 import { pluginKey } from '../plugin-key';
-import type { ExtensionPlugin } from '../types';
+import type { ExtensionPlugin, ExtensionPluginOptions } from '../types';
 export declare const createExtensionProviderHandler: (view: EditorView) => (name: string, provider?: Promise<ExtensionProvider>) => Promise<void>;
 export declare const handleUpdate: ({ view, prevState, domAtPos, extensionHandlers, applyChange, }: {
     view: EditorView;
@@ -20,5 +20,5 @@ export declare const handleUpdate: ({ view, prevState, domAtPos, extensionHandle
 }) => true | undefined;
 declare const createPlugin: (dispatch: Dispatch, providerFactory: ProviderFactory, extensionHandlers: ExtensionHandlers, portalProviderAPI: PortalProviderAPI, eventDispatcher: EventDispatcher, pluginInjectionApi: ExtractInjectionAPI<ExtensionPlugin> | undefined, useLongPressSelection?: boolean, options?: {
     appearance?: EditorAppearance;
-}, featureFlags?: FeatureFlags, allowDragAndDrop?: boolean, __livePage?: boolean) => SafePlugin<import("../types").ExtensionState>;
+}, featureFlags?: FeatureFlags, allowDragAndDrop?: boolean, __rendererExtensionOptions?: ExtensionPluginOptions['__rendererExtensionOptions']) => SafePlugin<import("../types").ExtensionState>;
 export { pluginKey, createPlugin, createCommand, getPluginState };

package/dist/types/types.d.ts

@@ -1,3 +1,4 @@
+import type { ADFEntity } from '@atlaskit/adf-utils/types';
 import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
 import type { ExtensionAPI, ExtensionHandlers, ExtensionProvider, Parameters, TransformAfter, TransformBefore, UpdateExtension } from '@atlaskit/editor-common/extensions';
 import type { MacroProvider } from '@atlaskit/editor-common/provider-factory';
@@ -42,7 +43,10 @@ export interface ExtensionPluginOptions extends LongPressSelectionPluginOptions
     extensionHandlers?: ExtensionHandlers;
     appearance?: EditorAppearance;
     allowDragAndDrop?: boolean;
-    __livePage?: boolean;
+    __rendererExtensionOptions?: {
+        rendererExtensionHandlers?: ExtensionHandlers;
+        isAllowedToUseRendererView: (node: ADFEntity) => boolean;
+    };
 }
 type InsertMacroFromMacroBrowser = (macroProvider: MacroProvider, macroNode?: PmNode, isEditing?: boolean) => (view: EditorView) => Promise<boolean>;
 export type RunMacroAutoConvert = (state: EditorState, text: string) => PmNode | null;

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

@@ -9,7 +9,7 @@ import type { EditorState } from '@atlaskit/editor-prosemirror/state';
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 import { createCommand, getPluginState } from '../plugin-factory';
 import { pluginKey } from '../plugin-key';
-import type { ExtensionPlugin } from '../types';
+import type { ExtensionPlugin, ExtensionPluginOptions } from '../types';
 export declare const createExtensionProviderHandler: (view: EditorView) => (name: string, provider?: Promise<ExtensionProvider>) => Promise<void>;
 export declare const handleUpdate: ({ view, prevState, domAtPos, extensionHandlers, applyChange, }: {
     view: EditorView;
@@ -20,5 +20,5 @@ export declare const handleUpdate: ({ view, prevState, domAtPos, extensionHandle
 }) => true | undefined;
 declare const createPlugin: (dispatch: Dispatch, providerFactory: ProviderFactory, extensionHandlers: ExtensionHandlers, portalProviderAPI: PortalProviderAPI, eventDispatcher: EventDispatcher, pluginInjectionApi: ExtractInjectionAPI<ExtensionPlugin> | undefined, useLongPressSelection?: boolean, options?: {
     appearance?: EditorAppearance;
-}, featureFlags?: FeatureFlags, allowDragAndDrop?: boolean, __livePage?: boolean) => SafePlugin<import("../types").ExtensionState>;
+}, featureFlags?: FeatureFlags, allowDragAndDrop?: boolean, __rendererExtensionOptions?: ExtensionPluginOptions['__rendererExtensionOptions']) => SafePlugin<import("../types").ExtensionState>;
 export { pluginKey, createPlugin, createCommand, getPluginState };

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

@@ -1,3 +1,4 @@
+import type { ADFEntity } from '@atlaskit/adf-utils/types';
 import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
 import type { ExtensionAPI, ExtensionHandlers, ExtensionProvider, Parameters, TransformAfter, TransformBefore, UpdateExtension } from '@atlaskit/editor-common/extensions';
 import type { MacroProvider } from '@atlaskit/editor-common/provider-factory';
@@ -42,7 +43,10 @@ export interface ExtensionPluginOptions extends LongPressSelectionPluginOptions
     extensionHandlers?: ExtensionHandlers;
     appearance?: EditorAppearance;
     allowDragAndDrop?: boolean;
-    __livePage?: boolean;
+    __rendererExtensionOptions?: {
+        rendererExtensionHandlers?: ExtensionHandlers;
+        isAllowedToUseRendererView: (node: ADFEntity) => boolean;
+    };
 }
 type InsertMacroFromMacroBrowser = (macroProvider: MacroProvider, macroNode?: PmNode, isEditing?: boolean) => (view: EditorView) => Promise<boolean>;
 export type RunMacroAutoConvert = (state: EditorState, text: string) => PmNode | null;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-extension",
-	"version": "1.18.6",
+	"version": "2.0.0",
 	"description": "editor-plugin-extension plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -30,7 +30,7 @@
 		"@atlaskit/button": "^20.3.0",
 		"@atlaskit/checkbox": "^15.2.0",
 		"@atlaskit/datetime-picker": "^15.9.0",
-		"@atlaskit/editor-common": "^95.10.0",
+		"@atlaskit/editor-common": "^96.0.0",
 		"@atlaskit/editor-json-transformer": "^8.21.0",
 		"@atlaskit/editor-plugin-analytics": "^1.10.0",
 		"@atlaskit/editor-plugin-context-identifier": "^1.3.0",