jupyterlab-pioneer 1.5.0 → 1.7.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/README.md +3 -2
  2. package/lib/index.d.ts +3 -3
  3. package/lib/producer.js +14 -14
  4. package/lib/types.d.ts +2 -2
  5. package/lib/utils.js +2 -1
  6. package/package.json +2 -6
package/README.md CHANGED
@@ -197,11 +197,12 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
197
197
  <table>
198
198
  <tbody>
199
199
  <tr>
200
- <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>
200
+ <td align="center" valign="top" width="14.28%"><a href="https://github.com/mengyanw"><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="#code-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="#tests-mengyanw" title="Tests">⚠️</a> <a href="#documentation-mengyanw" title="Documentation">📖</a></td>
201
201
  <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>
202
202
  <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>
203
- <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>
203
+ <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="#code-costrouc" title="Code">💻</a></td>
204
204
  <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>
205
+ <td align="center" valign="top" width="14.28%"><a href="https://github.com/cmarmo"><img src="https://avatars.githubusercontent.com/u/1662261?v=4?s=100" width="100px;" alt="Chiara Marmo"/><br /><sub><b>Chiara Marmo</b></sub></a><br /><a href="#code-cmarmo" title="Code">💻</a> <a href="#infra-cmarmo" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a></td>
205
206
  </tr>
206
207
  </tbody>
207
208
  </table>
package/lib/index.d.ts CHANGED
@@ -13,17 +13,17 @@ export interface IJupyterLabPioneer {
13
13
  * Send event data to exporters defined in the configuration file.
14
14
  *
15
15
  * @param {NotebookPanel} notebookPanel The notebook panel the extension currently listens to.
16
- * @param {Object} eventDetail An object containing event details.
16
+ * @param {object} eventDetail An object containing event details.
17
17
  * @param {Exporter} exporter The exporter configuration.
18
18
  * @param {Boolean} logWholeNotebook A boolean indicating whether to log the entire notebook or not.
19
19
  */
20
- publishEvent(notebookPanel: NotebookPanel, eventDetail: Object, exporter: Exporter, logWholeNotebook?: Boolean): Promise<void>;
20
+ publishEvent(notebookPanel: NotebookPanel, eventDetail: object, exporter: Exporter, logWholeNotebook?: boolean): Promise<void>;
21
21
  }
22
22
  declare class JupyterLabPioneer implements IJupyterLabPioneer {
23
23
  exporters: Exporter[];
24
24
  constructor();
25
25
  loadExporters(notebookPanel: NotebookPanel): Promise<void>;
26
- publishEvent(notebookPanel: NotebookPanel, eventDetail: Object, exporter: Exporter, logWholeNotebook?: Boolean): Promise<void>;
26
+ publishEvent(notebookPanel: NotebookPanel, eventDetail: object, exporter: Exporter, logWholeNotebook?: boolean): Promise<void>;
27
27
  }
28
28
  declare const plugin: JupyterFrontEndPlugin<JupyterLabPioneer>;
29
29
  export default plugin;
package/lib/producer.js CHANGED
@@ -20,7 +20,7 @@ class ActiveCellChangeEventProducer {
20
20
  pioneer.exporters.forEach(async (exporter) => {
21
21
  var _a, _b, _c;
22
22
  if ((_a = exporter.activeEvents) === null || _a === void 0 ? void 0 : _a.map(o => o.name).includes(ActiveCellChangeEventProducer.id)) {
23
- await pioneer.publishEvent(notebookPanel, event, exporter, (_c = (_b = exporter.activeEvents) === null || _b === void 0 ? void 0 : _b.find(o => o.name == ActiveCellChangeEventProducer.id)) === null || _c === void 0 ? void 0 : _c.logWholeNotebook);
23
+ await pioneer.publishEvent(notebookPanel, event, exporter, (_c = (_b = exporter.activeEvents) === null || _b === void 0 ? void 0 : _b.find(o => o.name === ActiveCellChangeEventProducer.id)) === null || _c === void 0 ? void 0 : _c.logWholeNotebook);
24
24
  }
25
25
  });
26
26
  }
@@ -49,7 +49,7 @@ class CellAddEventProducer {
49
49
  pioneer.exporters.forEach(async (exporter) => {
50
50
  var _a, _b, _c;
51
51
  if ((_a = exporter.activeEvents) === null || _a === void 0 ? void 0 : _a.map(o => o.name).includes(CellAddEventProducer.id)) {
52
- await pioneer.publishEvent(notebookPanel, event, exporter, (_c = (_b = exporter.activeEvents) === null || _b === void 0 ? void 0 : _b.find(o => o.name == CellAddEventProducer.id)) === null || _c === void 0 ? void 0 : _c.logWholeNotebook);
52
+ await pioneer.publishEvent(notebookPanel, event, exporter, (_c = (_b = exporter.activeEvents) === null || _b === void 0 ? void 0 : _b.find(o => o.name === CellAddEventProducer.id)) === null || _c === void 0 ? void 0 : _c.logWholeNotebook);
53
53
  }
54
54
  });
55
55
  }
@@ -77,7 +77,7 @@ class CellEditEventProducer {
77
77
  pioneer.exporters.forEach(async (exporter) => {
78
78
  var _a, _b, _c;
79
79
  if ((_a = exporter.activeEvents) === null || _a === void 0 ? void 0 : _a.map(o => o.name).includes(CellEditEventProducer.id)) {
80
- await pioneer.publishEvent(notebookPanel, event, exporter, (_c = (_b = exporter.activeEvents) === null || _b === void 0 ? void 0 : _b.find(o => o.name == CellEditEventProducer.id)) === null || _c === void 0 ? void 0 : _c.logWholeNotebook);
80
+ await pioneer.publishEvent(notebookPanel, event, exporter, (_c = (_b = exporter.activeEvents) === null || _b === void 0 ? void 0 : _b.find(o => o.name === CellEditEventProducer.id)) === null || _c === void 0 ? void 0 : _c.logWholeNotebook);
81
81
  }
82
82
  });
83
83
  };
@@ -126,7 +126,7 @@ class CellExecuteEventProducer {
126
126
  if (notebookPanel.content === args.notebook) {
127
127
  const executedCell = {
128
128
  id: args.cell.model.id,
129
- index: args.notebook.widgets.findIndex(value => value == args.cell),
129
+ index: args.notebook.widgets.findIndex(value => value === args.cell),
130
130
  type: args.cell.model.type
131
131
  };
132
132
  const event = {
@@ -141,7 +141,7 @@ class CellExecuteEventProducer {
141
141
  pioneer.exporters.forEach(async (exporter) => {
142
142
  var _a, _b, _c;
143
143
  if ((_a = exporter.activeEvents) === null || _a === void 0 ? void 0 : _a.map(o => o.name).includes(CellExecuteEventProducer.id)) {
144
- await pioneer.publishEvent(notebookPanel, event, exporter, (_c = (_b = exporter.activeEvents) === null || _b === void 0 ? void 0 : _b.find(o => o.name == CellExecuteEventProducer.id)) === null || _c === void 0 ? void 0 : _c.logWholeNotebook);
144
+ await pioneer.publishEvent(notebookPanel, event, exporter, (_c = (_b = exporter.activeEvents) === null || _b === void 0 ? void 0 : _b.find(o => o.name === CellExecuteEventProducer.id)) === null || _c === void 0 ? void 0 : _c.logWholeNotebook);
145
145
  }
146
146
  });
147
147
  }
@@ -170,7 +170,7 @@ class CellRemoveEventProducer {
170
170
  pioneer.exporters.forEach(async (exporter) => {
171
171
  var _a, _b, _c;
172
172
  if ((_a = exporter.activeEvents) === null || _a === void 0 ? void 0 : _a.map(o => o.name).includes(CellRemoveEventProducer.id)) {
173
- await pioneer.publishEvent(notebookPanel, event, exporter, (_c = (_b = exporter.activeEvents) === null || _b === void 0 ? void 0 : _b.find(o => o.name == CellRemoveEventProducer.id)) === null || _c === void 0 ? void 0 : _c.logWholeNotebook);
173
+ await pioneer.publishEvent(notebookPanel, event, exporter, (_c = (_b = exporter.activeEvents) === null || _b === void 0 ? void 0 : _b.find(o => o.name === CellRemoveEventProducer.id)) === null || _c === void 0 ? void 0 : _c.logWholeNotebook);
174
174
  }
175
175
  });
176
176
  }
@@ -200,7 +200,7 @@ class ClipboardCopyEventProducer {
200
200
  pioneer.exporters.forEach(async (exporter) => {
201
201
  var _a, _b, _c;
202
202
  if ((_a = exporter.activeEvents) === null || _a === void 0 ? void 0 : _a.map(o => o.name).includes(ClipboardCopyEventProducer.id)) {
203
- await pioneer.publishEvent(notebookPanel, event, exporter, (_c = (_b = exporter.activeEvents) === null || _b === void 0 ? void 0 : _b.find(o => o.name == ClipboardCopyEventProducer.id)) === null || _c === void 0 ? void 0 : _c.logWholeNotebook);
203
+ await pioneer.publishEvent(notebookPanel, event, exporter, (_c = (_b = exporter.activeEvents) === null || _b === void 0 ? void 0 : _b.find(o => o.name === ClipboardCopyEventProducer.id)) === null || _c === void 0 ? void 0 : _c.logWholeNotebook);
204
204
  }
205
205
  });
206
206
  });
@@ -229,7 +229,7 @@ class ClipboardCutEventProducer {
229
229
  pioneer.exporters.forEach(async (exporter) => {
230
230
  var _a, _b, _c;
231
231
  if ((_a = exporter.activeEvents) === null || _a === void 0 ? void 0 : _a.map(o => o.name).includes(ClipboardCutEventProducer.id)) {
232
- await pioneer.publishEvent(notebookPanel, event, exporter, (_c = (_b = exporter.activeEvents) === null || _b === void 0 ? void 0 : _b.find(o => o.name == ClipboardCutEventProducer.id)) === null || _c === void 0 ? void 0 : _c.logWholeNotebook);
232
+ await pioneer.publishEvent(notebookPanel, event, exporter, (_c = (_b = exporter.activeEvents) === null || _b === void 0 ? void 0 : _b.find(o => o.name === ClipboardCutEventProducer.id)) === null || _c === void 0 ? void 0 : _c.logWholeNotebook);
233
233
  }
234
234
  });
235
235
  });
@@ -258,7 +258,7 @@ class ClipboardPasteEventProducer {
258
258
  pioneer.exporters.forEach(async (exporter) => {
259
259
  var _a, _b, _c;
260
260
  if ((_a = exporter.activeEvents) === null || _a === void 0 ? void 0 : _a.map(o => o.name).includes(ClipboardPasteEventProducer.id)) {
261
- await pioneer.publishEvent(notebookPanel, event, exporter, (_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);
261
+ await pioneer.publishEvent(notebookPanel, event, exporter, (_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);
262
262
  }
263
263
  });
264
264
  });
@@ -279,7 +279,7 @@ class NotebookHiddenEventProducer {
279
279
  pioneer.exporters.forEach(async (exporter) => {
280
280
  var _a, _b, _c;
281
281
  if ((_a = exporter.activeEvents) === null || _a === void 0 ? void 0 : _a.map(o => o.name).includes(NotebookHiddenEventProducer.id)) {
282
- await pioneer.publishEvent(notebookPanel, event, exporter, (_c = (_b = exporter.activeEvents) === null || _b === void 0 ? void 0 : _b.find(o => o.name == NotebookHiddenEventProducer.id)) === null || _c === void 0 ? void 0 : _c.logWholeNotebook);
282
+ await pioneer.publishEvent(notebookPanel, event, exporter, (_c = (_b = exporter.activeEvents) === null || _b === void 0 ? void 0 : _b.find(o => o.name === NotebookHiddenEventProducer.id)) === null || _c === void 0 ? void 0 : _c.logWholeNotebook);
283
283
  }
284
284
  });
285
285
  }
@@ -304,7 +304,7 @@ class NotebookOpenEventProducer {
304
304
  pioneer.exporters.forEach(async (exporter) => {
305
305
  var _a, _b, _c;
306
306
  if ((_a = exporter.activeEvents) === null || _a === void 0 ? void 0 : _a.map(o => o.name).includes(NotebookOpenEventProducer.id)) {
307
- await pioneer.publishEvent(notebookPanel, event, exporter, (_c = (_b = exporter.activeEvents) === null || _b === void 0 ? void 0 : _b.find(o => o.name == NotebookOpenEventProducer.id)) === null || _c === void 0 ? void 0 : _c.logWholeNotebook);
307
+ await pioneer.publishEvent(notebookPanel, event, exporter, (_c = (_b = exporter.activeEvents) === null || _b === void 0 ? void 0 : _b.find(o => o.name === NotebookOpenEventProducer.id)) === null || _c === void 0 ? void 0 : _c.logWholeNotebook);
308
308
  this.produced = true;
309
309
  }
310
310
  });
@@ -325,7 +325,7 @@ class NotebookSaveEventProducer {
325
325
  pioneer.exporters.forEach(async (exporter) => {
326
326
  var _a, _b, _c;
327
327
  if ((_a = exporter.activeEvents) === null || _a === void 0 ? void 0 : _a.map(o => o.name).includes(NotebookSaveEventProducer.id)) {
328
- await pioneer.publishEvent(notebookPanel, event, exporter, (_c = (_b = exporter.activeEvents) === null || _b === void 0 ? void 0 : _b.find(o => o.name == NotebookSaveEventProducer.id)) === null || _c === void 0 ? void 0 : _c.logWholeNotebook);
328
+ await pioneer.publishEvent(notebookPanel, event, exporter, (_c = (_b = exporter.activeEvents) === null || _b === void 0 ? void 0 : _b.find(o => o.name === NotebookSaveEventProducer.id)) === null || _c === void 0 ? void 0 : _c.logWholeNotebook);
329
329
  }
330
330
  });
331
331
  }
@@ -374,7 +374,7 @@ class NotebookScrollEventProducer {
374
374
  pioneer.exporters.forEach(async (exporter) => {
375
375
  var _a, _b, _c;
376
376
  if ((_a = exporter.activeEvents) === null || _a === void 0 ? void 0 : _a.map(o => o.name).includes(NotebookScrollEventProducer.id)) {
377
- await pioneer.publishEvent(notebookPanel, event, exporter, (_c = (_b = exporter.activeEvents) === null || _b === void 0 ? void 0 : _b.find(o => o.name == NotebookScrollEventProducer.id)) === null || _c === void 0 ? void 0 : _c.logWholeNotebook);
377
+ await pioneer.publishEvent(notebookPanel, event, exporter, (_c = (_b = exporter.activeEvents) === null || _b === void 0 ? void 0 : _b.find(o => o.name === NotebookScrollEventProducer.id)) === null || _c === void 0 ? void 0 : _c.logWholeNotebook);
378
378
  }
379
379
  });
380
380
  });
@@ -397,7 +397,7 @@ class NotebookVisibleEventProducer {
397
397
  pioneer.exporters.forEach(async (exporter) => {
398
398
  var _a, _b, _c;
399
399
  if ((_a = exporter.activeEvents) === null || _a === void 0 ? void 0 : _a.map(o => o.name).includes(NotebookVisibleEventProducer.id)) {
400
- await pioneer.publishEvent(notebookPanel, event, exporter, (_c = (_b = exporter.activeEvents) === null || _b === void 0 ? void 0 : _b.find(o => o.name == NotebookVisibleEventProducer.id)) === null || _c === void 0 ? void 0 : _c.logWholeNotebook);
400
+ await pioneer.publishEvent(notebookPanel, event, exporter, (_c = (_b = exporter.activeEvents) === null || _b === void 0 ? void 0 : _b.find(o => o.name === NotebookVisibleEventProducer.id)) === null || _c === void 0 ? void 0 : _c.logWholeNotebook);
401
401
  }
402
402
  });
403
403
  }
package/lib/types.d.ts CHANGED
@@ -24,11 +24,11 @@ export interface ExporterArgs {
24
24
  /**
25
25
  * Additional parameters to pass to the http endpoint (optional for remote exporter)
26
26
  */
27
- params?: Object;
27
+ params?: object;
28
28
  /**
29
29
  * Environment variables to pass to the http endpoint (optional for remote exporter)
30
30
  */
31
- env?: Object[];
31
+ env?: object[];
32
32
  }
33
33
  export interface Exporter {
34
34
  /**
package/lib/utils.js CHANGED
@@ -9,7 +9,8 @@ export const sendInfoNotification = (exporters, isGlobal) => {
9
9
  message = `Telemetry data is being logged to ${exporterMessage} through jupyterlab-pioneer. \n See Help menu -> JupyterLab Pioneer for more details.`;
10
10
  }
11
11
  else if (isGlobal && !exporterMessage) {
12
- message = `Telemetry data is being logged through jupyterlab-pioneer. \n See Help menu -> JupyterLab Pioneer for more details.`;
12
+ message =
13
+ 'Telemetry data is being logged through jupyterlab-pioneer. \n See Help menu -> JupyterLab Pioneer for more details.';
13
14
  }
14
15
  else {
15
16
  message = `Embedded telemetry settings loaded. Telemetry data is being logged to ${exporterMessage} now.`;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "jupyterlab-pioneer",
3
- "version": "1.5.0",
3
+ "version": "1.7.1",
4
4
  "description": "A JupyterLab extension.",
5
5
  "keywords": [
6
6
  "jupyter",
@@ -136,11 +136,7 @@
136
136
  "selector": "interface",
137
137
  "format": [
138
138
  "PascalCase"
139
- ],
140
- "custom": {
141
- "regex": "^I[A-Z]",
142
- "match": true
143
- }
139
+ ]
144
140
  }
145
141
  ],
146
142
  "@typescript-eslint/no-unused-vars": [