@jupyter/docprovider 3.0.0-beta.6 → 3.0.0-rc.0

package/lib/index.d.ts

@@ -7,5 +7,4 @@ export * from './notebookCellExecutor';
 export * from './requests';
 export * from './ydrive';
 export * from './yprovider';
-export * from './tokens';
 export * from './TimelineSlider';

package/lib/index.js

@@ -11,5 +11,4 @@ export * from './notebookCellExecutor';
 export * from './requests';
 export * from './ydrive';
 export * from './yprovider';
-export * from './tokens';
 export * from './TimelineSlider';

package/lib/ydrive.d.ts

@@ -2,7 +2,7 @@ import { TranslationBundle } from '@jupyterlab/translation';
 import { Contents, Drive, User } from '@jupyterlab/services';
 import { ISignal } from '@lumino/signaling';
 import { WebSocketProvider } from './yprovider';
-import { ICollaborativeDrive, ISharedModelFactory } from './tokens';
+import { ICollaborativeDrive, ISharedModelFactory } from '@jupyter/collaborative-drive';
 import { Awareness } from 'y-protocols/awareness';
 export interface IForkProvider {
     connectToForkDoc: (forkRoomId: string, sessionId: string) => Promise<void>;

package/lib/ydrive.js

@@ -141,7 +141,9 @@ export class YDrive extends Drive {
                     super.get(localPath, { ...options, content: false }),
                     provider.ready
                 ]);
-                return model;
+                // The server doesn't return a model with a format when content is false,
+                // so set it back.
+                return { ...model, format: options.format };
             }
         }
         return super.get(localPath, options);
@@ -195,7 +197,7 @@ class SharedModelFactory {
          * Whether the IDrive supports real-time collaboration or not.
          */
         this.collaborative = !DISABLE_RTC;
-        this._documentFactories = new Map();
+        this.documentFactories = new Map();
     }
     /**
      * Register a SharedDocumentFactory.
@@ -204,10 +206,10 @@ class SharedModelFactory {
      * @param factory Document factory
      */
     registerDocumentFactory(type, factory) {
-        if (this._documentFactories.has(type)) {
+        if (this.documentFactories.has(type)) {
             throw new Error(`The content type ${type} already exists`);
         }
-        this._documentFactories.set(type, factory);
+        this.documentFactories.set(type, factory);
     }
     /**
      * Create a new `ISharedDocument` instance.
@@ -224,8 +226,8 @@ class SharedModelFactory {
             // the `sharedModel` will be the default one.
             return;
         }
-        if (this._documentFactories.has(options.contentType)) {
-            const factory = this._documentFactories.get(options.contentType);
+        if (this.documentFactories.has(options.contentType)) {
+            const factory = this.documentFactories.get(options.contentType);
             const sharedModel = factory(options);
             this._onCreate(options, sharedModel);
             return sharedModel;

package/lib/yprovider.d.ts

@@ -1,18 +1,9 @@
+import { IDocumentProvider } from '@jupyter/collaborative-drive';
 import { User } from '@jupyterlab/services';
 import { TranslationBundle } from '@jupyterlab/translation';
-import { IDisposable } from '@lumino/disposable';
 import { DocumentChange, YDocument } from '@jupyter/ydoc';
 import { WebsocketProvider as YWebsocketProvider } from 'y-websocket';
 import { IForkProvider } from './ydrive';
-/**
- * An interface for a document provider.
- */
-export interface IDocumentProvider extends IDisposable {
-    /**
-     * Returns a Promise that resolves when the document provider is ready.
-     */
-    readonly ready: Promise<void>;
-}
 /**
  * A class to provide Yjs synchronization over WebSocket.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jupyter/docprovider",
-  "version": "3.0.0-beta.6",
+  "version": "3.0.0-rc.0",
   "description": "JupyterLab - Document Provider",
   "homepage": "https://github.com/jupyterlab/jupyter-collaboration",
   "bugs": {
@@ -41,6 +41,7 @@
     "watch": "tsc -b --watch"
   },
   "dependencies": {
+    "@jupyter/collaborative-drive": "^3.0.0-rc.0",
     "@jupyter/ydoc": "^2.0.0 || ^3.0.0-a3",
     "@jupyterlab/apputils": "^4.2.0",
     "@jupyterlab/cells": "^4.2.0",
@@ -70,5 +71,13 @@
     "entryPoint": "./src/index.ts",
     "displayName": "@jupyter/docprovider",
     "tsconfig": "./tsconfig.json"
+  },
+  "jupyterlab": {
+    "sharedPackages": {
+      "@jupyter/collaborative-drive": {
+        "bundled": true,
+        "singleton": true
+      }
+    }
   }
 }

package/lib/tokens.d.ts

@@ -1,39 +0,0 @@
-import { DocumentChange, YDocument } from '@jupyter/ydoc';
-import { Contents } from '@jupyterlab/services';
-import { Token } from '@lumino/coreutils';
-import { WebSocketProvider } from './yprovider';
-/**
- * The collaborative drive.
- */
-export declare const ICollaborativeDrive: Token<ICollaborativeDrive>;
-/**
- * The global awareness token.
- */
-export declare const IGlobalAwareness: Token<import("y-protocols/awareness").Awareness>;
-/**
- * A document factory for registering shared models
- */
-export type SharedDocumentFactory = (options: Contents.ISharedFactoryOptions) => YDocument<DocumentChange>;
-/**
- * A Collaborative implementation for an `IDrive`, talking to the
- * server using the Jupyter REST API and a WebSocket connection.
- */
-export interface ICollaborativeDrive extends Contents.IDrive {
-    /**
-     * SharedModel factory for the YDrive.
-     */
-    readonly sharedModelFactory: ISharedModelFactory;
-    readonly providers: Map<string, WebSocketProvider>;
-}
-/**
- * Yjs sharedModel factory for real-time collaboration.
- */
-export interface ISharedModelFactory extends Contents.ISharedFactory {
-    /**
-     * Register a SharedDocumentFactory.
-     *
-     * @param type Document type
-     * @param factory Document factory
-     */
-    registerDocumentFactory(type: Contents.ContentType, factory: SharedDocumentFactory): void;
-}

package/lib/tokens.js

@@ -1,11 +0,0 @@
-// Copyright (c) Jupyter Development Team.
-// Distributed under the terms of the Modified BSD License.
-import { Token } from '@lumino/coreutils';
-/**
- * The collaborative drive.
- */
-export const ICollaborativeDrive = new Token('@jupyter/collaboration-extension:ICollaborativeDrive');
-/**
- * The global awareness token.
- */
-export const IGlobalAwareness = new Token('@jupyter/collaboration:IGlobalAwareness');