Create launcher button (#97)

Author: trungleduc

package.json

@@ -62,6 +62,7 @@
     "@jupyterlab/apputils": "^4.0.0",
     "@jupyterlab/coreutils": "^6.0.0",
     "@jupyterlab/docregistry": "^4.0.0",
+    "@jupyterlab/launcher": "^4.0.2",
     "@jupyterlab/mainmenu": "^4.0.0",
     "@jupyterlab/notebook": "^4.0.0",
     "@jupyterlab/observables": "^5.0.0",

src/commands.ts

@@ -2,6 +2,8 @@
  * The command IDs used by the control panel.
  */
 export namespace CommandIDs {
+  export const createNew = 'glue-control:new-session';
+
   export const new1DHistogram = 'glue-control:new-1d-histogram-viewer';
 
   export const new2DImage = 'glue-control:new-2d-image-viewer';

src/document/default.json

@@ -0,0 +1,23 @@
+{
+  "DataCollection": {
+    "_protocol": 4,
+    "_type": "glue.core.data_collection.DataCollection",
+    "cids": [],
+    "components": [],
+    "data": [],
+    "groups": [],
+    "links": [],
+    "subset_group_count": 0
+  },
+  "Session": {
+    "_type": "glue.core.session.Session"
+  },
+  "__main__": {
+    "_type": "glue.app.qt.application.GlueApplication",
+    "data": "DataCollection",
+    "plugins": [],
+    "session": "Session",
+    "tab_names": ["Tab 1"],
+    "viewers": [[]]
+  }
+}

src/document/plugin.ts

@@ -1,22 +1,26 @@
-import { IRenderMimeRegistry } from '@jupyterlab/rendermime';
-import {
-  JupyterFrontEnd,
-  JupyterFrontEndPlugin
-} from '@jupyterlab/application';
-import { WidgetTracker } from '@jupyterlab/apputils';
-
 import {
   ICollaborativeDrive,
   SharedDocumentFactory
 } from '@jupyter/docprovider';
+import {
+  JupyterFrontEnd,
+  JupyterFrontEndPlugin
+} from '@jupyterlab/application';
+import { ICommandPalette, WidgetTracker } from '@jupyterlab/apputils';
+import { IFileBrowserFactory } from '@jupyterlab/filebrowser';
+import { ILauncher } from '@jupyterlab/launcher';
+import { INotebookTracker } from '@jupyterlab/notebook';
+import { IRenderMimeRegistry } from '@jupyterlab/rendermime';
+import { IJupyterYWidgetManager } from 'yjs-widgets';
 
+import { CommandIDs } from '../commands';
 import { IGlueSessionTracker } from '../token';
+import { glueIcon } from '../tools';
+import defaultContent from './default.json';
 import { GlueSessionModelFactory } from './modelFactory';
+import { GlueSessionSharedModel } from './sharedModel';
 import { GlueSessionTracker } from './tracker';
 import { GlueCanvasWidgetFactory } from './widgetFactory';
-import { GlueSessionSharedModel } from './sharedModel';
-import { INotebookTracker } from '@jupyterlab/notebook';
-import { IJupyterYWidgetManager } from 'yjs-widgets';
 
 const NAME_SPACE = 'gluepyter';
 
@@ -97,3 +101,65 @@ export const gluePlugin: JupyterFrontEndPlugin<void> = {
     );
   }
 };
+
+/**
+ * Add launcher button to create a new glue session.
+ */
+export const newFilePlugin: JupyterFrontEndPlugin<void> = {
+  id: 'gluepyter:create-new-plugin',
+  autoStart: true,
+  requires: [IFileBrowserFactory],
+  optional: [ILauncher, ICommandPalette],
+  activate: (
+    app: JupyterFrontEnd,
+    browserFactory: IFileBrowserFactory,
+    launcher?: ILauncher,
+    commandPalette?: ICommandPalette
+  ) => {
+    const { commands } = app;
+    commands.addCommand(CommandIDs.createNew, {
+      label: args => 'New Glue Session',
+      caption: 'Create a new Glue Session',
+      icon: args => (args['isPalette'] ? undefined : glueIcon),
+      execute: async args => {
+        const cwd = (args['cwd'] ||
+          browserFactory.tracker.currentWidget?.model.path) as string;
+
+        let model = await app.serviceManager.contents.newUntitled({
+          path: cwd,
+          type: 'file',
+          ext: '.glu'
+        });
+        model = await app.serviceManager.contents.save(model.path, {
+          ...model,
+          format: 'text',
+          size: undefined,
+          content: JSON.stringify(defaultContent)
+        });
+
+        // Open the newly created file with the 'Editor'
+        return app.commands.execute('docmanager:open', {
+          path: model.path
+        });
+      }
+    });
+
+    // Add the command to the launcher
+    if (launcher) {
+      launcher.add({
+        command: CommandIDs.createNew,
+        category: 'Gluepyter',
+        rank: 1
+      });
+    }
+
+    // Add the command to the palette
+    if (commandPalette) {
+      commandPalette.addItem({
+        command: CommandIDs.createNew,
+        args: { isPalette: true },
+        category: 'Gluepyter'
+      });
+    }
+  }
+};

src/index.ts

@@ -1,10 +1,15 @@
 import { controlPanel } from './leftPanel/plugin';
-import { gluePlugin, sessionTrackerPlugin } from './document/plugin';
+import {
+  gluePlugin,
+  sessionTrackerPlugin,
+  newFilePlugin
+} from './document/plugin';
 import { yGlueSessionWidgetPlugin } from './yWidget';
 
 export default [
   sessionTrackerPlugin,
   gluePlugin,
   controlPanel,
-  yGlueSessionWidgetPlugin
+  yGlueSessionWidgetPlugin,
+  newFilePlugin
 ];

tsconfig.json

@@ -20,5 +20,5 @@
     "target": "ES2018",
     "types": ["jest"]
   },
-  "include": ["src/**/*"]
+  "include": ["src/**/*", "src/document/*.json"]
 }

yarn.lock

@@ -2431,6 +2431,24 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@jupyterlab/launcher@npm:^4.0.2":
+  version: 4.0.2
+  resolution: "@jupyterlab/launcher@npm:4.0.2"
+  dependencies:
+    "@jupyterlab/apputils": ^4.1.2
+    "@jupyterlab/translation": ^4.0.2
+    "@jupyterlab/ui-components": ^4.0.2
+    "@lumino/algorithm": ^2.0.0
+    "@lumino/commands": ^2.1.1
+    "@lumino/coreutils": ^2.1.1
+    "@lumino/disposable": ^2.1.1
+    "@lumino/properties": ^2.0.0
+    "@lumino/widgets": ^2.1.1
+    react: ^18.2.0
+  checksum: 4415fb8d2db8701857f21c515a8d4680133ffb5023b005681abd5f2df353a6cbb0e16099e35f363df44f015d4784a267c355c807ab840a15f63f1f3c219c7d11
+  languageName: node
+  linkType: hard
+
 "@jupyterlab/lsp@npm:^4.0.2":
   version: 4.0.2
   resolution: "@jupyterlab/lsp@npm:4.0.2"
@@ -6220,6 +6238,7 @@ __metadata:
     "@jupyterlab/builder": ^4.0.0
     "@jupyterlab/coreutils": ^6.0.0
     "@jupyterlab/docregistry": ^4.0.0
+    "@jupyterlab/launcher": ^4.0.2
     "@jupyterlab/mainmenu": ^4.0.0
     "@jupyterlab/notebook": ^4.0.0
     "@jupyterlab/observables": ^5.0.0