@hocuspocus/extension-database 2.9.1-rc.0 → 2.10.0

package/dist/packages/provider/src/HocuspocusProvider.d.ts

@@ -121,7 +121,7 @@ export declare class HocuspocusProvider extends EventEmitter {
     set synced(state: boolean);
     receiveStateless(payload: string): void;
     get isAuthenticationRequired(): boolean;
-    connect(): Promise<unknown>;
+    connect(): Promise<any>;
     disconnect(): void;
     onOpen(event: Event): Promise<void>;
     getToken(): Promise<string | null>;

package/dist/packages/provider/src/HocuspocusProviderWebsocket.d.ts

@@ -102,7 +102,7 @@ export declare class HocuspocusProviderWebsocket extends EventEmitter {
     receivedOnStatusPayload?: onStatusParameters | undefined;
     onOpen(event: Event): Promise<void>;
     onStatus(data: onStatusParameters): Promise<void>;
-    attach(provider: HocuspocusProvider): void;
+    attach(provider: HocuspocusProvider): Promise<any> | undefined;
     detach(provider: HocuspocusProvider): void;
     setConfiguration(configuration?: Partial<HocuspocusProviderWebsocketConfiguration>): void;
     cancelWebsocketRetry?: () => void;

package/dist/packages/provider/src/TiptapCollabProvider.d.ts

@@ -1,7 +1,7 @@
 import type { AbstractType, YArrayEvent } from 'yjs';
 import { HocuspocusProvider, HocuspocusProviderConfiguration } from './HocuspocusProvider.js';
 import { TiptapCollabProviderWebsocket } from './TiptapCollabProviderWebsocket.js';
-import type { THistoryVersion } from './types.js';
+import type { TCollabComment, TCollabThread, THistoryVersion } from './types.js';
 export type TiptapCollabProviderConfiguration = Required<Pick<HocuspocusProviderConfiguration, 'name'>> & Partial<HocuspocusProviderConfiguration> & (Required<Pick<AdditionalTiptapCollabProviderConfiguration, 'websocketProvider'>> | Required<Pick<AdditionalTiptapCollabProviderConfiguration, 'appId'>> | Required<Pick<AdditionalTiptapCollabProviderConfiguration, 'baseUrl'>>);
 export interface AdditionalTiptapCollabProviderConfiguration {
     /**
@@ -40,4 +40,19 @@ export declare class TiptapCollabProvider extends HocuspocusProvider {
     isAutoVersioning(): boolean;
     enableAutoVersioning(): 1;
     disableAutoVersioning(): 0;
+    private getYThreads;
+    getThreads<Data, CommentData>(): TCollabThread<Data, CommentData>[];
+    private getThreadIndex;
+    getThread<Data, CommentData>(id: string): TCollabThread<Data, CommentData> | null;
+    private getYThread;
+    createThread(data: Omit<TCollabThread, '_id' | 'createdAt' | 'updatedAt' | 'comments'>): TCollabThread | null;
+    updateThread(id: TCollabThread['id'], data: Partial<Pick<TCollabThread, 'data' | 'resolvedAt'>>): TCollabThread | null;
+    deleteThread(id: TCollabThread['id']): void;
+    getThreadComments(threadId: TCollabThread['id']): TCollabComment[] | null;
+    getThreadComment(threadId: TCollabThread['id'], commentId: TCollabComment['id']): TCollabComment | null;
+    addComment(threadId: TCollabThread['id'], data: Omit<TCollabComment, 'id' | 'updatedAt' | 'createdAt'>): TCollabThread | null;
+    updateComment(threadId: TCollabThread['id'], commentId: TCollabComment['id'], data: Partial<Pick<TCollabComment, 'data' | 'content'>>): TCollabThread | null;
+    deleteComment(threadId: TCollabThread['id'], commentId: TCollabComment['id']): TCollabThread | null;
+    watchThreads(callback: () => void): void;
+    unwatchThreads(callback: () => void): void;
 }

package/dist/packages/provider/src/types.d.ts

@@ -84,6 +84,21 @@ export type StatesArray = {
     clientId: number;
     [key: string | number]: any;
 }[];
+export type TCollabThread<Data = any, CommentData = any> = {
+    id: string;
+    createdAt: number;
+    updatedAt: number;
+    resolvedAt?: string;
+    comments: TCollabComment<CommentData>[];
+    data: Data;
+};
+export type TCollabComment<Data = any> = {
+    id: string;
+    createdAt: number;
+    updatedAt: number;
+    data: Data;
+    content: any;
+};
 export type THistoryVersion = {
     name?: string;
     version: number;

package/dist/playground/frontend/vite.config.d.ts

@@ -1,2 +1,2 @@
-declare const _default: import("vite").UserConfigExport;
+declare const _default: import("vite").UserConfig;
 export default _default;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@hocuspocus/extension-database",
   "description": "a generic Hocuspocus persistence driver for the database",
-  "version": "2.9.1-rc.0",
+  "version": "2.10.0",
   "homepage": "https://hocuspocus.dev",
   "keywords": [
     "hocuspocus",
@@ -27,7 +27,7 @@
     "dist"
   ],
   "dependencies": {
-    "@hocuspocus/server": "^2.9.1-rc.0"
+    "@hocuspocus/server": "^2.10.0"
   },
   "peerDependencies": {
     "yjs": "^13.6.8"