@atlaskit/collab-provider 9.17.0 → 9.17.2
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/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,17 @@
|
|
|
1
1
|
# @atlaskit/collab-provider
|
|
2
2
|
|
|
3
|
+
## 9.17.2
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- [#56790](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/56790) [`ff577a7969d4`](https://bitbucket.org/atlassian/atlassian-frontend/commits/ff577a7969d4) - ED-21266: Updated @atlaskit/adf-schema to 34.0.1
|
|
8
|
+
|
|
9
|
+
## 9.17.1
|
|
10
|
+
|
|
11
|
+
### Patch Changes
|
|
12
|
+
|
|
13
|
+
- [#56635](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/56635) [`92410fab43c6`](https://bitbucket.org/atlassian/atlassian-frontend/commits/92410fab43c6) - Update comment linking to data portal
|
|
14
|
+
|
|
3
15
|
## 9.17.0
|
|
4
16
|
|
|
5
17
|
### Minor Changes
|
|
@@ -5,7 +5,7 @@ Object.defineProperty(exports, "__esModule", {
|
|
|
5
5
|
});
|
|
6
6
|
exports.version = exports.nextMajorVersion = exports.name = void 0;
|
|
7
7
|
var name = exports.name = "@atlaskit/collab-provider";
|
|
8
|
-
var version = exports.version = "9.17.
|
|
8
|
+
var version = exports.version = "9.17.2";
|
|
9
9
|
var nextMajorVersion = exports.nextMajorVersion = function nextMajorVersion() {
|
|
10
10
|
return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
|
|
11
11
|
};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@atlaskit/collab-provider",
|
|
3
|
-
"version": "9.17.
|
|
3
|
+
"version": "9.17.2",
|
|
4
4
|
"description": "A provider for collaborative editing.",
|
|
5
5
|
"publishConfig": {
|
|
6
6
|
"registry": "https://registry.npmjs.org/"
|
|
@@ -62,7 +62,7 @@
|
|
|
62
62
|
}
|
|
63
63
|
},
|
|
64
64
|
"devDependencies": {
|
|
65
|
-
"@atlaskit/adf-schema": "^34.0.
|
|
65
|
+
"@atlaskit/adf-schema": "^34.0.1",
|
|
66
66
|
"@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
|
|
67
67
|
"typescript": "~4.9.5"
|
|
68
68
|
},
|
package/tmp/api-report-tmp.d.ts
DELETED
|
@@ -1,261 +0,0 @@
|
|
|
1
|
-
## API Report File for "@atlaskit/collab-provider"
|
|
2
|
-
|
|
3
|
-
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
|
4
|
-
|
|
5
|
-
```ts
|
|
6
|
-
|
|
7
|
-
import type { AnalyticsWebClient } from '@atlaskit/analytics-listeners';
|
|
8
|
-
import { CollabConnectedPayload } from '@atlaskit/editor-common/collab';
|
|
9
|
-
import { CollabDataPayload } from '@atlaskit/editor-common/collab';
|
|
10
|
-
import { CollabDisconnectedPayload } from '@atlaskit/editor-common/collab';
|
|
11
|
-
import { CollabEditProvider } from '@atlaskit/editor-common/collab';
|
|
12
|
-
import { CollabEventConnectingData } from '@atlaskit/editor-common/collab';
|
|
13
|
-
import { CollabEventConnectionData } from '@atlaskit/editor-common/collab';
|
|
14
|
-
import { CollabEventInitData } from '@atlaskit/editor-common/collab';
|
|
15
|
-
import { CollabEventLocalStepData } from '@atlaskit/editor-common/collab';
|
|
16
|
-
import { CollabEventPresenceData } from '@atlaskit/editor-common/collab';
|
|
17
|
-
import { CollabEventRemoteData } from '@atlaskit/editor-common/collab';
|
|
18
|
-
import { CollabEvents } from '@atlaskit/editor-common/collab';
|
|
19
|
-
import { CollabEventTelepointerData } from '@atlaskit/editor-common/collab';
|
|
20
|
-
import { CollabInitPayload } from '@atlaskit/editor-common/collab';
|
|
21
|
-
import { CollabLocalStepsPayload } from '@atlaskit/editor-common/collab';
|
|
22
|
-
import { CollabMetadataPayload } from '@atlaskit/editor-common/collab';
|
|
23
|
-
import { CollabParticipant } from '@atlaskit/editor-common/collab';
|
|
24
|
-
import { CollabPresencePayload } from '@atlaskit/editor-common/collab';
|
|
25
|
-
import { CollabSendableSelection } from '@atlaskit/editor-common/collab';
|
|
26
|
-
import { CollabTelepointerPayload } from '@atlaskit/editor-common/collab';
|
|
27
|
-
import type { EditorState } from '@atlaskit/editor-prosemirror/state';
|
|
28
|
-
import type { JSONDocNode } from '@atlaskit/editor-json-transformer';
|
|
29
|
-
import type { Manager } from 'socket.io-client';
|
|
30
|
-
import type { Metadata as Metadata_2 } from '@atlaskit/editor-common/collab';
|
|
31
|
-
import { NewCollabSyncUpErrorAttributes } from '@atlaskit/editor-common/collab';
|
|
32
|
-
import { PROVIDER_ERROR_CODE } from '@atlaskit/editor-common/collab';
|
|
33
|
-
import { ProviderError } from '@atlaskit/editor-common/collab';
|
|
34
|
-
import { ProviderParticipant } from '@atlaskit/editor-common/collab';
|
|
35
|
-
import { ResolvedEditorState } from '@atlaskit/editor-common/collab';
|
|
36
|
-
import type { Step } from '@atlaskit/editor-prosemirror/transform';
|
|
37
|
-
import { SyncUpErrorFunction } from '@atlaskit/editor-common/collab';
|
|
38
|
-
import type { Transaction } from '@atlaskit/editor-prosemirror/state';
|
|
39
|
-
|
|
40
|
-
// @public (undocumented)
|
|
41
|
-
type AuthCallback = (cb: (data: InitAndAuthData) => void) => void;
|
|
42
|
-
|
|
43
|
-
// @public (undocumented)
|
|
44
|
-
type BaseEvents = Pick<CollabEditProvider<CollabEvents>, 'send' | 'sendMessage' | 'setup'>;
|
|
45
|
-
|
|
46
|
-
export { CollabConnectedPayload }
|
|
47
|
-
|
|
48
|
-
export { CollabDataPayload }
|
|
49
|
-
|
|
50
|
-
export { CollabDisconnectedPayload }
|
|
51
|
-
|
|
52
|
-
export { CollabEditProvider }
|
|
53
|
-
|
|
54
|
-
export { CollabEventConnectingData }
|
|
55
|
-
|
|
56
|
-
export { CollabEventConnectionData }
|
|
57
|
-
|
|
58
|
-
// @public (undocumented)
|
|
59
|
-
export interface CollabEventDisconnectedData {
|
|
60
|
-
// (undocumented)
|
|
61
|
-
reason: 'CLIENT_DISCONNECT' | 'SERVER_DISCONNECT' | 'SOCKET_CLOSED' | 'SOCKET_ERROR' | 'SOCKET_TIMEOUT' | 'UNKNOWN_DISCONNECT';
|
|
62
|
-
// (undocumented)
|
|
63
|
-
sid: string;
|
|
64
|
-
}
|
|
65
|
-
|
|
66
|
-
export { CollabEventInitData }
|
|
67
|
-
|
|
68
|
-
export { CollabEventLocalStepData }
|
|
69
|
-
|
|
70
|
-
export { CollabEventPresenceData }
|
|
71
|
-
|
|
72
|
-
export { CollabEventRemoteData }
|
|
73
|
-
|
|
74
|
-
export { CollabEvents }
|
|
75
|
-
|
|
76
|
-
export { CollabEventTelepointerData }
|
|
77
|
-
|
|
78
|
-
export { CollabInitPayload }
|
|
79
|
-
|
|
80
|
-
export { CollabLocalStepsPayload }
|
|
81
|
-
|
|
82
|
-
export { CollabMetadataPayload }
|
|
83
|
-
|
|
84
|
-
export { CollabParticipant }
|
|
85
|
-
|
|
86
|
-
export { CollabPresencePayload }
|
|
87
|
-
|
|
88
|
-
export { CollabSendableSelection }
|
|
89
|
-
|
|
90
|
-
export { CollabTelepointerPayload }
|
|
91
|
-
|
|
92
|
-
// @public (undocumented)
|
|
93
|
-
interface Config {
|
|
94
|
-
analyticsClient?: AnalyticsWebClient;
|
|
95
|
-
// (undocumented)
|
|
96
|
-
cacheToken?: boolean;
|
|
97
|
-
// (undocumented)
|
|
98
|
-
createSocket: (path: string, auth?: AuthCallback | InitAndAuthData, productInfo?: ProductInformation) => Socket;
|
|
99
|
-
// (undocumented)
|
|
100
|
-
documentAri: string;
|
|
101
|
-
enableErrorOnFailedDocumentApply?: boolean;
|
|
102
|
-
failedStepLimitBeforeCatchupOnPublish?: number;
|
|
103
|
-
// (undocumented)
|
|
104
|
-
featureFlags?: {
|
|
105
|
-
[key: string]: boolean;
|
|
106
|
-
};
|
|
107
|
-
// (undocumented)
|
|
108
|
-
getAnalyticsWebClient?: Promise<AnalyticsWebClient>;
|
|
109
|
-
// (undocumented)
|
|
110
|
-
getUser?: GetUserType;
|
|
111
|
-
// (undocumented)
|
|
112
|
-
initialDraft?: InitialDraft;
|
|
113
|
-
// (undocumented)
|
|
114
|
-
isBufferingEnabled?: boolean;
|
|
115
|
-
// (undocumented)
|
|
116
|
-
lifecycle?: Lifecycle;
|
|
117
|
-
// (undocumented)
|
|
118
|
-
need404?: boolean;
|
|
119
|
-
permissionTokenRefresh?: () => Promise<null | string>;
|
|
120
|
-
// (undocumented)
|
|
121
|
-
productInfo?: ProductInformation;
|
|
122
|
-
rateLimitMaxStepSize?: number;
|
|
123
|
-
// (undocumented)
|
|
124
|
-
rateLimitStepCount?: number;
|
|
125
|
-
// (undocumented)
|
|
126
|
-
rateLimitTotalStepSize?: number;
|
|
127
|
-
// (undocumented)
|
|
128
|
-
rateLimitType?: number;
|
|
129
|
-
// (undocumented)
|
|
130
|
-
storage?: Storage_2;
|
|
131
|
-
throwOnNotConnected?: boolean;
|
|
132
|
-
// (undocumented)
|
|
133
|
-
url: string;
|
|
134
|
-
}
|
|
135
|
-
|
|
136
|
-
// @public (undocumented)
|
|
137
|
-
class Emitter<T = any> {
|
|
138
|
-
protected emit<K extends keyof T>(evt: K, data: T[K]): this;
|
|
139
|
-
off<K extends keyof T>(evt: K, handler: (args: T[K]) => void): this;
|
|
140
|
-
on<K extends keyof T>(evt: K, handler: (args: T[K]) => void): this;
|
|
141
|
-
unsubscribeAll<K extends keyof T>(evt?: K): this;
|
|
142
|
-
}
|
|
143
|
-
|
|
144
|
-
// @public (undocumented)
|
|
145
|
-
type EventHandler = () => void;
|
|
146
|
-
|
|
147
|
-
// @public (undocumented)
|
|
148
|
-
type GetUserType = ((userId: string) => Promise<Pick<ProviderParticipant, 'avatar' | 'email' | 'name' | 'userId'>>) | undefined;
|
|
149
|
-
|
|
150
|
-
// @public (undocumented)
|
|
151
|
-
interface InitAndAuthData {
|
|
152
|
-
// (undocumented)
|
|
153
|
-
initialized: boolean;
|
|
154
|
-
// (undocumented)
|
|
155
|
-
need404?: boolean;
|
|
156
|
-
// (undocumented)
|
|
157
|
-
token?: string;
|
|
158
|
-
}
|
|
159
|
-
|
|
160
|
-
// @public (undocumented)
|
|
161
|
-
interface InitialDraft {
|
|
162
|
-
// (undocumented)
|
|
163
|
-
document: JSONDocNode;
|
|
164
|
-
// (undocumented)
|
|
165
|
-
metadata?: Metadata_2;
|
|
166
|
-
// (undocumented)
|
|
167
|
-
timestamp?: number;
|
|
168
|
-
// (undocumented)
|
|
169
|
-
version: number;
|
|
170
|
-
}
|
|
171
|
-
|
|
172
|
-
// @public (undocumented)
|
|
173
|
-
interface Lifecycle {
|
|
174
|
-
// (undocumented)
|
|
175
|
-
on(event: LifecycleEvents, handler: EventHandler): void;
|
|
176
|
-
}
|
|
177
|
-
|
|
178
|
-
// @public (undocumented)
|
|
179
|
-
type LifecycleEvents = 'restore' | 'save';
|
|
180
|
-
|
|
181
|
-
export { NewCollabSyncUpErrorAttributes }
|
|
182
|
-
|
|
183
|
-
// @public (undocumented)
|
|
184
|
-
type ProductInformation = {
|
|
185
|
-
product: string;
|
|
186
|
-
subProduct?: string;
|
|
187
|
-
};
|
|
188
|
-
|
|
189
|
-
// @public (undocumented)
|
|
190
|
-
export class Provider extends Emitter<CollabEvents> implements BaseEvents {
|
|
191
|
-
constructor(config: Config);
|
|
192
|
-
destroy(): this;
|
|
193
|
-
// @deprecated
|
|
194
|
-
disconnect(): this;
|
|
195
|
-
getCurrentState: () => Promise<ResolvedEditorState>;
|
|
196
|
-
getFinalAcknowledgedState: () => Promise<ResolvedEditorState>;
|
|
197
|
-
getMetadata: () => Metadata_2;
|
|
198
|
-
// (undocumented)
|
|
199
|
-
getParticipants: () => ProviderParticipant[];
|
|
200
|
-
// (undocumented)
|
|
201
|
-
getUnconfirmedSteps: () => readonly Step[] | undefined;
|
|
202
|
-
// @deprecated
|
|
203
|
-
initialize(getState: () => EditorState): this;
|
|
204
|
-
send(_tr: Transaction | null, _oldState: EditorState | null, newState: EditorState): void;
|
|
205
|
-
sendMessage(data: CollabTelepointerPayload): void;
|
|
206
|
-
// @deprecated
|
|
207
|
-
setEditorWidth(editorWidth: string, broadcast?: boolean): void;
|
|
208
|
-
setMetadata(metadata: Metadata_2): void;
|
|
209
|
-
// @deprecated
|
|
210
|
-
setTitle(title: string, broadcast?: boolean): void;
|
|
211
|
-
setup({ getState, onSyncUpError, }: {
|
|
212
|
-
getState: () => EditorState;
|
|
213
|
-
onSyncUpError?: SyncUpErrorFunction;
|
|
214
|
-
}): this;
|
|
215
|
-
// @deprecated
|
|
216
|
-
unsubscribeAll(): this;
|
|
217
|
-
}
|
|
218
|
-
|
|
219
|
-
export { PROVIDER_ERROR_CODE }
|
|
220
|
-
|
|
221
|
-
export { ProviderError }
|
|
222
|
-
|
|
223
|
-
export { ProviderParticipant }
|
|
224
|
-
|
|
225
|
-
export { ResolvedEditorState }
|
|
226
|
-
|
|
227
|
-
// @public (undocumented)
|
|
228
|
-
interface SimpleEventEmitter {
|
|
229
|
-
// (undocumented)
|
|
230
|
-
on(event: string, fn: Function): SimpleEventEmitter;
|
|
231
|
-
}
|
|
232
|
-
|
|
233
|
-
// @public (undocumented)
|
|
234
|
-
export interface Socket extends SimpleEventEmitter {
|
|
235
|
-
// (undocumented)
|
|
236
|
-
close(): Socket;
|
|
237
|
-
// (undocumented)
|
|
238
|
-
connect(): Socket;
|
|
239
|
-
// (undocumented)
|
|
240
|
-
emit(event: string, ...args: any[]): Socket;
|
|
241
|
-
// (undocumented)
|
|
242
|
-
id: string;
|
|
243
|
-
// (undocumented)
|
|
244
|
-
io?: Manager;
|
|
245
|
-
}
|
|
246
|
-
|
|
247
|
-
// @public (undocumented)
|
|
248
|
-
interface Storage_2 {
|
|
249
|
-
// (undocumented)
|
|
250
|
-
delete(key: string): Promise<void>;
|
|
251
|
-
// (undocumented)
|
|
252
|
-
get(key: string): Promise<string>;
|
|
253
|
-
// (undocumented)
|
|
254
|
-
set(key: string, value: string): Promise<void>;
|
|
255
|
-
}
|
|
256
|
-
|
|
257
|
-
export { SyncUpErrorFunction }
|
|
258
|
-
|
|
259
|
-
// (No @packageDocumentation comment for this package)
|
|
260
|
-
|
|
261
|
-
```
|