@ckeditor/ckeditor-cloud-services-collaboration 52.1.4 → 52.1.5
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/package.json +13 -2
- package/src/ckeditorcloudserviceserror.d.ts +8 -0
- package/src/ckeditorcloudserviceserror.js +1 -1
- package/src/ckeditorcloudservicesservererror.d.ts +15 -0
- package/src/ckeditorcloudservicesservererror.js +1 -1
- package/src/collaborativeeditingservice/collaborativeeditingservice.d.ts +127 -0
- package/src/collaborativeeditingservice/collaborativeeditingservice.js +1 -1
- package/src/collaborativeeditingservice/descriptors/operationmetadatadescriptor.d.ts +18 -0
- package/src/collaborativeeditingservice/descriptors/operationmetadatadescriptor.js +1 -1
- package/src/collaborativeeditingservice/helpers/operationmetadatahelpers.d.ts +11 -0
- package/src/collaborativeeditingservice/helpers/operationmetadatahelpers.js +1 -1
- package/src/collaborativeeditingservice/messages/collaborativeeditingconnectmessage.d.ts +24 -0
- package/src/collaborativeeditingservice/messages/collaborativeeditingconnectmessage.js +1 -1
- package/src/collaborativeeditingservice/messages/collaborativeeditingreconnectmessage.d.ts +19 -0
- package/src/collaborativeeditingservice/messages/collaborativeeditingreconnectmessage.js +1 -1
- package/src/collaborativeeditingservice/messages/collaborativeeditingupdatemessage.d.ts +38 -0
- package/src/collaborativeeditingservice/messages/collaborativeeditingupdatemessage.js +1 -1
- package/src/collaborativeeditingservice/messages/getdocumentdetailsmessage.d.ts +16 -0
- package/src/collaborativeeditingservice/messages/getdocumentdetailsmessage.js +1 -1
- package/src/collaborativeeditingservice/responses/collaborativeeditingconnectresponse.d.ts +68 -0
- package/src/collaborativeeditingservice/responses/collaborativeeditingconnectresponse.js +1 -1
- package/src/collaborativeeditingservice/responses/collaborativeeditingresponse.d.ts +51 -0
- package/src/collaborativeeditingservice/responses/collaborativeeditingresponse.js +1 -1
- package/src/collaborativeeditingservice/responses/getdocumentdetailsresponse.d.ts +28 -0
- package/src/collaborativeeditingservice/responses/getdocumentdetailsresponse.js +1 -1
- package/src/comments-v2/commentsservice.d.ts +72 -0
- package/src/comments-v2/commentsservice.js +1 -1
- package/src/comments-v2/descriptors/commentdescriptor.d.ts +23 -0
- package/src/comments-v2/descriptors/commentdescriptor.js +1 -1
- package/src/comments-v2/descriptors/commentsthreaddescriptor.d.ts +31 -0
- package/src/comments-v2/descriptors/commentsthreaddescriptor.js +1 -1
- package/src/comments-v2/descriptors/commentthreadaddedcomment.d.ts +15 -0
- package/src/comments-v2/descriptors/commentthreadaddedcomment.js +1 -1
- package/src/comments-v2/messages/addcommentmessage.d.ts +30 -0
- package/src/comments-v2/messages/addcommentmessage.js +1 -1
- package/src/comments-v2/messages/comment-threads/addcommentthreadmessage.d.ts +32 -0
- package/src/comments-v2/messages/comment-threads/addcommentthreadmessage.js +1 -1
- package/src/comments-v2/messages/comment-threads/reopencommentthreadmessage.d.ts +17 -0
- package/src/comments-v2/messages/comment-threads/reopencommentthreadmessage.js +1 -1
- package/src/comments-v2/messages/comment-threads/resolvecommentthreadmessage.d.ts +21 -0
- package/src/comments-v2/messages/comment-threads/resolvecommentthreadmessage.js +1 -1
- package/src/comments-v2/messages/comment-threads/updatecommentthreadmessage.d.ts +23 -0
- package/src/comments-v2/messages/comment-threads/updatecommentthreadmessage.js +1 -1
- package/src/comments-v2/messages/connectmessage.d.ts +15 -0
- package/src/comments-v2/messages/connectmessage.js +1 -1
- package/src/comments-v2/messages/getcommentthreadmessage.d.ts +17 -0
- package/src/comments-v2/messages/getcommentthreadmessage.js +1 -1
- package/src/comments-v2/messages/getdocumentthreadsmessage.d.ts +15 -0
- package/src/comments-v2/messages/getdocumentthreadsmessage.js +1 -1
- package/src/comments-v2/messages/removecommentmessage.d.ts +19 -0
- package/src/comments-v2/messages/removecommentmessage.js +1 -1
- package/src/comments-v2/messages/removecommentthreadmessage.d.ts +17 -0
- package/src/comments-v2/messages/removecommentthreadmessage.js +1 -1
- package/src/comments-v2/messages/updatecommentmessage.d.ts +28 -0
- package/src/comments-v2/messages/updatecommentmessage.js +1 -1
- package/src/comments-v2/responses/addcommentresponse.d.ts +17 -0
- package/src/comments-v2/responses/addcommentresponse.js +1 -1
- package/src/comments-v2/responses/comment-threads/addcommentthreadresponse.d.ts +22 -0
- package/src/comments-v2/responses/comment-threads/addcommentthreadresponse.js +1 -1
- package/src/comments-v2/responses/comment-threads/resolvecommentthreadresponse.d.ts +19 -0
- package/src/comments-v2/responses/comment-threads/resolvecommentthreadresponse.js +1 -1
- package/src/comments-v2/responses/connectresponse.d.ts +19 -0
- package/src/comments-v2/responses/connectresponse.js +1 -1
- package/src/comments-v2/responses/getcommentthreadresponse.d.ts +33 -0
- package/src/comments-v2/responses/getcommentthreadresponse.js +1 -1
- package/src/comments-v2/responses/getdocumentthreadsresponse.d.ts +17 -0
- package/src/comments-v2/responses/getdocumentthreadsresponse.js +1 -1
- package/src/compiledmessages.d.ts +9 -8313
- package/src/compiledmessages.js +1 -1
- package/src/descriptor.d.ts +13 -0
- package/src/descriptor.js +1 -1
- package/src/descriptors/keyvaluedescriptor.d.ts +5 -0
- package/src/descriptors/keyvaluedescriptor.js +1 -1
- package/src/editor/editorservice.d.ts +11 -0
- package/src/editor/editorservice.js +1 -1
- package/src/editor/messages/iseditorbundleuploadedmessage.d.ts +15 -0
- package/src/editor/messages/iseditorbundleuploadedmessage.js +1 -1
- package/src/editor/responses/iseditorbundleuploadedresponse.d.ts +13 -0
- package/src/editor/responses/iseditorbundleuploadedresponse.js +1 -1
- package/src/errors/ServiceNotConnectedError.d.ts +4 -0
- package/src/errors/ServiceNotConnectedError.js +1 -1
- package/src/index.d.ts +66 -0
- package/src/index.js +1 -1
- package/src/message.d.ts +17 -0
- package/src/message.js +1 -1
- package/src/messagescompressor.d.ts +15 -0
- package/src/messagescompressor.js +1 -1
- package/src/messagesmapper.d.ts +9 -0
- package/src/messagesmapper.js +1 -1
- package/src/revision-history/descriptors/revisiondescriptor.d.ts +42 -0
- package/src/revision-history/descriptors/revisiondescriptor.js +1 -1
- package/src/revision-history/messages/revisionhistoryconnectmessage.d.ts +15 -0
- package/src/revision-history/messages/revisionhistoryconnectmessage.js +1 -1
- package/src/revision-history/messages/revisionhistorygetrevisionmessage.d.ts +17 -0
- package/src/revision-history/messages/revisionhistorygetrevisionmessage.js +1 -1
- package/src/revision-history/messages/revisionhistoryreconnectmessage.d.ts +17 -0
- package/src/revision-history/messages/revisionhistoryreconnectmessage.js +1 -1
- package/src/revision-history/messages/revisionhistoryupdaterevisionsmessage.d.ts +41 -0
- package/src/revision-history/messages/revisionhistoryupdaterevisionsmessage.js +1 -1
- package/src/revision-history/responses/revisionhistoryconnectresponse.d.ts +30 -0
- package/src/revision-history/responses/revisionhistoryconnectresponse.js +1 -1
- package/src/revision-history/responses/revisionhistorygetrevisionresponse.d.ts +30 -0
- package/src/revision-history/responses/revisionhistorygetrevisionresponse.js +1 -1
- package/src/revision-history/responses/revisionhistoryupdaterevisionsresponse.d.ts +13 -0
- package/src/revision-history/responses/revisionhistoryupdaterevisionsresponse.js +1 -1
- package/src/revision-history/revision.d.ts +15 -0
- package/src/revision-history/revision.js +1 -1
- package/src/revision-history/revisionhistoryservice.d.ts +75 -0
- package/src/revision-history/revisionhistoryservice.js +1 -1
- package/src/services.d.ts +8 -0
- package/src/services.js +1 -1
- package/src/sessions/descriptors/sessiondescriptor.d.ts +5 -0
- package/src/sessions/descriptors/sessiondescriptor.js +1 -1
- package/src/sessions/messages/sessionsconnectmessage.d.ts +17 -0
- package/src/sessions/messages/sessionsconnectmessage.js +1 -1
- package/src/sessions/messages/socketconnectmessage.d.ts +21 -0
- package/src/sessions/messages/socketconnectmessage.js +1 -1
- package/src/sessions/messages/socketdisconnectmessage.d.ts +15 -0
- package/src/sessions/messages/socketdisconnectmessage.js +1 -1
- package/src/sessions/responses/sessionsconnectresponse.d.ts +21 -0
- package/src/sessions/responses/sessionsconnectresponse.js +1 -1
- package/src/sessions/sessioncollection.d.ts +40 -0
- package/src/sessions/sessioncollection.js +1 -1
- package/src/sessions/sessions.d.ts +13 -0
- package/src/sessions/sessions.js +1 -1
- package/src/track-changes/descriptors/suggestiondescriptor.d.ts +25 -0
- package/src/track-changes/descriptors/suggestiondescriptor.js +1 -1
- package/src/track-changes/messages/addsuggestionmessage.d.ts +25 -0
- package/src/track-changes/messages/addsuggestionmessage.js +1 -1
- package/src/track-changes/messages/batchUpdateSuggestionsStateMessage.d.ts +19 -0
- package/src/track-changes/messages/batchUpdateSuggestionsStateMessage.js +1 -1
- package/src/track-changes/messages/connectmessage.d.ts +15 -0
- package/src/track-changes/messages/connectmessage.js +1 -1
- package/src/track-changes/messages/getallsuggestionsmessage.d.ts +15 -0
- package/src/track-changes/messages/getallsuggestionsmessage.js +1 -1
- package/src/track-changes/messages/getsuggestionmessage.d.ts +17 -0
- package/src/track-changes/messages/getsuggestionmessage.js +1 -1
- package/src/track-changes/messages/updatesuggestionmessage.d.ts +25 -0
- package/src/track-changes/messages/updatesuggestionmessage.js +1 -1
- package/src/track-changes/responses/addsuggestionresponse.d.ts +27 -0
- package/src/track-changes/responses/addsuggestionresponse.js +1 -1
- package/src/track-changes/responses/connectresponse.d.ts +19 -0
- package/src/track-changes/responses/connectresponse.js +1 -1
- package/src/track-changes/responses/getallsuggestionsresponse.d.ts +17 -0
- package/src/track-changes/responses/getallsuggestionsresponse.js +1 -1
- package/src/track-changes/responses/getsuggestionresponse.d.ts +27 -0
- package/src/track-changes/responses/getsuggestionresponse.js +1 -1
- package/src/track-changes/trackchangesservice.d.ts +62 -0
- package/src/track-changes/trackchangesservice.js +1 -1
- package/src/types.d.ts +7 -0
- package/src/types.js +1 -1
- package/src/users/descriptors/userdescriptor.d.ts +5 -0
- package/src/users/descriptors/userdescriptor.js +1 -1
- package/src/users/messages/getmanyusersmessage.d.ts +15 -0
- package/src/users/messages/getmanyusersmessage.js +1 -1
- package/src/users/messages/getusermessage.d.ts +15 -0
- package/src/users/messages/getusermessage.js +1 -1
- package/src/users/responses/getmanyusersresponse.d.ts +13 -0
- package/src/users/responses/getmanyusersresponse.js +1 -1
- package/src/users/responses/getuserresponse.d.ts +13 -0
- package/src/users/responses/getuserresponse.js +1 -1
- package/src/users/user.d.ts +41 -0
- package/src/users/user.js +1 -1
- package/src/version.d.ts +2 -0
- package/src/version.js +1 -1
- package/src/websocketgateway/channel.d.ts +31 -0
- package/src/websocketgateway/channel.js +1 -1
- package/src/websocketgateway/messages/channelmessage.d.ts +21 -0
- package/src/websocketgateway/messages/channelmessage.js +1 -1
- package/src/websocketgateway/parser/packetparser.d.ts +15 -0
- package/src/websocketgateway/parser/packetparser.js +1 -1
- package/src/websocketgateway/parser/packets/bytesbytespacketdatamessage.d.ts +18 -0
- package/src/websocketgateway/parser/packets/bytesbytespacketdatamessage.js +1 -1
- package/src/websocketgateway/parser/packets/numberbytespacketdatamessage.d.ts +18 -0
- package/src/websocketgateway/parser/packets/numberbytespacketdatamessage.js +1 -1
- package/src/websocketgateway/parser/packets/numbernumberpacketdatamessag.d.ts +17 -0
- package/src/websocketgateway/parser/packets/numbernumberpacketdatamessag.js +1 -1
- package/src/websocketgateway/parser/packets/numberobjectpacketdatamessage.d.ts +17 -0
- package/src/websocketgateway/parser/packets/numberobjectpacketdatamessage.js +1 -1
- package/src/websocketgateway/parser/packets/numberstringpacketdatamessag.d.ts +17 -0
- package/src/websocketgateway/parser/packets/numberstringpacketdatamessag.js +1 -1
- package/src/websocketgateway/parser/packets/objectbufferpacketdatamessage.d.ts +18 -0
- package/src/websocketgateway/parser/packets/objectbufferpacketdatamessage.js +1 -1
- package/src/websocketgateway/parser/packets/objectobjectpacketdatamessage.d.ts +17 -0
- package/src/websocketgateway/parser/packets/objectobjectpacketdatamessage.js +1 -1
- package/src/websocketgateway/parser/packets/packagedatamessage.d.ts +16 -0
- package/src/websocketgateway/parser/packets/packagedatamessage.js +1 -1
- package/src/websocketgateway/parser/packets/packetmessage.d.ts +31 -0
- package/src/websocketgateway/parser/packets/packetmessage.js +1 -1
- package/src/websocketgateway/parser/packets/packetoptionsmessage.d.ts +18 -0
- package/src/websocketgateway/parser/packets/packetoptionsmessage.js +1 -1
- package/src/websocketgateway/parser/packets/stringbytespacketdatamessage.d.ts +18 -0
- package/src/websocketgateway/parser/packets/stringbytespacketdatamessage.js +1 -1
- package/src/websocketgateway/parser/packets/stringnumberpacketdatamessage.d.ts +17 -0
- package/src/websocketgateway/parser/packets/stringnumberpacketdatamessage.js +1 -1
- package/src/websocketgateway/parser/packets/stringobjectpacketdatamessage.d.ts +17 -0
- package/src/websocketgateway/parser/packets/stringobjectpacketdatamessage.js +1 -1
- package/src/websocketgateway/parser/packets/stringstringpacketdatamessage.d.ts +17 -0
- package/src/websocketgateway/parser/packets/stringstringpacketdatamessage.js +1 -1
- package/src/websocketgateway/parser/parser.d.ts +14 -0
- package/src/websocketgateway/parser/parser.js +1 -1
- package/src/websocketgateway/parser/parserutils.d.ts +27 -0
- package/src/websocketgateway/parser/parserutils.js +1 -1
- package/src/websocketgateway/requestsmanager.d.ts +20 -0
- package/src/websocketgateway/requestsmanager.js +1 -1
- package/src/websocketgateway/websocketgateway.d.ts +164 -0
- package/src/websocketgateway/websocketgateway.js +1 -1
package/package.json
CHANGED
|
@@ -1,9 +1,21 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ckeditor/ckeditor-cloud-services-collaboration",
|
|
3
|
-
"version": "52.1.
|
|
3
|
+
"version": "52.1.5",
|
|
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": "src/index.js",
|
|
6
6
|
"license": "SEE LICENSE IN LICENSE.md",
|
|
7
|
+
"syncScripts": {
|
|
8
|
+
"compile:messages": "node compilemessages.esm.js",
|
|
9
|
+
"build": "tsc --build && tsc-alias",
|
|
10
|
+
"postbuild": "npm run compile:messages",
|
|
11
|
+
"prepublishOnly": "tsc --build --clean && npm run build",
|
|
12
|
+
"pretest": "ENV=test npm run build",
|
|
13
|
+
"test": "karma start karma.conf.cjs --single-run",
|
|
14
|
+
"lint": "eslint '**/*.{js,ts}'",
|
|
15
|
+
"lint:fix": "npm run lint -- --fix",
|
|
16
|
+
"deps:check": "ncu",
|
|
17
|
+
"ci:test": "npm run lint && npm test"
|
|
18
|
+
},
|
|
7
19
|
"keywords": [
|
|
8
20
|
"CKEditor",
|
|
9
21
|
"ckeditor5",
|
|
@@ -36,6 +48,5 @@
|
|
|
36
48
|
"peerDependencies": {
|
|
37
49
|
"ckeditor5": ">= 37.x"
|
|
38
50
|
},
|
|
39
|
-
"type": "module",
|
|
40
51
|
"obfuscated": true
|
|
41
52
|
}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { IPublicError } from './ckeditorcloudservicesservererror';
|
|
2
|
+
export default class CKEditorCloudServicesError extends Error {
|
|
3
|
+
readonly context?: unknown;
|
|
4
|
+
readonly code: string | null;
|
|
5
|
+
readonly data: Record<string, unknown>;
|
|
6
|
+
constructor(message: string, context?: unknown, code?: string | null, data?: Record<string, unknown>);
|
|
7
|
+
static fromPublicError(publicError: IPublicError): CKEditorCloudServicesError;
|
|
8
|
+
}
|
|
@@ -20,4 +20,4 @@
|
|
|
20
20
|
*
|
|
21
21
|
*
|
|
22
22
|
*/
|
|
23
|
-
|
|
23
|
+
'use strict';Object['defineProperty'](exports,'__esModule',{'value':!0x0});class CKEditorCloudServicesError extends Error{constructor(_0x1fcd54,_0x1397e5,_0x23d1ae=null,_0x133ae9={}){super('cloud-services-internal-error:\x20'+_0x1fcd54),this['context']=_0x1397e5,this['code']=_0x23d1ae,this['data']=_0x133ae9,this['name']='CKEditorError';}static['fromPublicError'](_0x2a3da2){return new CKEditorCloudServicesError(function(_0x4937f1){let _0x34d584='cloud-services-error:\x20'+_0x4937f1['message'];return _0x4937f1['data']&&(_0x34d584+='\x0aError\x20data:\x20'+JSON['stringify'](_0x4937f1['data'])),_0x4937f1['explanation']&&(_0x34d584+='\x0aExplanation:\x20'+_0x4937f1['explanation']),_0x4937f1['action']&&(_0x34d584+='\x0aAction:\x20'+_0x4937f1['action']),_0x4937f1['traceId']&&(_0x34d584+='\x0aTraceId:\x20'+_0x4937f1['traceId']),_0x4937f1['code']&&(_0x34d584+='\x0aCode:\x20'+_0x4937f1['code']),_0x34d584;}(_0x2a3da2),_0x2a3da2);}}exports['default']=CKEditorCloudServicesError;
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
export interface IPublicError {
|
|
2
|
+
message: string;
|
|
3
|
+
traceId?: string;
|
|
4
|
+
data?: Record<string, unknown>;
|
|
5
|
+
code?: string;
|
|
6
|
+
explanation?: string;
|
|
7
|
+
action?: string;
|
|
8
|
+
}
|
|
9
|
+
export default class CKEditorCloudServicesServerError extends Error {
|
|
10
|
+
readonly code?: string;
|
|
11
|
+
readonly traceId?: string;
|
|
12
|
+
readonly data?: Record<string, unknown>;
|
|
13
|
+
private constructor();
|
|
14
|
+
static fromPublicError(publicError: IPublicError): CKEditorCloudServicesServerError;
|
|
15
|
+
}
|
|
@@ -20,4 +20,4 @@
|
|
|
20
20
|
*
|
|
21
21
|
*
|
|
22
22
|
*/
|
|
23
|
-
|
|
23
|
+
'use strict';Object['defineProperty'](exports,'__esModule',{'value':!0x0});class CKEditorCloudServicesServerError extends Error{constructor(_0x427960,_0x3b04b3){super(),this['name']='CKEditorCloudServicesServerError',this['stack']=void 0x0,this['message']=_0x427960,this['code']=_0x3b04b3['code'],this['traceId']=_0x3b04b3['traceId'],this['data']=_0x3b04b3['data'];}static['fromPublicError'](_0x585a3f){return new CKEditorCloudServicesServerError(function(_0x32af0c){let _0x2383bf='cloud-services-server-error:\x20'+_0x32af0c['message'];return _0x32af0c['explanation']&&(_0x2383bf+='\x0aExplanation:\x20'+_0x32af0c['explanation']),_0x32af0c['action']&&(_0x2383bf+='\x0aAction:\x20'+_0x32af0c['action']),_0x32af0c['traceId']&&(_0x2383bf+='\x0aTraceId:\x20'+_0x32af0c['traceId']),_0x32af0c['code']&&(_0x2383bf+='\x0aCode:\x20'+_0x32af0c['code']),_0x2383bf;}(_0x585a3f),_0x585a3f);}}exports['default']=CKEditorCloudServicesServerError;
|
|
@@ -0,0 +1,127 @@
|
|
|
1
|
+
/// <reference types="node" />
|
|
2
|
+
import CollaborativeEditingConnectMessage from './messages/collaborativeeditingconnectmessage';
|
|
3
|
+
import CollaborativeEditingReconnectMessage from './messages/collaborativeeditingreconnectmessage';
|
|
4
|
+
import CollaborativeEditingResponse from './responses/collaborativeeditingresponse';
|
|
5
|
+
import CollaborativeEditingConnectResponse from './responses/collaborativeeditingconnectresponse';
|
|
6
|
+
import { IWebSocketGateway } from './../websocketgateway/websocketgateway';
|
|
7
|
+
import SessionCollection from '../sessions/sessioncollection';
|
|
8
|
+
import GetDocumentDetailsResponse from './responses/getdocumentdetailsresponse';
|
|
9
|
+
export declare const _SERVICE: number;
|
|
10
|
+
export interface IOperationsData {
|
|
11
|
+
buffers: (Buffer | Uint8Array)[];
|
|
12
|
+
types: number[];
|
|
13
|
+
}
|
|
14
|
+
declare const CollaborativeEditingService_base: {
|
|
15
|
+
new (): import("ckeditor5/src/utils").Emitter;
|
|
16
|
+
prototype: import("ckeditor5/src/utils").Emitter;
|
|
17
|
+
};
|
|
18
|
+
/**
|
|
19
|
+
* General purpose CollaborativeEditingService used to synchronize data store values with other collaborative nodes.
|
|
20
|
+
*/
|
|
21
|
+
declare class CollaborativeEditingService extends CollaborativeEditingService_base {
|
|
22
|
+
static _SERVICE: number;
|
|
23
|
+
private readonly _bundleVersion;
|
|
24
|
+
private readonly _id;
|
|
25
|
+
private _isConnected;
|
|
26
|
+
private _wsGateway?;
|
|
27
|
+
private _channel?;
|
|
28
|
+
private _connectedSessions?;
|
|
29
|
+
/**
|
|
30
|
+
* Create CollaborativeEditingService instance.
|
|
31
|
+
*
|
|
32
|
+
* const collabWritingService = new CollaborativeEditingService( '0.9.0', 'post-456-text' );
|
|
33
|
+
*
|
|
34
|
+
* @throws {TypeError}
|
|
35
|
+
* Throws when bundleVersion param is not provided.
|
|
36
|
+
*/
|
|
37
|
+
constructor(bundleVersion: string, serviceId?: string);
|
|
38
|
+
getId(): string;
|
|
39
|
+
/**
|
|
40
|
+
* Indicates that CollaborativeEditingService is connected to CKEditor Cloud Services.
|
|
41
|
+
*/
|
|
42
|
+
isConnected(): boolean;
|
|
43
|
+
/**
|
|
44
|
+
* Connects CollaborativeEditingService to CKEditor Cloud Services.
|
|
45
|
+
*
|
|
46
|
+
* const myDocument = new CollaborativeEditingService( '0.9.0', 'article-1234' );
|
|
47
|
+
*
|
|
48
|
+
* await myDocument.connect( wsGateway );
|
|
49
|
+
*
|
|
50
|
+
* @throws {CKEditorCloudServicesError}
|
|
51
|
+
* Thrown in the case of errors on the backend side.
|
|
52
|
+
*/
|
|
53
|
+
connect(wsGateway: IWebSocketGateway, data?: {
|
|
54
|
+
buffers: Buffer[];
|
|
55
|
+
types: number[];
|
|
56
|
+
}, lastOperationId?: string): Promise<CollaborativeEditingConnectResponse | void>;
|
|
57
|
+
/**
|
|
58
|
+
* Reconnects CollaborativeEditingService to CKEditor Cloud Services.
|
|
59
|
+
*
|
|
60
|
+
* const myDocument = new CollaborativeEditingService( '0.9.0', 'article-1234' );
|
|
61
|
+
*
|
|
62
|
+
* await myDocument.connect( wsGateway );
|
|
63
|
+
*
|
|
64
|
+
* wsGateway.on( 'change:state', ( event, property, value ) => {
|
|
65
|
+
* if( value === 'disconnected' ) {
|
|
66
|
+
* await myDocument.reconnect( wsGateway, 123 );
|
|
67
|
+
* }
|
|
68
|
+
* } );
|
|
69
|
+
*
|
|
70
|
+
* @throws {CKEditorCloudServicesError}
|
|
71
|
+
* Thrown when connection already exists or in the case of errors on the backend side.
|
|
72
|
+
*/
|
|
73
|
+
reconnect(wsGateway: IWebSocketGateway, lastKnowVersion: number): Promise<CollaborativeEditingConnectResponse>;
|
|
74
|
+
/**
|
|
75
|
+
* Disconnects CollaborativeEditingService from CKEditor Cloud Services.
|
|
76
|
+
*
|
|
77
|
+
* @throws {CKEditorCloudServicesError}
|
|
78
|
+
* Thrown in the case of errors on the backend side.
|
|
79
|
+
*/
|
|
80
|
+
disconnect(): void;
|
|
81
|
+
/**
|
|
82
|
+
* Gets document details from CKEditor Cloud Services.
|
|
83
|
+
*
|
|
84
|
+
* @throws {CKEditorCloudServicesError}
|
|
85
|
+
* Thrown in the case of errors on the backend side.
|
|
86
|
+
*/
|
|
87
|
+
getDocumentDetails(): Promise<GetDocumentDetailsResponse>;
|
|
88
|
+
/**
|
|
89
|
+
* Sends update to connected service. This will propagate update to other connected CollaborativeEditingService.
|
|
90
|
+
* Data update will not be stored on CollaborativeEditingService server instance.
|
|
91
|
+
*
|
|
92
|
+
* @throws {CKEditorCloudServicesError}
|
|
93
|
+
* Throws when baseVersion or data is not provided, data is empty, or in the case of errors on the backend side.
|
|
94
|
+
*
|
|
95
|
+
* @throws {ServiceNotConnectedError}
|
|
96
|
+
* Throws when collaborative editing service is not connected.
|
|
97
|
+
*/
|
|
98
|
+
sendOperations(data: IOperationsData, baseVersion: number | string, lastOperationId: string): Promise<CollaborativeEditingResponse>;
|
|
99
|
+
/**
|
|
100
|
+
* Returns read-only observable collection with EndUsers Sessions for collaborative editing service.
|
|
101
|
+
*
|
|
102
|
+
* @throws {CKEditorCloudServicesError}
|
|
103
|
+
* Thrown in the case of errors on the backend side.
|
|
104
|
+
*/
|
|
105
|
+
getConnectedSessions(): Promise<SessionCollection>;
|
|
106
|
+
/**
|
|
107
|
+
* Returns a Promise that resolves with read-only observable collection with EndUsers Sessions for given id.
|
|
108
|
+
*
|
|
109
|
+
* const sessions = await CollaborativeEditingService.getConnectedSessions( 'my-document-id' );
|
|
110
|
+
*
|
|
111
|
+
* @deprecated Use not static version of getConnectedSessions method.
|
|
112
|
+
*
|
|
113
|
+
* @throws {CKEditorCloudServicesError}
|
|
114
|
+
* Throws in the case of errors on the backend side.
|
|
115
|
+
*/
|
|
116
|
+
static getConnectedSessions(wsGateway: IWebSocketGateway, id: string): Promise<SessionCollection>;
|
|
117
|
+
_connect(wsGateway: IWebSocketGateway, message: CollaborativeEditingConnectMessage | CollaborativeEditingReconnectMessage): Promise<CollaborativeEditingConnectResponse | void>;
|
|
118
|
+
/**
|
|
119
|
+
* Connects given CollaborativeEditingService to channel.
|
|
120
|
+
*/
|
|
121
|
+
protected _connectToChannel(wsGateway: IWebSocketGateway, channelName: string): void;
|
|
122
|
+
/**
|
|
123
|
+
* WebSocketGateway "change:state" events handler.
|
|
124
|
+
*/
|
|
125
|
+
private _onWsGatewayStateChange;
|
|
126
|
+
}
|
|
127
|
+
export default CollaborativeEditingService;
|
|
@@ -20,4 +20,4 @@
|
|
|
20
20
|
*
|
|
21
21
|
*
|
|
22
22
|
*/
|
|
23
|
-
|
|
23
|
+
'use strict';var __importDefault=this&&this['__importDefault']||function(_0xcfcf6b){return _0xcfcf6b&&_0xcfcf6b['__esModule']?_0xcfcf6b:{'default':_0xcfcf6b};};Object['defineProperty'](exports,'__esModule',{'value':!0x0}),exports['_SERVICE']=void 0x0;const uuid_1=require('uuid'),utils_js_1=require('ckeditor5/src/utils.js'),messagescompressor_1=__importDefault(require('./../messagescompressor')),sessions_1=__importDefault(require('./../sessions/sessions')),collaborativeeditingconnectmessage_1=__importDefault(require('./messages/collaborativeeditingconnectmessage')),collaborativeeditingupdatemessage_1=__importDefault(require('./messages/collaborativeeditingupdatemessage')),collaborativeeditingreconnectmessage_1=__importDefault(require('./messages/collaborativeeditingreconnectmessage')),collaborativeeditingresponse_1=__importDefault(require('./responses/collaborativeeditingresponse')),collaborativeeditingconnectresponse_1=__importDefault(require('./responses/collaborativeeditingconnectresponse')),websocketgateway_1=__importDefault(require('./../websocketgateway/websocketgateway')),ckeditorcloudserviceserror_1=__importDefault(require('../ckeditorcloudserviceserror')),ServiceNotConnectedError_1=__importDefault(require('../errors/ServiceNotConnectedError')),getdocumentdetailsresponse_1=__importDefault(require('./responses/getdocumentdetailsresponse')),getdocumentdetailsmessage_1=__importDefault(require('./messages/getdocumentdetailsmessage'));exports['_SERVICE']=0x1;class CollaborativeEditingService extends(0x0,utils_js_1['EmitterMixin'])(){constructor(_0x4d14a6,_0x3c0ffe){if(super(),!_0x4d14a6)throw new TypeError('Param\x20\x22bundleVersion\x22\x20must\x20be\x20provided.');this['_id']=null!=_0x3c0ffe?_0x3c0ffe:(0x0,uuid_1['v4'])(),this['_isConnected']=!0x1,this['_bundleVersion']=_0x4d14a6;}['getId'](){return this['_id'];}['isConnected'](){return this['_isConnected'];}['connect'](_0x2a172d,_0x29bf59={'buffers':[],'types':[]},_0x2fa8c2){const _0x365d60=new collaborativeeditingconnectmessage_1['default'](this['getId'](),_0x29bf59['buffers'],_0x29bf59['types'],this['_bundleVersion'],_0x2fa8c2);return this['_connect'](_0x2a172d,_0x365d60);}['reconnect'](_0x481594,_0x1d486e){if(this['isConnected']())throw new ckeditorcloudserviceserror_1['default']('Cannot\x20reconnect\x20to\x20already\x20connected\x20service.',_0x481594);return this['_connect'](_0x481594,new collaborativeeditingreconnectmessage_1['default'](this['getId'](),_0x1d486e,this['_bundleVersion']));}['disconnect'](){this['_isConnected']&&(this['_isConnected']=!0x1,this['_wsGateway']&&(this['stopListening'](this['_wsGateway']),this['_wsGateway']=void 0x0),this['_channel']&&(this['stopListening'](this['_channel']),this['_channel']=void 0x0),this['_connectedSessions']&&(this['_connectedSessions']['disconnect'](),this['_connectedSessions']=void 0x0),this['fire']('disconnected'),this['stopListening']());}async['getDocumentDetails'](){const _0x32ffc4=new getdocumentdetailsmessage_1['default'](this['getId']());if(!this['_wsGateway'])throw new ServiceNotConnectedError_1['default']('Collaborative\x20Editing',this);const _0x5c1077=await this['_wsGateway']['_sendRequest'](exports['_SERVICE'],getdocumentdetailsmessage_1['default']['TYPE'],messagescompressor_1['default']['encode'](_0x32ffc4));return messagescompressor_1['default']['decode'](_0x5c1077,getdocumentdetailsresponse_1['default']);}async['sendOperations'](_0x467224,_0xb2cf6,_0x242698){if(!_0x467224||!_0x467224['types']||!_0x467224['types']['length'])throw new ckeditorcloudserviceserror_1['default']('Cannot\x20send\x20empty\x20update.',this['_wsGateway']);const _0x504a1d='number'==typeof _0xb2cf6?_0xb2cf6:parseInt(_0xb2cf6);if(!Number['isInteger'](_0x504a1d)||_0x504a1d<0x0)throw new ckeditorcloudserviceserror_1['default']('Base\x20version\x20not\x20provided.',this['_wsGateway']);const _0xcd680b=new collaborativeeditingupdatemessage_1['default'](this['getId'](),_0x467224['buffers'],_0x467224['types'],_0x504a1d,[],_0x242698);if(!this['_wsGateway']||!this['_isConnected'])throw new ServiceNotConnectedError_1['default']('Collaborative\x20Editing',this);const _0x4ac8b7=await this['_wsGateway']['_sendRequest'](exports['_SERVICE'],collaborativeeditingupdatemessage_1['default']['TYPE'],messagescompressor_1['default']['encode'](_0xcd680b));return messagescompressor_1['default']['decode'](_0x4ac8b7,collaborativeeditingresponse_1['default']);}async['getConnectedSessions'](){if(!this['_isConnected'])throw new ServiceNotConnectedError_1['default']('Collaborative\x20Editing',this);return this['_connectedSessions']||(this['_connectedSessions']=await sessions_1['default']['getConnectedSessions'](this['_wsGateway'],this['_id'],exports['_SERVICE'])),this['_connectedSessions'];}static['getConnectedSessions'](_0x583aa8,_0x1eee31){return sessions_1['default']['getConnectedSessions'](_0x583aa8,_0x1eee31,exports['_SERVICE']);}async['_connect'](_0x4e88a7,_0x27c04f){if(this['isConnected']())return;if(_0x4e88a7['state']!==websocketgateway_1['default']['STATE_CONNECTED'])throw new ckeditorcloudserviceserror_1['default']('WebSocket\x20Gateway\x20is\x20not\x20connected.',_0x4e88a7);this['_wsGateway']=_0x4e88a7,this['stopListening'](_0x4e88a7,'change:state');const _0x339c72=await _0x4e88a7['_sendRequest'](exports['_SERVICE'],_0x27c04f['constructor']['TYPE'],messagescompressor_1['default']['encode'](_0x27c04f)),_0x1edf18=messagescompressor_1['default']['decode'](_0x339c72,collaborativeeditingconnectresponse_1['default']);return this['listenTo'](_0x4e88a7,'change:state',(_0x5a9936,_0x1f25e0,_0x4236a2)=>this['_onWsGatewayStateChange'](_0x4236a2),{'priority':websocketgateway_1['default']['_CHANGE_STATE_EVENT_PRIORITY']}),this['_connectToChannel'](_0x4e88a7,_0x1edf18['channel']),this['_isConnected']=!0x0,this['fire']('connected'),_0x1edf18;}['_connectToChannel'](_0x51352e,_0x55c0ff){this['_channel']=_0x51352e['_getChannel'](exports['_SERVICE'],_0x55c0ff),this['listenTo'](this['_channel'],this['_channel']['getEventName'](collaborativeeditingupdatemessage_1['default']['TYPE']),(_0xa4bee9,_0x1d7944)=>{const _0x4244f6=messagescompressor_1['default']['decode'](_0x1d7944,collaborativeeditingupdatemessage_1['default']);this['fire']('operationsReceived',_0x4244f6['baseVersion'],_0x4244f6['data'],_0x4244f6['metadata']);});}['_onWsGatewayStateChange'](_0x455375){_0x455375===websocketgateway_1['default']['STATE_DISCONNECTED']&&this['disconnect']();}}CollaborativeEditingService['_SERVICE']=exports['_SERVICE'],exports['default']=CollaborativeEditingService;
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import Descriptor, { IDescriptorBody } from './../../descriptor';
|
|
2
|
+
interface IBaseOperationMetadata {
|
|
3
|
+
userId: string;
|
|
4
|
+
type?: string;
|
|
5
|
+
}
|
|
6
|
+
export interface IOperationMetadata extends IBaseOperationMetadata {
|
|
7
|
+
createdAt?: Date;
|
|
8
|
+
}
|
|
9
|
+
export interface IOperationMetadataJSON extends IBaseOperationMetadata {
|
|
10
|
+
createdAt?: string;
|
|
11
|
+
}
|
|
12
|
+
export default class OperationMetadataDescriptor extends Descriptor {
|
|
13
|
+
static readonly DESCRIPTOR_NAME: string;
|
|
14
|
+
static readonly DESCRIPTOR: IDescriptorBody;
|
|
15
|
+
static toJSON({ createdAt, ...metadata }: IOperationMetadata): IOperationMetadataJSON;
|
|
16
|
+
static fromJSON({ createdAt, ...metadata }: IOperationMetadataJSON): IOperationMetadata;
|
|
17
|
+
}
|
|
18
|
+
export {};
|
|
@@ -20,4 +20,4 @@
|
|
|
20
20
|
*
|
|
21
21
|
*
|
|
22
22
|
*/
|
|
23
|
-
|
|
23
|
+
'use strict';var __importDefault=this&&this['__importDefault']||function(_0x121b6b){return _0x121b6b&&_0x121b6b['__esModule']?_0x121b6b:{'default':_0x121b6b};};Object['defineProperty'](exports,'__esModule',{'value':!0x0});const descriptor_1=__importDefault(require('./../../descriptor'));class OperationMetadataDescriptor extends descriptor_1['default']{static['toJSON']({createdAt:_0x41fed7,..._0x9a1d89}){const _0x3bb550={..._0x9a1d89};return(null==_0x41fed7?void 0x0:_0x41fed7['toISOString'])&&(_0x3bb550['createdAt']=_0x41fed7['toISOString']()),_0x3bb550;}static['fromJSON']({createdAt:_0x895ec2,..._0x3da96b}){const _0x135297={..._0x3da96b};return _0x895ec2&&(_0x135297['createdAt']=new Date(_0x895ec2)),_0x135297;}}exports['default']=OperationMetadataDescriptor,OperationMetadataDescriptor['DESCRIPTOR_NAME']='OperationMetadataDescriptor',OperationMetadataDescriptor['DESCRIPTOR']={'fields':{'userId':{'type':'string','id':0x1},'type':{'type':'string','id':0x2},'createdAt':{'type':'string','id':0x3}}};
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { IOperationMetadata, IOperationMetadataJSON } from '../descriptors/operationmetadatadescriptor';
|
|
2
|
+
export default class OperationMetadataHelpers {
|
|
3
|
+
/**
|
|
4
|
+
* Prepares metadata data for all operations. Adds metadata to operations with type 0.
|
|
5
|
+
*/
|
|
6
|
+
static prepareMetadataForOperations(types: number[], metadata: IOperationMetadataJSON[]): IOperationMetadataJSON[];
|
|
7
|
+
/**
|
|
8
|
+
* Removes unnecessary metadata for operations with type 0.
|
|
9
|
+
*/
|
|
10
|
+
static removeUnnecessaryMetadata(types: number[], metadata: IOperationMetadata[]): IOperationMetadata[];
|
|
11
|
+
}
|
|
@@ -20,4 +20,4 @@
|
|
|
20
20
|
*
|
|
21
21
|
*
|
|
22
22
|
*/
|
|
23
|
-
|
|
23
|
+
'use strict';Object['defineProperty'](exports,'__esModule',{'value':!0x0}),exports['default']=class{static['prepareMetadataForOperations'](_0x3856fe,_0x4886f9){if(!(_0x3856fe&&_0x3856fe['length']&&_0x4886f9&&_0x4886f9['length']))return[];const _0x3ec6ea=[];let _0x131ec6=0x0;for(const _0x541a24 of _0x3856fe)if(0x0!==_0x541a24){if(!_0x4886f9[_0x131ec6])throw new Error('Missing\x20metadata\x20for\x20a\x20operation');_0x3ec6ea['push'](_0x4886f9[_0x131ec6]),_0x131ec6++;}else _0x3ec6ea['push'](_0x3ec6ea[_0x3ec6ea['length']-0x1]);return _0x3ec6ea;}static['removeUnnecessaryMetadata'](_0xb0cde9,_0x461c89){if(!(_0xb0cde9&&_0xb0cde9['length']&&_0x461c89&&_0x461c89['length']))return[];const _0x39d508=[];for(let _0x101f8e=0x0;_0x101f8e<_0xb0cde9['length'];_0x101f8e++)if(0x0!==_0xb0cde9[_0x101f8e]){if(!_0x461c89[_0x101f8e])throw new Error('Missing\x20metadata\x20for\x20a\x20operation');_0x39d508['push'](_0x461c89[_0x101f8e]);}return _0x39d508;}};
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
/// <reference types="node" />
|
|
2
|
+
import Message, { IMessage } from './../../message';
|
|
3
|
+
import { IDescriptorBody } from '../../descriptor';
|
|
4
|
+
export interface ICollaborativeEditingConnectMessage extends IMessage {
|
|
5
|
+
id: string;
|
|
6
|
+
bundleVersion: string;
|
|
7
|
+
buffers: Buffer[];
|
|
8
|
+
types: number[];
|
|
9
|
+
lastOperationId?: string;
|
|
10
|
+
}
|
|
11
|
+
export default class CollaborativeEditingConnectMessage extends Message {
|
|
12
|
+
readonly id: string;
|
|
13
|
+
readonly buffers: Buffer[];
|
|
14
|
+
readonly types: number[];
|
|
15
|
+
readonly bundleVersion: string;
|
|
16
|
+
readonly lastOperationId: string;
|
|
17
|
+
static readonly TYPE: string;
|
|
18
|
+
static readonly READABLE_TYPE_NAME: string;
|
|
19
|
+
static readonly DESCRIPTOR_NAME: string;
|
|
20
|
+
static readonly DESCRIPTOR: IDescriptorBody;
|
|
21
|
+
constructor(id: string, buffers: Buffer[], types: number[], bundleVersion: string, lastOperationId?: string);
|
|
22
|
+
toJSON(): ICollaborativeEditingConnectMessage;
|
|
23
|
+
static fromJSON(data: ICollaborativeEditingConnectMessage): CollaborativeEditingConnectMessage;
|
|
24
|
+
}
|
|
@@ -20,4 +20,4 @@
|
|
|
20
20
|
*
|
|
21
21
|
*
|
|
22
22
|
*/
|
|
23
|
-
|
|
23
|
+
'use strict';var __importDefault=this&&this['__importDefault']||function(_0x5a619f){return _0x5a619f&&_0x5a619f['__esModule']?_0x5a619f:{'default':_0x5a619f};};Object['defineProperty'](exports,'__esModule',{'value':!0x0});const message_1=__importDefault(require('./../../message'));class CollaborativeEditingConnectMessage extends message_1['default']{constructor(_0x2e855c,_0x4f2a14,_0x4eb479,_0x31c2d7,_0x2fa5ea=''){super(),this['id']=_0x2e855c,this['buffers']=_0x4f2a14,this['types']=_0x4eb479,this['bundleVersion']=_0x31c2d7,this['lastOperationId']=_0x2fa5ea;}['toJSON'](){return{'id':this['id'],'buffers':this['buffers'],'types':this['types'],'bundleVersion':this['bundleVersion'],'lastOperationId':this['lastOperationId']};}static['fromJSON'](_0x203a70){return new CollaborativeEditingConnectMessage(_0x203a70['id'],_0x203a70['buffers'],_0x203a70['types'],_0x203a70['bundleVersion'],_0x203a70['lastOperationId']);}}exports['default']=CollaborativeEditingConnectMessage,CollaborativeEditingConnectMessage['TYPE']='11',CollaborativeEditingConnectMessage['READABLE_TYPE_NAME']='connectToDocument',CollaborativeEditingConnectMessage['DESCRIPTOR_NAME']='CollaborativeEditingConnectMessage',CollaborativeEditingConnectMessage['DESCRIPTOR']={'fields':{'id':{'type':'string','id':0x1},'bundleVersion':{'type':'string','id':0x2},'buffers':{'rule':'repeated','type':'bytes','id':0x3},'types':{'rule':'repeated','type':'uint32','id':0x4},'lastOperationId':{'type':'string','id':0x5}}};
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import Message, { IMessage } from './../../message';
|
|
2
|
+
import { IDescriptorBody } from '../../descriptor';
|
|
3
|
+
export interface ICollaborativeEditingReconnectMessage extends IMessage {
|
|
4
|
+
id: string;
|
|
5
|
+
lastKnowVersion: number;
|
|
6
|
+
bundleVersion: string;
|
|
7
|
+
}
|
|
8
|
+
export default class CollaborativeEditingReconnectMessage extends Message {
|
|
9
|
+
readonly id: string;
|
|
10
|
+
readonly lastKnowVersion: number;
|
|
11
|
+
readonly bundleVersion: string;
|
|
12
|
+
static readonly TYPE: string;
|
|
13
|
+
static readonly READABLE_TYPE_NAME: string;
|
|
14
|
+
static readonly DESCRIPTOR_NAME: string;
|
|
15
|
+
static readonly DESCRIPTOR: IDescriptorBody;
|
|
16
|
+
constructor(id: string, lastKnowVersion: number, bundleVersion: string);
|
|
17
|
+
toJSON(): ICollaborativeEditingReconnectMessage;
|
|
18
|
+
static fromJSON(data: ICollaborativeEditingReconnectMessage): CollaborativeEditingReconnectMessage;
|
|
19
|
+
}
|
|
@@ -20,4 +20,4 @@
|
|
|
20
20
|
*
|
|
21
21
|
*
|
|
22
22
|
*/
|
|
23
|
-
|
|
23
|
+
'use strict';var __importDefault=this&&this['__importDefault']||function(_0x2bf38a){return _0x2bf38a&&_0x2bf38a['__esModule']?_0x2bf38a:{'default':_0x2bf38a};};Object['defineProperty'](exports,'__esModule',{'value':!0x0});const message_1=__importDefault(require('./../../message'));class CollaborativeEditingReconnectMessage extends message_1['default']{constructor(_0x124a41,_0x4e6c87,_0x14581b){super(),this['id']=_0x124a41,this['lastKnowVersion']=_0x4e6c87,this['bundleVersion']=_0x14581b;}['toJSON'](){return{'id':this['id'],'bundleVersion':this['bundleVersion'],'lastKnowVersion':this['lastKnowVersion']};}static['fromJSON'](_0x1c5a94){return new CollaborativeEditingReconnectMessage(_0x1c5a94['id'],_0x1c5a94['lastKnowVersion'],_0x1c5a94['bundleVersion']);}}exports['default']=CollaborativeEditingReconnectMessage,CollaborativeEditingReconnectMessage['TYPE']='12',CollaborativeEditingReconnectMessage['READABLE_TYPE_NAME']='reconnectToDocument',CollaborativeEditingReconnectMessage['DESCRIPTOR_NAME']='CollaborativeEditingReconnectMessage',CollaborativeEditingReconnectMessage['DESCRIPTOR']={'fields':{'id':{'type':'string','id':0x1},'bundleVersion':{'type':'string','id':0x2},'lastKnowVersion':{'type':'uint32','id':0x3}}};
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
/// <reference types="node" />
|
|
2
|
+
import Message, { IMessage } from './../../message';
|
|
3
|
+
import { IDescriptorBody } from '../../descriptor';
|
|
4
|
+
import { IOperationMetadata, IOperationMetadataJSON } from '../descriptors/operationmetadatadescriptor';
|
|
5
|
+
export interface ICollaborativeEditingUpdateMessage extends IMessage {
|
|
6
|
+
id: string;
|
|
7
|
+
buffers: Buffer[] | Uint8Array[];
|
|
8
|
+
types: number[];
|
|
9
|
+
baseVersion: number;
|
|
10
|
+
metadata: IOperationMetadataJSON[];
|
|
11
|
+
lastOperationId?: string;
|
|
12
|
+
}
|
|
13
|
+
interface ICollaborativeEditingUpdateData {
|
|
14
|
+
buffers: Buffer[] | Uint8Array[];
|
|
15
|
+
types: number[];
|
|
16
|
+
baseVersion: number;
|
|
17
|
+
lastOperationId?: string;
|
|
18
|
+
}
|
|
19
|
+
export default class CollaborativeEditingUpdateMessage extends Message {
|
|
20
|
+
readonly id: string;
|
|
21
|
+
readonly buffers: Buffer[] | Uint8Array[];
|
|
22
|
+
readonly types: number[];
|
|
23
|
+
readonly baseVersion: number;
|
|
24
|
+
readonly metadata: IOperationMetadata[];
|
|
25
|
+
readonly lastOperationId: string;
|
|
26
|
+
static readonly TYPE: string;
|
|
27
|
+
static readonly READABLE_TYPE_NAME: string;
|
|
28
|
+
static readonly DESCRIPTOR_NAME: string;
|
|
29
|
+
static readonly DESCRIPTOR: IDescriptorBody;
|
|
30
|
+
constructor(id: string, buffers: Buffer[] | Uint8Array[], types: number[], baseVersion: number, metadata?: IOperationMetadata[], lastOperationId?: string);
|
|
31
|
+
/**
|
|
32
|
+
* Returns compressed data of the operations.
|
|
33
|
+
*/
|
|
34
|
+
get data(): ICollaborativeEditingUpdateData;
|
|
35
|
+
toJSON(): ICollaborativeEditingUpdateMessage;
|
|
36
|
+
static fromJSON(data: ICollaborativeEditingUpdateMessage): CollaborativeEditingUpdateMessage;
|
|
37
|
+
}
|
|
38
|
+
export {};
|
|
@@ -20,4 +20,4 @@
|
|
|
20
20
|
*
|
|
21
21
|
*
|
|
22
22
|
*/
|
|
23
|
-
|
|
23
|
+
'use strict';var __importDefault=this&&this['__importDefault']||function(_0x5c937d){return _0x5c937d&&_0x5c937d['__esModule']?_0x5c937d:{'default':_0x5c937d};};Object['defineProperty'](exports,'__esModule',{'value':!0x0});const message_1=__importDefault(require('./../../message')),operationmetadatahelpers_1=__importDefault(require('./../helpers/operationmetadatahelpers')),operationmetadatadescriptor_1=__importDefault(require('../descriptors/operationmetadatadescriptor'));class CollaborativeEditingUpdateMessage extends message_1['default']{constructor(_0x1dceb9,_0xd8439f,_0x2ce3b8,_0x53eb07,_0x533460=[],_0x2f2c56=''){super(),this['id']=_0x1dceb9,this['buffers']=_0xd8439f,this['types']=_0x2ce3b8,this['baseVersion']=_0x53eb07,this['metadata']=_0x533460,this['lastOperationId']=_0x2f2c56;}get['data'](){return{'buffers':this['buffers'],'types':this['types'],'baseVersion':this['baseVersion'],'lastOperationId':this['lastOperationId']};}['toJSON'](){return{'id':this['id'],'buffers':this['buffers'],'types':this['types'],'baseVersion':this['baseVersion'],'metadata':operationmetadatahelpers_1['default']['removeUnnecessaryMetadata'](this['types'],this['metadata'])['map'](operationmetadatadescriptor_1['default']['toJSON']),'lastOperationId':this['lastOperationId']};}static['fromJSON'](_0x2377d3){return new CollaborativeEditingUpdateMessage(_0x2377d3['id'],_0x2377d3['buffers'],_0x2377d3['types'],_0x2377d3['baseVersion'],operationmetadatahelpers_1['default']['prepareMetadataForOperations'](_0x2377d3['types'],_0x2377d3['metadata'])['map'](operationmetadatadescriptor_1['default']['fromJSON']),_0x2377d3['lastOperationId']);}}exports['default']=CollaborativeEditingUpdateMessage,CollaborativeEditingUpdateMessage['TYPE']='13',CollaborativeEditingUpdateMessage['READABLE_TYPE_NAME']='updateDocument',CollaborativeEditingUpdateMessage['DESCRIPTOR_NAME']='CollaborativeEditingUpdateMessage',CollaborativeEditingUpdateMessage['DESCRIPTOR']={'fields':{'id':{'type':'string','id':0x1},'baseVersion':{'type':'uint32','id':0x2},'buffers':{'rule':'repeated','type':'bytes','id':0x3},'types':{'rule':'repeated','type':'uint32','id':0x4},'metadata':{'rule':'repeated','type':'OperationMetadataDescriptor','id':0x6},'lastOperationId':{'type':'string','id':0x7}}};
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import Message from '../../message';
|
|
2
|
+
import { IDescriptorBody } from '../../descriptor';
|
|
3
|
+
export interface IGetDocumentDetailsMessage {
|
|
4
|
+
documentId: string;
|
|
5
|
+
}
|
|
6
|
+
export default class GetDocumentDetailsMessage extends Message {
|
|
7
|
+
readonly documentId: string;
|
|
8
|
+
static readonly TYPE: string;
|
|
9
|
+
static readonly READABLE_TYPE_NAME: string;
|
|
10
|
+
static readonly DESCRIPTOR_NAME: string;
|
|
11
|
+
static readonly DESCRIPTOR: IDescriptorBody;
|
|
12
|
+
constructor(documentId: string);
|
|
13
|
+
get data(): IGetDocumentDetailsMessage;
|
|
14
|
+
toJSON(): IGetDocumentDetailsMessage;
|
|
15
|
+
static fromJSON(data: IGetDocumentDetailsMessage): GetDocumentDetailsMessage;
|
|
16
|
+
}
|
|
@@ -20,4 +20,4 @@
|
|
|
20
20
|
*
|
|
21
21
|
*
|
|
22
22
|
*/
|
|
23
|
-
|
|
23
|
+
'use strict';var __importDefault=this&&this['__importDefault']||function(_0x5a508c){return _0x5a508c&&_0x5a508c['__esModule']?_0x5a508c:{'default':_0x5a508c};};Object['defineProperty'](exports,'__esModule',{'value':!0x0});const message_1=__importDefault(require('../../message'));class GetDocumentDetailsMessage extends message_1['default']{constructor(_0x23c56b){super(),this['documentId']=_0x23c56b;}get['data'](){return{'documentId':this['documentId']};}['toJSON'](){return{'documentId':this['documentId']};}static['fromJSON'](_0x1f43cd){return new GetDocumentDetailsMessage(_0x1f43cd['documentId']);}}exports['default']=GetDocumentDetailsMessage,GetDocumentDetailsMessage['TYPE']='14',GetDocumentDetailsMessage['READABLE_TYPE_NAME']='getDocumentDetails',GetDocumentDetailsMessage['DESCRIPTOR_NAME']='GetDocumentDetailsMessage',GetDocumentDetailsMessage['DESCRIPTOR']={'fields':{'documentId':{'type':'string','id':0x1},'environmentId':{'type':'string','id':0x2}}};
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
/// <reference types="node" />
|
|
2
|
+
import Message, { IMessage } from './../../message';
|
|
3
|
+
import { IDescriptorBody } from '../../descriptor';
|
|
4
|
+
import { IOperationMetadata, IOperationMetadataJSON } from '../descriptors/operationmetadatadescriptor';
|
|
5
|
+
export interface ICollaborativeEditingConnectResponse extends IMessage {
|
|
6
|
+
channel: string;
|
|
7
|
+
offset: number;
|
|
8
|
+
version: number;
|
|
9
|
+
sessionId: string;
|
|
10
|
+
buffers: Buffer[] | Uint8Array[];
|
|
11
|
+
types: number[];
|
|
12
|
+
metadata: IOperationMetadataJSON[];
|
|
13
|
+
initData: string;
|
|
14
|
+
isInitialized: boolean;
|
|
15
|
+
lastOperationId?: string;
|
|
16
|
+
sessionCreatedAt: string | null;
|
|
17
|
+
}
|
|
18
|
+
interface ICollaborativeEditingConnectResponseParams {
|
|
19
|
+
channel: string;
|
|
20
|
+
version: number;
|
|
21
|
+
sessionId?: string;
|
|
22
|
+
buffers?: Buffer[] | Uint8Array[];
|
|
23
|
+
types?: number[];
|
|
24
|
+
offset?: number;
|
|
25
|
+
metadata?: IOperationMetadata[];
|
|
26
|
+
initData?: string | null;
|
|
27
|
+
lastOperationId?: string;
|
|
28
|
+
sessionCreatedAt: Date | null;
|
|
29
|
+
}
|
|
30
|
+
interface ICollaborativeEditingConnectResponseData {
|
|
31
|
+
buffers: Buffer[] | Uint8Array[];
|
|
32
|
+
types: number[];
|
|
33
|
+
baseVersion: number;
|
|
34
|
+
lastOperationId?: string;
|
|
35
|
+
sessionCreatedAt: Date | null;
|
|
36
|
+
}
|
|
37
|
+
export default class CollaborativeEditingConnectResponse extends Message {
|
|
38
|
+
readonly channel: string;
|
|
39
|
+
readonly version: number;
|
|
40
|
+
readonly buffers: Buffer[] | Uint8Array[];
|
|
41
|
+
readonly types: number[];
|
|
42
|
+
readonly offset: number;
|
|
43
|
+
readonly metadata: IOperationMetadata[];
|
|
44
|
+
readonly initData: string | null;
|
|
45
|
+
readonly sessionId: string;
|
|
46
|
+
readonly lastOperationId: string;
|
|
47
|
+
readonly sessionCreatedAt: Date | null;
|
|
48
|
+
static readonly DESCRIPTOR_NAME: string;
|
|
49
|
+
static readonly DESCRIPTOR: IDescriptorBody;
|
|
50
|
+
/**
|
|
51
|
+
* @deprecated - Use CollaborativeEditingConnectResponse.create factory method instead.
|
|
52
|
+
*
|
|
53
|
+
* @param channel - Name of channel on which messages will be published.
|
|
54
|
+
* @param version - Version of the document.
|
|
55
|
+
* @param buffers - List of operations compressed to the binary format.
|
|
56
|
+
* @param types - List of compressor identifiers.
|
|
57
|
+
* @param offset - Number of changes in previous editing sessions.
|
|
58
|
+
* @param metadata - Metadata of changes.
|
|
59
|
+
* @param initData - Initialization data of the document.
|
|
60
|
+
*/
|
|
61
|
+
constructor(channel: string, version: number, buffers?: Buffer[] | Uint8Array[], types?: number[], offset?: number, metadata?: IOperationMetadata[], initData?: string | null, sessionId?: string, lastOperationId?: string, sessionCreatedAt?: Date | null);
|
|
62
|
+
get data(): ICollaborativeEditingConnectResponseData;
|
|
63
|
+
get wereChangesApplied(): boolean;
|
|
64
|
+
toJSON(): ICollaborativeEditingConnectResponse;
|
|
65
|
+
static create(params: ICollaborativeEditingConnectResponseParams): CollaborativeEditingConnectResponse;
|
|
66
|
+
static fromJSON(data: ICollaborativeEditingConnectResponse): CollaborativeEditingConnectResponse;
|
|
67
|
+
}
|
|
68
|
+
export {};
|
|
@@ -20,4 +20,4 @@
|
|
|
20
20
|
*
|
|
21
21
|
*
|
|
22
22
|
*/
|
|
23
|
-
|
|
23
|
+
'use strict';var __importDefault=this&&this['__importDefault']||function(_0x4d19cc){return _0x4d19cc&&_0x4d19cc['__esModule']?_0x4d19cc:{'default':_0x4d19cc};};Object['defineProperty'](exports,'__esModule',{'value':!0x0});const message_1=__importDefault(require('./../../message')),operationmetadatahelpers_1=__importDefault(require('./../helpers/operationmetadatahelpers')),operationmetadatadescriptor_1=__importDefault(require('../descriptors/operationmetadatadescriptor'));class CollaborativeEditingConnectResponse extends message_1['default']{constructor(_0x3d2df2,_0x5e1506,_0x36a9b3=[],_0x21393d=[],_0x110b5a=0x0,_0x23c37b=[],_0x1739c9=null,_0x4569b6='',_0x2d78e9='',_0x11d971=null){super(),this['channel']=_0x3d2df2,this['version']=_0x5e1506,this['buffers']=_0x36a9b3,this['types']=_0x21393d,this['offset']=_0x110b5a,this['metadata']=_0x23c37b,this['initData']=_0x1739c9,this['sessionId']=_0x4569b6,this['lastOperationId']=_0x2d78e9,this['sessionCreatedAt']=_0x11d971;}get['data'](){return{'buffers':this['buffers'],'types':this['types'],'baseVersion':this['version']-this['types']['length'],'lastOperationId':this['lastOperationId'],'sessionCreatedAt':this['sessionCreatedAt']};}get['wereChangesApplied'](){var _0x5a0514;return!(null===(_0x5a0514=this['types'])||void 0x0===_0x5a0514?void 0x0:_0x5a0514['length'])&&null===this['initData'];}['toJSON'](){var _0x7d2619;return{'channel':this['channel'],'version':this['version'],'sessionId':this['sessionId'],'buffers':this['buffers'],'types':this['types'],'offset':this['offset'],'metadata':operationmetadatahelpers_1['default']['removeUnnecessaryMetadata'](this['types'],this['metadata'])['map'](operationmetadatadescriptor_1['default']['toJSON']),'initData':null!==(_0x7d2619=this['initData'])&&void 0x0!==_0x7d2619?_0x7d2619:'','isInitialized':'string'==typeof this['initData'],'lastOperationId':this['lastOperationId'],'sessionCreatedAt':this['sessionCreatedAt']?this['sessionCreatedAt']['toISOString']():null};}static['create'](_0x57c499){return new CollaborativeEditingConnectResponse(_0x57c499['channel'],_0x57c499['version'],_0x57c499['buffers'],_0x57c499['types'],_0x57c499['offset'],_0x57c499['metadata'],_0x57c499['initData'],_0x57c499['sessionId'],_0x57c499['lastOperationId'],_0x57c499['sessionCreatedAt']);}static['fromJSON'](_0x4a8f62){var _0x4c8451;let _0x4a22b2=null;return!0x0===_0x4a8f62['isInitialized']?_0x4a22b2=null!==(_0x4c8451=_0x4a8f62['initData'])&&void 0x0!==_0x4c8451?_0x4c8451:'':'boolean'!=typeof _0x4a8f62['isInitialized']&&_0x4a8f62['initData']&&(_0x4a22b2=_0x4a8f62['initData']),CollaborativeEditingConnectResponse['create']({'channel':_0x4a8f62['channel'],'version':_0x4a8f62['version'],'buffers':_0x4a8f62['buffers'],'types':_0x4a8f62['types'],'offset':_0x4a8f62['offset'],'metadata':operationmetadatahelpers_1['default']['prepareMetadataForOperations'](_0x4a8f62['types'],_0x4a8f62['metadata'])['map'](operationmetadatadescriptor_1['default']['fromJSON']),'initData':_0x4a22b2,'sessionId':_0x4a8f62['sessionId'],'lastOperationId':_0x4a8f62['lastOperationId'],'sessionCreatedAt':_0x4a8f62['sessionCreatedAt']?new Date(_0x4a8f62['sessionCreatedAt']):null});}}exports['default']=CollaborativeEditingConnectResponse,CollaborativeEditingConnectResponse['DESCRIPTOR_NAME']='CollaborativeEditingConnectResponse',CollaborativeEditingConnectResponse['DESCRIPTOR']={'fields':{'channel':{'type':'string','id':0x1},'offset':{'type':'uint32','id':0x2},'version':{'type':'uint32','id':0x3},'buffers':{'rule':'repeated','type':'bytes','id':0x4},'types':{'rule':'repeated','type':'uint32','id':0x5},'metadata':{'rule':'repeated','type':operationmetadatadescriptor_1['default']['DESCRIPTOR_NAME'],'id':0x7},'initData':{'type':'string','id':0x8},'isInitialized':{'type':'bool','id':0x9},'sessionId':{'type':'string','id':0xa},'lastOperationId':{'type':'string','id':0xb},'sessionCreatedAt':{'type':'string','id':0xc}}};
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
/// <reference types="node" />
|
|
2
|
+
import Message, { IMessage } from './../../message';
|
|
3
|
+
import { IDescriptorBody } from '../../descriptor';
|
|
4
|
+
import { IOperationMetadata, IOperationMetadataJSON } from '../descriptors/operationmetadatadescriptor';
|
|
5
|
+
export interface ICollaborativeEditingResponse extends IMessage {
|
|
6
|
+
version: number;
|
|
7
|
+
buffers: Buffer[];
|
|
8
|
+
types: number[];
|
|
9
|
+
metadata: IOperationMetadataJSON[];
|
|
10
|
+
lastOperationId: string;
|
|
11
|
+
lastOperationAcceptedAt: string | null;
|
|
12
|
+
}
|
|
13
|
+
interface ICollaborativeEditingResponseParams {
|
|
14
|
+
version: number;
|
|
15
|
+
buffers?: Buffer[];
|
|
16
|
+
types?: number[];
|
|
17
|
+
metadata?: IOperationMetadata[];
|
|
18
|
+
lastOperationId?: string;
|
|
19
|
+
lastOperationAcceptedAt?: string | null;
|
|
20
|
+
}
|
|
21
|
+
interface ICollaborativeEditingResponseData {
|
|
22
|
+
buffers: Buffer[];
|
|
23
|
+
types: number[];
|
|
24
|
+
baseVersion: number;
|
|
25
|
+
lastOperationId: string;
|
|
26
|
+
lastOperationAcceptedAt: Date | null;
|
|
27
|
+
}
|
|
28
|
+
export default class CollaborativeEditingResponse extends Message {
|
|
29
|
+
readonly version: number;
|
|
30
|
+
readonly buffers: Buffer[];
|
|
31
|
+
readonly types: number[];
|
|
32
|
+
readonly metadata: IOperationMetadata[];
|
|
33
|
+
readonly lastOperationId: string;
|
|
34
|
+
readonly lastOperationAcceptedAt: Date | null;
|
|
35
|
+
static readonly DESCRIPTOR_NAME: string;
|
|
36
|
+
static readonly DESCRIPTOR: IDescriptorBody;
|
|
37
|
+
/**
|
|
38
|
+
* @deprecated - Use CollaborativeEditingResponse.create factory method instead.
|
|
39
|
+
* @param version - Version of the document.
|
|
40
|
+
* @param buffers - List of operations compressed to the binary format.
|
|
41
|
+
* @param types - List of compressor identifiers.
|
|
42
|
+
* @param metadata - Metadata of changes.
|
|
43
|
+
*/
|
|
44
|
+
constructor(version: number, buffers?: Buffer[], types?: number[], metadata?: IOperationMetadata[], lastOperationId?: string, lastOperationAcceptedAt?: Date | null);
|
|
45
|
+
get data(): ICollaborativeEditingResponseData;
|
|
46
|
+
get wereChangesApplied(): boolean;
|
|
47
|
+
toJSON(): ICollaborativeEditingResponse;
|
|
48
|
+
static fromJSON(data: ICollaborativeEditingResponse): CollaborativeEditingResponse;
|
|
49
|
+
static create(data: ICollaborativeEditingResponseParams): CollaborativeEditingResponse;
|
|
50
|
+
}
|
|
51
|
+
export {};
|