Widget with toolbar and sidepanel in cell output (#419)

* Add minimal Context interface for jupytergis widgets

* Add a new widget to be include in Notebook cell output

* Fix the relative path issue when add a layer in cell output widget

* Use context 'localPath' instaed of 'path' to avoid 'RTC:' in the path

* Handle the resize event of the cell output widget

* lint

* Use the model (IJupyterGISModel) instead of the context in the components and tracker

* lint

* Fix dependencies in '@jupytergis/jupytergis-lab' package

* Allow using the python API without file on disk

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* lint

* Update Playwright Snapshots

* Use the notebook or console path as temporary project path, when using the API without file

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Rename widget for consistency, and remove console comands from cell output widget

* Build again the widget if the path is updated, to add the toolbar if necessary

* Add the widget to the tracker after rebuilt, and fix the model path, that can be updated between the model creation and the widget creation.

* Dispose of the widget when the model is disposed

* lint

* Do not dispose of the model when clearing cell output

* Dispose of the GIS widget when the yjs widget is disposed

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Author: 3 people

packages/base/src/annotations/components/Annotation.tsx

@@ -36,7 +36,7 @@ const Annotation = ({
    * Update the model when it changes.
    */
   rightPanelModel?.documentChanged.connect((_, widget) => {
-    setJgisModel(widget?.context.model);
+    setJgisModel(widget?.model);
   });
 
   const handleSubmit = () => {

packages/base/src/annotations/model.ts

@@ -4,13 +4,12 @@ import {
   IAnnotationModel,
   IJupyterGISModel
 } from '@jupytergis/schema';
-import { DocumentRegistry } from '@jupyterlab/docregistry';
 import { User } from '@jupyterlab/services';
 import { ISignal, Signal } from '@lumino/signaling';
 
 export class AnnotationModel implements IAnnotationModel {
   constructor(options: AnnotationModel.IOptions) {
-    this.context = options.context;
+    this.model = options.model;
   }
 
   get updateSignal(): ISignal<this, null> {
@@ -21,39 +20,37 @@ export class AnnotationModel implements IAnnotationModel {
     return this._user;
   }
 
-  set context(
-    context: DocumentRegistry.IContext<IJupyterGISModel> | undefined
-  ) {
-    this._context = context;
+  set model(model: IJupyterGISModel | undefined) {
+    this._model = model;
 
-    const state = this._context?.model.sharedModel.awareness.getLocalState();
+    const state = this._model?.sharedModel.awareness.getLocalState();
     this._user = state?.user;
 
-    this._contextChanged.emit(void 0);
+    this._modelChanged.emit(void 0);
   }
 
-  get context(): DocumentRegistry.IContext<IJupyterGISModel> | undefined {
-    return this._context;
+  get model(): IJupyterGISModel | undefined {
+    return this._model;
   }
 
-  get contextChanged(): ISignal<this, void> {
-    return this._contextChanged;
+  get modelChanged(): ISignal<this, void> {
+    return this._modelChanged;
   }
 
   update(): void {
     this._updateSignal.emit(null);
   }
 
   getAnnotation(id: string): IAnnotation | undefined {
-    const rawData = this._context?.model.sharedModel.getMetadata(id);
+    const rawData = this._model?.sharedModel.getMetadata(id);
     if (rawData) {
       return JSON.parse(rawData) as IAnnotation;
     }
   }
 
   getAnnotationIds(): string[] {
     const annotationIds: string[] = [];
-    for (const id in this._context?.model.sharedModel.metadata) {
+    for (const id in this._model?.sharedModel.metadata) {
       if (id.startsWith('annotation')) {
         annotationIds.push(id);
       }
@@ -62,14 +59,14 @@ export class AnnotationModel implements IAnnotationModel {
   }
 
   addAnnotation(key: string, value: IAnnotation): void {
-    this._context?.model.sharedModel.setMetadata(
+    this._model?.sharedModel.setMetadata(
       `annotation_${key}`,
       JSON.stringify(value)
     );
   }
 
   removeAnnotation(key: string): void {
-    this._context?.model.removeMetadata(key);
+    this._model?.removeMetadata(key);
   }
 
   addContent(id: string, value: string): void {
@@ -84,21 +81,18 @@ export class AnnotationModel implements IAnnotationModel {
         contents: [...currentAnnotation.contents, newContent]
       };
 
-      this._context?.model.sharedModel.setMetadata(
-        id,
-        JSON.stringify(newAnnotation)
-      );
+      this._model?.sharedModel.setMetadata(id, JSON.stringify(newAnnotation));
     }
   }
 
-  private _context: DocumentRegistry.IContext<IJupyterGISModel> | undefined;
-  private _contextChanged = new Signal<this, void>(this);
+  private _model: IJupyterGISModel | undefined;
+  private _modelChanged = new Signal<this, void>(this);
   private _updateSignal = new Signal<this, null>(this);
   private _user?: User.IIdentity;
 }
 
 namespace AnnotationModel {
   export interface IOptions {
-    context: DocumentRegistry.IContext<IJupyterGISModel> | undefined;
+    model: IJupyterGISModel | undefined;
   }
 }