@atlaskit/prosemirror-collab 0.9.4 → 0.9.5

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @atlaskit/prosemirror-collab
 
+## 0.9.5
+
+### Patch Changes
+
+- [#143146](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/143146)
+  [`5df86b2c5407e`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/5df86b2c5407e) -
+  Retire getVersion using getCollabState from prosemirror-collab, and adding error events on
+  checking undefined collab state in all collab-provider usages
+
 ## 0.9.4
 
 ### Patch Changes

package/dist/cjs/index.js

@@ -5,7 +5,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.collab = collab;
-exports.getVersion = getVersion;
+exports.getCollabState = getCollabState;
 exports.rebaseSteps = rebaseSteps;
 exports.receiveTransaction = receiveTransaction;
 exports.sendableSteps = sendableSteps;
@@ -188,9 +188,9 @@ function sendableSteps(state) {
   };
 }
 
-/// Get the version up to which the collab plugin has synced with the
-/// central authority.
-function getVersion(state) {
-  var _collabKey$getState;
-  return ((_collabKey$getState = collabKey.getState(state)) === null || _collabKey$getState === void 0 ? void 0 : _collabKey$getState.version) || 0;
+/// Get the collab state which would holds the version up to which the collab plugin has synced with the central authority.
+/// Override getVersion to getCollabState to gain the benefit on analytics / monitoring in collab-provider
+/// Override PR: https://stash.atlassian.com/projects/ATLASSIAN/repos/atlassian-frontend-monorepo/pull-requests/142331/overview
+function getCollabState(state) {
+  return collabKey.getState(state);
 }

package/dist/es2019/index.js

@@ -171,9 +171,9 @@ export function sendableSteps(state) {
   };
 }
 
-/// Get the version up to which the collab plugin has synced with the
-/// central authority.
-export function getVersion(state) {
-  var _collabKey$getState;
-  return ((_collabKey$getState = collabKey.getState(state)) === null || _collabKey$getState === void 0 ? void 0 : _collabKey$getState.version) || 0;
+/// Get the collab state which would holds the version up to which the collab plugin has synced with the central authority.
+/// Override getVersion to getCollabState to gain the benefit on analytics / monitoring in collab-provider
+/// Override PR: https://stash.atlassian.com/projects/ATLASSIAN/repos/atlassian-frontend-monorepo/pull-requests/142331/overview
+export function getCollabState(state) {
+  return collabKey.getState(state);
 }

package/dist/esm/index.js

@@ -177,9 +177,9 @@ export function sendableSteps(state) {
   };
 }
 
-/// Get the version up to which the collab plugin has synced with the
-/// central authority.
-export function getVersion(state) {
-  var _collabKey$getState;
-  return ((_collabKey$getState = collabKey.getState(state)) === null || _collabKey$getState === void 0 ? void 0 : _collabKey$getState.version) || 0;
+/// Get the collab state which would holds the version up to which the collab plugin has synced with the central authority.
+/// Override getVersion to getCollabState to gain the benefit on analytics / monitoring in collab-provider
+/// Override PR: https://stash.atlassian.com/projects/ATLASSIAN/repos/atlassian-frontend-monorepo/pull-requests/142331/overview
+export function getCollabState(state) {
+  return collabKey.getState(state);
 }

package/dist/types/index.d.ts

@@ -8,6 +8,11 @@ declare class Rebaseable {
     constructor(step: ProseMirrorStep, inverted: ProseMirrorStep, origin: ProseMirrorTransform);
 }
 export declare function rebaseSteps(steps: readonly Rebaseable[], over: readonly ProseMirrorStep[], transform: ProseMirrorTransform): Rebaseable[];
+declare class CollabState {
+    readonly version: number;
+    readonly unconfirmed: readonly Rebaseable[];
+    constructor(version: number, unconfirmed: readonly Rebaseable[]);
+}
 type CollabConfig = {
     version?: number;
     clientID?: number | string | null;
@@ -22,5 +27,5 @@ export declare function sendableSteps(state: EditorState): {
     clientID: number | string;
     origins: readonly Transaction[];
 } | null;
-export declare function getVersion(state: EditorState): number;
+export declare function getCollabState(state: EditorState): CollabState | undefined;
 export {};

package/dist/types-ts4.5/index.d.ts

@@ -8,6 +8,11 @@ declare class Rebaseable {
     constructor(step: ProseMirrorStep, inverted: ProseMirrorStep, origin: ProseMirrorTransform);
 }
 export declare function rebaseSteps(steps: readonly Rebaseable[], over: readonly ProseMirrorStep[], transform: ProseMirrorTransform): Rebaseable[];
+declare class CollabState {
+    readonly version: number;
+    readonly unconfirmed: readonly Rebaseable[];
+    constructor(version: number, unconfirmed: readonly Rebaseable[]);
+}
 type CollabConfig = {
     version?: number;
     clientID?: number | string | null;
@@ -22,5 +27,5 @@ export declare function sendableSteps(state: EditorState): {
     clientID: number | string;
     origins: readonly Transaction[];
 } | null;
-export declare function getVersion(state: EditorState): number;
+export declare function getCollabState(state: EditorState): CollabState | undefined;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/prosemirror-collab",
-	"version": "0.9.4",
+	"version": "0.9.5",
 	"description": "Collaborative editing for ProseMirror - Atlassian Fork",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"