@atlaskit/editor-plugin-interaction 1.0.1

package/CHANGELOG.md

@@ -0,0 +1,10 @@
+# @atlaskit/editor-plugin-interaction
+
+## 1.0.1
+
+### Patch Changes
+
+- [#140394](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/140394)
+  [`aa5fe04b853bf`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/aa5fe04b853bf) -
+  [ED-27253] Introduce interaction plugin to track first interaction on page
+- Updated dependencies

package/LICENSE.md

@@ -0,0 +1,11 @@
+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 Interaction
+
+Interaction 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-interaction*
+- **npm** - [@atlaskit/editor-plugin-interaction](https://www.npmjs.com/package/@atlaskit/editor-plugin-interaction)
+- **Source** - [Bitbucket](https://bitbucket.org/atlassian/atlassian-frontend/src/master/packages/editor/editor-plugin-interaction)
+- **Bundle** - [unpkg.com](https://unpkg.com/@atlaskit/editor-plugin-interaction/dist/)
+
+## Usage
+---
+**Internal use only**
+
+@atlaskit/editor-plugin-interaction 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 interaction](https://atlaskit.atlassian.com/packages/editor/editor-plugin-interaction) 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://hello.atlassian.net/wiki/spaces/AF/pages/2589099144/Documentation#License) for more licensing information.

package/afm-cc/tsconfig.json

@@ -0,0 +1,27 @@
+{
+    "extends": "../../../../tsconfig.entry-points.confluence.json",
+    "compilerOptions": {
+        "target": "es5",
+        "composite": true,
+        "outDir": "../dist",
+        "rootDir": "../"
+    },
+    "include": [
+        "../src/**/*.ts",
+        "../src/**/*.tsx"
+    ],
+    "exclude": [
+        "../src/**/__tests__/*",
+        "../src/**/*.test.*",
+        "../src/**/test.*",
+        "../src/**/examples.*"
+    ],
+    "references": [
+        {
+            "path": "../../editor-common/afm-cc/tsconfig.json"
+        },
+        {
+            "path": "../../../design-system/tokens/afm-cc/tsconfig.json"
+        }
+    ]
+}

package/afm-jira/tsconfig.json

@@ -0,0 +1,27 @@
+{
+	"extends": "../../../../tsconfig.entry-points.jira.json",
+	"compilerOptions": {
+		"target": "es5",
+		"outDir": "../../../../../tsDist/@atlaskit__editor-plugin-interaction/app",
+		"rootDir": "../",
+		"composite": true
+	},
+	"include": [
+		"../src/**/*.ts",
+		"../src/**/*.tsx"
+	],
+	"exclude": [
+		"../src/**/__tests__/*",
+		"../src/**/*.test.*",
+		"../src/**/test.*",
+		"../src/**/examples.*"
+	],
+	"references": [
+		{
+			"path": "../../editor-common/afm-jira/tsconfig.json"
+		},
+		{
+			"path": "../../../design-system/tokens/afm-jira/tsconfig.json"
+		}
+	]
+}

package/afm-post-office/tsconfig.json

@@ -0,0 +1,27 @@
+{
+	"extends": "../../../../tsconfig.entry-points.post-office.json",
+	"compilerOptions": {
+		"target": "es5",
+		"outDir": "../../../../../post-office/tsDist/@atlaskit__editor-plugin-interaction/app",
+		"rootDir": "../",
+		"composite": true
+	},
+	"include": [
+		"../src/**/*.ts",
+		"../src/**/*.tsx"
+	],
+	"exclude": [
+		"../src/**/__tests__/*",
+		"../src/**/*.test.*",
+		"../src/**/test.*",
+		"../src/**/examples.*"
+	],
+	"references": [
+		{
+			"path": "../../editor-common/afm-post-office/tsconfig.json"
+		},
+		{
+			"path": "../../../design-system/tokens/afm-post-office/tsconfig.json"
+		}
+	]
+}

package/build/tsconfig.json

@@ -0,0 +1,17 @@
+{
+	"extends": "../tsconfig",
+	"compilerOptions": {
+		"target": "es5",
+		"paths": {}
+	},
+	"include": [
+		"../src/**/*.ts",
+		"../src/**/*.tsx"
+	],
+	"exclude": [
+		"../src/**/__tests__/*",
+		"../src/**/*.test.*",
+		"../src/**/test.*",
+		"../src/**/examples.*"
+	]
+}

package/dist/cjs/index.js

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

package/dist/cjs/interactionPlugin.js

@@ -0,0 +1,30 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.interactionPlugin = void 0;
+var _main = require("./pm-plugins/main");
+var interactionPlugin = exports.interactionPlugin = function interactionPlugin(_ref) {
+  var api = _ref.api;
+  return {
+    name: 'interaction',
+    getSharedState: function getSharedState(editorState) {
+      var _key$getState;
+      if (!editorState) {
+        return {
+          hasHadInteraction: false
+        };
+      }
+      return {
+        hasHadInteraction: Boolean((_key$getState = _main.key.getState(editorState)) === null || _key$getState === void 0 ? void 0 : _key$getState.hasHadInteraction)
+      };
+    },
+    pmPlugins: function pmPlugins() {
+      return [{
+        name: 'interactionHandlerPlugin',
+        plugin: _main.createPlugin
+      }];
+    }
+  };
+};

package/dist/cjs/interactionPluginType.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

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

@@ -0,0 +1,50 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.key = exports.createPlugin = void 0;
+var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
+var _safePlugin = require("@atlaskit/editor-common/safe-plugin");
+var _state = require("@atlaskit/editor-prosemirror/state");
+var key = exports.key = new _state.PluginKey('interactionPluginHandler');
+var handleInteraction = function handleInteraction(view) {
+  var interactionState = key.getState(view.state);
+  if (!(interactionState !== null && interactionState !== void 0 && interactionState.hasHadInteraction)) {
+    view.dispatch(view.state.tr.setMeta(key, {
+      hasHadInteraction: true
+    }));
+  }
+  return false;
+};
+var createPlugin = exports.createPlugin = function createPlugin() {
+  return new _safePlugin.SafePlugin({
+    key: key,
+    state: {
+      init: function init() {
+        return {
+          hasHadInteraction: false
+        };
+      },
+      apply: function apply(tr, oldPluginState) {
+        var meta = tr.getMeta(key);
+        if ((0, _typeof2.default)(meta) === 'object') {
+          if (meta.hasHadInteraction !== oldPluginState.hasHadInteraction) {
+            return {
+              hasHadInteraction: meta.hasHadInteraction
+            };
+          }
+        }
+        return oldPluginState;
+      }
+    },
+    props: {
+      handleDOMEvents: {
+        mousedown: handleInteraction,
+        keyup: handleInteraction,
+        drop: handleInteraction
+      }
+    }
+  });
+};

package/dist/cjs/types/index.js

@@ -0,0 +1 @@
+"use strict";

package/dist/es2019/index.js

@@ -0,0 +1,4 @@
+/* eslint-disable @atlaskit/editor/no-re-export */
+// Entry file in package.json
+
+export { interactionPlugin } from './interactionPlugin';

package/dist/es2019/interactionPlugin.js

@@ -0,0 +1,25 @@
+import { createPlugin, key } from './pm-plugins/main';
+export const interactionPlugin = ({
+  api
+}) => {
+  return {
+    name: 'interaction',
+    getSharedState(editorState) {
+      var _key$getState;
+      if (!editorState) {
+        return {
+          hasHadInteraction: false
+        };
+      }
+      return {
+        hasHadInteraction: Boolean((_key$getState = key.getState(editorState)) === null || _key$getState === void 0 ? void 0 : _key$getState.hasHadInteraction)
+      };
+    },
+    pmPlugins() {
+      return [{
+        name: 'interactionHandlerPlugin',
+        plugin: createPlugin
+      }];
+    }
+  };
+};

package/dist/es2019/interactionPluginType.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,40 @@
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+export const key = new PluginKey('interactionPluginHandler');
+const handleInteraction = view => {
+  const interactionState = key.getState(view.state);
+  if (!(interactionState !== null && interactionState !== void 0 && interactionState.hasHadInteraction)) {
+    view.dispatch(view.state.tr.setMeta(key, {
+      hasHadInteraction: true
+    }));
+  }
+  return false;
+};
+export const createPlugin = () => new SafePlugin({
+  key,
+  state: {
+    init() {
+      return {
+        hasHadInteraction: false
+      };
+    },
+    apply(tr, oldPluginState) {
+      const meta = tr.getMeta(key);
+      if (typeof meta === 'object') {
+        if (meta.hasHadInteraction !== oldPluginState.hasHadInteraction) {
+          return {
+            hasHadInteraction: meta.hasHadInteraction
+          };
+        }
+      }
+      return oldPluginState;
+    }
+  },
+  props: {
+    handleDOMEvents: {
+      mousedown: handleInteraction,
+      keyup: handleInteraction,
+      drop: handleInteraction
+    }
+  }
+});

package/dist/esm/index.js

@@ -0,0 +1,4 @@
+/* eslint-disable @atlaskit/editor/no-re-export */
+// Entry file in package.json
+
+export { interactionPlugin } from './interactionPlugin';

package/dist/esm/interactionPlugin.js

@@ -0,0 +1,24 @@
+import { createPlugin, key } from './pm-plugins/main';
+export var interactionPlugin = function interactionPlugin(_ref) {
+  var api = _ref.api;
+  return {
+    name: 'interaction',
+    getSharedState: function getSharedState(editorState) {
+      var _key$getState;
+      if (!editorState) {
+        return {
+          hasHadInteraction: false
+        };
+      }
+      return {
+        hasHadInteraction: Boolean((_key$getState = key.getState(editorState)) === null || _key$getState === void 0 ? void 0 : _key$getState.hasHadInteraction)
+      };
+    },
+    pmPlugins: function pmPlugins() {
+      return [{
+        name: 'interactionHandlerPlugin',
+        plugin: createPlugin
+      }];
+    }
+  };
+};

package/dist/esm/interactionPluginType.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,43 @@
+import _typeof from "@babel/runtime/helpers/typeof";
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+export var key = new PluginKey('interactionPluginHandler');
+var handleInteraction = function handleInteraction(view) {
+  var interactionState = key.getState(view.state);
+  if (!(interactionState !== null && interactionState !== void 0 && interactionState.hasHadInteraction)) {
+    view.dispatch(view.state.tr.setMeta(key, {
+      hasHadInteraction: true
+    }));
+  }
+  return false;
+};
+export var createPlugin = function createPlugin() {
+  return new SafePlugin({
+    key: key,
+    state: {
+      init: function init() {
+        return {
+          hasHadInteraction: false
+        };
+      },
+      apply: function apply(tr, oldPluginState) {
+        var meta = tr.getMeta(key);
+        if (_typeof(meta) === 'object') {
+          if (meta.hasHadInteraction !== oldPluginState.hasHadInteraction) {
+            return {
+              hasHadInteraction: meta.hasHadInteraction
+            };
+          }
+        }
+        return oldPluginState;
+      }
+    },
+    props: {
+      handleDOMEvents: {
+        mousedown: handleInteraction,
+        keyup: handleInteraction,
+        drop: handleInteraction
+      }
+    }
+  });
+};

package/dist/types/index.d.ts

@@ -0,0 +1,3 @@
+export { interactionPlugin } from './interactionPlugin';
+export type { InteractionPlugin } from './interactionPluginType';
+export type { InteractionState } from './types';

package/dist/types/interactionPlugin.d.ts

@@ -0,0 +1,2 @@
+import { type InteractionPlugin } from './interactionPluginType';
+export declare const interactionPlugin: InteractionPlugin;

package/dist/types/interactionPluginType.d.ts

@@ -0,0 +1,5 @@
+import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
+import { type InteractionState } from './types';
+export type InteractionPlugin = NextEditorPlugin<'interaction', {
+    sharedState: InteractionState;
+}>;

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

@@ -0,0 +1,5 @@
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+import { type InteractionState } from '../types';
+export declare const key: PluginKey<InteractionState>;
+export declare const createPlugin: () => SafePlugin<InteractionState>;

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

@@ -0,0 +1,3 @@
+export type InteractionState = {
+    hasHadInteraction: boolean;
+};

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

@@ -0,0 +1,3 @@
+export { interactionPlugin } from './interactionPlugin';
+export type { InteractionPlugin } from './interactionPluginType';
+export type { InteractionState } from './types';

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

@@ -0,0 +1,2 @@
+import { type InteractionPlugin } from './interactionPluginType';
+export declare const interactionPlugin: InteractionPlugin;

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

@@ -0,0 +1,5 @@
+import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
+import { type InteractionState } from './types';
+export type InteractionPlugin = NextEditorPlugin<'interaction', {
+    sharedState: InteractionState;
+}>;

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

@@ -0,0 +1,5 @@
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+import { type InteractionState } from '../types';
+export declare const key: PluginKey<InteractionState>;
+export declare const createPlugin: () => SafePlugin<InteractionState>;

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

@@ -0,0 +1,3 @@
+export type InteractionState = {
+    hasHadInteraction: boolean;
+};

package/package.json

@@ -0,0 +1,79 @@
+{
+	"name": "@atlaskit/editor-plugin-interaction",
+	"version": "1.0.1",
+	"description": "Interaction plugin for @atlaskit/editor-core",
+	"author": "Atlassian Pty Ltd",
+	"license": "Apache-2.0",
+	"publishConfig": {
+		"registry": "https://registry.npmjs.org/"
+	},
+	"atlassian": {
+		"team": "Editor: Jenga",
+		"singleton": true,
+		"runReact18": true
+	},
+	"repository": "https://bitbucket.org/atlassian/atlassian-frontend-mirror",
+	"main": "dist/cjs/index.js",
+	"module": "dist/esm/index.js",
+	"module:es2019": "dist/es2019/index.js",
+	"types": "dist/types/index.d.ts",
+	"sideEffects": false,
+	"atlaskit:src": "src/index.ts",
+	"af:exports": {
+		".": "./src/index.ts"
+	},
+	"dependencies": {
+		"@atlaskit/editor-common": "^103.9.0",
+		"@atlaskit/editor-prosemirror": "7.0.0",
+		"@babel/runtime": "^7.0.0"
+	},
+	"peerDependencies": {
+		"@atlaskit/tokens": "^4.8.0",
+		"react": "^18.2.0",
+		"react-dom": "^18.2.0"
+	},
+	"devDependencies": {
+		"typescript": "~5.4.2"
+	},
+	"techstack": {
+		"@atlassian/frontend": {
+			"code-structure": [
+				"editor-plugin"
+			],
+			"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": [
+				"emotion",
+				"compiled"
+			],
+			"imports": [
+				"import-no-extraneous-disable-for-examples-and-docs"
+			],
+			"stricter": {
+				"no-unused-dependencies": {
+					"checkDevDependencies": true
+				}
+			}
+		}
+	}
+}

package/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "../../../tsconfig.json",
+  "include": [
+    "src/**/*.ts",
+    "src/**/*.tsx"
+  ],
+  "compilerOptions": {
+  }
+}