ocp_client_quickstart_connect_join_session_send_updates.ts

1import { OCPClient, SessionEvents } from '@opencollab/ocp-js';
2
3// Configuration for the OCP server
4const config = {
5  url: 'wss://collaboration-server.example.com',
6  authToken: 'your-access-token-here'
7};
8
9async function startCollaboration() {
10  // 1. Initialize the OCP Client
11  const client = new OCPClient(config);
12
13  try {
14    // 2. Connect to the protocol server
15    await client.connect();
16    console.log('Connected to Open Collaboration Protocol server.');
17
18    // 3. Join a specific collaboration session (e.g., a shared document or canvas)
19    const session = await client.joinSession('session-id-123');
20
21    // 4. Listen for real-time updates from other collaborators
22    session.on(SessionEvents.UPDATE, (data) => {
23      console.log('Received collaboration update:', data);
24    });
25
26    // 5. Send a local change to the protocol
27    await session.sendUpdate({
28      type: 'INSERT_TEXT',
29      payload: { index: 0, text: 'Hello, world!' }
30    });
31
32  } catch (error) {
33    console.error('Failed to initialize OCP:', error);
34  }
35}
36
37startCollaboration();