removed @stubbed for most of notebook-api;

implemented more of the api;

Signed-off-by: Jonah Iden <jonah.iden@typefox.io>

packages/plugin-ext/src/plugin/notebook/notebook-documents.ts

@@ -19,11 +19,13 @@
  *--------------------------------------------------------------------------------------------*/
 
 import * as theia from '@theia/plugin';
-import { Emitter, URI } from '@theia/core';
+import { Emitter } from '@theia/core';
 import { UriComponents } from '../../common/uri-components';
 import { NotebookCellsChangedEventDto, NotebookDocumentsExt } from '../../common';
 import { NotebooksExtImpl } from './notebooks';
-import { NotebookDocumentMetadata } from '@theia/notebook/lib/common';
+import { URI } from '../types-impl';
+
+export type NotebookDocumentMetadata = Record<string, unknown>;
 
 export class NotebookDocumentsExtImpl implements NotebookDocumentsExt {
 
@@ -39,18 +41,18 @@ export class NotebookDocumentsExtImpl implements NotebookDocumentsExt {
 
     $acceptModelChanged(uri: UriComponents, event: NotebookCellsChangedEventDto,
         isDirty: boolean, newMetadata?: NotebookDocumentMetadata): void {
-        const document = this.notebooksAndEditors.getNotebookDocument(URI.fromComponents(uri));
+        const document = this.notebooksAndEditors.getNotebookDocument(URI.from(uri));
         const e = document.acceptModelChanged(event, isDirty, newMetadata);
         this.didChangeNotebookDocumentEmitter.fire(e);
     }
 
     $acceptDirtyStateChanged(uri: UriComponents, isDirty: boolean): void {
-        const document = this.notebooksAndEditors.getNotebookDocument(URI.fromComponents(uri));
+        const document = this.notebooksAndEditors.getNotebookDocument(URI.from(uri));
         document.acceptDirty(isDirty);
     }
 
     $acceptModelSaved(uri: UriComponents): void {
-        const document = this.notebooksAndEditors.getNotebookDocument(URI.fromComponents(uri));
+        const document = this.notebooksAndEditors.getNotebookDocument(URI.from(uri));
         this.didSaveNotebookDocumentEmitter.fire(document.apiNotebook);
     }
 }

packages/plugin-ext/src/plugin/notebook/notebooks.ts

@@ -23,7 +23,7 @@ import { URI as TheiaURI } from '../types-impl';
 import * as theia from '@theia/plugin';
 import {
     CommandRegistryExt, ModelAddedData, NotebookCellStatusBarListDto, NotebookDataDto,
-    NotebookDocumentsAndEditorsDelta, NotebookDocumentsMain, NotebookEditorAddData, NotebooksExt, NotebooksMain, Plugin,
+    NotebookDocumentsAndEditorsDelta, NotebookDocumentShowOptions, NotebookDocumentsMain, NotebookEditorAddData, NotebookEditorsMain, NotebooksExt, NotebooksMain, Plugin,
     PLUGIN_RPC_CONTEXT
 } from '../../common';
 import { Cache } from '../../common/cache';
@@ -70,6 +70,7 @@ export class NotebooksExtImpl implements NotebooksExt {
 
     private notebookProxy: NotebooksMain;
     private notebookDocumentsProxy: NotebookDocumentsMain;
+    private notebookEditors: NotebookEditorsMain;
 
     constructor(
         rpc: RPCProtocol,
@@ -79,6 +80,7 @@ export class NotebooksExtImpl implements NotebooksExt {
     ) {
         this.notebookProxy = rpc.getProxy(PLUGIN_RPC_CONTEXT.NOTEBOOKS_MAIN);
         this.notebookDocumentsProxy = rpc.getProxy(PLUGIN_RPC_CONTEXT.NOTEBOOK_DOCUMENTS_MAIN);
+        this.notebookEditors = rpc.getProxy(PLUGIN_RPC_CONTEXT.NOTEBOOK_EDITORS_MAIN);
 
         commands.registerArgumentProcessor({
             processArgument: (arg: { uri: URI }) => {
@@ -191,6 +193,10 @@ export class NotebooksExtImpl implements NotebooksExt {
         return editor;
     }
 
+    getAllApiDocuments(): theia.NotebookDocument[] {
+        return [...this.documents.values()].map(doc => doc.apiNotebook);
+    }
+
     async $acceptDocumentsAndEditorsDelta(delta: NotebookDocumentsAndEditorsDelta): Promise<void> {
         if (delta.removedDocuments) {
             for (const uri of delta.removedDocuments) {
@@ -305,9 +311,9 @@ export class NotebooksExtImpl implements NotebooksExt {
         }
     }
 
-    getNotebookDocument(uri: URI, relaxed: true): NotebookDocument | undefined;
-    getNotebookDocument(uri: URI): NotebookDocument;
-    getNotebookDocument(uri: URI, relaxed?: true): NotebookDocument | undefined {
+    getNotebookDocument(uri: TheiaURI, relaxed: true): NotebookDocument | undefined;
+    getNotebookDocument(uri: TheiaURI): NotebookDocument;
+    getNotebookDocument(uri: TheiaURI, relaxed?: true): NotebookDocument | undefined {
         const result = this.documents.get(uri.toString());
         if (!result && !relaxed) {
             throw new Error(`NO notebook document for '${uri}'`);
@@ -332,4 +338,58 @@ export class NotebooksExtImpl implements NotebooksExt {
         this.editors.set(editorId, editor);
     }
 
+    async createNotebookDocument(options: { viewType: string; content?: theia.NotebookData }): Promise<TheiaURI> {
+        const canonicalUri = await this.notebookDocumentsProxy.$tryCreateNotebook({
+            viewType: options.viewType,
+            content: options.content && typeConverters.NotebookData.from(options.content)
+        });
+        return TheiaURI.from(canonicalUri);
+    }
+
+    async openNotebookDocument(uri: TheiaURI): Promise<theia.NotebookDocument> {
+        const cached = this.documents.get(uri.toString());
+        if (cached) {
+            return cached.apiNotebook;
+        }
+        const canonicalUri = await this.notebookDocumentsProxy.$tryOpenNotebook(uri);
+        const document = this.documents.get(URI.fromComponents(canonicalUri).toString());
+        return document?.apiNotebook!;
+    }
+
+    async showNotebookDocument(notebookOrUri: theia.NotebookDocument | TheiaURI, options?: theia.NotebookDocumentShowOptions): Promise<theia.NotebookEditor> {
+
+        if (URI.isUri(notebookOrUri)) {
+            notebookOrUri = await this.openNotebookDocument(notebookOrUri as TheiaURI);
+        }
+
+        const notebook = notebookOrUri as theia.NotebookDocument;
+
+        let resolvedOptions: NotebookDocumentShowOptions;
+        if (typeof options === 'object') {
+            resolvedOptions = {
+                position: typeConverters.ViewColumn.from(options.viewColumn),
+                preserveFocus: options.preserveFocus,
+                selections: options.selections && options.selections.map(typeConverters.NotebookRange.from),
+                pinned: typeof options.preview === 'boolean' ? !options.preview : undefined
+            };
+        } else {
+            resolvedOptions = {
+                preserveFocus: false
+            };
+        }
+
+        const editorId = await this.notebookEditors.$tryShowNotebookDocument(notebook.uri, notebook.notebookType, resolvedOptions);
+        const editor = editorId && this.editors.get(editorId)?.apiEditor;
+
+        if (editor) {
+            return editor;
+        }
+
+        if (editorId) {
+            throw new Error(`Could NOT open editor for "${notebook.uri.toString()}" because another editor opened in the meantime.`);
+        } else {
+            throw new Error(`Could NOT open editor for "${notebook.uri.toString()}".`);
+        }
+    }
+
 }

packages/plugin-ext/src/plugin/plugin-context.ts

@@ -249,6 +249,7 @@ import { TelemetryExtImpl } from './telemetry-ext';
 import { NotebookRenderersExtImpl } from './notebook/notebook-renderers';
 import { NotebookKernelsExtImpl } from './notebook/notebook-kernels';
 import { NotebookDocumentsExtImpl } from './notebook/notebook-documents';
+import { NotebookEditorsExtImpl } from './notebook/notebook-editors';
 
 export function createAPIFactory(
     rpc: RPCProtocol,
@@ -273,6 +274,7 @@ export function createAPIFactory(
     const editors = rpc.set(MAIN_RPC_CONTEXT.TEXT_EDITORS_EXT, new TextEditorsExtImpl(rpc, editorsAndDocumentsExt));
     const documents = rpc.set(MAIN_RPC_CONTEXT.DOCUMENTS_EXT, new DocumentsExtImpl(rpc, editorsAndDocumentsExt));
     const notebooksExt = rpc.set(MAIN_RPC_CONTEXT.NOTEBOOKS_EXT, new NotebooksExtImpl(rpc, commandRegistry, editorsAndDocumentsExt, documents));
+    const notebookEditors = rpc.set(MAIN_RPC_CONTEXT.NOTEBOOK_EDITORS_EXT, new NotebookEditorsExtImpl(notebooksExt));
     const notebookRenderers = rpc.set(MAIN_RPC_CONTEXT.NOTEBOOK_RENDERERS_EXT, new NotebookRenderersExtImpl(rpc, notebooksExt));
     const notebookKernels = rpc.set(MAIN_RPC_CONTEXT.NOTEBOOK_KERNELS_EXT, new NotebookKernelsExtImpl(rpc, notebooksExt, commandRegistry));
     const notebookDocuments = rpc.set(MAIN_RPC_CONTEXT.NOTEBOOK_DOCUMENTS_EXT, new NotebookDocumentsExtImpl(notebooksExt));
@@ -437,24 +439,24 @@ export function createAPIFactory(
                 }
             },
             get visibleNotebookEditors(): theia.NotebookEditor[] {
-                return [] as theia.NotebookEditor[];
+                return notebooksExt.visibleApiNotebookEditors;
             },
             onDidChangeVisibleNotebookEditors(listener, thisArg?, disposables?) {
-                return Disposable.NULL;
+                return notebooksExt.onDidChangeVisibleNotebookEditors(listener, thisArg, disposables);
             },
             get activeNotebookEditor(): theia.NotebookEditor | undefined {
                 return notebooksExt.activeApiNotebookEditor;
             }, onDidChangeActiveNotebookEditor(listener, thisArg?, disposables?) {
                 return notebooksExt.onDidChangeActiveNotebookEditor(listener, thisArg, disposables);
             },
             onDidChangeNotebookEditorSelection(listener, thisArg?, disposables?) {
-                return Disposable.NULL;
+                return notebookEditors.onDidChangeNotebookEditorSelection(listener, thisArg, disposables);
             },
             onDidChangeNotebookEditorVisibleRanges(listener, thisArg?, disposables?) {
-                return Disposable.NULL;
+                return notebookEditors.onDidChangeNotebookEditorVisibleRanges(listener, thisArg, disposables);
             },
             showNotebookDocument(document: NotebookDocument, options?: theia.NotebookDocumentShowOptions) {
-                return Promise.resolve({} as theia.NotebookEditor);
+                return notebooksExt.showNotebookDocument(document, options);
             },
             // eslint-disable-next-line @typescript-eslint/no-explicit-any
             showQuickPick(items: any, options?: theia.QuickPickOptions, token?: theia.CancellationToken): any {
@@ -626,7 +628,7 @@ export function createAPIFactory(
                 return workspaceExt.onDidChangeWorkspaceFolders(listener, thisArg, disposables);
             },
             get notebookDocuments(): theia.NotebookDocument[] {
-                return [] as theia.NotebookDocument[];
+                return notebooksExt.getAllApiDocuments();
             },
             get textDocuments(): theia.TextDocument[] {
                 return documents.getAllDocumentData().map(data => data.document);
@@ -696,8 +698,18 @@ export function createAPIFactory(
                 const data = await documents.openDocument(uri);
                 return data && data.document;
             },
-            openNotebookDocument(uriOrString: theia.Uri | string, content?: NotebookData): Promise<theia.NotebookDocument | undefined> {
-                return Promise.reject(new Error('Notebook API is stubbed'));
+            async openNotebookDocument(uriOrType: theia.Uri | string, content?: NotebookData): Promise<theia.NotebookDocument | undefined> {
+                let uri: URI;
+                if (URI.isUri(uriOrType)) {
+                    uri = uriOrType;
+                    await notebooksExt.openNotebookDocument(uriOrType as URI);
+                } else if (typeof uriOrType === 'string') {
+                    uri = URI.revive(await notebooksExt.createNotebookDocument({ viewType: uriOrType, content }));
+                } else {
+                    throw new Error('Invalid arguments');
+                }
+                return notebooksExt.getNotebookDocument(uri).apiNotebook;
+
             },
             createFileSystemWatcher: (pattern, ignoreCreate, ignoreChange, ignoreDelete): theia.FileSystemWatcher =>
                 extHostFileSystemEvent.createFileSystemWatcher(fromGlobPattern(pattern), ignoreCreate, ignoreChange, ignoreDelete),

packages/plugin-ext/src/plugin/types-impl.ts

@@ -1264,40 +1264,6 @@ export class NotebookData implements theia.NotebookData {
     }
 }
 
-export class NotebookDocument implements theia.NotebookDocument {
-    readonly uri: theia.Uri;
-    readonly notebookType: string;
-    readonly version: number;
-    readonly isDirty: boolean;
-    readonly isUntitled: boolean;
-    readonly isClosed: boolean;
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    readonly metadata: { [key: string]: any };
-    readonly cellCount: number;
-
-    cellAt(index: number): theia.NotebookCell {
-        return {} as theia.NotebookCell;
-    }
-    save(): theia.Thenable<boolean> {
-        return Promise.resolve(false);
-    }
-
-    getCells(range?: theia.NotebookRange | undefined): theia.NotebookCell[] {
-        return [] as NotebookCell[];
-    }
-}
-export class NotebookCell implements theia.NotebookCell {
-    readonly index: number;
-    readonly notebook: theia.NotebookDocument;
-    readonly kind: theia.NotebookCellKind;
-    readonly document: theia.TextDocument;
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    readonly metadata: { readonly [key: string]: any; };
-    readonly outputs: readonly theia.NotebookCellOutput[];
-    readonly executionSummary: theia.NotebookCellExecutionSummary | undefined;
-
-}
-
 export class NotebookRange implements theia.NotebookRange {
     static isNotebookRange(thing: unknown): thing is theia.NotebookRange {
         if (thing instanceof NotebookRange) {
@@ -1406,6 +1372,8 @@ export class NotebookEdit implements theia.NotebookEdit {
     constructor(range: NotebookRange, newCells: NotebookCellData[], newCellMetadata?: { [key: string]: unknown }, newNotebookMetadata?: { [key: string]: unknown }) {
         this.range = range;
         this.newCells = newCells;
+        this.newCellMetadata = newCellMetadata;
+        this.newNotebookMetadata = newNotebookMetadata;
     }
 
 }