@fails-components/jupyter-filesystem-extension 0.0.5 → 0.0.6

package/README.md

@@ -74,29 +74,3 @@ pip uninstall fails_components_jupyter_filesystem_extension
 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 `@fails-components/jupyter-applet-view` within that folder.
-
-### Testing the extension
-
-#### Frontend tests
-
-This extension is using [Jest](https://jestjs.io/) for JavaScript code testing.
-
-To execute them, execute:
-
-```sh
-jlpm
-jlpm test
-```
-
-<!--
-#### Integration tests
-
-This extension uses [Playwright](https://playwright.dev/docs/intro) for the integration tests (aka user level tests).
-More precisely, the JupyterLab helper [Galata](https://github.com/jupyterlab/jupyterlab/tree/master/galata) is used to handle testing the extension in JupyterLab.
-
-More information are provided within the [ui-tests](./ui-tests/README.md) README.
-
-### Packaging the extension
-
-See [RELEASE](RELEASE.md)
--->

package/lib/drive.d.ts

@@ -1,5 +1,6 @@
-import { Contents, Drive, ServerConnection } from '@jupyterlab/services';
-import { ISignal } from '@lumino/signaling';
+import type { Contents, Drive } from '@jupyterlab/services';
+import { ServerConnection } from '@jupyterlab/services';
+import type { ISignal } from '@lumino/signaling';
 interface IContentEvent {
     task: string;
 }

package/lib/drive.js

@@ -8,7 +8,7 @@ import { Signal } from '@lumino/signaling';
 // This code contains portions from or is inspired by Jupyter lab and lite
 // especially the Drive implementation
 const jsonMime = 'application/json';
-class FailsDrive {
+export class FailsDrive {
     constructor(options) {
         var _a;
         this._fileContent = JSON.stringify(FailsDrive.EMPTY_NB);
@@ -205,4 +205,3 @@ FailsDrive.EMPTY_NB = {
     nbformat: 4,
     cells: []
 };
-export { FailsDrive };

package/lib/index.d.ts

@@ -1,4 +1,4 @@
-import { ServiceManagerPlugin } from '@jupyterlab/services';
+import type { ServiceManagerPlugin } from '@jupyterlab/services';
 export * from './token';
 declare const plugins: ServiceManagerPlugin<any>[];
 export default plugins;

package/lib/index.js

@@ -8,6 +8,7 @@ const failsDriveMessages = {
     requires: [],
     autoStart: true,
     provides: IFailsDriveMessages,
+    description: 'IFailsDriveMessages interface to send/receive messages for the drive',
     activate: (_) => {
         let initialWaitRes;
         const initialWait = new Promise(resolve => (initialWaitRes = resolve));
@@ -33,6 +34,7 @@ const failsDrivePlugin = {
     requires: [IFailsDriveMessages],
     autoStart: true,
     provides: IDefaultDrive,
+    description: 'Supplies a drive object for Jupyter lite to be fed from outisde the iframe',
     activate: (_, driveMessages) => {
         const drive = new FailsDrive({});
         driveMessages.registerMessageHandler(msg => drive.onMessage(msg));
@@ -45,6 +47,7 @@ const failsSettingsPlugin = {
     autoStart: true,
     provides: ISettingManager,
     optional: [IServerSettings],
+    description: 'ISettingsManager from the IFrame embeeded Jupyter',
     activate: (_, serverSettings) => {
         const settings = new FailsSettings({
             serverSettings: serverSettings !== null && serverSettings !== void 0 ? serverSettings : undefined

package/lib/settings.d.ts

@@ -1,5 +1,6 @@
-import { Setting, SettingManager } from '@jupyterlab/services';
-import { ISettingRegistry } from '@jupyterlab/settingregistry';
+import type { Setting } from '@jupyterlab/services';
+import { SettingManager } from '@jupyterlab/services';
+import type { ISettingRegistry } from '@jupyterlab/settingregistry';
 export type SettingsFile = 'all.json' | 'all_federated.json';
 export declare class FailsSettings extends SettingManager implements Setting.IManager {
     static _overrides: Record<string, ISettingRegistry.IPlugin['schema']['default']>;

package/lib/settings.js

@@ -1,7 +1,7 @@
 import { PageConfig, URLExt } from '@jupyterlab/coreutils';
 import { SettingManager } from '@jupyterlab/services';
 import * as json5 from 'json5';
-class FailsSettings extends SettingManager {
+export class FailsSettings extends SettingManager {
     static override(plugin) {
         if (FailsSettings._overrides[plugin.id]) {
             if (!plugin.schema.properties) {
@@ -80,4 +80,3 @@ class FailsSettings extends SettingManager {
 }
 // the following is copied from the original Jupyter Lite Settings Object
 FailsSettings._overrides = JSON.parse(PageConfig.getOption('settingsOverrides') || '{}');
-export { FailsSettings };

package/lib/token.d.ts

@@ -1,5 +1,5 @@
 import { Token } from '@lumino/coreutils';
-import { IContentEventType } from './drive';
+import type { IContentEventType } from './drive';
 export type IFailsDriveMessageHandler = (msg: IContentEventType) => Promise<void> | void;
 export interface IFailsDriveMessages {
     registerMessageHandler: (handler: IFailsDriveMessageHandler) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@fails-components/jupyter-filesystem-extension",
-    "version": "0.0.5",
+    "version": "0.0.6",
     "description": "A collection of extensions, that redirect's filesystems access to fails and let fails puppeteer Jupyter lite. ",
     "keywords": [
         "jupyter",
@@ -34,8 +34,8 @@
     "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:labextension": "jupyter-builder build .",
+        "build:labextension:dev": "jupyter-builder build --development True .",
         "build:lib": "tsc --sourceMap",
         "build:lib:prod": "tsc",
         "clean": "jlpm clean:lib",
@@ -60,26 +60,27 @@
         "watch:labextension": "jupyter labextension watch ."
     },
     "dependencies": {
-        "@jupyterlab/coreutils": "^6.5.1",
-        "@jupyterlab/services": "^7.5.1",
-        "@jupyterlab/settingregistry": "^4.5.1",
+        "@jupyterlab/coreutils": "^6.6.0",
+        "@jupyterlab/services": "^7.6.0",
+        "@jupyterlab/settingregistry": "~4.6.0",
         "@lumino/coreutils": "^2.2.2",
         "@lumino/signaling": "^2.1.5",
         "json5": "^2.2.3"
     },
     "devDependencies": {
-        "@jupyterlab/builder": "^4.5.1",
-        "@jupyterlab/testutils": "^4.5.1",
+        "@jupyter/builder": "~1.0.0",
+        "@jupyter/eslint-plugin": "0.0.5",
+        "@jupyterlab/testutils": "~4.6.0",
+        "@stylistic/eslint-plugin": "^5.10.0",
         "@types/jest": "^29.2.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",
+        "eslint": "^9.39.2",
+        "eslint-config-prettier": "^9.1.0",
+        "eslint-plugin-prettier": "^5.1.3",
+        "eslint-plugin-react": "^7.37.0",
         "jest": "^29.2.0",
         "npm-run-all": "^4.1.5",
         "prettier": "^3.0.0",
@@ -91,7 +92,8 @@
         "stylelint-config-standard": "^34.0.0",
         "stylelint-csstree-validator": "^3.0.0",
         "stylelint-prettier": "^4.0.0",
-        "typescript": "~5.0.2",
+        "typescript": "~5.9.3",
+        "typescript-eslint": "^8.0.0",
         "yjs": "^13.5.0"
     },
     "sideEffects": [
@@ -113,8 +115,7 @@
         "coverage",
         "**/*.d.ts",
         "tests",
-        "**/__tests__",
-        "ui-tests"
+        "**/__tests__"
     ],
     "eslintConfig": {
         "extends": [

package/src/drive.ts

@@ -1,5 +1,7 @@
-import { Contents, Drive, ServerConnection } from '@jupyterlab/services';
-import { ISignal, Signal } from '@lumino/signaling';
+import type { Contents, Drive } from '@jupyterlab/services';
+import { ServerConnection } from '@jupyterlab/services';
+import type { ISignal } from '@lumino/signaling';
+import { Signal } from '@lumino/signaling';
 
 interface IContentEvent {
   task: string;
@@ -17,8 +19,7 @@ export interface ISavedJupyterContentEvent extends IContentEvent {
 }
 
 export type IContentEventType =
-  | ILoadJupyterContentEvent
-  | ISavedJupyterContentEvent; // use union
+  ILoadJupyterContentEvent | ISavedJupyterContentEvent; // use union
 
 // portions used from Jupyterlab:
 /* -----------------------------------------------------------------------------

package/src/index.ts

@@ -1,15 +1,19 @@
-import {
-  IDefaultDrive,
+import type {
   Contents,
   ServerConnection,
   Setting,
-  ISettingManager,
-  IServerSettings,
   ServiceManagerPlugin
 } from '@jupyterlab/services';
-import { FailsDrive, IContentEventType } from './drive';
+import {
+  IDefaultDrive,
+  ISettingManager,
+  IServerSettings
+} from '@jupyterlab/services';
+import type { IContentEventType } from './drive';
+import { FailsDrive } from './drive';
 import { FailsSettings } from './settings';
-import { IFailsDriveMessageHandler, IFailsDriveMessages } from './token';
+import type { IFailsDriveMessageHandler } from './token';
+import { IFailsDriveMessages } from './token';
 
 export * from './token';
 
@@ -18,6 +22,8 @@ const failsDriveMessages: ServiceManagerPlugin<IFailsDriveMessages> = {
   requires: [],
   autoStart: true,
   provides: IFailsDriveMessages,
+  description:
+    'IFailsDriveMessages interface to send/receive messages for the drive',
   activate: (_: null) => {
     let initialWaitRes: ((val: unknown) => void) | undefined;
     const initialWait = new Promise(resolve => (initialWaitRes = resolve));
@@ -44,6 +50,8 @@ const failsDrivePlugin: ServiceManagerPlugin<Contents.IDrive> = {
   requires: [IFailsDriveMessages],
   autoStart: true,
   provides: IDefaultDrive,
+  description:
+    'Supplies a drive object for Jupyter lite to be fed from outisde the iframe',
   activate: (_: null, driveMessages: IFailsDriveMessages) => {
     const drive = new FailsDrive({});
     driveMessages.registerMessageHandler(msg => drive.onMessage(msg));
@@ -57,6 +65,7 @@ const failsSettingsPlugin: ServiceManagerPlugin<Setting.IManager> = {
   autoStart: true,
   provides: ISettingManager,
   optional: [IServerSettings],
+  description: 'ISettingsManager from the IFrame embeeded Jupyter',
   activate: (_: null, serverSettings: ServerConnection.ISettings | null) => {
     const settings = new FailsSettings({
       serverSettings: serverSettings ?? undefined

package/src/settings.ts

@@ -1,6 +1,7 @@
 import { PageConfig, URLExt } from '@jupyterlab/coreutils';
-import { Setting, SettingManager } from '@jupyterlab/services';
-import { ISettingRegistry } from '@jupyterlab/settingregistry';
+import type { Setting } from '@jupyterlab/services';
+import { SettingManager } from '@jupyterlab/services';
+import type { ISettingRegistry } from '@jupyterlab/settingregistry';
 import * as json5 from 'json5';
 
 // portions used from Jupyterlab:

package/src/token.ts

@@ -1,5 +1,5 @@
 import { Token } from '@lumino/coreutils';
-import { IContentEventType } from './drive';
+import type { IContentEventType } from './drive';
 
 export type IFailsDriveMessageHandler = (
   msg: IContentEventType