API design

[jtpio]

Currently a consumer of the companion package instantiates a CommandBridge with the following:

jupyter-iframe-commands/demo/src/main.js

Lines 5 to 6 in bab0f4e

	const commandBridge = new CommandBridge({ iframeId: 'jupyterlab' })
	.commandBridge;

And use it as follows:

jupyter-iframe-commands/demo/src/main.js

Line 98 in bab0f4e

const commands = await commandBridge.listCommands();

To access methods exposed by the JupyterLab extension:

jupyter-iframe-commands/packages/extension/src/index.ts

Lines 45 to 52 in bab0f4e

	const api = {
	execute(command: string, args: ReadonlyPartialJSONObject) {
	commands.execute(command, args);
	},
	listCommands() {
	return commands.listCommands();
	}
	};

Some points to consider for expanding the API surface:

• Currently only execute and listCommands are exposed from the extension, but more could be made available, for example hasCommand, isEnabled and likely more
• A consumer of CommandBridge on the host page currently does not get good discoverability on what methods are available. This could be improved by defining an interface for the CommandBridge, to get better documentation and completions from IDEs.