@hocuspocus/provider 1.0.0-alpha.29 → 1.0.0-alpha.30

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 (72) hide show
  1. package/dist/hocuspocus-provider.cjs.map +1 -1
  2. package/dist/hocuspocus-provider.esm.js.map +1 -1
  3. package/dist/packages/extension-database/src/Database.d.ts +5 -9
  4. package/dist/packages/extension-logger/src/Logger.d.ts +5 -0
  5. package/dist/packages/extension-sqlite/src/SQLite.d.ts +4 -4
  6. package/dist/packages/extension-webhook/src/index.d.ts +1 -2
  7. package/dist/packages/provider/src/EventEmitter.d.ts +1 -1
  8. package/dist/packages/provider/src/HocuspocusProvider.d.ts +7 -4
  9. package/dist/packages/provider/src/types.d.ts +10 -0
  10. package/dist/packages/server/src/Connection.d.ts +4 -4
  11. package/dist/packages/server/src/Debugger.d.ts +1 -2
  12. package/dist/packages/server/src/Document.d.ts +8 -5
  13. package/dist/packages/server/src/Hocuspocus.d.ts +23 -12
  14. package/dist/packages/server/src/MessageReceiver.d.ts +8 -5
  15. package/dist/packages/server/src/OutgoingMessage.d.ts +1 -0
  16. package/dist/packages/server/src/index.d.ts +7 -0
  17. package/dist/packages/server/src/types.d.ts +77 -15
  18. package/dist/tests/extension-logger/onListen.d.ts +1 -0
  19. package/dist/tests/extension-redis/onLoadDocument.d.ts +1 -0
  20. package/dist/tests/extension-redis/onSynced.d.ts +1 -0
  21. package/dist/tests/extension-redis-rewrite/closeConnections.d.ts +1 -0
  22. package/dist/tests/extension-redis-rewrite/getConnectionCount.d.ts +1 -0
  23. package/dist/tests/extension-redis-rewrite/getDocumentsCount.d.ts +1 -0
  24. package/dist/tests/extension-redis-rewrite/onAwarenessChange.d.ts +1 -0
  25. package/dist/tests/extension-redis-rewrite/onChange.d.ts +1 -0
  26. package/dist/tests/extension-redis-rewrite/onStoreDocument.d.ts +1 -0
  27. package/dist/tests/extension-rocksdb/onLoadDocument.d.ts +1 -0
  28. package/dist/tests/provider/configuration.d.ts +1 -0
  29. package/dist/tests/provider/onAuthenticated.d.ts +1 -0
  30. package/dist/tests/provider/onAuthenticationFailed.d.ts +1 -0
  31. package/dist/tests/provider/onAwarenessChange.d.ts +1 -0
  32. package/dist/tests/provider/onAwarenessUpdate.d.ts +1 -0
  33. package/dist/tests/provider/onClose.d.ts +1 -0
  34. package/dist/tests/provider/onConnect.d.ts +1 -0
  35. package/dist/tests/provider/onDisconnect.d.ts +1 -0
  36. package/dist/tests/provider/onMessage.d.ts +1 -0
  37. package/dist/tests/provider/onOpen.d.ts +1 -0
  38. package/dist/tests/provider/onSynced.d.ts +1 -0
  39. package/dist/tests/server/address.d.ts +1 -0
  40. package/dist/tests/server/afterStoreDocument.d.ts +1 -0
  41. package/dist/tests/server/closeConnections.d.ts +1 -0
  42. package/dist/tests/server/getConnectionsCount.d.ts +1 -0
  43. package/dist/tests/server/getDocumentName.d.ts +1 -0
  44. package/dist/tests/server/getDocumentsCount.d.ts +1 -0
  45. package/dist/tests/server/getMessageLogs.d.ts +1 -0
  46. package/dist/tests/server/listen.d.ts +1 -0
  47. package/dist/tests/server/onAuthenticate.d.ts +1 -0
  48. package/dist/tests/server/onAwarenessUpdate.d.ts +1 -0
  49. package/dist/tests/server/onChange.d.ts +1 -0
  50. package/dist/tests/server/onConfigure.d.ts +1 -0
  51. package/dist/tests/server/onConnect.d.ts +1 -0
  52. package/dist/tests/server/onDestroy.d.ts +1 -0
  53. package/dist/tests/server/onDisconnect.d.ts +1 -0
  54. package/dist/tests/server/onListen.d.ts +1 -0
  55. package/dist/tests/server/onLoadDocument.d.ts +1 -0
  56. package/dist/tests/server/onRequest.d.ts +1 -0
  57. package/dist/tests/server/onStoreDocument.d.ts +1 -0
  58. package/dist/tests/server/onUpgrade.d.ts +1 -0
  59. package/dist/tests/server/requiresAuthentication.d.ts +1 -0
  60. package/dist/tests/transformer/TiptapTransformer.d.ts +1 -0
  61. package/dist/tests/utils/createDirectory.d.ts +1 -0
  62. package/dist/tests/utils/flushRedis.d.ts +1 -0
  63. package/dist/tests/utils/index.d.ts +7 -0
  64. package/dist/tests/utils/newHocuspocus.d.ts +2 -0
  65. package/dist/tests/utils/newHocuspocusProvider.d.ts +3 -0
  66. package/dist/tests/utils/redisConnectionSettings.d.ts +4 -0
  67. package/dist/tests/utils/removeDirectory.d.ts +1 -0
  68. package/dist/tests/utils/sleep.d.ts +1 -0
  69. package/package.json +5 -5
  70. package/src/EventEmitter.ts +1 -1
  71. package/src/HocuspocusProvider.ts +6 -5
  72. package/src/types.ts +10 -0
@@ -0,0 +1,7 @@
1
+ export * from './createDirectory';
2
+ export * from './flushRedis';
3
+ export * from './newHocuspocus';
4
+ export * from './newHocuspocusProvider';
5
+ export * from './redisConnectionSettings';
6
+ export * from './removeDirectory';
7
+ export * from './sleep';
@@ -0,0 +1,2 @@
1
+ import { Hocuspocus, Configuration } from '@hocuspocus/server';
2
+ export declare const newHocuspocus: (options?: Partial<Configuration> | undefined) => Hocuspocus;
@@ -0,0 +1,3 @@
1
+ import { HocuspocusProvider, HocuspocusProviderConfiguration } from '@hocuspocus/provider';
2
+ import { Hocuspocus } from '@hocuspocus/server';
3
+ export declare const newHocuspocusProvider: (server: Hocuspocus, options?: Partial<Omit<HocuspocusProviderConfiguration, 'url'>>) => HocuspocusProvider;
@@ -0,0 +1,4 @@
1
+ export declare const redisConnectionSettings: {
2
+ host: string;
3
+ port: number;
4
+ };
@@ -0,0 +1 @@
1
+ export declare const removeDirectory: (dir: string) => void;
@@ -0,0 +1 @@
1
+ export declare const sleep: (time: number) => Promise<unknown>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@hocuspocus/provider",
3
- "version": "1.0.0-alpha.29",
3
+ "version": "1.0.0-alpha.30",
4
4
  "description": "hocuspocus provider",
5
5
  "homepage": "https://hocuspocus.dev",
6
6
  "keywords": [
@@ -28,11 +28,11 @@
28
28
  "dist"
29
29
  ],
30
30
  "dependencies": {
31
- "@hocuspocus/common": "^1.0.0-alpha.4",
32
- "@lifeomic/attempt": "^3.0.1",
31
+ "@hocuspocus/common": "^1.0.0-alpha.5",
32
+ "@lifeomic/attempt": "^3.0.2",
33
33
  "lib0": "^0.2.43",
34
34
  "y-protocols": "^1.0.5",
35
- "yjs": "^13.5.22"
35
+ "yjs": "^13.5.24"
36
36
  },
37
- "gitHead": "87b715d1d28c603702879f4413c17d2c4a38c51a"
37
+ "gitHead": "125d94dc3520bb5185293c9b316f66ddd9215992"
38
38
  }
@@ -36,7 +36,7 @@ export default class EventEmitter {
36
36
  return this
37
37
  }
38
38
 
39
- protected removeAllListeners(): void {
39
+ removeAllListeners(): void {
40
40
  this.callbacks = {}
41
41
  }
42
42
  }
@@ -4,7 +4,7 @@ import * as time from 'lib0/time'
4
4
  import { Awareness, removeAwarenessStates } from 'y-protocols/awareness'
5
5
  import * as mutex from 'lib0/mutex'
6
6
  import * as url from 'lib0/url'
7
- import { Event, CloseEvent, MessageEvent } from 'ws'
7
+ import type { Event, CloseEvent, MessageEvent } from 'ws'
8
8
  import { retry } from '@lifeomic/attempt'
9
9
  import { Forbidden, Unauthorized } from '@hocuspocus/common'
10
10
  import EventEmitter from './EventEmitter'
@@ -19,7 +19,8 @@ import { AwarenessMessage } from './OutgoingMessages/AwarenessMessage'
19
19
  import { UpdateMessage } from './OutgoingMessages/UpdateMessage'
20
20
  import { OutgoingMessage } from './OutgoingMessage'
21
21
  import awarenessStatesToArray from './utils/awarenessStatesToArray'
22
- import { ConstructableOutgoingMessage } from './types'
22
+ import { ConstructableOutgoingMessage, StatesArray } from './types'
23
+ import { onAwarenessChangeParameters, onAwarenessUpdateParameters } from '.'
23
24
 
24
25
  export enum WebSocketStatus {
25
26
  Connecting = 'connecting',
@@ -115,12 +116,12 @@ export interface CompleteHocuspocusProviderConfiguration {
115
116
  onMessage: (event: MessageEvent) => void,
116
117
  onOutgoingMessage: (message: OutgoingMessage) => void,
117
118
  onStatus: (status: any) => void,
118
- onSynced: () => void,
119
+ onSynced: ({ state }: { state: boolean }) => void,
119
120
  onDisconnect: (event: CloseEvent) => void,
120
121
  onClose: (event: CloseEvent) => void,
121
122
  onDestroy: () => void,
122
- onAwarenessUpdate: (states: any) => void,
123
- onAwarenessChange: (states: any) => void,
123
+ onAwarenessUpdate: ({ states }: onAwarenessUpdateParameters) => void,
124
+ onAwarenessChange: ({ states }: onAwarenessChangeParameters) => void,
124
125
  /**
125
126
  * Don’t output any warnings.
126
127
  */
package/src/types.ts CHANGED
@@ -41,3 +41,13 @@ export type ConstructableOutgoingMessage =
41
41
  Constructable<SyncStepOneMessage> |
42
42
  Constructable<SyncStepTwoMessage> |
43
43
  Constructable<UpdateMessage>
44
+
45
+ export type onAwarenessUpdateParameters = {
46
+ states: StatesArray
47
+ }
48
+
49
+ export type onAwarenessChangeParameters = {
50
+ states: StatesArray
51
+ }
52
+
53
+ export type StatesArray = { clientId: number, [key: string | number]: any }[]