@textbus/collaborate 4.0.0-alpha.74 → 4.0.0

package/bundles/collaborate-module.d.ts

@@ -1,14 +1,16 @@
 import { Module, Textbus } from '@textbus/core';
 import { Provider } from '@viewfly/core';
+import { Doc as YDoc } from 'yjs';
 import { UserInfo } from './user-activity';
+import { SyncConnector } from './sync-connector';
 export interface CollaborateConfig {
-    url: string;
-    roomName: string;
     userinfo: UserInfo;
+    createConnector(yDoc: YDoc): SyncConnector;
 }
 export declare class CollaborateModule implements Module {
     config: CollaborateConfig;
     providers: Provider[];
     constructor(config: CollaborateConfig);
     setup(textbus: Textbus): Promise<(() => void) | void> | (() => void) | void;
+    onDestroy(textbus: Textbus): void;
 }

package/bundles/connectors/_api.d.ts

@@ -0,0 +1,2 @@
+export * from './hocuspocus-connector';
+export * from './y-websocket-connector';

package/bundles/connectors/hocuspocus-connector.d.ts

@@ -0,0 +1,13 @@
+import { Observable } from '@tanbo/stream';
+import { HocuspocusProviderConfiguration } from '@hocuspocus/provider';
+import { SyncConnector } from '../sync-connector';
+export declare class HocuspocusConnector extends SyncConnector {
+    onLoad: Observable<void>;
+    onStateChange: Observable<any>;
+    private loadEvent;
+    private stateChangeEvent;
+    private provide;
+    constructor(config: HocuspocusProviderConfiguration);
+    setLocalStateField(key: string, data: Record<string, any>): void;
+    onDestroy(): void;
+}

package/bundles/connectors/y-websocket-connector.d.ts

@@ -0,0 +1,13 @@
+import { Doc as YDoc } from 'yjs';
+import { Observable } from '@tanbo/stream';
+import { SyncConnector } from '../sync-connector';
+export declare class YWebsocketConnector extends SyncConnector {
+    onLoad: Observable<void>;
+    onStateChange: Observable<any>;
+    private provide;
+    private loadEvent;
+    private stateChangeEvent;
+    constructor(url: string, roomName: string, yDoc: YDoc);
+    setLocalStateField(key: string, data: Record<string, any>): void;
+    onDestroy(): void;
+}

package/bundles/index.esm.js

@@ -1,8 +1,70 @@
-import { Injectable, Inject, Optional } from '@viewfly/core';
 import { Subject, map, filter, Subscription } from '@tanbo/stream';
+import { HocuspocusProvider } from '@hocuspocus/provider';
+import { WebsocketProvider } from 'y-websocket';
+import { Injectable, Inject, Optional } from '@viewfly/core';
 import { makeError, HISTORY_STACK_SIZE, ChangeOrigin, createObjectProxy, createArrayProxy, Slot, RootComponentRef, Scheduler, Registry, Selection, History } from '@textbus/core';
 import { Doc, UndoManager, Map, Array as Array$1, Text, createAbsolutePositionFromRelativePosition, createRelativePositionFromTypeIndex } from 'yjs';
-import { WebsocketProvider } from 'y-websocket';
+
+/**
+ * 协作通信通用接口
+ */
+class SyncConnector {
+}
+
+class HocuspocusConnector extends SyncConnector {
+    constructor(config) {
+        super();
+        this.loadEvent = new Subject();
+        this.stateChangeEvent = new Subject();
+        this.onLoad = this.loadEvent.asObservable();
+        this.onStateChange = this.stateChangeEvent.asObservable();
+        this.provide = new HocuspocusProvider(Object.assign(Object.assign({}, config), { onSynced: (data) => {
+                var _a;
+                (_a = config.onSynced) === null || _a === void 0 ? void 0 : _a.call(config, data);
+                this.loadEvent.next();
+            }, onAwarenessUpdate: (data) => {
+                var _a;
+                (_a = config.onAwarenessUpdate) === null || _a === void 0 ? void 0 : _a.call(config, data);
+                data.states.forEach(state => {
+                    this.stateChangeEvent.next(state);
+                });
+            } }));
+    }
+    setLocalStateField(key, data) {
+        this.provide.setAwarenessField(key, data);
+    }
+    onDestroy() {
+        this.provide.disconnect();
+        this.provide.destroy();
+    }
+}
+
+class YWebsocketConnector extends SyncConnector {
+    constructor(url, roomName, yDoc) {
+        super();
+        this.loadEvent = new Subject();
+        this.stateChangeEvent = new Subject();
+        this.onLoad = this.loadEvent.asObservable();
+        this.onStateChange = this.stateChangeEvent.asObservable();
+        this.provide = new WebsocketProvider(url, roomName, yDoc);
+        this.provide.on('sync', (is) => {
+            if (is) {
+                this.loadEvent.next();
+            }
+        });
+        this.provide.awareness.on('update', () => {
+            this.provide.awareness.getStates().forEach(state => {
+                this.stateChangeEvent.next(state);
+            });
+        });
+    }
+    setLocalStateField(key, data) {
+        this.provide.awareness.setLocalStateField(key, data);
+    }
+    onDestroy() {
+        this.provide.disconnect();
+    }
+}
 
 /******************************************************************************
 Copyright (c) Microsoft Corporation.
@@ -737,8 +799,8 @@ function remoteFormatsToLocal(registry, attrs) {
 }
 
 let UserActivity = class UserActivity {
-    constructor(websocketProvider, selection) {
-        this.websocketProvider = websocketProvider;
+    constructor(syncConnector, selection) {
+        this.syncConnector = syncConnector;
         this.selection = selection;
         this.stateChangeEvent = new Subject();
         this.userChangeEvent = new Subject();
@@ -747,27 +809,23 @@ let UserActivity = class UserActivity {
         this.onUserChange = this.userChangeEvent.asObservable();
     }
     init(userinfo) {
-        const provide = this.websocketProvider;
-        provide.awareness.setLocalStateField('user', userinfo);
+        this.syncConnector.setLocalStateField('user', userinfo);
         this.subscription.add(this.selection.onChange.subscribe(() => {
             const selection = this.selection.getPaths();
-            provide.awareness.setLocalStateField('selection', Object.assign(Object.assign({}, userinfo), { selection }));
-        }));
-        provide.awareness.on('update', () => {
+            this.syncConnector.setLocalStateField('selection', Object.assign(Object.assign({}, userinfo), { selection }));
+        }), this.syncConnector.onStateChange.subscribe((state) => {
             const users = [];
             const remoteSelections = [];
-            provide.awareness.getStates().forEach(state => {
-                if (state.user) {
-                    users.push(state.user);
-                }
-                if (state.selection) {
-                    remoteSelections.push(state.selection);
-                }
-            });
+            if (state.user) {
+                users.push(state.user);
+            }
+            if (state.selection) {
+                remoteSelections.push(state.selection);
+            }
             const selections = remoteSelections.filter(i => i.id !== userinfo.id);
             this.userChangeEvent.next(users);
             this.stateChangeEvent.next(selections);
-        });
+        }));
     }
     destroy() {
         this.subscription.unsubscribe();
@@ -775,7 +833,7 @@ let UserActivity = class UserActivity {
 };
 UserActivity = __decorate([
     Injectable(),
-    __metadata("design:paramtypes", [WebsocketProvider,
+    __metadata("design:paramtypes", [SyncConnector,
         Selection])
 ], UserActivity);
 
@@ -789,29 +847,24 @@ class CollaborateModule {
                 provide: History,
                 useExisting: Collaborate
             }, {
-                provide: WebsocketProvider,
+                provide: SyncConnector,
                 useFactory: (collab) => {
-                    return new WebsocketProvider(this.config.url, this.config.roomName, collab.yDoc);
+                    return this.config.createConnector(collab.yDoc);
                 },
                 deps: [Collaborate]
             }
         ];
     }
     setup(textbus) {
-        const provide = textbus.get(WebsocketProvider);
+        const connector = textbus.get(SyncConnector);
         const userActivity = textbus.get(UserActivity);
         userActivity.init(this.config.userinfo);
-        return new Promise((resolve) => {
-            provide.on('sync', (is) => {
-                if (is) {
-                    resolve(() => {
-                        provide.disconnect();
-                        userActivity.destroy();
-                    });
-                }
-            });
-        });
+        return connector.onLoad.toPromise();
+    }
+    onDestroy(textbus) {
+        textbus.get(UserActivity).destroy();
+        textbus.get(SyncConnector).onDestroy();
     }
 }
 
-export { Collaborate, CollaborateModule, CustomUndoManagerConfig, UserActivity };
+export { Collaborate, CollaborateModule, CustomUndoManagerConfig, HocuspocusConnector, SyncConnector, UserActivity, YWebsocketConnector };

package/bundles/index.js

@@ -1,10 +1,72 @@
 'use strict';
 
-var core$1 = require('@viewfly/core');
 var stream = require('@tanbo/stream');
+var provider = require('@hocuspocus/provider');
+var yWebsocket = require('y-websocket');
+var core$1 = require('@viewfly/core');
 var core = require('@textbus/core');
 var yjs = require('yjs');
-var yWebsocket = require('y-websocket');
+
+/**
+ * 协作通信通用接口
+ */
+class SyncConnector {
+}
+
+class HocuspocusConnector extends SyncConnector {
+    constructor(config) {
+        super();
+        this.loadEvent = new stream.Subject();
+        this.stateChangeEvent = new stream.Subject();
+        this.onLoad = this.loadEvent.asObservable();
+        this.onStateChange = this.stateChangeEvent.asObservable();
+        this.provide = new provider.HocuspocusProvider(Object.assign(Object.assign({}, config), { onSynced: (data) => {
+                var _a;
+                (_a = config.onSynced) === null || _a === void 0 ? void 0 : _a.call(config, data);
+                this.loadEvent.next();
+            }, onAwarenessUpdate: (data) => {
+                var _a;
+                (_a = config.onAwarenessUpdate) === null || _a === void 0 ? void 0 : _a.call(config, data);
+                data.states.forEach(state => {
+                    this.stateChangeEvent.next(state);
+                });
+            } }));
+    }
+    setLocalStateField(key, data) {
+        this.provide.setAwarenessField(key, data);
+    }
+    onDestroy() {
+        this.provide.disconnect();
+        this.provide.destroy();
+    }
+}
+
+class YWebsocketConnector extends SyncConnector {
+    constructor(url, roomName, yDoc) {
+        super();
+        this.loadEvent = new stream.Subject();
+        this.stateChangeEvent = new stream.Subject();
+        this.onLoad = this.loadEvent.asObservable();
+        this.onStateChange = this.stateChangeEvent.asObservable();
+        this.provide = new yWebsocket.WebsocketProvider(url, roomName, yDoc);
+        this.provide.on('sync', (is) => {
+            if (is) {
+                this.loadEvent.next();
+            }
+        });
+        this.provide.awareness.on('update', () => {
+            this.provide.awareness.getStates().forEach(state => {
+                this.stateChangeEvent.next(state);
+            });
+        });
+    }
+    setLocalStateField(key, data) {
+        this.provide.awareness.setLocalStateField(key, data);
+    }
+    onDestroy() {
+        this.provide.disconnect();
+    }
+}
 
 /******************************************************************************
 Copyright (c) Microsoft Corporation.
@@ -739,8 +801,8 @@ function remoteFormatsToLocal(registry, attrs) {
 }
 
 exports.UserActivity = class UserActivity {
-    constructor(websocketProvider, selection) {
-        this.websocketProvider = websocketProvider;
+    constructor(syncConnector, selection) {
+        this.syncConnector = syncConnector;
         this.selection = selection;
         this.stateChangeEvent = new stream.Subject();
         this.userChangeEvent = new stream.Subject();
@@ -749,27 +811,23 @@ exports.UserActivity = class UserActivity {
         this.onUserChange = this.userChangeEvent.asObservable();
     }
     init(userinfo) {
-        const provide = this.websocketProvider;
-        provide.awareness.setLocalStateField('user', userinfo);
+        this.syncConnector.setLocalStateField('user', userinfo);
         this.subscription.add(this.selection.onChange.subscribe(() => {
             const selection = this.selection.getPaths();
-            provide.awareness.setLocalStateField('selection', Object.assign(Object.assign({}, userinfo), { selection }));
-        }));
-        provide.awareness.on('update', () => {
+            this.syncConnector.setLocalStateField('selection', Object.assign(Object.assign({}, userinfo), { selection }));
+        }), this.syncConnector.onStateChange.subscribe((state) => {
             const users = [];
             const remoteSelections = [];
-            provide.awareness.getStates().forEach(state => {
-                if (state.user) {
-                    users.push(state.user);
-                }
-                if (state.selection) {
-                    remoteSelections.push(state.selection);
-                }
-            });
+            if (state.user) {
+                users.push(state.user);
+            }
+            if (state.selection) {
+                remoteSelections.push(state.selection);
+            }
             const selections = remoteSelections.filter(i => i.id !== userinfo.id);
             this.userChangeEvent.next(users);
             this.stateChangeEvent.next(selections);
-        });
+        }));
     }
     destroy() {
         this.subscription.unsubscribe();
@@ -777,7 +835,7 @@ exports.UserActivity = class UserActivity {
 };
 exports.UserActivity = __decorate([
     core$1.Injectable(),
-    __metadata("design:paramtypes", [yWebsocket.WebsocketProvider,
+    __metadata("design:paramtypes", [SyncConnector,
         core.Selection])
 ], exports.UserActivity);
 
@@ -791,30 +849,28 @@ class CollaborateModule {
                 provide: core.History,
                 useExisting: exports.Collaborate
             }, {
-                provide: yWebsocket.WebsocketProvider,
+                provide: SyncConnector,
                 useFactory: (collab) => {
-                    return new yWebsocket.WebsocketProvider(this.config.url, this.config.roomName, collab.yDoc);
+                    return this.config.createConnector(collab.yDoc);
                 },
                 deps: [exports.Collaborate]
             }
         ];
     }
     setup(textbus) {
-        const provide = textbus.get(yWebsocket.WebsocketProvider);
+        const connector = textbus.get(SyncConnector);
         const userActivity = textbus.get(exports.UserActivity);
         userActivity.init(this.config.userinfo);
-        return new Promise((resolve) => {
-            provide.on('sync', (is) => {
-                if (is) {
-                    resolve(() => {
-                        provide.disconnect();
-                        userActivity.destroy();
-                    });
-                }
-            });
-        });
+        return connector.onLoad.toPromise();
+    }
+    onDestroy(textbus) {
+        textbus.get(exports.UserActivity).destroy();
+        textbus.get(SyncConnector).onDestroy();
     }
 }
 
 exports.CollaborateModule = CollaborateModule;
 exports.CustomUndoManagerConfig = CustomUndoManagerConfig;
+exports.HocuspocusConnector = HocuspocusConnector;
+exports.SyncConnector = SyncConnector;
+exports.YWebsocketConnector = YWebsocketConnector;

package/bundles/public-api.d.ts

@@ -1,3 +1,5 @@
+export * from './connectors/_api';
 export * from './collaborate';
 export * from './collaborate-module';
+export * from './sync-connector';
 export * from './user-activity';

package/bundles/sync-connector.d.ts

@@ -0,0 +1,10 @@
+import { Observable } from '@tanbo/stream';
+/**
+ * 协作通信通用接口
+ */
+export declare abstract class SyncConnector {
+    abstract onLoad: Observable<void>;
+    abstract onStateChange: Observable<any>;
+    abstract setLocalStateField(key: string, data: Record<string, any>): void;
+    abstract onDestroy(): void;
+}

package/bundles/user-activity.d.ts

@@ -1,6 +1,6 @@
 import { Observable } from '@tanbo/stream';
 import { Selection, SelectionPaths } from '@textbus/core';
-import { WebsocketProvider } from 'y-websocket';
+import { SyncConnector } from './sync-connector';
 export interface UserInfo {
     username: string;
     color: string;
@@ -10,14 +10,14 @@ export interface ActivityInfo extends UserInfo {
     selection: SelectionPaths;
 }
 export declare class UserActivity {
-    private websocketProvider;
+    private syncConnector;
     private selection;
     onStateChange: Observable<ActivityInfo[]>;
     onUserChange: Observable<UserInfo[]>;
     private stateChangeEvent;
     private userChangeEvent;
     private subscription;
-    constructor(websocketProvider: WebsocketProvider, selection: Selection);
+    constructor(syncConnector: SyncConnector, selection: Selection);
     init(userinfo: UserInfo): void;
     destroy(): void;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@textbus/collaborate",
-  "version": "4.0.0-alpha.74",
+  "version": "4.0.0",
   "description": "Textbus is a rich text editor and framework that is highly customizable and extensible to achieve rich wysiwyg effects.",
   "main": "./bundles/index.js",
   "module": "./bundles/index.esm.js",
@@ -25,8 +25,9 @@
     "typescript editor"
   ],
   "dependencies": {
+    "@hocuspocus/provider": "^2.13.6",
     "@tanbo/stream": "^1.2.5",
-    "@textbus/core": "^4.0.0-alpha.74",
+    "@textbus/core": "^4.0.0",
     "@viewfly/core": "^1.0.0-alpha.22",
     "y-websocket": "^1.4.3",
     "yjs": "^13.6.14"
@@ -49,5 +50,5 @@
   "bugs": {
     "url": "https://github.com/textbus/textbus.git/issues"
   },
-  "gitHead": "fcd0c2f0e5111a1019cdd92144cde932fb4f5acd"
+  "gitHead": "cf4fd289b73bc777124a32fe42bb58eba05a34f1"
 }