@atlaskit/editor-plugin-help-dialog 1.8.13 → 1.9.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/editor-plugin-help-dialog
 
+## 1.9.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
+
 ## 1.8.13
 
 ### Patch Changes

package/dist/cjs/helpDialogPlugin.js

@@ -10,6 +10,7 @@ var _analytics = require("@atlaskit/editor-common/analytics");
 var _keymaps = require("@atlaskit/editor-common/keymaps");
 var _messages = require("@atlaskit/editor-common/messages");
 var _questionCircle = _interopRequireDefault(require("@atlaskit/icon/core/migration/question-circle"));
+var _actions = require("./pm-plugins/actions");
 var _commands = require("./pm-plugins/commands");
 var _keymap = require("./pm-plugins/keymap");
 var _main = require("./pm-plugins/main");
@@ -83,6 +84,20 @@ var helpDialogPlugin = exports.helpDialogPlugin = function helpDialogPlugin(_ref
         return null;
       }
       return _pluginKey.pluginKey.getState(editorState) || null;
+    },
+    actions: {
+      openHelp: function openHelp() {
+        return api === null || api === void 0 ? void 0 : api.core.actions.execute(function (_ref5) {
+          var tr = _ref5.tr;
+          return (0, _actions.openHelpAction)(tr);
+        });
+      },
+      closeHelp: function closeHelp() {
+        return api === null || api === void 0 ? void 0 : api.core.actions.execute(function (_ref6) {
+          var tr = _ref6.tr;
+          return (0, _actions.closeHelpAction)(tr);
+        });
+      }
     }
   };
 };

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

@@ -0,0 +1,13 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.openHelpAction = exports.closeHelpAction = void 0;
+var _pluginKey = require("./plugin-key");
+var openHelpAction = exports.openHelpAction = function openHelpAction(tr) {
+  return tr.setMeta(_pluginKey.pluginKey, true);
+};
+var closeHelpAction = exports.closeHelpAction = function closeHelpAction(tr) {
+  return tr.setMeta(_pluginKey.pluginKey, false);
+};

package/dist/es2019/helpDialogPlugin.js

@@ -3,6 +3,7 @@ import { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, EVENT_TYPE, INPUT_METHOD } f
 import { openHelp, tooltip } from '@atlaskit/editor-common/keymaps';
 import { toolbarInsertBlockMessages as messages } from '@atlaskit/editor-common/messages';
 import QuestionCircleIcon from '@atlaskit/icon/core/migration/question-circle';
+import { closeHelpAction, openHelpAction } from './pm-plugins/actions';
 import { openHelpCommand } from './pm-plugins/commands';
 import { keymapPlugin } from './pm-plugins/keymap';
 import { createPlugin } from './pm-plugins/main';
@@ -72,5 +73,17 @@ export const helpDialogPlugin = ({
       return null;
     }
     return pluginKey.getState(editorState) || null;
+  },
+  actions: {
+    openHelp: () => {
+      return api === null || api === void 0 ? void 0 : api.core.actions.execute(({
+        tr
+      }) => openHelpAction(tr));
+    },
+    closeHelp: () => {
+      return api === null || api === void 0 ? void 0 : api.core.actions.execute(({
+        tr
+      }) => closeHelpAction(tr));
+    }
   }
 });

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

@@ -0,0 +1,7 @@
+import { pluginKey } from './plugin-key';
+export const openHelpAction = tr => {
+  return tr.setMeta(pluginKey, true);
+};
+export const closeHelpAction = tr => {
+  return tr.setMeta(pluginKey, false);
+};

package/dist/esm/helpDialogPlugin.js

@@ -3,6 +3,7 @@ import { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, EVENT_TYPE, INPUT_METHOD } f
 import { openHelp, tooltip } from '@atlaskit/editor-common/keymaps';
 import { toolbarInsertBlockMessages as messages } from '@atlaskit/editor-common/messages';
 import QuestionCircleIcon from '@atlaskit/icon/core/migration/question-circle';
+import { closeHelpAction, openHelpAction } from './pm-plugins/actions';
 import { openHelpCommand } from './pm-plugins/commands';
 import { keymapPlugin } from './pm-plugins/keymap';
 import { createPlugin } from './pm-plugins/main';
@@ -76,6 +77,20 @@ export var helpDialogPlugin = function helpDialogPlugin(_ref) {
         return null;
       }
       return pluginKey.getState(editorState) || null;
+    },
+    actions: {
+      openHelp: function openHelp() {
+        return api === null || api === void 0 ? void 0 : api.core.actions.execute(function (_ref5) {
+          var tr = _ref5.tr;
+          return openHelpAction(tr);
+        });
+      },
+      closeHelp: function closeHelp() {
+        return api === null || api === void 0 ? void 0 : api.core.actions.execute(function (_ref6) {
+          var tr = _ref6.tr;
+          return closeHelpAction(tr);
+        });
+      }
     }
   };
 };

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

@@ -0,0 +1,7 @@
+import { pluginKey } from './plugin-key';
+export var openHelpAction = function openHelpAction(tr) {
+  return tr.setMeta(pluginKey, true);
+};
+export var closeHelpAction = function closeHelpAction(tr) {
+  return tr.setMeta(pluginKey, false);
+};

package/dist/types/helpDialogPluginType.d.ts

@@ -9,4 +9,8 @@ export type HelpDialogPlugin = NextEditorPlugin<'helpDialog', {
     dependencies: [OptionalPlugin<AnalyticsPlugin>, OptionalPlugin<QuickInsertPlugin>];
     pluginConfiguration: boolean;
     sharedState: HelpDialogSharedState | null;
+    actions: {
+        openHelp(): void;
+        closeHelp(): void;
+    };
 }>;

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

@@ -0,0 +1,3 @@
+import type { Transaction } from '@atlaskit/editor-prosemirror/state';
+export declare const openHelpAction: (tr: Transaction) => Transaction;
+export declare const closeHelpAction: (tr: Transaction) => Transaction;

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

@@ -12,4 +12,8 @@ export type HelpDialogPlugin = NextEditorPlugin<'helpDialog', {
     ];
     pluginConfiguration: boolean;
     sharedState: HelpDialogSharedState | null;
+    actions: {
+        openHelp(): void;
+        closeHelp(): void;
+    };
 }>;

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

@@ -0,0 +1,3 @@
+import type { Transaction } from '@atlaskit/editor-prosemirror/state';
+export declare const openHelpAction: (tr: Transaction) => Transaction;
+export declare const closeHelpAction: (tr: Transaction) => Transaction;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-help-dialog",
-	"version": "1.8.13",
+	"version": "1.9.0",
 	"description": "Help Dialog plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",