@atlaskit/collab-provider 21.0.22 → 21.0.23

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/collab-provider
 
+## 21.0.23
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 21.0.22
 
 ### Patch Changes

package/dist/cjs/helpers/utils.js

@@ -42,6 +42,16 @@ function sleep(ms) {
     setTimeout(resolve, ms);
   });
 }
+
+/**
+ * Returns whether an id belongs to an agent — referred to as an "AI provider" in this
+ * package's terminology.
+ *
+ * @remarks Agents are not a distinct type: they are ordinary participants distinguished
+ * only by the `agent:` prefix on their `userId`/`sessionId`. This predicate is the single
+ * source of truth for that convention and gates agent-specific presence handling across the
+ * provider (e.g. immediate `presence` emission and agent-leave cleanup).
+ */
 var isAIProviderID = exports.isAIProviderID = function isAIProviderID(id) {
   return typeof id === 'string' && id.startsWith('agent:');
 };

package/dist/cjs/types.js

@@ -13,6 +13,15 @@ exports.AcknowledgementResponseTypes = void 0;
  * @param {string} sessionId socket.id from NCS
  * @param data event specific data from NCS
  */
+/**
+ * Presence details broadcast for a single participant (human or agent) on a document.
+ *
+ * @remarks Agents are modelled as ordinary participants distinguished only by the
+ * `agent:` prefix on their `userId`/`sessionId` (see `isAIProviderID`); this package
+ * refers to them as "AI providers". Note this base type carries no last-active time —
+ * a participant's `lastActive` is derived from {@link PresencePayload.timestamp} when the
+ * payload is hydrated into a participant.
+ */
 var AcknowledgementResponseTypes = exports.AcknowledgementResponseTypes = /*#__PURE__*/function (AcknowledgementResponseTypes) {
   AcknowledgementResponseTypes["SUCCESS"] = "SUCCESS";
   AcknowledgementResponseTypes["ERROR"] = "ERROR";

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 = "21.0.21";
+var version = exports.version = "21.0.22";
 var nextMajorVersion = exports.nextMajorVersion = function nextMajorVersion() {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

package/dist/es2019/helpers/utils.js

@@ -22,6 +22,16 @@ export function sleep(ms) {
     setTimeout(resolve, ms);
   });
 }
+
+/**
+ * Returns whether an id belongs to an agent — referred to as an "AI provider" in this
+ * package's terminology.
+ *
+ * @remarks Agents are not a distinct type: they are ordinary participants distinguished
+ * only by the `agent:` prefix on their `userId`/`sessionId`. This predicate is the single
+ * source of truth for that convention and gates agent-specific presence handling across the
+ * provider (e.g. immediate `presence` emission and agent-leave cleanup).
+ */
 export const isAIProviderID = id => typeof id === 'string' && id.startsWith('agent:');
 export const getProduct = productInfo => {
   var _productInfo$product;

package/dist/es2019/types.js

@@ -11,6 +11,16 @@
  * @param data event specific data from NCS
  */
 
+/**
+ * Presence details broadcast for a single participant (human or agent) on a document.
+ *
+ * @remarks Agents are modelled as ordinary participants distinguished only by the
+ * `agent:` prefix on their `userId`/`sessionId` (see `isAIProviderID`); this package
+ * refers to them as "AI providers". Note this base type carries no last-active time —
+ * a participant's `lastActive` is derived from {@link PresencePayload.timestamp} when the
+ * payload is hydrated into a participant.
+ */
+
 export let AcknowledgementResponseTypes = /*#__PURE__*/function (AcknowledgementResponseTypes) {
   AcknowledgementResponseTypes["SUCCESS"] = "SUCCESS";
   AcknowledgementResponseTypes["ERROR"] = "ERROR";

package/dist/es2019/version-wrapper.js

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

package/dist/esm/helpers/utils.js

@@ -32,6 +32,16 @@ export function sleep(ms) {
     setTimeout(resolve, ms);
   });
 }
+
+/**
+ * Returns whether an id belongs to an agent — referred to as an "AI provider" in this
+ * package's terminology.
+ *
+ * @remarks Agents are not a distinct type: they are ordinary participants distinguished
+ * only by the `agent:` prefix on their `userId`/`sessionId`. This predicate is the single
+ * source of truth for that convention and gates agent-specific presence handling across the
+ * provider (e.g. immediate `presence` emission and agent-leave cleanup).
+ */
 export var isAIProviderID = function isAIProviderID(id) {
   return typeof id === 'string' && id.startsWith('agent:');
 };

package/dist/esm/types.js

@@ -11,6 +11,16 @@
  * @param data event specific data from NCS
  */
 
+/**
+ * Presence details broadcast for a single participant (human or agent) on a document.
+ *
+ * @remarks Agents are modelled as ordinary participants distinguished only by the
+ * `agent:` prefix on their `userId`/`sessionId` (see `isAIProviderID`); this package
+ * refers to them as "AI providers". Note this base type carries no last-active time —
+ * a participant's `lastActive` is derived from {@link PresencePayload.timestamp} when the
+ * payload is hydrated into a participant.
+ */
+
 export var AcknowledgementResponseTypes = /*#__PURE__*/function (AcknowledgementResponseTypes) {
   AcknowledgementResponseTypes["SUCCESS"] = "SUCCESS";
   AcknowledgementResponseTypes["ERROR"] = "ERROR";

package/dist/esm/version-wrapper.js

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

package/dist/types/helpers/utils.d.ts

@@ -8,6 +8,15 @@ import type { Node as ProseMirrorNode } from '@atlaskit/editor-prosemirror/model
 import { CustomError } from '../errors/custom-errors';
 export declare const createLogger: (prefix: string, color?: string) => (msg: string, data?: any) => void;
 export declare function sleep(ms: number): Promise<any>;
+/**
+ * Returns whether an id belongs to an agent — referred to as an "AI provider" in this
+ * package's terminology.
+ *
+ * @remarks Agents are not a distinct type: they are ordinary participants distinguished
+ * only by the `agent:` prefix on their `userId`/`sessionId`. This predicate is the single
+ * source of truth for that convention and gates agent-specific presence handling across the
+ * provider (e.g. immediate `presence` emission and agent-leave cleanup).
+ */
 export declare const isAIProviderID: (id: string) => boolean;
 export declare const getProduct: (productInfo?: ProductInformation) => string;
 export declare const getSubProduct: (productInfo?: ProductInformation) => string;

package/dist/types/types.d.ts

@@ -143,16 +143,40 @@ export type BroadcastIncomingPayload = {
     sessionId?: string;
     timestamp?: number;
 };
+/**
+ * Presence details broadcast for a single participant (human or agent) on a document.
+ *
+ * @remarks Agents are modelled as ordinary participants distinguished only by the
+ * `agent:` prefix on their `userId`/`sessionId` (see `isAIProviderID`); this package
+ * refers to them as "AI providers". Note this base type carries no last-active time —
+ * a participant's `lastActive` is derived from {@link PresencePayload.timestamp} when the
+ * payload is hydrated into a participant.
+ */
 export type PresenceData = {
     clientId: number | string;
+    /** Permission level the participant holds on the document (view / comment / edit). */
     permit?: UserPermitType;
+    /** Whether the participant is a `viewer` or an `editor`; drives the presence facepile. */
     presenceActivity?: PresenceActivity;
+    /**
+     * Correlates the presence connection with the editor websocket connection so avatar
+     * colours and telepointers line up across both.
+     */
     presenceId?: string;
+    /** Stable identifier for this presence session. For agents, carries the `agent:` prefix. */
     sessionId: string;
+    /** Participant identity. For agents, carries the `agent:` prefix. */
     userId: string | undefined;
 };
 export type PresencePayload = PresenceData & {
     data?: Record<string, any>;
+    /**
+     * Epoch milliseconds of when this presence was last observed (added by NCS).
+     *
+     * @remarks Hydrated into the participant's `lastActive` (see `createParticipantFromPayload`),
+     * which drives inactivity filtering and, for agents, is the last-active time surfaced on the
+     * presence facepile. On the server this same value is the agent session's `updatedAt`.
+     */
     timestamp: number;
 };
 export type TelepointerPayload = PresencePayload & {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/collab-provider",
-	"version": "21.0.22",
+	"version": "21.0.23",
 	"description": "A provider for collaborative editing.",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -29,7 +29,7 @@
 		"@atlaskit/platform-feature-flags": "^2.0.0",
 		"@atlaskit/prosemirror-collab": "^1.0.0",
 		"@atlaskit/react-ufo": "^7.3.0",
-		"@atlaskit/tmp-editor-statsig": "^125.0.0",
+		"@atlaskit/tmp-editor-statsig": "^126.0.0",
 		"@atlaskit/ufo": "^1.0.0",
 		"@atlaskit/util-service-support": "^7.2.0",
 		"@babel/runtime": "^7.0.0",