@atlaskit/collab-provider 25.0.5 → 25.0.6

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @atlaskit/collab-provider
 
+## 25.0.6
+
+### Patch Changes
+
+- [`351ba3a2cc9d5`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/351ba3a2cc9d5) -
+  `BaseStepPM` gains an optional `invocationId`, the backend-issued identifier of the agent
+  invocation a collaboration step belongs to.
+
+  NCS attaches the identifier to every step produced by one backend agent invocation, so consumers
+  can group a received batch back into the invocation that produced it. Identity is per step rather
+  than per batch: one live or catch-up batch can mix human steps, agent steps from different
+  invocations, and steps with no identifier at all.
+
+  The field is optional and additive, so steps that do not carry it are unaffected, and the frontend
+  treats the value as opaque rather than validating its format.
+
+- Updated dependencies
+
 ## 25.0.5
 
 ### Patch Changes

package/dist/cjs/types.js

@@ -26,6 +26,17 @@ var AcknowledgementResponseTypes = exports.AcknowledgementResponseTypes = /*#__P
   AcknowledgementResponseTypes["SUCCESS"] = "SUCCESS";
   AcknowledgementResponseTypes["ERROR"] = "ERROR";
   return AcknowledgementResponseTypes;
-}({}); // ESS-2916 Type def for namespace status - lock/unlock
+}({});
+/**
+ * A batch of steps delivered to the document service: broadcast live over the websocket, returned by
+ * catch-up, or built locally from the client's own steps once NCS acknowledges them.
+ *
+ * Author and invocation identity live on each step, never on this envelope: one batch may mix human
+ * steps, agent steps from different invocations, and steps that carry no `invocationId` at all.
+ * Consumers should therefore read `agentType`/`agentId`/`invocationId` per step rather than inferring
+ * them for the whole batch — note that the existing agent-presence consumers still derive some
+ * attributes batch-wide, which is safe only while a batch has a single agent author.
+ */
+// ESS-2916 Type def for namespace status - lock/unlock
 // This is added as a part of CEPS-1660
 // CatchupV2

package/dist/cjs/version-wrapper.js

@@ -5,7 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.version = exports.nextMajorVersion = exports.name = void 0;
 var name = exports.name = "@atlaskit/collab-provider";
-var version = exports.version = "25.0.4";
+var version = exports.version = "25.0.5";
 var nextMajorVersion = exports.nextMajorVersion = function nextMajorVersion() {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

package/dist/es2019/types.js

@@ -27,6 +27,17 @@ export let AcknowledgementResponseTypes = /*#__PURE__*/function (Acknowledgement
   return AcknowledgementResponseTypes;
 }({});
 
+/**
+ * A batch of steps delivered to the document service: broadcast live over the websocket, returned by
+ * catch-up, or built locally from the client's own steps once NCS acknowledges them.
+ *
+ * Author and invocation identity live on each step, never on this envelope: one batch may mix human
+ * steps, agent steps from different invocations, and steps that carry no `invocationId` at all.
+ * Consumers should therefore read `agentType`/`agentId`/`invocationId` per step rather than inferring
+ * them for the whole batch — note that the existing agent-presence consumers still derive some
+ * attributes batch-wide, which is safe only while a batch has a single agent author.
+ */
+
 // ESS-2916 Type def for namespace status - lock/unlock
 
 // This is added as a part of CEPS-1660

package/dist/es2019/version-wrapper.js

@@ -1,5 +1,5 @@
 export const name = "@atlaskit/collab-provider";
-export const version = "25.0.4";
+export const version = "25.0.5";
 export const nextMajorVersion = () => {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

package/dist/esm/types.js

@@ -27,6 +27,17 @@ export var AcknowledgementResponseTypes = /*#__PURE__*/function (Acknowledgement
   return AcknowledgementResponseTypes;
 }({});
 
+/**
+ * A batch of steps delivered to the document service: broadcast live over the websocket, returned by
+ * catch-up, or built locally from the client's own steps once NCS acknowledges them.
+ *
+ * Author and invocation identity live on each step, never on this envelope: one batch may mix human
+ * steps, agent steps from different invocations, and steps that carry no `invocationId` at all.
+ * Consumers should therefore read `agentType`/`agentId`/`invocationId` per step rather than inferring
+ * them for the whole batch — note that the existing agent-presence consumers still derive some
+ * attributes batch-wide, which is safe only while a batch has a single agent author.
+ */
+
 // ESS-2916 Type def for namespace status - lock/unlock
 
 // This is added as a part of CEPS-1660

package/dist/esm/version-wrapper.js

@@ -1,5 +1,5 @@
 export var name = "@atlaskit/collab-provider";
-export var version = "25.0.4";
+export var version = "25.0.5";
 export var nextMajorVersion = function nextMajorVersion() {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

package/dist/types/types.d.ts

@@ -205,6 +205,16 @@ export type AcknowledgementErrorPayload = {
     type: AcknowledgementResponseTypes.ERROR;
 };
 export type AddStepAcknowledgementPayload = AddStepAcknowledgementSuccessPayload | AcknowledgementErrorPayload;
+/**
+ * A batch of steps delivered to the document service: broadcast live over the websocket, returned by
+ * catch-up, or built locally from the client's own steps once NCS acknowledges them.
+ *
+ * Author and invocation identity live on each step, never on this envelope: one batch may mix human
+ * steps, agent steps from different invocations, and steps that carry no `invocationId` at all.
+ * Consumers should therefore read `agentType`/`agentId`/`invocationId` per step rather than inferring
+ * them for the whole batch — note that the existing agent-presence consumers still derive some
+ * attributes batch-wide, which is safe only while a batch has a single agent author.
+ */
 export type StepsPayload = {
     steps: StepJson[];
     version: number;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/collab-provider",
-	"version": "25.0.5",
+	"version": "25.0.6",
 	"description": "A provider for collaborative editing.",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -23,14 +23,14 @@
 		"@atlaskit/analytics-listeners": "^11.1.0",
 		"@atlaskit/anonymous-assets": "^2.8.0",
 		"@atlaskit/atlassian-context": "^1.1.0",
-		"@atlaskit/editor-json-transformer": "^9.6.0",
+		"@atlaskit/editor-json-transformer": "^9.7.0",
 		"@atlaskit/editor-prosemirror": "^8.0.0",
 		"@atlaskit/feature-gate-js-client": "^6.0.0",
 		"@atlaskit/platform-feature-experiments": "^0.3.0",
 		"@atlaskit/platform-feature-flags": "^2.1.0",
 		"@atlaskit/prosemirror-collab": "^1.0.0",
 		"@atlaskit/react-ufo": "^7.7.0",
-		"@atlaskit/tmp-editor-statsig": "^164.0.0",
+		"@atlaskit/tmp-editor-statsig": "^164.1.0",
 		"@atlaskit/ufo": "^1.0.0",
 		"@atlaskit/util-service-support": "^7.2.0",
 		"@babel/runtime": "^7.0.0",
@@ -78,6 +78,6 @@
 		}
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^120.5.0"
+		"@atlaskit/editor-common": "^120.6.0"
 	}
 }