@jupyterlab/pluginmanager-extension 4.1.0-alpha.2

package/lib/index.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @packageDocumentation
+ * @module pluginmanager-extension
+ */
+import { JupyterFrontEndPlugin } from '@jupyterlab/application';
+declare const plugins: JupyterFrontEndPlugin<any>[];
+export default plugins;

package/lib/index.js

@@ -0,0 +1,131 @@
+/* -----------------------------------------------------------------------------
+| Copyright (c) Jupyter Development Team.
+| Distributed under the terms of the Modified BSD License.
+|----------------------------------------------------------------------------*/
+/**
+ * @packageDocumentation
+ * @module pluginmanager-extension
+ */
+import { ILayoutRestorer } from '@jupyterlab/application';
+import { ICommandPalette, MainAreaWidget, WidgetTracker } from '@jupyterlab/apputils';
+import { ITranslator, nullTranslator } from '@jupyterlab/translation';
+import { CommandToolbarButton, extensionIcon, refreshIcon } from '@jupyterlab/ui-components';
+import { IPluginManager, PluginListModel, Plugins } from '@jupyterlab/pluginmanager';
+/**
+ * The command IDs used by the pluginmanager plugin.
+ */
+var CommandIDs;
+(function (CommandIDs) {
+    CommandIDs.open = 'pluginmanager:open';
+    CommandIDs.refreshPlugins = 'pluginmanager:refresh';
+})(CommandIDs || (CommandIDs = {}));
+const PLUGIN_ID = '@jupyterlab/pluginmanager-extension:plugin';
+/**
+ * A plugin for managing status of other plugins.
+ */
+const pluginmanager = {
+    id: PLUGIN_ID,
+    description: 'Enable or disable individual plugins.',
+    autoStart: true,
+    requires: [],
+    optional: [ITranslator, ICommandPalette, ILayoutRestorer],
+    provides: IPluginManager,
+    activate: (app, translator, palette, restorer) => {
+        const { commands, shell } = app;
+        translator = translator !== null && translator !== void 0 ? translator : nullTranslator;
+        const trans = translator.load('jupyterlab');
+        // Translation strings.
+        const category = trans.__('Plugin Manager');
+        const widgetLabel = trans.__('Advanced Plugin Manager');
+        const refreshPlugins = trans.__('Refresh Plugin List');
+        const namespace = 'plugin-manager';
+        const tracker = new WidgetTracker({
+            namespace: namespace
+        });
+        /**
+         * Create a MainAreaWidget for Plugin Manager.
+         */
+        function createWidget(args) {
+            const model = new PluginListModel({
+                ...args,
+                pluginData: {
+                    availablePlugins: app.info.availablePlugins
+                },
+                serverSettings: app.serviceManager.serverSettings,
+                extraLockedPlugins: [
+                    PLUGIN_ID,
+                    // UI will not proceed beyond splash without `layout` plugin
+                    '@jupyterlab/application-extension:layout',
+                    // State restoration does not work well without resolver,
+                    // can leave user locked out of the plugin manager
+                    // (if command palette and menu are disabled too)
+                    '@jupyterlab/apputils-extension:resolver'
+                ],
+                translator: translator !== null && translator !== void 0 ? translator : nullTranslator
+            });
+            const content = new Plugins({
+                model,
+                translator: translator !== null && translator !== void 0 ? translator : nullTranslator
+            });
+            content.title.label = widgetLabel;
+            content.title.icon = extensionIcon;
+            const main = new MainAreaWidget({ content, reveal: model.ready });
+            main.toolbar.addItem('refresh-plugins', new CommandToolbarButton({
+                id: CommandIDs.refreshPlugins,
+                args: { noLabel: true },
+                commands
+            }));
+            return main;
+        }
+        // Register commands.
+        commands.addCommand(CommandIDs.open, {
+            label: widgetLabel,
+            execute: args => {
+                const main = createWidget(args);
+                shell.add(main, 'main', { type: 'Plugins' });
+                // add to tracker so it can be restored, and update when choices change
+                void tracker.add(main);
+                main.content.model.trackerDataChanged.connect(() => {
+                    void tracker.save(main);
+                });
+                return main;
+            }
+        });
+        commands.addCommand(CommandIDs.refreshPlugins, {
+            label: args => (args.noLabel ? '' : refreshPlugins),
+            caption: trans.__('Refresh plugins list'),
+            icon: refreshIcon,
+            execute: async () => {
+                var _a;
+                return (_a = tracker.currentWidget) === null || _a === void 0 ? void 0 : _a.content.model.refresh().catch((reason) => {
+                    console.error(`Failed to refresh the available plugins list:\n${reason}`);
+                });
+            }
+        });
+        if (palette) {
+            palette.addItem({ command: CommandIDs.open, category });
+        }
+        if (restorer) {
+            void restorer.restore(tracker, {
+                command: CommandIDs.open,
+                name: _ => 'plugins',
+                args: widget => {
+                    const { query, isDisclaimed } = widget.content.model;
+                    const args = {
+                        query,
+                        isDisclaimed
+                    };
+                    return args;
+                }
+            });
+        }
+        return {
+            open: () => {
+                return app.commands.execute(CommandIDs.open);
+            }
+        };
+    }
+};
+const plugins = [pluginmanager];
+export default plugins;
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;+EAG+E;AAC/E;;;GAGG;AACH,OAAO,EACL,eAAe,EAGhB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACL,eAAe,EACf,cAAc,EACd,aAAa,EACd,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACtE,OAAO,EACL,oBAAoB,EACpB,aAAa,EACb,WAAW,EACZ,MAAM,2BAA2B,CAAC;AAEnC,OAAO,EACL,cAAc,EACd,eAAe,EACf,OAAO,EACR,MAAM,2BAA2B,CAAC;AAEnC;;GAEG;AACH,IAAU,UAAU,CAInB;AAJD,WAAU,UAAU;IACL,eAAI,GAAG,oBAAoB,CAAC;IAE5B,yBAAc,GAAG,uBAAuB,CAAC;AACxD,CAAC,EAJS,UAAU,KAAV,UAAU,QAInB;AAED,MAAM,SAAS,GAAG,4CAA4C,CAAC;AAE/D;;GAEG;AACH,MAAM,aAAa,GAA0C;IAC3D,EAAE,EAAE,SAAS;IACb,WAAW,EAAE,uCAAuC;IACpD,SAAS,EAAE,IAAI;IACf,QAAQ,EAAE,EAAE;IACZ,QAAQ,EAAE,CAAC,WAAW,EAAE,eAAe,EAAE,eAAe,CAAC;IACzD,QAAQ,EAAE,cAAc;IACxB,QAAQ,EAAE,CACR,GAAe,EACf,UAA8B,EAC9B,OAA+B,EAC/B,QAAgC,EAChC,EAAE;QACF,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,GAAG,CAAC;QAChC,UAAU,GAAG,UAAU,aAAV,UAAU,cAAV,UAAU,GAAI,cAAc,CAAC;QAC1C,MAAM,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAE5C,uBAAuB;QACvB,MAAM,QAAQ,GAAG,KAAK,CAAC,EAAE,CAAC,gBAAgB,CAAC,CAAC;QAC5C,MAAM,WAAW,GAAG,KAAK,CAAC,EAAE,CAAC,yBAAyB,CAAC,CAAC;QACxD,MAAM,cAAc,GAAG,KAAK,CAAC,EAAE,CAAC,qBAAqB,CAAC,CAAC;QAEvD,MAAM,SAAS,GAAG,gBAAgB,CAAC;QACnC,MAAM,OAAO,GAAG,IAAI,aAAa,CAA0B;YACzD,SAAS,EAAE,SAAS;SACrB,CAAC,CAAC;QAEH;;WAEG;QACH,SAAS,YAAY,CAAC,IAAyC;YAC7D,MAAM,KAAK,GAAG,IAAI,eAAe,CAAC;gBAChC,GAAG,IAAI;gBACP,UAAU,EAAE;oBACV,gBAAgB,EAAE,GAAG,CAAC,IAAI,CAAC,gBAAgB;iBAC5C;gBACD,cAAc,EAAE,GAAG,CAAC,cAAc,CAAC,cAAc;gBACjD,kBAAkB,EAAE;oBAClB,SAAS;oBACT,4DAA4D;oBAC5D,0CAA0C;oBAC1C,yDAAyD;oBACzD,kDAAkD;oBAClD,iDAAiD;oBACjD,yCAAyC;iBAC1C;gBACD,UAAU,EAAE,UAAU,aAAV,UAAU,cAAV,UAAU,GAAI,cAAc;aACzC,CAAC,CAAC;YACH,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC;gBAC1B,KAAK;gBACL,UAAU,EAAE,UAAU,aAAV,UAAU,cAAV,UAAU,GAAI,cAAc;aACzC,CAAC,CAAC;YACH,OAAO,CAAC,KAAK,CAAC,KAAK,GAAG,WAAW,CAAC;YAClC,OAAO,CAAC,KAAK,CAAC,IAAI,GAAG,aAAa,CAAC;YACnC,MAAM,IAAI,GAAG,IAAI,cAAc,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC;YAElE,IAAI,CAAC,OAAO,CAAC,OAAO,CAClB,iBAAiB,EACjB,IAAI,oBAAoB,CAAC;gBACvB,EAAE,EAAE,UAAU,CAAC,cAAc;gBAC7B,IAAI,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE;gBACvB,QAAQ;aACT,CAAC,CACH,CAAC;YAEF,OAAO,IAAI,CAAC;QACd,CAAC;QAED,qBAAqB;QACrB,QAAQ,CAAC,UAAU,CAAC,UAAU,CAAC,IAAI,EAAE;YACnC,KAAK,EAAE,WAAW;YAClB,OAAO,EAAE,IAAI,CAAC,EAAE;gBACd,MAAM,IAAI,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;gBAChC,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC;gBAE7C,uEAAuE;gBACvE,KAAK,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;gBACvB,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,kBAAkB,CAAC,OAAO,CAAC,GAAG,EAAE;oBACjD,KAAK,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC1B,CAAC,CAAC,CAAC;gBACH,OAAO,IAAI,CAAC;YACd,CAAC;SACF,CAAC,CAAC;QAEH,QAAQ,CAAC,UAAU,CAAC,UAAU,CAAC,cAAc,EAAE;YAC7C,KAAK,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,cAAc,CAAC;YACnD,OAAO,EAAE,KAAK,CAAC,EAAE,CAAC,sBAAsB,CAAC;YACzC,IAAI,EAAE,WAAW;YACjB,OAAO,EAAE,KAAK,IAAI,EAAE;;gBAClB,OAAO,MAAA,OAAO,CAAC,aAAa,0CAAE,OAAO,CAAC,KAAK,CACxC,OAAO,GACP,KAAK,CAAC,CAAC,MAAa,EAAE,EAAE;oBACvB,OAAO,CAAC,KAAK,CACX,kDAAkD,MAAM,EAAE,CAC3D,CAAC;gBACJ,CAAC,CAAC,CAAC;YACP,CAAC;SACF,CAAC,CAAC;QAEH,IAAI,OAAO,EAAE;YACX,OAAO,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,UAAU,CAAC,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC;SACzD;QAED,IAAI,QAAQ,EAAE;YACZ,KAAK,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE;gBAC7B,OAAO,EAAE,UAAU,CAAC,IAAI;gBACxB,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,SAAS;gBACpB,IAAI,EAAE,MAAM,CAAC,EAAE;oBACb,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC;oBACrD,MAAM,IAAI,GAAuC;wBAC/C,KAAK;wBACL,YAAY;qBACb,CAAC;oBACF,OAAO,IAA0B,CAAC;gBACpC,CAAC;aACF,CAAC,CAAC;SACJ;QACD,OAAO;YACL,IAAI,EAAE,GAAG,EAAE;gBACT,OAAO,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;YAC/C,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC;AAEF,MAAM,OAAO,GAAiC,CAAC,aAAa,CAAC,CAAC;AAE9D,eAAe,OAAO,CAAC"}

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@jupyterlab/pluginmanager-extension",
+  "version": "4.1.0-alpha.2",
+  "description": "Enable/disable plugins from user interface",
+  "homepage": "https://github.com/jupyterlab/jupyterlab",
+  "bugs": {
+    "url": "https://github.com/jupyterlab/jupyterlab/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/jupyterlab/jupyterlab.git"
+  },
+  "license": "BSD-3-Clause",
+  "author": "Project Jupyter",
+  "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,eot,gif,html,jpg,js,js.map,json,png,svg,woff2,ttf}",
+    "schema/*.json",
+    "style/**/*.{css,eot,gif,html,jpg,json,png,svg,woff2,ttf}",
+    "src/**/*.{ts,tsx}",
+    "style/index.js"
+  ],
+  "scripts": {
+    "build": "tsc -b",
+    "build:test": "tsc --build tsconfig.test.json",
+    "clean": "rimraf lib tsconfig.tsbuildinfo",
+    "watch": "tsc -b --watch"
+  },
+  "dependencies": {
+    "@jupyterlab/application": "^4.1.0-alpha.2",
+    "@jupyterlab/apputils": "^4.2.0-alpha.2",
+    "@jupyterlab/pluginmanager": "^4.1.0-alpha.2",
+    "@jupyterlab/translation": "^4.1.0-alpha.2",
+    "@jupyterlab/ui-components": "^4.1.0-alpha.2",
+    "@lumino/coreutils": "^2.1.2"
+  },
+  "devDependencies": {
+    "rimraf": "~3.0.0",
+    "typescript": "~5.0.4"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "jupyterlab": {
+    "extension": true
+  },
+  "styleModule": "style/index.js"
+}

package/src/index.ts

@@ -0,0 +1,173 @@
+/* -----------------------------------------------------------------------------
+| Copyright (c) Jupyter Development Team.
+| Distributed under the terms of the Modified BSD License.
+|----------------------------------------------------------------------------*/
+/**
+ * @packageDocumentation
+ * @module pluginmanager-extension
+ */
+import {
+  ILayoutRestorer,
+  JupyterFrontEndPlugin,
+  JupyterLab
+} from '@jupyterlab/application';
+import {
+  ICommandPalette,
+  MainAreaWidget,
+  WidgetTracker
+} from '@jupyterlab/apputils';
+import { ITranslator, nullTranslator } from '@jupyterlab/translation';
+import {
+  CommandToolbarButton,
+  extensionIcon,
+  refreshIcon
+} from '@jupyterlab/ui-components';
+import { ReadonlyJSONObject } from '@lumino/coreutils';
+import {
+  IPluginManager,
+  PluginListModel,
+  Plugins
+} from '@jupyterlab/pluginmanager';
+
+/**
+ * The command IDs used by the pluginmanager plugin.
+ */
+namespace CommandIDs {
+  export const open = 'pluginmanager:open';
+
+  export const refreshPlugins = 'pluginmanager:refresh';
+}
+
+const PLUGIN_ID = '@jupyterlab/pluginmanager-extension:plugin';
+
+/**
+ * A plugin for managing status of other plugins.
+ */
+const pluginmanager: JupyterFrontEndPlugin<IPluginManager> = {
+  id: PLUGIN_ID,
+  description: 'Enable or disable individual plugins.',
+  autoStart: true,
+  requires: [],
+  optional: [ITranslator, ICommandPalette, ILayoutRestorer],
+  provides: IPluginManager,
+  activate: (
+    app: JupyterLab,
+    translator: ITranslator | null,
+    palette: ICommandPalette | null,
+    restorer: ILayoutRestorer | null
+  ) => {
+    const { commands, shell } = app;
+    translator = translator ?? nullTranslator;
+    const trans = translator.load('jupyterlab');
+
+    // Translation strings.
+    const category = trans.__('Plugin Manager');
+    const widgetLabel = trans.__('Advanced Plugin Manager');
+    const refreshPlugins = trans.__('Refresh Plugin List');
+
+    const namespace = 'plugin-manager';
+    const tracker = new WidgetTracker<MainAreaWidget<Plugins>>({
+      namespace: namespace
+    });
+
+    /**
+     * Create a MainAreaWidget for Plugin Manager.
+     */
+    function createWidget(args?: PluginListModel.IConfigurableState) {
+      const model = new PluginListModel({
+        ...args,
+        pluginData: {
+          availablePlugins: app.info.availablePlugins
+        },
+        serverSettings: app.serviceManager.serverSettings,
+        extraLockedPlugins: [
+          PLUGIN_ID,
+          // UI will not proceed beyond splash without `layout` plugin
+          '@jupyterlab/application-extension:layout',
+          // State restoration does not work well without resolver,
+          // can leave user locked out of the plugin manager
+          // (if command palette and menu are disabled too)
+          '@jupyterlab/apputils-extension:resolver'
+        ],
+        translator: translator ?? nullTranslator
+      });
+      const content = new Plugins({
+        model,
+        translator: translator ?? nullTranslator
+      });
+      content.title.label = widgetLabel;
+      content.title.icon = extensionIcon;
+      const main = new MainAreaWidget({ content, reveal: model.ready });
+
+      main.toolbar.addItem(
+        'refresh-plugins',
+        new CommandToolbarButton({
+          id: CommandIDs.refreshPlugins,
+          args: { noLabel: true },
+          commands
+        })
+      );
+
+      return main;
+    }
+
+    // Register commands.
+    commands.addCommand(CommandIDs.open, {
+      label: widgetLabel,
+      execute: args => {
+        const main = createWidget(args);
+        shell.add(main, 'main', { type: 'Plugins' });
+
+        // add to tracker so it can be restored, and update when choices change
+        void tracker.add(main);
+        main.content.model.trackerDataChanged.connect(() => {
+          void tracker.save(main);
+        });
+        return main;
+      }
+    });
+
+    commands.addCommand(CommandIDs.refreshPlugins, {
+      label: args => (args.noLabel ? '' : refreshPlugins),
+      caption: trans.__('Refresh plugins list'),
+      icon: refreshIcon,
+      execute: async () => {
+        return tracker.currentWidget?.content.model
+          .refresh()
+          .catch((reason: Error) => {
+            console.error(
+              `Failed to refresh the available plugins list:\n${reason}`
+            );
+          });
+      }
+    });
+
+    if (palette) {
+      palette.addItem({ command: CommandIDs.open, category });
+    }
+
+    if (restorer) {
+      void restorer.restore(tracker, {
+        command: CommandIDs.open,
+        name: _ => 'plugins',
+        args: widget => {
+          const { query, isDisclaimed } = widget.content.model;
+          const args: PluginListModel.IConfigurableState = {
+            query,
+            isDisclaimed
+          };
+          return args as ReadonlyJSONObject;
+        }
+      });
+    }
+    return {
+      open: () => {
+        return app.commands.execute(CommandIDs.open);
+      }
+    };
+  }
+};
+
+const plugins: JupyterFrontEndPlugin<any>[] = [pluginmanager];
+
+export default plugins;

package/style/index.css

@@ -0,0 +1,10 @@
+/*-----------------------------------------------------------------------------
+| Copyright (c) Jupyter Development Team.
+| Distributed under the terms of the Modified BSD License.
+|----------------------------------------------------------------------------*/
+
+/* This file was auto-generated by ensurePackage() in @jupyterlab/buildutils */
+@import url('~@jupyterlab/ui-components/style/index.css');
+@import url('~@jupyterlab/apputils/style/index.css');
+@import url('~@jupyterlab/application/style/index.css');
+@import url('~@jupyterlab/pluginmanager/style/index.css');

package/style/index.js

@@ -0,0 +1,10 @@
+/*-----------------------------------------------------------------------------
+| Copyright (c) Jupyter Development Team.
+| Distributed under the terms of the Modified BSD License.
+|----------------------------------------------------------------------------*/
+
+/* This file was auto-generated by ensurePackage() in @jupyterlab/buildutils */
+import '@jupyterlab/ui-components/style/index.js';
+import '@jupyterlab/apputils/style/index.js';
+import '@jupyterlab/application/style/index.js';
+import '@jupyterlab/pluginmanager/style/index.js';