@hocuspocus/extension-logger 2.0.2 → 2.0.4
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.
- package/dist/packages/common/src/CloseEvents.d.ts +6 -0
- package/dist/packages/extension-redis/src/Redis.d.ts +6 -1
- package/dist/packages/provider/src/HocuspocusProvider.d.ts +1 -0
- package/dist/packages/provider/src/TiptapCollabProviderWebsocket.d.ts +11 -0
- package/dist/packages/provider/src/index.d.ts +1 -0
- package/package.json +2 -2
- package/dist/packages/provider/src/HocuspocusCloudProvider.d.ts +0 -12
|
@@ -2,6 +2,12 @@ export interface CloseEvent {
|
|
|
2
2
|
code: number;
|
|
3
3
|
reason: string;
|
|
4
4
|
}
|
|
5
|
+
/**
|
|
6
|
+
* The server is terminating the connection because a data frame was received
|
|
7
|
+
* that is too large.
|
|
8
|
+
* See: https://developer.mozilla.org/en-US/docs/Web/API/CloseEvent/code
|
|
9
|
+
*/
|
|
10
|
+
export declare const MessageTooBig: CloseEvent;
|
|
5
11
|
/**
|
|
6
12
|
* The server successfully processed the request, asks that the requester reset
|
|
7
13
|
* its document view, and is not returning any content.
|
|
@@ -42,6 +42,11 @@ export interface Configuration {
|
|
|
42
42
|
* The maximum time for the Redis lock in ms (in case it can’t be released).
|
|
43
43
|
*/
|
|
44
44
|
lockTimeout: number;
|
|
45
|
+
/**
|
|
46
|
+
* A delay before onDisconnect is executed. This allows last minute updates'
|
|
47
|
+
* sync messages to be received by the subscription before it's closed.
|
|
48
|
+
*/
|
|
49
|
+
disconnectDelay: number;
|
|
45
50
|
}
|
|
46
51
|
export declare class Redis implements Extension {
|
|
47
52
|
/**
|
|
@@ -103,7 +108,7 @@ export declare class Redis implements Extension {
|
|
|
103
108
|
* Make sure to *not* listen for further changes, when there’s
|
|
104
109
|
* noone connected anymore.
|
|
105
110
|
*/
|
|
106
|
-
onDisconnect: ({
|
|
111
|
+
onDisconnect: ({ document, documentName }: onDisconnectPayload) => Promise<void>;
|
|
107
112
|
beforeBroadcastStateless(data: beforeBroadcastStatelessPayload): Promise<number>;
|
|
108
113
|
/**
|
|
109
114
|
* Kill the Redlock connection immediately.
|
|
@@ -77,6 +77,7 @@ export declare class HocuspocusProvider extends EventEmitter {
|
|
|
77
77
|
get document(): Y.Doc;
|
|
78
78
|
get awareness(): Awareness;
|
|
79
79
|
get hasUnsyncedChanges(): boolean;
|
|
80
|
+
updateUnsyncedChanges(unsyncedChanges?: number): void;
|
|
80
81
|
forceSync(): void;
|
|
81
82
|
boundBeforeUnload: () => void;
|
|
82
83
|
beforeUnload(): void;
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { CompleteHocuspocusProviderWebsocketConfiguration, HocuspocusProviderWebsocket } from './HocuspocusProviderWebsocket';
|
|
2
|
+
export type TiptapCollabProviderWebsocketConfiguration = Partial<CompleteHocuspocusProviderWebsocketConfiguration> & AdditionalTiptapCollabProviderWebsocketConfiguration;
|
|
3
|
+
export interface AdditionalTiptapCollabProviderWebsocketConfiguration {
|
|
4
|
+
/**
|
|
5
|
+
* A Hocuspocus Cloud App ID, get one here: https://collab.tiptap.dev
|
|
6
|
+
*/
|
|
7
|
+
appId: string;
|
|
8
|
+
}
|
|
9
|
+
export declare class TiptapCollabProviderWebsocket extends HocuspocusProviderWebsocket {
|
|
10
|
+
constructor(configuration: TiptapCollabProviderWebsocketConfiguration);
|
|
11
|
+
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@hocuspocus/extension-logger",
|
|
3
|
-
"version": "2.0.
|
|
3
|
+
"version": "2.0.4",
|
|
4
4
|
"description": "hocuspocus logging 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.0.
|
|
31
|
+
"@hocuspocus/server": "^2.0.4"
|
|
32
32
|
},
|
|
33
33
|
"gitHead": "b3454a4ca289a84ddfb7fa5607a2d4b8d5c37e9d"
|
|
34
34
|
}
|
|
@@ -1,12 +0,0 @@
|
|
|
1
|
-
import { HocuspocusProvider, HocuspocusProviderConfiguration } from './HocuspocusProvider';
|
|
2
|
-
import { HocuspocusProviderWebsocketConfiguration } from './HocuspocusProviderWebsocket';
|
|
3
|
-
export type HocuspocusCloudProviderConfiguration = Required<Pick<HocuspocusProviderConfiguration, 'name'>> & Partial<HocuspocusProviderConfiguration> & Partial<Pick<HocuspocusProviderWebsocketConfiguration, 'url'>> & AdditionalHocuspocusCloudProviderConfiguration;
|
|
4
|
-
export interface AdditionalHocuspocusCloudProviderConfiguration {
|
|
5
|
-
/**
|
|
6
|
-
* A Hocuspocus Cloud key, get one here: https://hocuspocus.cloud/
|
|
7
|
-
*/
|
|
8
|
-
key: string;
|
|
9
|
-
}
|
|
10
|
-
export declare class HocuspocusCloudProvider extends HocuspocusProvider {
|
|
11
|
-
constructor(configuration: HocuspocusCloudProviderConfiguration);
|
|
12
|
-
}
|