@jupyterlite/application 0.1.0-alpha.23

package/lib/index.d.ts

@@ -0,0 +1,2 @@
+export * from './singleWidgetApp';
+export * from './singleWidgetShell';

package/lib/index.js

@@ -0,0 +1,4 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
+export * from './singleWidgetApp';
+export * from './singleWidgetShell';

package/lib/singleWidgetApp.d.ts

@@ -0,0 +1,76 @@
+import { JupyterFrontEnd, JupyterFrontEndPlugin } from '@jupyterlab/application';
+import { LabStatus } from '@jupyterlab/application/lib/status';
+import { IRenderMime } from '@jupyterlab/rendermime-interfaces';
+import { ISingleWidgetShell } from './singleWidgetShell';
+/**
+ * App is the main application class. It is instantiated once and shared.
+ */
+export declare class SingleWidgetApp extends JupyterFrontEnd<ISingleWidgetShell> {
+    /**
+     * Construct a new SingleWidgetApp object.
+     *
+     * @param options The instantiation options for an application.
+     */
+    constructor(options?: SingleWidgetApp.IOptions);
+    /**
+     * The name of the application.
+     */
+    readonly name = "Single Widget Application";
+    /**
+     * A namespace/prefix plugins may use to denote their provenance.
+     */
+    readonly namespace = "Single Widget Application";
+    /**
+     * The application busy and dirty status signals and flags.
+     */
+    readonly status: LabStatus;
+    /**
+     * The version of the application.
+     */
+    readonly version: string;
+    /**
+     * The JupyterLab application paths dictionary.
+     */
+    get paths(): JupyterFrontEnd.IPaths;
+    /**
+     * Register plugins from a plugin module.
+     *
+     * @param mod - The plugin module to register.
+     */
+    registerPluginModule(mod: SingleWidgetApp.IPluginModule): void;
+    /**
+     * Register the plugins from multiple plugin modules.
+     *
+     * @param mods - The plugin modules to register.
+     */
+    registerPluginModules(mods: SingleWidgetApp.IPluginModule[]): void;
+}
+/**
+ * A namespace for App statics.
+ */
+export declare namespace SingleWidgetApp {
+    /**
+     * The instantiation options for an App application.
+     */
+    interface IOptions extends JupyterFrontEnd.IOptions<ISingleWidgetShell>, Partial<IInfo> {
+    }
+    /**
+     * The information about a Jupyter Notebook application.
+     */
+    interface IInfo {
+        /**
+         * The mime renderer extensions.
+         */
+        readonly mimeExtensions: IRenderMime.IExtensionModule[];
+    }
+    /**
+     * The interface for a module that exports a plugin or plugins as
+     * the default value.
+     */
+    interface IPluginModule {
+        /**
+         * The default export.
+         */
+        default: JupyterFrontEndPlugin<any> | JupyterFrontEndPlugin<any>[];
+    }
+}

package/lib/singleWidgetApp.js

@@ -0,0 +1,109 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
+import { JupyterFrontEnd } from '@jupyterlab/application';
+import { createRendermimePlugins } from '@jupyterlab/application/lib/mimerenderers';
+import { LabStatus } from '@jupyterlab/application/lib/status';
+import { PageConfig } from '@jupyterlab/coreutils';
+import { SingleWidgetShell } from './singleWidgetShell';
+/**
+ * App is the main application class. It is instantiated once and shared.
+ */
+export class SingleWidgetApp extends JupyterFrontEnd {
+    /**
+     * Construct a new SingleWidgetApp object.
+     *
+     * @param options The instantiation options for an application.
+     */
+    constructor(options = { shell: new SingleWidgetShell() }) {
+        var _a, _b;
+        super({
+            ...options,
+            shell: (_a = options.shell) !== null && _a !== void 0 ? _a : new SingleWidgetShell(),
+        });
+        /**
+         * The name of the application.
+         */
+        this.name = 'Single Widget Application';
+        /**
+         * A namespace/prefix plugins may use to denote their provenance.
+         */
+        this.namespace = this.name;
+        /**
+         * The application busy and dirty status signals and flags.
+         */
+        this.status = new LabStatus(this);
+        /**
+         * The version of the application.
+         */
+        this.version = (_b = PageConfig.getOption('appVersion')) !== null && _b !== void 0 ? _b : 'unknown';
+        if (options.mimeExtensions) {
+            for (const plugin of createRendermimePlugins(options.mimeExtensions)) {
+                this.registerPlugin(plugin);
+            }
+        }
+    }
+    /**
+     * The JupyterLab application paths dictionary.
+     */
+    get paths() {
+        return {
+            urls: {
+                base: PageConfig.getOption('baseUrl'),
+                notFound: PageConfig.getOption('notFoundUrl'),
+                app: PageConfig.getOption('appUrl'),
+                static: PageConfig.getOption('staticUrl'),
+                settings: PageConfig.getOption('settingsUrl'),
+                themes: PageConfig.getOption('themesUrl'),
+                doc: PageConfig.getOption('docUrl'),
+                translations: PageConfig.getOption('translationsApiUrl'),
+                hubHost: PageConfig.getOption('hubHost') || undefined,
+                hubPrefix: PageConfig.getOption('hubPrefix') || undefined,
+                hubUser: PageConfig.getOption('hubUser') || undefined,
+                hubServerName: PageConfig.getOption('hubServerName') || undefined,
+            },
+            directories: {
+                appSettings: PageConfig.getOption('appSettingsDir'),
+                schemas: PageConfig.getOption('schemasDir'),
+                static: PageConfig.getOption('staticDir'),
+                templates: PageConfig.getOption('templatesDir'),
+                themes: PageConfig.getOption('themesDir'),
+                userSettings: PageConfig.getOption('userSettingsDir'),
+                serverRoot: PageConfig.getOption('serverRoot'),
+                workspaces: PageConfig.getOption('workspacesDir'),
+            },
+        };
+    }
+    /**
+     * Register plugins from a plugin module.
+     *
+     * @param mod - The plugin module to register.
+     */
+    registerPluginModule(mod) {
+        let data = mod.default;
+        // Handle commonjs exports.
+        if (!Object.prototype.hasOwnProperty.call(mod, '__esModule')) {
+            data = mod;
+        }
+        if (!Array.isArray(data)) {
+            data = [data];
+        }
+        data.forEach((item) => {
+            try {
+                this.registerPlugin(item);
+            }
+            catch (error) {
+                console.error(error);
+            }
+        });
+    }
+    /**
+     * Register the plugins from multiple plugin modules.
+     *
+     * @param mods - The plugin modules to register.
+     */
+    registerPluginModules(mods) {
+        mods.forEach((mod) => {
+            this.registerPluginModule(mod);
+        });
+    }
+}

package/lib/singleWidgetShell.d.ts

@@ -0,0 +1,62 @@
+import { JupyterFrontEnd } from '@jupyterlab/application';
+import { DocumentRegistry } from '@jupyterlab/docregistry';
+import { IIterator } from '@lumino/algorithm';
+import { Token } from '@lumino/coreutils';
+import { ISignal } from '@lumino/signaling';
+import { Widget } from '@lumino/widgets';
+/**
+ * The single widget application shell token.
+ */
+export declare const ISingleWidgetShell: Token<ISingleWidgetShell>;
+/**
+ * The single widget application shell interface.
+ */
+export interface ISingleWidgetShell extends SingleWidgetShell {
+}
+/**
+ * The application shell.
+ */
+export declare class SingleWidgetShell extends Widget implements JupyterFrontEnd.IShell {
+    constructor();
+    /**
+     * A signal emitted when the current widget changes.
+     */
+    get currentChanged(): ISignal<ISingleWidgetShell, void>;
+    /**
+     * The current widget in the shell's main area.
+     */
+    get currentWidget(): Widget | null;
+    /**
+     * Activate a widget in its area.
+     */
+    activateById(id: string): void;
+    /**
+     * Add a widget to the application shell.
+     *
+     * @param widget - The widget being added.
+     *
+     * @param area - Optional region in the shell into which the widget should
+     * be added.
+     *
+     * @param options - Optional open options.
+     *
+     */
+    add(widget: Widget, area?: Shell.Area, options?: DocumentRegistry.IOpenOptions): void;
+    /**
+     * Return the list of widgets for the given area.
+     *
+     * @param area The area
+     */
+    widgets(area: Shell.Area): IIterator<Widget>;
+    private _main;
+    private _currentChanged;
+}
+/**
+ * A namespace for Shell statics
+ */
+export declare namespace Shell {
+    /**
+     * The areas of the application shell where widgets can reside.
+     */
+    type Area = 'main';
+}

package/lib/singleWidgetShell.js

@@ -0,0 +1,82 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
+import { find, iter } from '@lumino/algorithm';
+import { Token } from '@lumino/coreutils';
+import { Signal } from '@lumino/signaling';
+import { Panel, Widget, PanelLayout } from '@lumino/widgets';
+/**
+ * The single widget application shell token.
+ */
+export const ISingleWidgetShell = new Token('@jupyterlite/application:ISingleWidgetShell');
+/**
+ * The application shell.
+ */
+export class SingleWidgetShell extends Widget {
+    constructor() {
+        super();
+        this._currentChanged = new Signal(this);
+        this.id = 'main';
+        const rootLayout = new PanelLayout();
+        this._main = new Panel();
+        this._main.id = 'single-widget-panel';
+        rootLayout.addWidget(this._main);
+        this.layout = rootLayout;
+    }
+    /**
+     * A signal emitted when the current widget changes.
+     */
+    get currentChanged() {
+        return this._currentChanged;
+    }
+    /**
+     * The current widget in the shell's main area.
+     */
+    get currentWidget() {
+        var _a;
+        return (_a = this._main.widgets[0]) !== null && _a !== void 0 ? _a : null;
+    }
+    /**
+     * Activate a widget in its area.
+     */
+    activateById(id) {
+        const widget = find(this.widgets('main'), (w) => w.id === id);
+        if (widget) {
+            widget.activate();
+        }
+    }
+    /**
+     * Add a widget to the application shell.
+     *
+     * @param widget - The widget being added.
+     *
+     * @param area - Optional region in the shell into which the widget should
+     * be added.
+     *
+     * @param options - Optional open options.
+     *
+     */
+    add(widget, area, options) {
+        if (area === 'main' || area === undefined) {
+            if (this._main.widgets.length > 0) {
+                // do not add the widget if there is already one
+                return;
+            }
+            this._main.addWidget(widget);
+            this._main.update();
+            this._currentChanged.emit(void 0);
+        }
+    }
+    /**
+     * Return the list of widgets for the given area.
+     *
+     * @param area The area
+     */
+    widgets(area) {
+        switch (area !== null && area !== void 0 ? area : 'main') {
+            case 'main':
+                return iter(this._main.widgets);
+            default:
+                throw new Error(`Invalid area: ${area}`);
+        }
+    }
+}

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@jupyterlite/application",
+  "version": "0.1.0-alpha.23",
+  "description": "JupyterLite - Application",
+  "homepage": "https://github.com/jupyterlite/jupyterlite",
+  "bugs": {
+    "url": "https://github.com/jupyterlite/jupyterlite/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/jupyterlite/jupyterlite.git"
+  },
+  "license": "BSD-3-Clause",
+  "author": "JupyterLite Contributors",
+  "sideEffects": [
+    "style/*.css",
+    "style/index.js"
+  ],
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "style": "style/index.css",
+  "directories": {
+    "lib": "lib/"
+  },
+  "files": [
+    "lib/*.d.ts",
+    "lib/*.js.map",
+    "lib/*.js",
+    "style/*.css",
+    "style/index.js"
+  ],
+  "scripts": {
+    "build": "tsc -b",
+    "clean": "rimraf lib && rimraf tsconfig.tsbuildinfo",
+    "docs": "typedoc src",
+    "prepublishOnly": "npm run build",
+    "watch": "tsc -b --watch"
+  },
+  "dependencies": {
+    "@jupyterlab/application": "~3.2.9",
+    "@jupyterlab/coreutils": "~5.2.9",
+    "@jupyterlab/docregistry": "~3.2.9",
+    "@jupyterlab/rendermime-interfaces": "~3.2.9",
+    "@lumino/coreutils": "^1.12.0",
+    "@lumino/signaling": "^1.10.1",
+    "@lumino/widgets": "^1.31.1"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.11.6",
+    "@babel/preset-env": "^7.12.1",
+    "@jupyterlab/testutils": "~3.2.9",
+    "@types/jest": "^26.0.10",
+    "jest": "^26.4.2",
+    "rimraf": "~3.0.0",
+    "ts-jest": "^26.3.0",
+    "typescript": "~4.5.2"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "jupyterlab": {
+    "coreDependency": true
+  },
+  "styleModule": "style/index.js"
+}

package/style/base.css

@@ -0,0 +1,22 @@
+/*-----------------------------------------------------------------------------
+| Copyright (c) Jupyter Development Team.
+| Distributed under the terms of the Modified BSD License.
+|----------------------------------------------------------------------------*/
+
+body {
+  margin: 0;
+  padding: 0;
+  background: var(--jp-layout-color2);
+}
+
+#main {
+  position: absolute;
+  top: 0;
+  left: 0;
+  right: 0;
+  bottom: 0;
+}
+
+#single-widget-panel {
+  height: 100%;
+}

package/style/index.css

@@ -0,0 +1,8 @@
+/*-----------------------------------------------------------------------------
+| Copyright (c) Jupyter Development Team.
+| Distributed under the terms of the Modified BSD License.
+|----------------------------------------------------------------------------*/
+
+@import url('~@jupyterlab/application/style/index.css');
+
+@import url('./base.css');

package/style/index.js

@@ -0,0 +1,8 @@
+/*-----------------------------------------------------------------------------
+| Copyright (c) Jupyter Development Team.
+| Distributed under the terms of the Modified BSD License.
+|----------------------------------------------------------------------------*/
+
+import '@jupyterlab/application/style/index.js';
+
+import './base.css';