@atlaskit/editor-plugin-help-dialog 0.1.0 → 0.2.0

package/.eslintrc.js

@@ -2,5 +2,7 @@ module.exports = {
   rules: {
     '@typescript-eslint/no-duplicate-imports': 'error',
     '@typescript-eslint/no-explicit-any': 'error',
+    '@atlaskit/design-system/consistent-css-prop-usage': 'warn',
+    '@repo/internal/dom-events/no-unsafe-event-listeners': 'warn',
   },
 };

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/editor-plugin-help-dialog
 
+## 0.2.0
+
+### Minor Changes
+
+- [#41049](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/41049) [`56e271b5da6`](https://bitbucket.org/atlassian/atlassian-frontend/commits/56e271b5da6) - Extract help-dialog-plugin from editor-core
+
 ## 0.1.0
 
 ### Minor Changes

package/dist/cjs/commands.js

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

package/dist/cjs/index.js

@@ -2,4 +2,18 @@
 
 Object.defineProperty(exports, "__esModule", {
   value: true
-});
+});
+Object.defineProperty(exports, "deprecatedOpenHelpCommand", {
+  enumerable: true,
+  get: function get() {
+    return _commands.openHelpCommand;
+  }
+});
+Object.defineProperty(exports, "helpDialogPlugin", {
+  enumerable: true,
+  get: function get() {
+    return _plugin.helpDialogPlugin;
+  }
+});
+var _plugin = require("./plugin");
+var _commands = require("./commands");

package/dist/cjs/plugin-key.js

@@ -0,0 +1,8 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.pluginKey = void 0;
+var _state = require("@atlaskit/editor-prosemirror/state");
+var pluginKey = exports.pluginKey = new _state.PluginKey('helpDialogPlugin');

package/dist/cjs/plugin.js

@@ -0,0 +1,137 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createPlugin = createPlugin;
+exports.helpDialogPlugin = void 0;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _react = _interopRequireDefault(require("react"));
+var _analytics = require("@atlaskit/editor-common/analytics");
+var _keymaps = require("@atlaskit/editor-common/keymaps");
+var _messages = require("@atlaskit/editor-common/messages");
+var _safePlugin = require("@atlaskit/editor-common/safe-plugin");
+var _keymap = require("@atlaskit/editor-prosemirror/keymap");
+var _questionCircle = _interopRequireDefault(require("@atlaskit/icon/glyph/question-circle"));
+var _commands = require("./commands");
+var _pluginKey = require("./plugin-key");
+var _HelpDialogLoader = require("./ui/HelpDialogLoader");
+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) { (0, _defineProperty2.default)(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; }
+function createPlugin(dispatch, imageEnabled) {
+  return new _safePlugin.SafePlugin({
+    key: _pluginKey.pluginKey,
+    state: {
+      init: function init() {
+        return {
+          isVisible: false,
+          imageEnabled: imageEnabled
+        };
+      },
+      apply: function apply(tr, _value, state) {
+        var isVisible = tr.getMeta(_pluginKey.pluginKey);
+        var currentState = _pluginKey.pluginKey.getState(state);
+        if (isVisible !== undefined && isVisible !== currentState.isVisible) {
+          var newState = _objectSpread(_objectSpread({}, currentState), {}, {
+            isVisible: isVisible
+          });
+          dispatch(_pluginKey.pluginKey, newState);
+          return newState;
+        }
+        return currentState;
+      }
+    }
+  });
+}
+var helpDialogPlugin = exports.helpDialogPlugin = function helpDialogPlugin(_ref) {
+  var _ref$config = _ref.config,
+    imageUploadProviderExists = _ref$config === void 0 ? false : _ref$config,
+    api = _ref.api;
+  return {
+    name: 'helpDialog',
+    pmPlugins: function pmPlugins() {
+      return [{
+        name: 'helpDialog',
+        plugin: function plugin(_ref2) {
+          var dispatch = _ref2.dispatch;
+          return createPlugin(dispatch, imageUploadProviderExists);
+        }
+      }, {
+        name: 'helpDialogKeymap',
+        plugin: function plugin() {
+          var _api$analytics;
+          return keymapPlugin(api === null || api === void 0 || (_api$analytics = api.analytics) === null || _api$analytics === void 0 ? void 0 : _api$analytics.actions);
+        }
+      }];
+    },
+    pluginsOptions: {
+      quickInsert: function quickInsert(_ref3) {
+        var formatMessage = _ref3.formatMessage;
+        return [{
+          id: 'helpdialog',
+          title: formatMessage(_messages.toolbarInsertBlockMessages.help),
+          description: formatMessage(_messages.toolbarInsertBlockMessages.helpDescription),
+          keywords: ['?'],
+          priority: 4000,
+          keyshortcut: (0, _keymaps.tooltip)(_keymaps.openHelp),
+          icon: function icon() {
+            return /*#__PURE__*/_react.default.createElement(_questionCircle.default, {
+              label: ""
+            });
+          },
+          action: function action(insert) {
+            var _api$analytics2;
+            var tr = insert('');
+            (0, _commands.openHelpCommand)(tr);
+            api === null || api === void 0 || (_api$analytics2 = api.analytics) === null || _api$analytics2 === void 0 || _api$analytics2.actions.attachAnalyticsEvent({
+              action: _analytics.ACTION.HELP_OPENED,
+              actionSubject: _analytics.ACTION_SUBJECT.HELP,
+              actionSubjectId: _analytics.ACTION_SUBJECT_ID.HELP_QUICK_INSERT,
+              attributes: {
+                inputMethod: _analytics.INPUT_METHOD.QUICK_INSERT
+              },
+              eventType: _analytics.EVENT_TYPE.UI
+            })(tr);
+            return tr;
+          }
+        }];
+      }
+    },
+    contentComponent: function contentComponent(_ref4) {
+      var editorView = _ref4.editorView;
+      return /*#__PURE__*/_react.default.createElement(_HelpDialogLoader.HelpDialogLoader, {
+        pluginInjectionApi: api,
+        editorView: editorView,
+        quickInsertEnabled: !!(api !== null && api !== void 0 && api.quickInsert)
+      });
+    },
+    getSharedState: function getSharedState(editorState) {
+      if (!editorState) {
+        return null;
+      }
+      return _pluginKey.pluginKey.getState(editorState) || null;
+    }
+  };
+};
+var keymapPlugin = function keymapPlugin(editorAnalyticsAPI) {
+  var list = {};
+  (0, _keymaps.bindKeymapWithCommand)(_keymaps.openHelp.common, function (state, dispatch) {
+    var tr = state.tr;
+    var isVisible = tr.getMeta(_pluginKey.pluginKey);
+    if (!isVisible) {
+      editorAnalyticsAPI === null || editorAnalyticsAPI === void 0 || editorAnalyticsAPI.attachAnalyticsEvent({
+        action: _analytics.ACTION.CLICKED,
+        actionSubject: _analytics.ACTION_SUBJECT.BUTTON,
+        actionSubjectId: _analytics.ACTION_SUBJECT_ID.BUTTON_HELP,
+        attributes: {
+          inputMethod: _analytics.INPUT_METHOD.SHORTCUT
+        },
+        eventType: _analytics.EVENT_TYPE.UI
+      })(tr);
+      (0, _commands.openHelpCommand)(tr, dispatch);
+    }
+    return true;
+  }, list);
+  return (0, _keymap.keymap)(list);
+};

package/dist/cjs/ui/HelpDialogLoader.js

@@ -0,0 +1,24 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.HelpDialogLoader = void 0;
+var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
+var _reactLoadable = _interopRequireDefault(require("react-loadable"));
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || (0, _typeof2.default)(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+var HelpDialogLoader = exports.HelpDialogLoader = (0, _reactLoadable.default)({
+  loader: function loader() {
+    return Promise.resolve().then(function () {
+      return _interopRequireWildcard(require( /* webpackChunkName: "@atlaskit-internal_editor-core-helpdialog" */
+      './index'));
+    }).then(function (mod) {
+      return mod.default;
+    });
+  },
+  loading: function loading() {
+    return null;
+  }
+});