@atlaskit/collab-provider 25.0.10 → 25.1.1

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,22 @@
1
1
  # @atlaskit/collab-provider
2
2
 
3
+ ## 25.1.1
4
+
5
+ ### Patch Changes
6
+
7
+ - Updated dependencies
8
+
9
+ ## 25.1.0
10
+
11
+ ### Minor Changes
12
+
13
+ - [`bd2c5b0112185`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/bd2c5b0112185) -
14
+ Remove stale API report artifacts from published Platform packages.
15
+
16
+ ### Patch Changes
17
+
18
+ - Updated dependencies
19
+
3
20
  ## 25.0.10
4
21
 
5
22
  ### Patch 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 = "25.0.9";
8
+ var version = exports.version = "25.1.0";
9
9
  var nextMajorVersion = exports.nextMajorVersion = function nextMajorVersion() {
10
10
  return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
11
11
  };
@@ -1,5 +1,5 @@
1
1
  export const name = "@atlaskit/collab-provider";
2
- export const version = "25.0.9";
2
+ export const version = "25.1.0";
3
3
  export const nextMajorVersion = () => {
4
4
  return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
5
5
  };
@@ -1,5 +1,5 @@
1
1
  export var name = "@atlaskit/collab-provider";
2
- export var version = "25.0.9";
2
+ export var version = "25.1.0";
3
3
  export var nextMajorVersion = function nextMajorVersion() {
4
4
  return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
5
5
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/collab-provider",
3
- "version": "25.0.10",
3
+ "version": "25.1.1",
4
4
  "description": "A provider for collaborative editing.",
5
5
  "publishConfig": {
6
6
  "registry": "https://registry.npmjs.org/"
@@ -18,21 +18,21 @@
18
18
  "team": "Editor: Collaboration"
19
19
  },
20
20
  "dependencies": {
21
- "@atlaskit/adf-utils": "^20.7.0",
22
- "@atlaskit/analytics-gas-types": "^6.1.0",
23
- "@atlaskit/analytics-listeners": "^11.2.0",
21
+ "@atlaskit/adf-utils": "^20.8.0",
22
+ "@atlaskit/analytics-gas-types": "^6.2.0",
23
+ "@atlaskit/analytics-listeners": "^11.3.0",
24
24
  "@atlaskit/anonymous-assets": "^2.8.0",
25
25
  "@atlaskit/atlassian-context": "^1.1.0",
26
- "@atlaskit/editor-json-transformer": "^9.7.0",
26
+ "@atlaskit/editor-json-transformer": "^9.8.0",
27
27
  "@atlaskit/editor-prosemirror": "^8.0.0",
28
28
  "@atlaskit/feature-gate-js-client": "^6.0.0",
29
29
  "@atlaskit/platform-feature-experiments": "^0.3.0",
30
- "@atlaskit/platform-feature-flags": "^2.1.0",
31
- "@atlaskit/prosemirror-collab": "^1.0.0",
30
+ "@atlaskit/platform-feature-flags": "^2.2.0",
31
+ "@atlaskit/prosemirror-collab": "^1.1.0",
32
32
  "@atlaskit/react-ufo": "^7.7.0",
33
- "@atlaskit/tmp-editor-statsig": "^168.0.0",
34
- "@atlaskit/ufo": "^1.0.0",
35
- "@atlaskit/util-service-support": "^7.2.0",
33
+ "@atlaskit/tmp-editor-statsig": "^169.0.0",
34
+ "@atlaskit/ufo": "^1.1.0",
35
+ "@atlaskit/util-service-support": "^7.3.0",
36
36
  "@babel/runtime": "^7.0.0",
37
37
  "bind-event-listener": "^3.0.0",
38
38
  "eventemitter2": "^4.1.0",
@@ -60,7 +60,7 @@
60
60
  "@atlaskit/editor-test-helpers": "workspace:^",
61
61
  "@atlassian/a11y-jest-testing": "^0.17.0",
62
62
  "@atlassian/experiment-test-utils": "^0.2.0",
63
- "@atlassian/feature-flags-test-utils": "^1.2.0"
63
+ "@atlassian/feature-flags-test-utils": "^1.3.0"
64
64
  },
65
65
  "platform-feature-flags": {
66
66
  "platform_move_presence_agents": {
@@ -78,6 +78,6 @@
78
78
  }
79
79
  },
80
80
  "peerDependencies": {
81
- "@atlaskit/editor-common": "^120.7.0"
81
+ "@atlaskit/editor-common": "^120.10.0"
82
82
  }
83
83
  }
package/report.api.md DELETED
@@ -1,299 +0,0 @@
1
- <!-- API Report Version: 2.3 -->
2
-
3
- ## API Report File for "@atlaskit/collab-provider"
4
-
5
- > Do not edit this file. This report is auto-generated using
6
- > [API Extractor](https://api-extractor.com/).
7
- > [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
8
-
9
- ### Table of contents
10
-
11
- - [Main Entry Types](#main-entry-types)
12
- - [Peer Dependencies](#peer-dependencies)
13
-
14
- ### Main Entry Types
15
-
16
- <!--SECTION START: Main Entry Types-->
17
-
18
- ```ts
19
- import type { AnalyticsWebClient } from '@atlaskit/analytics-listeners';
20
- import { CollabConnectedPayload } from '@atlaskit/editor-common/collab';
21
- import { CollabDataPayload } from '@atlaskit/editor-common/collab';
22
- import { CollabDisconnectedPayload } from '@atlaskit/editor-common/collab';
23
- import { CollabEditProvider } from '@atlaskit/editor-common/collab';
24
- import { CollabEventConnectingData } from '@atlaskit/editor-common/collab';
25
- import { CollabEventConnectionData } from '@atlaskit/editor-common/collab';
26
- import { CollabEventInitData } from '@atlaskit/editor-common/collab';
27
- import { CollabEventLocalStepData } from '@atlaskit/editor-common/collab';
28
- import { CollabEventPresenceData } from '@atlaskit/editor-common/collab';
29
- import { CollabEventRemoteData } from '@atlaskit/editor-common/collab';
30
- import { CollabEvents } from '@atlaskit/editor-common/collab';
31
- import { CollabEventTelepointerData } from '@atlaskit/editor-common/collab';
32
- import { CollabInitPayload } from '@atlaskit/editor-common/collab';
33
- import { CollabLocalStepsPayload } from '@atlaskit/editor-common/collab';
34
- import { CollabMetadataPayload } from '@atlaskit/editor-common/collab';
35
- import { CollabParticipant } from '@atlaskit/editor-common/collab';
36
- import { CollabPresencePayload } from '@atlaskit/editor-common/collab';
37
- import { CollabSendableSelection } from '@atlaskit/editor-common/collab';
38
- import { CollabTelepointerPayload } from '@atlaskit/editor-common/collab';
39
- import type { EditorState } from '@atlaskit/editor-prosemirror/state';
40
- import type { JSONDocNode } from '@atlaskit/editor-json-transformer';
41
- import type { Manager } from 'socket.io-client';
42
- import type { Metadata as Metadata_2 } from '@atlaskit/editor-common/collab';
43
- import { NewCollabSyncUpErrorAttributes } from '@atlaskit/editor-common/collab';
44
- import { PROVIDER_ERROR_CODE } from '@atlaskit/editor-common/collab';
45
- import { ProviderError } from '@atlaskit/editor-common/collab';
46
- import { ProviderParticipant } from '@atlaskit/editor-common/collab';
47
- import { ResolvedEditorState } from '@atlaskit/editor-common/collab';
48
- import type { Step } from '@atlaskit/editor-prosemirror/transform';
49
- import { SyncUpErrorFunction } from '@atlaskit/editor-common/collab';
50
- import type { Transaction } from '@atlaskit/editor-prosemirror/state';
51
-
52
- // @public (undocumented)
53
- type AuthCallback = (cb: (data: InitAndAuthData) => void) => void;
54
-
55
- // @public (undocumented)
56
- type BaseEvents = Pick<CollabEditProvider<CollabEvents>, 'send' | 'sendMessage' | 'setup'>;
57
-
58
- export { CollabConnectedPayload };
59
-
60
- export { CollabDataPayload };
61
-
62
- export { CollabDisconnectedPayload };
63
-
64
- export { CollabEditProvider };
65
-
66
- export { CollabEventConnectingData };
67
-
68
- export { CollabEventConnectionData };
69
-
70
- // @public (undocumented)
71
- export interface CollabEventDisconnectedData {
72
- // (undocumented)
73
- reason:
74
- | 'CLIENT_DISCONNECT'
75
- | 'SERVER_DISCONNECT'
76
- | 'SOCKET_CLOSED'
77
- | 'SOCKET_ERROR'
78
- | 'SOCKET_TIMEOUT'
79
- | 'UNKNOWN_DISCONNECT';
80
- // (undocumented)
81
- sid: string;
82
- }
83
-
84
- export { CollabEventInitData };
85
-
86
- export { CollabEventLocalStepData };
87
-
88
- export { CollabEventPresenceData };
89
-
90
- export { CollabEventRemoteData };
91
-
92
- export { CollabEvents };
93
-
94
- export { CollabEventTelepointerData };
95
-
96
- export { CollabInitPayload };
97
-
98
- export { CollabLocalStepsPayload };
99
-
100
- export { CollabMetadataPayload };
101
-
102
- export { CollabParticipant };
103
-
104
- export { CollabPresencePayload };
105
-
106
- export { CollabSendableSelection };
107
-
108
- export { CollabTelepointerPayload };
109
-
110
- // @public (undocumented)
111
- interface Config {
112
- analyticsClient?: AnalyticsWebClient;
113
- // (undocumented)
114
- cacheToken?: boolean;
115
- // (undocumented)
116
- createSocket: (
117
- path: string,
118
- auth?: AuthCallback | InitAndAuthData,
119
- productInfo?: ProductInformation,
120
- ) => Socket;
121
- // (undocumented)
122
- documentAri: string;
123
- enableErrorOnFailedDocumentApply?: boolean;
124
- failedStepLimitBeforeCatchupOnPublish?: number;
125
- // (undocumented)
126
- featureFlags?: {
127
- [key: string]: boolean;
128
- };
129
- // (undocumented)
130
- getAnalyticsWebClient?: Promise<AnalyticsWebClient>;
131
- // (undocumented)
132
- getUser?: GetUserType;
133
- // (undocumented)
134
- initialDraft?: InitialDraft;
135
- // (undocumented)
136
- isBufferingEnabled?: boolean;
137
- // (undocumented)
138
- lifecycle?: Lifecycle;
139
- // (undocumented)
140
- need404?: boolean;
141
- permissionTokenRefresh?: () => Promise<null | string>;
142
- // (undocumented)
143
- productInfo?: ProductInformation;
144
- rateLimitMaxStepSize?: number;
145
- // (undocumented)
146
- rateLimitStepCount?: number;
147
- // (undocumented)
148
- rateLimitTotalStepSize?: number;
149
- // (undocumented)
150
- rateLimitType?: number;
151
- // (undocumented)
152
- storage?: Storage_2;
153
- throwOnNotConnected?: boolean;
154
- // (undocumented)
155
- url: string;
156
- }
157
-
158
- // @public (undocumented)
159
- class Emitter<T = any> {
160
- protected emit<K extends keyof T>(evt: K, data: T[K]): this;
161
- off<K extends keyof T>(evt: K, handler: (args: T[K]) => void): this;
162
- on<K extends keyof T>(evt: K, handler: (args: T[K]) => void): this;
163
- unsubscribeAll<K extends keyof T>(evt?: K): this;
164
- }
165
-
166
- // @public (undocumented)
167
- type EventHandler = () => void;
168
-
169
- // @public (undocumented)
170
- type GetUserType =
171
- | ((userId: string) => Promise<Pick<ProviderParticipant, 'avatar' | 'email' | 'name' | 'userId'>>)
172
- | undefined;
173
-
174
- // @public (undocumented)
175
- interface InitAndAuthData {
176
- // (undocumented)
177
- initialized: boolean;
178
- // (undocumented)
179
- need404?: boolean;
180
- // (undocumented)
181
- token?: string;
182
- }
183
-
184
- // @public (undocumented)
185
- interface InitialDraft {
186
- // (undocumented)
187
- document: JSONDocNode;
188
- // (undocumented)
189
- metadata?: Metadata_2;
190
- // (undocumented)
191
- timestamp?: number;
192
- // (undocumented)
193
- version: number;
194
- }
195
-
196
- // @public (undocumented)
197
- interface Lifecycle {
198
- // (undocumented)
199
- on(event: LifecycleEvents, handler: EventHandler): void;
200
- }
201
-
202
- // @public (undocumented)
203
- type LifecycleEvents = 'restore' | 'save';
204
-
205
- export { NewCollabSyncUpErrorAttributes };
206
-
207
- // @public (undocumented)
208
- type ProductInformation = {
209
- product: string;
210
- subProduct?: string;
211
- };
212
-
213
- // @public (undocumented)
214
- export class Provider extends Emitter<CollabEvents> implements BaseEvents {
215
- constructor(config: Config);
216
- destroy(): this;
217
- // @deprecated
218
- disconnect(): this;
219
- getCurrentState: () => Promise<ResolvedEditorState>;
220
- getFinalAcknowledgedState: () => Promise<ResolvedEditorState>;
221
- getMetadata: () => Metadata_2;
222
- // (undocumented)
223
- getParticipants: () => ProviderParticipant[];
224
- // (undocumented)
225
- getUnconfirmedSteps: () => readonly Step[] | undefined;
226
- // @deprecated
227
- initialize(getState: () => EditorState): this;
228
- send(_tr: Transaction | null, _oldState: EditorState | null, newState: EditorState): void;
229
- sendMessage(data: CollabTelepointerPayload): void;
230
- // @deprecated
231
- setEditorWidth(editorWidth: string, broadcast?: boolean): void;
232
- setMetadata(metadata: Metadata_2): void;
233
- // @deprecated
234
- setTitle(title: string, broadcast?: boolean): void;
235
- setup({
236
- getState,
237
- onSyncUpError,
238
- }: {
239
- getState: () => EditorState;
240
- onSyncUpError?: SyncUpErrorFunction;
241
- }): this;
242
- // @deprecated
243
- unsubscribeAll(): this;
244
- }
245
-
246
- export { PROVIDER_ERROR_CODE };
247
-
248
- export { ProviderError };
249
-
250
- export { ProviderParticipant };
251
-
252
- export { ResolvedEditorState };
253
-
254
- // @public (undocumented)
255
- interface SimpleEventEmitter {
256
- // (undocumented)
257
- on(event: string, fn: Function): SimpleEventEmitter;
258
- }
259
-
260
- // @public (undocumented)
261
- export interface Socket extends SimpleEventEmitter {
262
- // (undocumented)
263
- close(): Socket;
264
- // (undocumented)
265
- connect(): Socket;
266
- // (undocumented)
267
- emit(event: string, ...args: any[]): Socket;
268
- // (undocumented)
269
- id: string;
270
- // (undocumented)
271
- io?: Manager;
272
- }
273
-
274
- // @public (undocumented)
275
- interface Storage_2 {
276
- // (undocumented)
277
- delete(key: string): Promise<void>;
278
- // (undocumented)
279
- get(key: string): Promise<string>;
280
- // (undocumented)
281
- set(key: string, value: string): Promise<void>;
282
- }
283
-
284
- export { SyncUpErrorFunction };
285
-
286
- // (No @packageDocumentation comment for this package)
287
- ```
288
-
289
- <!--SECTION END: Main Entry Types-->
290
-
291
- ### Peer Dependencies
292
-
293
- <!--SECTION START: Peer Dependencies-->
294
-
295
- ```json
296
- {}
297
- ```
298
-
299
- <!--SECTION END: Peer Dependencies-->