@fails-components/jupyter-filesystem-extension 0.0.1-alpha.10

package/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2024, Marten Richter
+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,102 @@
+# fails_components_jupyter_filesystem_extension
+
+[![Github Actions Status](https://github.com/fails-components/jupyterfails/workflows/Build/badge.svg)](https://github.com/fails-components/jupyterfails/actions/workflows/build.yml)
+
+This is an extension, that taps into jupyter lite's filesystem handling to be able to remotely control and supply the files visible to jupyter lite.
+It is probably only useful together with fails-components' jupyter launcher plugin,
+that allows to control jupyter lite embedded inside an iframe (build from the jupyterfails' repos configs).
+
+## Requirements
+
+- JupyterLab >= 4.0.0
+
+## Install
+
+To install the extension, execute:
+
+```bash
+pip install fails_components_jupyter_filesystem_extension
+```
+
+## Uninstall
+
+To remove the extension, execute:
+
+```bash
+pip uninstall fails_components_jupyter_filesystem_extension
+```
+
+## 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 fails_components_jupyter_filesystem_extension directory
+jlpm build
+# Install package in development mode
+pip install -e "."
+# Link your development version of the extension with JupyterLab
+jupyter labextension develop . --overwrite
+# 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
+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/contents.d.ts

@@ -0,0 +1,31 @@
+import { Contents as ServerContents } from '@jupyterlab/services';
+import { IContents } from '@jupyterlite/contents';
+import { IContentEventType } from '@fails-components/jupyter-launcher';
+export declare class FailsContents implements IContents {
+    constructor();
+    onMessage(event: IContentEventType): Promise<any>;
+    get ready(): Promise<void>;
+    initialize(): Promise<void>;
+    get(path: string, options?: ServerContents.IFetchOptions): Promise<ServerContents.IModel | null>;
+    save(path: string, options?: Partial<ServerContents.IModel>): Promise<ServerContents.IModel | null>;
+    newUntitled(options?: ServerContents.ICreateOptions): Promise<ServerContents.IModel | null>;
+    rename(oldLocalPath: string, newLocalPath: string): Promise<ServerContents.IModel>;
+    delete(path: string): Promise<void>;
+    copy(path: string, toDir: string): Promise<ServerContents.IModel>;
+    createCheckpoint(path: string): Promise<ServerContents.ICheckpointModel>;
+    listCheckpoints(path: string): Promise<ServerContents.ICheckpointModel[]>;
+    restoreCheckpoint(path: string, checkpointID: string): Promise<void>;
+    deleteCheckpoint(path: string, checkpointID: string): Promise<void>;
+    static EMPTY_NB: {
+        metadata: {
+            orig_nbformat: number;
+        };
+        nbformat_minor: number;
+        nbformat: number;
+        cells: never[];
+    };
+    private _ready;
+    private _fileContent;
+    private _fileName;
+    private _failsCallbacks;
+}

package/lib/contents.js

@@ -0,0 +1,165 @@
+import { PromiseDelegate } from '@lumino/coreutils';
+// portions used from Jupyterlab:
+/* -----------------------------------------------------------------------------
+| Copyright (c) Jupyter Development Team.
+| Distributed under the terms of the Modified BSD License.
+|----------------------------------------------------------------------------*/
+// This code contains portions from or is inspired by Jupyter lab and lite
+const jsonMime = 'application/json';
+class FailsContents {
+    constructor() {
+        this._fileContent = JSON.stringify(FailsContents.EMPTY_NB);
+        this._fileName = 'unloaded.ipynb';
+        this._ready = new PromiseDelegate();
+        if (!window.failsCallbacks) {
+            window.failsCallbacks = {};
+        }
+        this._failsCallbacks = window.failsCallbacks;
+        this._failsCallbacks.callContents = this.onMessage.bind(this);
+    }
+    async onMessage(event) {
+        // todo handle events
+        switch (event.task) {
+            case 'loadFile':
+                {
+                    const loadevent = event;
+                    this._fileContent = JSON.stringify(loadevent.fileData || FailsContents.EMPTY_NB);
+                    this._fileName = loadevent.fileName;
+                }
+                break;
+            case 'savedFile':
+                {
+                    const savedevent = event;
+                    if (this._fileName !== savedevent.fileName) {
+                        return { error: 'Filename not found' };
+                    }
+                    return {
+                        fileData: JSON.parse(this._fileContent)
+                    };
+                }
+                break;
+        }
+    }
+    get ready() {
+        return this._ready.promise;
+    }
+    async initialize() {
+        this._ready.resolve(void 0);
+    }
+    async get(path, options) {
+        // remove leading slash
+        path = decodeURIComponent(path.replace(/^\//, ''));
+        const serverFile = {
+            name: this._fileName,
+            path: this._fileName,
+            last_modified: new Date(0).toISOString(),
+            created: new Date(0).toISOString(),
+            format: 'json',
+            mimetype: jsonMime,
+            content: JSON.parse(this._fileContent),
+            size: 0,
+            writable: true,
+            type: 'notebook'
+        };
+        if (path === '') {
+            // the local directory, return the info about the proxy notebook
+            return {
+                name: '',
+                path,
+                last_modified: new Date(0).toISOString(),
+                created: new Date(0).toISOString(),
+                format: 'json',
+                mimetype: jsonMime,
+                content: [serverFile],
+                size: 0,
+                writable: true,
+                type: 'directory'
+            };
+        }
+        if (path === this._fileName) {
+            return serverFile;
+        }
+        return null; // not found
+    }
+    async save(path, options = {}) {
+        path = decodeURIComponent(path);
+        if (path !== this._fileName) {
+            // we only allow the proxy object
+            return null;
+        }
+        const chunk = options.chunk;
+        const chunked = chunk ? chunk > 1 || chunk === -1 : false;
+        let item = await this.get(path, {
+            content: chunked
+        });
+        if (!item) {
+            return null;
+        }
+        const modified = new Date().toISOString();
+        // override with the new values
+        item = {
+            ...item,
+            ...options,
+            last_modified: modified
+        };
+        if (options.content && options.format === 'base64') {
+            const lastChunk = chunk ? chunk === -1 : true;
+            const modified = new Date().toISOString();
+            // override with the new values
+            item = {
+                ...item,
+                ...options,
+                last_modified: modified
+            };
+            const originalContent = item.content;
+            const escaped = decodeURIComponent(escape(atob(options.content)));
+            const newcontent = chunked ? originalContent + escaped : escaped;
+            item = {
+                ...item,
+                content: lastChunk ? JSON.parse(newcontent) : newcontent,
+                format: 'json',
+                type: 'notebook',
+                size: newcontent.length
+            };
+            this._fileContent = JSON.stringify(newcontent); // no parsing
+            return item;
+        }
+        this._fileContent = JSON.stringify(item.content); // no parsing
+        return item;
+    }
+    // For fails creating a new file is not allowed, so no need to implment it
+    async newUntitled(options) {
+        throw new Error('NewUntitled not implemented');
+    }
+    async rename(oldLocalPath, newLocalPath) {
+        throw new Error('rename not implemented');
+    }
+    async delete(path) {
+        throw new Error('delete not implemented');
+    }
+    async copy(path, toDir) {
+        throw new Error('copy not implemented');
+    }
+    async createCheckpoint(path) {
+        throw new Error('createCheckpoint not (yet?) implemented');
+    }
+    async listCheckpoints(path) {
+        // throw new Error('listCheckpoints not (yet?) implemented');
+        return [{ id: 'fakeCheckpoint', last_modified: new Date().toISOString() }];
+    }
+    async restoreCheckpoint(path, checkpointID) {
+        throw new Error('restoreCheckpoint not (yet?) implemented');
+    }
+    async deleteCheckpoint(path, checkpointID) {
+        throw new Error('deleteCheckpoint not (yet?) implemented');
+    }
+}
+FailsContents.EMPTY_NB = {
+    metadata: {
+        orig_nbformat: 4
+    },
+    nbformat_minor: 5,
+    nbformat: 4,
+    cells: []
+};
+export { FailsContents };

package/lib/index.d.ts

@@ -0,0 +1,5 @@
+import { IContents } from '@jupyterlite/contents';
+import { JupyterLiteServerPlugin } from '@jupyterlite/server';
+export declare const failsContentsPlugin: JupyterLiteServerPlugin<IContents>;
+declare const plugins: JupyterLiteServerPlugin<any>[];
+export default plugins;

package/lib/index.js

@@ -0,0 +1,37 @@
+import { IContents } from '@jupyterlite/contents';
+import { ISettings } from '@jupyterlite/settings';
+import { FailsContents } from './contents';
+import { FailsSettings } from './settings';
+export const failsContentsPlugin = {
+    id: '@fails-components/jupyter-fails-server:contents',
+    requires: [],
+    autoStart: true,
+    provides: IContents,
+    activate: (app) => {
+        if (app.namespace !== 'JupyterLite Server') {
+            console.log('Not on server');
+        }
+        const contents = new FailsContents();
+        app.started.then(() => contents.initialize().catch(console.warn));
+        return contents;
+    }
+};
+const failsSettingsPlugin = {
+    id: '@fails-components/jupyter-fails-server:settings',
+    requires: [],
+    autoStart: true,
+    provides: ISettings,
+    activate: (app) => {
+        if (app.namespace !== 'JupyterLite Server') {
+            console.log('Not on server');
+        }
+        const settings = new FailsSettings();
+        app.started.then(() => settings.initialize().catch(console.warn));
+        return settings;
+    }
+};
+const plugins = [
+    failsContentsPlugin,
+    failsSettingsPlugin
+];
+export default plugins;

package/lib/settings.d.ts

@@ -0,0 +1,15 @@
+import { ISettings, IPlugin as ISettingsPlugin } from '@jupyterlite/settings';
+export declare class FailsSettings implements ISettings {
+    static _overrides: Record<string, ISettingsPlugin['schema']['default']>;
+    static override(plugin: ISettingsPlugin): ISettingsPlugin;
+    constructor();
+    get ready(): Promise<void>;
+    initialize(): Promise<void>;
+    get(pluginId: string): Promise<ISettingsPlugin | undefined>;
+    getAll(): Promise<{
+        settings: ISettingsPlugin[];
+    }>;
+    private _getAll;
+    save(pluginId: string, raw: string): Promise<void>;
+    private _ready;
+}

package/lib/settings.js

@@ -0,0 +1,79 @@
+import { PageConfig, URLExt } from '@jupyterlab/coreutils';
+import { PromiseDelegate } from '@lumino/coreutils';
+import * as json5 from 'json5';
+// portions used from Jupyterlab:
+/* -----------------------------------------------------------------------------
+| Copyright (c) Jupyter Development Team.
+| Distributed under the terms of the Modified BSD License.
+|----------------------------------------------------------------------------*/
+// This code contains portions from or is inspired by Jupyter lab and lite
+class FailsSettings {
+    static override(plugin) {
+        if (FailsSettings._overrides[plugin.id]) {
+            if (!plugin.schema.properties) {
+                // probably malformed, or only provides keyboard shortcuts, etc.
+                plugin.schema.properties = {};
+            }
+            for (const [prop, propDefault] of Object.entries(FailsSettings._overrides[plugin.id] || {})) {
+                plugin.schema.properties[prop].default = propDefault;
+            }
+        }
+        return plugin;
+    }
+    constructor() {
+        this._ready = new PromiseDelegate();
+    }
+    get ready() {
+        return this._ready.promise;
+    }
+    async initialize() {
+        this._ready.resolve(void 0);
+    }
+    // copied from the original settings
+    async get(pluginId) {
+        const all = await this.getAll();
+        const settings = all.settings;
+        const setting = settings.find((setting) => {
+            return setting.id === pluginId;
+        });
+        return setting;
+    }
+    // copied from the original settings
+    async getAll() {
+        const allCore = await this._getAll('all.json');
+        let allFederated = [];
+        try {
+            allFederated = await this._getAll('all_federated.json');
+        }
+        catch (_a) {
+            // handle the case where there is no federated extension
+        }
+        // JupyterLab 4 expects all settings to be returned in one go
+        // so append the settings from federated plugins to the core ones
+        const all = allCore.concat(allFederated);
+        // return existing user settings if they exist
+        const settings = await Promise.all(all.map(async (plugin) => {
+            // const { id } = plugin;
+            const raw = /*((await storage.getItem(id)) as string) ?? */ plugin.raw;
+            return {
+                ...FailsSettings.override(plugin),
+                raw,
+                settings: json5.parse(raw)
+            };
+        }));
+        return { settings };
+    }
+    // one to one copy from settings of the original JupyterLite
+    async _getAll(file) {
+        var _a;
+        const settingsUrl = (_a = PageConfig.getOption('settingsUrl')) !== null && _a !== void 0 ? _a : '/';
+        const all = (await (await fetch(URLExt.join(settingsUrl, file))).json());
+        return all;
+    }
+    async save(pluginId, raw) {
+        // we do nothing
+    }
+}
+// the following is copied from the original Jupyter Lite Settings Object
+FailsSettings._overrides = JSON.parse(PageConfig.getOption('settingsOverrides') || '{}');
+export { FailsSettings };

package/package.json

@@ -0,0 +1,211 @@
+{
+    "name": "@fails-components/jupyter-filesystem-extension",
+    "version": "0.0.1-alpha.10",
+    "description": "A collection of extensions, that redirect's filesystems access to fails and let fails puppeteer Jupyter lite. ",
+    "keywords": [
+        "jupyter",
+        "jupyterlite",
+        "jupyterlite-extension"
+    ],
+    "homepage": "https://github.com/fails-components/jupyterfails",
+    "bugs": {
+        "url": "https://github.com/fails-components/jupyterfails/issues"
+    },
+    "license": "BSD-3-Clause",
+    "author": {
+        "name": "Marten Richter",
+        "email": "marten.richter@freenet.de"
+    },
+    "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}",
+        "schema/*.json",
+        "src/**/*.{ts,tsx}",
+        "LICENSE",
+        "README.md"
+    ],
+    "main": "lib/index.js",
+    "types": "lib/index.d.ts",
+    "style": "style/index.css",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/fails-components/jupyterfails.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 fails_components_jupyter_filesystem_extension/labextension fails_components_jupyter_filesystem_extension/_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",
+        "prepublishOnly": "npm run build",
+        "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\"",
+        "test": "jest --coverage --passWithNoTests",
+        "watch": "run-p watch:src watch:labextension",
+        "watch:src": "tsc -w --sourceMap",
+        "watch:labextension": "jupyter labextension watch ."
+    },
+    "dependencies": {
+        "@fails-components/jupyter-launcher": "^0.0.1-alpha.10",
+        "@jupyter-widgets/jupyterlab-manager": "^5.0.11",
+        "@jupyterlab/application": "^4.3.4",
+        "@jupyterlab/services": "^7.3.4",
+        "@jupyterlite/application-extension": "^0.5.0",
+        "@jupyterlite/contents": "^0.5.0",
+        "@jupyterlite/server": "^0.5.0",
+        "@jupyterlite/settings": "^0.5.0",
+        "@lumino/coreutils": "^2.2.0",
+        "json5": "^2.2.3"
+    },
+    "devDependencies": {
+        "@jupyterlab/builder": "^4.0.0",
+        "@jupyterlab/testutils": "^4.0.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",
+        "jest": "^29.2.0",
+        "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": {
+        "extension": true,
+        "outputDir": "fails_components_jupyter_filesystem_extension/labextension",
+        "schemaDir": "schema"
+    },
+    "jupyterlite": {
+        "liteExtension": true
+    },
+    "eslintIgnore": [
+        "node_modules",
+        "dist",
+        "coverage",
+        "**/*.d.ts",
+        "tests",
+        "**/__tests__",
+        "ui-tests"
+    ],
+    "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-class-pattern": "^([a-z][A-z\\d]*)(-[A-z\\d]+)*$",
+            "selector-no-vendor-prefix": null,
+            "value-no-vendor-prefix": null
+        }
+    }
+}

package/src/contents.ts

@@ -0,0 +1,218 @@
+import { Contents as ServerContents } from '@jupyterlab/services';
+import { IContents } from '@jupyterlite/contents';
+import { PromiseDelegate } from '@lumino/coreutils';
+import {
+  IFailsCallbacks,
+  IContentEventType,
+  ILoadJupyterContentEvent,
+  ISavedJupyterContentEvent
+} from '@fails-components/jupyter-launcher';
+
+// portions used from Jupyterlab:
+/* -----------------------------------------------------------------------------
+| Copyright (c) Jupyter Development Team.
+| Distributed under the terms of the Modified BSD License.
+|----------------------------------------------------------------------------*/
+// This code contains portions from or is inspired by Jupyter lab and lite
+
+const jsonMime = 'application/json';
+
+export class FailsContents implements IContents {
+  constructor() {
+    this._ready = new PromiseDelegate();
+    if (!(window as any).failsCallbacks) {
+      (window as any).failsCallbacks = {};
+    }
+    this._failsCallbacks = (window as any).failsCallbacks;
+    this._failsCallbacks.callContents = this.onMessage.bind(this);
+  }
+
+  async onMessage(event: IContentEventType): Promise<any> {
+    // todo handle events
+    switch (event.task) {
+      case 'loadFile':
+        {
+          const loadevent = event as ILoadJupyterContentEvent;
+          this._fileContent = JSON.stringify(
+            loadevent.fileData || FailsContents.EMPTY_NB
+          );
+          this._fileName = loadevent.fileName;
+        }
+        break;
+      case 'savedFile':
+        {
+          const savedevent = event as ISavedJupyterContentEvent;
+          if (this._fileName !== savedevent.fileName) {
+            return { error: 'Filename not found' };
+          }
+          return {
+            fileData: JSON.parse(this._fileContent)
+          };
+        }
+        break;
+    }
+  }
+
+  get ready(): Promise<void> {
+    return this._ready.promise;
+  }
+
+  async initialize() {
+    this._ready.resolve(void 0);
+  }
+
+  async get(
+    path: string,
+    options?: ServerContents.IFetchOptions
+  ): Promise<ServerContents.IModel | null> {
+    // remove leading slash
+    path = decodeURIComponent(path.replace(/^\//, ''));
+
+    const serverFile = {
+      name: this._fileName,
+      path: this._fileName,
+      last_modified: new Date(0).toISOString(),
+      created: new Date(0).toISOString(),
+      format: 'json' as ServerContents.FileFormat,
+      mimetype: jsonMime,
+      content: JSON.parse(this._fileContent),
+      size: 0,
+      writable: true,
+      type: 'notebook'
+    };
+
+    if (path === '') {
+      // the local directory, return the info about the proxy notebook
+      return {
+        name: '',
+        path,
+        last_modified: new Date(0).toISOString(),
+        created: new Date(0).toISOString(),
+        format: 'json',
+        mimetype: jsonMime,
+        content: [serverFile],
+        size: 0,
+        writable: true,
+        type: 'directory'
+      };
+    }
+    if (path === this._fileName) {
+      return serverFile;
+    }
+    return null; // not found
+  }
+
+  async save(
+    path: string,
+    options: Partial<ServerContents.IModel> = {}
+  ): Promise<ServerContents.IModel | null> {
+    path = decodeURIComponent(path);
+    if (path !== this._fileName) {
+      // we only allow the proxy object
+      return null;
+    }
+    const chunk = options.chunk;
+    const chunked = chunk ? chunk > 1 || chunk === -1 : false;
+
+    let item: ServerContents.IModel | null = await this.get(path, {
+      content: chunked
+    });
+
+    if (!item) {
+      return null;
+    }
+
+    const modified = new Date().toISOString();
+    // override with the new values
+    item = {
+      ...item,
+      ...options,
+      last_modified: modified
+    };
+
+    if (options.content && options.format === 'base64') {
+      const lastChunk = chunk ? chunk === -1 : true;
+
+      const modified = new Date().toISOString();
+      // override with the new values
+      item = {
+        ...item,
+        ...options,
+        last_modified: modified
+      };
+
+      const originalContent = item.content;
+      const escaped = decodeURIComponent(escape(atob(options.content)));
+      const newcontent = chunked ? originalContent + escaped : escaped;
+      item = {
+        ...item,
+        content: lastChunk ? JSON.parse(newcontent) : newcontent,
+        format: 'json',
+        type: 'notebook',
+        size: newcontent.length
+      };
+      this._fileContent = JSON.stringify(newcontent); // no parsing
+      return item;
+    }
+
+    this._fileContent = JSON.stringify(item.content); // no parsing
+    return item;
+  }
+
+  // For fails creating a new file is not allowed, so no need to implment it
+  async newUntitled(
+    options?: ServerContents.ICreateOptions
+  ): Promise<ServerContents.IModel | null> {
+    throw new Error('NewUntitled not implemented');
+  }
+
+  async rename(
+    oldLocalPath: string,
+    newLocalPath: string
+  ): Promise<ServerContents.IModel> {
+    throw new Error('rename not implemented');
+  }
+
+  async delete(path: string): Promise<void> {
+    throw new Error('delete not implemented');
+  }
+
+  async copy(path: string, toDir: string): Promise<ServerContents.IModel> {
+    throw new Error('copy not implemented');
+  }
+
+  async createCheckpoint(
+    path: string
+  ): Promise<ServerContents.ICheckpointModel> {
+    throw new Error('createCheckpoint not (yet?) implemented');
+  }
+
+  async listCheckpoints(
+    path: string
+  ): Promise<ServerContents.ICheckpointModel[]> {
+    // throw new Error('listCheckpoints not (yet?) implemented');
+    return [{ id: 'fakeCheckpoint', last_modified: new Date().toISOString() }];
+  }
+
+  async restoreCheckpoint(path: string, checkpointID: string): Promise<void> {
+    throw new Error('restoreCheckpoint not (yet?) implemented');
+  }
+
+  async deleteCheckpoint(path: string, checkpointID: string): Promise<void> {
+    throw new Error('deleteCheckpoint not (yet?) implemented');
+  }
+
+  static EMPTY_NB = {
+    metadata: {
+      orig_nbformat: 4
+    },
+    nbformat_minor: 5,
+    nbformat: 4,
+    cells: []
+  };
+
+  private _ready: PromiseDelegate<void>;
+  private _fileContent: string = JSON.stringify(FailsContents.EMPTY_NB);
+  private _fileName: string = 'unloaded.ipynb';
+  private _failsCallbacks: IFailsCallbacks;
+}

package/src/index.ts

@@ -0,0 +1,45 @@
+import { IContents } from '@jupyterlite/contents';
+import {
+  JupyterLiteServerPlugin,
+  JupyterLiteServer
+} from '@jupyterlite/server';
+import { ISettings } from '@jupyterlite/settings';
+import { FailsContents } from './contents';
+import { FailsSettings } from './settings';
+
+export const failsContentsPlugin: JupyterLiteServerPlugin<IContents> = {
+  id: '@fails-components/jupyter-fails-server:contents',
+  requires: [],
+  autoStart: true,
+  provides: IContents,
+  activate: (app: JupyterLiteServer) => {
+    if (app.namespace !== 'JupyterLite Server') {
+      console.log('Not on server');
+    }
+    const contents = new FailsContents();
+    app.started.then(() => contents.initialize().catch(console.warn));
+    return contents;
+  }
+};
+
+const failsSettingsPlugin: JupyterLiteServerPlugin<ISettings> = {
+  id: '@fails-components/jupyter-fails-server:settings',
+  requires: [],
+  autoStart: true,
+  provides: ISettings,
+  activate: (app: JupyterLiteServer) => {
+    if (app.namespace !== 'JupyterLite Server') {
+      console.log('Not on server');
+    }
+    const settings = new FailsSettings();
+    app.started.then(() => settings.initialize().catch(console.warn));
+    return settings;
+  }
+};
+
+const plugins: JupyterLiteServerPlugin<any>[] = [
+  failsContentsPlugin,
+  failsSettingsPlugin
+];
+
+export default plugins;

package/src/settings.ts

@@ -0,0 +1,100 @@
+import { PageConfig, URLExt } from '@jupyterlab/coreutils';
+import { ISettings, IPlugin as ISettingsPlugin } from '@jupyterlite/settings';
+import { PromiseDelegate } from '@lumino/coreutils';
+import * as json5 from 'json5';
+
+// portions used from Jupyterlab:
+/* -----------------------------------------------------------------------------
+| Copyright (c) Jupyter Development Team.
+| Distributed under the terms of the Modified BSD License.
+|----------------------------------------------------------------------------*/
+// This code contains portions from or is inspired by Jupyter lab and lite
+
+export class FailsSettings implements ISettings {
+  // the following is copied from the original Jupyter Lite Settings Object
+  static _overrides: Record<string, ISettingsPlugin['schema']['default']> =
+    JSON.parse(PageConfig.getOption('settingsOverrides') || '{}');
+
+  static override(plugin: ISettingsPlugin): ISettingsPlugin {
+    if (FailsSettings._overrides[plugin.id]) {
+      if (!plugin.schema.properties) {
+        // probably malformed, or only provides keyboard shortcuts, etc.
+        plugin.schema.properties = {};
+      }
+      for (const [prop, propDefault] of Object.entries(
+        FailsSettings._overrides[plugin.id] || {}
+      )) {
+        plugin.schema.properties[prop].default = propDefault;
+      }
+    }
+    return plugin;
+  }
+
+  constructor() {
+    this._ready = new PromiseDelegate();
+  }
+
+  get ready(): Promise<void> {
+    return this._ready.promise;
+  }
+
+  async initialize() {
+    this._ready.resolve(void 0);
+  }
+
+  // copied from the original settings
+  async get(pluginId: string): Promise<ISettingsPlugin | undefined> {
+    const all = await this.getAll();
+    const settings = all.settings as ISettingsPlugin[];
+    const setting = settings.find((setting: ISettingsPlugin) => {
+      return setting.id === pluginId;
+    });
+    return setting;
+  }
+
+  // copied from the original settings
+  async getAll(): Promise<{ settings: ISettingsPlugin[] }> {
+    const allCore = await this._getAll('all.json');
+    let allFederated: ISettingsPlugin[] = [];
+    try {
+      allFederated = await this._getAll('all_federated.json');
+    } catch {
+      // handle the case where there is no federated extension
+    }
+
+    // JupyterLab 4 expects all settings to be returned in one go
+    // so append the settings from federated plugins to the core ones
+    const all = allCore.concat(allFederated);
+
+    // return existing user settings if they exist
+    const settings = await Promise.all(
+      all.map(async plugin => {
+        // const { id } = plugin;
+        const raw = /*((await storage.getItem(id)) as string) ?? */ plugin.raw;
+        return {
+          ...FailsSettings.override(plugin),
+          raw,
+          settings: json5.parse(raw)
+        };
+      })
+    );
+    return { settings };
+  }
+
+  // one to one copy from settings of the original JupyterLite
+  private async _getAll(
+    file: 'all.json' | 'all_federated.json'
+  ): Promise<ISettingsPlugin[]> {
+    const settingsUrl = PageConfig.getOption('settingsUrl') ?? '/';
+    const all = (await (
+      await fetch(URLExt.join(settingsUrl, file))
+    ).json()) as ISettingsPlugin[];
+    return all;
+  }
+
+  async save(pluginId: string, raw: string): Promise<void> {
+    // we do nothing
+  }
+
+  private _ready: PromiseDelegate<void>;
+}

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,2 @@
+import './base.css';
+import './index.css';