@atlaskit/editor-plugin-collab-edit 15.0.8 → 16.0.1

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # @atlaskit/editor-plugin-collab-edit
 
+## 16.0.1
+
+### Patch Changes
+
+- Updated dependencies
+
+## 16.0.0
+
+### Patch Changes
+
+- [`ddb1f3da1e991`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/ddb1f3da1e991) -
+  Track acceptance rate for backend-persisted agent edits. These arrive as remote collab steps
+  rather than frontend-streamed transformations, so they previously started no analytics session and
+  were absent from the metric. They now reuse the existing survival definition, and are recorded
+  only on the requesting user's client.
+
+  Gated by `platform_editor_agent_be_streaming`, which controls whether remote agent steps are
+  annotated at all, and by the agent type allowlist in
+  `platform_editor_backend_review_moment_agent_types`, which defaults to empty. Recording cannot
+  occur unless both permit it.
+
+- Updated dependencies
+
 ## 15.0.8
 
 ### Patch Changes

package/dist/cjs/pm-plugins/main/agent-review-segments.js

@@ -7,6 +7,7 @@ exports.getAgentEditSegments = exports.REVIEW_MOMENT_AGENT_TYPES_CONFIG = void 0
 var _expVal = require("@atlaskit/platform-feature-experiments/exp-val");
 var _prosemirrorCollab = require("@atlaskit/prosemirror-collab");
 var _agentShimmerRanges = require("./agent-shimmer-ranges");
+var _pluginKey = require("./plugin-key");
 // Statsig dynamic config: which BE-streaming `agentType` values may open Review Moment.
 // Code default is `[]` (fail closed) until the list is set in Statsig.
 var REVIEW_MOMENT_AGENT_TYPES_CONFIG = exports.REVIEW_MOMENT_AGENT_TYPES_CONFIG = 'platform_editor_backend_review_moment_agent_types';
@@ -99,6 +100,7 @@ var mapToBeforeDoc = function mapToBeforeDoc(steps, pos, stepIndex, bias) {
  * @param view  the editor view (for the collab rebase guard)
  */
 var getAgentEditSegments = exports.getAgentEditSegments = function getAgentEditSegments(json, steps, tr, view) {
+  var _collabPluginState$ac;
   // `agentType` present ⇒ agent-authored (per the NCS↔Editor steps contract). Read
   // from the first agent step; it is identical across a batch.
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -118,6 +120,13 @@ var getAgentEditSegments = exports.getAgentEditSegments = function getAgentEditS
   // The user the agent acted on behalf of (the requester). Optional/additive on the
   // step contract, so it may be absent.
   var actorUserId = typeof (agentStep === null || agentStep === void 0 ? void 0 : agentStep.userId) === 'string' ? agentStep.userId : undefined;
+  // Resolve the local user's AAID via the collab session: the plugin state knows this
+  // client's session id, and the participant list maps that to a `userId`. Both are
+  // optional, so an unresolvable identity degrades to `false` (see the contract).
+  var collabPluginState = _pluginKey.pluginKey.getState(view.state);
+  var localSessionId = collabPluginState === null || collabPluginState === void 0 ? void 0 : collabPluginState.sessionId;
+  var localUserId = localSessionId ? collabPluginState === null || collabPluginState === void 0 || (_collabPluginState$ac = collabPluginState.activeParticipants) === null || _collabPluginState$ac === void 0 || (_collabPluginState$ac = _collabPluginState$ac.get(localSessionId)) === null || _collabPluginState$ac === void 0 ? void 0 : _collabPluginState$ac.userId : undefined;
+  var isLocalUserRequester = actorUserId !== undefined && localUserId !== undefined && actorUserId === localUserId;
   // Which agent instance wrote the batch. Additive on the step contract like
   // `userId`, so treat it as optional. Carried for contract clarity / future
   // per-agent attribution; nothing consumes it yet.
@@ -280,6 +289,7 @@ var getAgentEditSegments = exports.getAgentEditSegments = function getAgentEditS
       agentId: agentId,
       agentType: agentType,
       complete: complete,
+      isLocalUserRequester: isLocalUserRequester,
       segments: segments
     };
   } catch (_unused3) {

package/dist/cjs/pm-plugins/track-steps.js

@@ -17,7 +17,6 @@ function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length)
 function groupBy(array, keyGetter) {
   // Check group by exists, and that it's a function. If so, use the native browser code
   if ('groupBy' in Object && typeof Object.groupBy === 'function') {
-    // @ts-ignore TS2322 - Type 'Partial<Record<string, T[]>>' is not assignable to type 'Record<string, T[]>'.
     return Object.groupBy(array, keyGetter);
   }
 

package/dist/es2019/pm-plugins/main/agent-review-segments.js

@@ -1,6 +1,7 @@
 import { expVal } from '@atlaskit/platform-feature-experiments/exp-val';
 import { getCollabState } from '@atlaskit/prosemirror-collab';
 import { isPositionNeutralStep } from './agent-shimmer-ranges';
+import { pluginKey } from './plugin-key';
 
 // Statsig dynamic config: which BE-streaming `agentType` values may open Review Moment.
 // Code default is `[]` (fail closed) until the list is set in Statsig.
@@ -88,6 +89,7 @@ const mapToBeforeDoc = (steps, pos, stepIndex, bias) => {
  * @param view  the editor view (for the collab rebase guard)
  */
 export const getAgentEditSegments = (json, steps, tr, view) => {
+  var _collabPluginState$ac, _collabPluginState$ac2;
   // `agentType` present ⇒ agent-authored (per the NCS↔Editor steps contract). Read
   // from the first agent step; it is identical across a batch.
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -105,6 +107,13 @@ export const getAgentEditSegments = (json, steps, tr, view) => {
   // The user the agent acted on behalf of (the requester). Optional/additive on the
   // step contract, so it may be absent.
   const actorUserId = typeof (agentStep === null || agentStep === void 0 ? void 0 : agentStep.userId) === 'string' ? agentStep.userId : undefined;
+  // Resolve the local user's AAID via the collab session: the plugin state knows this
+  // client's session id, and the participant list maps that to a `userId`. Both are
+  // optional, so an unresolvable identity degrades to `false` (see the contract).
+  const collabPluginState = pluginKey.getState(view.state);
+  const localSessionId = collabPluginState === null || collabPluginState === void 0 ? void 0 : collabPluginState.sessionId;
+  const localUserId = localSessionId ? collabPluginState === null || collabPluginState === void 0 ? void 0 : (_collabPluginState$ac = collabPluginState.activeParticipants) === null || _collabPluginState$ac === void 0 ? void 0 : (_collabPluginState$ac2 = _collabPluginState$ac.get(localSessionId)) === null || _collabPluginState$ac2 === void 0 ? void 0 : _collabPluginState$ac2.userId : undefined;
+  const isLocalUserRequester = actorUserId !== undefined && localUserId !== undefined && actorUserId === localUserId;
   // Which agent instance wrote the batch. Additive on the step contract like
   // `userId`, so treat it as optional. Carried for contract clarity / future
   // per-agent attribution; nothing consumes it yet.
@@ -261,6 +270,7 @@ export const getAgentEditSegments = (json, steps, tr, view) => {
       agentId,
       agentType,
       complete,
+      isLocalUserRequester,
       segments
     };
   } catch {

package/dist/es2019/pm-plugins/track-steps.js

@@ -7,7 +7,6 @@ import { updateNcsSessionStepMetrics } from './track-step-metrics';
 function groupBy(array, keyGetter) {
   // Check group by exists, and that it's a function. If so, use the native browser code
   if ('groupBy' in Object && typeof Object.groupBy === 'function') {
-    // @ts-ignore TS2322 - Type 'Partial<Record<string, T[]>>' is not assignable to type 'Record<string, T[]>'.
     return Object.groupBy(array, keyGetter);
   }
 

package/dist/esm/pm-plugins/main/agent-review-segments.js

@@ -1,6 +1,7 @@
 import { expVal } from '@atlaskit/platform-feature-experiments/exp-val';
 import { getCollabState } from '@atlaskit/prosemirror-collab';
 import { isPositionNeutralStep } from './agent-shimmer-ranges';
+import { pluginKey } from './plugin-key';
 
 // Statsig dynamic config: which BE-streaming `agentType` values may open Review Moment.
 // Code default is `[]` (fail closed) until the list is set in Statsig.
@@ -94,6 +95,7 @@ var mapToBeforeDoc = function mapToBeforeDoc(steps, pos, stepIndex, bias) {
  * @param view  the editor view (for the collab rebase guard)
  */
 export var getAgentEditSegments = function getAgentEditSegments(json, steps, tr, view) {
+  var _collabPluginState$ac;
   // `agentType` present ⇒ agent-authored (per the NCS↔Editor steps contract). Read
   // from the first agent step; it is identical across a batch.
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -113,6 +115,13 @@ export var getAgentEditSegments = function getAgentEditSegments(json, steps, tr,
   // The user the agent acted on behalf of (the requester). Optional/additive on the
   // step contract, so it may be absent.
   var actorUserId = typeof (agentStep === null || agentStep === void 0 ? void 0 : agentStep.userId) === 'string' ? agentStep.userId : undefined;
+  // Resolve the local user's AAID via the collab session: the plugin state knows this
+  // client's session id, and the participant list maps that to a `userId`. Both are
+  // optional, so an unresolvable identity degrades to `false` (see the contract).
+  var collabPluginState = pluginKey.getState(view.state);
+  var localSessionId = collabPluginState === null || collabPluginState === void 0 ? void 0 : collabPluginState.sessionId;
+  var localUserId = localSessionId ? collabPluginState === null || collabPluginState === void 0 || (_collabPluginState$ac = collabPluginState.activeParticipants) === null || _collabPluginState$ac === void 0 || (_collabPluginState$ac = _collabPluginState$ac.get(localSessionId)) === null || _collabPluginState$ac === void 0 ? void 0 : _collabPluginState$ac.userId : undefined;
+  var isLocalUserRequester = actorUserId !== undefined && localUserId !== undefined && actorUserId === localUserId;
   // Which agent instance wrote the batch. Additive on the step contract like
   // `userId`, so treat it as optional. Carried for contract clarity / future
   // per-agent attribution; nothing consumes it yet.
@@ -275,6 +284,7 @@ export var getAgentEditSegments = function getAgentEditSegments(json, steps, tr,
       agentId: agentId,
       agentType: agentType,
       complete: complete,
+      isLocalUserRequester: isLocalUserRequester,
       segments: segments
     };
   } catch (_unused3) {

package/dist/esm/pm-plugins/track-steps.js

@@ -11,7 +11,6 @@ import { updateNcsSessionStepMetrics } from './track-step-metrics';
 function groupBy(array, keyGetter) {
   // Check group by exists, and that it's a function. If so, use the native browser code
   if ('groupBy' in Object && typeof Object.groupBy === 'function') {
-    // @ts-ignore TS2322 - Type 'Partial<Record<string, T[]>>' is not assignable to type 'Record<string, T[]>'.
     return Object.groupBy(array, keyGetter);
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-collab-edit",
-	"version": "15.0.8",
+	"version": "16.0.1",
 	"description": "Collab Edit plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -19,26 +19,26 @@
 	"sideEffects": false,
 	"atlaskit:src": "src/index.ts",
 	"dependencies": {
-		"@atlaskit/adf-schema": "^56.7.0",
+		"@atlaskit/adf-schema": "^57.0.0",
 		"@atlaskit/custom-steps": "^1.0.0",
-		"@atlaskit/editor-json-transformer": "^9.2.0",
-		"@atlaskit/editor-plugin-analytics": "^14.0.0",
-		"@atlaskit/editor-plugin-connectivity": "^14.0.0",
-		"@atlaskit/editor-plugin-editor-viewmode": "^16.0.0",
-		"@atlaskit/editor-plugin-feature-flags": "^13.0.0",
+		"@atlaskit/editor-json-transformer": "^9.4.0",
+		"@atlaskit/editor-plugin-analytics": "^15.0.0",
+		"@atlaskit/editor-plugin-connectivity": "^15.0.0",
+		"@atlaskit/editor-plugin-editor-viewmode": "^17.0.0",
+		"@atlaskit/editor-plugin-feature-flags": "^14.0.0",
 		"@atlaskit/editor-prosemirror": "^8.0.0",
 		"@atlaskit/editor-shared-styles": "^4.0.0",
 		"@atlaskit/frontend-utilities": "^4.1.0",
 		"@atlaskit/platform-feature-experiments": "^0.3.0",
 		"@atlaskit/platform-feature-flags": "^2.1.0",
 		"@atlaskit/prosemirror-collab": "^1.0.0",
-		"@atlaskit/tmp-editor-statsig": "^147.0.0",
+		"@atlaskit/tmp-editor-statsig": "^147.1.0",
 		"@atlaskit/tokens": "^16.7.0",
 		"@babel/runtime": "^7.0.0",
 		"memoize-one": "^6.0.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^118.10.0",
+		"@atlaskit/editor-common": "^119.4.0",
 		"react": "^18.2.0 || ^19.2.0",
 		"react-dom": "^18.2.0 || ^19.2.0"
 	},