@ckeditor/ckeditor-cloud-services-collaboration 52.1.0 → 52.1.4
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 +2 -1
- package/src/ckeditorcloudserviceserror.js +1 -1
- package/src/ckeditorcloudservicesservererror.js +1 -1
- package/src/collaborativeeditingservice/collaborativeeditingservice.js +1 -1
- package/src/collaborativeeditingservice/descriptors/operationmetadatadescriptor.js +1 -1
- package/src/collaborativeeditingservice/helpers/operationmetadatahelpers.js +1 -1
- package/src/collaborativeeditingservice/messages/collaborativeeditingconnectmessage.js +1 -1
- package/src/collaborativeeditingservice/messages/collaborativeeditingreconnectmessage.js +1 -1
- package/src/collaborativeeditingservice/messages/collaborativeeditingupdatemessage.js +1 -1
- package/src/collaborativeeditingservice/messages/getdocumentdetailsmessage.js +1 -1
- package/src/collaborativeeditingservice/responses/collaborativeeditingconnectresponse.js +1 -1
- package/src/collaborativeeditingservice/responses/collaborativeeditingresponse.js +1 -1
- package/src/collaborativeeditingservice/responses/getdocumentdetailsresponse.js +1 -1
- package/src/comments-v2/commentsservice.js +1 -1
- package/src/comments-v2/descriptors/commentdescriptor.js +1 -1
- package/src/comments-v2/descriptors/commentsthreaddescriptor.js +1 -1
- package/src/comments-v2/descriptors/commentthreadaddedcomment.js +1 -1
- package/src/comments-v2/messages/addcommentmessage.js +1 -1
- package/src/comments-v2/messages/comment-threads/addcommentthreadmessage.js +1 -1
- package/src/comments-v2/messages/comment-threads/reopencommentthreadmessage.js +1 -1
- package/src/comments-v2/messages/comment-threads/resolvecommentthreadmessage.js +1 -1
- package/src/comments-v2/messages/comment-threads/updatecommentthreadmessage.js +1 -1
- package/src/comments-v2/messages/connectmessage.js +1 -1
- package/src/comments-v2/messages/getcommentthreadmessage.js +1 -1
- package/src/comments-v2/messages/getdocumentthreadsmessage.js +1 -1
- package/src/comments-v2/messages/removecommentmessage.js +1 -1
- package/src/comments-v2/messages/removecommentthreadmessage.js +1 -1
- package/src/comments-v2/messages/updatecommentmessage.js +1 -1
- package/src/comments-v2/responses/addcommentresponse.js +1 -1
- package/src/comments-v2/responses/comment-threads/addcommentthreadresponse.js +1 -1
- package/src/comments-v2/responses/comment-threads/resolvecommentthreadresponse.js +1 -1
- package/src/comments-v2/responses/connectresponse.js +1 -1
- package/src/comments-v2/responses/getcommentthreadresponse.js +1 -1
- package/src/comments-v2/responses/getdocumentthreadsresponse.js +1 -1
- package/src/compiledmessages.d.ts +8313 -9
- package/src/compiledmessages.js +1 -1
- package/src/descriptor.js +1 -1
- package/src/descriptors/keyvaluedescriptor.js +1 -1
- package/src/editor/editorservice.js +1 -1
- package/src/editor/messages/iseditorbundleuploadedmessage.js +1 -1
- package/src/editor/responses/iseditorbundleuploadedresponse.js +1 -1
- package/src/errors/ServiceNotConnectedError.js +1 -1
- package/src/index.js +1 -1
- package/src/message.js +1 -1
- package/src/messagescompressor.js +1 -1
- package/src/messagesmapper.js +1 -1
- package/src/revision-history/descriptors/revisiondescriptor.js +1 -1
- package/src/revision-history/messages/revisionhistoryconnectmessage.js +1 -1
- package/src/revision-history/messages/revisionhistorygetrevisionmessage.js +1 -1
- package/src/revision-history/messages/revisionhistoryreconnectmessage.js +1 -1
- package/src/revision-history/messages/revisionhistoryupdaterevisionsmessage.js +1 -1
- package/src/revision-history/responses/revisionhistoryconnectresponse.js +1 -1
- package/src/revision-history/responses/revisionhistorygetrevisionresponse.js +1 -1
- package/src/revision-history/responses/revisionhistoryupdaterevisionsresponse.js +1 -1
- package/src/revision-history/revision.js +1 -1
- package/src/revision-history/revisionhistoryservice.js +1 -1
- package/src/services.js +1 -1
- package/src/sessions/descriptors/sessiondescriptor.js +1 -1
- package/src/sessions/messages/sessionsconnectmessage.js +1 -1
- package/src/sessions/messages/socketconnectmessage.js +1 -1
- package/src/sessions/messages/socketdisconnectmessage.js +1 -1
- package/src/sessions/responses/sessionsconnectresponse.js +1 -1
- package/src/sessions/sessioncollection.js +1 -1
- package/src/sessions/sessions.js +1 -1
- package/src/track-changes/descriptors/suggestiondescriptor.js +1 -1
- package/src/track-changes/messages/addsuggestionmessage.js +1 -1
- package/src/track-changes/messages/batchUpdateSuggestionsStateMessage.js +1 -1
- package/src/track-changes/messages/connectmessage.js +1 -1
- package/src/track-changes/messages/getallsuggestionsmessage.js +1 -1
- package/src/track-changes/messages/getsuggestionmessage.js +1 -1
- package/src/track-changes/messages/updatesuggestionmessage.js +1 -1
- package/src/track-changes/responses/addsuggestionresponse.js +1 -1
- package/src/track-changes/responses/connectresponse.js +1 -1
- package/src/track-changes/responses/getallsuggestionsresponse.js +1 -1
- package/src/track-changes/responses/getsuggestionresponse.js +1 -1
- package/src/track-changes/trackchangesservice.js +1 -1
- package/src/types.js +1 -1
- package/src/users/descriptors/userdescriptor.js +1 -1
- package/src/users/messages/getmanyusersmessage.js +1 -1
- package/src/users/messages/getusermessage.js +1 -1
- package/src/users/responses/getmanyusersresponse.js +1 -1
- package/src/users/responses/getuserresponse.js +1 -1
- package/src/users/user.js +1 -1
- package/src/version.js +1 -1
- package/src/websocketgateway/channel.js +1 -1
- package/src/websocketgateway/messages/channelmessage.js +1 -1
- package/src/websocketgateway/parser/packetparser.js +1 -1
- package/src/websocketgateway/parser/packets/bytesbytespacketdatamessage.js +1 -1
- package/src/websocketgateway/parser/packets/numberbytespacketdatamessage.js +1 -1
- package/src/websocketgateway/parser/packets/numbernumberpacketdatamessag.js +1 -1
- package/src/websocketgateway/parser/packets/numberobjectpacketdatamessage.js +1 -1
- package/src/websocketgateway/parser/packets/numberstringpacketdatamessag.js +1 -1
- package/src/websocketgateway/parser/packets/objectbufferpacketdatamessage.js +1 -1
- package/src/websocketgateway/parser/packets/objectobjectpacketdatamessage.js +1 -1
- package/src/websocketgateway/parser/packets/packagedatamessage.js +1 -1
- package/src/websocketgateway/parser/packets/packetmessage.js +1 -1
- package/src/websocketgateway/parser/packets/packetoptionsmessage.js +1 -1
- package/src/websocketgateway/parser/packets/stringbytespacketdatamessage.js +1 -1
- package/src/websocketgateway/parser/packets/stringnumberpacketdatamessage.js +1 -1
- package/src/websocketgateway/parser/packets/stringobjectpacketdatamessage.js +1 -1
- package/src/websocketgateway/parser/packets/stringstringpacketdatamessage.js +1 -1
- package/src/websocketgateway/parser/parser.js +1 -1
- package/src/websocketgateway/parser/parserutils.js +1 -1
- package/src/websocketgateway/requestsmanager.js +1 -1
- package/src/websocketgateway/websocketgateway.js +1 -1
- package/src/ckeditorcloudserviceserror.d.ts +0 -8
- package/src/ckeditorcloudservicesservererror.d.ts +0 -15
- package/src/collaborativeeditingservice/collaborativeeditingservice.d.ts +0 -127
- package/src/collaborativeeditingservice/descriptors/operationmetadatadescriptor.d.ts +0 -18
- package/src/collaborativeeditingservice/helpers/operationmetadatahelpers.d.ts +0 -11
- package/src/collaborativeeditingservice/messages/collaborativeeditingconnectmessage.d.ts +0 -24
- package/src/collaborativeeditingservice/messages/collaborativeeditingreconnectmessage.d.ts +0 -19
- package/src/collaborativeeditingservice/messages/collaborativeeditingupdatemessage.d.ts +0 -38
- package/src/collaborativeeditingservice/messages/getdocumentdetailsmessage.d.ts +0 -16
- package/src/collaborativeeditingservice/responses/collaborativeeditingconnectresponse.d.ts +0 -68
- package/src/collaborativeeditingservice/responses/collaborativeeditingresponse.d.ts +0 -51
- package/src/collaborativeeditingservice/responses/getdocumentdetailsresponse.d.ts +0 -28
- package/src/comments-v2/commentsservice.d.ts +0 -72
- package/src/comments-v2/descriptors/commentdescriptor.d.ts +0 -23
- package/src/comments-v2/descriptors/commentsthreaddescriptor.d.ts +0 -31
- package/src/comments-v2/descriptors/commentthreadaddedcomment.d.ts +0 -15
- package/src/comments-v2/messages/addcommentmessage.d.ts +0 -30
- package/src/comments-v2/messages/comment-threads/addcommentthreadmessage.d.ts +0 -32
- package/src/comments-v2/messages/comment-threads/reopencommentthreadmessage.d.ts +0 -17
- package/src/comments-v2/messages/comment-threads/resolvecommentthreadmessage.d.ts +0 -21
- package/src/comments-v2/messages/comment-threads/updatecommentthreadmessage.d.ts +0 -23
- package/src/comments-v2/messages/connectmessage.d.ts +0 -15
- package/src/comments-v2/messages/getcommentthreadmessage.d.ts +0 -17
- package/src/comments-v2/messages/getdocumentthreadsmessage.d.ts +0 -15
- package/src/comments-v2/messages/removecommentmessage.d.ts +0 -19
- package/src/comments-v2/messages/removecommentthreadmessage.d.ts +0 -17
- package/src/comments-v2/messages/updatecommentmessage.d.ts +0 -28
- package/src/comments-v2/responses/addcommentresponse.d.ts +0 -17
- package/src/comments-v2/responses/comment-threads/addcommentthreadresponse.d.ts +0 -22
- package/src/comments-v2/responses/comment-threads/resolvecommentthreadresponse.d.ts +0 -19
- package/src/comments-v2/responses/connectresponse.d.ts +0 -19
- package/src/comments-v2/responses/getcommentthreadresponse.d.ts +0 -33
- package/src/comments-v2/responses/getdocumentthreadsresponse.d.ts +0 -17
- package/src/descriptor.d.ts +0 -13
- package/src/descriptors/keyvaluedescriptor.d.ts +0 -5
- package/src/editor/editorservice.d.ts +0 -11
- package/src/editor/messages/iseditorbundleuploadedmessage.d.ts +0 -15
- package/src/editor/responses/iseditorbundleuploadedresponse.d.ts +0 -13
- package/src/errors/ServiceNotConnectedError.d.ts +0 -4
- package/src/index.d.ts +0 -66
- package/src/message.d.ts +0 -17
- package/src/messagescompressor.d.ts +0 -15
- package/src/messagesmapper.d.ts +0 -9
- package/src/revision-history/descriptors/revisiondescriptor.d.ts +0 -42
- package/src/revision-history/messages/revisionhistoryconnectmessage.d.ts +0 -15
- package/src/revision-history/messages/revisionhistorygetrevisionmessage.d.ts +0 -17
- package/src/revision-history/messages/revisionhistoryreconnectmessage.d.ts +0 -17
- package/src/revision-history/messages/revisionhistoryupdaterevisionsmessage.d.ts +0 -41
- package/src/revision-history/responses/revisionhistoryconnectresponse.d.ts +0 -30
- package/src/revision-history/responses/revisionhistorygetrevisionresponse.d.ts +0 -30
- package/src/revision-history/responses/revisionhistoryupdaterevisionsresponse.d.ts +0 -13
- package/src/revision-history/revision.d.ts +0 -15
- package/src/revision-history/revisionhistoryservice.d.ts +0 -75
- package/src/services.d.ts +0 -8
- package/src/sessions/descriptors/sessiondescriptor.d.ts +0 -5
- package/src/sessions/messages/sessionsconnectmessage.d.ts +0 -17
- package/src/sessions/messages/socketconnectmessage.d.ts +0 -21
- package/src/sessions/messages/socketdisconnectmessage.d.ts +0 -15
- package/src/sessions/responses/sessionsconnectresponse.d.ts +0 -21
- package/src/sessions/sessioncollection.d.ts +0 -40
- package/src/sessions/sessions.d.ts +0 -13
- package/src/track-changes/descriptors/suggestiondescriptor.d.ts +0 -25
- package/src/track-changes/messages/addsuggestionmessage.d.ts +0 -25
- package/src/track-changes/messages/batchUpdateSuggestionsStateMessage.d.ts +0 -19
- package/src/track-changes/messages/connectmessage.d.ts +0 -15
- package/src/track-changes/messages/getallsuggestionsmessage.d.ts +0 -15
- package/src/track-changes/messages/getsuggestionmessage.d.ts +0 -17
- package/src/track-changes/messages/updatesuggestionmessage.d.ts +0 -25
- package/src/track-changes/responses/addsuggestionresponse.d.ts +0 -27
- package/src/track-changes/responses/connectresponse.d.ts +0 -19
- package/src/track-changes/responses/getallsuggestionsresponse.d.ts +0 -17
- package/src/track-changes/responses/getsuggestionresponse.d.ts +0 -27
- package/src/track-changes/trackchangesservice.d.ts +0 -62
- package/src/types.d.ts +0 -7
- package/src/users/descriptors/userdescriptor.d.ts +0 -5
- package/src/users/messages/getmanyusersmessage.d.ts +0 -15
- package/src/users/messages/getusermessage.d.ts +0 -15
- package/src/users/responses/getmanyusersresponse.d.ts +0 -13
- package/src/users/responses/getuserresponse.d.ts +0 -13
- package/src/users/user.d.ts +0 -41
- package/src/version.d.ts +0 -2
- package/src/websocketgateway/channel.d.ts +0 -31
- package/src/websocketgateway/messages/channelmessage.d.ts +0 -21
- package/src/websocketgateway/parser/packetparser.d.ts +0 -15
- package/src/websocketgateway/parser/packets/bytesbytespacketdatamessage.d.ts +0 -18
- package/src/websocketgateway/parser/packets/numberbytespacketdatamessage.d.ts +0 -18
- package/src/websocketgateway/parser/packets/numbernumberpacketdatamessag.d.ts +0 -17
- package/src/websocketgateway/parser/packets/numberobjectpacketdatamessage.d.ts +0 -17
- package/src/websocketgateway/parser/packets/numberstringpacketdatamessag.d.ts +0 -17
- package/src/websocketgateway/parser/packets/objectbufferpacketdatamessage.d.ts +0 -18
- package/src/websocketgateway/parser/packets/objectobjectpacketdatamessage.d.ts +0 -17
- package/src/websocketgateway/parser/packets/packagedatamessage.d.ts +0 -16
- package/src/websocketgateway/parser/packets/packetmessage.d.ts +0 -31
- package/src/websocketgateway/parser/packets/packetoptionsmessage.d.ts +0 -18
- package/src/websocketgateway/parser/packets/stringbytespacketdatamessage.d.ts +0 -18
- package/src/websocketgateway/parser/packets/stringnumberpacketdatamessage.d.ts +0 -17
- package/src/websocketgateway/parser/packets/stringobjectpacketdatamessage.d.ts +0 -17
- package/src/websocketgateway/parser/packets/stringstringpacketdatamessage.d.ts +0 -17
- package/src/websocketgateway/parser/parser.d.ts +0 -14
- package/src/websocketgateway/parser/parserutils.d.ts +0 -27
- package/src/websocketgateway/requestsmanager.d.ts +0 -20
- package/src/websocketgateway/websocketgateway.d.ts +0 -164
|
@@ -20,4 +20,4 @@
|
|
|
20
20
|
*
|
|
21
21
|
*
|
|
22
22
|
*/
|
|
23
|
-
|
|
23
|
+
import _0x1aa5ea from'../ckeditorcloudserviceserror.js';class WebSocketRequest{constructor(_0x49d8d0,_0x3c9849){this['_context']=_0x49d8d0,this['_deferredPromise']=(function(){let _0xf51d17,_0x53deb7;const _0x191aea=new Promise((_0x414c7a,_0x54061c)=>{_0xf51d17=_0x414c7a,_0x53deb7=_0x54061c;});return{'resolve':_0xf51d17,'reject':_0x53deb7,'promise':_0x191aea};}()),this['timeout']=setTimeout(()=>this['error'](new _0x1aa5ea('Request\x20timeout.',this['_context'])),_0x3c9849);}get['promise'](){return this['_deferredPromise']['promise'];}['response'](_0x202d74){this['_deferredPromise']['resolve'](_0x202d74);}['error'](_0x5df469){this['_deferredPromise']['reject'](_0x5df469);}}export default class WebSocketGatewayRequestsManager{constructor(_0x4ee63d){this['_context']=_0x4ee63d,this['_requests']=new Set();}async['send'](_0x4207e9,_0x9347d=0xafc8){const _0x52913a=this['_createRequest'](_0x9347d);try{return _0x4207e9(_0x52913a),await _0x52913a['promise'];}finally{this['_finishRequest'](_0x52913a);}}['errorAll'](_0x155e65){for(const _0x559c68 of this['_requests'])_0x559c68['error'](_0x155e65);}['waitForAllRequests'](_0x3f0e97=0xafc8){return this['_waitForRequests'](_0x3f0e97);}['_createRequest'](_0x54553c){const _0x3f459d=new WebSocketRequest(this['_context'],_0x54553c);return this['_requests']['add'](_0x3f459d),_0x3f459d;}['_finishRequest'](_0x318822){this['_requests']['delete'](_0x318822),clearTimeout(_0x318822['timeout']);}async['_waitForRequests'](_0x32a977=0x1388,_0x12b9bc=0x0){return!this['_requests']['size']||_0x12b9bc>=_0x32a977/0x1f4?Promise['resolve']():(await new Promise(_0x1b00a2=>{setTimeout(_0x1b00a2,0x1f4);}),this['_waitForRequests'](_0x32a977,_0x12b9bc++));}}
|
|
@@ -20,4 +20,4 @@
|
|
|
20
20
|
*
|
|
21
21
|
*
|
|
22
22
|
*/
|
|
23
|
-
'use strict';var __importDefault=this&&this['__importDefault']||function(_0x5cb77a){return _0x5cb77a&&_0x5cb77a['__esModule']?_0x5cb77a:{'default':_0x5cb77a};};Object['defineProperty'](exports,'__esModule',{'value':!0x0}),exports['WEB_SOCKET_GATEWAY_STATES']=void 0x0;const socket_io_client_1=require('socket.io-client'),url_parse_1=__importDefault(require('url-parse')),utils_js_1=require('ckeditor5/src/utils.js'),channel_1=__importDefault(require('./channel')),user_1=__importDefault(require('./../users/user')),version_1=__importDefault(require('./../version')),ckeditorcloudserviceserror_1=__importDefault(require('./../ckeditorcloudserviceserror')),ckeditorcloudservicesservererror_1=__importDefault(require('./../ckeditorcloudservicesservererror')),parser_1=require('./parser/parser'),requestsmanager_1=__importDefault(require('./requestsmanager'));var WEB_SOCKET_GATEWAY_STATES;!function(_0x83e059){_0x83e059['DISCONNECTED']='disconnected',_0x83e059['CONNECTING']='connecting',_0x83e059['CONNECTED']='connected';}(WEB_SOCKET_GATEWAY_STATES=exports['WEB_SOCKET_GATEWAY_STATES']||(exports['WEB_SOCKET_GATEWAY_STATES']={}));class WebSocketGateway extends(0x0,utils_js_1['ObservableMixin'])(){constructor(_0x526ee6,_0x37cf04,_0x4f6689={},_0x397677=socket_io_client_1['io'],_0x3857a5=user_1['default']['get']){if(super(),this['_token']=_0x37cf04,this['_options']=_0x4f6689,this['_connectionProvider']=_0x397677,this['_userFactory']=_0x3857a5,this['_requestsManager']=new requestsmanager_1['default'](this),this['_channels']=new Map(),this['_connectionAttempt']=0x0,!_0x526ee6)throw new TypeError('Api\x20address\x20must\x20be\x20provided.');if(!this['_token'])throw new TypeError('Token\x20must\x20be\x20provided.');this['_options']['requestTimeout']||(this['_options']['requestTimeout']=0x4e20),this['_url']=(0x0,url_parse_1['default'])(_0x526ee6['replace'](/^(?!(?:\w+:)?\/\/)/,'https://')),this['set']('state',WEB_SOCKET_GATEWAY_STATES['DISCONNECTED']),this['set']('socketId',void 0x0),this['set']('me',void 0x0),this['on']('change:state',async(_0x27e252,_0x3503b7,_0x3a60ff)=>{var _0x3b1c1d;if(this['_debugEvent']('ws-gw:change:state',_0x3a60ff),_0x3a60ff!==WebSocketGateway['STATE_CONNECTED']){if(_0x3a60ff===WebSocketGateway['STATE_DISCONNECTED'])return this['_requestsManager']['errorAll'](new ckeditorcloudserviceserror_1['default']('Not\x20connected.',this));}else try{this['me']=await this['_userFactory']['call'](user_1['default'],this,null===(_0x3b1c1d=this['_socketAuth'])||void 0x0===_0x3b1c1d?void 0x0:_0x3b1c1d['userId']);}catch(_0xb8901c){}},{'priority':WebSocketGateway['_CHANGE_STATE_EVENT_PRIORITY']}),this['on']('error',(_0x1c6ea4,_0x1e1f29)=>{this['_options']['onError']?this['_options']['onError'](_0x1e1f29):console['error'](_0x1e1f29);});}get['sessionId'](){return this['socketId'];}['waitForAllRequests'](_0xd20bf7){return this['_requestsManager']['waitForAllRequests'](_0xd20bf7);}['disconnect'](){var _0xc4081;this['state']!==WEB_SOCKET_GATEWAY_STATES['DISCONNECTED']&&(null===(_0xc4081=this['_socket'])||void 0x0===_0xc4081||_0xc4081['disconnect'](),this['_socket']=void 0x0,this['state']=WEB_SOCKET_GATEWAY_STATES['DISCONNECTED']);}async['reconnect'](){this['_socket']||this['state']!==WEB_SOCKET_GATEWAY_STATES['DISCONNECTED']||(await this['_token']['refreshToken'](),await this['_connect']());}static async['connect'](_0x53b88f,_0xad93e5='local.cs.dev:443/ws-v2',_0x53fb34={},_0x2a54c5=socket_io_client_1['io'],_0x3511d6=user_1['default']['get']){const _0x4bd66d=new WebSocketGateway(_0xad93e5,_0x53b88f,_0x53fb34,_0x2a54c5,_0x3511d6);return await _0x4bd66d['_connect'](),_0x4bd66d;}['_sendRequest'](_0x314222,_0x234613,_0x106693){if(!_0x314222)throw new ckeditorcloudserviceserror_1['default']('`serviceName`\x20must\x20be\x20provided.',this);if(this['state']!==WebSocketGateway['STATE_CONNECTED'])throw new ckeditorcloudserviceserror_1['default']('Not\x20connected.',this);if(!this['_socketAuth']||!this['_socketAuth']['isAuthenticated'])throw new ckeditorcloudserviceserror_1['default']('Not\x20authenticated.',this);const _0x3792b2=new ArrayBuffer(_0x106693['length']+0x2),_0x4e500c=new Uint8Array(_0x3792b2);return _0x4e500c[0x0]=_0x314222,_0x4e500c[0x1]=parseInt(_0x234613),_0x4e500c['set'](_0x106693,0x2),this['_emit'](0x1,_0x4e500c);}['_getChannel'](_0xeab9db,_0x1feefd){const _0x1bad5f=''+_0xeab9db+_0x1feefd;return!this['_channels']['has'](_0x1bad5f)&&this['_socket']&&this['_channels']['set'](_0x1bad5f,new channel_1['default'](_0x1bad5f,this,this['_socket'])),this['_channels']['get'](_0x1bad5f);}['_connect'](){return new Promise((_0x1299d5,_0x56d29d)=>{const _0x3a66d5=this['_setupSocket']();!this['socketId']&&_0x3a66d5['io']['on']('reconnect_error',()=>{this['_debugEvent']('reconnect_error'),this['_reconnectionAttemptError'](_0x56d29d);}),_0x3a66d5['once']('connect',async()=>{this['_debugEvent']('once-connect');try{await this['_onConnect'](),_0x1299d5();}catch(_0x3c7587){_0x56d29d(_0x3c7587);}}),_0x3a66d5['connect']();});}['_getPortByProtocol'](_0x1b583c){return['http:','ws:']['includes'](_0x1b583c)?0x50:0x1bb;}['_setupSocket'](){var _0x7fb2d1;if(this['_socket'])return this['_socket'];const _0x2d859e=this['_url']['port']||this['_getPortByProtocol'](this['_url']['protocol']),_0x44c0fb=(this['_url']['protocol']||'https:')+'//'+this['_url']['hostname']+':'+_0x2d859e,_0x10b966=this['_url']['pathname']['match'](/^\/.*\/ws/)?this['_url']['pathname']['split']('/ws')[0x0]:'',_0x633c8e=this['_connectionProvider'](_0x44c0fb,{'parser':{'Encoder':parser_1['Encoder'],'Decoder':parser_1['Decoder']},'path':_0x10b966+'/ws-v2/ws','transports':['websocket'],'timeout':void 0x0!==this['_options']['timeout']?this['_options']['timeout']:0x1388,'reconnection':void 0x0===this['_options']['autoReconnect']||this['_options']['autoReconnect'],'reconnectionDelay':0x3e8,'reconnectionDelayMax':0x1388,'rejectUnauthorized':void 0x0===this['_options']['rejectUnauthorized']||this['_options']['rejectUnauthorized'],'query':{'version':version_1['default']},'agent':null!==(_0x7fb2d1=this['_options']['agent'])&&void 0x0!==_0x7fb2d1&&_0x7fb2d1,'closeOnBeforeunload':!0x1});return this['state']=WEB_SOCKET_GATEWAY_STATES['CONNECTING'],_0x633c8e['on']('connect',()=>{this['_debugEvent']('connect'),this['socketId']=_0x633c8e['id'];}),_0x633c8e['on']('connect_error',_0x179401=>{this['_debugEvent']('connect_error',_0x179401);}),_0x633c8e['on']('disconnect',()=>{this['_debugEvent']('disconnect'),this['_onDisconnect']();}),_0x633c8e['io']['on']('reconnect',async()=>{this['_debugEvent']('reconnect'),await this['_onReconnect']();}),_0x633c8e['io']['on']('reconnect_attempt',_0x1c9b59=>{this['_debugEvent']('reconnect_attempt',_0x1c9b59),this['state']=WEB_SOCKET_GATEWAY_STATES['CONNECTING'],this['_connectionAttempt']=_0x1c9b59;}),_0x633c8e['on']('unauthorized',_0x2ca4c8=>{this['_debugEvent']('unauthorized'),this['_onUnauthorized'](_0x2ca4c8);}),_0x633c8e['on']('authenticationRequest',async _0x4e81d5=>{this['_debugEvent']('authenticationRequest',_0x4e81d5['attempt']),await this['_onReconnect']();}),this['_socket']=_0x633c8e,_0x633c8e;}['_emit'](_0x20da12,_0x4f7bb3){const _0x2ef574=this['_socket'];return this['_requestsManager']['send'](_0x34721c=>{_0x2ef574['emit'](_0x20da12,_0x4f7bb3,(_0x5f3590,_0x54f83f)=>{if(_0x5f3590)return _0x34721c['error'](ckeditorcloudservicesservererror_1['default']['fromPublicError'](_0x5f3590));_0x34721c['response'](_0x54f83f);});},this['_options']['requestTimeout']);}['_addAuthData'](_0x139ca6,_0x5c32df){this['_socketAuth']={'environmentId':_0x139ca6,'userId':_0x5c32df,'isAuthenticated':!0x0};}['_removeAuthData'](){this['_socketAuth']=void 0x0;}async['_onConnect'](){await this['_authenticate'](this['_token']['value']),this['state']=WEB_SOCKET_GATEWAY_STATES['CONNECTED'];const _0x16342c=async(_0x17caa3,_0x486bf8,_0x349f21)=>{this['_debugEvent']('token:value:change');try{await this['_authenticate'](_0x349f21);}catch(_0x2cb832){}};this['_token']['on']('change:value',_0x16342c),this['_socket']['io']['off']('reconnect_error'),this['on']('disconnect',()=>{this['_token']['off']('change:value',_0x16342c);});}async['_onReconnect'](){await this['_token']['refreshToken'](),await this['_onConnect']();}['_onDisconnect'](){this['state']=WEB_SOCKET_GATEWAY_STATES['DISCONNECTED'],this['_connectionAttempt']=0x0,this['fire']('disconnect');for(const _0x5a9796 of this['_channels']['values']())_0x5a9796['remove']();this['_channels']['clear'](),void 0x0===this['_options']['autoReconnect']||this['_options']['autoReconnect']||(this['_socket']=void 0x0);}['_debugEvent'](_0x143b9b,_0x37d921){if(!this['_isDebugModeEnabled']())return;const _0x40fe8e=void 0x0!==_0x37d921?',\x20data:\x20'+_0x37d921:'';console['info'](new Date()['toLocaleString']()+'\x20'+_0x143b9b+_0x40fe8e);}['_reconnectionAttemptError'](_0x2bc841){this['_connectionAttempt']>=0x2&&(this['disconnect'](),_0x2bc841(ckeditorcloudserviceserror_1['default']['fromPublicError']({'message':'The\x20number\x20of\x20initial\x20connection\x20attempts\x20exceeded.','explanation':'Three\x20initial\x20connection\x20attempts\x20failed.\x20It\x20can\x20be\x20caused\x20by\x20a\x20slow,\x20unstable,\x20missing\x20or\x20blocked\x20Internet\x20connection.','action':'Please\x20verify\x20the\x20stability\x20of\x20your\x20Internet\x20connection\x20and\x20ensure\x20that\x20no\x20antivirus\x20or\x20firewall\x20software\x20blocks\x20the\x20Web\x20Socket\x20protocol\x20connections.'})));}['_onUnauthorized']({error:_0x5cabf9}){this['_removeAuthData'](),this['fire']('error',ckeditorcloudservicesservererror_1['default']['fromPublicError'](_0x5cabf9));}async['_authenticate'](_0x44b590){try{this['_debugEvent']('authenticate:start');const _0x9e5b0c=await this['_emit'](0x2,{'token':_0x44b590});this['_debugEvent']('authenticate:success','envId:\x20'+_0x9e5b0c['environmentId']+',\x20userId:\x20'+_0x9e5b0c['userId']),this['_addAuthData'](_0x9e5b0c['environmentId'],_0x9e5b0c['userId']);}catch(_0x35935f){throw this['_debugEvent']('authenticate:error',_0x35935f['message']),this['_removeAuthData'](),_0x35935f;}}['_isDebugModeEnabled'](){var _0x52d24d;if(!utils_js_1['global']['window']['localStorage'])return!0x1;return'true'===(null!==(_0x52d24d=utils_js_1['global']['window']['localStorage']['getItem']('csClientDebugMode'))&&void 0x0!==_0x52d24d?_0x52d24d:'false')['toLowerCase']();}}WebSocketGateway['STATE_DISCONNECTED']=WEB_SOCKET_GATEWAY_STATES['DISCONNECTED'],WebSocketGateway['STATE_CONNECTING']=WEB_SOCKET_GATEWAY_STATES['CONNECTING'],WebSocketGateway['STATE_CONNECTED']=WEB_SOCKET_GATEWAY_STATES['CONNECTED'],WebSocketGateway['_CHANGE_STATE_EVENT_PRIORITY']=utils_js_1['priorities']['get']('highest')+0xf423f,exports['default']=WebSocketGateway;
|
|
23
|
+
import{io}from'socket.io-client';import _0x19f939 from'url-parse';import{ObservableMixin,priorities,global}from'ckeditor5/src/utils.js';import _0x5e8af6 from'./channel.js';import _0x3ce454 from'./../users/user.js';import _0x120e64 from'./../version.js';import _0x357a18 from'./../ckeditorcloudserviceserror.js';import _0x4064d5 from'./../ckeditorcloudservicesservererror.js';import{Encoder,Decoder}from'./parser/parser.js';import _0x10e78d from'./requestsmanager.js';export var WEB_SOCKET_GATEWAY_STATES;!function(_0x46e47e){_0x46e47e['DISCONNECTED']='disconnected',_0x46e47e['CONNECTING']='connecting',_0x46e47e['CONNECTED']='connected';}(WEB_SOCKET_GATEWAY_STATES||(WEB_SOCKET_GATEWAY_STATES={}));class WebSocketGateway extends ObservableMixin(){constructor(_0x2607ee,_0x588f8f,_0x197bd8={},_0x44b004=io,_0xae187c=_0x3ce454['get']){if(super(),this['_token']=_0x588f8f,this['_options']=_0x197bd8,this['_connectionProvider']=_0x44b004,this['_userFactory']=_0xae187c,this['_requestsManager']=new _0x10e78d(this),this['_channels']=new Map(),this['_connectionAttempt']=0x0,!_0x2607ee)throw new TypeError('Api\x20address\x20must\x20be\x20provided.');if(!this['_token'])throw new TypeError('Token\x20must\x20be\x20provided.');this['_options']['requestTimeout']||(this['_options']['requestTimeout']=0x4e20),this['_url']=_0x19f939(_0x2607ee['replace'](/^(?!(?:\w+:)?\/\/)/,'https://')),this['set']('state',WEB_SOCKET_GATEWAY_STATES['DISCONNECTED']),this['set']('socketId',void 0x0),this['set']('me',void 0x0),this['on']('change:state',async(_0x4537f0,_0x550c80,_0x142bc2)=>{var _0x5b09dc;if(this['_debugEvent']('ws-gw:change:state',_0x142bc2),_0x142bc2!==WebSocketGateway['STATE_CONNECTED']){if(_0x142bc2===WebSocketGateway['STATE_DISCONNECTED'])return this['_requestsManager']['errorAll'](new _0x357a18('Not\x20connected.',this));}else try{this['me']=await this['_userFactory']['call'](_0x3ce454,this,null===(_0x5b09dc=this['_socketAuth'])||void 0x0===_0x5b09dc?void 0x0:_0x5b09dc['userId']);}catch(_0x2168be){}},{'priority':WebSocketGateway['_CHANGE_STATE_EVENT_PRIORITY']}),this['on']('error',(_0x333548,_0x1a17e2)=>{this['_options']['onError']?this['_options']['onError'](_0x1a17e2):console['error'](_0x1a17e2);});}get['sessionId'](){return this['socketId'];}['waitForAllRequests'](_0x293a8a){return this['_requestsManager']['waitForAllRequests'](_0x293a8a);}['disconnect'](){var _0x35d1c4;this['state']!==WEB_SOCKET_GATEWAY_STATES['DISCONNECTED']&&(null===(_0x35d1c4=this['_socket'])||void 0x0===_0x35d1c4||_0x35d1c4['disconnect'](),this['_socket']=void 0x0,this['state']=WEB_SOCKET_GATEWAY_STATES['DISCONNECTED']);}async['reconnect'](){this['_socket']||this['state']!==WEB_SOCKET_GATEWAY_STATES['DISCONNECTED']||(await this['_token']['refreshToken'](),await this['_connect']());}static async['connect'](_0x273f82,_0x5e2ab1='local.cs.dev:443/ws-v2',_0x23facf={},_0x407d91=io,_0x45649d=_0x3ce454['get']){const _0xaafd0f=new WebSocketGateway(_0x5e2ab1,_0x273f82,_0x23facf,_0x407d91,_0x45649d);return await _0xaafd0f['_connect'](),_0xaafd0f;}['_sendRequest'](_0x12c327,_0xf6361a,_0x22f6d7){if(!_0x12c327)throw new _0x357a18('`serviceName`\x20must\x20be\x20provided.',this);if(this['state']!==WebSocketGateway['STATE_CONNECTED'])throw new _0x357a18('Not\x20connected.',this);if(!this['_socketAuth']||!this['_socketAuth']['isAuthenticated'])throw new _0x357a18('Not\x20authenticated.',this);const _0x312826=new ArrayBuffer(_0x22f6d7['length']+0x2),_0xcf3acc=new Uint8Array(_0x312826);return _0xcf3acc[0x0]=_0x12c327,_0xcf3acc[0x1]=parseInt(_0xf6361a),_0xcf3acc['set'](_0x22f6d7,0x2),this['_emit'](0x1,_0xcf3acc);}['_getChannel'](_0x5a9ec9,_0x509504){const _0x4d1f02=''+_0x5a9ec9+_0x509504;return!this['_channels']['has'](_0x4d1f02)&&this['_socket']&&this['_channels']['set'](_0x4d1f02,new _0x5e8af6(_0x4d1f02,this,this['_socket'])),this['_channels']['get'](_0x4d1f02);}['_connect'](){return new Promise((_0x5465ce,_0x27d3e6)=>{const _0x3b4bbe=this['_setupSocket']();!this['socketId']&&_0x3b4bbe['io']['on']('reconnect_error',()=>{this['_debugEvent']('reconnect_error'),this['_reconnectionAttemptError'](_0x27d3e6);}),_0x3b4bbe['once']('connect',async()=>{this['_debugEvent']('once-connect');try{await this['_onConnect'](),_0x5465ce();}catch(_0x70cdc){_0x27d3e6(_0x70cdc);}}),_0x3b4bbe['connect']();});}['_getPortByProtocol'](_0x34ada5){return['http:','ws:']['includes'](_0x34ada5)?0x50:0x1bb;}['_setupSocket'](){var _0x3a34dd;if(this['_socket'])return this['_socket'];const _0x33fdaf=this['_url']['port']||this['_getPortByProtocol'](this['_url']['protocol']),_0x131557=(this['_url']['protocol']||'https:')+'//'+this['_url']['hostname']+':'+_0x33fdaf,_0x36d0ca=this['_url']['pathname']['match'](/^\/.*\/ws/)?this['_url']['pathname']['split']('/ws')[0x0]:'',_0x1e87bb=this['_connectionProvider'](_0x131557,{'parser':{'Encoder':Encoder,'Decoder':Decoder},'path':_0x36d0ca+'/ws-v2/ws','transports':['websocket'],'timeout':void 0x0!==this['_options']['timeout']?this['_options']['timeout']:0x1388,'reconnection':void 0x0===this['_options']['autoReconnect']||this['_options']['autoReconnect'],'reconnectionDelay':0x3e8,'reconnectionDelayMax':0x1388,'rejectUnauthorized':void 0x0===this['_options']['rejectUnauthorized']||this['_options']['rejectUnauthorized'],'query':{'version':_0x120e64},'agent':null!==(_0x3a34dd=this['_options']['agent'])&&void 0x0!==_0x3a34dd&&_0x3a34dd,'closeOnBeforeunload':!0x1});return this['state']=WEB_SOCKET_GATEWAY_STATES['CONNECTING'],_0x1e87bb['on']('connect',()=>{this['_debugEvent']('connect'),this['socketId']=_0x1e87bb['id'];}),_0x1e87bb['on']('connect_error',_0x54c2f3=>{this['_debugEvent']('connect_error',_0x54c2f3);}),_0x1e87bb['on']('disconnect',()=>{this['_debugEvent']('disconnect'),this['_onDisconnect']();}),_0x1e87bb['io']['on']('reconnect',async()=>{this['_debugEvent']('reconnect'),await this['_onReconnect']();}),_0x1e87bb['io']['on']('reconnect_attempt',_0x4c0c59=>{this['_debugEvent']('reconnect_attempt',_0x4c0c59),this['state']=WEB_SOCKET_GATEWAY_STATES['CONNECTING'],this['_connectionAttempt']=_0x4c0c59;}),_0x1e87bb['on']('unauthorized',_0x2917e5=>{this['_debugEvent']('unauthorized'),this['_onUnauthorized'](_0x2917e5);}),_0x1e87bb['on']('authenticationRequest',async _0x3ba0c7=>{this['_debugEvent']('authenticationRequest',_0x3ba0c7['attempt']),await this['_onReconnect']();}),this['_socket']=_0x1e87bb,_0x1e87bb;}['_emit'](_0x23951d,_0x397f66){const _0x552968=this['_socket'];return this['_requestsManager']['send'](_0x581715=>{_0x552968['emit'](_0x23951d,_0x397f66,(_0x5f3df4,_0x3e8bc1)=>{if(_0x5f3df4)return _0x581715['error'](_0x4064d5['fromPublicError'](_0x5f3df4));_0x581715['response'](_0x3e8bc1);});},this['_options']['requestTimeout']);}['_addAuthData'](_0x17c1b5,_0x5230be){this['_socketAuth']={'environmentId':_0x17c1b5,'userId':_0x5230be,'isAuthenticated':!0x0};}['_removeAuthData'](){this['_socketAuth']=void 0x0;}async['_onConnect'](){await this['_authenticate'](this['_token']['value']),this['state']=WEB_SOCKET_GATEWAY_STATES['CONNECTED'];const _0x3360db=async(_0x92bc6d,_0x2a2a12,_0x5494db)=>{this['_debugEvent']('token:value:change');try{await this['_authenticate'](_0x5494db);}catch(_0x51a652){}};this['_token']['on']('change:value',_0x3360db),this['_socket']['io']['off']('reconnect_error'),this['on']('disconnect',()=>{this['_token']['off']('change:value',_0x3360db);});}async['_onReconnect'](){await this['_token']['refreshToken'](),await this['_onConnect']();}['_onDisconnect'](){this['state']=WEB_SOCKET_GATEWAY_STATES['DISCONNECTED'],this['_connectionAttempt']=0x0,this['fire']('disconnect');for(const _0x4c0dbc of this['_channels']['values']())_0x4c0dbc['remove']();this['_channels']['clear'](),void 0x0===this['_options']['autoReconnect']||this['_options']['autoReconnect']||(this['_socket']=void 0x0);}['_debugEvent'](_0x30723e,_0x2ed1e0){if(!this['_isDebugModeEnabled']())return;const _0x16adca=void 0x0!==_0x2ed1e0?',\x20data:\x20'+_0x2ed1e0:'';console['info'](new Date()['toLocaleString']()+'\x20'+_0x30723e+_0x16adca);}['_reconnectionAttemptError'](_0x34234f){this['_connectionAttempt']>=0x2&&(this['disconnect'](),_0x34234f(_0x357a18['fromPublicError']({'message':'The\x20number\x20of\x20initial\x20connection\x20attempts\x20exceeded.','explanation':'Three\x20initial\x20connection\x20attempts\x20failed.\x20It\x20can\x20be\x20caused\x20by\x20a\x20slow,\x20unstable,\x20missing\x20or\x20blocked\x20Internet\x20connection.','action':'Please\x20verify\x20the\x20stability\x20of\x20your\x20Internet\x20connection\x20and\x20ensure\x20that\x20no\x20antivirus\x20or\x20firewall\x20software\x20blocks\x20the\x20Web\x20Socket\x20protocol\x20connections.'})));}['_onUnauthorized']({error:_0xcebe37}){this['_removeAuthData'](),this['fire']('error',_0x4064d5['fromPublicError'](_0xcebe37));}async['_authenticate'](_0x4d9aff){try{this['_debugEvent']('authenticate:start');const _0x144aac=await this['_emit'](0x2,{'token':_0x4d9aff});this['_debugEvent']('authenticate:success','envId:\x20'+_0x144aac['environmentId']+',\x20userId:\x20'+_0x144aac['userId']),this['_addAuthData'](_0x144aac['environmentId'],_0x144aac['userId']);}catch(_0x12400b){throw this['_debugEvent']('authenticate:error',_0x12400b['message']),this['_removeAuthData'](),_0x12400b;}}['_isDebugModeEnabled'](){var _0x27bcaa;if(!global['window']['localStorage'])return!0x1;return'true'===(null!==(_0x27bcaa=global['window']['localStorage']['getItem']('csClientDebugMode'))&&void 0x0!==_0x27bcaa?_0x27bcaa:'false')['toLowerCase']();}}WebSocketGateway['STATE_DISCONNECTED']=WEB_SOCKET_GATEWAY_STATES['DISCONNECTED'],WebSocketGateway['STATE_CONNECTING']=WEB_SOCKET_GATEWAY_STATES['CONNECTING'],WebSocketGateway['STATE_CONNECTED']=WEB_SOCKET_GATEWAY_STATES['CONNECTED'],WebSocketGateway['_CHANGE_STATE_EVENT_PRIORITY']=priorities['get']('highest')+0xf423f;export default WebSocketGateway;
|
|
@@ -1,8 +0,0 @@
|
|
|
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
|
-
}
|
|
@@ -1,15 +0,0 @@
|
|
|
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
|
-
}
|
|
@@ -1,127 +0,0 @@
|
|
|
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;
|
|
@@ -1,18 +0,0 @@
|
|
|
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 {};
|
|
@@ -1,11 +0,0 @@
|
|
|
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
|
-
}
|
|
@@ -1,24 +0,0 @@
|
|
|
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
|
-
}
|
|
@@ -1,19 +0,0 @@
|
|
|
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
|
-
}
|
|
@@ -1,38 +0,0 @@
|
|
|
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 {};
|
|
@@ -1,16 +0,0 @@
|
|
|
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
|
-
}
|
|
@@ -1,68 +0,0 @@
|
|
|
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 {};
|
|
@@ -1,51 +0,0 @@
|
|
|
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 {};
|
|
@@ -1,28 +0,0 @@
|
|
|
1
|
-
import { IDescriptorBody } from '../../descriptor';
|
|
2
|
-
import Message, { IMessage } from './../../message';
|
|
3
|
-
export interface IGetDocumentDetailsResponse extends IMessage {
|
|
4
|
-
lastDocumentSessionId?: string;
|
|
5
|
-
lastDocumentSessionOperationId?: string;
|
|
6
|
-
currentDocumentSessionId?: string;
|
|
7
|
-
currentDocumentSessionVersion?: number;
|
|
8
|
-
currentDocumentSessionOperationId?: string;
|
|
9
|
-
}
|
|
10
|
-
export interface ICurrentDocumentSession {
|
|
11
|
-
lastOperationId?: string;
|
|
12
|
-
version?: number;
|
|
13
|
-
id?: string;
|
|
14
|
-
}
|
|
15
|
-
export interface ILastDocumentSession {
|
|
16
|
-
id?: string;
|
|
17
|
-
lastOperationId?: string;
|
|
18
|
-
}
|
|
19
|
-
export default class GetDocumentDetailsResponse extends Message {
|
|
20
|
-
readonly lastDocumentSession?: ILastDocumentSession | undefined;
|
|
21
|
-
readonly currentDocumentSession?: ICurrentDocumentSession | undefined;
|
|
22
|
-
static readonly DESCRIPTOR_NAME: string;
|
|
23
|
-
static readonly DESCRIPTOR: IDescriptorBody;
|
|
24
|
-
constructor(lastDocumentSession?: ILastDocumentSession | undefined, currentDocumentSession?: ICurrentDocumentSession | undefined);
|
|
25
|
-
get data(): IGetDocumentDetailsResponse;
|
|
26
|
-
toJSON(): IGetDocumentDetailsResponse;
|
|
27
|
-
static fromJSON(data: IGetDocumentDetailsResponse): GetDocumentDetailsResponse;
|
|
28
|
-
}
|
|
@@ -1,72 +0,0 @@
|
|
|
1
|
-
import AddCommentResponse from './responses/addcommentresponse';
|
|
2
|
-
import { IWebSocketGateway } from './../websocketgateway/websocketgateway';
|
|
3
|
-
import { IThread } from './descriptors/commentsthreaddescriptor';
|
|
4
|
-
import SessionCollection from '../sessions/sessioncollection';
|
|
5
|
-
import { IComment } from './descriptors/commentdescriptor';
|
|
6
|
-
import AddCommentThreadResponse from './responses/comment-threads/addcommentthreadresponse';
|
|
7
|
-
import ResolveCommentThreadResponse from './responses/comment-threads/resolvecommentthreadresponse';
|
|
8
|
-
export declare const _SERVICE: number;
|
|
9
|
-
export interface IAddCommentThreadParams {
|
|
10
|
-
commentThreadId: string;
|
|
11
|
-
context?: Record<string, unknown> | null;
|
|
12
|
-
comments?: IComment[];
|
|
13
|
-
resolvedAt?: Date | string | null;
|
|
14
|
-
createdAt?: Date | string | null;
|
|
15
|
-
resolvedBy?: string | null;
|
|
16
|
-
deletedAt?: Date | null | string;
|
|
17
|
-
attributes?: Record<string, unknown> | null;
|
|
18
|
-
}
|
|
19
|
-
export interface IUpdateCommentThreadParams {
|
|
20
|
-
commentThreadId: string;
|
|
21
|
-
context?: Record<string, unknown> | null;
|
|
22
|
-
attributes?: Record<string, unknown> | null;
|
|
23
|
-
unlinkedAt?: Date | null | string;
|
|
24
|
-
}
|
|
25
|
-
declare const CommentsService_base: {
|
|
26
|
-
new (): import("ckeditor5/src/utils").Emitter;
|
|
27
|
-
prototype: import("ckeditor5/src/utils").Emitter;
|
|
28
|
-
};
|
|
29
|
-
declare class CommentsService extends CommentsService_base {
|
|
30
|
-
private readonly _documentId;
|
|
31
|
-
private _isConnected;
|
|
32
|
-
private _wsGateway?;
|
|
33
|
-
private _channel?;
|
|
34
|
-
private _connectedSessions?;
|
|
35
|
-
private static readonly _SERVICE;
|
|
36
|
-
constructor(_documentId: string);
|
|
37
|
-
get isConnected(): boolean;
|
|
38
|
-
/**
|
|
39
|
-
* Connects to WebSocketGateway and starts listening on channel.
|
|
40
|
-
*/
|
|
41
|
-
connect(wsGateway: IWebSocketGateway): Promise<IThread[] | void>;
|
|
42
|
-
/**
|
|
43
|
-
* Disconnects CommentsService from CKEditor Cloud Services.
|
|
44
|
-
*/
|
|
45
|
-
disconnect(): void;
|
|
46
|
-
addComment(commentThreadId: string, commentId: string, content: string, attributes?: Record<string, unknown>): Promise<AddCommentResponse>;
|
|
47
|
-
updateComment(commentThreadId: string, commentId: string, content: string, attributes?: Record<string, unknown>): Promise<void>;
|
|
48
|
-
removeComment(commentThreadId: string, commentId: string): Promise<void>;
|
|
49
|
-
removeCommentThread(commentThreadId: string): Promise<void>;
|
|
50
|
-
addCommentThread(addCommentThreadParams: IAddCommentThreadParams): Promise<AddCommentThreadResponse>;
|
|
51
|
-
resolveCommentThread(commentThreadId: string): Promise<ResolveCommentThreadResponse>;
|
|
52
|
-
reopenCommentThread(commentThreadId: string): Promise<void>;
|
|
53
|
-
updateCommentThread(params: IUpdateCommentThreadParams): Promise<void>;
|
|
54
|
-
getCommentThread(commentThreadId: string, attempt?: number): Promise<IThread>;
|
|
55
|
-
getDocumentThreads(): Promise<{
|
|
56
|
-
threads: IThread[];
|
|
57
|
-
}>;
|
|
58
|
-
/**
|
|
59
|
-
* Returns read-only observable collection with EndUsers Sessions for comments service.
|
|
60
|
-
*/
|
|
61
|
-
getConnectedSessions(): Promise<SessionCollection>;
|
|
62
|
-
/**
|
|
63
|
-
* Starts to listen on a given channel.
|
|
64
|
-
*/
|
|
65
|
-
private _connectToChannel;
|
|
66
|
-
/**
|
|
67
|
-
* Processes websocket gateway state changes.
|
|
68
|
-
*/
|
|
69
|
-
private _onWsGatewayStateChange;
|
|
70
|
-
private _sendRequest;
|
|
71
|
-
}
|
|
72
|
-
export default CommentsService;
|
|
@@ -1,23 +0,0 @@
|
|
|
1
|
-
import Descriptor, { IDescriptorBody } from './../../descriptor';
|
|
2
|
-
interface ICommonComment {
|
|
3
|
-
commentId: string;
|
|
4
|
-
commentThreadId: string;
|
|
5
|
-
userId: string;
|
|
6
|
-
content: string;
|
|
7
|
-
documentId: string;
|
|
8
|
-
}
|
|
9
|
-
export interface ICommentJSON extends ICommonComment {
|
|
10
|
-
createdAt: string;
|
|
11
|
-
attributes: string | null;
|
|
12
|
-
}
|
|
13
|
-
export interface IComment extends ICommonComment {
|
|
14
|
-
createdAt: Date;
|
|
15
|
-
attributes: Record<string, unknown> | null;
|
|
16
|
-
}
|
|
17
|
-
export default class CommentDescriptor extends Descriptor {
|
|
18
|
-
static readonly DESCRIPTOR_NAME: string;
|
|
19
|
-
static readonly DESCRIPTOR: IDescriptorBody;
|
|
20
|
-
static toJSON(comment: IComment): ICommentJSON;
|
|
21
|
-
static fromJSON(comment: ICommentJSON): IComment;
|
|
22
|
-
}
|
|
23
|
-
export {};
|
|
@@ -1,31 +0,0 @@
|
|
|
1
|
-
import Descriptor, { IDescriptorBody } from './../../descriptor';
|
|
2
|
-
import { IComment, ICommentJSON } from './commentdescriptor';
|
|
3
|
-
interface ICommonThread {
|
|
4
|
-
commentThreadId: string;
|
|
5
|
-
resolvedBy?: string | null;
|
|
6
|
-
}
|
|
7
|
-
export interface IThreadJSON extends ICommonThread {
|
|
8
|
-
comments?: ICommentJSON[];
|
|
9
|
-
attributes?: string | null;
|
|
10
|
-
createdAt?: string;
|
|
11
|
-
deletedAt?: string | null;
|
|
12
|
-
resolvedAt?: string | null;
|
|
13
|
-
context?: string | null;
|
|
14
|
-
unlinkedAt?: string | null;
|
|
15
|
-
}
|
|
16
|
-
export interface IThread extends ICommonThread {
|
|
17
|
-
comments?: IComment[];
|
|
18
|
-
createdAt?: Date;
|
|
19
|
-
deletedAt?: Date | null;
|
|
20
|
-
resolvedAt?: Date | null;
|
|
21
|
-
attributes?: Record<string, unknown> | null;
|
|
22
|
-
context?: Record<string, unknown> | null;
|
|
23
|
-
unlinkedAt?: Date | null;
|
|
24
|
-
}
|
|
25
|
-
export default class CommentsThreadDescriptor extends Descriptor {
|
|
26
|
-
static readonly DESCRIPTOR_NAME: string;
|
|
27
|
-
static readonly DESCRIPTOR: IDescriptorBody;
|
|
28
|
-
static toJSON(thread: IThread): IThreadJSON;
|
|
29
|
-
static fromJSON(thread: IThreadJSON): IThread;
|
|
30
|
-
}
|
|
31
|
-
export {};
|