@tlockney/cdp-kernel 0.6.0 → 0.7.1

package/dist/kernel-core.d.ts

@@ -0,0 +1,78 @@
+import { type JsonObject, type KernelMessage, type OutgoingMessage } from "./message.ts";
+import { type KernelTarget, type TargetEvents } from "./target-api.ts";
+import type { Debugger } from "./debugger.ts";
+import type { CompletionResult } from "./notebook-types.ts";
+import { type CellTransformOptions, type TypeStripper, type TypeStripperName } from "./transform.ts";
+/** The channels a frontend sends requests on. */
+export type ChannelName = "shell" | "control" | "stdin";
+/** A request, and which of the frontend's connections it came on. */
+export interface Received {
+    peer: string;
+    msg: KernelMessage;
+}
+/** How messages reach the kernel and leave it: ZeroMQ (src/zmq-channels.ts), or a page (src/browser/). */
+export interface KernelChannels {
+    /** Settles once every channel can carry messages. */
+    readonly ready: Promise<unknown>;
+    /** The next message on a channel; null for one that is dropped (malformed, or unsigned). */
+    recv(channel: ChannelName): Promise<Received | null>;
+    /** Shell messages received but not yet taken by recv. */
+    shellQueued(): number;
+    reply(channel: ChannelName, peer: string, msg: OutgoingMessage): void;
+    publish(msg: OutgoingMessage): void;
+    /** How many frontends listen on stdin. */
+    stdinPeers(): number;
+    /** To every frontend listening on stdin. */
+    sendStdin(msg: OutgoingMessage): void;
+}
+/** Typed completion and tooltips (src/language-service.ts). */
+export interface TypeService {
+    reset(): void;
+    addCell(code: string): void;
+    complete(code: string, cursor: number): Promise<CompletionResult | null>;
+    quickInfo(code: string, cursor: number): Promise<string | null>;
+}
+/** What a KernelCore gets from the process it runs in. */
+export interface KernelHost {
+    /** The target's name, for the banner and messages. */
+    readonly runtime: string;
+    readonly version: string;
+    /** The TypeScript version cells are checked against; TYPESCRIPT_VERSION if not given. */
+    readonly languageVersion?: string;
+    readonly channels: KernelChannels;
+    launchTarget(events: TargetEvents): Promise<KernelTarget>;
+    /** What strips cells' types; esbuild by default (#238). */
+    readonly typeStrip?: TypeStripperName | TypeStripper;
+    /** A project's transform settings, e.g. a deno.json's JSX options (#13). */
+    readonly transform?: CellTransformOptions;
+    /** Shown once, in the first cell: e.g. why a project config wasn't used. */
+    readonly warning?: string | null;
+    readonly types?: TypeService | null;
+    /** Returned as `capabilities` in kernel_info_reply, when set: what the host offers cells (#384). */
+    readonly capabilities?: JsonObject;
+    /** JupyterLab's visual debugger, for targets driven over CDP (#18). */
+    createDebugger?(publish: (event: JsonObject) => void, transformOptions: () => CellTransformOptions): Debugger;
+    /** A file's source, for the lines around a traceback frame (#322). */
+    readSource?(file: string): string | undefined;
+    /** Path or URL prefixes of the kernel's own runtime files, whose frames a traceback marks as library code. */
+    readonly kernelFiles?: readonly string[];
+    log(text: string): void;
+    /** After shutdown_reply has gone out. */
+    exit(): void;
+}
+/**
+ * kernel_info's language_info.version when the host doesn't know the
+ * installed TypeScript's: the major version package.json depends on.
+ */
+export declare const TYPESCRIPT_VERSION = "6";
+export declare class KernelCore {
+    #private;
+    constructor(host: KernelHost);
+    run(): Promise<void>;
+    /** What SIGINT does: interrupt the cell, or the prompt it waits on. */
+    interrupt(): Promise<void>;
+    /** The process is exiting: a target that exits now isn't reported. */
+    stopping(): void;
+    /** A state dump, for a kernel that has stopped answering (#237). */
+    logState(): Promise<void>;
+}