@jupyter/collaborative-drive 3.0.0-beta.8

package/lib/index.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @packageDocumentation
+ * @module collaborative-drive
+ */
+export * from './tokens';

package/lib/index.js

@@ -0,0 +1,9 @@
+/* -----------------------------------------------------------------------------
+| Copyright (c) Jupyter Development Team.
+| Distributed under the terms of the Modified BSD License.
+|----------------------------------------------------------------------------*/
+/**
+ * @packageDocumentation
+ * @module collaborative-drive
+ */
+export * from './tokens';

package/lib/tokens.d.ts

@@ -0,0 +1,49 @@
+import { DocumentChange, YDocument } from '@jupyter/ydoc';
+import { Contents } from '@jupyterlab/services';
+import { IDisposable } from '@lumino/disposable';
+import { Token } from '@lumino/coreutils';
+/**
+ * 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, IDocumentProvider>;
+}
+/**
+ * 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;
+    documentFactories: Map<Contents.ContentType, SharedDocumentFactory>;
+}
+/**
+ * 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>;
+}

package/lib/tokens.js

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

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@jupyter/collaborative-drive",
+  "version": "3.0.0-beta.8",
+  "description": "JupyterLab - Collaborative Drive",
+  "homepage": "https://github.com/jupyterlab/jupyter-collaboration",
+  "bugs": {
+    "url": "https://github.com/jupyterlab/jupyter-collaboration/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/jupyterlab/jupyter-collaboration.git"
+  },
+  "license": "BSD-3-Clause",
+  "author": "Project Jupyter",
+  "sideEffects": [
+    "style/**/*"
+  ],
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "directories": {
+    "lib": "lib/"
+  },
+  "files": [
+    "lib/**/*.{d.ts,eot,gif,html,jpg,js,js.map,json,png,svg,woff2,ttf}",
+    "schema/*.json",
+    "style/**/*.{css,eot,gif,html,jpg,json,png,svg,woff2,ttf}",
+    "style/index.js"
+  ],
+  "scripts": {
+    "build": "tsc -b",
+    "build:prod": "jlpm run build",
+    "build:test": "tsc --build tsconfig.test.json",
+    "clean": "rimraf lib tsconfig.tsbuildinfo",
+    "clean:lib": "jlpm run clean:all",
+    "clean:all": "rimraf lib tsconfig.tsbuildinfo node_modules",
+    "install:extension": "jlpm run build",
+    "watch": "tsc -b --watch"
+  },
+  "dependencies": {
+    "@jupyter/ydoc": "^2.0.0 || ^3.0.0-a3",
+    "@jupyterlab/services": "^7.2.0",
+    "@lumino/coreutils": "^2.1.0",
+    "@lumino/disposable": "^2.1.0"
+  },
+  "devDependencies": {
+    "rimraf": "^4.1.2",
+    "typescript": "~5.0.4"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "typedoc": {
+    "entryPoint": "./src/index.ts",
+    "displayName": "@jupyter/collaborative-drive",
+    "tsconfig": "./tsconfig.json"
+  }
+}