@hocuspocus/provider 2.12.1-rc.0 → 2.12.2-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.
- package/dist/hocuspocus-provider.cjs +4 -0
- package/dist/hocuspocus-provider.cjs.map +1 -1
- package/dist/hocuspocus-provider.esm.js +4 -0
- package/dist/hocuspocus-provider.esm.js.map +1 -1
- package/dist/packages/provider/src/TiptapCollabProvider.d.ts +4 -1
- package/package.json +2 -2
- package/src/TiptapCollabProvider.ts +11 -1
|
@@ -1,8 +1,9 @@
|
|
|
1
1
|
import type { AbstractType, YArrayEvent } from 'yjs';
|
|
2
|
+
import * as Y from 'yjs';
|
|
2
3
|
import { HocuspocusProvider, HocuspocusProviderConfiguration } from './HocuspocusProvider.js';
|
|
3
4
|
import { TiptapCollabProviderWebsocket } from './TiptapCollabProviderWebsocket.js';
|
|
4
5
|
import type { TCollabComment, TCollabThread, THistoryVersion } from './types.js';
|
|
5
|
-
export type TiptapCollabProviderConfiguration = Required<Pick<HocuspocusProviderConfiguration, 'name'>> & Partial<HocuspocusProviderConfiguration> & (Required<Pick<AdditionalTiptapCollabProviderConfiguration, 'websocketProvider'>> | Required<Pick<AdditionalTiptapCollabProviderConfiguration, 'appId'>> | Required<Pick<AdditionalTiptapCollabProviderConfiguration, 'baseUrl'>>)
|
|
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'>;
|
|
6
7
|
export interface AdditionalTiptapCollabProviderConfiguration {
|
|
7
8
|
/**
|
|
8
9
|
* A Hocuspocus Cloud App ID, get one here: https://cloud.tiptap.dev
|
|
@@ -13,9 +14,11 @@ export interface AdditionalTiptapCollabProviderConfiguration {
|
|
|
13
14
|
*/
|
|
14
15
|
baseUrl?: string;
|
|
15
16
|
websocketProvider?: TiptapCollabProviderWebsocket;
|
|
17
|
+
user?: string;
|
|
16
18
|
}
|
|
17
19
|
export declare class TiptapCollabProvider extends HocuspocusProvider {
|
|
18
20
|
tiptapCollabConfigurationPrefix: string;
|
|
21
|
+
userData?: Y.PermanentUserData;
|
|
19
22
|
constructor(configuration: TiptapCollabProviderConfiguration);
|
|
20
23
|
/**
|
|
21
24
|
* note: this will only work if your server loaded @hocuspocus-pro/extension-history, or if you are on a Tiptap business plan.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@hocuspocus/provider",
|
|
3
|
-
"version": "2.12.
|
|
3
|
+
"version": "2.12.2-rc.0",
|
|
4
4
|
"description": "hocuspocus provider",
|
|
5
5
|
"homepage": "https://hocuspocus.dev",
|
|
6
6
|
"keywords": [
|
|
@@ -29,7 +29,7 @@
|
|
|
29
29
|
"dist"
|
|
30
30
|
],
|
|
31
31
|
"dependencies": {
|
|
32
|
-
"@hocuspocus/common": "^2.12.
|
|
32
|
+
"@hocuspocus/common": "^2.12.2-rc.0",
|
|
33
33
|
"@lifeomic/attempt": "^3.0.2",
|
|
34
34
|
"lib0": "^0.2.87",
|
|
35
35
|
"ws": "^8.14.2"
|
|
@@ -16,7 +16,8 @@ export type TiptapCollabProviderConfiguration =
|
|
|
16
16
|
Partial<HocuspocusProviderConfiguration> &
|
|
17
17
|
(Required<Pick<AdditionalTiptapCollabProviderConfiguration, 'websocketProvider'>> |
|
|
18
18
|
Required<Pick<AdditionalTiptapCollabProviderConfiguration, 'appId'>>|
|
|
19
|
-
Required<Pick<AdditionalTiptapCollabProviderConfiguration, 'baseUrl'>>)
|
|
19
|
+
Required<Pick<AdditionalTiptapCollabProviderConfiguration, 'baseUrl'>>) &
|
|
20
|
+
Pick<AdditionalTiptapCollabProviderConfiguration, 'user'>
|
|
20
21
|
|
|
21
22
|
export interface AdditionalTiptapCollabProviderConfiguration {
|
|
22
23
|
/**
|
|
@@ -30,11 +31,15 @@ export interface AdditionalTiptapCollabProviderConfiguration {
|
|
|
30
31
|
baseUrl?: string
|
|
31
32
|
|
|
32
33
|
websocketProvider?: TiptapCollabProviderWebsocket
|
|
34
|
+
|
|
35
|
+
user?: string
|
|
33
36
|
}
|
|
34
37
|
|
|
35
38
|
export class TiptapCollabProvider extends HocuspocusProvider {
|
|
36
39
|
tiptapCollabConfigurationPrefix = '__tiptapcollab__'
|
|
37
40
|
|
|
41
|
+
userData?: Y.PermanentUserData
|
|
42
|
+
|
|
38
43
|
constructor(configuration: TiptapCollabProviderConfiguration) {
|
|
39
44
|
if (!configuration.websocketProvider) {
|
|
40
45
|
configuration.websocketProvider = new TiptapCollabProviderWebsocket({ appId: (configuration as Required<Pick<AdditionalTiptapCollabProviderConfiguration, 'appId'>>).appId, baseUrl: (configuration as Required<Pick<AdditionalTiptapCollabProviderConfiguration, 'baseUrl'>>).baseUrl })
|
|
@@ -45,6 +50,11 @@ export class TiptapCollabProvider extends HocuspocusProvider {
|
|
|
45
50
|
}
|
|
46
51
|
|
|
47
52
|
super(configuration as HocuspocusProviderConfiguration)
|
|
53
|
+
|
|
54
|
+
if (configuration.user) {
|
|
55
|
+
this.userData = new Y.PermanentUserData(this.document, this.document.getMap('__tiptapcollab__users'))
|
|
56
|
+
this.userData.setUserMapping(this.document, this.document.clientID, configuration.user)
|
|
57
|
+
}
|
|
48
58
|
}
|
|
49
59
|
|
|
50
60
|
/**
|