@atlaskit/editor-plugin-save-on-enter 0.1.0

package/.eslintrc.js

@@ -0,0 +1,14 @@
+module.exports = {
+  rules: {
+    '@typescript-eslint/no-duplicate-imports': 'error',
+    '@typescript-eslint/no-explicit-any': 'error',
+  },
+  overrides: [
+    {
+      files: ['**/__tests__/**/*.{js,ts,tsx}', '**/examples/**/*.{js,ts,tsx}'],
+      rules: {
+        '@typescript-eslint/no-explicit-any': 'off',
+      },
+    },
+  ],
+};

package/CHANGELOG.md

@@ -0,0 +1 @@
+# @atlaskit/editor-plugin-save-on-enter

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 Save-on-enter
+
+Save-on-enter 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-save-on-enter*
+- **npm** - [@atlaskit/editor-plugin-save-on-enter](https://www.npmjs.com/package/@atlaskit/editor-plugin-save-on-enter)
+- **Source** - [Bitbucket](https://bitbucket.org/atlassian/atlassian-frontend/src/master/packages/editor/editor-plugin-save-on-enter)
+- **Bundle** - [unpkg.com](https://unpkg.com/@atlaskit/editor-plugin-save-on-enter/dist/)
+
+## Usage
+---
+**Internal use only**
+
+@atlaskit/editor-plugin-save-on-enter 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 Save-on-enter](https://atlaskit.atlassian.com/packages/editor/editor-plugin-save-on-enter) 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/index.js

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

package/dist/cjs/plugin.js

@@ -0,0 +1,69 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createPlugin = createPlugin;
+exports.saveOnEnterPlugin = void 0;
+var _analytics = require("@atlaskit/editor-common/analytics");
+var _utils = require("@atlaskit/editor-common/utils");
+var _keymap = require("@atlaskit/editor-prosemirror/keymap");
+function createPlugin(eventDispatch, onSave) {
+  if (!onSave) {
+    return;
+  }
+  return (0, _keymap.keymap)({
+    Enter: function Enter(state, _dispatch, editorView) {
+      if (editorView && canSaveOnEnter(editorView)) {
+        eventDispatch(_utils.analyticsEventKey, analyticsPayload(state));
+        onSave(editorView);
+        return true;
+      }
+      return false;
+    }
+  });
+}
+function canSaveOnEnter(editorView) {
+  var _ref = editorView.state.selection,
+    $cursor = _ref.$cursor;
+  var _editorView$state$sch = editorView.state.schema.nodes,
+    decisionItem = _editorView$state$sch.decisionItem,
+    paragraph = _editorView$state$sch.paragraph,
+    taskItem = _editorView$state$sch.taskItem;
+  return !$cursor || $cursor.parent.type === paragraph && $cursor.depth === 1 || $cursor.parent.type === decisionItem && !isEmptyAtCursor($cursor) || $cursor.parent.type === taskItem && !isEmptyAtCursor($cursor);
+}
+function isEmptyAtCursor($cursor) {
+  var content = $cursor.parent.content;
+  return !(content && content.size);
+}
+var analyticsPayload = function analyticsPayload(state) {
+  return {
+    payload: {
+      action: _analytics.ACTION.STOPPED,
+      actionSubject: _analytics.ACTION_SUBJECT.EDITOR,
+      actionSubjectId: _analytics.ACTION_SUBJECT_ID.SAVE,
+      attributes: {
+        inputMethod: _analytics.INPUT_METHOD.SHORTCUT,
+        documentSize: state.doc.nodeSize
+        // TODO add individual node counts - tables, headings, lists, mediaSingles, mediaGroups, mediaCards, panels, extensions, decisions, action, codeBlocks
+      },
+
+      eventType: _analytics.EVENT_TYPE.UI
+    }
+  };
+};
+var saveOnEnterPlugin = exports.saveOnEnterPlugin = function saveOnEnterPlugin(_ref2) {
+  var onSave = _ref2.config;
+  return {
+    name: 'saveOnEnter',
+    pmPlugins: function pmPlugins() {
+      return [{
+        name: 'saveOnEnter',
+        plugin: function plugin(_ref3) {
+          var dispatch = _ref3.dispatch;
+          return createPlugin(dispatch, onSave);
+        }
+      }];
+    }
+  };
+};

package/dist/es2019/index.js

@@ -0,0 +1 @@
+export { saveOnEnterPlugin } from './plugin';

package/dist/es2019/plugin.js

@@ -0,0 +1,62 @@
+import { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, EVENT_TYPE, INPUT_METHOD } from '@atlaskit/editor-common/analytics';
+import { analyticsEventKey } from '@atlaskit/editor-common/utils';
+import { keymap } from '@atlaskit/editor-prosemirror/keymap';
+export function createPlugin(eventDispatch, onSave) {
+  if (!onSave) {
+    return;
+  }
+  return keymap({
+    Enter(state, _dispatch, editorView) {
+      if (editorView && canSaveOnEnter(editorView)) {
+        eventDispatch(analyticsEventKey, analyticsPayload(state));
+        onSave(editorView);
+        return true;
+      }
+      return false;
+    }
+  });
+}
+function canSaveOnEnter(editorView) {
+  const {
+    $cursor
+  } = editorView.state.selection;
+  const {
+    decisionItem,
+    paragraph,
+    taskItem
+  } = editorView.state.schema.nodes;
+  return !$cursor || $cursor.parent.type === paragraph && $cursor.depth === 1 || $cursor.parent.type === decisionItem && !isEmptyAtCursor($cursor) || $cursor.parent.type === taskItem && !isEmptyAtCursor($cursor);
+}
+function isEmptyAtCursor($cursor) {
+  const {
+    content
+  } = $cursor.parent;
+  return !(content && content.size);
+}
+const analyticsPayload = state => ({
+  payload: {
+    action: ACTION.STOPPED,
+    actionSubject: ACTION_SUBJECT.EDITOR,
+    actionSubjectId: ACTION_SUBJECT_ID.SAVE,
+    attributes: {
+      inputMethod: INPUT_METHOD.SHORTCUT,
+      documentSize: state.doc.nodeSize
+      // TODO add individual node counts - tables, headings, lists, mediaSingles, mediaGroups, mediaCards, panels, extensions, decisions, action, codeBlocks
+    },
+
+    eventType: EVENT_TYPE.UI
+  }
+});
+export const saveOnEnterPlugin = ({
+  config: onSave
+}) => ({
+  name: 'saveOnEnter',
+  pmPlugins() {
+    return [{
+      name: 'saveOnEnter',
+      plugin: ({
+        dispatch
+      }) => createPlugin(dispatch, onSave)
+    }];
+  }
+});

package/dist/esm/index.js

@@ -0,0 +1 @@
+export { saveOnEnterPlugin } from './plugin';

package/dist/esm/plugin.js

@@ -0,0 +1,62 @@
+import { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, EVENT_TYPE, INPUT_METHOD } from '@atlaskit/editor-common/analytics';
+import { analyticsEventKey } from '@atlaskit/editor-common/utils';
+import { keymap } from '@atlaskit/editor-prosemirror/keymap';
+export function createPlugin(eventDispatch, onSave) {
+  if (!onSave) {
+    return;
+  }
+  return keymap({
+    Enter: function Enter(state, _dispatch, editorView) {
+      if (editorView && canSaveOnEnter(editorView)) {
+        eventDispatch(analyticsEventKey, analyticsPayload(state));
+        onSave(editorView);
+        return true;
+      }
+      return false;
+    }
+  });
+}
+function canSaveOnEnter(editorView) {
+  var _ref = editorView.state.selection,
+    $cursor = _ref.$cursor;
+  var _editorView$state$sch = editorView.state.schema.nodes,
+    decisionItem = _editorView$state$sch.decisionItem,
+    paragraph = _editorView$state$sch.paragraph,
+    taskItem = _editorView$state$sch.taskItem;
+  return !$cursor || $cursor.parent.type === paragraph && $cursor.depth === 1 || $cursor.parent.type === decisionItem && !isEmptyAtCursor($cursor) || $cursor.parent.type === taskItem && !isEmptyAtCursor($cursor);
+}
+function isEmptyAtCursor($cursor) {
+  var content = $cursor.parent.content;
+  return !(content && content.size);
+}
+var analyticsPayload = function analyticsPayload(state) {
+  return {
+    payload: {
+      action: ACTION.STOPPED,
+      actionSubject: ACTION_SUBJECT.EDITOR,
+      actionSubjectId: ACTION_SUBJECT_ID.SAVE,
+      attributes: {
+        inputMethod: INPUT_METHOD.SHORTCUT,
+        documentSize: state.doc.nodeSize
+        // TODO add individual node counts - tables, headings, lists, mediaSingles, mediaGroups, mediaCards, panels, extensions, decisions, action, codeBlocks
+      },
+
+      eventType: EVENT_TYPE.UI
+    }
+  };
+};
+export var saveOnEnterPlugin = function saveOnEnterPlugin(_ref2) {
+  var onSave = _ref2.config;
+  return {
+    name: 'saveOnEnter',
+    pmPlugins: function pmPlugins() {
+      return [{
+        name: 'saveOnEnter',
+        plugin: function plugin(_ref3) {
+          var dispatch = _ref3.dispatch;
+          return createPlugin(dispatch, onSave);
+        }
+      }];
+    }
+  };
+};

package/dist/types/index.d.ts

@@ -0,0 +1,2 @@
+export { saveOnEnterPlugin } from './plugin';
+export type { SaveOnEnterPlugin } from './plugin';

package/dist/types/plugin.d.ts

@@ -0,0 +1,11 @@
+import type { Dispatch } from '@atlaskit/editor-common/event-dispatcher';
+import type { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
+import type { EditorView } from '@atlaskit/editor-prosemirror/view';
+export declare function createPlugin(eventDispatch: Dispatch, onSave?: (editorView: EditorView) => void): SafePlugin | undefined;
+type Config = (editorView: EditorView) => void;
+export type SaveOnEnterPlugin = NextEditorPlugin<'saveOnEnter', {
+    pluginConfiguration: Config | undefined;
+}>;
+export declare const saveOnEnterPlugin: SaveOnEnterPlugin;
+export {};

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

@@ -0,0 +1,2 @@
+export { saveOnEnterPlugin } from './plugin';
+export type { SaveOnEnterPlugin } from './plugin';

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

@@ -0,0 +1,11 @@
+import type { Dispatch } from '@atlaskit/editor-common/event-dispatcher';
+import type { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
+import type { EditorView } from '@atlaskit/editor-prosemirror/view';
+export declare function createPlugin(eventDispatch: Dispatch, onSave?: (editorView: EditorView) => void): SafePlugin | undefined;
+type Config = (editorView: EditorView) => void;
+export type SaveOnEnterPlugin = NextEditorPlugin<'saveOnEnter', {
+    pluginConfiguration: Config | undefined;
+}>;
+export declare const saveOnEnterPlugin: SaveOnEnterPlugin;
+export {};

package/package.json

@@ -0,0 +1,92 @@
+{
+  "name": "@atlaskit/editor-plugin-save-on-enter",
+  "version": "0.1.0",
+  "description": "Save-on-enter plugin for @atlaskit/editor-core",
+  "author": "Atlassian Pty Ltd",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "atlassian": {
+    "team": "Editor: Lego",
+    "inPublicMirror": false,
+    "releaseModel": "continuous",
+    "website": {
+      "name": "EditorPluginSaveOnEnter",
+      "category": "Components"
+    }
+  },
+  "repository": "https://bitbucket.org/atlassian/atlassian-frontend",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "module:es2019": "dist/es2019/index.js",
+  "types": "dist/types/index.d.ts",
+  "typesVersions": {
+    ">=4.5 <4.9": {
+      "*": [
+        "dist/types-ts4.5/*",
+        "dist/types-ts4.5/index.d.ts"
+      ]
+    }
+  },
+  "sideEffects": false,
+  "atlaskit:src": "src/index.ts",
+  "af:exports": {
+    ".": "./src/index.ts"
+  },
+  "dependencies": {
+    "@atlaskit/editor-common": "^76.5.0",
+    "@atlaskit/editor-prosemirror": "1.1.0",
+    "@babel/runtime": "^7.0.0"
+  },
+  "peerDependencies": {
+    "react": "^16.8.0"
+  },
+  "devDependencies": {
+    "@af/visual-regression": "*",
+    "@atlaskit/ssr": "*",
+    "@atlaskit/visual-regression": "*",
+    "@atlaskit/webdriver-runner": "*",
+    "@atlassian/atlassian-frontend-prettier-config-1.0.0": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.0",
+    "@testing-library/react": "^12.1.5",
+    "react-dom": "^16.8.0",
+    "typescript": "~4.9.5",
+    "wait-for-expect": "^1.2.0"
+  },
+  "techstack": {
+    "@atlassian/frontend": {
+      "import-structure": [
+        "atlassian-conventions"
+      ],
+      "circular-dependencies": [
+        "file-and-folder-level"
+      ]
+    },
+    "@repo/internal": {
+      "dom-events": "use-bind-event-listener",
+      "analytics": [
+        "analytics-next"
+      ],
+      "design-tokens": [
+        "color"
+      ],
+      "theming": [
+        "react-context"
+      ],
+      "ui-components": [
+        "lite-mode"
+      ],
+      "deprecation": [
+        "no-deprecated-imports"
+      ],
+      "styling": [
+        "static",
+        "emotion"
+      ],
+      "imports": [
+        "import-no-extraneous-disable-for-examples-and-docs"
+      ]
+    }
+  },
+  "prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.0"
+}

package/report.api.md

@@ -0,0 +1,50 @@
+<!-- API Report Version: 2.3 -->
+
+## API Report File for "@atlaskit/editor-plugin-save-on-enter"
+
+> Do not edit this file. This report is auto-generated using [API Extractor](https://api-extractor.com/).
+> [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
+
+### Table of contents
+
+- [Main Entry Types](#main-entry-types)
+- [Peer Dependencies](#peer-dependencies)
+
+### Main Entry Types
+
+<!--SECTION START: Main Entry Types-->
+
+```ts
+import type { EditorView } from '@atlaskit/editor-prosemirror/view';
+import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
+
+// @public (undocumented)
+type Config = (editorView: EditorView) => void;
+
+// @public (undocumented)
+export type SaveOnEnterPlugin = NextEditorPlugin<
+  'saveOnEnter',
+  {
+    pluginConfiguration: Config | undefined;
+  }
+>;
+
+// @public (undocumented)
+export const saveOnEnterPlugin: SaveOnEnterPlugin;
+
+// (No @packageDocumentation comment for this package)
+```
+
+<!--SECTION END: Main Entry Types-->
+
+### Peer Dependencies
+
+<!--SECTION START: Peer Dependencies-->
+
+```json
+{
+  "react": "^16.8.0"
+}
+```
+
+<!--SECTION END: Peer Dependencies-->

package/tmp/api-report-tmp.d.ts

@@ -0,0 +1,23 @@
+## API Report File for "@atlaskit/editor-plugin-save-on-enter"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import type { EditorView } from '@atlaskit/editor-prosemirror/view';
+import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
+
+// @public (undocumented)
+type Config = (editorView: EditorView) => void;
+
+// @public (undocumented)
+export type SaveOnEnterPlugin = NextEditorPlugin<'saveOnEnter', {
+    pluginConfiguration: Config | undefined;
+}>;
+
+// @public (undocumented)
+export const saveOnEnterPlugin: SaveOnEnterPlugin;
+
+// (No @packageDocumentation comment for this package)
+
+```