@ckeditor/ckeditor-cloud-services-collaboration 55.0.0 → 55.2.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/comments-v2/descriptors/connectdetailsdescriptor.d.ts +14 -0
- package/dist/comments-v2/messages/connectmessage.d.ts +4 -1
- package/dist/comments-v2/responses/connectresponse.d.ts +4 -1
- package/dist/index.d.ts +2 -0
- package/dist/revision-history/descriptors/connectdetailsdescriptor.d.ts +18 -0
- package/dist/revision-history/messages/revisionhistoryconnectmessage.d.ts +4 -1
- package/dist/revision-history/messages/revisionhistorygetlatestrevisionmessage.d.ts +18 -0
- package/dist/revision-history/responses/revisionhistoryconnectresponse.d.ts +15 -1
- package/dist/revision-history/responses/revisionhistorygetlatestrevisionresponse.d.ts +31 -0
- package/dist/revision-history/revisionhistoryservice.d.ts +9 -0
- package/dist/services.js +19 -19
- package/dist/track-changes/descriptors/connectdetailsdescriptor.d.ts +14 -0
- package/dist/track-changes/messages/connectmessage.d.ts +4 -1
- package/dist/track-changes/responses/connectresponse.d.ts +4 -1
- package/dist/users/descriptors/userdescriptor.d.ts +5 -0
- package/dist/users/responses/getmanyusersresponse.d.ts +2 -1
- package/dist/version.d.ts +1 -1
- package/package.json +1 -1
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/*
|
|
2
|
+
Copyright (c), CKSource Holding sp. z o.o. All rights reserved.
|
|
3
|
+
*/
|
|
4
|
+
import Descriptor, { type IDescriptorBody } from './../../descriptor';
|
|
5
|
+
export interface ITrackChangesConnectDetails {
|
|
6
|
+
/**
|
|
7
|
+
* Requests the authors of the suggestions.
|
|
8
|
+
*/
|
|
9
|
+
includeUsers?: boolean;
|
|
10
|
+
}
|
|
11
|
+
export default class ConnectDetailsDescriptor extends Descriptor {
|
|
12
|
+
static readonly DESCRIPTOR_NAME: string;
|
|
13
|
+
static readonly DESCRIPTOR: IDescriptorBody;
|
|
14
|
+
}
|
|
@@ -3,16 +3,19 @@
|
|
|
3
3
|
*/
|
|
4
4
|
import Message, { type IMessage } from './../../message';
|
|
5
5
|
import type { IDescriptorBody } from '../../descriptor';
|
|
6
|
+
import type { ITrackChangesConnectDetails } from '../descriptors/connectdetailsdescriptor';
|
|
6
7
|
export interface IConnectMessage extends IMessage {
|
|
7
8
|
documentId: string;
|
|
9
|
+
details?: ITrackChangesConnectDetails;
|
|
8
10
|
}
|
|
9
11
|
export default class ConnectMessage extends Message {
|
|
10
12
|
readonly documentId: string;
|
|
13
|
+
readonly details?: ITrackChangesConnectDetails | undefined;
|
|
11
14
|
static readonly TYPE: string;
|
|
12
15
|
static readonly READABLE_TYPE_NAME: string;
|
|
13
16
|
static readonly DESCRIPTOR_NAME: string;
|
|
14
17
|
static readonly DESCRIPTOR: IDescriptorBody;
|
|
15
|
-
constructor(documentId: string);
|
|
18
|
+
constructor(documentId: string, details?: ITrackChangesConnectDetails | undefined);
|
|
16
19
|
toJSON(): IConnectMessage;
|
|
17
20
|
static fromJSON(object: IConnectMessage): ConnectMessage;
|
|
18
21
|
}
|
|
@@ -4,19 +4,22 @@
|
|
|
4
4
|
import Message, { type IMessage } from './../../message';
|
|
5
5
|
import type { IDescriptorBody } from '../../descriptor';
|
|
6
6
|
import { type ISuggestion, type ISuggestionJSON } from '../descriptors/suggestiondescriptor';
|
|
7
|
+
import { type IUserJSON } from '../../users/descriptors/userdescriptor';
|
|
7
8
|
export interface IConnectResponse extends IMessage {
|
|
8
9
|
channel: string;
|
|
9
10
|
suggestions?: string[];
|
|
10
11
|
suggestionsV2?: ISuggestionJSON[];
|
|
12
|
+
users?: IUserJSON[];
|
|
11
13
|
}
|
|
12
14
|
export default class ConnectResponse extends Message {
|
|
13
15
|
readonly channel: string;
|
|
14
16
|
private readonly _suggestions?;
|
|
15
17
|
private readonly _suggestionsV2?;
|
|
18
|
+
readonly users?: Record<string, unknown>[] | undefined;
|
|
16
19
|
readonly suggestions: ISuggestion[];
|
|
17
20
|
static readonly DESCRIPTOR_NAME: string;
|
|
18
21
|
static readonly DESCRIPTOR: IDescriptorBody;
|
|
19
|
-
constructor(channel: string, _suggestions?: ISuggestion[] | undefined, _suggestionsV2?: ISuggestion[] | undefined);
|
|
22
|
+
constructor(channel: string, _suggestions?: ISuggestion[] | undefined, _suggestionsV2?: ISuggestion[] | undefined, users?: Record<string, unknown>[] | undefined);
|
|
20
23
|
toJSON(): IConnectResponse;
|
|
21
24
|
static fromJSON(object: IConnectResponse): ConnectResponse;
|
|
22
25
|
}
|
|
@@ -2,7 +2,12 @@
|
|
|
2
2
|
Copyright (c), CKSource Holding sp. z o.o. All rights reserved.
|
|
3
3
|
*/
|
|
4
4
|
import Descriptor, { type IDescriptorBody } from './../../descriptor';
|
|
5
|
+
export interface IUserJSON {
|
|
6
|
+
attributes: Record<string, string>[];
|
|
7
|
+
}
|
|
5
8
|
export default class UserDescriptor extends Descriptor {
|
|
6
9
|
static readonly DESCRIPTOR_NAME: string;
|
|
7
10
|
static readonly DESCRIPTOR: IDescriptorBody;
|
|
11
|
+
static toJSON(user: Record<string, unknown>): IUserJSON;
|
|
12
|
+
static fromJSON(data: IUserJSON): Record<string, unknown>;
|
|
8
13
|
}
|
|
@@ -3,8 +3,9 @@
|
|
|
3
3
|
*/
|
|
4
4
|
import Message, { type IMessage } from './../../message';
|
|
5
5
|
import type { IDescriptorBody } from '../../descriptor';
|
|
6
|
+
import { type IUserJSON } from '../descriptors/userdescriptor';
|
|
6
7
|
export interface IGetManyUsersResponse extends IMessage {
|
|
7
|
-
users:
|
|
8
|
+
users: IUserJSON[];
|
|
8
9
|
}
|
|
9
10
|
export default class GetManyUsersResponse extends Message {
|
|
10
11
|
readonly users: Record<string, unknown>[];
|
package/dist/version.d.ts
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ckeditor/ckeditor-cloud-services-collaboration",
|
|
3
|
-
"version": "55.
|
|
3
|
+
"version": "55.2.0",
|
|
4
4
|
"description": "CKEditor Cloud Services Collaboration low-level API is required by CKEditor 5 Collaboration features to enable real-time collaborative editing in CKEditor 5.",
|
|
5
5
|
"main": "dist/services.js",
|
|
6
6
|
"license": "SEE LICENSE IN LICENSE.md",
|