10.20.0 • Published 9 months ago

@atlaskit/collab-provider v10.20.0

Weekly downloads
63
License
Apache-2.0
Repository
bitbucket
Last release
9 months ago

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, 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

// Full integration
- setup({getState, onSyncUpError}: {getState: () => EditorState; onSyncUpError?: SyncUpErrorFunction;})

// Partial Integration, initialize the provider with passing config isPresenceOnly as true
- setupForPresenceOnly(clientId: string)

Support

If you have further questions or require assistance, please reach out to the #team-cc-editor-services on Slack.

@atlaskit/adf-utils@atlaskit/analytics-gas-types@atlaskit/analytics-listeners@atlaskit/editor-common@atlaskit/editor-json-transformer@atlaskit/editor-prosemirror@atlaskit/feature-gate-js-client@atlaskit/platform-feature-flags@atlaskit/prosemirror-collab@atlaskit/react-ufo@atlaskit/tmp-editor-statsig@atlaskit/ufo@atlaskit/util-service-support@babel/runtimebind-event-listenereventemitter2lodashprosemirror-changesetsocket.io-clientuuid
@atlaskit/editor-mobile-bridge
10.8.0

1 year ago

10.8.1

1 year ago

10.0.0

1 year ago

10.15.0

10 months ago

10.7.0

1 year ago

9.46.0

1 year ago

10.7.1

1 year ago

10.7.2

1 year ago

10.7.3

1 year ago

10.16.0

9 months ago

10.16.1

9 months ago

10.16.2

9 months ago

10.16.3

9 months ago

9.45.0

1 year ago

10.2.0

1 year ago

10.2.1

1 year ago

10.2.2

1 year ago

10.13.0

11 months ago

10.9.0

1 year ago

10.9.1

1 year ago

10.9.2

12 months ago

10.9.3

12 months ago

10.1.0

1 year ago

10.1.1

1 year ago

10.1.2

1 year ago

10.1.3

1 year ago

10.9.4

12 months ago

10.14.2

10 months ago

10.14.3

10 months ago

10.14.0

11 months ago

10.14.1

11 months ago

10.14.4

10 months ago

10.4.1

1 year ago

10.4.0

1 year ago

10.11.1

11 months ago

10.11.0

11 months ago

10.19.1

9 months ago

10.19.2

9 months ago

10.19.0

9 months ago

10.3.2

1 year ago

10.3.3

1 year ago

10.3.4

1 year ago

10.3.0

1 year ago

10.3.1

1 year ago

10.12.0

11 months ago

10.12.1

11 months ago

10.6.0

1 year ago

10.6.1

1 year ago

10.6.2

1 year ago

10.20.0

9 months ago

10.17.0

9 months ago

10.17.1

9 months ago

10.5.0

1 year ago

10.5.1

1 year ago

10.5.2

1 year ago

10.10.2

11 months ago

10.10.0

12 months ago

10.10.1

12 months ago

10.18.0

9 months ago

9.44.1

1 year ago

9.44.0

1 year ago

9.43.3

1 year ago

9.43.2

1 year ago

9.43.1

1 year ago

9.43.0

1 year ago

9.42.5

1 year ago

9.42.4

1 year ago

9.42.3

1 year ago

9.42.2

1 year ago

9.42.1

1 year ago

9.42.0

1 year ago

9.41.1

1 year ago

9.41.0

1 year ago

9.39.0

1 year ago

9.38.1

1 year ago

9.38.0

1 year ago

9.37.4

2 years ago

9.40.6

1 year ago

9.40.5

1 year ago

9.40.0

1 year ago

9.40.4

1 year ago

9.40.3

1 year ago

9.40.2

1 year ago

9.40.1

1 year ago

9.37.7

1 year ago

9.37.6

1 year ago

9.37.5

2 years ago

9.35.0

2 years ago

9.34.0

2 years ago

9.33.2

2 years ago

9.33.1

2 years ago

9.33.0

2 years ago

9.29.1

2 years ago

9.32.3

2 years ago

9.32.2

2 years ago

9.32.1

2 years ago

9.32.0

2 years ago

9.29.3

2 years ago

9.29.2

2 years ago

9.31.0

2 years ago

9.30.1

2 years ago

9.30.0

2 years ago

9.37.0

2 years ago

9.37.3

2 years ago

9.37.2

2 years ago

9.37.1

2 years ago

9.36.1

2 years ago

9.36.0

2 years ago

9.28.6

2 years ago

9.29.0

2 years ago

9.28.5

2 years ago

9.28.4

2 years ago

9.28.2

2 years ago

9.28.3

2 years ago

9.28.1

2 years ago

9.28.0

2 years ago

9.27.1

2 years ago

9.27.0

2 years ago

9.26.7

2 years ago

9.26.5

2 years ago

9.26.6

2 years ago

9.26.4

2 years ago

9.26.3

2 years ago

9.26.1

2 years ago

9.26.2

2 years ago

9.26.0

2 years ago

9.25.15

2 years ago

9.25.14

2 years ago

9.25.13

2 years ago

9.25.12

2 years ago

9.25.10

2 years ago

9.25.11

2 years ago

9.25.8

2 years ago

9.25.9

2 years ago

9.25.5

2 years ago

9.25.6

2 years ago

9.25.7

2 years ago

9.25.4

2 years ago

9.25.3

2 years ago

9.25.2

2 years ago

9.25.1

2 years ago

9.25.0

2 years ago

9.24.1

2 years ago

9.24.0

2 years ago

9.23.1

2 years ago

9.23.0

2 years ago

9.22.8

2 years ago

9.22.9

2 years ago

9.22.7

2 years ago

9.22.6

2 years ago

9.22.5

2 years ago

9.22.4

2 years ago

9.22.2

2 years ago

9.22.3

2 years ago

9.22.1

2 years ago

9.22.0

2 years ago

9.21.3

2 years ago

9.21.2

2 years ago

9.21.1

2 years ago

9.21.0

2 years ago

9.20.7

2 years ago

9.20.6

2 years ago

9.20.5

2 years ago

9.20.3

2 years ago

9.20.4

2 years ago

9.20.2

2 years ago

9.20.0

2 years ago

9.20.1

2 years ago

9.19.0

2 years ago

9.18.4

2 years ago

9.18.3

2 years ago

9.18.2

2 years ago

9.18.1

2 years ago

9.17.3

2 years ago

9.17.4

2 years ago

9.17.5

2 years ago

9.18.0

2 years ago

9.17.0

2 years ago

9.17.1

2 years ago

9.17.2

2 years ago

9.16.0

2 years ago

9.16.1

2 years ago

9.15.5

2 years ago

9.15.3

2 years ago

9.15.4

2 years ago

9.8.0

3 years ago

9.4.0

3 years ago

9.12.4

2 years ago

9.12.5

2 years ago

9.12.0

3 years ago

9.12.1

3 years ago

9.12.2

2 years ago

9.12.3

2 years ago

9.9.0

3 years ago

9.9.1

3 years ago

9.5.2

3 years ago

9.5.1

3 years ago

9.5.0

3 years ago

9.15.1

2 years ago

9.15.2

2 years ago

9.11.1

3 years ago

9.15.0

2 years ago

9.11.0

3 years ago

9.6.4

3 years ago

9.6.3

3 years ago

9.6.2

3 years ago

9.6.1

3 years ago

9.6.0

3 years ago

9.14.0

2 years ago

9.10.0

3 years ago

9.10.1

3 years ago

9.7.3

3 years ago

9.7.2

3 years ago

9.7.1

3 years ago

9.7.0

3 years ago

9.7.4

3 years ago

9.13.0

2 years ago

9.3.1

3 years ago

9.2.2

3 years ago

9.2.1

3 years ago

9.1.0

3 years ago

9.3.0

3 years ago

9.2.0

3 years ago

9.0.1

3 years ago

8.8.1

3 years ago

8.8.0

3 years ago

8.8.2

3 years ago

8.6.0

3 years ago

8.9.0

3 years ago

8.9.1

3 years ago

8.7.0

3 years ago

9.0.0

3 years ago

8.5.0

3 years ago

8.4.0

3 years ago

8.3.0

3 years ago

8.2.0

3 years ago

8.1.0

3 years ago

8.0.1

3 years ago

8.0.0

3 years ago

7.6.2

3 years ago

7.6.3

3 years ago

7.7.0

3 years ago

7.6.1

3 years ago

7.6.0

4 years ago

7.5.1

4 years ago

7.4.4

4 years ago

7.4.3

4 years ago

7.4.2

4 years ago

7.4.1

4 years ago

7.5.0

4 years ago

7.3.1

4 years ago

7.4.0

4 years ago

7.3.0

4 years ago

7.2.0

4 years ago

7.1.8

4 years ago

7.1.7

4 years ago

7.1.3

4 years ago

7.1.6

4 years ago

7.1.5

4 years ago

7.1.4

4 years ago

7.1.2

4 years ago

7.1.1

4 years ago

7.1.0

4 years ago

7.0.1

5 years ago

7.0.0

5 years ago

6.5.0

5 years ago

6.4.2

5 years ago

6.4.1

5 years ago

6.3.0

5 years ago

6.4.0

5 years ago

6.3.1

5 years ago

6.2.0

5 years ago

6.1.0

5 years ago

6.0.0

5 years ago

5.2.0

5 years ago

5.1.0

5 years ago

5.0.1

5 years ago

5.0.0

5 years ago

4.1.1

5 years ago

4.1.0

5 years ago

0.0.0-alpha-dummy

5 years ago

4.0.0

5 years ago

3.3.2

5 years ago

3.3.1

5 years ago

3.3.0

5 years ago

3.2.3

6 years ago

3.2.2

6 years ago

3.2.1

6 years ago

3.2.0

6 years ago

3.1.0

6 years ago

3.0.0

6 years ago

2.0.0

6 years ago

1.0.2

6 years ago

1.0.1

6 years ago

1.0.0

6 years ago

0.1.1

6 years ago

0.1.0

6 years ago