@atlaskit/editor-plugin-expand 0.1.0

package/CHANGELOG.md

@@ -0,0 +1 @@
+# @atlaskit/editor-plugin-expand

package/LICENSE.md

@@ -0,0 +1,13 @@
+Copyright 2023 Atlassian Pty Ltd
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,30 @@
+# Editor plugin expand
+
+Expand plugin for @atlaskit/editor-core
+
+**Note:** This component is designed for internal Atlassian development.
+External contributors will be able to use this component but will not be able to submit issues.
+
+## Install
+---
+- **Install** - *yarn add @atlaskit/editor-plugin-expand*
+- **npm** - [@atlaskit/editor-plugin-expand](https://www.npmjs.com/package/@atlaskit/editor-plugin-expand)
+- **Source** - [Bitbucket](https://bitbucket.org/atlassian/atlassian-frontend/src/master/packages/editor/editor-plugin-expand)
+- **Bundle** - [unpkg.com](https://unpkg.com/@atlaskit/editor-plugin-expand/dist/)
+
+## Usage
+---
+**Internal use only**
+
+@atlaskit/editor-plugin-expand is intended for internal use by the @atlaskit/editor-core and as a plugin dependency of the Editor within your product.
+
+Direct use of this component is not supported.
+
+Please see [Atlaskit - Editor plugin expand](https://atlaskit.atlassian.com/packages/editor/editor-plugin-expand) for documentation and examples for this package.
+
+## Support
+---
+For internal Atlassian, visit the slack channel [#help-editor](https://atlassian.slack.com/archives/CFG3PSQ9E) for support or visit [go/editor-help](https://go/editor-help) to submit a bug.
+## License
+---
+Please see [Atlassian Frontend - License](https://developer.atlassian.com/cloud/framework/atlassian-frontend/#license) for more licensing information.

package/dist/cjs/commands.js

@@ -0,0 +1,184 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.updateExpandTitle = exports.toggleExpandExpanded = exports.setSelectionInsideExpand = exports.setExpandRef = exports.insertExpand = exports.focusTitle = exports.deleteExpandAtPos = exports.deleteExpand = exports.createExpandNode = void 0;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _analytics = require("@atlaskit/editor-common/analytics");
+var _selection = require("@atlaskit/editor-common/selection");
+var _utils = require("@atlaskit/editor-common/utils");
+var _state = require("@atlaskit/editor-prosemirror/state");
+var _utils2 = require("@atlaskit/editor-prosemirror/utils");
+var _utils3 = require("@atlaskit/editor-tables/utils");
+var _pluginFactory = require("./pm-plugins/plugin-factory");
+var _utils4 = require("./utils");
+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; }
+var setExpandRef = exports.setExpandRef = function setExpandRef(ref) {
+  return (0, _pluginFactory.createCommand)({
+    type: 'SET_EXPAND_REF',
+    data: {
+      ref: ref
+    }
+  }, function (tr) {
+    return tr.setMeta('addToHistory', false);
+  });
+};
+var deleteExpandAtPos = exports.deleteExpandAtPos = function deleteExpandAtPos(editorAnalyticsAPI) {
+  return function (expandNodePos, expandNode) {
+    return function (state, dispatch) {
+      if (!expandNode || isNaN(expandNodePos)) {
+        return false;
+      }
+      var payload = {
+        action: _analytics.ACTION.DELETED,
+        actionSubject: expandNode.type === state.schema.nodes.expand ? _analytics.ACTION_SUBJECT.EXPAND : _analytics.ACTION_SUBJECT.NESTED_EXPAND,
+        attributes: {
+          inputMethod: _analytics.INPUT_METHOD.TOOLBAR
+        },
+        eventType: _analytics.EVENT_TYPE.TRACK
+      };
+      if (expandNode && dispatch) {
+        var tr = state.tr;
+        tr.delete(expandNodePos, expandNodePos + expandNode.nodeSize);
+        editorAnalyticsAPI === null || editorAnalyticsAPI === void 0 || editorAnalyticsAPI.attachAnalyticsEvent(payload)(tr);
+        dispatch(tr);
+      }
+      return true;
+    };
+  };
+};
+var deleteExpand = exports.deleteExpand = function deleteExpand(editorAnalyticsAPI) {
+  return function (state, dispatch) {
+    var expandNode = (0, _utils4.findExpand)(state);
+    if (!expandNode) {
+      return false;
+    }
+    return deleteExpandAtPos(editorAnalyticsAPI)(expandNode.pos, expandNode.node)(state, dispatch);
+  };
+};
+var updateExpandTitle = exports.updateExpandTitle = function updateExpandTitle(title, pos, nodeType) {
+  return function (state, dispatch) {
+    var node = state.doc.nodeAt(pos);
+    if (node && node.type === nodeType && dispatch) {
+      var tr = state.tr;
+      tr.setNodeMarkup(pos, node.type, _objectSpread(_objectSpread({}, node.attrs), {}, {
+        title: title
+      }), node.marks);
+      dispatch(tr);
+    }
+    return true;
+  };
+};
+var toggleExpandExpanded = exports.toggleExpandExpanded = function toggleExpandExpanded(editorAnalyticsAPI) {
+  return function (pos, nodeType) {
+    return function (state, dispatch) {
+      var node = state.doc.nodeAt(pos);
+      if (node && node.type === nodeType && dispatch) {
+        var tr = state.tr;
+        var isExpandedNext = !node.attrs.__expanded;
+        tr.setNodeMarkup(pos, node.type, _objectSpread(_objectSpread({}, node.attrs), {}, {
+          __expanded: isExpandedNext
+        }), node.marks);
+
+        // If we're going to collapse the expand and our cursor is currently inside
+        // Move to a right gap cursor, if the toolbar is interacted (or an API),
+        // it will insert below rather than inside (which will be invisible).
+        if (isExpandedNext === false && (0, _utils4.findExpand)(state)) {
+          tr.setSelection(new _selection.GapCursorSelection(tr.doc.resolve(pos + node.nodeSize), _selection.Side.RIGHT));
+        }
+
+        // log when people open/close expands
+        // TODO: ED-8523 make platform/mode global attributes?
+        var payload = {
+          action: _analytics.ACTION.TOGGLE_EXPAND,
+          actionSubject: nodeType === state.schema.nodes.expand ? _analytics.ACTION_SUBJECT.EXPAND : _analytics.ACTION_SUBJECT.NESTED_EXPAND,
+          attributes: {
+            platform: _analytics.PLATFORMS.WEB,
+            mode: _analytics.MODE.EDITOR,
+            expanded: isExpandedNext
+          },
+          eventType: _analytics.EVENT_TYPE.TRACK
+        };
+
+        // `isRemote` meta prevents this step from being
+        // sync'd between sessions in collab edit
+        tr.setMeta('isRemote', true);
+        editorAnalyticsAPI === null || editorAnalyticsAPI === void 0 || editorAnalyticsAPI.attachAnalyticsEvent(payload)(tr);
+        dispatch(tr);
+      }
+      return true;
+    };
+  };
+};
+
+// Creates either an expand or a nestedExpand node based on the current selection
+var createExpandNode = exports.createExpandNode = function createExpandNode(state) {
+  var _state$schema$nodes = state.schema.nodes,
+    expand = _state$schema$nodes.expand,
+    nestedExpand = _state$schema$nodes.nestedExpand;
+  var expandType = (0, _utils3.findTable)(state.selection) ? nestedExpand : expand;
+  return expandType.createAndFill({});
+};
+var insertExpand = exports.insertExpand = function insertExpand(editorAnalyticsAPI) {
+  return function (state, dispatch) {
+    var expandNode = createExpandNode(state);
+    if (!expandNode) {
+      return false;
+    }
+    var tr = state.selection.empty ? (0, _utils2.safeInsert)(expandNode)(state.tr).scrollIntoView() : (0, _utils.createWrapSelectionTransaction)({
+      state: state,
+      type: expandNode.type
+    });
+    var payload = {
+      action: _analytics.ACTION.INSERTED,
+      actionSubject: _analytics.ACTION_SUBJECT.DOCUMENT,
+      actionSubjectId: (expandNode === null || expandNode === void 0 ? void 0 : expandNode.type) === state.schema.nodes.expand ? _analytics.ACTION_SUBJECT_ID.EXPAND : _analytics.ACTION_SUBJECT_ID.NESTED_EXPAND,
+      attributes: {
+        inputMethod: _analytics.INPUT_METHOD.INSERT_MENU
+      },
+      eventType: _analytics.EVENT_TYPE.TRACK
+    };
+    if (dispatch && expandNode) {
+      editorAnalyticsAPI === null || editorAnalyticsAPI === void 0 || editorAnalyticsAPI.attachAnalyticsEvent(payload)(tr);
+      dispatch(tr);
+    }
+    return true;
+  };
+};
+var focusTitle = exports.focusTitle = function focusTitle(pos) {
+  return function (state, dispatch, editorView) {
+    if (editorView) {
+      var dom = editorView.domAtPos(pos);
+      var expandWrapper = dom.node.parentElement;
+      if (expandWrapper) {
+        setSelectionInsideExpand(pos)(state, dispatch, editorView);
+        var input = expandWrapper.querySelector('input');
+        if (input) {
+          input.focus();
+          return true;
+        }
+      }
+    }
+    return false;
+  };
+};
+
+// Used to clear any node or cell selection when expand title is focused
+var setSelectionInsideExpand = exports.setSelectionInsideExpand = function setSelectionInsideExpand(expandPos) {
+  return function (state, dispatch, editorView) {
+    if (editorView) {
+      if (!editorView.hasFocus()) {
+        editorView.focus();
+      }
+      var sel = _state.Selection.findFrom(editorView.state.doc.resolve(expandPos), 1, true);
+      if (sel && dispatch) {
+        dispatch(editorView.state.tr.setSelection(sel));
+      }
+      return true;
+    }
+    return false;
+  };
+};

package/dist/cjs/index.js

@@ -0,0 +1,12 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "expandPlugin", {
+  enumerable: true,
+  get: function get() {
+    return _plugin.expandPlugin;
+  }
+});
+var _plugin = require("./plugin");