@jupyter/docprovider 1.0.0-alpha.6 → 1.0.0-alpha.7

package/lib/index.d.ts

@@ -4,3 +4,4 @@
  */
 export * from './ydrive';
 export * from './yprovider';
+export * from './tokens';

package/lib/index.js

@@ -8,3 +8,4 @@
  */
 export * from './ydrive';
 export * from './yprovider';
+export * from './tokens';

package/lib/tokens.d.ts

@@ -0,0 +1,33 @@
+import { DocumentChange, YDocument } from '@jupyter/ydoc';
+import { Contents } from '@jupyterlab/services';
+import { Token } from '@lumino/coreutils';
+/**
+ * The collaborative drive.
+ */
+export declare const ICollaborativeDrive: Token<ICollaborativeDrive>;
+/**
+ * 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;
+}
+/**
+ * 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

@@ -0,0 +1,7 @@
+// 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');

package/lib/ydrive.d.ts

@@ -1,11 +1,11 @@
-import { DocumentChange, ISharedDocument, YDocument } from '@jupyter/ydoc';
 import { TranslationBundle } from '@jupyterlab/translation';
 import { Contents, Drive, User } from '@jupyterlab/services';
+import { ICollaborativeDrive, ISharedModelFactory } from './tokens';
 /**
  * A Collaborative implementation for an `IDrive`, talking to the
  * server using the Jupyter REST API and a WebSocket connection.
  */
-export declare class YDrive extends Drive {
+export declare class YDrive extends Drive implements ICollaborativeDrive {
     /**
      * Construct a new drive object.
      *
@@ -15,7 +15,7 @@ export declare class YDrive extends Drive {
     /**
      * SharedModel factory for the YDrive.
      */
-    readonly sharedModelFactory: SharedModelFactory;
+    readonly sharedModelFactory: ISharedModelFactory;
     /**
      * Dispose of the resources held by the manager.
      */
@@ -48,34 +48,3 @@ export declare class YDrive extends Drive {
     private _trans;
     private _providers;
 }
-/**
- * Yjs sharedModel factory for real-time collaboration.
- */
-declare class SharedModelFactory implements Contents.ISharedFactory {
-    private _onCreate;
-    private _documentOptions;
-    /**
-     * Shared model factory constructor
-     *
-     * @param _onCreate Callback on new document model creation
-     */
-    constructor(_onCreate: (options: Contents.ISharedFactoryOptions, sharedModel: YDocument<DocumentChange>) => void);
-    /**
-     * Whether the IDrive supports real-time collaboration or not.
-     */
-    readonly collaborative = true;
-    /**
-     * Set shared document model options
-     *
-     * @param type Document type
-     * @param value Document options
-     */
-    setDocumentOptions(type: Contents.ContentType, value: Record<string, any>): void;
-    /**
-     * Create a new `ISharedDocument` instance.
-     *
-     * It should return `undefined` if the factory is not able to create a `ISharedDocument`.
-     */
-    createNew(options: Contents.ISharedFactoryOptions): ISharedDocument | undefined;
-}
-export {};

package/lib/ydrive.js

@@ -1,6 +1,5 @@
 // Copyright (c) Jupyter Development Team.
 // Distributed under the terms of the Modified BSD License.
-import { YFile, YNotebook } from '@jupyter/ydoc';
 import { URLExt } from '@jupyterlab/coreutils';
 import { Drive } from '@jupyterlab/services';
 import { WebSocketProvider } from './yprovider';
@@ -19,7 +18,7 @@ export class YDrive extends Drive {
      * @param user - The user manager to add the identity to the awareness of documents.
      */
     constructor(user, translator) {
-        super({ name: 'YDrive' });
+        super({ name: 'RTC' });
         this._onCreate = (options, sharedModel) => {
             if (typeof options.format !== 'string') {
                 return;
@@ -127,19 +126,16 @@ class SharedModelFactory {
          * Whether the IDrive supports real-time collaboration or not.
          */
         this.collaborative = true;
-        this._documentOptions = new Map();
-        this._documentOptions.set('notebook', {
-            disableDocumentWideUndoRedo: true
-        });
+        this._documentFactories = new Map();
     }
     /**
-     * Set shared document model options
+     * Register a SharedDocumentFactory.
      *
      * @param type Document type
-     * @param value Document options
+     * @param factory Document factory
      */
-    setDocumentOptions(type, value) {
-        this._documentOptions.set(type, { ...value });
+    registerDocumentFactory(type, factory) {
+        this._documentFactories.set(type, factory);
     }
     /**
      * Create a new `ISharedDocument` instance.
@@ -156,20 +152,12 @@ class SharedModelFactory {
             // the `sharedModel` will be the default one.
             return;
         }
-        let sharedModel;
-        switch (options.contentType) {
-            case 'file':
-                sharedModel = new YFile();
-                break;
-            case 'notebook':
-                sharedModel = new YNotebook(this._documentOptions.get('notebook'));
-                break;
-            //default:
-            // FIXME we should request a registry for the proper sharedModel
-        }
-        if (sharedModel) {
+        if (this._documentFactories.has(options.contentType)) {
+            const factory = this._documentFactories.get(options.contentType);
+            const sharedModel = factory(options);
             this._onCreate(options, sharedModel);
+            return sharedModel;
         }
-        return sharedModel;
+        return;
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jupyter/docprovider",
-  "version": "1.0.0-alpha.6",
+  "version": "1.0.0-alpha.7",
   "description": "JupyterLab - Document Provider",
   "homepage": "https://github.com/jupyterlab/jupyter_collaboration",
   "bugs": {
@@ -42,8 +42,8 @@
   },
   "dependencies": {
     "@jupyter/ydoc": "^0.3.4",
-    "@jupyterlab/coreutils": "^6.0.0-alpha.22",
-    "@jupyterlab/services": "^7.0.0-alpha.22",
+    "@jupyterlab/coreutils": "^6.0.0-beta.0",
+    "@jupyterlab/services": "^7.0.0-beta.0",
     "@lumino/coreutils": "^2.0.0",
     "@lumino/disposable": "^2.0.0",
     "@lumino/signaling": "^2.0.0",
@@ -52,7 +52,7 @@
     "yjs": "^13.5.40"
   },
   "devDependencies": {
-    "@jupyterlab/testing": "^4.0.0-alpha.22",
+    "@jupyterlab/testing": "^4.0.0-beta.0",
     "@types/jest": "^29.2.0",
     "rimraf": "^4.1.2",
     "typescript": "~5.0.2"