@atlaskit/collab-provider 9.42.0 → 9.42.2

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @atlaskit/collab-provider
 
+## 9.42.2
+
+### Patch Changes
+
+- [#147660](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/147660)
+  [`9b66ba02b702e`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/9b66ba02b702e) -
+  Add README.md to guide integrating with collab-provider
+
+## 9.42.1
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 9.42.0
 
 ### Minor Changes

package/README.md

@@ -0,0 +1,23 @@
+# Integrating with Collab-Provider
+This guide outlines two primary use cases for integrating with the collab-provider.
+
+# Use Cases
+1. Full Integration: FE Events and BE API Calls
+    - For scenarios requiring both front-end events and back-end API interactions, the back-end APIs are hosted by `pf-collab-service`. To determine if API calls are necessary, please refer to the [OpenAPI documentation](https://bitbucket.org/atlassian/pf-collab-service/src/c25a7614f30c68cae50b8f8da827a844c4ccecc2/openapi.yaml#openapi.yaml), specifically under the `Service to Service` section.
+2. Partial Integration: FE Events Only
+    - For scenarios where only front-end events are needed, without back-end API interactions.
+
+# Integration Details
+1. Full Integration: FE Events and BE API Calls
+    - Ensure the provider is initialized with:
+        - `DocumentService` from `document-service.ts`
+        - `Api` from `api.ts`
+2. Partial Integration: FE Events Only
+    - Ensure the provider is initialized with:
+        - `NullDocumentService` from `null-document-service.ts`
+        - `NullApi` from `null-api.ts`
+
+For a detailed comparison of these integration approaches, refer to the source code in `../platform/packages/editor/collab-provider/src/provider/index.ts`.
+
+# Support
+If you have further questions or require assistance, please reach out to the [#team-cc-editor-services](https://atlassian.enterprise.slack.com/archives/C02GEULKMLN) on Slack.

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

package/dist/es2019/version-wrapper.js

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

package/dist/esm/version-wrapper.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/collab-provider",
-	"version": "9.42.0",
+	"version": "9.42.2",
 	"description": "A provider for collaborative editing.",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -34,7 +34,7 @@
 	"dependencies": {
 		"@atlaskit/analytics-gas-types": "^5.1.0",
 		"@atlaskit/analytics-listeners": "^8.11.0",
-		"@atlaskit/editor-common": "^91.1.0",
+		"@atlaskit/editor-common": "^92.1.0",
 		"@atlaskit/editor-json-transformer": "^8.18.0",
 		"@atlaskit/editor-prosemirror": "6.0.0",
 		"@atlaskit/platform-feature-flags": "^0.3.0",