@atlaskit/editor-core 198.6.11 → 198.7.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/editor-core
 
+## 198.7.0
+
+### Minor Changes
+
+- [#154461](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/154461)
+  [`ed3b12d7f1092`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/ed3b12d7f1092) -
+  Remove WithHelpTrigger from Confluence and deprecate
+
 ## 198.6.11
 
 ### Patch Changes

package/dist/cjs/ui/ToolbarHelp/index.js

@@ -9,30 +9,59 @@ var _react = _interopRequireDefault(require("react"));
 var _reactIntlNext = require("react-intl-next");
 var _uiMenu = require("@atlaskit/editor-common/ui-menu");
 var _question = _interopRequireDefault(require("@atlaskit/icon/glyph/question"));
-var _WithHelpTrigger = _interopRequireDefault(require("../WithHelpTrigger"));
+var _EditorContext = require("../EditorContext");
 var _messages = require("./messages");
+// Please, do not copy or use this kind of code below
+// This is just a temporary solution to keep the tooltip trigger working for Trello since it's not using the composable editor
+// @ts-ignore
+var fakePluginKey = {
+  key: 'helpDialog$',
+  getState: function getState(state) {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    return state['helpDialog$'];
+  }
+};
+var openHelpCommand = function openHelpCommand(tr, dispatch) {
+  tr = tr.setMeta(fakePluginKey, true);
+  if (dispatch) {
+    dispatch(tr);
+    return true;
+  }
+  return false;
+};
 var TooltipHelpTrigger = function TooltipHelpTrigger(_ref) {
   var _ref$title = _ref.title,
     title = _ref$title === void 0 ? 'Open help dialog' : _ref$title,
     _ref$titlePosition = _ref.titlePosition,
     titlePosition = _ref$titlePosition === void 0 ? 'left' : _ref$titlePosition,
-    intl = _ref.intl;
+    intl = _ref.intl,
+    editorApi = _ref.editorApi;
+  var editorContext = (0, _EditorContext.useEditorContext)();
+
   // to have translation for the default tooltip helper
   var displayTitle = title;
   if (title === 'Open help dialog') {
     displayTitle = intl.formatMessage(_messages.messages.toolbarHelpTitle);
   }
-  return /*#__PURE__*/_react.default.createElement(_WithHelpTrigger.default, {
-    render: function render(showHelp) {
-      return /*#__PURE__*/_react.default.createElement(_uiMenu.ToolbarButton, {
-        onClick: showHelp,
-        title: displayTitle,
-        titlePosition: titlePosition,
-        iconBefore: /*#__PURE__*/_react.default.createElement(_question.default, {
-          label: displayTitle
-        })
-      });
+  var showHelp = function showHelp() {
+    if (editorApi) {
+      var _editorApi$helpDialog;
+      editorApi === null || editorApi === void 0 || (_editorApi$helpDialog = editorApi.helpDialog) === null || _editorApi$helpDialog === void 0 || _editorApi$helpDialog.actions.openHelp();
+    } else {
+      var _editorContext$editor;
+      var editorView = editorContext === null || editorContext === void 0 || (_editorContext$editor = editorContext.editorActions) === null || _editorContext$editor === void 0 ? void 0 : _editorContext$editor._privateGetEditorView();
+      if (editorView) {
+        openHelpCommand(editorView.state.tr, editorView.dispatch);
+      }
     }
+  };
+  return /*#__PURE__*/_react.default.createElement(_uiMenu.ToolbarButton, {
+    onClick: showHelp,
+    title: displayTitle,
+    titlePosition: titlePosition,
+    iconBefore: /*#__PURE__*/_react.default.createElement(_question.default, {
+      label: displayTitle
+    })
   });
 };
 var _default = exports.default = (0, _reactIntlNext.injectIntl)(TooltipHelpTrigger);

package/dist/cjs/version-wrapper.js

@@ -5,4 +5,4 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.version = exports.name = void 0;
 var name = exports.name = "@atlaskit/editor-core";
-var version = exports.version = "198.6.11";
+var version = exports.version = "198.7.0";

package/dist/es2019/index.js

@@ -9,6 +9,11 @@ export {
  */
 default as EditorContext } from './ui/EditorContext';
 export { default as WithEditorActions } from './ui/WithEditorActions';
+/**
+ * @deprecated
+ * DO NOT USE THIS WILL BE REMOVED SOON AND IS UNSAFE.
+ * Please use the the openHelp action via the editorAPI from the `@atlaskit/editor-plugin-help-dialog` plugin.
+ */
 export { default as WithHelpTrigger } from './ui/WithHelpTrigger';
 export { default as CollapsedEditor } from './ui/CollapsedEditor';
 export { default as ToolbarHelp } from './ui/ToolbarHelp';

package/dist/es2019/ui/ToolbarHelp/index.js

@@ -2,26 +2,57 @@ import React from 'react';
 import { injectIntl } from 'react-intl-next';
 import { ToolbarButton } from '@atlaskit/editor-common/ui-menu';
 import QuestionIcon from '@atlaskit/icon/glyph/question';
-import WithHelpTrigger from '../WithHelpTrigger';
+import { useEditorContext } from '../EditorContext';
 import { messages } from './messages';
+// Please, do not copy or use this kind of code below
+// This is just a temporary solution to keep the tooltip trigger working for Trello since it's not using the composable editor
+// @ts-ignore
+const fakePluginKey = {
+  key: 'helpDialog$',
+  getState: state => {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    return state['helpDialog$'];
+  }
+};
+const openHelpCommand = (tr, dispatch) => {
+  tr = tr.setMeta(fakePluginKey, true);
+  if (dispatch) {
+    dispatch(tr);
+    return true;
+  }
+  return false;
+};
 const TooltipHelpTrigger = ({
   title = 'Open help dialog',
   titlePosition = 'left',
-  intl
+  intl,
+  editorApi
 }) => {
+  const editorContext = useEditorContext();
+
   // to have translation for the default tooltip helper
   let displayTitle = title;
   if (title === 'Open help dialog') {
     displayTitle = intl.formatMessage(messages.toolbarHelpTitle);
   }
-  return /*#__PURE__*/React.createElement(WithHelpTrigger, {
-    render: showHelp => /*#__PURE__*/React.createElement(ToolbarButton, {
-      onClick: showHelp,
-      title: displayTitle,
-      titlePosition: titlePosition,
-      iconBefore: /*#__PURE__*/React.createElement(QuestionIcon, {
-        label: displayTitle
-      })
+  const showHelp = () => {
+    if (editorApi) {
+      var _editorApi$helpDialog;
+      editorApi === null || editorApi === void 0 ? void 0 : (_editorApi$helpDialog = editorApi.helpDialog) === null || _editorApi$helpDialog === void 0 ? void 0 : _editorApi$helpDialog.actions.openHelp();
+    } else {
+      var _editorContext$editor;
+      const editorView = editorContext === null || editorContext === void 0 ? void 0 : (_editorContext$editor = editorContext.editorActions) === null || _editorContext$editor === void 0 ? void 0 : _editorContext$editor._privateGetEditorView();
+      if (editorView) {
+        openHelpCommand(editorView.state.tr, editorView.dispatch);
+      }
+    }
+  };
+  return /*#__PURE__*/React.createElement(ToolbarButton, {
+    onClick: showHelp,
+    title: displayTitle,
+    titlePosition: titlePosition,
+    iconBefore: /*#__PURE__*/React.createElement(QuestionIcon, {
+      label: displayTitle
     })
   });
 };

package/dist/es2019/version-wrapper.js

@@ -1,2 +1,2 @@
 export const name = "@atlaskit/editor-core";
-export const version = "198.6.11";
+export const version = "198.7.0";

package/dist/esm/index.js

@@ -9,6 +9,11 @@ export {
  */
 default as EditorContext } from './ui/EditorContext';
 export { default as WithEditorActions } from './ui/WithEditorActions';
+/**
+ * @deprecated
+ * DO NOT USE THIS WILL BE REMOVED SOON AND IS UNSAFE.
+ * Please use the the openHelp action via the editorAPI from the `@atlaskit/editor-plugin-help-dialog` plugin.
+ */
 export { default as WithHelpTrigger } from './ui/WithHelpTrigger';
 export { default as CollapsedEditor } from './ui/CollapsedEditor';
 export { default as ToolbarHelp } from './ui/ToolbarHelp';

package/dist/esm/ui/ToolbarHelp/index.js

@@ -2,30 +2,59 @@ import React from 'react';
 import { injectIntl } from 'react-intl-next';
 import { ToolbarButton } from '@atlaskit/editor-common/ui-menu';
 import QuestionIcon from '@atlaskit/icon/glyph/question';
-import WithHelpTrigger from '../WithHelpTrigger';
+import { useEditorContext } from '../EditorContext';
 import { messages } from './messages';
+// Please, do not copy or use this kind of code below
+// This is just a temporary solution to keep the tooltip trigger working for Trello since it's not using the composable editor
+// @ts-ignore
+var fakePluginKey = {
+  key: 'helpDialog$',
+  getState: function getState(state) {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    return state['helpDialog$'];
+  }
+};
+var openHelpCommand = function openHelpCommand(tr, dispatch) {
+  tr = tr.setMeta(fakePluginKey, true);
+  if (dispatch) {
+    dispatch(tr);
+    return true;
+  }
+  return false;
+};
 var TooltipHelpTrigger = function TooltipHelpTrigger(_ref) {
   var _ref$title = _ref.title,
     title = _ref$title === void 0 ? 'Open help dialog' : _ref$title,
     _ref$titlePosition = _ref.titlePosition,
     titlePosition = _ref$titlePosition === void 0 ? 'left' : _ref$titlePosition,
-    intl = _ref.intl;
+    intl = _ref.intl,
+    editorApi = _ref.editorApi;
+  var editorContext = useEditorContext();
+
   // to have translation for the default tooltip helper
   var displayTitle = title;
   if (title === 'Open help dialog') {
     displayTitle = intl.formatMessage(messages.toolbarHelpTitle);
   }
-  return /*#__PURE__*/React.createElement(WithHelpTrigger, {
-    render: function render(showHelp) {
-      return /*#__PURE__*/React.createElement(ToolbarButton, {
-        onClick: showHelp,
-        title: displayTitle,
-        titlePosition: titlePosition,
-        iconBefore: /*#__PURE__*/React.createElement(QuestionIcon, {
-          label: displayTitle
-        })
-      });
+  var showHelp = function showHelp() {
+    if (editorApi) {
+      var _editorApi$helpDialog;
+      editorApi === null || editorApi === void 0 || (_editorApi$helpDialog = editorApi.helpDialog) === null || _editorApi$helpDialog === void 0 || _editorApi$helpDialog.actions.openHelp();
+    } else {
+      var _editorContext$editor;
+      var editorView = editorContext === null || editorContext === void 0 || (_editorContext$editor = editorContext.editorActions) === null || _editorContext$editor === void 0 ? void 0 : _editorContext$editor._privateGetEditorView();
+      if (editorView) {
+        openHelpCommand(editorView.state.tr, editorView.dispatch);
+      }
     }
+  };
+  return /*#__PURE__*/React.createElement(ToolbarButton, {
+    onClick: showHelp,
+    title: displayTitle,
+    titlePosition: titlePosition,
+    iconBefore: /*#__PURE__*/React.createElement(QuestionIcon, {
+      label: displayTitle
+    })
   });
 };
 export default injectIntl(TooltipHelpTrigger);

package/dist/esm/version-wrapper.js

@@ -1,2 +1,2 @@
 export var name = "@atlaskit/editor-core";
-export var version = "198.6.11";
+export var version = "198.7.0";

package/dist/types/create-editor/create-universal-preset.d.ts

@@ -2705,6 +2705,10 @@ export declare function createUniversalPreset({ props, prevProps, initialPluginC
     }, import("@atlaskit/editor-common/types").QuickInsertPluginOptions | undefined>>];
     pluginConfiguration: boolean;
     sharedState: import("@atlaskit/editor-plugin-help-dialog").HelpDialogSharedState | null;
+    actions: {
+        openHelp(): void;
+        closeHelp(): void;
+    };
 }, boolean> | undefined, import("@atlaskit/editor-common/types").NextEditorPluginFunctionOptionalConfigDefinition<"feedbackDialog", {
     pluginConfiguration: import("@atlaskit/editor-common/types").FeedbackInfo;
     dependencies: [import("@atlaskit/editor-common/types").OptionalPlugin<import("@atlaskit/editor-common/types").NextEditorPluginFunctionOptionalConfigDefinition<"analytics", {

package/dist/types/index.d.ts

@@ -8,6 +8,11 @@ export {
  */
 default as EditorContext, } from './ui/EditorContext';
 export { default as WithEditorActions } from './ui/WithEditorActions';
+/**
+ * @deprecated
+ * DO NOT USE THIS WILL BE REMOVED SOON AND IS UNSAFE.
+ * Please use the the openHelp action via the editorAPI from the `@atlaskit/editor-plugin-help-dialog` plugin.
+ */
 export { default as WithHelpTrigger } from './ui/WithHelpTrigger';
 export { default as CollapsedEditor } from './ui/CollapsedEditor';
 export { default as ToolbarHelp } from './ui/ToolbarHelp';

package/dist/types/presets/universal.d.ts

@@ -2756,6 +2756,10 @@ export default function createUniversalPresetInternal({ appearance, props, featu
     }, import("@atlaskit/editor-common/types").QuickInsertPluginOptions | undefined>>];
     pluginConfiguration: boolean;
     sharedState: import("@atlaskit/editor-plugins/help-dialog").HelpDialogSharedState | null;
+    actions: {
+        openHelp(): void;
+        closeHelp(): void;
+    };
 }, boolean> | undefined, import("@atlaskit/editor-common/types").NextEditorPluginFunctionOptionalConfigDefinition<"feedbackDialog", {
     pluginConfiguration: import("@atlaskit/editor-common/types").FeedbackInfo;
     dependencies: [import("@atlaskit/editor-common/types").OptionalPlugin<import("@atlaskit/editor-common/types").NextEditorPluginFunctionOptionalConfigDefinition<"analytics", {

package/dist/types/presets/useUniversalPreset.d.ts

@@ -2705,6 +2705,10 @@ export default function useUniversalPreset({ props, initialPluginConfiguration }
     }, import("@atlaskit/editor-common/types").QuickInsertPluginOptions | undefined>>];
     pluginConfiguration: boolean;
     sharedState: import("@atlaskit/editor-plugin-help-dialog").HelpDialogSharedState | null;
+    actions: {
+        openHelp(): void;
+        closeHelp(): void;
+    };
 }, boolean> | undefined, import("@atlaskit/editor-common/types").NextEditorPluginFunctionOptionalConfigDefinition<"feedbackDialog", {
     pluginConfiguration: import("@atlaskit/editor-common/types").FeedbackInfo;
     dependencies: [import("@atlaskit/editor-common/types").OptionalPlugin<import("@atlaskit/editor-common/types").NextEditorPluginFunctionOptionalConfigDefinition<"analytics", {

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

@@ -1,9 +1,12 @@
 import React from 'react';
 import type { WrappedComponentProps } from 'react-intl-next';
+import { type ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import { type HelpDialogPlugin } from '@atlaskit/editor-plugins/help-dialog';
 import type { PositionType } from '@atlaskit/tooltip/types';
 interface Props {
     title?: string;
     titlePosition?: PositionType;
+    editorApi?: ExtractInjectionAPI<HelpDialogPlugin> | undefined;
 }
 declare const _default: React.FC<import("react-intl-next").WithIntlProps<Props & WrappedComponentProps>> & {
     WrappedComponent: React.ComponentType<Props & WrappedComponentProps>;

package/dist/types-ts4.5/create-editor/create-universal-preset.d.ts

@@ -3320,6 +3320,10 @@ export declare function createUniversalPreset({ props, prevProps, initialPluginC
         ];
         pluginConfiguration: boolean;
         sharedState: import("@atlaskit/editor-plugin-help-dialog").HelpDialogSharedState | null;
+        actions: {
+            openHelp(): void;
+            closeHelp(): void;
+        };
     }, boolean> | undefined,
     import("@atlaskit/editor-common/types").NextEditorPluginFunctionOptionalConfigDefinition<"feedbackDialog", {
         pluginConfiguration: import("@atlaskit/editor-common/types").FeedbackInfo;

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

@@ -8,6 +8,11 @@ export {
  */
 default as EditorContext, } from './ui/EditorContext';
 export { default as WithEditorActions } from './ui/WithEditorActions';
+/**
+ * @deprecated
+ * DO NOT USE THIS WILL BE REMOVED SOON AND IS UNSAFE.
+ * Please use the the openHelp action via the editorAPI from the `@atlaskit/editor-plugin-help-dialog` plugin.
+ */
 export { default as WithHelpTrigger } from './ui/WithHelpTrigger';
 export { default as CollapsedEditor } from './ui/CollapsedEditor';
 export { default as ToolbarHelp } from './ui/ToolbarHelp';

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

@@ -3371,6 +3371,10 @@ export default function createUniversalPresetInternal({ appearance, props, featu
         ];
         pluginConfiguration: boolean;
         sharedState: import("@atlaskit/editor-plugins/help-dialog").HelpDialogSharedState | null;
+        actions: {
+            openHelp(): void;
+            closeHelp(): void;
+        };
     }, boolean> | undefined,
     import("@atlaskit/editor-common/types").NextEditorPluginFunctionOptionalConfigDefinition<"feedbackDialog", {
         pluginConfiguration: import("@atlaskit/editor-common/types").FeedbackInfo;

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

@@ -3320,6 +3320,10 @@ export default function useUniversalPreset({ props, initialPluginConfiguration }
         ];
         pluginConfiguration: boolean;
         sharedState: import("@atlaskit/editor-plugin-help-dialog").HelpDialogSharedState | null;
+        actions: {
+            openHelp(): void;
+            closeHelp(): void;
+        };
     }, boolean> | undefined,
     import("@atlaskit/editor-common/types").NextEditorPluginFunctionOptionalConfigDefinition<"feedbackDialog", {
         pluginConfiguration: import("@atlaskit/editor-common/types").FeedbackInfo;

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

@@ -1,9 +1,12 @@
 import React from 'react';
 import type { WrappedComponentProps } from 'react-intl-next';
+import { type ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import { type HelpDialogPlugin } from '@atlaskit/editor-plugins/help-dialog';
 import type { PositionType } from '@atlaskit/tooltip/types';
 interface Props {
     title?: string;
     titlePosition?: PositionType;
+    editorApi?: ExtractInjectionAPI<HelpDialogPlugin> | undefined;
 }
 declare const _default: React.FC<import("react-intl-next").WithIntlProps<Props & WrappedComponentProps>> & {
     WrappedComponent: React.ComponentType<Props & WrappedComponentProps>;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-core",
-	"version": "198.6.11",
+	"version": "198.7.0",
 	"description": "A package contains Atlassian editor core functionality",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"