@fails-components/jupyter-launcher 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,101 @@
+# fails_components_jupyter_launcher
+
+[![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, where jupyter can be steering inside an iframe.
+You can load, launch and save different notebooks and applets (created with applet-view extension).
+
+## Requirements
+
+- JupyterLab >= 4.0.0
+
+## Install
+
+To install the extension, execute:
+
+```bash
+pip install fails_components_jupyter_launcher
+```
+
+## Uninstall
+
+To remove the extension, execute:
+
+```bash
+pip uninstall fails_components_jupyter_launcher
+```
+
+## 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_launcher 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_launcher
+```
+
+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/index.d.ts

@@ -0,0 +1,139 @@
+import { JupyterFrontEndPlugin } from '@jupyterlab/application';
+import { JSONObject, PartialJSONObject, Token } from '@lumino/coreutils';
+import { ISignal } from '@lumino/signaling';
+export interface IScreenShotOpts {
+    dpi: number;
+}
+export interface IAppletScreenshottaker {
+    takeAppScreenshot: (opts: IScreenShotOpts) => Promise<Blob | undefined>;
+}
+interface IContentEvent {
+    task: string;
+}
+export interface ILoadJupyterContentEvent extends IContentEvent {
+    task: 'loadFile';
+    fileData: object | undefined;
+    fileName: string;
+}
+export interface ISavedJupyterContentEvent extends IContentEvent {
+    task: 'savedFile';
+    fileName: string;
+}
+export type IContentEventType = ILoadJupyterContentEvent | ISavedJupyterContentEvent;
+export interface IFailsCallbacks {
+    callContents?: (event: IContentEventType) => Promise<any>;
+    postMessageToFails?: (message: any, transfer?: Transferable[]) => void;
+}
+export declare const IFailsLauncherInfo: Token<IFailsLauncherInfo>;
+export interface IFailsLauncherInit {
+    inLecture: boolean;
+    selectedAppid: string | undefined;
+    reportMetadata?: (metadata: PartialJSONObject) => void;
+}
+export interface IFailsAppletSize {
+    appid: string;
+    width: number;
+    height: number;
+}
+export interface IAppletWidgetRegistry {
+}
+export interface IFailsInterceptorUpdateMessage {
+    path: string;
+    mime: string;
+    state: JSONObject;
+}
+export interface IFailsLauncherInfo extends IFailsLauncherInit {
+    inLectureChanged: ISignal<IFailsLauncherInfo, boolean>;
+    selectedAppidChanged: ISignal<this, string | undefined>;
+    appletSizes: {
+        [key: string]: IFailsAppletSize;
+    };
+    appletSizesChanged: ISignal<this, {
+        [key: string]: IFailsAppletSize;
+    }>;
+    updateMessageArrived?: ISignal<IAppletWidgetRegistry, IFailsInterceptorUpdateMessage>;
+    remoteUpdateMessageArrived: ISignal<IFailsLauncherInfo, IFailsInterceptorUpdateMessage>;
+}
+export interface IReplyJupyter {
+    requestId?: number;
+}
+export interface IGDPRProxyInfo {
+    allowedSites?: string[] | undefined;
+    proxySites?: string[] | undefined;
+    proxyURL: string;
+}
+export interface ILoadJupyterInfo {
+    type: 'loadJupyter';
+    inLecture: boolean;
+    rerunAtStartup: boolean;
+    installScreenShotPatches: boolean;
+    installGDPRProxy?: IGDPRProxyInfo;
+    appid?: string;
+    fileName: string;
+    fileData: object | undefined;
+    kernelName: 'python' | 'xpython' | undefined;
+}
+export interface ISaveJupyter {
+    type: 'saveJupyter';
+    fileName: string;
+}
+export interface IActivateApp {
+    type: 'activateApp';
+    inLecture: boolean;
+    appid?: string;
+}
+export interface IScreenshotApp extends IScreenShotOpts {
+    type: 'screenshotApp';
+}
+export interface IActivateInterceptor {
+    type: 'activateInterceptor';
+    activate: boolean;
+}
+export interface IGetLicenses {
+    type: 'getLicenses';
+}
+export interface IRestartKernelAndRerunCells {
+    type: 'restartKernelAndRerunCells';
+}
+export interface IInterceptorUpdate {
+    path: string;
+    mime: string;
+    state: JSONObject;
+}
+export interface IReceiveInterceptorUpdate extends IInterceptorUpdate {
+    type: 'receiveInterceptorUpdate';
+}
+export type IFailsToJupyterMessage = IActivateApp | IActivateInterceptor | IGetLicenses | IReceiveInterceptorUpdate | IRestartKernelAndRerunCells | ILoadJupyterInfo | IScreenshotApp | ISaveJupyter;
+export interface IAppLoaded {
+    task: 'appLoaded';
+}
+export interface IDocDirty {
+    task: 'docDirty';
+    dirty: boolean;
+}
+export interface IReportMetadata {
+    task: 'reportMetadata';
+    metadata: {
+        failsApp?: JSONObject;
+        kernelspec?: JSONObject;
+    };
+}
+export interface IReportFailsAppletSizes {
+    task: 'reportFailsAppletSizes';
+    appletSizes: {
+        [key: string]: IFailsAppletSize;
+    };
+}
+export interface IReportKernelStatus {
+    task: 'reportKernelStatus';
+    status: string;
+}
+export interface ISendInterceptorUpdate extends IInterceptorUpdate {
+    task: 'sendInterceptorUpdate';
+}
+export type IJupyterToFailsMessage = IReportMetadata | IReportFailsAppletSizes | ISendInterceptorUpdate | IReportKernelStatus | IAppLoaded | IDocDirty;
+/**
+ * Initialization data for the @fails-components/jupyter-launcher extension.
+ */
+declare const plugins: JupyterFrontEndPlugin<any>[];
+export default plugins;