@jupyter/docprovider 1.0.0 → 1.1.0-alpha.0

package/lib/awareness.d.ts

@@ -0,0 +1,68 @@
+import { User } from '@jupyterlab/services';
+import { IDisposable } from '@lumino/disposable';
+import { ISignal } from '@lumino/signaling';
+import { WebsocketProvider } from 'y-websocket';
+import { IAwareness, IAwarenessProvider } from './tokens';
+export declare enum MessageType {
+    CHAT = 125
+}
+export interface IChatMessage {
+    username: string;
+    msg: string;
+}
+/**
+ * A class to provide Yjs synchronization over WebSocket.
+ *
+ * We specify custom messages that the server can interpret. For reference please look in yjs_ws_server.
+ *
+ */
+export declare class WebSocketAwarenessProvider extends WebsocketProvider implements IAwarenessProvider, IDisposable {
+    /**
+     * Construct a new WebSocketAwarenessProvider
+     *
+     * @param options The instantiation options for a WebSocketAwarenessProvider
+     */
+    constructor(options: WebSocketAwarenessProvider.IOptions);
+    get isDisposed(): boolean;
+    /**
+     * A signal to subscribe for incoming messages.
+     */
+    get chatMessage(): ISignal<this, IChatMessage>;
+    dispose(): void;
+    /**
+     * Send a message to every collaborator.
+     *
+     * @param msg message
+     */
+    sendMessage(msg: string): void;
+    private _onUserChanged;
+    private _isDisposed;
+    private _awareness;
+    private _chatMessage;
+}
+/**
+ * A namespace for WebSocketAwarenessProvider statics.
+ */
+export declare namespace WebSocketAwarenessProvider {
+    /**
+     * The instantiation options for a WebSocketAwarenessProvider.
+     */
+    interface IOptions {
+        /**
+         * The server URL
+         */
+        url: string;
+        /**
+         * The room ID
+         */
+        roomID: string;
+        /**
+         * The awareness object
+         */
+        awareness: IAwareness;
+        /**
+         * The user data
+         */
+        user: User.IManager;
+    }
+}

package/lib/awareness.js

@@ -0,0 +1,75 @@
+/* -----------------------------------------------------------------------------
+| Copyright (c) Jupyter Development Team.
+| Distributed under the terms of the Modified BSD License.
+|----------------------------------------------------------------------------*/
+import { Signal } from '@lumino/signaling';
+import * as decoding from 'lib0/decoding';
+import * as encoding from 'lib0/encoding';
+import { WebsocketProvider } from 'y-websocket';
+export var MessageType;
+(function (MessageType) {
+    MessageType[MessageType["CHAT"] = 125] = "CHAT";
+})(MessageType || (MessageType = {}));
+/**
+ * A class to provide Yjs synchronization over WebSocket.
+ *
+ * We specify custom messages that the server can interpret. For reference please look in yjs_ws_server.
+ *
+ */
+export class WebSocketAwarenessProvider extends WebsocketProvider {
+    /**
+     * Construct a new WebSocketAwarenessProvider
+     *
+     * @param options The instantiation options for a WebSocketAwarenessProvider
+     */
+    constructor(options) {
+        super(options.url, options.roomID, options.awareness.doc, {
+            awareness: options.awareness
+        });
+        this._isDisposed = false;
+        this._awareness = options.awareness;
+        const user = options.user;
+        user.ready
+            .then(() => this._onUserChanged(user))
+            .catch(e => console.error(e));
+        user.userChanged.connect(this._onUserChanged, this);
+        this._chatMessage = new Signal(this);
+        this.messageHandlers[MessageType.CHAT] = (encoder, decoder, provider, emitSynced, messageType) => {
+            const content = decoding.readVarString(decoder);
+            const data = JSON.parse(content);
+            console.debug('Chat:', data);
+            this._chatMessage.emit(data);
+        };
+    }
+    get isDisposed() {
+        return this._isDisposed;
+    }
+    /**
+     * A signal to subscribe for incoming messages.
+     */
+    get chatMessage() {
+        return this._chatMessage;
+    }
+    dispose() {
+        if (this._isDisposed) {
+            return;
+        }
+        this.destroy();
+        this._isDisposed = true;
+    }
+    /**
+     * Send a message to every collaborator.
+     *
+     * @param msg message
+     */
+    sendMessage(msg) {
+        console.debug('Send message:', msg);
+        const encoder = encoding.createEncoder();
+        encoding.writeVarUint(encoder, MessageType.CHAT);
+        encoding.writeVarString(encoder, msg);
+        this.ws.send(encoding.toUint8Array(encoder));
+    }
+    _onUserChanged(user) {
+        this._awareness.setLocalStateField('user', user.identity);
+    }
+}

package/lib/index.d.ts

@@ -2,6 +2,7 @@
  * @packageDocumentation
  * @module docprovider
  */
+export * from './awareness';
 export * from './ydrive';
 export * from './yprovider';
 export * from './tokens';

package/lib/index.js

@@ -6,6 +6,7 @@
  * @packageDocumentation
  * @module docprovider
  */
+export * from './awareness';
 export * from './ydrive';
 export * from './yprovider';
 export * from './tokens';

package/lib/tokens.d.ts

@@ -1,6 +1,9 @@
 import { DocumentChange, YDocument } from '@jupyter/ydoc';
 import { Contents } from '@jupyterlab/services';
 import { Token } from '@lumino/coreutils';
+import { ISignal } from '@lumino/signaling';
+import type { Awareness } from 'y-protocols/awareness';
+import { IChatMessage } from './awareness';
 /**
  * The collaborative drive.
  */
@@ -31,3 +34,24 @@ export interface ISharedModelFactory extends Contents.ISharedFactory {
      */
     registerDocumentFactory(type: Contents.ContentType, factory: SharedDocumentFactory): void;
 }
+/**
+ * The awareness interface.
+ *
+ * TODO: Move to @jupyter/YDoc
+ */
+export type IAwareness = Awareness;
+/**
+ * A provider interface for global awareness features.
+ */
+export interface IAwarenessProvider {
+    /**
+     * A signal to subscribe for incoming messages.
+     */
+    get chatMessage(): ISignal<this, IChatMessage>;
+    /**
+     * Send a message to every collaborator.
+     *
+     * @param msg message
+     */
+    sendMessage(msg: string): void;
+}

package/lib/ydrive.js

@@ -1,8 +1,9 @@
 // Copyright (c) Jupyter Development Team.
 // Distributed under the terms of the Modified BSD License.
-import { URLExt } from '@jupyterlab/coreutils';
+import { PageConfig, URLExt } from '@jupyterlab/coreutils';
 import { Drive } from '@jupyterlab/services';
 import { WebSocketProvider } from './yprovider';
+const DISABLE_RTC = PageConfig.getOption('disableRTC') === 'true' ? true : false;
 /**
  * The url for the default drive service.
  */
@@ -125,7 +126,7 @@ class SharedModelFactory {
         /**
          * Whether the IDrive supports real-time collaboration or not.
          */
-        this.collaborative = true;
+        this.collaborative = !DISABLE_RTC;
         this._documentFactories = new Map();
     }
     /**
@@ -150,7 +151,7 @@ class SharedModelFactory {
             console.warn(`Only defined format are supported; got ${options.format}.`);
             return;
         }
-        if (!options.collaborative) {
+        if (!this.collaborative || !options.collaborative) {
             // Bail if the document model does not support collaboration
             // the `sharedModel` will be the default one.
             return;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jupyter/docprovider",
-  "version": "1.0.0",
+  "version": "1.1.0-alpha.0",
   "description": "JupyterLab - Document Provider",
   "homepage": "https://github.com/jupyterlab/jupyter_collaboration",
   "bugs": {