@hocuspocus/extension-sqlite 2.0.6 → 2.1.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 (125) hide show
  1. package/dist/hocuspocus-sqlite.cjs +46 -46
  2. package/dist/hocuspocus-sqlite.esm.js +46 -46
  3. package/dist/packages/common/src/CloseEvents.d.ts +29 -29
  4. package/dist/packages/common/src/auth.d.ts +6 -6
  5. package/dist/packages/common/src/awarenessStatesToArray.d.ts +3 -3
  6. package/dist/packages/common/src/index.d.ts +4 -4
  7. package/dist/packages/common/src/types.d.ts +10 -10
  8. package/dist/packages/extension-database/src/Database.d.ts +30 -30
  9. package/dist/packages/extension-database/src/index.d.ts +1 -1
  10. package/dist/packages/extension-logger/src/Logger.d.ts +67 -67
  11. package/dist/packages/extension-logger/src/index.d.ts +1 -1
  12. package/dist/packages/extension-redis/src/Redis.d.ts +116 -117
  13. package/dist/packages/extension-redis/src/index.d.ts +1 -1
  14. package/dist/packages/extension-sqlite/src/SQLite.d.ts +26 -26
  15. package/dist/packages/extension-sqlite/src/index.d.ts +1 -1
  16. package/dist/packages/extension-throttle/src/index.d.ts +31 -31
  17. package/dist/packages/extension-webhook/src/index.d.ts +57 -57
  18. package/dist/packages/provider/src/EventEmitter.d.ts +9 -9
  19. package/dist/packages/provider/src/HocuspocusProvider.d.ts +110 -110
  20. package/dist/packages/provider/src/HocuspocusProviderWebsocket.d.ts +115 -115
  21. package/dist/packages/provider/src/IncomingMessage.d.ts +16 -16
  22. package/dist/packages/provider/src/MessageReceiver.d.ts +13 -13
  23. package/dist/packages/provider/src/MessageSender.d.ts +10 -10
  24. package/dist/packages/provider/src/OutgoingMessage.d.ts +9 -9
  25. package/dist/packages/provider/src/OutgoingMessages/AuthenticationMessage.d.ts +7 -7
  26. package/dist/packages/provider/src/OutgoingMessages/AwarenessMessage.d.ts +8 -8
  27. package/dist/packages/provider/src/OutgoingMessages/CloseMessage.d.ts +8 -8
  28. package/dist/packages/provider/src/OutgoingMessages/QueryAwarenessMessage.d.ts +8 -8
  29. package/dist/packages/provider/src/OutgoingMessages/StatelessMessage.d.ts +7 -7
  30. package/dist/packages/provider/src/OutgoingMessages/SyncStepOneMessage.d.ts +8 -8
  31. package/dist/packages/provider/src/OutgoingMessages/SyncStepTwoMessage.d.ts +8 -8
  32. package/dist/packages/provider/src/OutgoingMessages/UpdateMessage.d.ts +7 -7
  33. package/dist/packages/provider/src/TiptapCollabProvider.d.ts +11 -11
  34. package/dist/packages/provider/src/TiptapCollabProviderWebsocket.d.ts +11 -11
  35. package/dist/packages/provider/src/index.d.ts +5 -5
  36. package/dist/packages/provider/src/types.d.ts +84 -84
  37. package/dist/packages/server/src/Connection.d.ts +71 -71
  38. package/dist/packages/server/src/Debugger.d.ts +14 -14
  39. package/dist/packages/server/src/DirectConnection.d.ts +13 -0
  40. package/dist/packages/server/src/Document.d.ts +91 -88
  41. package/dist/packages/server/src/Hocuspocus.d.ts +111 -108
  42. package/dist/packages/server/src/IncomingMessage.d.ts +21 -21
  43. package/dist/packages/server/src/MessageReceiver.d.ts +12 -12
  44. package/dist/packages/server/src/OutgoingMessage.d.ts +20 -20
  45. package/dist/packages/server/src/index.d.ts +8 -8
  46. package/dist/packages/server/src/types.d.ts +266 -264
  47. package/dist/packages/transformer/src/Prosemirror.d.ts +11 -11
  48. package/dist/packages/transformer/src/Tiptap.d.ts +10 -10
  49. package/dist/packages/transformer/src/index.d.ts +3 -3
  50. package/dist/packages/transformer/src/types.d.ts +5 -5
  51. package/dist/playground/backend/src/default.d.ts +1 -1
  52. package/dist/playground/backend/src/express.d.ts +1 -1
  53. package/dist/playground/backend/src/koa.d.ts +1 -1
  54. package/dist/playground/backend/src/load-document.d.ts +1 -1
  55. package/dist/playground/backend/src/redis.d.ts +1 -1
  56. package/dist/playground/backend/src/slow.d.ts +1 -1
  57. package/dist/playground/backend/src/tiptapcollab.d.ts +1 -1
  58. package/dist/playground/backend/src/webhook.d.ts +1 -1
  59. package/dist/playground/frontend/src/main.d.ts +1 -1
  60. package/dist/playground/frontend/vite.config.d.ts +2 -2
  61. package/dist/tests/extension-database/fetch.d.ts +1 -1
  62. package/dist/tests/extension-logger/onListen.d.ts +1 -1
  63. package/dist/tests/extension-redis/closeConnections.d.ts +1 -1
  64. package/dist/tests/extension-redis/getConnectionCount.d.ts +1 -1
  65. package/dist/tests/extension-redis/getDocumentsCount.d.ts +1 -1
  66. package/dist/tests/extension-redis/onAwarenessChange.d.ts +1 -1
  67. package/dist/tests/extension-redis/onChange.d.ts +1 -1
  68. package/dist/tests/extension-redis/onStateless.d.ts +1 -1
  69. package/dist/tests/extension-redis/onStoreDocument.d.ts +1 -1
  70. package/dist/tests/extension-throttle/banning.d.ts +1 -1
  71. package/dist/tests/extension-throttle/configuration.d.ts +1 -1
  72. package/dist/tests/provider/observe.d.ts +1 -1
  73. package/dist/tests/provider/observeDeep.d.ts +1 -1
  74. package/dist/tests/provider/onAuthenticated.d.ts +1 -1
  75. package/dist/tests/provider/onAuthenticationFailed.d.ts +1 -1
  76. package/dist/tests/provider/onAwarenessChange.d.ts +1 -1
  77. package/dist/tests/provider/onAwarenessUpdate.d.ts +1 -1
  78. package/dist/tests/provider/onClose.d.ts +1 -1
  79. package/dist/tests/provider/onConnect.d.ts +1 -1
  80. package/dist/tests/provider/onDisconnect.d.ts +1 -1
  81. package/dist/tests/provider/onMessage.d.ts +1 -1
  82. package/dist/tests/provider/onOpen.d.ts +1 -1
  83. package/dist/tests/provider/onStateless.d.ts +1 -1
  84. package/dist/tests/provider/onSynced.d.ts +1 -1
  85. package/dist/tests/providerwebsocket/configuration.d.ts +1 -1
  86. package/dist/tests/server/address.d.ts +1 -1
  87. package/dist/tests/server/afterStoreDocument.d.ts +1 -1
  88. package/dist/tests/server/beforeBroadcastStateless.d.ts +1 -1
  89. package/dist/tests/server/beforeHandleMessage.d.ts +1 -1
  90. package/dist/tests/server/closeConnections.d.ts +1 -1
  91. package/dist/tests/server/getConnectionsCount.d.ts +1 -1
  92. package/dist/tests/server/getDocumentsCount.d.ts +1 -1
  93. package/dist/tests/server/getMessageLogs.d.ts +1 -1
  94. package/dist/tests/server/listen.d.ts +1 -1
  95. package/dist/tests/server/onAuthenticate.d.ts +1 -1
  96. package/dist/tests/server/onAwarenessUpdate.d.ts +1 -1
  97. package/dist/tests/server/onChange.d.ts +1 -1
  98. package/dist/tests/server/onClose.d.ts +1 -1
  99. package/dist/tests/server/onConfigure.d.ts +1 -1
  100. package/dist/tests/server/onConnect.d.ts +1 -1
  101. package/dist/tests/server/onDestroy.d.ts +1 -1
  102. package/dist/tests/server/onDisconnect.d.ts +1 -1
  103. package/dist/tests/server/onListen.d.ts +1 -1
  104. package/dist/tests/server/onLoadDocument.d.ts +1 -1
  105. package/dist/tests/server/onRequest.d.ts +1 -1
  106. package/dist/tests/server/onStateless.d.ts +1 -1
  107. package/dist/tests/server/onStoreDocument.d.ts +1 -1
  108. package/dist/tests/server/onUpgrade.d.ts +1 -1
  109. package/dist/tests/server/openDirectConnection.d.ts +1 -0
  110. package/dist/tests/server/requiresAuthentication.d.ts +1 -1
  111. package/dist/tests/server/websocketError.d.ts +1 -1
  112. package/dist/tests/transformer/TiptapTransformer.d.ts +1 -1
  113. package/dist/tests/utils/createDirectory.d.ts +1 -1
  114. package/dist/tests/utils/flushRedis.d.ts +1 -1
  115. package/dist/tests/utils/index.d.ts +9 -9
  116. package/dist/tests/utils/newHocuspocus.d.ts +2 -2
  117. package/dist/tests/utils/newHocuspocusProvider.d.ts +3 -3
  118. package/dist/tests/utils/newHocuspocusProviderWebsocket.d.ts +3 -3
  119. package/dist/tests/utils/randomInteger.d.ts +1 -1
  120. package/dist/tests/utils/redisConnectionSettings.d.ts +4 -4
  121. package/dist/tests/utils/removeDirectory.d.ts +1 -1
  122. package/dist/tests/utils/retryableAssertion.d.ts +2 -2
  123. package/dist/tests/utils/sleep.d.ts +1 -1
  124. package/package.json +4 -3
  125. package/src/index.ts +1 -1
@@ -1,110 +1,110 @@
1
- import * as Y from 'yjs';
2
- import { Awareness } from 'y-protocols/awareness';
3
- import * as mutex from 'lib0/mutex';
4
- import type { CloseEvent, Event, MessageEvent } from 'ws';
5
- import EventEmitter from './EventEmitter';
6
- import { ConstructableOutgoingMessage, onAuthenticationFailedParameters, onCloseParameters, onDisconnectParameters, onMessageParameters, onOpenParameters, onOutgoingMessageParameters, onStatelessParameters, onStatusParameters, onSyncedParameters, WebSocketStatus } from './types';
7
- import { CompleteHocuspocusProviderWebsocketConfiguration, HocuspocusProviderWebsocket } from './HocuspocusProviderWebsocket';
8
- import { onAwarenessChangeParameters, onAwarenessUpdateParameters } from '.';
9
- export type HocuspocusProviderConfiguration = Required<Pick<CompleteHocuspocusProviderConfiguration, 'name'>> & Partial<CompleteHocuspocusProviderConfiguration> & (Required<Pick<CompleteHocuspocusProviderWebsocketConfiguration, 'url'>> | Required<Pick<CompleteHocuspocusProviderConfiguration, 'websocketProvider'>>);
10
- export interface CompleteHocuspocusProviderConfiguration {
11
- /**
12
- * The identifier/name of your document
13
- */
14
- name: string;
15
- /**
16
- * The actual Y.js document
17
- */
18
- document: Y.Doc;
19
- /**
20
- * Pass false to disable broadcasting between browser tabs.
21
- */
22
- broadcast: boolean;
23
- /**
24
- * An Awareness instance to keep the presence state of all clients.
25
- */
26
- awareness: Awareness;
27
- /**
28
- * A token that’s sent to the backend for authentication purposes.
29
- */
30
- token: string | (() => string) | (() => Promise<string>) | null;
31
- /**
32
- * URL parameters that should be added.
33
- */
34
- parameters: {
35
- [key: string]: any;
36
- };
37
- /**
38
- * Hocuspocus websocket provider
39
- */
40
- websocketProvider: HocuspocusProviderWebsocket;
41
- /**
42
- * Force syncing the document in the defined interval.
43
- */
44
- forceSyncInterval: false | number;
45
- onAuthenticated: () => void;
46
- onAuthenticationFailed: (data: onAuthenticationFailedParameters) => void;
47
- onOpen: (data: onOpenParameters) => void;
48
- onConnect: () => void;
49
- onMessage: (data: onMessageParameters) => void;
50
- onOutgoingMessage: (data: onOutgoingMessageParameters) => void;
51
- onStatus: (data: onStatusParameters) => void;
52
- onSynced: (data: onSyncedParameters) => void;
53
- onDisconnect: (data: onDisconnectParameters) => void;
54
- onClose: (data: onCloseParameters) => void;
55
- onDestroy: () => void;
56
- onAwarenessUpdate: (data: onAwarenessUpdateParameters) => void;
57
- onAwarenessChange: (data: onAwarenessChangeParameters) => void;
58
- onStateless: (data: onStatelessParameters) => void;
59
- /**
60
- * Don’t output any warnings.
61
- */
62
- quiet: boolean;
63
- }
64
- export declare class HocuspocusProvider extends EventEmitter {
65
- configuration: CompleteHocuspocusProviderConfiguration;
66
- subscribedToBroadcastChannel: boolean;
67
- isSynced: boolean;
68
- unsyncedChanges: number;
69
- status: WebSocketStatus;
70
- isAuthenticated: boolean;
71
- mux: mutex.mutex;
72
- intervals: any;
73
- isConnected: boolean;
74
- constructor(configuration: HocuspocusProviderConfiguration);
75
- onStatus({ status }: onStatusParameters): void;
76
- setConfiguration(configuration?: Partial<HocuspocusProviderConfiguration>): void;
77
- get document(): Y.Doc;
78
- get awareness(): Awareness;
79
- get hasUnsyncedChanges(): boolean;
80
- updateUnsyncedChanges(unsyncedChanges?: number): void;
81
- forceSync(): void;
82
- boundBeforeUnload: () => void;
83
- beforeUnload(): void;
84
- registerEventListeners(): void;
85
- sendStateless(payload: string): void;
86
- documentUpdateHandler(update: Uint8Array, origin: any): void;
87
- awarenessUpdateHandler({ added, updated, removed }: any, origin: any): void;
88
- get synced(): boolean;
89
- set synced(state: boolean);
90
- receiveStateless(payload: string): void;
91
- get isAuthenticationRequired(): boolean;
92
- connect(): Promise<unknown>;
93
- disconnect(): void;
94
- onOpen(event: Event): Promise<void>;
95
- getToken(): Promise<string | null>;
96
- startSync(): void;
97
- send(message: ConstructableOutgoingMessage, args: any, broadcast?: boolean): void;
98
- onMessage(event: MessageEvent): void;
99
- onClose(event: CloseEvent): void;
100
- destroy(): void;
101
- permissionDeniedHandler(reason: string): void;
102
- authenticatedHandler(): void;
103
- get broadcastChannel(): string;
104
- boundBroadcastChannelSubscriber: (data: ArrayBuffer) => void;
105
- broadcastChannelSubscriber(data: ArrayBuffer): void;
106
- subscribeToBroadcastChannel(): void;
107
- disconnectBroadcastChannel(): void;
108
- broadcast(Message: ConstructableOutgoingMessage, args?: any): void;
109
- setAwarenessField(key: string, value: any): void;
110
- }
1
+ import * as Y from 'yjs';
2
+ import { Awareness } from 'y-protocols/awareness';
3
+ import * as mutex from 'lib0/mutex';
4
+ import type { CloseEvent, Event, MessageEvent } from 'ws';
5
+ import EventEmitter from './EventEmitter.js';
6
+ import { ConstructableOutgoingMessage, onAuthenticationFailedParameters, onCloseParameters, onDisconnectParameters, onMessageParameters, onOpenParameters, onOutgoingMessageParameters, onStatelessParameters, onStatusParameters, onSyncedParameters, WebSocketStatus, onAwarenessChangeParameters, onAwarenessUpdateParameters } from './types.js';
7
+ import { CompleteHocuspocusProviderWebsocketConfiguration, HocuspocusProviderWebsocket } from './HocuspocusProviderWebsocket.js';
8
+ export type HocuspocusProviderConfiguration = Required<Pick<CompleteHocuspocusProviderConfiguration, 'name'>> & Partial<CompleteHocuspocusProviderConfiguration> & (Required<Pick<CompleteHocuspocusProviderWebsocketConfiguration, 'url'>> | Required<Pick<CompleteHocuspocusProviderConfiguration, 'websocketProvider'>>);
9
+ export interface CompleteHocuspocusProviderConfiguration {
10
+ /**
11
+ * The identifier/name of your document
12
+ */
13
+ name: string;
14
+ /**
15
+ * The actual Y.js document
16
+ */
17
+ document: Y.Doc;
18
+ /**
19
+ * Pass false to disable broadcasting between browser tabs.
20
+ */
21
+ broadcast: boolean;
22
+ /**
23
+ * An Awareness instance to keep the presence state of all clients.
24
+ */
25
+ awareness: Awareness;
26
+ /**
27
+ * A token that’s sent to the backend for authentication purposes.
28
+ */
29
+ token: string | (() => string) | (() => Promise<string>) | null;
30
+ /**
31
+ * URL parameters that should be added.
32
+ */
33
+ parameters: {
34
+ [key: string]: any;
35
+ };
36
+ /**
37
+ * Hocuspocus websocket provider
38
+ */
39
+ websocketProvider: HocuspocusProviderWebsocket;
40
+ /**
41
+ * Force syncing the document in the defined interval.
42
+ */
43
+ forceSyncInterval: false | number;
44
+ onAuthenticated: () => void;
45
+ onAuthenticationFailed: (data: onAuthenticationFailedParameters) => void;
46
+ onOpen: (data: onOpenParameters) => void;
47
+ onConnect: () => void;
48
+ onMessage: (data: onMessageParameters) => void;
49
+ onOutgoingMessage: (data: onOutgoingMessageParameters) => void;
50
+ onStatus: (data: onStatusParameters) => void;
51
+ onSynced: (data: onSyncedParameters) => void;
52
+ onDisconnect: (data: onDisconnectParameters) => void;
53
+ onClose: (data: onCloseParameters) => void;
54
+ onDestroy: () => void;
55
+ onAwarenessUpdate: (data: onAwarenessUpdateParameters) => void;
56
+ onAwarenessChange: (data: onAwarenessChangeParameters) => void;
57
+ onStateless: (data: onStatelessParameters) => void;
58
+ /**
59
+ * Don’t output any warnings.
60
+ */
61
+ quiet: boolean;
62
+ }
63
+ export declare class HocuspocusProvider extends EventEmitter {
64
+ configuration: CompleteHocuspocusProviderConfiguration;
65
+ subscribedToBroadcastChannel: boolean;
66
+ isSynced: boolean;
67
+ unsyncedChanges: number;
68
+ status: WebSocketStatus;
69
+ isAuthenticated: boolean;
70
+ authorizedScope: string | undefined;
71
+ mux: mutex.mutex;
72
+ intervals: any;
73
+ isConnected: boolean;
74
+ constructor(configuration: HocuspocusProviderConfiguration);
75
+ onStatus({ status }: onStatusParameters): void;
76
+ setConfiguration(configuration?: Partial<HocuspocusProviderConfiguration>): void;
77
+ get document(): Y.Doc;
78
+ get awareness(): Awareness;
79
+ get hasUnsyncedChanges(): boolean;
80
+ updateUnsyncedChanges(unsyncedChanges?: number): void;
81
+ forceSync(): void;
82
+ boundBeforeUnload: () => void;
83
+ beforeUnload(): void;
84
+ registerEventListeners(): void;
85
+ sendStateless(payload: string): void;
86
+ documentUpdateHandler(update: Uint8Array, origin: any): void;
87
+ awarenessUpdateHandler({ added, updated, removed }: any, origin: any): void;
88
+ get synced(): boolean;
89
+ set synced(state: boolean);
90
+ receiveStateless(payload: string): void;
91
+ get isAuthenticationRequired(): boolean;
92
+ connect(): Promise<unknown>;
93
+ disconnect(): void;
94
+ onOpen(event: Event): Promise<void>;
95
+ getToken(): Promise<string | null>;
96
+ startSync(): void;
97
+ send(message: ConstructableOutgoingMessage, args: any, broadcast?: boolean): void;
98
+ onMessage(event: MessageEvent): void;
99
+ onClose(event: CloseEvent): void;
100
+ destroy(): void;
101
+ permissionDeniedHandler(reason: string): void;
102
+ authenticatedHandler(scope: string): void;
103
+ get broadcastChannel(): string;
104
+ boundBroadcastChannelSubscriber: (data: ArrayBuffer) => void;
105
+ broadcastChannelSubscriber(data: ArrayBuffer): void;
106
+ subscribeToBroadcastChannel(): void;
107
+ disconnectBroadcastChannel(): void;
108
+ broadcast(Message: ConstructableOutgoingMessage, args?: any): void;
109
+ setAwarenessField(key: string, value: any): void;
110
+ }
@@ -1,115 +1,115 @@
1
- import * as mutex from 'lib0/mutex';
2
- import type { MessageEvent } from 'ws';
3
- import { Event } from 'ws';
4
- import EventEmitter from './EventEmitter';
5
- import { onCloseParameters, onDisconnectParameters, onMessageParameters, onOpenParameters, onOutgoingMessageParameters, onStatusParameters, WebSocketStatus } from './types';
6
- import { HocuspocusProvider, onAwarenessChangeParameters, onAwarenessUpdateParameters } from '.';
7
- export type HocuspocusProviderWebsocketConfiguration = Required<Pick<CompleteHocuspocusProviderWebsocketConfiguration, 'url'>> & Partial<CompleteHocuspocusProviderWebsocketConfiguration>;
8
- export interface CompleteHocuspocusProviderWebsocketConfiguration {
9
- /**
10
- * URL of your @hocuspocus/server instance
11
- */
12
- url: string;
13
- /**
14
- * Pass `false` to start the connection manually.
15
- */
16
- connect: boolean;
17
- /**
18
- * URL parameters that should be added.
19
- */
20
- parameters: {
21
- [key: string]: any;
22
- };
23
- /**
24
- * An optional WebSocket polyfill, for example for Node.js
25
- */
26
- WebSocketPolyfill: any;
27
- /**
28
- * Disconnect when no message is received for the defined amount of milliseconds.
29
- */
30
- messageReconnectTimeout: number;
31
- /**
32
- * The delay between each attempt in milliseconds. You can provide a factor to have the delay grow exponentially.
33
- */
34
- delay: number;
35
- /**
36
- * The intialDelay is the amount of time to wait before making the first attempt. This option should typically be 0 since you typically want the first attempt to happen immediately.
37
- */
38
- initialDelay: number;
39
- /**
40
- * The factor option is used to grow the delay exponentially.
41
- */
42
- factor: number;
43
- /**
44
- * The maximum number of attempts or 0 if there is no limit on number of attempts.
45
- */
46
- maxAttempts: number;
47
- /**
48
- * minDelay is used to set a lower bound of delay when jitter is enabled. This property has no effect if jitter is disabled.
49
- */
50
- minDelay: number;
51
- /**
52
- * The maxDelay option is used to set an upper bound for the delay when factor is enabled. A value of 0 can be provided if there should be no upper bound when calculating delay.
53
- */
54
- maxDelay: number;
55
- /**
56
- * If jitter is true then the calculated delay will be a random integer value between minDelay and the calculated delay for the current iteration.
57
- */
58
- jitter: boolean;
59
- /**
60
- * A timeout in milliseconds. If timeout is non-zero then a timer is set using setTimeout. If the timeout is triggered then future attempts will be aborted.
61
- */
62
- timeout: number;
63
- onOpen: (data: onOpenParameters) => void;
64
- onConnect: () => void;
65
- onMessage: (data: onMessageParameters) => void;
66
- onOutgoingMessage: (data: onOutgoingMessageParameters) => void;
67
- onStatus: (data: onStatusParameters) => void;
68
- onDisconnect: (data: onDisconnectParameters) => void;
69
- onClose: (data: onCloseParameters) => void;
70
- onDestroy: () => void;
71
- onAwarenessUpdate: (data: onAwarenessUpdateParameters) => void;
72
- onAwarenessChange: (data: onAwarenessChangeParameters) => void;
73
- /**
74
- * Don’t output any warnings.
75
- */
76
- quiet: boolean;
77
- }
78
- export declare class HocuspocusProviderWebsocket extends EventEmitter {
79
- configuration: CompleteHocuspocusProviderWebsocketConfiguration;
80
- subscribedToBroadcastChannel: boolean;
81
- webSocket: WebSocket | null;
82
- shouldConnect: boolean;
83
- status: WebSocketStatus;
84
- lastMessageReceived: number;
85
- mux: mutex.mutex;
86
- intervals: any;
87
- connectionAttempt: {
88
- resolve: (value?: any) => void;
89
- reject: (reason?: any) => void;
90
- } | null;
91
- constructor(configuration: HocuspocusProviderWebsocketConfiguration);
92
- receivedOnOpenPayload?: Event | undefined;
93
- receivedOnStatusPayload?: onStatusParameters | undefined;
94
- onOpen(event: Event): Promise<void>;
95
- onStatus(data: onStatusParameters): Promise<void>;
96
- attach(provider: HocuspocusProvider): void;
97
- detach(provider: HocuspocusProvider): void;
98
- setConfiguration(configuration?: Partial<HocuspocusProviderWebsocketConfiguration>): void;
99
- boundConnect: () => Promise<unknown>;
100
- cancelWebsocketRetry?: () => void;
101
- connect(): Promise<unknown>;
102
- createWebSocketConnection(): Promise<unknown>;
103
- onMessage(event: MessageEvent): void;
104
- resolveConnectionAttempt(): void;
105
- stopConnectionAttempt(): void;
106
- rejectConnectionAttempt(): void;
107
- checkConnection(): void;
108
- registerEventListeners(): void;
109
- get serverUrl(): string;
110
- get url(): string;
111
- disconnect(): void;
112
- send(message: any): void;
113
- onClose({ event }: onCloseParameters): void;
114
- destroy(): void;
115
- }
1
+ import * as mutex from 'lib0/mutex';
2
+ import type { MessageEvent } from 'ws';
3
+ import { Event } from 'ws';
4
+ import EventEmitter from './EventEmitter.js';
5
+ import { onCloseParameters, onDisconnectParameters, onMessageParameters, onOpenParameters, onOutgoingMessageParameters, onStatusParameters, WebSocketStatus, onAwarenessChangeParameters, onAwarenessUpdateParameters } from './types.js';
6
+ import { HocuspocusProvider } from './HocuspocusProvider.js';
7
+ export type HocuspocusProviderWebsocketConfiguration = Required<Pick<CompleteHocuspocusProviderWebsocketConfiguration, 'url'>> & Partial<CompleteHocuspocusProviderWebsocketConfiguration>;
8
+ export interface CompleteHocuspocusProviderWebsocketConfiguration {
9
+ /**
10
+ * URL of your @hocuspocus/server instance
11
+ */
12
+ url: string;
13
+ /**
14
+ * Pass `false` to start the connection manually.
15
+ */
16
+ connect: boolean;
17
+ /**
18
+ * URL parameters that should be added.
19
+ */
20
+ parameters: {
21
+ [key: string]: any;
22
+ };
23
+ /**
24
+ * An optional WebSocket polyfill, for example for Node.js
25
+ */
26
+ WebSocketPolyfill: any;
27
+ /**
28
+ * Disconnect when no message is received for the defined amount of milliseconds.
29
+ */
30
+ messageReconnectTimeout: number;
31
+ /**
32
+ * The delay between each attempt in milliseconds. You can provide a factor to have the delay grow exponentially.
33
+ */
34
+ delay: number;
35
+ /**
36
+ * The intialDelay is the amount of time to wait before making the first attempt. This option should typically be 0 since you typically want the first attempt to happen immediately.
37
+ */
38
+ initialDelay: number;
39
+ /**
40
+ * The factor option is used to grow the delay exponentially.
41
+ */
42
+ factor: number;
43
+ /**
44
+ * The maximum number of attempts or 0 if there is no limit on number of attempts.
45
+ */
46
+ maxAttempts: number;
47
+ /**
48
+ * minDelay is used to set a lower bound of delay when jitter is enabled. This property has no effect if jitter is disabled.
49
+ */
50
+ minDelay: number;
51
+ /**
52
+ * The maxDelay option is used to set an upper bound for the delay when factor is enabled. A value of 0 can be provided if there should be no upper bound when calculating delay.
53
+ */
54
+ maxDelay: number;
55
+ /**
56
+ * If jitter is true then the calculated delay will be a random integer value between minDelay and the calculated delay for the current iteration.
57
+ */
58
+ jitter: boolean;
59
+ /**
60
+ * A timeout in milliseconds. If timeout is non-zero then a timer is set using setTimeout. If the timeout is triggered then future attempts will be aborted.
61
+ */
62
+ timeout: number;
63
+ onOpen: (data: onOpenParameters) => void;
64
+ onConnect: () => void;
65
+ onMessage: (data: onMessageParameters) => void;
66
+ onOutgoingMessage: (data: onOutgoingMessageParameters) => void;
67
+ onStatus: (data: onStatusParameters) => void;
68
+ onDisconnect: (data: onDisconnectParameters) => void;
69
+ onClose: (data: onCloseParameters) => void;
70
+ onDestroy: () => void;
71
+ onAwarenessUpdate: (data: onAwarenessUpdateParameters) => void;
72
+ onAwarenessChange: (data: onAwarenessChangeParameters) => void;
73
+ /**
74
+ * Don’t output any warnings.
75
+ */
76
+ quiet: boolean;
77
+ }
78
+ export declare class HocuspocusProviderWebsocket extends EventEmitter {
79
+ configuration: CompleteHocuspocusProviderWebsocketConfiguration;
80
+ subscribedToBroadcastChannel: boolean;
81
+ webSocket: WebSocket | null;
82
+ shouldConnect: boolean;
83
+ status: WebSocketStatus;
84
+ lastMessageReceived: number;
85
+ mux: mutex.mutex;
86
+ intervals: any;
87
+ connectionAttempt: {
88
+ resolve: (value?: any) => void;
89
+ reject: (reason?: any) => void;
90
+ } | null;
91
+ constructor(configuration: HocuspocusProviderWebsocketConfiguration);
92
+ receivedOnOpenPayload?: Event | undefined;
93
+ receivedOnStatusPayload?: onStatusParameters | undefined;
94
+ onOpen(event: Event): Promise<void>;
95
+ onStatus(data: onStatusParameters): Promise<void>;
96
+ attach(provider: HocuspocusProvider): void;
97
+ detach(provider: HocuspocusProvider): void;
98
+ setConfiguration(configuration?: Partial<HocuspocusProviderWebsocketConfiguration>): void;
99
+ boundConnect: () => Promise<unknown>;
100
+ cancelWebsocketRetry?: () => void;
101
+ connect(): Promise<unknown>;
102
+ createWebSocketConnection(): Promise<unknown>;
103
+ onMessage(event: MessageEvent): void;
104
+ resolveConnectionAttempt(): void;
105
+ stopConnectionAttempt(): void;
106
+ rejectConnectionAttempt(): void;
107
+ checkConnection(): void;
108
+ registerEventListeners(): void;
109
+ get serverUrl(): string;
110
+ get url(): string;
111
+ disconnect(): void;
112
+ send(message: any): void;
113
+ onClose({ event }: onCloseParameters): void;
114
+ destroy(): void;
115
+ }
@@ -1,16 +1,16 @@
1
- import { Decoder } from 'lib0/decoding';
2
- import { Encoder } from 'lib0/encoding';
3
- import { MessageType } from './types';
4
- export declare class IncomingMessage {
5
- data: any;
6
- encoder: Encoder;
7
- decoder: Decoder;
8
- constructor(data: any);
9
- readVarUint(): MessageType;
10
- readVarString(): string;
11
- readVarUint8Array(): Uint8Array;
12
- writeVarUint(type: MessageType): void;
13
- writeVarString(string: string): void;
14
- writeVarUint8Array(data: Uint8Array): void;
15
- length(): number;
16
- }
1
+ import { Decoder } from 'lib0/decoding';
2
+ import { Encoder } from 'lib0/encoding';
3
+ import { MessageType } from './types.js';
4
+ export declare class IncomingMessage {
5
+ data: any;
6
+ encoder: Encoder;
7
+ decoder: Decoder;
8
+ constructor(data: any);
9
+ readVarUint(): MessageType;
10
+ readVarString(): string;
11
+ readVarUint8Array(): Uint8Array;
12
+ writeVarUint(type: MessageType): void;
13
+ writeVarString(string: string): void;
14
+ writeVarUint8Array(data: Uint8Array): void;
15
+ length(): number;
16
+ }
@@ -1,13 +1,13 @@
1
- import { HocuspocusProvider } from './HocuspocusProvider';
2
- import { IncomingMessage } from './IncomingMessage';
3
- export declare class MessageReceiver {
4
- message: IncomingMessage;
5
- broadcasted: boolean;
6
- constructor(message: IncomingMessage);
7
- setBroadcasted(value: boolean): this;
8
- apply(provider: HocuspocusProvider, emitSynced?: boolean): void;
9
- private applySyncMessage;
10
- private applyAwarenessMessage;
11
- private applyAuthMessage;
12
- private applyQueryAwarenessMessage;
13
- }
1
+ import { HocuspocusProvider } from './HocuspocusProvider.js';
2
+ import { IncomingMessage } from './IncomingMessage.js';
3
+ export declare class MessageReceiver {
4
+ message: IncomingMessage;
5
+ broadcasted: boolean;
6
+ constructor(message: IncomingMessage);
7
+ setBroadcasted(value: boolean): this;
8
+ apply(provider: HocuspocusProvider, emitSynced?: boolean): void;
9
+ private applySyncMessage;
10
+ private applyAwarenessMessage;
11
+ private applyAuthMessage;
12
+ private applyQueryAwarenessMessage;
13
+ }
@@ -1,10 +1,10 @@
1
- import { Encoder } from 'lib0/encoding';
2
- import { ConstructableOutgoingMessage } from './types';
3
- export declare class MessageSender {
4
- encoder: Encoder;
5
- message: any;
6
- constructor(Message: ConstructableOutgoingMessage, args?: any);
7
- create(): Uint8Array;
8
- send(webSocket: any): void;
9
- broadcast(channel: string): void;
10
- }
1
+ import { Encoder } from 'lib0/encoding';
2
+ import { ConstructableOutgoingMessage } from './types.js';
3
+ export declare class MessageSender {
4
+ encoder: Encoder;
5
+ message: any;
6
+ constructor(Message: ConstructableOutgoingMessage, args?: any);
7
+ create(): Uint8Array;
8
+ send(webSocket: any): void;
9
+ broadcast(channel: string): void;
10
+ }
@@ -1,9 +1,9 @@
1
- import { Encoder } from 'lib0/encoding';
2
- import { MessageType, OutgoingMessageArguments, OutgoingMessageInterface } from './types';
3
- export declare class OutgoingMessage implements OutgoingMessageInterface {
4
- encoder: Encoder;
5
- type?: MessageType;
6
- constructor();
7
- get(args: Partial<OutgoingMessageArguments>): Encoder | undefined;
8
- toUint8Array(): Uint8Array;
9
- }
1
+ import { Encoder } from 'lib0/encoding';
2
+ import { MessageType, OutgoingMessageArguments, OutgoingMessageInterface } from './types.js';
3
+ export declare class OutgoingMessage implements OutgoingMessageInterface {
4
+ encoder: Encoder;
5
+ type?: MessageType;
6
+ constructor();
7
+ get(args: Partial<OutgoingMessageArguments>): Encoder | undefined;
8
+ toUint8Array(): Uint8Array;
9
+ }
@@ -1,7 +1,7 @@
1
- import { MessageType, OutgoingMessageArguments } from '../types';
2
- import { OutgoingMessage } from '../OutgoingMessage';
3
- export declare class AuthenticationMessage extends OutgoingMessage {
4
- type: MessageType;
5
- description: string;
6
- get(args: Partial<OutgoingMessageArguments>): import("lib0/encoding").Encoder;
7
- }
1
+ import { MessageType, OutgoingMessageArguments } from '../types.js';
2
+ import { OutgoingMessage } from '../OutgoingMessage.js';
3
+ export declare class AuthenticationMessage extends OutgoingMessage {
4
+ type: MessageType;
5
+ description: string;
6
+ get(args: Partial<OutgoingMessageArguments>): import("lib0/encoding").Encoder;
7
+ }
@@ -1,8 +1,8 @@
1
- import * as encoding from 'lib0/encoding';
2
- import { MessageType, OutgoingMessageArguments } from '../types';
3
- import { OutgoingMessage } from '../OutgoingMessage';
4
- export declare class AwarenessMessage extends OutgoingMessage {
5
- type: MessageType;
6
- description: string;
7
- get(args: Partial<OutgoingMessageArguments>): encoding.Encoder;
8
- }
1
+ import * as encoding from 'lib0/encoding';
2
+ import { MessageType, OutgoingMessageArguments } from '../types.js';
3
+ import { OutgoingMessage } from '../OutgoingMessage.js';
4
+ export declare class AwarenessMessage extends OutgoingMessage {
5
+ type: MessageType;
6
+ description: string;
7
+ get(args: Partial<OutgoingMessageArguments>): encoding.Encoder;
8
+ }
@@ -1,8 +1,8 @@
1
- import * as encoding from 'lib0/encoding';
2
- import { MessageType, OutgoingMessageArguments } from '../types';
3
- import { OutgoingMessage } from '../OutgoingMessage';
4
- export declare class CloseMessage extends OutgoingMessage {
5
- type: MessageType;
6
- description: string;
7
- get(args: Partial<OutgoingMessageArguments>): encoding.Encoder;
8
- }
1
+ import * as encoding from 'lib0/encoding';
2
+ import { MessageType, OutgoingMessageArguments } from '../types.js';
3
+ import { OutgoingMessage } from '../OutgoingMessage.js';
4
+ export declare class CloseMessage extends OutgoingMessage {
5
+ type: MessageType;
6
+ description: string;
7
+ get(args: Partial<OutgoingMessageArguments>): encoding.Encoder;
8
+ }
@@ -1,8 +1,8 @@
1
- import * as encoding from 'lib0/encoding';
2
- import { MessageType, OutgoingMessageArguments } from '../types';
3
- import { OutgoingMessage } from '../OutgoingMessage';
4
- export declare class QueryAwarenessMessage extends OutgoingMessage {
5
- type: MessageType;
6
- description: string;
7
- get(args: Partial<OutgoingMessageArguments>): encoding.Encoder;
8
- }
1
+ import * as encoding from 'lib0/encoding';
2
+ import { MessageType, OutgoingMessageArguments } from '../types.js';
3
+ import { OutgoingMessage } from '../OutgoingMessage.js';
4
+ export declare class QueryAwarenessMessage extends OutgoingMessage {
5
+ type: MessageType;
6
+ description: string;
7
+ get(args: Partial<OutgoingMessageArguments>): encoding.Encoder;
8
+ }
@@ -1,7 +1,7 @@
1
- import { MessageType, OutgoingMessageArguments } from '../types';
2
- import { OutgoingMessage } from '../OutgoingMessage';
3
- export declare class StatelessMessage extends OutgoingMessage {
4
- type: MessageType;
5
- description: string;
6
- get(args: Partial<OutgoingMessageArguments>): import("lib0/encoding").Encoder;
7
- }
1
+ import { MessageType, OutgoingMessageArguments } from '../types.js';
2
+ import { OutgoingMessage } from '../OutgoingMessage.js';
3
+ export declare class StatelessMessage extends OutgoingMessage {
4
+ type: MessageType;
5
+ description: string;
6
+ get(args: Partial<OutgoingMessageArguments>): import("lib0/encoding").Encoder;
7
+ }