@superdoc-dev/sdk 1.1.0-next.16 → 1.1.0-next.17

package/README.md

@@ -81,6 +81,10 @@ await doc.save(params)
 await doc.close(params)
 ```
 
+### Collaboration sessions
+
+The SDK supports collaborative editing with `y-websocket`, `hocuspocus`, and `liveblocks` providers. Pass `collabUrl` for the websocket shorthand or a `collaboration` object for explicit provider config. See the [full collaboration docs](https://docs.superdoc.dev/document-engine/sdks#collaboration-sessions) for examples and all options.
+
 ### Operations
 
 | Category | Operations |

package/dist/generated/client.d.ts

@@ -9129,7 +9129,30 @@ export interface DocDiffApplyParams {
 export interface DocOpenParams {
     doc?: string;
     sessionId?: string;
-    collaboration?: Record<string, unknown> | unknown[];
+    collaboration?: ({
+        providerType: "y-websocket" | "hocuspocus";
+        url: string;
+        documentId?: string;
+        tokenEnv?: string;
+        syncTimeoutMs?: number;
+        onMissing?: "seedFromDoc" | "blank" | "error";
+        bootstrapSettlingMs?: number;
+    }) | ({
+        providerType: "liveblocks";
+        roomId: string;
+        publicApiKey: string;
+        syncTimeoutMs?: number;
+        onMissing?: "seedFromDoc" | "blank" | "error";
+        bootstrapSettlingMs?: number;
+    }) | ({
+        providerType: "liveblocks";
+        roomId: string;
+        authEndpoint: string;
+        authHeadersEnv?: string;
+        syncTimeoutMs?: number;
+        onMissing?: "seedFromDoc" | "blank" | "error";
+        bootstrapSettlingMs?: number;
+    });
     collabDocumentId?: string;
     collabUrl?: string;
     contentOverride?: string;
@@ -14421,7 +14444,8 @@ export type DocOpenResult = {
     };
     dirty?: boolean;
     collaboration?: {
-        documentId?: string;
+        providerType: "y-websocket" | "hocuspocus" | "liveblocks";
+        documentId: string;
         url?: string;
     };
     bootstrap?: {
@@ -14480,7 +14504,8 @@ export type DocStatusResult = {
         revision?: number;
     };
     collaboration?: {
-        documentId?: string;
+        providerType: "y-websocket" | "hocuspocus" | "liveblocks";
+        documentId: string;
         url?: string;
     };
     openedAt?: string;
@@ -14513,6 +14538,11 @@ export type DocSessionListResult = {
         sessionType?: string;
         dirty?: boolean;
         revision?: number;
+        collaboration?: {
+            providerType: "y-websocket" | "hocuspocus" | "liveblocks";
+            documentId: string;
+            url?: string;
+        };
     }>;
     total?: number;
 };