@datalayer/jupyter-react 1.1.9 → 1.2.0

package/lib/jupyter/lite/contents/tokens.d.ts

@@ -0,0 +1,136 @@
+import { IDisposable } from '@lumino/disposable';
+import { Contents as ServerContents } from '@jupyterlab/services';
+import { Token } from '@lumino/coreutils';
+/**
+ * The token for the settings service.
+ */
+export declare const IContents: Token<IContents>;
+/**
+ * The interface for the contents service.
+ */
+export interface IContents {
+    /**
+     * A promise that resolves after the contents have been full initialized.
+     */
+    ready: Promise<void>;
+    /**
+     * Create a new untitled file or directory in the specified directory path.
+     *
+     * @param options: The options used to create the file.
+     *
+     * @returns A promise which resolves with the created file content when the file is created.
+     */
+    newUntitled(options?: ServerContents.ICreateOptions): Promise<ServerContents.IModel | null>;
+    /**
+     * Copy a file into a given directory.
+     *
+     * @param path - The original file path.
+     * @param toDir - The destination directory path.
+     *
+     * @returns A promise which resolves with the new contents model when the
+     *  file is copied.
+     *
+     * #### Notes
+     * The server will select the name of the copied file.
+     */
+    copy(path: string, toDir: string): Promise<ServerContents.IModel>;
+    /**
+     * Get a file or directory.
+     *
+     * @param path: The path to the file.
+     * @param options: The options used to fetch the file.
+     *
+     * @returns A promise which resolves with the file content.
+     */
+    get(path: string, options?: ServerContents.IFetchOptions): Promise<ServerContents.IModel | null>;
+    /**
+     * Rename a file or directory.
+     *
+     * @param oldLocalPath - The original file path.
+     * @param newLocalPath - The new file path.
+     *
+     * @returns A promise which resolves with the new file content model when the file is renamed.
+     */
+    rename(oldLocalPath: string, newLocalPath: string): Promise<ServerContents.IModel>;
+    /**
+     * Save a file.
+     *
+     * @param path - The desired file path.
+     * @param options - Optional overrides to the model.
+     *
+     * @returns A promise which resolves with the file content model when the file is saved.
+     */
+    save(path: string, options?: Partial<ServerContents.IModel>): Promise<ServerContents.IModel | null>;
+    /**
+     * Delete a file.
+     *
+     * @param path - The path to the file.
+     */
+    delete(path: string): Promise<void>;
+    /**
+     * Create a checkpoint for a file.
+     *
+     * @param path - The path of the file.
+     *
+     * @returns A promise which resolves with the new checkpoint model when the
+     *   checkpoint is created.
+     */
+    createCheckpoint(path: string): Promise<ServerContents.ICheckpointModel>;
+    /**
+     * List available checkpoints for a file.
+     *
+     * @param path - The path of the file.
+     *
+     * @returns A promise which resolves with a list of checkpoint models for
+     *    the file.
+     */
+    listCheckpoints(path: string): Promise<ServerContents.ICheckpointModel[]>;
+    /**
+     * Restore a file to a known checkpoint state.
+     *
+     * @param path - The path of the file.
+     * @param checkpointID - The id of the checkpoint to restore.
+     *
+     * @returns A promise which resolves when the checkpoint is restored.
+     */
+    restoreCheckpoint(path: string, checkpointID: string): Promise<void>;
+    /**
+     * Delete a checkpoint for a file.
+     *
+     * @param path - The path of the file.
+     * @param checkpointID - The id of the checkpoint to delete.
+     *
+     * @returns A promise which resolves when the checkpoint is deleted.
+     */
+    deleteCheckpoint(path: string, checkpointID: string): Promise<void>;
+}
+/**
+ * Commonly-used mimetypes
+ */
+export declare namespace MIME {
+    const JSON = "application/json";
+    const PLAIN_TEXT = "text/plain";
+    const OCTET_STREAM = "octet/stream";
+}
+/**
+ * A namespace for file constructs.
+ */
+export declare namespace FILE {
+    /**
+     * Get a mimetype (or fallback).
+     */
+    function getType(ext: string, defaultType?: string | null): string;
+    /**
+     * Determine whether the given extension matches a given fileFormat.
+     */
+    function hasFormat(ext: string, fileFormat: 'base64' | 'text' | 'json'): boolean;
+}
+/**
+ * The token for the BroadcastChannel broadcaster.
+ */
+export declare const IBroadcastChannelWrapper: Token<IBroadcastChannelWrapper>;
+export interface IBroadcastChannelWrapper extends IDisposable {
+    enable(): void;
+    disable(): void;
+    enabled: boolean;
+}

package/lib/jupyter/lite/contents/tokens.js

@@ -0,0 +1,66 @@
+import { PageConfig } from '@jupyterlab/coreutils';
+import { Token } from '@lumino/coreutils';
+import mime from 'mime';
+/**
+ * The token for the settings service.
+ */
+export const IContents = new Token('@jupyterlite/contents:IContents');
+/**
+ * Commonly-used mimetypes
+ */
+export var MIME;
+(function (MIME) {
+    MIME.JSON = 'application/json';
+    MIME.PLAIN_TEXT = 'text/plain';
+    MIME.OCTET_STREAM = 'octet/stream';
+})(MIME || (MIME = {}));
+/**
+ * A namespace for file constructs.
+ */
+export var FILE;
+(function (FILE) {
+    /**
+     * Build-time configured file types.
+     */
+    const TYPES = JSON.parse(PageConfig.getOption('fileTypes') || '{}');
+    /**
+     * Get a mimetype (or fallback).
+     */
+    function getType(ext, defaultType = null) {
+        ext = ext.toLowerCase();
+        for (const fileType of Object.values(TYPES)) {
+            for (const fileExt of fileType.extensions || []) {
+                if (fileExt === ext &&
+                    fileType.mimeTypes &&
+                    fileType.mimeTypes.length) {
+                    return fileType.mimeTypes[0];
+                }
+            }
+        }
+        return mime.getType(ext) || defaultType || MIME.OCTET_STREAM;
+    }
+    FILE.getType = getType;
+    /**
+     * Determine whether the given extension matches a given fileFormat.
+     */
+    function hasFormat(ext, fileFormat) {
+        ext = ext.toLowerCase();
+        for (const fileType of Object.values(TYPES)) {
+            if (fileType.fileFormat !== fileFormat) {
+                continue;
+            }
+            for (const fileExt of fileType.extensions || []) {
+                if (fileExt === ext) {
+                    return true;
+                }
+            }
+        }
+        return false;
+    }
+    FILE.hasFormat = hasFormat;
+})(FILE || (FILE = {}));
+/**
+ * The token for the BroadcastChannel broadcaster.
+ */
+export const IBroadcastChannelWrapper = new Token('@jupyterlite/contents:IBroadcastChannelWrapper');
+//# sourceMappingURL=tokens.js.map

package/lib/jupyter/lite/contents/tokens.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tokens.js","sourceRoot":"","sources":["../../../../src/jupyter/lite/contents/tokens.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAEnD,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAC1C,OAAO,IAAI,MAAM,MAAM,CAAC;AAExB;;GAEG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,IAAI,KAAK,CAChC,iCAAiC,CAClC,CAAC;AA2HF;;GAEG;AACH,MAAM,KAAW,IAAI,CAIpB;AAJD,WAAiB,IAAI;IACN,SAAI,GAAG,kBAAkB,CAAC;IAC1B,eAAU,GAAG,YAAY,CAAC;IAC1B,iBAAY,GAAG,cAAc,CAAC;AAC7C,CAAC,EAJgB,IAAI,KAAJ,IAAI,QAIpB;AAED;;GAEG;AACH,MAAM,KAAW,IAAI,CAmDpB;AAnDD,WAAiB,IAAI;IACnB;;OAEG;IACH,MAAM,KAAK,GAAmD,IAAI,CAAC,KAAK,CACtE,UAAU,CAAC,SAAS,CAAC,WAAW,CAAC,IAAI,IAAI,CAC1C,CAAC;IAEF;;OAEG;IACH,SAAgB,OAAO,CACrB,GAAW,EACX,cAA6B,IAAI;QAEjC,GAAG,GAAG,GAAG,CAAC,WAAW,EAAE,CAAC;QACxB,KAAK,MAAM,QAAQ,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;YAC5C,KAAK,MAAM,OAAO,IAAI,QAAQ,CAAC,UAAU,IAAI,EAAE,EAAE,CAAC;gBAChD,IACE,OAAO,KAAK,GAAG;oBACf,QAAQ,CAAC,SAAS;oBAClB,QAAQ,CAAC,SAAS,CAAC,MAAM,EACzB,CAAC;oBACD,OAAO,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;gBAC/B,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,WAAW,IAAI,IAAI,CAAC,YAAY,CAAC;IAC/D,CAAC;IAlBe,YAAO,UAkBtB,CAAA;IAED;;OAEG;IACH,SAAgB,SAAS,CACvB,GAAW,EACX,UAAsC;QAEtC,GAAG,GAAG,GAAG,CAAC,WAAW,EAAE,CAAC;QACxB,KAAK,MAAM,QAAQ,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;YAC5C,IAAI,QAAQ,CAAC,UAAU,KAAK,UAAU,EAAE,CAAC;gBACvC,SAAS;YACX,CAAC;YACD,KAAK,MAAM,OAAO,IAAI,QAAQ,CAAC,UAAU,IAAI,EAAE,EAAE,CAAC;gBAChD,IAAI,OAAO,KAAK,GAAG,EAAE,CAAC;oBACpB,OAAO,IAAI,CAAC;gBACd,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAhBe,cAAS,YAgBxB,CAAA;AACH,CAAC,EAnDgB,IAAI,KAAJ,IAAI,QAmDpB;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,IAAI,KAAK,CAC/C,gDAAgD,CACjD,CAAC"}

package/lib/jupyter/lite/kernel/index.d.ts

@@ -0,0 +1,4 @@
+export * from './kernel';
+export * from './kernels';
+export * from './kernelspecs';
+export * from './tokens';

package/lib/jupyter/lite/kernel/index.js

@@ -0,0 +1,7 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
+export * from './kernel';
+export * from './kernels';
+export * from './kernelspecs';
+export * from './tokens';
+//# sourceMappingURL=index.js.map

package/lib/jupyter/lite/kernel/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/jupyter/lite/kernel/index.ts"],"names":[],"mappings":"AAAA,0CAA0C;AAC1C,2DAA2D;AAE3D,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,eAAe,CAAC;AAC9B,cAAc,UAAU,CAAC"}

package/lib/jupyter/lite/kernel/kernel.d.ts

@@ -0,0 +1,245 @@
+import { KernelMessage } from '@jupyterlab/services';
+import { ISignal } from '@lumino/signaling';
+import { IKernel } from './tokens';
+/**
+ * A base kernel class handling basic kernel messaging.
+ */
+export declare abstract class BaseKernel implements IKernel {
+    /**
+     * Construct a new BaseKernel.
+     *
+     * @param options The instantiation options for a BaseKernel.
+     */
+    constructor(options: IKernel.IOptions);
+    /**
+     * A promise that is fulfilled when the kernel is ready.
+     */
+    get ready(): Promise<void>;
+    /**
+     * Return whether the kernel is disposed.
+     */
+    get isDisposed(): boolean;
+    /**
+     * A signal emitted when the kernel is disposed.
+     */
+    get disposed(): ISignal<this, void>;
+    /**
+     * Get the kernel id
+     */
+    get id(): string;
+    /**
+     * Get the name of the kernel
+     */
+    get name(): string;
+    /**
+     * The location in the virtual filesystem from which the kernel was started.
+     */
+    get location(): string;
+    /**
+     * The current execution count
+     */
+    get executionCount(): number;
+    /**
+     * Get the last parent header
+     */
+    get parentHeader(): KernelMessage.IHeader<KernelMessage.MessageType> | undefined;
+    /**
+     * Get the last parent message (mimic ipykernel's get_parent)
+     */
+    get parent(): KernelMessage.IMessage | undefined;
+    /**
+     * Dispose the kernel.
+     */
+    dispose(): void;
+    /**
+     * Handle an incoming message from the client.
+     *
+     * @param msg The message to handle
+     */
+    handleMessage(msg: KernelMessage.IMessage): Promise<void>;
+    /**
+     * Handle a `kernel_info_request` message.
+     *
+     * @returns A promise that resolves with the kernel info.
+     */
+    abstract kernelInfoRequest(): Promise<KernelMessage.IInfoReplyMsg['content']>;
+    /**
+     * Handle an `execute_request` message.
+     *
+     * @param content - The content of the execute_request kernel message
+     */
+    abstract executeRequest(content: KernelMessage.IExecuteRequestMsg['content']): Promise<KernelMessage.IExecuteReplyMsg['content']>;
+    /**
+     * Handle a `complete_request` message.
+     *
+     * @param content - The content of the request.
+     */
+    abstract completeRequest(content: KernelMessage.ICompleteRequestMsg['content']): Promise<KernelMessage.ICompleteReplyMsg['content']>;
+    /**
+     * Handle an `inspect_request` message.
+     *
+     * @param content - The content of the request.
+     *
+     * @returns A promise that resolves with the response message.
+     */
+    abstract inspectRequest(content: KernelMessage.IInspectRequestMsg['content']): Promise<KernelMessage.IInspectReplyMsg['content']>;
+    /**
+     * Handle an `is_complete_request` message.
+     *
+     * @param content - The content of the request.
+     *
+     * @returns A promise that resolves with the response message.
+     */
+    abstract isCompleteRequest(content: KernelMessage.IIsCompleteRequestMsg['content']): Promise<KernelMessage.IIsCompleteReplyMsg['content']>;
+    /**
+     * Handle a `comm_info_request` message.
+     *
+     * @param content - The content of the request.
+     *
+     * @returns A promise that resolves with the response message.
+     */
+    abstract commInfoRequest(content: KernelMessage.ICommInfoRequestMsg['content']): Promise<KernelMessage.ICommInfoReplyMsg['content']>;
+    /**
+     * Send an `input_reply` message.
+     *
+     * @param content - The content of the reply.
+     */
+    abstract inputReply(content: KernelMessage.IInputReplyMsg['content']): void;
+    /**
+     * Send an `comm_open` message.
+     *
+     * @param msg - The comm_open message.
+     */
+    abstract commOpen(msg: KernelMessage.ICommOpenMsg): Promise<void>;
+    /**
+     * Send an `comm_msg` message.
+     *
+     * @param msg - The comm_msg message.
+     */
+    abstract commMsg(msg: KernelMessage.ICommMsgMsg): Promise<void>;
+    /**
+     * Send an `comm_close` message.
+     *
+     * @param close - The comm_close message.
+     */
+    abstract commClose(msg: KernelMessage.ICommCloseMsg): Promise<void>;
+    /**
+     * Stream an event from the kernel
+     *
+     * @param parentHeader The parent header.
+     * @param content The stream content.
+     */
+    protected stream(content: KernelMessage.IStreamMsg['content'], parentHeader?: KernelMessage.IHeader<KernelMessage.MessageType> | undefined): void;
+    /**
+     * Send a `display_data` message to the client.
+     *
+     * @param parentHeader The parent header.
+     * @param content The display_data content.
+     */
+    protected displayData(content: KernelMessage.IDisplayDataMsg['content'], parentHeader?: KernelMessage.IHeader<KernelMessage.MessageType> | undefined): void;
+    /**
+     * Send a `input_request` message to the client.
+     *
+     * @param parentHeader The parent header.
+     * @param content The input_request content.
+     */
+    protected inputRequest(content: KernelMessage.IInputRequestMsg['content'], parentHeader?: KernelMessage.IHeader<KernelMessage.MessageType> | undefined): void;
+    /**
+     * Send an `execute_result` message.
+     *
+     * @param parentHeader The parent header.
+     * @param content The execute result content.
+     */
+    protected publishExecuteResult(content: KernelMessage.IExecuteResultMsg['content'], parentHeader?: KernelMessage.IHeader<KernelMessage.MessageType> | undefined): void;
+    /**
+     * Send an `error` message to the client.
+     *
+     * @param parentHeader The parent header.
+     * @param content The error content.
+     */
+    protected publishExecuteError(content: KernelMessage.IErrorMsg['content'], parentHeader?: KernelMessage.IHeader<KernelMessage.MessageType> | undefined): void;
+    /**
+     * Send a `update_display_data` message to the client.
+     *
+     * @param parentHeader The parent header.
+     * @param content The update_display_data content.
+     */
+    protected updateDisplayData(content: KernelMessage.IUpdateDisplayDataMsg['content'], parentHeader?: KernelMessage.IHeader<KernelMessage.MessageType> | undefined): void;
+    /**
+     * Send a `clear_output` message to the client.
+     *
+     * @param parentHeader The parent header.
+     * @param content The clear_output content.
+     */
+    protected clearOutput(content: KernelMessage.IClearOutputMsg['content'], parentHeader?: KernelMessage.IHeader<KernelMessage.MessageType> | undefined): void;
+    /**
+     * Send a `comm` message to the client.
+     *
+     * @param .
+     */
+    protected handleComm(type: 'comm_close' | 'comm_msg' | 'comm_open', content: KernelMessage.ICommMsgMsg['content'], metadata: KernelMessage.ICommMsgMsg['metadata'], buffers: KernelMessage.ICommMsgMsg['buffers'], parentHeader?: KernelMessage.IHeader<KernelMessage.MessageType> | undefined): void;
+    /**
+     * Send an 'idle' status message.
+     *
+     * @param parent The parent message
+     */
+    private _idle;
+    /**
+     * Send a 'busy' status message.
+     *
+     * @param parent The parent message.
+     */
+    private _busy;
+    /**
+     * Handle a kernel_info_request message
+     *
+     * @param parent The parent message.
+     */
+    private _kernelInfo;
+    /**
+     * Handle a `history_request` message
+     *
+     * @param msg The parent message.
+     */
+    private _historyRequest;
+    /**
+     * Send an `execute_input` message.
+     *
+     * @param msg The parent message.
+     */
+    private _executeInput;
+    /**
+     * Handle an execute_request message.
+     *
+     * @param msg The parent message.
+     */
+    private _execute;
+    /**
+     * Handle an complete_request message
+     *
+     * @param msg The parent message.
+     */
+    private _complete;
+    /**
+     * Handle an inspect_request message
+     *
+     * @param msg The parent message.
+     */
+    private _inspect;
+    /**
+     * Handle an is_complete_request message
+     *
+     * @param msg The parent message.
+     */
+    private _isCompleteRequest;
+    private _id;
+    private _name;
+    private _location;
+    private _history;
+    private _executionCount;
+    private _isDisposed;
+    private _disposed;
+    private _sendMessage;
+    private _parentHeader;
+    private _parent;
+}