@jupyterlite/xeus 2.1.2 → 3.0.0-a0

package/lib/index.d.ts

@@ -1,5 +1,5 @@
-import { JupyterLiteServerPlugin } from '@jupyterlite/server';
-import { IEmpackEnvMetaFile } from './tokens';
-declare const plugins: JupyterLiteServerPlugin<void | IEmpackEnvMetaFile>[];
-export default plugins;
-export { IEmpackEnvMetaFile };
+export * from './coincident.worker';
+export * from './comlink.worker';
+export * from './interfaces';
+export * from './web_worker_kernel';
+export * from './worker';

package/lib/index.js

@@ -1,86 +1,5 @@
-// Copyright (c) Thorsten Beier
-// Copyright (c) JupyterLite Contributors
-// Distributed under the terms of the Modified BSD License.
-import { PageConfig, URLExt } from '@jupyterlab/coreutils';
-import { IServiceWorkerManager } from '@jupyterlite/server';
-import { IBroadcastChannelWrapper } from '@jupyterlite/contents';
-import { IKernelSpecs } from '@jupyterlite/kernel';
-import { WebWorkerKernel } from './web_worker_kernel';
-import { IEmpackEnvMetaFile } from './tokens';
-function getJson(url) {
-    const json_url = URLExt.join(PageConfig.getBaseUrl(), url);
-    const xhr = new XMLHttpRequest();
-    xhr.open('GET', json_url, false);
-    xhr.send(null);
-    return JSON.parse(xhr.responseText);
-}
-let kernel_list = [];
-try {
-    kernel_list = getJson('xeus/kernels.json');
-}
-catch (err) {
-    console.log(`Could not fetch xeus/kernels.json: ${err}`);
-    throw err;
-}
-const plugins = kernel_list.map((kernel) => {
-    return {
-        id: `@jupyterlite/xeus-${kernel}:register`,
-        autoStart: true,
-        requires: [IKernelSpecs],
-        optional: [
-            IServiceWorkerManager,
-            IBroadcastChannelWrapper,
-            IEmpackEnvMetaFile
-        ],
-        activate: (app, kernelspecs, serviceWorker, broadcastChannel, empackEnvMetaFile) => {
-            // Fetch kernel spec
-            const kernelspec = getJson('xeus/kernels/' + kernel + '/kernel.json');
-            kernelspec.name = kernel;
-            kernelspec.dir = kernel;
-            for (const [key, value] of Object.entries(kernelspec.resources)) {
-                kernelspec.resources[key] = URLExt.join(PageConfig.getBaseUrl(), value);
-            }
-            const contentsManager = app.serviceManager.contents;
-            kernelspecs.register({
-                spec: kernelspec,
-                create: async (options) => {
-                    const mountDrive = !!(((serviceWorker === null || serviceWorker === void 0 ? void 0 : serviceWorker.enabled) && (broadcastChannel === null || broadcastChannel === void 0 ? void 0 : broadcastChannel.enabled)) ||
-                        crossOriginIsolated);
-                    if (mountDrive) {
-                        console.info(`${kernelspec.name} contents will be synced with Jupyter Contents`);
-                    }
-                    else {
-                        console.warn(`${kernelspec.name} contents will NOT be synced with Jupyter Contents`);
-                    }
-                    const link = empackEnvMetaFile
-                        ? await empackEnvMetaFile.getLink(kernelspec)
-                        : '';
-                    return new WebWorkerKernel({
-                        ...options,
-                        contentsManager,
-                        mountDrive,
-                        kernelSpec: kernelspec,
-                        empackEnvMetaLink: link
-                    });
-                }
-            });
-        }
-    };
-});
-const empackEnvMetaPlugin = {
-    id: '@jupyterlite/xeus:empack-env-meta',
-    autoStart: true,
-    provides: IEmpackEnvMetaFile,
-    activate: () => {
-        return {
-            getLink: async (kernelspec) => {
-                const kernelName = kernelspec.name;
-                const kernel_root_url = URLExt.join(PageConfig.getBaseUrl(), `xeus/kernels/${kernelName}`);
-                return `${kernel_root_url}`;
-            }
-        };
-    }
-};
-plugins.push(empackEnvMetaPlugin);
-export default plugins;
-export { IEmpackEnvMetaFile };
+export * from './coincident.worker';
+export * from './comlink.worker';
+export * from './interfaces';
+export * from './web_worker_kernel';
+export * from './worker';

package/lib/{tokens.d.ts → interfaces.d.ts}

@@ -3,7 +3,6 @@
  */
 import { TDriveMethod, TDriveRequest, TDriveResponse } from '@jupyterlite/contents';
 import { IWorkerKernel } from '@jupyterlite/kernel';
-import { Token } from '@lumino/coreutils';
 /**
  * An interface for Xeus workers.
  */
@@ -68,10 +67,3 @@ export declare namespace IXeusWorkerKernel {
         empackEnvMetaLink?: string;
     }
 }
-export interface IEmpackEnvMetaFile {
-    /**
-     * Get empack_env_meta link.
-     */
-    getLink: (kernelspec: Record<string, any>) => Promise<string>;
-}
-export declare const IEmpackEnvMetaFile: Token<IEmpackEnvMetaFile>;

package/lib/interfaces.js

@@ -0,0 +1,3 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
+export {};

package/lib/web_worker_kernel.d.ts

@@ -2,7 +2,7 @@ import type { Remote } from 'comlink';
 import { ISignal } from '@lumino/signaling';
 import { Contents, KernelMessage } from '@jupyterlab/services';
 import { IKernel } from '@jupyterlite/kernel';
-import { IXeusWorkerKernel } from './tokens';
+import { IXeusWorkerKernel } from './interfaces';
 export declare class WebWorkerKernel implements IKernel {
     /**
      * Instantiate a new WebWorkerKernel

package/lib/worker.d.ts

@@ -1,5 +1,4 @@
-import type { DriveFS } from '@jupyterlite/contents';
-import { IXeusWorkerKernel } from './tokens';
+import { IXeusWorkerKernel } from './interfaces';
 export declare class XeusRemoteKernel {
     constructor(options?: XeusRemoteKernel.IOptions);
     ready(): Promise<void>;
@@ -12,8 +11,6 @@ export declare class XeusRemoteKernel {
      * @param callback the callback to register
      */
     registerCallback(callback: (msg: any) => void): void;
-    protected _driveName: string;
-    protected _driveFS: DriveFS | null;
     protected _sendWorkerMessage: (msg: any) => void;
 }
 export declare namespace XeusRemoteKernel {

package/lib/worker.js

@@ -44,8 +44,6 @@ globalThis.ready = new Promise(resolve => {
 });
 export class XeusRemoteKernel {
     constructor(options = {}) {
-        this._driveName = '';
-        this._driveFS = null;
         this._sendWorkerMessage = () => { };
     }
     async ready() {

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@jupyterlite/xeus",
-    "version": "2.1.2",
-    "description": "JupyterLite loader for Xeus kernels",
+    "version": "3.0.0-a0",
+    "description": "JupyterLite Xeus kernels",
     "keywords": [
         "jupyter",
         "jupyterlab",
@@ -14,43 +14,26 @@
     "license": "BSD-3-Clause",
     "author": "JupyterLite Contributors",
     "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}"
+        "lib/**/*.{d.ts,eot,gif,html,jpg,js,js.map,json,png,svg,woff2,ttf}"
     ],
     "main": "lib/index.js",
     "types": "lib/index.d.ts",
-    "style": "style/index.css",
     "repository": {
         "type": "git",
         "url": "https://github.com/jupyterlite/xeus.git"
     },
     "scripts": {
-        "build": "jlpm build:lib && jlpm build:worker && jlpm build:labextension:dev",
-        "build:prod": "jlpm clean && jlpm build:lib:prod && jlpm build:worker:prod  && jlpm build:labextension",
+        "build": "jlpm build:lib && jlpm build:worker",
+        "build:prod": "jlpm clean && jlpm build:lib:prod && jlpm build:worker:prod",
         "build:worker": "webpack --config worker.webpack.config.js --mode=development",
         "build:worker:prod": "webpack --config worker.webpack.config.js --mode=production",
-        "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 jupyterlite_xeus/labextension jupyterlite_xeus/_version.py",
-        "clean:all": "jlpm clean:lib && jlpm clean:labextension && jlpm clean:lintcache",
-        "eslint": "jlpm eslint:check --fix",
-        "eslint:check": "eslint . --cache --ext .ts,.tsx",
-        "install:extension": "jlpm build",
-        "lint": "jlpm stylelint && jlpm prettier && jlpm eslint",
-        "lint:check": "jlpm stylelint:check && jlpm prettier:check && jlpm eslint:check",
-        "prettier": "jlpm prettier:base --write --list-different",
-        "prettier:base": "prettier \"**/*{.ts,.tsx,.js,.jsx,.css,.json,.md}\"",
-        "prettier:check": "jlpm prettier:base --check",
-        "stylelint": "jlpm stylelint:check --fix",
-        "stylelint:check": "stylelint --cache \"style/**/*.css\"",
-        "watch": "run-p watch:src watch:labextension",
-        "watch:src": "tsc -w --sourceMap",
-        "watch:labextension": "jupyter labextension watch ."
+        "clean:all": "jlpm clean:lib",
+        "watch": "run-p watch:src",
+        "watch:src": "tsc -w --sourceMap"
     },
     "dependencies": {
         "@jupyterlab/coreutils": "^6",
@@ -68,148 +51,15 @@
         "@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",
         "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",
         "ts-loader": "^9.2.6",
         "typescript": "~5.0.2",
         "webpack": "^5.87.0",
         "yjs": "^13.5.0"
     },
-    "sideEffects": [
-        "style/*.css",
-        "style/index.js"
-    ],
-    "styleModule": "style/index.js",
     "publishConfig": {
         "access": "public"
-    },
-    "jupyterlab": {
-        "extension": true,
-        "outputDir": "jupyterlite_xeus/labextension",
-        "sharedPackages": {
-            "@jupyterlite/kernel": {
-                "bundled": false,
-                "singleton": true
-            },
-            "@jupyterlite/server": {
-                "bundled": false,
-                "singleton": true
-            },
-            "@jupyterlite/contents": {
-                "bundled": false,
-                "singleton": true
-            }
-        }
-    },
-    "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/LICENSE

@@ -1,29 +0,0 @@
-BSD 3-Clause License
-
-Copyright (c) 2023, JupyterLite Contributors
-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

@@ -1,184 +0,0 @@
-# JupyterLite Xeus
-
-[![Github Actions Status](https://github.com/jupyterlite/xeus/workflows/Build/badge.svg)](https://github.com/jupyterlite/xeus/actions/workflows/build.yml)
-
-JupyterLite loader for Xeus kernels
-
-## Requirements
-
-- JupyterLab >= 4.0.0
-
-## Install
-
-To install the extension, execute:
-
-```bash
-pip install jupyterlite_xeus
-```
-
-## Usage
-
-### From environment.yml
-
-#### xeus-python kernel
-
-To load a `xeus-python` kernel with a custom environment, create an `environment.yml` file with `xeus-python` and the desired dependencies. Here is an example with `numpy` as a additional dependency:
-
-```yaml
-name: xeus-lite-wasm
-channels:
-  - https://repo.mamba.pm/emscripten-forge
-  - conda-forge
-dependencies:
-  - xeus-python
-  - numpy
-```
-
-To build JupyterLite, run the following command where `environment.yml` is the path to the file you just created
-
-```bash
-jupyter lite build --XeusAddon.environment_file=some_path/to/environment.yml
-```
-
-#### xeus-lua / xeus-sqlite / xeus-\<mylang\>
-
-To load a `xeus-lua` or `xeus-sqlite` kernel you can
-do the same as above, just with
-
-```yaml
-dependencies:
-  - xeus-lua
-```
-
-or
-
-```yaml
-dependencies:
-  - xeus-sqlite
-```
-
-Note that `xeus-sqlite` and `xeus-lua` do not support additional dependencies yet.
-To build JupyterLite, run again:
-
-```bash
-jupyter lite build --XeusAddon.environment_file=environment.yml
-```
-
-#### Multiple kernels
-
-To create a deployment with multiple kernels, you can simply add them to the `environment.yml` file:
-
-```yaml
-name: xeus-lite-wasm
-channels:
-  - https://repo.mamba.pm/emscripten-forge
-  - conda-forge
-dependencies:
-  - xeus-python
-  - xeus-lua
-  - xeus-sqlite
-  - numpy
-```
-
-### From local environment / prefix
-
-When developing a xeus-kernel, it is very useful to be able to test it in JupyterLite without having to publish the kernel to emscripten-forge. Therefore, you can also use a local environment / prefix to build JupyterLite with a custom kernel.
-
-#### Create a local environment / prefix
-
-This workflow usually starts with creating a local conda environment / prefix for the `emscripten-wasm32` platform with all the dependencies required to build your kernel (here we install dependencies for `xeus-python`).
-
-```bash
-micromamba create -n xeus-python-dev \
-    --platform=emscripten-wasm32 \
-    -c https://repo.mamba.pm/emscripten-forge \
-    -c conda-forge \
-    --yes \
-    "python>=3.11" pybind11 nlohmann_json pybind11_json numpy pytest \
-    bzip2 sqlite zlib libffi xtl pyjs \
-    xeus xeus-lite
-```
-
-#### Build the kernel
-
-This depends on your kernel, but it will look something like this:
-
-```bash
-# path to your emscripten emsdk
-source $EMSDK_DIR/emsdk_env.sh
-
-WASM_ENV_NAME=xeus-python-dev
-WASM_ENV_PREFIX=$MAMBA_ROOT_PREFIX/envs/$WASM_ENV_NAME
-
-# let cmake know where the env is
-export PREFIX=$WASM_ENV_PREFIX
-export CMAKE_PREFIX_PATH=$PREFIX
-export CMAKE_SYSTEM_PREFIX_PATH=$PREFIX
-
-cd /path/to/your/kernel/src
-mkdir build_wasm
-cd build_wasm
-emcmake cmake \
-    -DCMAKE_BUILD_TYPE=Release \
-    -DCMAKE_FIND_ROOT_PATH_MODE_PACKAGE=ON \
-    -DCMAKE_INSTALL_PREFIX=$PREFIX \
-    ..
-emmake make -j8 install
-```
-
-#### Build the JupyterLite site
-
-You will need to create a new environment with the dependencies to build the JupyterLite site.
-
-```bash
-# create new environment
-micromamba create -n xeus-lite-host \
-    jupyterlite-core
-
-# activate the environment
-micromamba activate xeus-lite-host
-
-# install jupyterlite_xeus via pip
-python -m pip install jupyterlite-xeus
-```
-
-When running `jupyter lite build`, we pass the `prefix` option and point it to the local environment / prefix we just created:
-
-```bash
-jupyter lite build --XeusAddon.prefix=$WASM_ENV_PREFIX
-```
-
-### Mounting additional files
-
-To copy additional files and directories into the virtual filesystem of the xeus-lite kernels you can use the `--XeusAddon.mount` option.
-Each mount is specified as a pair of paths separated by a colon `:`. The first path is the path to the file or directory on the host machine, the second path is the path to the file or directory in the virtual filesystem of the kernel.
-
-```bash
-jupyter lite build \
-    --XeusAddon.environment_file=environment.yml \
-    --XeusAddon.mounts=/some/path/on/host_machine:/some/path/in/virtual/filesystem
-```
-
-## Contributing
-
-### Development install from a conda / mamba environment
-
-Create the conda environment with `conda`/`mamba`/`micromamba` (replace `micromamba` with `conda` or `mamba` according to your preference):
-
-```bash
-micromamba create -f environment-dev.yml -n xeus-lite-dev
-```
-
-Activate the environment:
-
-```bash
-micromamba activate xeus-lite-dev
-```
-
-```bash
-python -m pip install -e .   -v --no-build-isolation
-```
-
-### Packaging the extension
-
-See [RELEASE](RELEASE.md).

package/lib/tokens.js

@@ -1,4 +0,0 @@
-// Copyright (c) Jupyter Development Team.
-// Distributed under the terms of the Modified BSD License.
-import { Token } from '@lumino/coreutils';
-export const IEmpackEnvMetaFile = new Token('@jupyterlite/xeus:IEmpackEnvMetaFile');

package/style/base.css

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

package/style/index.css

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

package/style/index.js

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