jupyterlab-pioneer 0.1.2

package/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2023, Educational Technology Collective
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,137 @@
+# JupyterLab Pioneer 
+
+[![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)
+
+A JupyterLab extension for generating and exporting JupyterLab event telemetry data.
+
+## Get started
+
+### Run the extension with docker compose
+```bash
+# enter the configuration_examples directory and run
+docker compose -p jupyterlab-pioneer up --build
+```
+ A JupyterLab application with the extension installed and configured will run on localhost:8888.
+ 
+### Or install the extension and configure it manually
+
+To install the extension, execute:
+
+```bash
+pip install jupyterlab-pioneer
+```
+Before starting Jupyter Lab, users need to write their own configuration files (or use the provided configuration examples) and **place them in the correct directory**.
+
+Examples of configurations are [here](#configurations).
+
+## Configurations
+### Overview
+The configuration file controls the activated events and data exporters.
+
+To add a data exporter, users should assign a callable function along with function arguments when configuring `exporters`. This extension provides 4 [default exporters](https://github.com/educational-technology-collective/jupyterlab-pioneer/blob/b7eda5f4b286c7b0f7aa50df716b2795f180cc6e/jupyterlab_pioneer/handlers.py#L9), `command_line_exporter`, `console_exporter`, `file_exporter` and `remote_exporter`. Users can import default exporters or write customized exporters in the configuration file.
+
+### Configuration file name & path
+
+Jupyter Server expects the configuration file to be named after the extension’s name like so: **`jupyter_{extension name defined in application.py}_config.py`**. So, the configuration file name for this extension is `jupyter_jupyterlab_pioneer_config.py`.
+
+Jupyter Server looks for an extension’s config file in a set of specific paths. **The configuration file should be saved into one of the config directories provided by `jupyter --path`.**
+
+Check jupyter server [doc](https://jupyter-server.readthedocs.io/en/latest/operators/configuring-extensions.html) for more details.
+### Syntax
+
+`activateEvents`: An array of the ids of the events. Only valid events (1. has an id associated with the event class, and 2. the event id is included in `activatedEvents`) will be activated.
+
+`logNotebookContentEvents`: An array of the ids of the events. The extension will export the entire notebook content only for valid events (1. has an id associated with the event class, and 2. the event id is included in `logNotebookContentEvents`).
+
+`exporters`: An array of exporters. Each exporter should have the following structure:
+```python
+{
+    exporter: # a callable exporter function. Need to contain 'path' for file_exporter, 'url' for remote_exporter.
+    args: # arguments passed to the exporter function
+}
+```
+**The configuration file should be saved into one of the config directories provided by `jupyter --path`.**
+
+### Example
+[jupyter_jupyterlab_pioneer_config.py](https://github.com/educational-technology-collective/jupyterlab-pioneer/blob/main/configuration_examples/jupyter_jupyterlab_pioneer_config.py)
+
+## Uninstall
+
+To remove the extension, execute:
+
+```bash
+pip uninstall jupyterlab_pioneer
+```
+
+## Troubleshoot
+
+If you are seeing the frontend extension, but it is not working, check
+that the server extension is enabled:
+
+```bash
+jupyter server extension list
+```
+
+If the server extension is installed and enabled, but you are not seeing
+the frontend extension, check the frontend extension is installed:
+
+```bash
+jupyter labextension list
+```
+
+## Contributing
+
+### Development install
+
+Note: You will need NodeJS to build the extension package.
+
+The `jlpm` command is JupyterLab's pinned version of
+[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
+`yarn` or `npm` in lieu of `jlpm` below.
+
+```bash
+# Clone the repo to your local environment
+# Change directory to the jupyterlab_pioneer directory
+# Install package in development mode
+pip install -e "."
+# Link your development version of the extension with JupyterLab
+jupyter labextension develop . --overwrite
+# Server extension must be manually installed in develop mode
+jupyter server extension enable jupyterlab_pioneer
+# Rebuild extension Typescript source after making changes
+jlpm build
+```
+
+You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.
+
+```bash
+# Watch the source directory in one terminal, automatically rebuilding when needed
+jlpm watch
+# Run JupyterLab in another terminal
+jupyter lab
+```
+
+With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).
+
+By default, the `jlpm build` command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:
+
+```bash
+jupyter lab build --minimize=False
+```
+
+### Development uninstall
+
+```bash
+# Server extension must be manually disabled in develop mode
+jupyter server extension disable jupyterlab_pioneer
+pip uninstall jupyterlab_pioneer
+```
+
+In development mode, you will also need to remove the symlink created by `jupyter labextension develop`
+command. To find its location, you can run `jupyter labextension list` to figure out where the `labextensions`
+folder is located. Then you can remove the symlink named `jupyterlab-pioneer` within that folder.
+
+### Packaging the extension
+
+See [RELEASE](RELEASE.md)

package/lib/events.d.ts

@@ -0,0 +1,53 @@
+import { NotebookPanel } from '@jupyterlab/notebook';
+import { ITelemetryRouter } from './router';
+export declare class NotebookOpenEventProducer {
+    static id: string;
+    private produced;
+    listen(_: NotebookPanel, router: ITelemetryRouter, logNotebookContentEvent: boolean): Promise<void>;
+}
+export declare class NotebookScrollProducer {
+    static id: string;
+    private timeout;
+    listen(notebookPanel: NotebookPanel, router: ITelemetryRouter, logNotebookContentEvent: boolean): void;
+}
+export declare class NotebookVisibleEventProducer {
+    static id: string;
+    listen(notebookPanel: NotebookPanel, router: ITelemetryRouter, logNotebookContentEvent: boolean): void;
+}
+export declare class NotebookHiddenEventProducer {
+    static id: string;
+    listen(_: NotebookPanel, router: ITelemetryRouter, logNotebookContentEvent: boolean): void;
+}
+export declare class ClipboardCopyEventProducer {
+    static id: string;
+    listen(notebookPanel: NotebookPanel, router: ITelemetryRouter, logNotebookContentEvent: boolean): void;
+}
+export declare class ClipboardCutEventProducer {
+    static id: string;
+    listen(notebookPanel: NotebookPanel, router: ITelemetryRouter, logNotebookContentEvent: boolean): void;
+}
+export declare class ClipboardPasteEventProducer {
+    static id: string;
+    listen(notebookPanel: NotebookPanel, router: ITelemetryRouter, logNotebookContentEvent: boolean): void;
+}
+export declare class ActiveCellChangeEventProducer {
+    static id: string;
+    listen(notebookPanel: NotebookPanel, router: ITelemetryRouter, logNotebookContentEvent: boolean): void;
+}
+export declare class NotebookSaveEventProducer {
+    static id: string;
+    listen(notebookPanel: NotebookPanel, router: ITelemetryRouter, logNotebookContentEvent: boolean): void;
+}
+export declare class CellExecuteEventProducer {
+    static id: string;
+    listen(_: any, router: ITelemetryRouter, logNotebookContentEvent: boolean): void;
+}
+export declare class CellAddEventProducer {
+    static id: string;
+    listen(notebookPanel: NotebookPanel, router: ITelemetryRouter, logNotebookContentEvent: boolean): void;
+}
+export declare class CellRemoveEventProducer {
+    static id: string;
+    listen(notebookPanel: NotebookPanel, router: ITelemetryRouter, logNotebookContentEvent: boolean): void;
+}
+export declare const producerCollection: (typeof NotebookVisibleEventProducer)[];

package/lib/events.js

@@ -0,0 +1,283 @@
+import { NotebookActions } from '@jupyterlab/notebook';
+import { requestAPI } from './handler';
+class NotebookOpenEventProducer {
+    constructor() {
+        this.produced = false;
+    }
+    async listen(_, router, logNotebookContentEvent) {
+        if (!this.produced) {
+            const event = {
+                eventName: NotebookOpenEventProducer.id,
+                eventTime: Date.now(),
+                eventInfo: {
+                    environ: await requestAPI('environ')
+                }
+            };
+            await router.publishEvent(event, logNotebookContentEvent);
+            this.produced = true;
+        }
+    }
+}
+NotebookOpenEventProducer.id = 'NotebookOpenEvent';
+export { NotebookOpenEventProducer };
+const getVisibleCells = (notebookPanel) => {
+    const visibleCells = [];
+    for (let index = 0; index < notebookPanel.content.widgets.length; index++) {
+        const cell = notebookPanel.content.widgets[index];
+        const cellTop = cell.node.offsetTop;
+        const cellBottom = cell.node.offsetTop + cell.node.offsetHeight;
+        const viewTop = notebookPanel.content.node.scrollTop;
+        const viewBottom = notebookPanel.content.node.scrollTop +
+            notebookPanel.content.node.clientHeight;
+        if (cellTop <= viewBottom && cellBottom >= viewTop) {
+            visibleCells.push({
+                id: cell.model.id,
+                index: index
+            });
+        }
+    }
+    return visibleCells;
+};
+class NotebookScrollProducer {
+    constructor() {
+        this.timeout = 0;
+    }
+    listen(notebookPanel, router, logNotebookContentEvent) {
+        notebookPanel.content.node.addEventListener('scroll', async (e) => {
+            e.stopPropagation();
+            clearTimeout(this.timeout);
+            await new Promise(resolve => (this.timeout = window.setTimeout(resolve, 1500))); // wait 1.5 seconds before preceding
+            const event = {
+                eventName: NotebookScrollProducer.id,
+                eventTime: Date.now(),
+                eventInfo: {
+                    cells: getVisibleCells(notebookPanel)
+                }
+            };
+            await router.publishEvent(event, logNotebookContentEvent);
+        });
+    }
+}
+NotebookScrollProducer.id = 'NotebookScrollEvent';
+export { NotebookScrollProducer };
+class NotebookVisibleEventProducer {
+    listen(notebookPanel, router, logNotebookContentEvent) {
+        document.addEventListener('visibilitychange', async () => {
+            if (document.visibilityState === 'visible') {
+                const event = {
+                    eventName: NotebookVisibleEventProducer.id,
+                    eventTime: Date.now(),
+                    eventInfo: {
+                        cells: getVisibleCells(notebookPanel)
+                    }
+                };
+                await router.publishEvent(event, logNotebookContentEvent);
+            }
+        });
+    }
+}
+NotebookVisibleEventProducer.id = 'NotebookVisibleEvent';
+export { NotebookVisibleEventProducer };
+class NotebookHiddenEventProducer {
+    listen(_, router, logNotebookContentEvent) {
+        document.addEventListener('visibilitychange', async (e) => {
+            if (document.visibilityState === 'hidden') {
+                const event = {
+                    eventName: NotebookHiddenEventProducer.id,
+                    eventTime: Date.now()
+                };
+                await router.publishEvent(event, logNotebookContentEvent);
+            }
+        });
+    }
+}
+NotebookHiddenEventProducer.id = 'NotebookHiddenEvent';
+export { NotebookHiddenEventProducer };
+class ClipboardCopyEventProducer {
+    listen(notebookPanel, router, logNotebookContentEvent) {
+        notebookPanel.node.addEventListener('copy', async () => {
+            var _a, _b;
+            const cell = {
+                id: (_a = notebookPanel.content.activeCell) === null || _a === void 0 ? void 0 : _a.model.id,
+                index: notebookPanel.content.widgets.findIndex(value => value === notebookPanel.content.activeCell)
+            };
+            const text = (_b = document.getSelection()) === null || _b === void 0 ? void 0 : _b.toString();
+            const event = {
+                eventName: ClipboardCopyEventProducer.id,
+                eventTime: Date.now(),
+                eventInfo: {
+                    cells: [cell],
+                    selection: text
+                }
+            };
+            await router.publishEvent(event, logNotebookContentEvent);
+        });
+    }
+}
+ClipboardCopyEventProducer.id = 'ClipboardCopyEvent';
+export { ClipboardCopyEventProducer };
+class ClipboardCutEventProducer {
+    listen(notebookPanel, router, logNotebookContentEvent) {
+        notebookPanel.node.addEventListener('cut', async () => {
+            var _a, _b;
+            const cell = {
+                id: (_a = notebookPanel.content.activeCell) === null || _a === void 0 ? void 0 : _a.model.id,
+                index: notebookPanel.content.widgets.findIndex(value => value === notebookPanel.content.activeCell)
+            };
+            const text = (_b = document.getSelection()) === null || _b === void 0 ? void 0 : _b.toString();
+            const event = {
+                eventName: ClipboardCutEventProducer.id,
+                eventTime: Date.now(),
+                eventInfo: {
+                    cells: [cell],
+                    selection: text
+                }
+            };
+            await router.publishEvent(event, logNotebookContentEvent);
+        });
+    }
+}
+ClipboardCutEventProducer.id = 'ClipboardCutEvent';
+export { ClipboardCutEventProducer };
+class ClipboardPasteEventProducer {
+    listen(notebookPanel, router, logNotebookContentEvent) {
+        notebookPanel.node.addEventListener('paste', async (e) => {
+            var _a;
+            const cell = {
+                id: (_a = notebookPanel.content.activeCell) === null || _a === void 0 ? void 0 : _a.model.id,
+                index: notebookPanel.content.widgets.findIndex(value => value === notebookPanel.content.activeCell)
+            };
+            const text = (e.clipboardData || window.clipboardData).getData('text');
+            const event = {
+                eventName: ClipboardPasteEventProducer.id,
+                eventTime: Date.now(),
+                eventInfo: {
+                    cells: [cell],
+                    selection: text
+                }
+            };
+            await router.publishEvent(event, logNotebookContentEvent);
+        });
+    }
+}
+ClipboardPasteEventProducer.id = 'ClipboardPasteEvent';
+export { ClipboardPasteEventProducer };
+class ActiveCellChangeEventProducer {
+    listen(notebookPanel, router, logNotebookContentEvent) {
+        notebookPanel.content.activeCellChanged.connect(async (_, cell) => {
+            if (cell && notebookPanel.content.widgets) {
+                const activatedCell = {
+                    id: cell === null || cell === void 0 ? void 0 : cell.model.id,
+                    index: notebookPanel.content.widgets.findIndex(value => value === cell)
+                };
+                const event = {
+                    eventName: ActiveCellChangeEventProducer.id,
+                    eventTime: Date.now(),
+                    eventInfo: {
+                        cells: [activatedCell] // activated cell
+                    }
+                };
+                await router.publishEvent(event, logNotebookContentEvent);
+            }
+        });
+    }
+}
+ActiveCellChangeEventProducer.id = 'ActiveCellChangeEvent';
+export { ActiveCellChangeEventProducer };
+class NotebookSaveEventProducer {
+    listen(notebookPanel, router, logNotebookContentEvent) {
+        notebookPanel.context.saveState.connect(async (_, saveState) => {
+            if (saveState.match('completed')) {
+                const event = {
+                    eventName: NotebookSaveEventProducer.id,
+                    eventTime: Date.now()
+                };
+                await router.publishEvent(event, logNotebookContentEvent);
+            }
+        });
+    }
+}
+NotebookSaveEventProducer.id = 'NotebookSaveEvent';
+export { NotebookSaveEventProducer };
+class CellExecuteEventProducer {
+    listen(_, router, logNotebookContentEvent) {
+        NotebookActions.executed.connect(async (_, args) => {
+            const executedCell = {
+                id: args.cell.model.id,
+                index: args.notebook.widgets.findIndex(value => value == args.cell)
+            };
+            const event = {
+                eventName: CellExecuteEventProducer.id,
+                eventTime: Date.now(),
+                eventInfo: {
+                    cells: [executedCell],
+                    success: args.success,
+                    kernelError: args.success ? null : args.error
+                }
+            };
+            await router.publishEvent(event, logNotebookContentEvent);
+        });
+    }
+}
+CellExecuteEventProducer.id = 'CellExecuteEvent';
+export { CellExecuteEventProducer };
+class CellAddEventProducer {
+    listen(notebookPanel, router, logNotebookContentEvent) {
+        var _a;
+        (_a = notebookPanel.content.model) === null || _a === void 0 ? void 0 : _a.cells.changed.connect(async (_, args) => {
+            if (args.type === 'add') {
+                const addedCell = {
+                    id: args.newValues[0].id,
+                    index: args.newIndex
+                };
+                const event = {
+                    eventName: CellAddEventProducer.id,
+                    eventTime: Date.now(),
+                    eventInfo: {
+                        cells: [addedCell]
+                    }
+                };
+                await router.publishEvent(event, logNotebookContentEvent);
+            }
+        });
+    }
+}
+CellAddEventProducer.id = 'CellAddEvent';
+export { CellAddEventProducer };
+class CellRemoveEventProducer {
+    listen(notebookPanel, router, logNotebookContentEvent) {
+        var _a;
+        (_a = notebookPanel.content.model) === null || _a === void 0 ? void 0 : _a.cells.changed.connect(async (_, args) => {
+            if (args.type === 'remove') {
+                const removedCell = {
+                    newIndex: args.newIndex,
+                    oldIndex: args.oldIndex
+                };
+                const event = {
+                    eventName: CellRemoveEventProducer.id,
+                    eventTime: Date.now(),
+                    eventInfo: {
+                        cells: [removedCell]
+                    }
+                };
+                await router.publishEvent(event, logNotebookContentEvent);
+            }
+        });
+    }
+}
+CellRemoveEventProducer.id = 'CellRemoveEvent';
+export { CellRemoveEventProducer };
+export const producerCollection = [
+    NotebookOpenEventProducer,
+    NotebookScrollProducer,
+    NotebookVisibleEventProducer,
+    NotebookHiddenEventProducer,
+    ClipboardCopyEventProducer,
+    ClipboardCutEventProducer,
+    ClipboardPasteEventProducer,
+    ActiveCellChangeEventProducer,
+    NotebookSaveEventProducer,
+    CellExecuteEventProducer,
+    CellAddEventProducer,
+    CellRemoveEventProducer
+];

package/lib/handler.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Call the API extension
+ *
+ * @param endPoint API REST end point for the extension
+ * @param init Initial values for the request
+ * @returns The response body interpreted as JSON
+ */
+export declare function requestAPI<T>(endPoint?: string, init?: RequestInit): Promise<T>;

package/lib/handler.js

@@ -0,0 +1,35 @@
+import { URLExt } from '@jupyterlab/coreutils';
+import { ServerConnection } from '@jupyterlab/services';
+/**
+ * Call the API extension
+ *
+ * @param endPoint API REST end point for the extension
+ * @param init Initial values for the request
+ * @returns The response body interpreted as JSON
+ */
+export async function requestAPI(endPoint = '', init = {}) {
+    // Make request to Jupyter API
+    const settings = ServerConnection.makeSettings();
+    const requestUrl = URLExt.join(settings.baseUrl, 'jupyterlab-pioneer', // API Namespace
+    endPoint);
+    let response;
+    try {
+        response = await ServerConnection.makeRequest(requestUrl, init, settings);
+    }
+    catch (error) {
+        throw new ServerConnection.NetworkError(error);
+    }
+    let data = await response.text();
+    if (data.length > 0) {
+        try {
+            data = JSON.parse(data);
+        }
+        catch (error) {
+            console.log('Not a JSON response body.', response);
+        }
+    }
+    if (!response.ok) {
+        throw new ServerConnection.ResponseError(response, data.message || data);
+    }
+    return data;
+}

package/lib/index.d.ts

@@ -0,0 +1,3 @@
+import { JupyterFrontEndPlugin } from '@jupyterlab/application';
+declare const plugin: JupyterFrontEndPlugin<void>;
+export default plugin;

package/lib/index.js

@@ -0,0 +1,26 @@
+import { INotebookTracker } from '@jupyterlab/notebook';
+import { TelemetryRouter } from './router';
+import { requestAPI } from './handler';
+import { producerCollection } from './events';
+const PLUGIN_ID = 'jupyterlab-pioneer:plugin';
+const plugin = {
+    id: PLUGIN_ID,
+    autoStart: true,
+    requires: [INotebookTracker],
+    activate: async (app, notebookTracker) => {
+        const version = await requestAPI('version');
+        console.log(`${PLUGIN_ID}: ${version}`);
+        const config = await requestAPI('config');
+        const telemetryRouter = new TelemetryRouter();
+        notebookTracker.widgetAdded.connect(async (_, notebookPanel) => {
+            await notebookPanel.sessionContext.ready; // wait until session id is created
+            await telemetryRouter.loadNotebookPanel(notebookPanel);
+            producerCollection.forEach(producer => {
+                if (config.activeEvents.includes(producer.id)) {
+                    new producer().listen(notebookPanel, telemetryRouter, config.logNotebookContentEvents.includes(producer.id));
+                }
+            });
+        });
+    }
+};
+export default plugin;

package/lib/router.d.ts

@@ -0,0 +1,22 @@
+import { NotebookPanel } from '@jupyterlab/notebook';
+export interface ITelemetryRouter {
+    loadNotebookPanel(notebookPanel: NotebookPanel): void;
+    publishEvent(eventDetail: Object, logNotebookContent?: Boolean): void;
+}
+export declare class TelemetryRouter implements ITelemetryRouter {
+    private sessionID?;
+    private notebookPanel?;
+    /**
+     * Load notebookPanel.
+     *
+     * @param {NotebookPanel} notebookPanel
+     */
+    loadNotebookPanel(notebookPanel: NotebookPanel): Promise<void>;
+    /**
+     * Send event data to exporters defined in the configuration file.
+     *
+     * @param {Object} eventDetail An object containing event details
+     * @param {Boolean} logNotebookContent A boolean indicating whether to log the entire notebook or not
+     */
+    publishEvent(eventDetail: Object, logNotebookContent?: Boolean): Promise<void>;
+}

package/lib/router.js

@@ -0,0 +1,45 @@
+import { requestAPI } from './handler';
+export class TelemetryRouter {
+    /**
+     * Load notebookPanel.
+     *
+     * @param {NotebookPanel} notebookPanel
+     */
+    async loadNotebookPanel(notebookPanel) {
+        this.notebookPanel = notebookPanel;
+    }
+    /**
+     * Send event data to exporters defined in the configuration file.
+     *
+     * @param {Object} eventDetail An object containing event details
+     * @param {Boolean} logNotebookContent A boolean indicating whether to log the entire notebook or not
+     */
+    async publishEvent(eventDetail, logNotebookContent) {
+        var _a, _b, _c, _d, _e, _f, _g;
+        if (!this.notebookPanel) {
+            throw Error('router needs to load notebookPanel first.');
+        }
+        // Check if session id received is equal to the stored session id
+        if (!this.sessionID ||
+            this.sessionID !== ((_b = (_a = this.notebookPanel) === null || _a === void 0 ? void 0 : _a.sessionContext.session) === null || _b === void 0 ? void 0 : _b.id)) {
+            this.sessionID = (_d = (_c = this.notebookPanel) === null || _c === void 0 ? void 0 : _c.sessionContext.session) === null || _d === void 0 ? void 0 : _d.id;
+        }
+        // Construct data
+        const requestBody = {
+            eventDetail: eventDetail,
+            notebookState: {
+                sessionID: this.sessionID,
+                notebookPath: (_e = this.notebookPanel) === null || _e === void 0 ? void 0 : _e.context.path,
+                notebookContent: logNotebookContent
+                    ? (_g = (_f = this.notebookPanel) === null || _f === void 0 ? void 0 : _f.model) === null || _g === void 0 ? void 0 : _g.toJSON()
+                    : null // decide whether to log the entire notebook
+            }
+        };
+        // Send data to exporters
+        const response = await requestAPI('export', {
+            method: 'POST',
+            body: JSON.stringify(requestBody)
+        });
+        console.log(response);
+    }
+}

package/package.json

@@ -0,0 +1,199 @@
+{
+    "name": "jupyterlab-pioneer",
+    "version": "0.1.2",
+    "description": "A JupyterLab extension.",
+    "keywords": [
+        "jupyter",
+        "jupyterlab",
+        "jupyterlab-extension"
+    ],
+    "homepage": "https://github.com/educational-technology-collective/jupyterlab-pioneer",
+    "bugs": {
+        "url": "https://github.com/educational-technology-collective/jupyterlab-pioneer/issues"
+    },
+    "license": "BSD-3-Clause",
+    "author": {
+        "name": "Educational Technology Collective",
+        "email": "etc-jupyterlab-telemetry@umich.edu"
+    },
+    "files": [
+        "lib/**/*.{d.ts,eot,gif,html,jpg,js,js.map,json,png,svg,woff2,ttf}",
+        "style/**/*.{css,js,eot,gif,html,jpg,json,png,svg,woff2,ttf}"
+    ],
+    "main": "lib/index.js",
+    "types": "lib/index.d.ts",
+    "style": "style/index.css",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/educational-technology-collective/jupyterlab-pioneer.git"
+    },
+    "scripts": {
+        "build": "jlpm build:lib && jlpm build:labextension:dev",
+        "build:prod": "jlpm clean && jlpm build:lib:prod && jlpm build:labextension",
+        "build:labextension": "jupyter labextension build .",
+        "build:labextension:dev": "jupyter labextension build --development True .",
+        "build:lib": "tsc --sourceMap",
+        "build:lib:prod": "tsc",
+        "clean": "jlpm clean:lib",
+        "clean:lib": "rimraf lib tsconfig.tsbuildinfo",
+        "clean:lintcache": "rimraf .eslintcache .stylelintcache",
+        "clean:labextension": "rimraf jupyterlab_pioneer/labextension jupyterlab_pioneer/_version.py",
+        "clean:all": "jlpm clean:lib && jlpm clean:labextension && jlpm clean:lintcache",
+        "eslint": "jlpm eslint:check --fix",
+        "eslint:check": "eslint . --cache --ext .ts,.tsx",
+        "install:extension": "jlpm build",
+        "lint": "jlpm stylelint && jlpm prettier && jlpm eslint",
+        "lint:check": "jlpm stylelint:check && jlpm prettier:check && jlpm eslint:check",
+        "prettier": "jlpm prettier:base --write --list-different",
+        "prettier:base": "prettier \"**/*{.ts,.tsx,.js,.jsx,.css,.json,.md}\"",
+        "prettier:check": "jlpm prettier:base --check",
+        "stylelint": "jlpm stylelint:check --fix",
+        "stylelint:check": "stylelint --cache \"style/**/*.css\"",
+        "watch": "run-p watch:src watch:labextension",
+        "watch:src": "tsc -w --sourceMap",
+        "watch:labextension": "jupyter labextension watch ."
+    },
+    "dependencies": {
+        "@jupyterlab/application": "^4.0.0",
+        "@jupyterlab/coreutils": "^6.0.0",
+        "@jupyterlab/notebook": "^4.0.5",
+        "@jupyterlab/services": "^7.0.0"
+    },
+    "devDependencies": {
+        "@jupyterlab/builder": "^4.0.0",
+        "@types/json-schema": "^7.0.11",
+        "@types/react": "^18.0.26",
+        "@types/react-addons-linked-state-mixin": "^0.14.22",
+        "@typescript-eslint/eslint-plugin": "^6.1.0",
+        "@typescript-eslint/parser": "^6.1.0",
+        "css-loader": "^6.7.1",
+        "eslint": "^8.36.0",
+        "eslint-config-prettier": "^8.8.0",
+        "eslint-plugin-prettier": "^5.0.0",
+        "mkdirp": "^1.0.3",
+        "npm-run-all": "^4.1.5",
+        "prettier": "^3.0.0",
+        "rimraf": "^5.0.1",
+        "source-map-loader": "^1.0.2",
+        "style-loader": "^3.3.1",
+        "stylelint": "^15.10.1",
+        "stylelint-config-recommended": "^13.0.0",
+        "stylelint-config-standard": "^34.0.0",
+        "stylelint-csstree-validator": "^3.0.0",
+        "stylelint-prettier": "^4.0.0",
+        "typescript": "~5.0.2",
+        "yjs": "^13.5.0"
+    },
+    "sideEffects": [
+        "style/*.css",
+        "style/index.js"
+    ],
+    "styleModule": "style/index.js",
+    "publishConfig": {
+        "access": "public"
+    },
+    "jupyterlab": {
+        "discovery": {
+            "server": {
+                "managers": [
+                    "pip"
+                ],
+                "base": {
+                    "name": "jupyterlab_pioneer"
+                }
+            }
+        },
+        "extension": true,
+        "outputDir": "jupyterlab_pioneer/labextension"
+    },
+    "eslintIgnore": [
+        "node_modules",
+        "dist",
+        "coverage",
+        "**/*.d.ts"
+    ],
+    "eslintConfig": {
+        "extends": [
+            "eslint:recommended",
+            "plugin:@typescript-eslint/eslint-recommended",
+            "plugin:@typescript-eslint/recommended",
+            "plugin:prettier/recommended"
+        ],
+        "parser": "@typescript-eslint/parser",
+        "parserOptions": {
+            "project": "tsconfig.json",
+            "sourceType": "module"
+        },
+        "plugins": [
+            "@typescript-eslint"
+        ],
+        "rules": {
+            "@typescript-eslint/naming-convention": [
+                "error",
+                {
+                    "selector": "interface",
+                    "format": [
+                        "PascalCase"
+                    ],
+                    "custom": {
+                        "regex": "^I[A-Z]",
+                        "match": true
+                    }
+                }
+            ],
+            "@typescript-eslint/no-unused-vars": [
+                "warn",
+                {
+                    "args": "none"
+                }
+            ],
+            "@typescript-eslint/no-explicit-any": "off",
+            "@typescript-eslint/no-namespace": "off",
+            "@typescript-eslint/no-use-before-define": "off",
+            "@typescript-eslint/quotes": [
+                "error",
+                "single",
+                {
+                    "avoidEscape": true,
+                    "allowTemplateLiterals": false
+                }
+            ],
+            "curly": [
+                "error",
+                "all"
+            ],
+            "eqeqeq": "error",
+            "prefer-arrow-callback": "error"
+        }
+    },
+    "prettier": {
+        "singleQuote": true,
+        "trailingComma": "none",
+        "arrowParens": "avoid",
+        "endOfLine": "auto",
+        "overrides": [
+            {
+                "files": "package.json",
+                "options": {
+                    "tabWidth": 4
+                }
+            }
+        ]
+    },
+    "stylelint": {
+        "extends": [
+            "stylelint-config-recommended",
+            "stylelint-config-standard",
+            "stylelint-prettier/recommended"
+        ],
+        "plugins": [
+            "stylelint-csstree-validator"
+        ],
+        "rules": {
+            "csstree/validator": true,
+            "property-no-vendor-prefix": null,
+            "selector-no-vendor-prefix": null,
+            "value-no-vendor-prefix": null
+        }
+    }
+}

package/style/base.css

@@ -0,0 +1,5 @@
+/*
+    See the JupyterLab Developer Guide for useful CSS Patterns:
+
+    https://jupyterlab.readthedocs.io/en/stable/developer/css.html
+*/

package/style/index.css

@@ -0,0 +1 @@
+@import url('base.css');

package/style/index.js

@@ -0,0 +1 @@
+import './base.css';