@codesandbox/sandpack-client/dist/clients/runtime/types.d.ts

<img style="width:100%" src="https://user-images.githubusercontent.com/4838076/143581035-ebee5ba2-9cb1-4fe8-a05b-2f44bd69bb4b.gif" alt="Component toolkit for live running code editing experiences" />

import type { BaseSandpackMessage, BundlerState, ClientStatus, Modules, NpmRegistry, ReactDevToolsMode, SandboxTestMessage, SandpackErrorMessage, SandpackLogLevel, SandpackMessageConsoleMethods, SandpackTemplate } from "../..";
export type SandpackRuntimeMessage = BaseSandpackMessage & ({
    type: "initialized";
} | {
    type: "start";
    firstLoad?: boolean;
} | {
    type: "status";
    status: ClientStatus;
} | {
    type: "state";
    state: BundlerState;
} | {
    type: "success";
} | ({
    type: "action";
    action: "show-error";
} & SandpackErrorMessage) | {
    type: "action";
    action: "notification";
    notificationType: "error";
    title: string;
} | {
    type: "done";
    compilatonError: boolean;
} | {
    type: "urlchange";
    url: string;
    back: boolean;
    forward: boolean;
} | {
    type: "resize";
    height: number;
} | {
    type: "transpiler-context";
    data: Record<string, Record<string, unknown>>;
} | {
    type: "compile";
    version: number;
    isInitializationCompile?: boolean;
    modules: Modules;
    externalResources: string[];
    hasFileResolver: boolean;
    disableDependencyPreprocessing?: boolean;
    experimental_enableServiceWorker?: boolean;
    experimental_stableServiceWorkerId?: string;
    template?: string | SandpackTemplate;
    showOpenInCodeSandbox: boolean;
    showErrorScreen: boolean;
    showLoadingScreen: boolean;
    skipEval: boolean;
    clearConsoleDisabled?: boolean;
    reactDevTools?: ReactDevToolsMode;
    logLevel?: SandpackLogLevel;
    customNpmRegistries?: NpmRegistry[];
    teamId?: string;
    sandboxId?: string;
} | {
    type: "refresh";
} | {
    type: "urlback";
} | {
    type: "urlforward";
} | {
    type: "get-transpiler-context";
} | {
    type: "get-modules";
} | {
    type: "all-modules";
    data: Array<{
        path: string;
        code: string;
    }>;
} | {
    type: "activate-react-devtools";
} | {
    type: "console";
    log: Array<{
        method: SandpackMessageConsoleMethods;
        id: string;
        data: string[];
    }>;
} | SandboxTestMessage | {
    type: "sign-in";
    teamId: string;
} | {
    type: "sign-out";
} | {
    type: "dependencies";
    data: {
        state: "downloading_manifest";
    } | {
        state: "downloaded_module";
        name: string;
        total: number;
        progress: number;
    } | {
        state: "starting";
    };
});
export declare const CHANNEL_NAME = "$CSB_RELAY";
export interface IPreviewRequestMessage {
    $channel: typeof CHANNEL_NAME;
    $type: "preview/request";
    id: string;
    method: string;
    url: string;
}
export interface IPreviewResponseMessage {
    $channel: typeof CHANNEL_NAME;
    $type: "preview/response";
    id: string;
    status: number;
    headers: Record<string, string>;
    body: string | Uint8Array;
}