jupyter-webrtc-provider 0.1.0

package/LICENSE

@@ -0,0 +1,30 @@
+BSD 3-Clause License
+
+Copyright (c) 2014 Kevin Jahns <kevin.jahns@rwth-aachen.de>.
+Copyright (c) 2026, David Brochart
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,84 @@
+# jupyter_webrtc_provider
+
+[![Github Actions Status](https://github.com/davidbrochart/jupyter-webrtc-provider/workflows/Build/badge.svg)](https://github.com/davidbrochart/jupyter-webrtc-provider/actions/workflows/build.yml)
+
+A JupyterLab extension for a WebRTC shared document provider.
+
+## Requirements
+
+- JupyterLab >= 4.0.0
+
+## Install
+
+To install the extension, execute:
+
+```bash
+pip install jupyter_webrtc_provider
+```
+
+## Uninstall
+
+To remove the extension, execute:
+
+```bash
+pip uninstall jupyter_webrtc_provider
+```
+
+## Contributing
+
+### Development install
+
+Note: You will need NodeJS to build the extension package.
+
+The `jlpm` command is JupyterLab's pinned version of
+[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
+`yarn` or `npm` in lieu of `jlpm` below.
+
+```bash
+# Clone the repo to your local environment
+# Change directory to the jupyter_webrtc_provider directory
+
+# Set up a virtual environment and install package in development mode
+python -m venv .venv
+source .venv/bin/activate
+pip install --editable "."
+
+# Link your development version of the extension with JupyterLab
+jupyter labextension develop . --overwrite
+
+# Rebuild extension Typescript source after making changes
+# IMPORTANT: Unlike the steps above which are performed only once, do this step
+# every time you make a change.
+jlpm build
+```
+
+You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.
+
+```bash
+# Watch the source directory in one terminal, automatically rebuilding when needed
+jlpm watch
+# Run JupyterLab in another terminal
+jupyter lab
+```
+
+With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).
+
+By default, the `jlpm build` command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:
+
+```bash
+jupyter lab build --minimize=False
+```
+
+### Development uninstall
+
+```bash
+pip uninstall jupyter_webrtc_provider
+```
+
+In development mode, you will also need to remove the symlink created by `jupyter labextension develop`
+command. To find its location, you can run `jupyter labextension list` to figure out where the `labextensions`
+folder is located. Then you can remove the symlink named `jupyter-webrtc-provider` within that folder.
+
+### Packaging the extension
+
+See [RELEASE](RELEASE.md)

package/lib/awareness.d.ts

@@ -0,0 +1,60 @@
+import { ServerConnection, User } from '@jupyterlab/services';
+import { IAwareness } from '@jupyter/ydoc';
+import { IWebSocketFactory } from './websocket';
+import { WebrtcProvider } from './webrtc';
+export interface IContent {
+    type: string;
+    body: string;
+}
+/**
+ * A class to provide Yjs synchronization over WebRTC.
+ *
+ */
+export declare class WebRTCAwarenessProvider extends WebrtcProvider {
+    /**
+     * Construct a new WebRTCAwarenessProvider
+     *
+     * @param options The instantiation options for a WebRTCAwarenessProvider
+     */
+    constructor(options: WebRTCAwarenessProvider.IOptions);
+    get isDisposed(): boolean;
+    dispose(): void;
+    private _onUserChanged;
+    readonly awareness: IAwareness;
+    private _isDisposed;
+    private _user;
+}
+/**
+ * A namespace for WebRTCAwarenessProvider statics.
+ */
+export declare namespace WebRTCAwarenessProvider {
+    /**
+     * The instantiation options for a WebRTCAwarenessProvider.
+     */
+    interface IOptions {
+        /**
+         * The room ID
+         */
+        roomID: string;
+        /**
+         * The awareness object
+         */
+        awareness: IAwareness;
+        /**
+         * The user data
+         */
+        user: User.IManager;
+        /**
+         * The server settings.
+         */
+        serverSettings?: ServerConnection.ISettings;
+        /**
+         * The signaling server URLs for WebRTC.
+         */
+        signalingServers: string[];
+        /**
+         * Factory function to create WebSocket connections.
+         */
+        webSocketFactory: IWebSocketFactory;
+    }
+}

package/lib/awareness.js

@@ -0,0 +1,41 @@
+import { WebrtcProvider } from './webrtc';
+/**
+ * A class to provide Yjs synchronization over WebRTC.
+ *
+ */
+export class WebRTCAwarenessProvider extends WebrtcProvider {
+    /**
+     * Construct a new WebRTCAwarenessProvider
+     *
+     * @param options The instantiation options for a WebRTCAwarenessProvider
+     */
+    constructor(options) {
+        super(options.roomID, options.awareness.doc, {
+            signaling: options.signalingServers,
+            awareness: options.awareness,
+            webSocketFactory: options.webSocketFactory
+        });
+        this._isDisposed = false;
+        this.awareness = options.awareness;
+        this._user = options.user;
+        this._user.ready
+            .then(() => this._onUserChanged(this._user))
+            .catch(e => console.error(e));
+        this._user.userChanged.connect(this._onUserChanged, this);
+    }
+    get isDisposed() {
+        return this._isDisposed;
+    }
+    dispose() {
+        if (this._isDisposed) {
+            return;
+        }
+        this._user.userChanged.disconnect(this._onUserChanged, this);
+        this._isDisposed = true;
+        this.destroy();
+    }
+    _onUserChanged(user) {
+        this.awareness.setLocalStateField('user', user.identity);
+    }
+}
+//# sourceMappingURL=awareness.js.map

package/lib/awareness.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"awareness.js","sourceRoot":"","sources":["../src/awareness.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAO1C;;;GAGG;AACH,MAAM,OAAO,uBAAwB,SAAQ,cAAc;IACzD;;;;OAIG;IACH,YAAY,OAAyC;QACnD,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,SAAS,CAAC,GAAG,EAAE;YAC3C,SAAS,EAAE,OAAO,CAAC,gBAAgB;YACnC,SAAS,EAAE,OAAO,CAAC,SAAS;YAC5B,gBAAgB,EAAE,OAAO,CAAC,gBAAgB;SAC3C,CAAC,CAAC;QA4BG,gBAAW,GAAG,KAAK,CAAC;QA3B1B,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QACnC,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC;QAC1B,IAAI,CAAC,KAAK,CAAC,KAAK;aACb,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;aAC3C,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QAChC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;IAC5D,CAAC;IAED,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED,OAAO;QACL,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACrB,OAAO;QACT,CAAC;QAED,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,UAAU,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;QAC7D,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QACxB,IAAI,CAAC,OAAO,EAAE,CAAC;IACjB,CAAC;IAEO,cAAc,CAAC,IAAmB;QACxC,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC3D,CAAC;CAKF"}

package/lib/crypto.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Derive a cryptographic key from a secret and room name using PBKDF2.
+ */
+export declare const deriveKey: (secret: string, roomName: string) => Promise<CryptoKey>;
+/**
+ * Encrypt data using AES-GCM encryption.
+ */
+export declare const encrypt: (data: Uint8Array, key: CryptoKey | null) => Promise<Uint8Array>;
+/**
+ * Encrypt a JSON-serializable object using AES-GCM encryption.
+ */
+export declare const encryptJson: (data: any, key: CryptoKey | null) => Promise<Uint8Array>;
+/**
+ * Decrypt data using AES-GCM decryption.
+ */
+export declare const decrypt: (data: Uint8Array, key: CryptoKey | null) => Promise<Uint8Array>;
+/**
+ * Decrypt data and parse it as JSON.
+ */
+export declare const decryptJson: (data: Uint8Array, key: CryptoKey | null) => Promise<any>;

package/lib/crypto.js

@@ -0,0 +1,76 @@
+import * as encoding from 'lib0/encoding';
+import * as decoding from 'lib0/decoding';
+import * as string from 'lib0/string';
+/**
+ * Derive a cryptographic key from a secret and room name using PBKDF2.
+ */
+export const deriveKey = (secret, roomName) => {
+    const secretBuffer = string.encodeUtf8(secret).buffer;
+    const salt = string.encodeUtf8(roomName).buffer;
+    return crypto.subtle
+        .importKey('raw', secretBuffer, 'PBKDF2', false, ['deriveKey'])
+        .then(keyMaterial => crypto.subtle.deriveKey({
+        name: 'PBKDF2',
+        salt,
+        iterations: 100000,
+        hash: 'SHA-256'
+    }, keyMaterial, {
+        name: 'AES-GCM',
+        length: 256
+    }, true, ['encrypt', 'decrypt']));
+};
+/**
+ * Encrypt data using AES-GCM encryption.
+ */
+export const encrypt = (data, key) => {
+    if (!key) {
+        return Promise.resolve(data);
+    }
+    const iv = crypto.getRandomValues(new Uint8Array(12));
+    return crypto.subtle
+        .encrypt({
+        name: 'AES-GCM',
+        iv
+    }, key, data)
+        .then(cipher => {
+        const encryptedDataEncoder = encoding.createEncoder();
+        encoding.writeVarString(encryptedDataEncoder, 'AES-GCM');
+        encoding.writeVarUint8Array(encryptedDataEncoder, iv);
+        encoding.writeVarUint8Array(encryptedDataEncoder, new Uint8Array(cipher));
+        return encoding.toUint8Array(encryptedDataEncoder);
+    });
+};
+/**
+ * Encrypt a JSON-serializable object using AES-GCM encryption.
+ */
+export const encryptJson = (data, key) => {
+    const dataEncoder = encoding.createEncoder();
+    encoding.writeAny(dataEncoder, data);
+    return encrypt(encoding.toUint8Array(dataEncoder), key);
+};
+/**
+ * Decrypt data using AES-GCM decryption.
+ */
+export const decrypt = (data, key) => {
+    if (!key) {
+        return Promise.resolve(data);
+    }
+    const dataDecoder = decoding.createDecoder(data);
+    const algorithm = decoding.readVarString(dataDecoder);
+    if (algorithm !== 'AES-GCM') {
+        throw new Error('Unknown encryption algorithm');
+    }
+    const iv = decoding.readVarUint8Array(dataDecoder);
+    const cipher = decoding.readVarUint8Array(dataDecoder);
+    return crypto.subtle
+        .decrypt({
+        name: 'AES-GCM',
+        iv
+    }, key, cipher)
+        .then(decrypted => new Uint8Array(decrypted));
+};
+/**
+ * Decrypt data and parse it as JSON.
+ */
+export const decryptJson = (data, key) => decrypt(data, key).then(decryptedValue => decoding.readAny(decoding.createDecoder(new Uint8Array(decryptedValue))));
+//# sourceMappingURL=crypto.js.map

package/lib/crypto.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"crypto.js","sourceRoot":"","sources":["../src/crypto.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,QAAQ,MAAM,eAAe,CAAC;AAC1C,OAAO,KAAK,QAAQ,MAAM,eAAe,CAAC;AAC1C,OAAO,KAAK,MAAM,MAAM,aAAa,CAAC;AAEtC;;GAEG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CACvB,MAAc,EACd,QAAgB,EACI,EAAE;IACtB,MAAM,YAAY,GAAG,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC;IACtD,MAAM,IAAI,GAAG,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC;IAChD,OAAO,MAAM,CAAC,MAAM;SACjB,SAAS,CAAC,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,WAAW,CAAC,CAAC;SAC9D,IAAI,CAAC,WAAW,CAAC,EAAE,CAClB,MAAM,CAAC,MAAM,CAAC,SAAS,CACrB;QACE,IAAI,EAAE,QAAQ;QACd,IAAI;QACJ,UAAU,EAAE,MAAM;QAClB,IAAI,EAAE,SAAS;KAChB,EACD,WAAW,EACX;QACE,IAAI,EAAE,SAAS;QACf,MAAM,EAAE,GAAG;KACZ,EACD,IAAI,EACJ,CAAC,SAAS,EAAE,SAAS,CAAC,CACvB,CACF,CAAC;AACN,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,CACrB,IAAgB,EAChB,GAAqB,EACA,EAAE;IACvB,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IACD,MAAM,EAAE,GAAG,MAAM,CAAC,eAAe,CAAC,IAAI,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC;IACtD,OAAO,MAAM,CAAC,MAAM;SACjB,OAAO,CACN;QACE,IAAI,EAAE,SAAS;QACf,EAAE;KACH,EACD,GAAG,EACH,IAAI,CACL;SACA,IAAI,CAAC,MAAM,CAAC,EAAE;QACb,MAAM,oBAAoB,GAAG,QAAQ,CAAC,aAAa,EAAE,CAAC;QACtD,QAAQ,CAAC,cAAc,CAAC,oBAAoB,EAAE,SAAS,CAAC,CAAC;QACzD,QAAQ,CAAC,kBAAkB,CAAC,oBAAoB,EAAE,EAAE,CAAC,CAAC;QACtD,QAAQ,CAAC,kBAAkB,CAAC,oBAAoB,EAAE,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;QAC1E,OAAO,QAAQ,CAAC,YAAY,CAAC,oBAAoB,CAAC,CAAC;IACrD,CAAC,CAAC,CAAC;AACP,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CACzB,IAAS,EACT,GAAqB,EACA,EAAE;IACvB,MAAM,WAAW,GAAG,QAAQ,CAAC,aAAa,EAAE,CAAC;IAC7C,QAAQ,CAAC,QAAQ,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;IACrC,OAAO,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC,WAAW,CAAC,EAAE,GAAG,CAAC,CAAC;AAC1D,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,CACrB,IAAgB,EAChB,GAAqB,EACA,EAAE;IACvB,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IACD,MAAM,WAAW,GAAG,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;IACjD,MAAM,SAAS,GAAG,QAAQ,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;IACtD,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;QAC5B,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;IAClD,CAAC;IACD,MAAM,EAAE,GAAG,QAAQ,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC;IACnD,MAAM,MAAM,GAAG,QAAQ,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC;IACvD,OAAO,MAAM,CAAC,MAAM;SACjB,OAAO,CACN;QACE,IAAI,EAAE,SAAS;QACf,EAAE;KACH,EACD,GAAG,EACH,MAAM,CACP;SACA,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,IAAI,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC;AAClD,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CACzB,IAAgB,EAChB,GAAqB,EACP,EAAE,CAChB,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE,CACvC,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC,IAAI,UAAU,CAAC,cAAc,CAAC,CAAC,CAAC,CACzE,CAAC"}

package/lib/index.d.ts

@@ -0,0 +1,6 @@
+export { IWebSocketFactory } from './websocket';
+import { JupyterFrontEndPlugin } from '@jupyterlab/application';
+import { awarenessProviderFactoryPlugin, documentProviderFactoryPlugin } from './provider';
+export { awarenessProviderFactoryPlugin, documentProviderFactoryPlugin };
+declare const plugins: JupyterFrontEndPlugin<unknown>[];
+export default plugins;

package/lib/index.js

@@ -0,0 +1,9 @@
+export { IWebSocketFactory } from './websocket';
+import { awarenessProviderFactoryPlugin, documentProviderFactoryPlugin } from './provider';
+export { awarenessProviderFactoryPlugin, documentProviderFactoryPlugin };
+const plugins = [
+    documentProviderFactoryPlugin,
+    awarenessProviderFactoryPlugin
+];
+export default plugins;
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAIhD,OAAO,EACL,8BAA8B,EAC9B,6BAA6B,EAC9B,MAAM,YAAY,CAAC;AAEpB,OAAO,EAAE,8BAA8B,EAAE,6BAA6B,EAAE,CAAC;AAEzE,MAAM,OAAO,GAAqC;IAChD,6BAA6B;IAC7B,8BAA8B;CAC/B,CAAC;AAEF,eAAe,OAAO,CAAC"}

package/lib/provider.d.ts

@@ -0,0 +1,110 @@
+import { IAwarenessProviderFactory, IDocumentProviderFactory } from '@jupyter/docprovider';
+import { JupyterFrontEndPlugin } from '@jupyterlab/application';
+import { TranslationBundle } from '@jupyterlab/translation';
+import { IDocumentProvider } from '@jupyter/collaborative-drive';
+import { ServerConnection, User, Contents } from '@jupyterlab/services';
+import { DocumentChange, YDocument } from '@jupyter/ydoc';
+import { IForkProvider } from '@jupyter/docprovider';
+import { IWebSocketFactory } from './websocket';
+/**
+ * A class to provide Yjs synchronization over WebRTC.
+ *
+ */
+export declare class WebRTCProvider implements IDocumentProvider, IForkProvider {
+    /**
+     * Construct a new WebRTCProvider
+     *
+     * @param options The instantiation options for a WebRTCProvider
+     */
+    constructor(options: WebRTCProvider.IOptions);
+    /**
+     * Test whether the object has been disposed.
+     */
+    get isDisposed(): boolean;
+    /**
+     * A promise that resolves when the document provider is ready.
+     */
+    get ready(): Promise<void>;
+    get contentType(): string;
+    get format(): string;
+    /**
+     * Dispose of the resources held by the object.
+     */
+    dispose(): void;
+    reconnect(): Promise<void>;
+    private _connect;
+    connectToForkDoc(forkRoomId: string, sessionId: string): Promise<void>;
+    save(): Promise<void>;
+    private _disconnect;
+    private _onUserChanged;
+    private _onSynced;
+    private _awareness;
+    private _contentType;
+    private _format;
+    private _isDisposed;
+    private _path;
+    private _ready;
+    private _sharedModel;
+    private _webrtcProvider;
+    private _signalingServers;
+    private _drive;
+    private _webSocketFactory;
+}
+/**
+ * A namespace for WebRTCProvider statics.
+ */
+export declare namespace WebRTCProvider {
+    /**
+     * The instantiation options for a WebRTCProvider.
+     */
+    interface IOptions {
+        /**
+         * The document file path
+         */
+        path: string;
+        /**
+         * Content type
+         */
+        contentType: string;
+        /**
+         * The source format
+         */
+        format: string;
+        /**
+         * The shared model
+         */
+        model: YDocument<DocumentChange>;
+        /**
+         * The user data
+         */
+        user: User.IManager;
+        /**
+         * The jupyterlab translator
+         */
+        translator: TranslationBundle;
+        /**
+         * The server settings.
+         */
+        serverSettings?: ServerConnection.ISettings;
+        /**
+         * The signaling server URLs for WebRTC.
+         */
+        signalingServers: string[];
+        /**
+         * The drive to use for loading and saving document content.
+         */
+        drive: Contents.IDrive;
+        /**
+         * Factory function to create WebSocket connections.
+         */
+        webSocketFactory: IWebSocketFactory;
+    }
+}
+/**
+ * Plugin that provides the WebRTC document provider factory.
+ */
+export declare const documentProviderFactoryPlugin: JupyterFrontEndPlugin<IDocumentProviderFactory>;
+/**
+ * Plugin that provides the WebRTC awareness provider factory.
+ */
+export declare const awarenessProviderFactoryPlugin: JupyterFrontEndPlugin<IAwarenessProviderFactory>;