jupyterlab-pioneer 0.1.6 → 0.1.7

package/README.md

@@ -40,12 +40,12 @@ To add a data exporter, users should assign a callable function along with funct
 
 This extension provides 4 default exporters.
 
-- [`console_exporter`](https://github.com/educational-technology-collective/jupyterlab-pioneer/blob/main/jupyterlab_pioneer/handlers.py#L10), which sends telemetry data to the browser console
-- [`command_line_exporter`](https://github.com/educational-technology-collective/jupyterlab-pioneer/blob/main/jupyterlab_pioneer/handlers.py#L33), which sends telemetry data to the python console jupyter is running on
-- [`file_exporter`](https://github.com/educational-technology-collective/jupyterlab-pioneer/blob/main/jupyterlab_pioneer/handlers.py#L55), which saves telemetry data to local file
-- [`remote_exporter`](https://github.com/educational-technology-collective/jupyterlab-pioneer/blob/main/jupyterlab_pioneer/handlers.py#L81), which sends telemetry data to a remote http endpoint
+- [`console_exporter`](https://github.com/educational-technology-collective/jupyterlab-pioneer/blob/main/jupyterlab_pioneer/default_exporters.py#L9), which sends telemetry data to the browser console
+- [`command_line_exporter`](https://github.com/educational-technology-collective/jupyterlab-pioneer/blob/main/jupyterlab_pioneer/default_exporters.py#L32), which sends telemetry data to the python console jupyter is running on
+- [`file_exporter`](https://github.com/educational-technology-collective/jupyterlab-pioneer/blob/main/jupyterlab_pioneer/default_exporters.py#L57), which saves telemetry data to local file
+- [`remote_exporter`](https://github.com/educational-technology-collective/jupyterlab-pioneer/blob/main/jupyterlab_pioneer/default_exporters.py#L85), which sends telemetry data to a remote http endpoint
 
-Additionally, users can import default exporters or write customized exporters in the configuration file.
+Additionally, users can write customized exporters in the configuration file.
 
 ### Configuration file name & path
 
@@ -57,16 +57,29 @@ Check jupyter server [doc](https://jupyter-server.readthedocs.io/en/latest/opera
 
 ### 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.
+`activateEvents`: An array of active events. Each active event in the array should have the following structure:
 
-`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`).
+```python
+{
+    'name': string # string, event name
+    'logWholeNotebook': # boolean, whether to export the entire notebook content when event is triggered
+}
+```
+
+The extension would only generate and export data for valid events ( 1. that have an id associated with the event class, 2. and the event name is included in `activeEvents`
+).
+The extension will export the entire notebook content only for valid events with the `logWholeNotebook` flag == True.
 
-`exporters`: An array of exporters. Each exporter should have the following structure:
+`exporters`: An array of exporters. Each exporter in the array 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
+    'type': # one of 'console_exporter', 'command_line_exporter',
+            # 'file_exporter', 'remote_exporter',
+            # or 'custom_exporter'.
+    'args': # arguments passed to the exporter function.
+            # It needs to contain 'path' for file_exporter, 'url' for remote_exporter.
+    'activeEvents': # exporter's local active_events config will override global activeEvents config
 }
 ```
 

package/lib/index.d.ts

@@ -1,6 +1,7 @@
 import { JupyterFrontEndPlugin } from '@jupyterlab/application';
 import { NotebookPanel } from '@jupyterlab/notebook';
 import { Token } from '@lumino/coreutils';
+import { Exporter } from './types';
 export declare const IJupyterLabPioneer: Token<IJupyterLabPioneer>;
 export interface IJupyterLabPioneer {
     /**
@@ -10,10 +11,10 @@ export interface IJupyterLabPioneer {
      * @param {Object} eventDetail An object containing event details
      * @param {Boolean} logNotebookContent A boolean indicating whether to log the entire notebook or not
      */
-    publishEvent(notebookPanel: NotebookPanel, eventDetail: Object, logNotebookContent?: Boolean): Promise<void>;
+    publishEvent(notebookPanel: NotebookPanel, eventDetail: Object, logWholeNotebook?: Boolean, exporter?: Exporter): Promise<void>;
 }
 declare class JupyterLabPioneer implements IJupyterLabPioneer {
-    publishEvent(notebookPanel: NotebookPanel, eventDetail: Object, logNotebookContent?: Boolean): Promise<void>;
+    publishEvent(notebookPanel: NotebookPanel, eventDetail: Object, logWholeNotebook?: Boolean, exporter?: Exporter): Promise<void>;
 }
 declare const plugin: JupyterFrontEndPlugin<JupyterLabPioneer>;
 export default plugin;

package/lib/index.js

@@ -1,28 +1,26 @@
 import { INotebookTracker } from '@jupyterlab/notebook';
 import { Token } from '@lumino/coreutils';
 import { requestAPI } from './handler';
-// import { Router } from './router';
 import { producerCollection } from './producer';
 const PLUGIN_ID = 'jupyterlab-pioneer:plugin';
 export const IJupyterLabPioneer = new Token(PLUGIN_ID);
 class JupyterLabPioneer {
-    async publishEvent(notebookPanel, eventDetail, logNotebookContent) {
+    async publishEvent(notebookPanel, eventDetail, logWholeNotebook, exporter) {
         var _a, _b;
         if (!notebookPanel) {
             throw Error('router is listening to a null notebook panel');
         }
-        // Construct data
         const requestBody = {
             eventDetail: eventDetail,
             notebookState: {
                 sessionID: (_a = notebookPanel === null || notebookPanel === void 0 ? void 0 : notebookPanel.sessionContext.session) === null || _a === void 0 ? void 0 : _a.id,
                 notebookPath: notebookPanel === null || notebookPanel === void 0 ? void 0 : notebookPanel.context.path,
-                notebookContent: logNotebookContent
+                notebookContent: logWholeNotebook
                     ? (_b = notebookPanel === null || notebookPanel === void 0 ? void 0 : notebookPanel.model) === null || _b === void 0 ? void 0 : _b.toJSON()
                     : null // decide whether to log the entire notebook
-            }
+            },
+            exporter: exporter
         };
-        // Send data to exporters
         const response = await requestAPI('export', {
             method: 'POST',
             body: JSON.stringify(requestBody)
@@ -38,15 +36,34 @@ const plugin = {
     activate: async (app, notebookTracker) => {
         const version = await requestAPI('version');
         console.log(`${PLUGIN_ID}: ${version}`);
-        const config = await requestAPI('config');
+        const config = (await requestAPI('config'));
         const pioneer = new JupyterLabPioneer();
         notebookTracker.widgetAdded.connect(async (_, notebookPanel) => {
+            var _a;
             await notebookPanel.revealed;
             await notebookPanel.sessionContext.ready;
-            producerCollection.forEach(producer => {
-                if (config.activeEvents.includes(producer.id)) {
-                    new producer().listen(notebookPanel, pioneer, config.logNotebookContentEvents.includes(producer.id));
-                }
+            const activeEvents = config.activeEvents;
+            const exporters = ((_a = notebookPanel.content.model) === null || _a === void 0 ? void 0 : _a.getMetadata('exporters')) ||
+                config.exporters;
+            const processedExporters = activeEvents && activeEvents.length
+                ? exporters.map(e => {
+                    if (!e.activeEvents) {
+                        e.activeEvents = activeEvents;
+                        return e;
+                    }
+                    else {
+                        return e;
+                    }
+                })
+                : exporters.filter(e => e.activeEvents && e.activeEvents.length);
+            console.log(processedExporters);
+            processedExporters.forEach(exporter => {
+                producerCollection.forEach(producer => {
+                    var _a;
+                    if ((_a = exporter.activeEvents) === null || _a === void 0 ? void 0 : _a.map(o => o.name).includes(producer.id)) {
+                        new producer().listen(notebookPanel, pioneer, exporter);
+                    }
+                });
             });
         });
         return pioneer;

package/lib/producer.d.ts

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

package/lib/producer.js

@@ -1,103 +1,156 @@
 import { NotebookActions } from '@jupyterlab/notebook';
+import { EditorView } from '@codemirror/view';
 import { requestAPI } from './handler';
-class NotebookOpenEventProducer {
-    constructor() {
-        this.produced = false;
-    }
-    async listen(notebookPanel, pioneer, logNotebookContentEvent) {
-        if (!this.produced) {
-            const event = {
-                eventName: NotebookOpenEventProducer.id,
-                eventTime: Date.now(),
-                eventInfo: {
-                    environ: await requestAPI('environ')
-                }
-            };
-            await pioneer.publishEvent(notebookPanel, event, logNotebookContentEvent);
-            this.produced = true;
-        }
+class ActiveCellChangeEventProducer {
+    listen(notebookPanel, pioneer, exporter) {
+        notebookPanel.content.activeCellChanged.connect(async (_, cell) => {
+            var _a, _b;
+            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 pioneer.publishEvent(notebookPanel, event, (_b = (_a = exporter.activeEvents) === null || _a === void 0 ? void 0 : _a.find(o => o.name == ActiveCellChangeEventProducer.id)) === null || _b === void 0 ? void 0 : _b.logWholeNotebook, exporter);
+            }
+        });
     }
 }
-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;
+ActiveCellChangeEventProducer.id = 'ActiveCellChangeEvent';
+export { ActiveCellChangeEventProducer };
+class CellAddEventProducer {
+    listen(notebookPanel, pioneer, exporter) {
+        var _a;
+        (_a = notebookPanel.content.model) === null || _a === void 0 ? void 0 : _a.cells.changed.connect(async (_, args) => {
+            var _a, _b;
+            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 pioneer.publishEvent(notebookPanel, event, (_b = (_a = exporter.activeEvents) === null || _a === void 0 ? void 0 : _a.find(o => o.name == CellAddEventProducer.id)) === null || _b === void 0 ? void 0 : _b.logWholeNotebook, exporter);
+            }
+        });
     }
-    listen(notebookPanel, pioneer, 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
+}
+CellAddEventProducer.id = 'CellAddEvent';
+export { CellAddEventProducer };
+class CellEditEventProducer {
+    listen(notebookPanel, pioneer, exporter) {
+        var _a, _b;
+        const sendDoc = async (_, cell) => {
+            var _a, _b, _c, _d;
+            await (cell === null || cell === void 0 ? void 0 : cell.ready); // wait until cell is ready, to prevent errors when creating new cells
+            const editor = cell === null || cell === void 0 ? void 0 : cell.editor;
             const event = {
-                eventName: NotebookScrollProducer.id,
+                eventName: CellEditEventProducer.id,
                 eventTime: Date.now(),
                 eventInfo: {
-                    cells: getVisibleCells(notebookPanel)
+                    index: notebookPanel.content.widgets.findIndex(value => value === cell),
+                    doc: (_b = (_a = editor === null || editor === void 0 ? void 0 : editor.state) === null || _a === void 0 ? void 0 : _a.doc) === null || _b === void 0 ? void 0 : _b.toJSON() // send entire cell content if this is a new cell
                 }
             };
-            await pioneer.publishEvent(notebookPanel, event, logNotebookContentEvent);
-        });
+            await pioneer.publishEvent(notebookPanel, event, (_d = (_c = exporter.activeEvents) === null || _c === void 0 ? void 0 : _c.find(o => o.name == CellEditEventProducer.id)) === null || _d === void 0 ? void 0 : _d.logWholeNotebook, exporter);
+        };
+        const addDocChangeListener = async (cell) => {
+            await (cell === null || cell === void 0 ? void 0 : cell.ready); // wait until cell is ready, to prevent errors when creating new cells
+            const editor = cell === null || cell === void 0 ? void 0 : cell.editor;
+            editor === null || editor === void 0 ? void 0 : editor.injectExtension(EditorView.updateListener.of(async (v) => {
+                if (v.docChanged) {
+                    const event = {
+                        eventName: CellEditEventProducer.id,
+                        eventTime: Date.now(),
+                        eventInfo: {
+                            index: notebookPanel.content.widgets.findIndex(value => value === cell),
+                            changes: v.changes.toJSON() // send changes
+                        }
+                    };
+                    await pioneer.publishEvent(notebookPanel, event, false, // do not log whole notebook for doc changes
+                    exporter);
+                }
+            }));
+        };
+        (_a = notebookPanel === null || notebookPanel === void 0 ? void 0 : notebookPanel.content) === null || _a === void 0 ? void 0 : _a.widgets.forEach(cell => {
+            addDocChangeListener(cell);
+        }); // add listener to existing cells
+        sendDoc(notebookPanel.content, notebookPanel.content.activeCell); // send initial active cell content
+        (_b = notebookPanel.content.model) === null || _b === void 0 ? void 0 : _b.cells.changed.connect(async (_, args) => {
+            var _a;
+            if (args.type === 'add') {
+                addDocChangeListener((_a = notebookPanel === null || notebookPanel === void 0 ? void 0 : notebookPanel.content) === null || _a === void 0 ? void 0 : _a.widgets[args.newIndex]);
+            }
+        }); // add doc change listener to cells created after initialization
+        notebookPanel.content.activeCellChanged.connect(sendDoc); // send active cell content when active cell changes
     }
 }
-NotebookScrollProducer.id = 'NotebookScrollEvent';
-export { NotebookScrollProducer };
-class NotebookVisibleEventProducer {
-    listen(notebookPanel, pioneer, logNotebookContentEvent) {
-        document.addEventListener('visibilitychange', async () => {
-            if (document.visibilityState === 'visible' && document.contains(notebookPanel.node)) {
+CellEditEventProducer.id = 'CellEditEvent';
+export { CellEditEventProducer };
+class CellExecuteEventProducer {
+    listen(notebookPanel, pioneer, exporter) {
+        NotebookActions.executed.connect(async (_, args) => {
+            var _a, _b;
+            if (notebookPanel.content === args.notebook) {
+                const executedCell = {
+                    id: args.cell.model.id,
+                    index: args.notebook.widgets.findIndex(value => value == args.cell)
+                };
                 const event = {
-                    eventName: NotebookVisibleEventProducer.id,
+                    eventName: CellExecuteEventProducer.id,
                     eventTime: Date.now(),
                     eventInfo: {
-                        cells: getVisibleCells(notebookPanel)
+                        cells: [executedCell],
+                        success: args.success,
+                        kernelError: args.success ? null : args.error
                     }
                 };
-                await pioneer.publishEvent(notebookPanel, event, logNotebookContentEvent);
+                await pioneer.publishEvent(notebookPanel, event, (_b = (_a = exporter.activeEvents) === null || _a === void 0 ? void 0 : _a.find(o => o.name == CellExecuteEventProducer.id)) === null || _b === void 0 ? void 0 : _b.logWholeNotebook, exporter);
             }
         });
     }
 }
-NotebookVisibleEventProducer.id = 'NotebookVisibleEvent';
-export { NotebookVisibleEventProducer };
-class NotebookHiddenEventProducer {
-    listen(notebookPanel, pioneer, logNotebookContentEvent) {
-        document.addEventListener('visibilitychange', async (e) => {
-            if (document.visibilityState === 'hidden' && document.contains(notebookPanel.node)) {
+CellExecuteEventProducer.id = 'CellExecuteEvent';
+export { CellExecuteEventProducer };
+class CellRemoveEventProducer {
+    listen(notebookPanel, pioneer, exporter) {
+        var _a;
+        (_a = notebookPanel.content.model) === null || _a === void 0 ? void 0 : _a.cells.changed.connect(async (_, args) => {
+            var _a, _b;
+            if (args.type === 'remove') {
+                const removedCell = {
+                    newIndex: args.newIndex,
+                    oldIndex: args.oldIndex
+                };
                 const event = {
-                    eventName: NotebookHiddenEventProducer.id,
+                    eventName: CellRemoveEventProducer.id,
                     eventTime: Date.now(),
-                    eventInfo: null
+                    eventInfo: {
+                        cells: [removedCell]
+                    }
                 };
-                await pioneer.publishEvent(notebookPanel, event, logNotebookContentEvent);
+                await pioneer.publishEvent(notebookPanel, event, (_b = (_a = exporter.activeEvents) === null || _a === void 0 ? void 0 : _a.find(o => o.name == CellRemoveEventProducer.id)) === null || _b === void 0 ? void 0 : _b.logWholeNotebook, exporter);
             }
         });
     }
 }
-NotebookHiddenEventProducer.id = 'NotebookHiddenEvent';
-export { NotebookHiddenEventProducer };
+CellRemoveEventProducer.id = 'CellRemoveEvent';
+export { CellRemoveEventProducer };
 class ClipboardCopyEventProducer {
-    listen(notebookPanel, pioneer, logNotebookContentEvent) {
+    listen(notebookPanel, pioneer, exporter) {
         notebookPanel.node.addEventListener('copy', async () => {
-            var _a, _b;
+            var _a, _b, _c, _d;
             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)
@@ -111,16 +164,16 @@ class ClipboardCopyEventProducer {
                     selection: text
                 }
             };
-            await pioneer.publishEvent(notebookPanel, event, logNotebookContentEvent);
+            await pioneer.publishEvent(notebookPanel, event, (_d = (_c = exporter.activeEvents) === null || _c === void 0 ? void 0 : _c.find(o => o.name == ClipboardCopyEventProducer.id)) === null || _d === void 0 ? void 0 : _d.logWholeNotebook, exporter);
         });
     }
 }
 ClipboardCopyEventProducer.id = 'ClipboardCopyEvent';
 export { ClipboardCopyEventProducer };
 class ClipboardCutEventProducer {
-    listen(notebookPanel, pioneer, logNotebookContentEvent) {
+    listen(notebookPanel, pioneer, exporter) {
         notebookPanel.node.addEventListener('cut', async () => {
-            var _a, _b;
+            var _a, _b, _c, _d;
             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)
@@ -134,16 +187,16 @@ class ClipboardCutEventProducer {
                     selection: text
                 }
             };
-            await pioneer.publishEvent(notebookPanel, event, logNotebookContentEvent);
+            await pioneer.publishEvent(notebookPanel, event, (_d = (_c = exporter.activeEvents) === null || _c === void 0 ? void 0 : _c.find(o => o.name == ClipboardCutEventProducer.id)) === null || _d === void 0 ? void 0 : _d.logWholeNotebook, exporter);
         });
     }
 }
 ClipboardCutEventProducer.id = 'ClipboardCutEvent';
 export { ClipboardCutEventProducer };
 class ClipboardPasteEventProducer {
-    listen(notebookPanel, pioneer, logNotebookContentEvent) {
+    listen(notebookPanel, pioneer, exporter) {
         notebookPanel.node.addEventListener('paste', async (e) => {
-            var _a;
+            var _a, _b, _c;
             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)
@@ -157,131 +210,141 @@ class ClipboardPasteEventProducer {
                     selection: text
                 }
             };
-            await pioneer.publishEvent(notebookPanel, event, logNotebookContentEvent);
+            await pioneer.publishEvent(notebookPanel, event, (_c = (_b = exporter.activeEvents) === null || _b === void 0 ? void 0 : _b.find(o => o.name == ClipboardPasteEventProducer.id)) === null || _c === void 0 ? void 0 : _c.logWholeNotebook, exporter);
         });
     }
 }
 ClipboardPasteEventProducer.id = 'ClipboardPasteEvent';
 export { ClipboardPasteEventProducer };
-class ActiveCellChangeEventProducer {
-    listen(notebookPanel, pioneer, 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)
-                };
+class NotebookHiddenEventProducer {
+    listen(notebookPanel, pioneer, exporter) {
+        document.addEventListener('visibilitychange', async (e) => {
+            var _a, _b;
+            if (document.visibilityState === 'hidden' &&
+                document.contains(notebookPanel.node)) {
                 const event = {
-                    eventName: ActiveCellChangeEventProducer.id,
+                    eventName: NotebookHiddenEventProducer.id,
                     eventTime: Date.now(),
-                    eventInfo: {
-                        cells: [activatedCell] // activated cell
-                    }
+                    eventInfo: null
                 };
-                await pioneer.publishEvent(notebookPanel, event, logNotebookContentEvent);
+                await pioneer.publishEvent(notebookPanel, event, (_b = (_a = exporter.activeEvents) === null || _a === void 0 ? void 0 : _a.find(o => o.name == NotebookHiddenEventProducer.id)) === null || _b === void 0 ? void 0 : _b.logWholeNotebook, exporter);
             }
         });
     }
 }
-ActiveCellChangeEventProducer.id = 'ActiveCellChangeEvent';
-export { ActiveCellChangeEventProducer };
+NotebookHiddenEventProducer.id = 'NotebookHiddenEvent';
+export { NotebookHiddenEventProducer };
+class NotebookOpenEventProducer {
+    constructor() {
+        this.produced = false;
+    }
+    async listen(notebookPanel, pioneer, exporter) {
+        var _a, _b;
+        if (!this.produced) {
+            const event = {
+                eventName: NotebookOpenEventProducer.id,
+                eventTime: Date.now(),
+                eventInfo: {
+                    environ: await requestAPI('environ')
+                }
+            };
+            await pioneer.publishEvent(notebookPanel, event, (_b = (_a = exporter.activeEvents) === null || _a === void 0 ? void 0 : _a.find(o => o.name == NotebookOpenEventProducer.id)) === null || _b === void 0 ? void 0 : _b.logWholeNotebook, exporter);
+            this.produced = true;
+        }
+    }
+}
+NotebookOpenEventProducer.id = 'NotebookOpenEvent';
+export { NotebookOpenEventProducer };
 class NotebookSaveEventProducer {
-    listen(notebookPanel, pioneer, logNotebookContentEvent) {
+    listen(notebookPanel, pioneer, exporter) {
         notebookPanel.context.saveState.connect(async (_, saveState) => {
+            var _a, _b;
             if (saveState.match('completed')) {
                 const event = {
                     eventName: NotebookSaveEventProducer.id,
                     eventTime: Date.now(),
                     eventInfo: null
                 };
-                await pioneer.publishEvent(notebookPanel, event, logNotebookContentEvent);
+                await pioneer.publishEvent(notebookPanel, event, (_b = (_a = exporter.activeEvents) === null || _a === void 0 ? void 0 : _a.find(o => o.name == NotebookSaveEventProducer.id)) === null || _b === void 0 ? void 0 : _b.logWholeNotebook, exporter);
             }
         });
     }
 }
 NotebookSaveEventProducer.id = 'NotebookSaveEvent';
 export { NotebookSaveEventProducer };
-class CellExecuteEventProducer {
-    listen(notebookPanel, pioneer, logNotebookContentEvent) {
-        NotebookActions.executed.connect(async (_, args) => {
-            if (notebookPanel.content === args.notebook) {
-                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 pioneer.publishEvent(notebookPanel, event, logNotebookContentEvent);
-            }
-        });
+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
+            });
+        }
     }
-}
-CellExecuteEventProducer.id = 'CellExecuteEvent';
-export { CellExecuteEventProducer };
-class CellAddEventProducer {
-    listen(notebookPanel, pioneer, 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 pioneer.publishEvent(notebookPanel, event, logNotebookContentEvent);
-            }
+    return visibleCells;
+};
+class NotebookScrollProducer {
+    constructor() {
+        this.timeout = 0;
+    }
+    listen(notebookPanel, pioneer, exporter) {
+        notebookPanel.content.node.addEventListener('scroll', async (e) => {
+            var _a, _b;
+            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 pioneer.publishEvent(notebookPanel, event, (_b = (_a = exporter.activeEvents) === null || _a === void 0 ? void 0 : _a.find(o => o.name == NotebookScrollProducer.id)) === null || _b === void 0 ? void 0 : _b.logWholeNotebook, exporter);
         });
     }
 }
-CellAddEventProducer.id = 'CellAddEvent';
-export { CellAddEventProducer };
-class CellRemoveEventProducer {
-    listen(notebookPanel, pioneer, 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
-                };
+NotebookScrollProducer.id = 'NotebookScrollEvent';
+export { NotebookScrollProducer };
+class NotebookVisibleEventProducer {
+    listen(notebookPanel, pioneer, exporter) {
+        document.addEventListener('visibilitychange', async () => {
+            var _a, _b;
+            if (document.visibilityState === 'visible' &&
+                document.contains(notebookPanel.node)) {
                 const event = {
-                    eventName: CellRemoveEventProducer.id,
+                    eventName: NotebookVisibleEventProducer.id,
                     eventTime: Date.now(),
                     eventInfo: {
-                        cells: [removedCell]
+                        cells: getVisibleCells(notebookPanel)
                     }
                 };
-                await pioneer.publishEvent(notebookPanel, event, logNotebookContentEvent);
+                await pioneer.publishEvent(notebookPanel, event, (_b = (_a = exporter.activeEvents) === null || _a === void 0 ? void 0 : _a.find(o => o.name == NotebookVisibleEventProducer.id)) === null || _b === void 0 ? void 0 : _b.logWholeNotebook, exporter);
             }
         });
     }
 }
-CellRemoveEventProducer.id = 'CellRemoveEvent';
-export { CellRemoveEventProducer };
+NotebookVisibleEventProducer.id = 'NotebookVisibleEvent';
+export { NotebookVisibleEventProducer };
 export const producerCollection = [
-    NotebookOpenEventProducer,
-    NotebookScrollProducer,
-    NotebookVisibleEventProducer,
-    NotebookHiddenEventProducer,
+    ActiveCellChangeEventProducer,
+    CellAddEventProducer,
+    CellExecuteEventProducer,
+    CellRemoveEventProducer,
+    CellEditEventProducer,
     ClipboardCopyEventProducer,
     ClipboardCutEventProducer,
     ClipboardPasteEventProducer,
-    ActiveCellChangeEventProducer,
+    NotebookHiddenEventProducer,
+    NotebookOpenEventProducer,
     NotebookSaveEventProducer,
-    CellExecuteEventProducer,
-    CellAddEventProducer,
-    CellRemoveEventProducer
+    NotebookScrollProducer,
+    NotebookVisibleEventProducer
 ];

package/lib/types.d.ts

@@ -0,0 +1,20 @@
+export interface ActiveEvent {
+    name: string;
+    logWholeNotebook: boolean;
+}
+export interface ExporterArgs {
+    id: string;
+    url?: string;
+    params?: Object;
+    path?: string;
+    env?: Object[];
+}
+export interface Exporter {
+    type: string;
+    args?: ExporterArgs;
+    activeEvents?: ActiveEvent[];
+}
+export interface Config {
+    activeEvents: ActiveEvent[];
+    exporters: Exporter[];
+}

package/lib/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "jupyterlab-pioneer",
-    "version": "0.1.6",
+    "version": "0.1.7",
     "description": "A JupyterLab extension.",
     "keywords": [
         "jupyter",

package/lib/router.d.ts

@@ -1,11 +0,0 @@
-import { NotebookPanel } from '@jupyterlab/notebook';
-export declare class Router {
-    /**
-     * Send event data to exporters defined in the configuration file.
-     *
-     * @param {NotebookPanel} notebookPanel The notebook panel the extension currently listens to.
-     * @param {Object} eventDetail An object containing event details
-     * @param {Boolean} logNotebookContent A boolean indicating whether to log the entire notebook or not
-     */
-    publishEvent(notebookPanel: NotebookPanel, eventDetail: Object, logNotebookContent?: Boolean): Promise<void>;
-}

package/lib/router.js

@@ -1,33 +0,0 @@
-import { requestAPI } from './handler';
-export class Router {
-    /**
-     * Send event data to exporters defined in the configuration file.
-     *
-     * @param {NotebookPanel} notebookPanel The notebook panel the extension currently listens to.
-     * @param {Object} eventDetail An object containing event details
-     * @param {Boolean} logNotebookContent A boolean indicating whether to log the entire notebook or not
-     */
-    async publishEvent(notebookPanel, eventDetail, logNotebookContent) {
-        var _a, _b;
-        if (!notebookPanel) {
-            throw Error('router is listening to a null notebook panel');
-        }
-        // Construct data
-        const requestBody = {
-            eventDetail: eventDetail,
-            notebookState: {
-                sessionID: (_a = notebookPanel === null || notebookPanel === void 0 ? void 0 : notebookPanel.sessionContext.session) === null || _a === void 0 ? void 0 : _a.id,
-                notebookPath: notebookPanel === null || notebookPanel === void 0 ? void 0 : notebookPanel.context.path,
-                notebookContent: logNotebookContent
-                    ? (_b = notebookPanel === null || notebookPanel === void 0 ? void 0 : notebookPanel.model) === null || _b === void 0 ? void 0 : _b.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);
-    }
-}