@atlaskit/editor-plugin-interactivity 0.1.0 → 0.3.0

package/dist/types/collector/lifecycle-observer.d.ts

@@ -0,0 +1,25 @@
+export type LifecycleHandlers = {
+    /** The tab became hidden. */
+    onHidden: () => void;
+    /** The page is being unloaded. May arrive right after `onHidden`. */
+    onPageHide: () => void;
+    /** The page came back from the back/forward cache. */
+    onPageShow: () => void;
+    /** The tab became visible again — the session continues. */
+    onVisible: () => void;
+};
+/**
+ * Reports the page lifecycle signals that force an extra snapshot: the tab being hidden or
+ * shown again, and the page being unloaded or restored from the back/forward cache.
+ *
+ * None of them is guaranteed to arrive — a mobile browser being killed raises nothing at all.
+ * Snapshots carry session-to-date values, so losing the last one costs only the tail of that
+ * session.
+ */
+export declare class LifecycleObserver {
+    private readonly handlers;
+    private unbind;
+    constructor(handlers: LifecycleHandlers);
+    start(): void;
+    stop(): void;
+}

package/dist/types/collector/snapshot-scheduler.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Fires `onTick` on the snapshot cadence. Timings are offsets from `start()`, so a
+ * restart (a new session in the same editor) restarts the cadence too.
+ */
+export declare class SnapshotScheduler {
+    private readonly onTick;
+    private timeoutId;
+    private tickIndex;
+    constructor(onTick: () => void);
+    start(): void;
+    restart(): void;
+    stop(): void;
+    private scheduleNext;
+    private delayForNextTick;
+}

package/dist/types/interactivityPlugin.d.ts

@@ -1,9 +1,11 @@
 import type { InteractivityPlugin } from './interactivityPluginType';
 /**
- * Reports interaction latency distributions for full page editor sessions as the
- * `editor interactivity` operational event.
+ * Reports session-to-date 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.
+ * The session runs for as long as the plugin's hook stays mounted, which is one editor
+ * mount: `MountPluginHooks` in editor-core keys hook fibers by plugin name, so a preset
+ * reconfigure — which destroys and recreates ProseMirror plugin views — leaves this hook,
+ * and the session, in place.
  */
 export declare const interactivityPlugin: InteractivityPlugin;

package/dist/types/interactivityPluginType.d.ts

@@ -1,2 +1,11 @@
-import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
-export type InteractivityPlugin = NextEditorPlugin<'interactivity'>;
+import type { NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
+import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics/analyticsPluginType';
+import type { ContextIdentifierPlugin } from '@atlaskit/editor-plugin-context-identifier/contextIdentifierPluginType';
+import type { EditorViewModePlugin } from '@atlaskit/editor-plugin-editor-viewmode/editorViewmodePluginType';
+export type InteractivityPlugin = NextEditorPlugin<'interactivity', {
+    dependencies: [
+        OptionalPlugin<AnalyticsPlugin>,
+        OptionalPlugin<ContextIdentifierPlugin>,
+        OptionalPlugin<EditorViewModePlugin>
+    ];
+}>;

package/docs/0-intro.tsx

@@ -1,7 +1,6 @@
 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';
 
@@ -24,24 +23,44 @@ ${createEditorUseOnlyNotice('Editor Plugin Interactivity', [
 
   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.
+  It reports the \`editor interactivity\` operational event: session-to-date interaction latency
+  histograms for full page editor sessions — for the page as a whole, and for the editor's typing,
+  pointer and other interactions — per [RFC 095](https://hello.atlassian.net/wiki/spaces/EDITOR/pages/7527607488/Editor+RFC+095+Confluence+editor+responsiveness+bucketed+INP+telemetry).
+  See the package README for the event shape, the snapshot cadence and what ends a session.
+
+  The plugin has no configuration, state, actions or commands — adding it to a preset is what turns
+  collection on.
 
   ## Usage
 ---
 
-Add the plugin to a preset. It has no configuration, state, actions or commands, so there is
+Add the plugin to a preset. It reports for as long as the editor stays mounted, so there is
 nothing to call:
 
 ${code`
 import { interactivityPlugin } from '@atlaskit/editor-plugin-interactivity';
 
-const preset = new EditorPresetBuilder().add(interactivityPlugin);
+const preset = new EditorPresetBuilder()
+	.add(analyticsPlugin)
+	.add(contextIdentifierPlugin)
+	.add(editorViewModePlugin)
+	.add(interactivityPlugin);
 `}
 
+All three dependencies are optional, but the event is only fired when the analytics plugin is
+present, and the session is only split per document and per mode when the other two are:
+
 ${code`
-type InteractivityPlugin = NextEditorPlugin<'interactivity'>
+type InteractivityPlugin = NextEditorPlugin<
+	'interactivity',
+	{
+		dependencies: [
+			OptionalPlugin<AnalyticsPlugin>,
+			OptionalPlugin<ContextIdentifierPlugin>,
+			OptionalPlugin<EditorViewModePlugin>,
+		];
+	}
+>
 `}
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-interactivity",
-	"version": "0.1.0",
+	"version": "0.3.0",
 	"description": "Interactivity plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -19,10 +19,15 @@
 	"types": "dist/types/index.d.ts",
 	"sideEffects": false,
 	"dependencies": {
-		"@babel/runtime": "^7.0.0"
+		"@atlaskit/browser-apis": "^1.2.0",
+		"@atlaskit/editor-plugin-analytics": "^15.0.0",
+		"@atlaskit/editor-plugin-context-identifier": "^15.0.0",
+		"@atlaskit/editor-plugin-editor-viewmode": "^17.0.0",
+		"@babel/runtime": "^7.0.0",
+		"bind-event-listener": "^3.0.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^119.5.0",
+		"@atlaskit/editor-common": "^119.10.0",
 		"react": "^18.2.0 || ^19.2.0"
 	},
 	"devDependencies": {