@typbase/engine 0.2.1

package/engine.d.ts

@@ -0,0 +1,569 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * A `#typbase.section(kind: ...)[...]` block. Ranges are raw source bytes;
+ * `content_start..content_end` is the markup inside the brackets.
+ */
+export interface SectionSpan {
+    kind: string;
+    content_start: number;
+    content_end: number;
+    full_start: number;
+    full_end: number;
+    title: string;
+}
+
+/**
+ * A file, source, or package the compiler asked for but the world does not
+ * have. Every compile returns the requests it accumulated; the caller
+ * resolves them (workspace source, blob bytes, package tarball) and recompiles.
+ */
+export type TypstRequest = { type: "source"; value: string } | { type: "file"; value: string } | { type: "package"; value: { namespace: string; name: string; version: string } };
+
+/**
+ * A notebook cell: one `// %%` marker line plus the content below it, up to
+ * the next marker or the end of the document. Ranges are UTF-16 offsets into
+ * the raw source, so they can be used as editor positions directly.
+ */
+export interface CellSpan {
+    /**
+     * Cell type from the marker label: `"markup"` or `"code"`.
+     */
+    kind: string;
+    /**
+     * Marker line range, excluding the newline. Both zero on the implicit
+     * leading cell of a document whose first marker is not on line one.
+     */
+    marker_start: number;
+    marker_end: number;
+    /**
+     * Content range. Blank lines below the content belong to the gap before
+     * the next marker and are excluded.
+     */
+    content_start: number;
+    content_end: number;
+}
+
+/**
+ * An SVG frame with its corresponding source range.
+ */
+export interface SvgRangedFrame {
+    /**
+     * UTF-16 range in the source for this frame.
+     */
+    range: { start: number; end: number };
+    /**
+     * The SVG render data.
+     */
+    render: SvgFrameRender;
+}
+
+/**
+ * One flattened source block. `map[i]` is the raw byte offset of plain byte
+ * `i`; FTS offsets in `plain` translate through it to editor positions.
+ */
+export interface FlattenedBlock {
+    kind: string;
+    plain: string;
+    range_start: number;
+    range_end: number;
+    map: number[];
+}
+
+/**
+ * One link call in a page source, in UTF-16 offsets.
+ */
+export interface LinkSpan {
+    /**
+     * The link form: `"page-link"`, `"embed"`, or `"url"`.
+     */
+    kind: string;
+    /**
+     * The page reference: the id argument for `page-link` and `embed`, or the
+     * id part of a `typbase://page/<id>` URL.
+     */
+    target: string;
+    /**
+     * UTF-16 range of the whole call.
+     */
+    from: number;
+    to: number;
+    /**
+     * UTF-16 range of the target string's contents, inside the quotes.
+     */
+    target_from: number;
+    target_to: number;
+}
+
+/**
+ * One segment in the check report, labelled for humans.
+ */
+export interface CheckedSegment {
+    kind: string;
+    generated: boolean;
+    from: number;
+    from_end: number;
+    to: number;
+    to_end: number;
+}
+
+/**
+ * Rendered SVG data for a frame, including metadata.
+ */
+export interface SvgFrameRender {
+    /**
+     * SVG markup as a string.
+     */
+    svg: string;
+    /**
+     * Width of the frame in points.
+     */
+    width: number;
+    /**
+     * Height of the frame in points.
+     */
+    height: number;
+    /**
+     * Offset from the left of the page in points.
+     */
+    xOffset: number;
+    /**
+     * Hash of the frame items for change detection.
+     */
+    yOffset: number;
+    /**
+     * Hash of the frame items for change detection.
+     */
+    hash: number;
+}
+
+/**
+ * Result of SVG rendering, containing SVG frames and diagnostics.
+ */
+export interface SvgRender {
+    /**
+     * Rendered SVG frames for each chunk.
+     */
+    frames: SvgRangedFrame[];
+    /**
+     * Rendered SVG frames for tooltips.
+     */
+    tooltips: SvgRangedFrame[];
+    /**
+     * Diagnostics and warnings produced during rendering.
+     */
+    diagnostics: TypstDiagnostic[];
+}
+
+/**
+ * Result of `TypstState::check_index`: a self-test of the source maps.
+ */
+export interface IndexCheckReport {
+    /**
+     * True when every checked invariant held.
+     */
+    ok: boolean;
+    /**
+     * How many positions were sampled for each direction.
+     */
+    checked: number;
+    /**
+     * Human-readable descriptions of failed invariants.
+     */
+    mismatches: string[];
+    /**
+     * Every segment of the raw to pristine-synth map, for the debug lab.
+     */
+    segments: CheckedSegment[];
+}
+
+/**
+ * Result of rendering a Typst document to HTML.
+ */
+export interface RenderHtmlResult {
+    /**
+     * The rendered HTML document, if successful.
+     */
+    document: string | undefined;
+    /**
+     * Diagnostics and warnings produced during rendering.
+     */
+    diagnostics: TypstDiagnostic[];
+    /**
+     * Requests the caller must satisfy before re-rendering (query JSON,
+     * embedded pages). The editor's `compileHTML` carries them too; the
+     * publish worker needs them on this path.
+     */
+    requests: TypstRequest[];
+}
+
+/**
+ * SVG export: one string per page, or a single merged document.
+ */
+export interface RenderSvgResult {
+    pages: string[];
+    diagnostics: TypstDiagnostic[];
+    requests: TypstRequest[];
+}
+
+export interface Autocomplete {
+    offset: number;
+    completions: TypstCompletion[];
+}
+
+export interface CheckResult {
+    diagnostics: TypstDiagnostic[];
+    requests: TypstRequest[];
+}
+
+export interface CompileHTMLResult {
+    frames: HTMLRangedFrame[];
+    diagnostics: TypstDiagnostic[];
+    requests: TypstRequest[];
+}
+
+export interface CompilePagedResult {
+    frames: SvgRangedFrame[];
+    tooltips: SvgRangedFrame[];
+    diagnostics: TypstDiagnostic[];
+    requests: TypstRequest[];
+}
+
+export interface HTMLFrameRender {
+    html: string;
+    hash: number;
+}
+
+export interface HTMLRangedFrame {
+    range: { start: number; end: number };
+    render: HTMLFrameRender;
+}
+
+export interface HTMLRenderResult {
+    frames: HTMLRangedFrame[];
+    diagnostics: TypstDiagnostic[];
+}
+
+export interface RenderPdfResult {
+    bytes: number[] | undefined;
+    diagnostics: TypstDiagnostic[];
+    requests: TypstRequest[];
+}
+
+export interface TypstCompletion {
+    type: TypstCompletionKind;
+    label: string;
+    apply: string | undefined;
+    detail: string | undefined;
+}
+
+export interface TypstDiagnostic {
+    range: { start: number; end: number };
+    severity: TypstDiagnosticSeverity;
+    message: string;
+    hints: string[];
+}
+
+export interface TypstHighlight {
+    tag: string;
+    range: { start: number; end: number };
+}
+
+export type TypstCompletionKind = "syntax" | "func" | "type" | "param" | "constant" | "path" | "package" | "label" | "font" | "symbol";
+
+export type TypstDiagnosticSeverity = "error" | "warning" | "info" | "hint";
+
+export type TypstError = EcoString;
+
+export type TypstJump = { type: "File"; position: number };
+
+
+export class FileId {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+}
+
+export class Rgb {
+    free(): void;
+    [Symbol.dispose](): void;
+    constructor(r: number, g: number, b: number);
+    toString(): string;
+}
+
+/**
+ * Colors handed to Typst as the `theme` dictionary. The slots mirror the
+ * app's resolved `ThemePaletteTokens` one to one (plus derived `on-*` text
+ * colors), so a single token set styles both the chrome and rendered pages.
+ * The dict keys in [`fmt::Display`] are the kebab-case token names Typst
+ * code reads. `overlay` stays chrome-only: it carries alpha and Rgb cannot.
+ */
+export class ThemeColors {
+    free(): void;
+    [Symbol.dispose](): void;
+    constructor(surface: Rgb, surface2: Rgb, surface3: Rgb, border: Rgb, border_strong: Rgb, text: Rgb, text_secondary: Rgb, accent: Rgb, accent_soft: Rgb, on_accent: Rgb, ok: Rgb, ok_soft: Rgb, warning: Rgb, warning_soft: Rgb, danger: Rgb, danger_soft: Rgb, on_danger: Rgb, info: Rgb, info_soft: Rgb, red: Rgb, orange: Rgb, yellow: Rgb, green: Rgb, cyan: Rgb, blue: Rgb, violet: Rgb, code: Rgb);
+    /**
+     * Generated tmTheme text, for writing into exported project bundles.
+     */
+    tmTheme(): string;
+    /**
+     * Virtual path of `tmTheme`, with no leading slash.
+     */
+    tmThemePath(): string;
+}
+
+/**
+ * Global state for Typst rendering and compilation in Typbase.
+ *
+ * Holds the world, all open source and space contexts, and manages the mapping
+ * between user/editor state and Typst's compilation model.
+ */
+export class TypstState {
+    free(): void;
+    [Symbol.dispose](): void;
+    autocomplete(id: FileId, raw_cursor_utf16: number, explicit: boolean): Autocomplete | undefined;
+    /**
+     * Diagnostics-only HTML pass: compile the pristine synth, no recovery.
+     */
+    checkHTML(id: FileId, text: string, prelude: string): CheckResult;
+    /**
+     * Index mapping self-test for the debug lab. Builds the synth exactly
+     * like a compile would, then verifies map invariants: segments tile both
+     * spaces, both directions stay in bounds, and neither regresses.
+     */
+    checkIndex(id: FileId, text: string, prelude: string): IndexCheckReport;
+    /**
+     * Diagnostics-only pass: compile the pristine synth, no recovery.
+     */
+    checkPaged(id: FileId, text: string, prelude: string): CheckResult;
+    /**
+     * The editor's inline HTML render: one ranged frame for the whole note,
+     * with the frames renderer's block-blanking recovery. Publishing, export,
+     * and chat use `renderHtml` (see [`document`]) instead.
+     */
+    compileHTML(id: FileId, text: string, prelude: string): CompileHTMLResult;
+    /**
+     * The editor's paged render: one SVG frame per source chunk, plus the
+     * tooltip frames and diagnostics the editor needs.
+     */
+    compilePaged(id: FileId, text: string, prelude: string): CompilePagedResult;
+    createFileId(path: string): FileId;
+    createSourceId(path: string, space_id: string): FileId;
+    /**
+     * Clears Typst's global memoization caches. They make repeated compiles
+     * cheap but grow for the lifetime of the instance, so call this when
+     * memory matters more than speed, such as on a workspace switch.
+     */
+    evictCaches(): void;
+    /**
+     * Evicts entries unused across two eviction rounds. The heap watchdog
+     * uses this while typing: per-keystroke entries age out, shared entries
+     * such as the library and fonts stay warm.
+     */
+    evictCachesAged(max_age: number): void;
+    /**
+     * Extracts notebook cells (`// %%` markers) as UTF-16 spans, ready for
+     * CodeMirror positions. Pure syntax pass; no state needed.
+     */
+    extractCells(text: string): CellSpan[];
+    /**
+     * Extracts the app's link calls (`typbase.page-link`, `typbase.embed`,
+     * and `typbase://page/` URLs) with UTF-16 ranges. Pure syntax pass; no
+     * state needed.
+     */
+    extractLinks(text: string): LinkSpan[];
+    /**
+     * Extracts `#typbase.section` spans for the page doc's sections list.
+     */
+    extractSections(text: string): SectionSpan[];
+    /**
+     * Plain-text flattening per block for the search index, plus the byte
+     * map back to raw source. Pure syntax pass; no state needed.
+     */
+    flattenDocument(text: string): FlattenedBlock[];
+    highlight(id: FileId, text: string): TypstHighlight[];
+    hover(id: FileId, raw_cursor_utf16: number, side: number): string | undefined;
+    insertFile(id: FileId, bytes: Uint8Array): void;
+    insertSource(id: FileId, text: string): void;
+    installFont(bytes: Uint8Array): void;
+    installPackage(spec: string, data: Uint8Array): void;
+    jumpHTML(id: FileId, element: Uint32Array): TypstJump | undefined;
+    jumpPaged(id: FileId, x: number, y: number): TypstJump | undefined;
+    /**
+     * Current WASM heap size in bytes. The lab watches this to catch leaks;
+     * the wasm allocator rarely returns memory to the browser, so growth
+     * here usually means a compile loop.
+     */
+    memoryBytes(): number;
+    constructor();
+    /**
+     * False when the shipped wasm build omits the pdf feature (the default).
+     */
+    pdfAvailable(): boolean;
+    removeFile(id: FileId): void;
+    removePackage(spec: string): void;
+    /**
+     * Renders the whole note to one HTML document, with recovery. Used by
+     * publish, export, and chat; the editor's inline frames use
+     * `compileHTML` instead.
+     */
+    renderHtml(id: FileId, text: string, prelude: string): RenderHtmlResult;
+    /**
+     * PDF publishing, compiled only when the `pdf` cargo feature is on.
+     * Returns the PDF bytes plus diagnostics; the caller uploads the bytes
+     * as a blob on `at.typbase.post`.
+     */
+    renderPdf(id: FileId, text: string, prelude: string): RenderPdfResult;
+    /**
+     * SVG export of the paged document: one entry per page, or a single
+     * merged document. Uses the PDF page geometry so the sheets match the
+     * PDF export; the caller sets the page width through `resize`.
+     */
+    renderSvg(id: FileId, text: string, prelude: string, merged: boolean): RenderSvgResult;
+    resize(id: FileId, width?: number | null, height?: number | null): boolean;
+    /**
+     * Monotonic counter bumped on font/theme/config changes. Re-render
+     * decisions key on this, not on the file path alone.
+     */
+    revision(): number;
+    setCodeFont(id: FileId, code_font?: string | null): void;
+    setFont(id: FileId, font: string): void;
+    /**
+     * The editor's line-height as a multiple of the text size. Frame crops
+     * move their top to the editor's line box so the rendered text sits on
+     * the same baseline as the source text.
+     */
+    setLineHeightRatio(id: FileId, ratio: number): void;
+    setLocale(id: FileId, locale: string): void;
+    setMathFont(id: FileId, math_font?: string | null): void;
+    setTextSize(id: FileId, text_size: number): void;
+    setTheme(id: FileId, theme: ThemeColors): void;
+    /**
+     * The style block alone, for exports and the project mirror: the same
+     * text the engine prepends, minus the render-target page config.
+     */
+    static stylePrelude(theme: ThemeColors, text_size: number, font: string, math_font: string | null | undefined, code_font: string | null | undefined, locale: string): string;
+    /**
+     * The stdlib source as shipped, for writing a compilable project to disk.
+     */
+    typbaseLib(): string;
+}
+
+/**
+ * True when the module was built by the dev profile.
+ *
+ * The two wasm tasks write the same `pkg/` directory, so a stray
+ * `engine:build-dev` edge in a release graph silently swaps the optimized
+ * engine for the unoptimized one. Release tooling can read this before
+ * publishing; custom sections cannot key that kind of check because wasm-opt
+ * and wasm-bindgen rewrite them.
+ */
+export function isDevelopmentBuild(): boolean;
+
+export function start(): void;
+
+/**
+ * Drains the allocation-failure flag without going through a `TypstState`
+ * handle.
+ *
+ * A trap inside a `&mut self` method leaves wasm-bindgen's borrow flag set
+ * (there is no unwinding and no `Drop`), so the method form of this call
+ * throws the aliasing error on the dead object exactly when the host needs
+ * the reason for the failure. This free function touches a static and a
+ * primitive only, so it works on a poisoned instance.
+ */
+export function takeOomGlobal(): boolean;
+
+/**
+ * Drains the panic message without going through a `TypstState` handle.
+ * See [`take_oom_global`] for why the method form is not usable here.
+ */
+export function takePanicGlobal(): string | undefined;
+
+export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+
+export interface InitOutput {
+    readonly memory: WebAssembly.Memory;
+    readonly __wbg_fileid_free: (a: number, b: number) => void;
+    readonly __wbg_rgb_free: (a: number, b: number) => void;
+    readonly __wbg_themecolors_free: (a: number, b: number) => void;
+    readonly __wbg_typststate_free: (a: number, b: number) => void;
+    readonly isDevelopmentBuild: () => number;
+    readonly rgb_new: (a: number, b: number, c: number) => number;
+    readonly rgb_toString: (a: number, b: number) => void;
+    readonly start: () => void;
+    readonly takeOomGlobal: () => number;
+    readonly takePanicGlobal: (a: number) => void;
+    readonly themecolors_new: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number, j: number, k: number, l: number, m: number, n: number, o: number, p: number, q: number, r: number, s: number, t: number, u: number, v: number, w: number, x: number, y: number, z: number, a1: number) => number;
+    readonly themecolors_tmTheme: (a: number, b: number) => void;
+    readonly themecolors_tmThemePath: (a: number, b: number) => void;
+    readonly typststate_autocomplete: (a: number, b: number, c: number, d: number, e: number) => void;
+    readonly typststate_checkHTML: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => void;
+    readonly typststate_checkIndex: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => void;
+    readonly typststate_checkPaged: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => void;
+    readonly typststate_compileHTML: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => void;
+    readonly typststate_compilePaged: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => void;
+    readonly typststate_createFileId: (a: number, b: number, c: number) => number;
+    readonly typststate_createSourceId: (a: number, b: number, c: number, d: number, e: number) => number;
+    readonly typststate_evictCaches: (a: number) => void;
+    readonly typststate_evictCachesAged: (a: number, b: number) => void;
+    readonly typststate_extractCells: (a: number, b: number, c: number, d: number) => void;
+    readonly typststate_extractLinks: (a: number, b: number, c: number, d: number) => void;
+    readonly typststate_extractSections: (a: number, b: number, c: number, d: number) => void;
+    readonly typststate_flattenDocument: (a: number, b: number, c: number, d: number) => void;
+    readonly typststate_highlight: (a: number, b: number, c: number, d: number, e: number) => void;
+    readonly typststate_hover: (a: number, b: number, c: number, d: number, e: number) => void;
+    readonly typststate_insertFile: (a: number, b: number, c: number, d: number) => void;
+    readonly typststate_insertSource: (a: number, b: number, c: number, d: number) => void;
+    readonly typststate_installFont: (a: number, b: number, c: number) => void;
+    readonly typststate_installPackage: (a: number, b: number, c: number, d: number, e: number, f: number) => void;
+    readonly typststate_jumpHTML: (a: number, b: number, c: number, d: number, e: number) => void;
+    readonly typststate_jumpPaged: (a: number, b: number, c: number, d: number, e: number) => void;
+    readonly typststate_memoryBytes: (a: number) => number;
+    readonly typststate_new: () => number;
+    readonly typststate_pdfAvailable: (a: number) => number;
+    readonly typststate_removeFile: (a: number, b: number) => void;
+    readonly typststate_removePackage: (a: number, b: number, c: number, d: number) => void;
+    readonly typststate_renderHtml: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => void;
+    readonly typststate_renderPdf: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => void;
+    readonly typststate_renderSvg: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number) => void;
+    readonly typststate_resize: (a: number, b: number, c: number, d: number, e: number, f: number) => number;
+    readonly typststate_revision: (a: number) => number;
+    readonly typststate_setCodeFont: (a: number, b: number, c: number, d: number) => void;
+    readonly typststate_setFont: (a: number, b: number, c: number, d: number) => void;
+    readonly typststate_setLineHeightRatio: (a: number, b: number, c: number) => void;
+    readonly typststate_setLocale: (a: number, b: number, c: number, d: number) => void;
+    readonly typststate_setMathFont: (a: number, b: number, c: number, d: number) => void;
+    readonly typststate_setTextSize: (a: number, b: number, c: number) => void;
+    readonly typststate_setTheme: (a: number, b: number, c: number) => void;
+    readonly typststate_stylePrelude: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number, j: number, k: number) => void;
+    readonly typststate_typbaseLib: (a: number, b: number) => void;
+    readonly __wbindgen_export: (a: number, b: number) => number;
+    readonly __wbindgen_export2: (a: number, b: number, c: number, d: number) => number;
+    readonly __wbindgen_export3: (a: number) => void;
+    readonly __wbindgen_add_to_stack_pointer: (a: number) => number;
+    readonly __wbindgen_export4: (a: number, b: number, c: number) => void;
+    readonly __wbindgen_start: () => void;
+}
+
+export type SyncInitInput = BufferSource | WebAssembly.Module;
+
+/**
+ * Instantiates the given `module`, which can either be bytes or
+ * a precompiled `WebAssembly.Module`.
+ *
+ * @param {{ module: SyncInitInput }} module - Passing `SyncInitInput` directly is deprecated.
+ *
+ * @returns {InitOutput}
+ */
+export function initSync(module: { module: SyncInitInput } | SyncInitInput): InitOutput;
+
+/**
+ * If `module_or_path` is {RequestInfo} or {URL}, makes a request and
+ * for everything else, calls `WebAssembly.instantiate` directly.
+ *
+ * @param {{ module_or_path: InitInput | Promise<InitInput> }} module_or_path - Passing `InitInput` directly is deprecated.
+ *
+ * @returns {Promise<InitOutput>}
+ */
+export default function __wbg_init (module_or_path?: { module_or_path: InitInput | Promise<InitInput> } | InitInput | Promise<InitInput>): Promise<InitOutput>;