jupyterlab-pioneer 0.1.11 → 0.2.0

package/README.md

@@ -1,5 +1,11 @@
 # JupyterLab Pioneer
 
+<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
+
+[![All Contributors](https://img.shields.io/badge/all_contributors-5-orange.svg?style=flat-square)](#contributors-)
+
+<!-- ALL-CONTRIBUTORS-BADGE:END -->
+
 [![PyPI](https://img.shields.io/pypi/v/jupyterlab-pioneer.svg)](https://pypi.org/project/jupyterlab-pioneer)
 [![npm](https://img.shields.io/npm/v/jupyterlab-pioneer.svg)](https://www.npmjs.com/package/jupyterlab-pioneer)
 
@@ -180,3 +186,29 @@ folder is located. Then you can remove the symlink named `jupyterlab-pioneer` wi
 ### Packaging the extension
 
 See [RELEASE](RELEASE.md)
+
+## Contributors ✨
+
+Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<table>
+  <tbody>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://www.wumengyan.com/"><img src="https://avatars.githubusercontent.com/u/85606983?v=4?s=100" width="100px;" alt="mengyanw"/><br /><sub><b>Mengyan Wu</b></sub></a><br /><a href="https://github.com/educational-technology-collective/jupyterlab-pioneer/commits?author=mengyanw" title="Code">💻</a> <a href="#ideas-mengyanw" title="Ideas, Planning, & Feedback">🤔</a> <a href="#maintenance-mengyanw" title="Maintenance">🚧</a> <a href="#projectManagement-mengyanw" title="Project Management">📆</a> <a href="#infra-mengyanw" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="https://github.com/educational-technology-collective/jupyterlab-pioneer/commits?author=mengyanw" title="Tests">⚠️</a> <a href="https://github.com/educational-technology-collective/jupyterlab-pioneer/commits?author=mengyanw" title="Documentation">📖</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="http://christopherbrooks.ca"><img src="https://avatars.githubusercontent.com/u/1355641?v=4?s=100" width="100px;" alt="Christopher Brooks"/><br /><sub><b>Christopher Brooks</b></sub></a><br /><a href="#ideas-cab938" title="Ideas, Planning, & Feedback">🤔</a> <a href="#projectManagement-cab938" title="Project Management">📆</a> <a href="#infra-cab938" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="http://from.so/Steve_Oney"><img src="https://avatars.githubusercontent.com/u/211262?v=4?s=100" width="100px;" alt="Steve Oney"/><br /><sub><b>Steve Oney</b></sub></a><br /><a href="#ideas-soney" title="Ideas, Planning, & Feedback">🤔</a> <a href="#projectManagement-soney" title="Project Management">📆</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://www.chrisostrouchov.com"><img src="https://avatars.githubusercontent.com/u/1740337?v=4?s=100" width="100px;" alt="Christopher Ostrouchov"/><br /><sub><b>Christopher Ostrouchov</b></sub></a><br /><a href="#ideas-costrouc" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/educational-technology-collective/jupyterlab-pioneer/commits?author=costrouc" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://iamit.in"><img src="https://avatars.githubusercontent.com/u/5647941?v=4?s=100" width="100px;" alt="Amit Kumar"/><br /><sub><b>Amit Kumar</b></sub></a><br /><a href="#infra-aktech" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a></td>
+    </tr>
+  </tbody>
+</table>
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

package/lib/index.js

@@ -1,7 +1,9 @@
 import { INotebookTracker } from '@jupyterlab/notebook';
+import { IMainMenu } from '@jupyterlab/mainmenu';
 import { Token } from '@lumino/coreutils';
 import { requestAPI } from './handler';
 import { producerCollection } from './producer';
+import { sendInfoNotification, addInfoToHelpMenu } from './utils';
 const PLUGIN_ID = 'jupyterlab-pioneer:plugin';
 export const IJupyterLabPioneer = new Token(PLUGIN_ID);
 class JupyterLabPioneer {
@@ -31,15 +33,17 @@ class JupyterLabPioneer {
 const plugin = {
     id: PLUGIN_ID,
     autoStart: true,
-    requires: [INotebookTracker],
+    requires: [INotebookTracker, IMainMenu],
     provides: IJupyterLabPioneer,
-    activate: async (app, notebookTracker) => {
+    activate: async (app, notebookTracker, mainMenu) => {
         const version = await requestAPI('version');
         console.log(`${PLUGIN_ID}: ${version}`);
         const config = (await requestAPI('config'));
         const pioneer = new JupyterLabPioneer();
+        addInfoToHelpMenu(app, mainMenu, version);
+        sendInfoNotification(config.exporters, true);
         notebookTracker.widgetAdded.connect(async (_, notebookPanel) => {
-            var _a;
+            var _a, _b;
             await notebookPanel.revealed;
             await notebookPanel.sessionContext.ready;
             const activeEvents = config.activeEvents;
@@ -67,6 +71,9 @@ const plugin = {
                     }
                 });
             });
+            if ((_b = notebookPanel.content.model) === null || _b === void 0 ? void 0 : _b.getMetadata('exporters')) {
+                sendInfoNotification(processedExporters, false);
+            }
         });
         return pioneer;
     }

package/lib/utils.d.ts

@@ -0,0 +1,5 @@
+import { JupyterFrontEnd } from '@jupyterlab/application';
+import { IMainMenu } from '@jupyterlab/mainmenu';
+import { Exporter } from './types';
+export declare const sendInfoNotification: (exporters: Exporter[], isGlobal: boolean) => void;
+export declare const addInfoToHelpMenu: (app: JupyterFrontEnd, mainMenu: IMainMenu, version: string) => void;

package/lib/utils.js

@@ -0,0 +1,57 @@
+import * as React from 'react';
+import { Dialog, showDialog, Notification } from '@jupyterlab/apputils';
+export const sendInfoNotification = (exporters, isGlobal) => {
+    const exporterMessage = exporters
+        .map(each => { var _a; return ((_a = each.args) === null || _a === void 0 ? void 0 : _a.id) || each.type; })
+        .join(' & ');
+    let message;
+    if (isGlobal && exporterMessage) {
+        message = `Telemetry data is being logged to ${exporterMessage} through jupyterlab-pioneer. \n See Help menu -> JupyterLab Pioneer for more details.`;
+    }
+    else if (isGlobal && !exporterMessage) {
+        message = `Telemetry data is being logged through jupyterlab-pioneer. \n See Help menu -> JupyterLab Pioneer for more details.`;
+    }
+    else {
+        message = `Embedded telemetry settings loaded. Telemetry data is being logged to ${exporterMessage} now.`;
+    }
+    Notification.info(message, { autoClose: 20000 });
+};
+export const addInfoToHelpMenu = (app, mainMenu, version) => {
+    // Add extension info to help menu
+    app.commands.addCommand('help:pioneer', {
+        label: 'JupyterLab Pioneer',
+        execute: () => {
+            // Create the header of the dialog
+            const title = (React.createElement("span", { className: "jp-About-header" },
+                "JupyterLab Pioneer",
+                React.createElement("div", { className: "jp-About-header-info" },
+                    React.createElement("span", { className: "jp-About-version-info" },
+                        React.createElement("span", { className: "jp-About-version" },
+                            "Version ",
+                            version)))));
+            // Create the body of the dialog
+            const contributorsURL = 'https://github.com/educational-technology-collective/jupyterlab-pioneer/graphs/contributors';
+            const docURL = 'https://jupyterlab-pioneer.readthedocs.io/en/latest/';
+            const gitURL = 'https://github.com/educational-technology-collective/jupyterlab-pioneer';
+            const externalLinks = (React.createElement("span", { className: "jp-About-externalLinks" },
+                React.createElement("a", { href: contributorsURL, target: "_blank", rel: "noopener noreferrer", className: "jp-Button-flat" }, "CONTRIBUTOR LIST"),
+                React.createElement("a", { href: docURL, target: "_blank", rel: "noopener noreferrer", className: "jp-Button-flat" }, "DOCUMENTATION"),
+                React.createElement("a", { href: gitURL, target: "_blank", rel: "noopener noreferrer", className: "jp-Button-flat" }, "GITHUB REPO")));
+            const copyright = (React.createElement("span", { className: "jp-About-copyright" }, "\u00A9 2023 Educational Technology Collective"));
+            const body = (React.createElement("div", { className: "jp-About-body" },
+                externalLinks,
+                copyright));
+            return showDialog({
+                title,
+                body,
+                buttons: [
+                    Dialog.createButton({
+                        label: 'Dismiss',
+                        className: 'jp-About-button jp-mod-reject jp-mod-styled'
+                    })
+                ]
+            });
+        }
+    });
+    mainMenu.helpMenu.addGroup([{ command: 'help:pioneer' }]);
+};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "jupyterlab-pioneer",
-    "version": "0.1.11",
+    "version": "0.2.0",
     "description": "A JupyterLab extension.",
     "keywords": [
         "jupyter",
@@ -55,7 +55,9 @@
     },
     "dependencies": {
         "@jupyterlab/application": "^4.0.0",
+        "@jupyterlab/apputils": "^4.1.9",
         "@jupyterlab/coreutils": "^6.0.0",
+        "@jupyterlab/mainmenu": "^4.0.9",
         "@jupyterlab/notebook": "^4.0.5",
         "@jupyterlab/services": "^7.0.0"
     },