# @atlaskit/collab-provider

> A provider for collaborative editing.

Latest version **42.0.2** (published 2026-11-18) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @atlaskit/collab-provider
pnpm add @atlaskit/collab-provider
yarn add @atlaskit/collab-provider
bun add @atlaskit/collab-provider
```

## Health

**Score 65/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; recently updated; high maintenance score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 42.0.2 |
| Published | 2026-11-18 |
| First published | 2020-03-13 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 22 |
| Unpacked size | 1.2 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Atlassian Pty Ltd |
| Maintainers | atlassianartifactteam |

## Links

- npm: https://www.npmjs.com/package/@atlaskit/collab-provider
- Repository: https://bitbucket.org/atlassian/atlassian-frontend-mirror
- Homepage: https://bitbucket.org/atlassian/atlassian-frontend-mirror#readme
- Issues: https://bitbucket.org/atlassian/atlassian-frontend-mirror/issues
- npm.io page: https://npm.io/package/@atlaskit/collab-provider

## Dependencies (22)

- [uuid](https://npm.io/package/uuid.md) ^11.1.1
- [lodash](https://npm.io/package/lodash.md) ^4.17.21
- [@atlaskit/ufo](https://npm.io/package/@atlaskit/ufo.md) ^2.0.0
- [eventemitter2](https://npm.io/package/eventemitter2.md) ^4.1.0
- [@babel/runtime](https://npm.io/package/@babel/runtime.md) ^7.0.0
- [socket.io-client](https://npm.io/package/socket.io-client.md) ^4.8.4
- [@atlaskit/adf-utils](https://npm.io/package/@atlaskit/adf-utils.md) ^20.9.0
- [@atlaskit/react-ufo](https://npm.io/package/@atlaskit/react-ufo.md) ^8.5.0
- [bind-event-listener](https://npm.io/package/bind-event-listener.md) ^3.0.0
- [prosemirror-changeset](https://npm.io/package/prosemirror-changeset.md) ^2.3.1
- [@atlaskit/anonymous-assets](https://npm.io/package/@atlaskit/anonymous-assets.md) ^2.14.0
- [@atlaskit/atlassian-context](https://npm.io/package/@atlaskit/atlassian-context.md) ^2.0.0
- [@atlaskit/editor-prosemirror](https://npm.io/package/@atlaskit/editor-prosemirror.md) ^9.0.0
- [@atlaskit/prosemirror-collab](https://npm.io/package/@atlaskit/prosemirror-collab.md) ^1.1.0
- [@atlaskit/tmp-editor-statsig](https://npm.io/package/@atlaskit/tmp-editor-statsig.md) ^266.0.0
- [@atlaskit/analytics-gas-types](https://npm.io/package/@atlaskit/analytics-gas-types.md) ^6.2.0
- [@atlaskit/analytics-listeners](https://npm.io/package/@atlaskit/analytics-listeners.md) ^11.4.0
- [@atlaskit/util-service-support](https://npm.io/package/@atlaskit/util-service-support.md) ^7.4.0
- [@atlaskit/feature-gate-js-client](https://npm.io/package/@atlaskit/feature-gate-js-client.md) ^8.0.0
- [@atlaskit/platform-feature-flags](https://npm.io/package/@atlaskit/platform-feature-flags.md) ^2.2.0
- [@atlaskit/editor-json-transformer](https://npm.io/package/@atlaskit/editor-json-transformer.md) ^10.0.0
- [@atlaskit/platform-feature-experiments](https://npm.io/package/@atlaskit/platform-feature-experiments.md) ^0.3.0

## Recent versions

- 42.0.2 (latest) — 2026-11-18
- 8.9.1 (next) — 2023-05-17
- 42.0.1 — 2026-11-17
- 42.0.0 — 2026-11-17
- 41.0.0 — 2026-11-17
- 40.0.0 — 2026-11-16
- 39.1.16 — 2026-11-16
- 39.1.15 — 2026-11-13
- 39.1.14 — 2026-11-12
- 39.1.13 — 2026-11-11
- 39.1.12 — 2026-11-10
- 39.1.11 — 2026-11-09
- 39.1.10 — 2026-11-07
- 39.1.9 — 2026-11-06
- 39.1.8 — 2026-11-05
- … 653 more at https://npm.io/package/@atlaskit/collab-provider/versions

## README

# 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`
```
// 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](https://atlassian.enterprise.slack.com/archives/C02GEULKMLN) on Slack.

---
_Source: https://npm.io/package/@atlaskit/collab-provider · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
