Add interface to extension

demo/src/main.js

@@ -1,9 +1,8 @@
 /* eslint-disable @typescript-eslint/quotes */
 /* eslint-disable no-undef */
-import { CommandBridge } from 'jupyter-iframe-commands-host';
+import { createBridge } from 'jupyter-iframe-commands-host';
 
-const commandBridge = new CommandBridge({ iframeId: 'jupyterlab' })
-  .commandBridge;
+const commandBridge = createBridge({ iframeId: 'jupyterlab' });
 
 // Create and append dialogs to the document
 const instructionsDialog = document.createElement('dialog');

packages/extension/package.json

@@ -54,7 +54,8 @@
   },
   "dependencies": {
     "@jupyterlab/application": "^4.3.2",
-    "@jupyterlab/settingregistry": "^4.3.2"
+    "@jupyterlab/settingregistry": "^4.3.2",
+    "@lumino/coreutils": "^2.2.0"
   },
   "devDependencies": {
     "@jupyterlab/builder": "^4.3.2"

packages/extension/src/index.ts

@@ -8,6 +8,7 @@ import {
 import { ISettingRegistry } from '@jupyterlab/settingregistry';
 import { ReadonlyPartialJSONObject } from '@lumino/coreutils';
 import { expose, windowEndpoint } from 'comlink';
+import { ICommandBridgeRemote } from './interface';
 
 /**
  * A plugin to expose an API for interacting with JupyterLab from a parent page.
@@ -42,7 +43,7 @@ const plugin: JupyterFrontEndPlugin<void> = {
         });
     }
 
-    const api = {
+    const api: ICommandBridgeRemote = {
       execute(command: string, args: ReadonlyPartialJSONObject) {
         commands.execute(command, args);
       },
@@ -57,3 +58,4 @@ const plugin: JupyterFrontEndPlugin<void> = {
 };
 
 export default plugin;
+export * from './interface';

packages/extension/src/interface.ts

@@ -0,0 +1,6 @@
+import { ReadonlyPartialJSONObject } from '@lumino/coreutils';
+
+export interface ICommandBridgeRemote {
+  execute(command: string, args: ReadonlyPartialJSONObject): void;
+  listCommands(): string[];
+}

packages/host/package.json

@@ -42,8 +42,7 @@
     "watch": "tsc -b --watch"
   },
   "dependencies": {
-    "@lumino/commands": "^2.3.1",
-    "@lumino/coreutils": "^2.2.0",
-    "comlink": "^4.4.2"
+    "comlink": "^4.4.2",
+    "jupyter-iframe-commands": "0.0.1"
   }
 }

packages/host/src/index.ts

@@ -1,7 +1,7 @@
 // Copyright (c) TileDB, Inc.
 // Distributed under the terms of the Modified BSD License.
 import { Endpoint, Remote, windowEndpoint, wrap } from 'comlink';
-
+import { ICommandBridgeRemote } from 'jupyter-iframe-commands';
 /**
  * A bridge to expose actions on JupyterLab commands.
  */
@@ -22,13 +22,21 @@ export class CommandBridge {
     }
 
     this._endpoint = windowEndpoint(this._childWindow);
-    this.commandBridge = wrap(this._endpoint);
+    this._commandBridge = wrap(this._endpoint);
+  }
+
+  get commandBridge() {
+    return this._commandBridge;
   }
 
   private _iframe: HTMLIFrameElement | null;
   private _childWindow: Window | undefined | null;
   private _endpoint: Endpoint | undefined;
-  commandBridge: Remote<unknown> | undefined;
+  private _commandBridge: Remote<ICommandBridgeRemote> | undefined;
+}
+
+export function createBridge({ iframeId }: CommandBridge.IOptions) {
+  return new CommandBridge({ iframeId }).commandBridge;
 }
 
 export namespace CommandBridge {

yarn.lock

@@ -5885,9 +5885,8 @@ __metadata:
   version: 0.0.0-use.local
   resolution: "jupyter-iframe-commands-host@workspace:packages/host"
   dependencies:
-    "@lumino/commands": ^2.3.1
-    "@lumino/coreutils": ^2.2.0
     comlink: ^4.4.2
+    jupyter-iframe-commands: 0.0.1
   languageName: unknown
   linkType: soft
 
@@ -5921,13 +5920,14 @@ __metadata:
   languageName: unknown
   linkType: soft
 
-"jupyter-iframe-commands@workspace:packages/extension":
+"jupyter-iframe-commands@0.0.1, jupyter-iframe-commands@workspace:packages/extension":
   version: 0.0.0-use.local
   resolution: "jupyter-iframe-commands@workspace:packages/extension"
   dependencies:
     "@jupyterlab/application": ^4.3.2
     "@jupyterlab/builder": ^4.3.2
     "@jupyterlab/settingregistry": ^4.3.2
+    "@lumino/coreutils": ^2.2.0
   languageName: unknown
   linkType: soft