@atlaskit/editor-plugin-interactivity 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,14 @@
+# @atlaskit/editor-plugin-interactivity
+
+## 0.1.0
+
+### Minor Changes
+
+- [`40071c3a1e51d`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/40071c3a1e51d) -
+  Add the interactivity plugin package and register it in the Confluence full page presets behind
+  the platform_editor_editor_interactivity experiment. The plugin is a stub for now — it collects
+  nothing.
+
+### Patch Changes
+
+- Updated dependencies

package/LICENSE.md

@@ -0,0 +1,11 @@
+Copyright 2019 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,59 @@
+# Editor Plugin Interactivity
+
+Interactivity 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.
+
+## Overview
+
+The Interactivity plugin reports the `editor interactivity` operational event: how interaction
+latencies were spread over an editor session, as bucketed counts, per
+[RFC 095](https://hello.atlassian.net/wiki/spaces/EDITOR/pages/7527607488/Editor+RFC+095+Confluence+editor+responsiveness+bucketed+INP+telemetry).
+The existing `editor inp` event reports a single value per session and cannot answer how many
+interactions were slow.
+
+The plugin is a stub at this point — it registers itself and collects nothing. The collector and the
+event arrive in EDITOR-8553.
+
+## Install
+
+---
+
+- **Install** - _yarn add @atlaskit/editor-plugin-interactivity_
+- **npm** -
+  [@atlaskit/editor-plugin-interactivity](https://www.npmjs.com/package/@atlaskit/editor-plugin-interactivity)
+- **Source** -
+  [Bitbucket](https://bitbucket.org/atlassian/atlassian-frontend/src/master/packages/editor/editor-plugin-interactivity)
+- **Bundle** - [unpkg.com](https://unpkg.com/@atlaskit/editor-plugin-interactivity/dist/)
+
+## Usage
+
+---
+
+**Internal use only**
+
+@atlaskit/editor-plugin-interactivity 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 interactivity](https://atlaskit.atlassian.com/packages/editor/editor-plugin-interactivity)
+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,25 @@
+{
+	"extends": "../../../../tsconfig.local-consumption.json",
+	"include": [
+		"../src/**/*.ts",
+		"../src/**/*.tsx"
+	],
+	"exclude": [
+		"../src/**/__tests__/*",
+		"../src/**/*.test.*",
+		"../src/**/test.*",
+		"../src/**/mocks/*",
+		"../src/**/examples.*"
+	],
+	"compilerOptions": {
+		"outDir": "../../../../../confluence/tsDist/@atlaskit__editor-plugin-interactivity",
+		"rootDir": "../",
+		"composite": true,
+		"noCheck": true
+	},
+	"references": [
+		{
+			"path": "../../editor-common/afm-cc/tsconfig.json"
+		}
+	]
+}

package/afm-products/tsconfig.json

@@ -0,0 +1,25 @@
+{
+	"extends": "../../../../tsconfig.local-consumption.json",
+	"include": [
+		"../src/**/*.ts",
+		"../src/**/*.tsx"
+	],
+	"exclude": [
+		"../src/**/__tests__/*",
+		"../src/**/*.test.*",
+		"../src/**/test.*",
+		"../src/**/mocks/*",
+		"../src/**/examples.*"
+	],
+	"compilerOptions": {
+		"outDir": "../../../../../tsDist/@atlaskit__editor-plugin-interactivity/app",
+		"rootDir": "../",
+		"composite": true,
+		"noCheck": true
+	},
+	"references": [
+		{
+			"path": "../../editor-common/afm-products/tsconfig.json"
+		}
+	]
+}

package/dist/cjs/index.js

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

package/dist/cjs/interactivityPlugin.js

@@ -0,0 +1,18 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.interactivityPlugin = void 0;
+/**
+ * Reports interaction latency distributions for full page editor sessions as the
+ * `editor interactivity` operational event.
+ *
+ * A stub for now: the plugin only registers itself. The collector and the event land in
+ * EDITOR-8553.
+ */
+var interactivityPlugin = exports.interactivityPlugin = function interactivityPlugin() {
+  return {
+    name: 'interactivity'
+  };
+};

package/dist/cjs/interactivityPluginType.js

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

package/dist/es2019/index.js

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

package/dist/es2019/interactivityPlugin.js

@@ -0,0 +1,10 @@
+/**
+ * Reports interaction latency distributions for full page editor sessions as the
+ * `editor interactivity` operational event.
+ *
+ * A stub for now: the plugin only registers itself. The collector and the event land in
+ * EDITOR-8553.
+ */
+export const interactivityPlugin = () => ({
+  name: 'interactivity'
+});

package/dist/es2019/interactivityPluginType.js

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

package/dist/esm/index.js

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

package/dist/esm/interactivityPlugin.js

@@ -0,0 +1,12 @@
+/**
+ * Reports interaction latency distributions for full page editor sessions as the
+ * `editor interactivity` operational event.
+ *
+ * A stub for now: the plugin only registers itself. The collector and the event land in
+ * EDITOR-8553.
+ */
+export var interactivityPlugin = function interactivityPlugin() {
+  return {
+    name: 'interactivity'
+  };
+};

package/dist/esm/interactivityPluginType.js

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

package/dist/types/index.d.ts

@@ -0,0 +1,2 @@
+export { interactivityPlugin } from './interactivityPlugin';
+export type { InteractivityPlugin } from './interactivityPluginType';

package/dist/types/interactivityPlugin.d.ts

@@ -0,0 +1,9 @@
+import type { InteractivityPlugin } from './interactivityPluginType';
+/**
+ * Reports interaction latency distributions for full page editor sessions as the
+ * `editor interactivity` operational event.
+ *
+ * A stub for now: the plugin only registers itself. The collector and the event land in
+ * EDITOR-8553.
+ */
+export declare const interactivityPlugin: InteractivityPlugin;

package/dist/types/interactivityPluginType.d.ts

@@ -0,0 +1,2 @@
+import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
+export type InteractivityPlugin = NextEditorPlugin<'interactivity'>;

package/docs/0-intro.tsx

@@ -0,0 +1,55 @@
+import React from 'react';
+
+import { AtlassianInternalWarning, code, md } from '@atlaskit/docs';
+// eslint-disable-next-line @atlassian/tangerine/import/entry-points
+import { createEditorUseOnlyNotice } from '@atlaskit/editor-common/doc-utils';
+import { token } from '@atlaskit/tokens';
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const readmeDocs: any = md`
+
+${createEditorUseOnlyNotice('Editor Plugin Interactivity', [
+	{ name: 'Editor Core', link: '/packages/editor/editor-core' },
+])}
+
+
+  ${(
+		<>
+			{/* eslint-disable-next-line @atlaskit/ui-styling-standard/enforce-style-prop -- Ignored via go/DSP-18766 */}
+			<div style={{ marginTop: token('space.100') }}>
+				<AtlassianInternalWarning />
+			</div>
+		</>
+	)}
+
+  This package includes the interactivity plugin used by \`@atlaskit/editor-core\`.
+
+  It will report the \`editor interactivity\` operational event: how interaction latencies were
+  spread over an editor session, as bucketed counts, per [RFC 095](https://hello.atlassian.net/wiki/spaces/EDITOR/pages/7527607488/Editor+RFC+095+Confluence+editor+responsiveness+bucketed+INP+telemetry).
+  The plugin is a stub at this point and collects nothing.
+
+  ## Usage
+---
+
+Add the plugin to a preset. It has no configuration, state, actions or commands, so there is
+nothing to call:
+
+${code`
+import { interactivityPlugin } from '@atlaskit/editor-plugin-interactivity';
+
+const preset = new EditorPresetBuilder().add(interactivityPlugin);
+`}
+
+${code`
+type InteractivityPlugin = NextEditorPlugin<'interactivity'>
+`}
+
+
+  ## 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.
+`;
+export default readmeDocs;

package/package.json

@@ -0,0 +1,68 @@
+{
+	"name": "@atlaskit/editor-plugin-interactivity",
+	"version": "0.1.0",
+	"description": "Interactivity plugin for @atlaskit/editor-core",
+	"author": "Atlassian Pty Ltd",
+	"license": "Apache-2.0",
+	"publishConfig": {
+		"registry": "https://registry.npmjs.org/"
+	},
+	"atlassian": {
+		"team": "Editor: Lego",
+		"releaseModel": "continuous",
+		"singleton": 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,
+	"dependencies": {
+		"@babel/runtime": "^7.0.0"
+	},
+	"peerDependencies": {
+		"@atlaskit/editor-common": "^119.5.0",
+		"react": "^18.2.0 || ^19.2.0"
+	},
+	"devDependencies": {
+		"react": "^19.2.0",
+		"typescript": "npm:@typescript/typescript6@^6.0.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",
+				"emotion"
+			],
+			"imports": [
+				"import-no-extraneous-disable-for-examples-and-docs"
+			]
+		}
+	}
+}

package/tsconfig.json

@@ -0,0 +1,4 @@
+{
+	"extends": "./tsconfig.dev.json",
+	"compilerOptions": { "disableReferencedProjectLoad": true, "disableSolutionSearching": true }
+}