@hocuspocus/extension-throttle 2.15.2 → 3.0.4-rc.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (51) hide show
  1. package/dist/hocuspocus-throttle.cjs +0 -2
  2. package/dist/hocuspocus-throttle.cjs.map +1 -1
  3. package/dist/hocuspocus-throttle.esm.js.map +1 -1
  4. package/dist/packages/extension-database/src/Database.d.ts +1 -1
  5. package/dist/packages/extension-logger/src/Logger.d.ts +1 -1
  6. package/dist/packages/extension-redis/src/Redis.d.ts +4 -3
  7. package/dist/packages/extension-sqlite/src/SQLite.d.ts +2 -1
  8. package/dist/packages/extension-throttle/src/index.d.ts +2 -2
  9. package/dist/packages/extension-webhook/src/index.d.ts +3 -3
  10. package/dist/packages/provider/src/HocuspocusProvider.d.ts +12 -45
  11. package/dist/packages/provider/src/HocuspocusProviderWebsocket.d.ts +5 -9
  12. package/dist/packages/provider/src/IncomingMessage.d.ts +3 -3
  13. package/dist/packages/provider/src/MessageReceiver.d.ts +2 -4
  14. package/dist/packages/provider/src/MessageSender.d.ts +2 -2
  15. package/dist/packages/provider/src/OutgoingMessage.d.ts +2 -2
  16. package/dist/packages/provider/src/OutgoingMessages/AuthenticationMessage.d.ts +2 -1
  17. package/dist/packages/provider/src/OutgoingMessages/AwarenessMessage.d.ts +2 -1
  18. package/dist/packages/provider/src/OutgoingMessages/CloseMessage.d.ts +2 -1
  19. package/dist/packages/provider/src/OutgoingMessages/QueryAwarenessMessage.d.ts +2 -1
  20. package/dist/packages/provider/src/OutgoingMessages/StatelessMessage.d.ts +2 -1
  21. package/dist/packages/provider/src/OutgoingMessages/SyncStepOneMessage.d.ts +2 -1
  22. package/dist/packages/provider/src/OutgoingMessages/SyncStepTwoMessage.d.ts +2 -1
  23. package/dist/packages/provider/src/OutgoingMessages/UpdateMessage.d.ts +2 -1
  24. package/dist/packages/provider/src/index.d.ts +0 -2
  25. package/dist/packages/provider/src/types.d.ts +12 -12
  26. package/dist/packages/server/src/ClientConnection.d.ts +19 -10
  27. package/dist/packages/server/src/Connection.d.ts +7 -23
  28. package/dist/packages/server/src/DirectConnection.d.ts +2 -2
  29. package/dist/packages/server/src/Document.d.ts +3 -7
  30. package/dist/packages/server/src/Hocuspocus.d.ts +7 -36
  31. package/dist/packages/server/src/IncomingMessage.d.ts +3 -3
  32. package/dist/packages/server/src/MessageReceiver.d.ts +5 -7
  33. package/dist/packages/server/src/OutgoingMessage.d.ts +4 -3
  34. package/dist/packages/server/src/Server.d.ts +23 -3
  35. package/dist/packages/server/src/index.d.ts +1 -1
  36. package/dist/packages/server/src/types.d.ts +15 -29
  37. package/dist/packages/server/src/util/getParameters.d.ts +1 -1
  38. package/dist/packages/transformer/src/Prosemirror.d.ts +1 -1
  39. package/dist/packages/transformer/src/Tiptap.d.ts +3 -3
  40. package/dist/packages/transformer/src/types.d.ts +1 -1
  41. package/dist/tests/utils/newHocuspocus.d.ts +2 -2
  42. package/dist/tests/utils/newHocuspocusProvider.d.ts +2 -2
  43. package/dist/tests/utils/newHocuspocusProviderWebsocket.d.ts +4 -3
  44. package/dist/tests/utils/retryableAssertion.d.ts +1 -1
  45. package/package.json +2 -2
  46. package/src/index.ts +3 -3
  47. package/dist/packages/provider/src/TiptapCollabProvider.d.ts +0 -161
  48. package/dist/packages/provider/src/TiptapCollabProviderWebsocket.d.ts +0 -19
  49. package/dist/packages/server/src/Debugger.d.ts +0 -14
  50. package/dist/tests/server/getMessageLogs.d.ts +0 -1
  51. package/dist/tests/server/requiresAuthentication.d.ts +0 -1
@@ -1,15 +1,12 @@
1
1
  /// <reference types="node" />
2
- import { IncomingMessage } from 'http';
3
- import WebSocket, { AddressInfo } from 'ws';
4
- import { Server as HocuspocusServer } from './Server.js';
5
- import { Debugger } from './Debugger.js';
2
+ import type { IncomingMessage } from 'http';
3
+ import type WebSocket from 'ws';
4
+ import type { Server } from './Server.js';
6
5
  import { DirectConnection } from './DirectConnection.js';
7
6
  import Document from './Document.js';
8
- import { Configuration, ConnectionConfiguration, HookName, HookPayloadByName, onListenPayload, onStoreDocumentPayload } from './types.js';
7
+ import type { Configuration, ConnectionConfiguration, HookName, HookPayloadByName, onStoreDocumentPayload } from './types.js';
9
8
  export declare const defaultConfiguration: {
10
9
  name: null;
11
- port: number;
12
- address: string;
13
10
  timeout: number;
14
11
  debounce: number;
15
12
  maxDebounce: number;
@@ -19,17 +16,12 @@ export declare const defaultConfiguration: {
19
16
  gcFilter: () => boolean;
20
17
  };
21
18
  unloadImmediately: boolean;
22
- stopOnSignals: boolean;
23
19
  };
24
- /**
25
- * Hocuspocus Server
26
- */
27
20
  export declare class Hocuspocus {
28
21
  configuration: Configuration;
29
22
  loadingDocuments: Map<string, Promise<Document>>;
30
23
  documents: Map<string, Document>;
31
- server?: HocuspocusServer;
32
- debugger: Debugger;
24
+ server?: Server;
33
25
  debouncer: {
34
26
  debounce: (id: string, func: Function, debounce: number, maxDebounce: number) => any;
35
27
  isDebounced: (id: string) => boolean;
@@ -37,19 +29,9 @@ export declare class Hocuspocus {
37
29
  };
38
30
  constructor(configuration?: Partial<Configuration>);
39
31
  /**
40
- * Configure the server
32
+ * Configure Hocuspocus
41
33
  */
42
34
  configure(configuration: Partial<Configuration>): Hocuspocus;
43
- get requiresAuthentication(): boolean;
44
- /**
45
- * Start the server
46
- */
47
- listen(portOrCallback?: number | ((data: onListenPayload) => Promise<any>) | null, callback?: any, websocketOptions?: WebSocket.ServerOptions): Promise<Hocuspocus>;
48
- get address(): AddressInfo;
49
- get URL(): string;
50
- get webSocketURL(): string;
51
- get httpURL(): string;
52
- private showStartScreen;
53
35
  /**
54
36
  * Get the total number of active documents
55
37
  */
@@ -62,10 +44,6 @@ export declare class Hocuspocus {
62
44
  * Force close one or more connections
63
45
  */
64
46
  closeConnections(documentName?: string): void;
65
- /**
66
- * Destroy the server
67
- */
68
- destroy(): Promise<any>;
69
47
  /**
70
48
  * The `handleConnection` method receives incoming WebSocket connections,
71
49
  * runs all hooks:
@@ -88,7 +66,7 @@ export declare class Hocuspocus {
88
66
  * Create a new document by the given request
89
67
  */
90
68
  createDocument(documentName: string, request: Partial<Pick<IncomingMessage, 'headers' | 'url'>>, socketId: string, connection: ConnectionConfiguration, context?: any): Promise<Document>;
91
- loadDocument(documentName: string, request: Partial<Pick<IncomingMessage, 'headers' | 'url'>>, socketId: string, connection: ConnectionConfiguration, context?: any): Promise<Document>;
69
+ loadDocument(documentName: string, request: Partial<Pick<IncomingMessage, 'headers' | 'url'>>, socketId: string, connectionConfig: ConnectionConfiguration, context?: any): Promise<Document>;
92
70
  storeDocumentHooks(document: Document, hookPayload: onStoreDocumentPayload, immediately?: boolean): any;
93
71
  /**
94
72
  * Run the given hook on all configured extensions.
@@ -96,12 +74,5 @@ export declare class Hocuspocus {
96
74
  */
97
75
  hooks<T extends HookName>(name: T, payload: HookPayloadByName[T], callback?: Function | null): Promise<any>;
98
76
  unloadDocument(document: Document): Promise<any>;
99
- enableDebugging(): void;
100
- enableMessageLogging(): void;
101
- disableLogging(): void;
102
- disableDebugging(): void;
103
- flushMessageLogs(): this;
104
- getMessageLogs(): any[];
105
77
  openDirectConnection(documentName: string, context?: any): Promise<DirectConnection>;
106
78
  }
107
- export declare const Server: Hocuspocus;
@@ -1,6 +1,6 @@
1
- import { Decoder } from 'lib0/decoding';
2
- import { Encoder } from 'lib0/encoding';
3
- import { MessageType } from './types.js';
1
+ import type { Decoder } from 'lib0/decoding';
2
+ import type { Encoder } from 'lib0/encoding';
3
+ import type { MessageType } from './types.js';
4
4
  export declare class IncomingMessage {
5
5
  /**
6
6
  * Access to the received message.
@@ -1,13 +1,11 @@
1
- import Connection from './Connection.js';
2
- import { Debugger } from './Debugger.js';
3
- import Document from './Document.js';
4
- import { IncomingMessage } from './IncomingMessage.js';
1
+ import type Connection from './Connection.js';
2
+ import type Document from './Document.js';
3
+ import type { IncomingMessage } from './IncomingMessage.js';
5
4
  export declare class MessageReceiver {
6
5
  message: IncomingMessage;
7
- logger: Debugger;
8
6
  defaultTransactionOrigin?: string;
9
- constructor(message: IncomingMessage, logger: Debugger, defaultTransactionOrigin?: string);
7
+ constructor(message: IncomingMessage, defaultTransactionOrigin?: string);
10
8
  apply(document: Document, connection?: Connection, reply?: (message: Uint8Array) => void): void;
11
- readSyncMessage(message: IncomingMessage, document: Document, connection?: Connection, reply?: (message: Uint8Array) => void, requestFirstSync?: boolean): 0 | 2 | 1;
9
+ readSyncMessage(message: IncomingMessage, document: Document, connection?: Connection, reply?: (message: Uint8Array) => void, requestFirstSync?: boolean): 0 | 1 | 2;
12
10
  applyQueryAwarenessMessage(document: Document, reply?: (message: Uint8Array) => void): void;
13
11
  }
@@ -1,6 +1,6 @@
1
- import { Encoder } from 'lib0/encoding';
2
- import { Awareness } from 'y-protocols/awareness';
3
- import Document from './Document.js';
1
+ import type { Encoder } from 'lib0/encoding';
2
+ import type { Awareness } from 'y-protocols/awareness';
3
+ import type Document from './Document.js';
4
4
  export declare class OutgoingMessage {
5
5
  encoder: Encoder;
6
6
  type?: number;
@@ -17,5 +17,6 @@ export declare class OutgoingMessage {
17
17
  writeStateless(payload: string): OutgoingMessage;
18
18
  writeBroadcastStateless(payload: string): OutgoingMessage;
19
19
  writeSyncStatus(updateSaved: boolean): OutgoingMessage;
20
+ writeCloseMessage(reason: string): OutgoingMessage;
20
21
  toUint8Array(): Uint8Array;
21
22
  }
@@ -1,13 +1,33 @@
1
1
  /// <reference types="node" />
2
- import { IncomingMessage, Server as HTTPServer, ServerResponse } from 'http';
3
- import { ServerOptions, WebSocketServer } from 'ws';
2
+ import type { IncomingMessage, Server as HTTPServer, ServerResponse } from 'http';
3
+ import { WebSocketServer } from 'ws';
4
+ import type { AddressInfo, ServerOptions } from 'ws';
4
5
  import { Hocuspocus } from './Hocuspocus.js';
6
+ import type { Configuration } from './types';
7
+ export interface ServerConfiguration extends Configuration {
8
+ port?: number;
9
+ address?: string;
10
+ stopOnSignals?: boolean;
11
+ }
12
+ export declare const defaultServerConfiguration: {
13
+ port: number;
14
+ address: string;
15
+ stopOnSignals: boolean;
16
+ };
5
17
  export declare class Server {
6
18
  httpServer: HTTPServer;
7
19
  webSocketServer: WebSocketServer;
8
20
  hocuspocus: Hocuspocus;
9
- constructor(hocuspocus: Hocuspocus, websocketOptions?: ServerOptions);
21
+ configuration: ServerConfiguration;
22
+ constructor(configuration?: Partial<ServerConfiguration>, websocketOptions?: ServerOptions);
10
23
  setupWebsocketConnection: () => void;
11
24
  setupHttpUpgrade: () => void;
12
25
  requestHandler: (request: IncomingMessage, response: ServerResponse) => Promise<void>;
26
+ listen(port?: number, callback?: any): Promise<Hocuspocus>;
27
+ get address(): AddressInfo;
28
+ destroy(): Promise<any>;
29
+ get URL(): string;
30
+ get webSocketURL(): string;
31
+ get httpURL(): string;
32
+ private showStartScreen;
13
33
  }
@@ -1,9 +1,9 @@
1
1
  export * from './Connection.js';
2
- export * from './Debugger.js';
3
2
  export * from './Document.js';
4
3
  export * from './Hocuspocus.js';
5
4
  export * from './IncomingMessage.js';
6
5
  export * from './MessageReceiver.js';
7
6
  export * from './OutgoingMessage.js';
7
+ export * from './Server.js';
8
8
  export * from './types.js';
9
9
  export * from './util/debounce.js';
@@ -1,12 +1,13 @@
1
1
  /// <reference types="node" />
2
2
  /// <reference types="node" />
3
3
  /// <reference types="node" />
4
- import { IncomingHttpHeaders, IncomingMessage, ServerResponse } from 'http';
5
- import { URLSearchParams } from 'url';
6
- import { Awareness } from 'y-protocols/awareness';
7
- import Connection from './Connection.js';
8
- import Document from './Document.js';
9
- import { Hocuspocus } from './Hocuspocus.js';
4
+ /// <reference types="node" />
5
+ import type { IncomingHttpHeaders, IncomingMessage, ServerResponse } from 'http';
6
+ import type { URLSearchParams } from 'url';
7
+ import type { Awareness } from 'y-protocols/awareness';
8
+ import type Connection from './Connection.js';
9
+ import type Document from './Document.js';
10
+ import type { Hocuspocus } from './Hocuspocus.js';
10
11
  export declare enum MessageType {
11
12
  Unknown = -1,
12
13
  Sync = 0,
@@ -26,7 +27,6 @@ export interface AwarenessUpdate {
26
27
  }
27
28
  export interface ConnectionConfiguration {
28
29
  readOnly: boolean;
29
- requiresAuthentication: boolean;
30
30
  isAuthenticated: boolean;
31
31
  }
32
32
  export interface Extension {
@@ -87,14 +87,6 @@ export interface Configuration extends Extension {
87
87
  * A list of hocuspocus extensions.
88
88
  */
89
89
  extensions: Array<Extension>;
90
- /**
91
- * The port which the server listens on.
92
- */
93
- port?: number;
94
- /**
95
- * The address which the server listens on.
96
- */
97
- address?: string;
98
90
  /**
99
91
  * Defines in which interval the server sends a ping, and closes the connection when no pong is sent back.
100
92
  */
@@ -120,12 +112,6 @@ export interface Configuration extends Extension {
120
112
  * your onStoreDocument is rate-limited.
121
113
  */
122
114
  unloadImmediately: boolean;
123
- /**
124
- * the server will gracefully stop if SIGINT, SIGQUIT or SIGTERM is received.
125
- *
126
- * Set this to false if you don't want that.
127
- */
128
- stopOnSignals: boolean;
129
115
  /**
130
116
  * options to pass to the ydoc document
131
117
  */
@@ -149,7 +135,7 @@ export interface onAuthenticatePayload {
149
135
  request: IncomingMessage;
150
136
  socketId: string;
151
137
  token: string;
152
- connection: ConnectionConfiguration;
138
+ connectionConfig: ConnectionConfiguration;
153
139
  }
154
140
  export interface onCreateDocumentPayload {
155
141
  context: any;
@@ -158,7 +144,7 @@ export interface onCreateDocumentPayload {
158
144
  requestHeaders: IncomingHttpHeaders;
159
145
  requestParameters: URLSearchParams;
160
146
  socketId: string;
161
- connection: ConnectionConfiguration;
147
+ connectionConfig: ConnectionConfiguration;
162
148
  }
163
149
  export interface onConnectPayload {
164
150
  context: any;
@@ -168,7 +154,7 @@ export interface onConnectPayload {
168
154
  requestHeaders: IncomingHttpHeaders;
169
155
  requestParameters: URLSearchParams;
170
156
  socketId: string;
171
- connection: ConnectionConfiguration;
157
+ connectionConfig: ConnectionConfiguration;
172
158
  }
173
159
  export interface connectedPayload {
174
160
  context: any;
@@ -178,8 +164,8 @@ export interface connectedPayload {
178
164
  requestHeaders: IncomingHttpHeaders;
179
165
  requestParameters: URLSearchParams;
180
166
  socketId: string;
181
- connection: ConnectionConfiguration;
182
- connectionInstance: Connection;
167
+ connectionConfig: ConnectionConfiguration;
168
+ connection: Connection;
183
169
  }
184
170
  export interface onLoadDocumentPayload {
185
171
  context: any;
@@ -189,7 +175,7 @@ export interface onLoadDocumentPayload {
189
175
  requestHeaders: IncomingHttpHeaders;
190
176
  requestParameters: URLSearchParams;
191
177
  socketId: string;
192
- connection: ConnectionConfiguration;
178
+ connectionConfig: ConnectionConfiguration;
193
179
  }
194
180
  export interface afterLoadDocumentPayload {
195
181
  context: any;
@@ -199,7 +185,7 @@ export interface afterLoadDocumentPayload {
199
185
  requestHeaders: IncomingHttpHeaders;
200
186
  requestParameters: URLSearchParams;
201
187
  socketId: string;
202
- connection: ConnectionConfiguration;
188
+ connectionConfig: ConnectionConfiguration;
203
189
  }
204
190
  export interface onChangePayload {
205
191
  clientsCount: number;
@@ -269,7 +255,7 @@ export interface fetchPayload {
269
255
  requestHeaders: IncomingHttpHeaders;
270
256
  requestParameters: URLSearchParams;
271
257
  socketId: string;
272
- connection: ConnectionConfiguration;
258
+ connectionConfig: ConnectionConfiguration;
273
259
  }
274
260
  export interface storePayload extends onStoreDocumentPayload {
275
261
  state: Buffer;
@@ -1,6 +1,6 @@
1
1
  /// <reference types="node" />
2
2
  /// <reference types="node" />
3
- import { IncomingMessage } from 'http';
3
+ import type { IncomingMessage } from 'http';
4
4
  import { URLSearchParams } from 'url';
5
5
  /**
6
6
  * Get parameters by the given request
@@ -1,6 +1,6 @@
1
1
  import { Doc } from 'yjs';
2
2
  import { Schema } from '@tiptap/pm/model';
3
- import { Transformer } from './types.js';
3
+ import type { Transformer } from './types.js';
4
4
  declare class Prosemirror implements Transformer {
5
5
  defaultSchema: Schema;
6
6
  schema(schema: Schema): Prosemirror;
@@ -1,6 +1,6 @@
1
- import { Doc } from 'yjs';
2
- import { Extensions } from '@tiptap/core';
3
- import { Transformer } from './types.js';
1
+ import type { Doc } from 'yjs';
2
+ import type { Extensions } from '@tiptap/core';
3
+ import type { Transformer } from './types.js';
4
4
  export declare class Tiptap implements Transformer {
5
5
  defaultExtensions: Extensions;
6
6
  extensions(extensions: Extensions): Tiptap;
@@ -1,4 +1,4 @@
1
- import { Doc } from 'yjs';
1
+ import type { Doc } from 'yjs';
2
2
  export interface Transformer {
3
3
  fromYdoc: (document: Doc, fieldName?: string | Array<string>) => any;
4
4
  toYdoc: (document: any, fieldName: string) => Doc;
@@ -1,2 +1,2 @@
1
- import { Hocuspocus, Configuration } from '@hocuspocus/server';
2
- export declare const newHocuspocus: (options?: Partial<Configuration>) => Promise<Hocuspocus>;
1
+ import type { ServerConfiguration } from '@hocuspocus/server';
2
+ export declare const newHocuspocus: (options?: Partial<ServerConfiguration>) => Promise<import("@hocuspocus/server").Hocuspocus>;
@@ -1,3 +1,3 @@
1
- import { HocuspocusProvider, HocuspocusProviderConfiguration, HocuspocusProviderWebsocket, HocuspocusProviderWebsocketConfiguration } from '@hocuspocus/provider';
2
- import { Hocuspocus } from '@hocuspocus/server';
1
+ import { HocuspocusProvider, type HocuspocusProviderConfiguration, type HocuspocusProviderWebsocket, type HocuspocusProviderWebsocketConfiguration } from '@hocuspocus/provider';
2
+ import type { Hocuspocus } from '@hocuspocus/server';
3
3
  export declare const newHocuspocusProvider: (server: Hocuspocus, options?: Partial<HocuspocusProviderConfiguration>, websocketOptions?: Partial<HocuspocusProviderWebsocketConfiguration>, websocketProvider?: HocuspocusProviderWebsocket) => HocuspocusProvider;
@@ -1,3 +1,4 @@
1
- import { HocuspocusProviderWebsocket, HocuspocusProviderWebsocketConfiguration } from '@hocuspocus/provider';
2
- import { Hocuspocus } from '@hocuspocus/server';
3
- export declare const newHocuspocusProviderWebsocket: (server: Hocuspocus, options?: Partial<Omit<HocuspocusProviderWebsocketConfiguration, 'url'>>) => HocuspocusProviderWebsocket;
1
+ import type { HocuspocusProviderWebsocketConfiguration } from '@hocuspocus/provider';
2
+ import { HocuspocusProviderWebsocket } from '@hocuspocus/provider';
3
+ import type { Hocuspocus } from '@hocuspocus/server';
4
+ export declare const newHocuspocusProviderWebsocket: (hocuspocus: Hocuspocus, options?: Partial<Omit<HocuspocusProviderWebsocketConfiguration, 'url'>>) => HocuspocusProviderWebsocket;
@@ -1,2 +1,2 @@
1
- import { ExecutionContext } from 'ava';
1
+ import type { ExecutionContext } from 'ava';
2
2
  export declare const retryableAssertion: (t: ExecutionContext, recoverableTry: (tt: ExecutionContext) => void) => Promise<void>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@hocuspocus/extension-throttle",
3
- "version": "2.15.2",
3
+ "version": "3.0.4-rc.0",
4
4
  "description": "hocuspocus throttle extension",
5
5
  "homepage": "https://hocuspocus.dev",
6
6
  "keywords": [
@@ -28,7 +28,7 @@
28
28
  "dist"
29
29
  ],
30
30
  "dependencies": {
31
- "@hocuspocus/server": "^2.15.2"
31
+ "@hocuspocus/server": "^3.0.4-rc.0"
32
32
  },
33
33
  "gitHead": "b3454a4ca289a84ddfb7fa5607a2d4b8d5c37e9d"
34
34
  }
package/src/index.ts CHANGED
@@ -1,4 +1,4 @@
1
- import {
1
+ import type {
2
2
  Extension,
3
3
  onConnectPayload,
4
4
  } from '@hocuspocus/server'
@@ -23,7 +23,7 @@ export class Throttle implements Extension {
23
23
 
24
24
  bannedIps: Map<string, number> = new Map()
25
25
 
26
- cleanupInterval?: NodeJS.Timer
26
+ cleanupInterval?: NodeJS.Timeout
27
27
 
28
28
  /**
29
29
  * Constructor
@@ -73,7 +73,7 @@ export class Throttle implements Extension {
73
73
  * Throttle requests
74
74
  * @private
75
75
  */
76
- private throttle(ip: string): Boolean {
76
+ private throttle(ip: string): boolean {
77
77
  if (!this.configuration.throttle) {
78
78
  return false
79
79
  }
@@ -1,161 +0,0 @@
1
- import type { AbstractType, YArrayEvent } from 'yjs';
2
- import * as Y from 'yjs';
3
- import { HocuspocusProvider, HocuspocusProviderConfiguration } from './HocuspocusProvider.js';
4
- import { TiptapCollabProviderWebsocket } from './TiptapCollabProviderWebsocket.js';
5
- import { type DeleteCommentOptions, type DeleteThreadOptions, type GetThreadsOptions, type TCollabComment, type TCollabThread, type THistoryVersion } from './types.js';
6
- export type TiptapCollabProviderConfiguration = Required<Pick<HocuspocusProviderConfiguration, 'name'>> & Partial<HocuspocusProviderConfiguration> & (Required<Pick<AdditionalTiptapCollabProviderConfiguration, 'websocketProvider'>> | Required<Pick<AdditionalTiptapCollabProviderConfiguration, 'appId'>> | Required<Pick<AdditionalTiptapCollabProviderConfiguration, 'baseUrl'>>) & Pick<AdditionalTiptapCollabProviderConfiguration, 'user'> & {
7
- /**
8
- * Pass `true` if you want to delete a thread when the first comment is deleted.
9
- */
10
- deleteThreadOnFirstCommentDelete?: boolean;
11
- };
12
- export interface AdditionalTiptapCollabProviderConfiguration {
13
- /**
14
- * A Hocuspocus Cloud App ID, get one here: https://cloud.tiptap.dev
15
- */
16
- appId?: string;
17
- /**
18
- * If you are using the on-premise version of TiptapCollab, put your baseUrl here (e.g. https://collab.yourdomain.com)
19
- */
20
- baseUrl?: string;
21
- websocketProvider?: TiptapCollabProviderWebsocket;
22
- user?: string;
23
- }
24
- export declare class TiptapCollabProvider extends HocuspocusProvider {
25
- tiptapCollabConfigurationPrefix: string;
26
- userData?: Y.PermanentUserData;
27
- constructor(configuration: TiptapCollabProviderConfiguration);
28
- /**
29
- * note: this will only work if your server loaded @hocuspocus-pro/extension-history, or if you are on a Tiptap business plan.
30
- */
31
- createVersion(name?: string): void;
32
- /**
33
- * note: this will only work if your server loaded @hocuspocus-pro/extension-history, or if you are on a Tiptap business plan.
34
- */
35
- revertToVersion(targetVersion: number): void;
36
- /**
37
- * note: this will only work if your server loaded @hocuspocus-pro/extension-history, or if you are on a Tiptap business plan.
38
- *
39
- * The server will reply with a stateless message (THistoryVersionPreviewEvent)
40
- */
41
- previewVersion(targetVersion: number): void;
42
- /**
43
- * note: this will only work if your server loaded @hocuspocus-pro/extension-history, or if you are on a Tiptap business plan.
44
- */
45
- getVersions(): THistoryVersion[];
46
- watchVersions(callback: Parameters<AbstractType<YArrayEvent<THistoryVersion>>['observe']>[0]): void;
47
- unwatchVersions(callback: Parameters<AbstractType<YArrayEvent<THistoryVersion>>['unobserve']>[0]): void;
48
- isAutoVersioning(): boolean;
49
- enableAutoVersioning(): 1;
50
- disableAutoVersioning(): 0;
51
- /**
52
- * Returns all users in the document as Y.Map objects
53
- * @returns An array of Y.Map objects
54
- */
55
- private getYThreads;
56
- /**
57
- * Finds all threads in the document and returns them as JSON objects
58
- * @options Options to control the output of the threads (e.g. include deleted threads)
59
- * @returns An array of threads as JSON objects
60
- */
61
- getThreads<Data, CommentData>(options?: GetThreadsOptions): TCollabThread<Data, CommentData>[];
62
- /**
63
- * Find the index of a thread by its id
64
- * @param id The thread id
65
- * @returns The index of the thread or null if not found
66
- */
67
- private getThreadIndex;
68
- /**
69
- * Gets a single thread by its id
70
- * @param id The thread id
71
- * @returns The thread as a JSON object or null if not found
72
- */
73
- getThread<Data, CommentData>(id: string): TCollabThread<Data, CommentData> | null;
74
- /**
75
- * Gets a single thread by its id as a Y.Map object
76
- * @param id The thread id
77
- * @returns The thread as a Y.Map object or null if not found
78
- */
79
- private getYThread;
80
- /**
81
- * Create a new thread
82
- * @param data The thread data
83
- * @returns The created thread
84
- */
85
- createThread(data: Omit<TCollabThread, 'id' | 'createdAt' | 'updatedAt' | 'deletedAt' | 'comments' | 'deletedComments'>): TCollabThread;
86
- /**
87
- * Update a specific thread
88
- * @param id The thread id
89
- * @param data New data for the thread
90
- * @returns The updated thread or null if the thread is not found
91
- */
92
- updateThread(id: TCollabThread['id'], data: Partial<Pick<TCollabThread, 'data'> & {
93
- resolvedAt: TCollabThread['resolvedAt'] | null;
94
- }>): TCollabThread;
95
- /**
96
- * Handle the deletion of a thread. By default, the thread and it's comments are not deleted, but marked as deleted
97
- * via the `deletedAt` property. Forceful deletion can be enabled by setting the `force` option to `true`.
98
- *
99
- * If you only want to delete the comments of a thread, you can set the `deleteComments` option to `true`.
100
- * @param id The thread id
101
- * @param options A set of options that control how the thread is deleted
102
- * @returns The deleted thread or null if the thread is not found
103
- */
104
- deleteThread(id: TCollabThread['id'], options?: DeleteThreadOptions): TCollabThread | null | undefined;
105
- /**
106
- * Tries to restore a deleted thread
107
- * @param id The thread id
108
- * @returns The restored thread or null if the thread is not found
109
- */
110
- restoreThread(id: TCollabThread['id']): TCollabThread | null;
111
- /**
112
- * Returns comments from a thread, either deleted or not
113
- * @param threadId The thread id
114
- * @param includeDeleted If you want to include deleted comments, defaults to `false`
115
- * @returns The comments or null if the thread is not found
116
- */
117
- getThreadComments(threadId: TCollabThread['id'], includeDeleted?: boolean): TCollabComment[] | null;
118
- /**
119
- * Get a single comment from a specific thread
120
- * @param threadId The thread id
121
- * @param commentId The comment id
122
- * @param includeDeleted If you want to include deleted comments in the search
123
- * @returns The comment or null if not found
124
- */
125
- getThreadComment(threadId: TCollabThread['id'], commentId: TCollabComment['id'], includeDeleted?: boolean): TCollabComment | null;
126
- /**
127
- * Adds a comment to a thread
128
- * @param threadId The thread id
129
- * @param data The comment data
130
- * @returns The updated thread or null if the thread is not found
131
- * @example addComment('123', { content: 'Hello world', data: { author: 'Maria Doe' } })
132
- */
133
- addComment(threadId: TCollabThread['id'], data: Omit<TCollabComment, 'id' | 'updatedAt' | 'createdAt'>): TCollabThread;
134
- /**
135
- * Update a comment in a thread
136
- * @param threadId The thread id
137
- * @param commentId The comment id
138
- * @param data The new comment data
139
- * @returns The updated thread or null if the thread or comment is not found
140
- * @example updateComment('123', { content: 'The new content', data: { attachments: ['file1.jpg'] }})
141
- */
142
- updateComment(threadId: TCollabThread['id'], commentId: TCollabComment['id'], data: Partial<Pick<TCollabComment, 'data' | 'content'>>): TCollabThread;
143
- /**
144
- * Deletes a comment from a thread
145
- * @param threadId The thread id
146
- * @param commentId The comment id
147
- * @param options A set of options that control how the comment is deleted
148
- * @returns The updated thread or null if the thread or comment is not found
149
- */
150
- deleteComment(threadId: TCollabThread['id'], commentId: TCollabComment['id'], options?: DeleteCommentOptions): TCollabThread | null | undefined;
151
- /**
152
- * Start watching threads for changes
153
- * @param callback The callback function to be called when a thread changes
154
- */
155
- watchThreads(callback: () => void): void;
156
- /**
157
- * Stop watching threads for changes
158
- * @param callback The callback function to be removed
159
- */
160
- unwatchThreads(callback: () => void): void;
161
- }
@@ -1,19 +0,0 @@
1
- import { CompleteHocuspocusProviderWebsocketConfiguration, HocuspocusProviderWebsocket } from './HocuspocusProviderWebsocket.js';
2
- export type TiptapCollabProviderWebsocketConfiguration = Partial<CompleteHocuspocusProviderWebsocketConfiguration> & AdditionalTiptapCollabProviderWebsocketConfiguration;
3
- export interface AdditionalTiptapCollabProviderWebsocketConfiguration {
4
- /**
5
- * A Hocuspocus Cloud App ID, get one here: https://cloud.tiptap.dev
6
- */
7
- appId?: string;
8
- /**
9
- * If you are using the on-premise version of TiptapCollab, put your baseUrl here (e.g. https://collab.yourdomain.com)
10
- */
11
- baseUrl?: string;
12
- /**
13
- * Only fill this if you are using Tiptap Collab HA.
14
- */
15
- shardKey?: string;
16
- }
17
- export declare class TiptapCollabProviderWebsocket extends HocuspocusProviderWebsocket {
18
- constructor(configuration: TiptapCollabProviderWebsocketConfiguration);
19
- }
@@ -1,14 +0,0 @@
1
- export declare class Debugger {
2
- logs: any[];
3
- listen: boolean;
4
- output: boolean;
5
- enable(): void;
6
- disable(): void;
7
- verbose(): void;
8
- quiet(): void;
9
- log(message: any): this;
10
- flush(): this;
11
- get(): {
12
- logs: any[];
13
- };
14
- }
@@ -1 +0,0 @@
1
- export {};
@@ -1 +0,0 @@
1
- export {};