@canvist/web 0.0.0 → 0.2.0

package/wasm/canvist_web_bg.wasm.d.ts

@@ -0,0 +1,59 @@
+/* tslint:disable */
+/* eslint-disable */
+export const memory: WebAssembly.Memory;
+export const __wbg_webeditor_free: (a: number, b: number) => void;
+export const webeditor_bodyStyle: (a: number) => [number, number];
+export const webeditor_can: (a: number, b: number, c: number, d: number, e: number) => [number, number, number];
+export const webeditor_caretRect: (a: number) => [number, number];
+export const webeditor_caretRectAt: (a: number, b: number, c: number, d: number) => [number, number];
+export const webeditor_characterBounds: (a: number, b: number, c: number) => [number, number];
+export const webeditor_commitComposition: (a: number, b: number, c: number) => [number, number, number];
+export const webeditor_copySelection: (a: number) => [number, number, number, number];
+export const webeditor_cutSelection: (a: number) => [number, number, number, number];
+export const webeditor_dropAt: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number) => [number, number, number];
+export const webeditor_editContextState: (a: number) => any;
+export const webeditor_export: (a: number, b: number, c: number) => [number, number, number, number];
+export const webeditor_fonts: (a: number) => [number, number];
+export const webeditor_fontsLoaded: (a: number, b: number, c: number) => number;
+export const webeditor_forgetMeasurements: (a: number) => void;
+export const webeditor_frame: (a: number) => [number, number, number, number];
+export const webeditor_geometry: (a: number) => [number, number, number, number];
+export const webeditor_hideFamilies: (a: number, b: number, c: number) => void;
+export const webeditor_html: (a: number) => [number, number];
+export const webeditor_insertText: (a: number, b: number, c: number) => [number, number, number];
+export const webeditor_isEmpty: (a: number) => number;
+export const webeditor_isInSelection: (a: number, b: number, c: number) => number;
+export const webeditor_keyDown: (a: number, b: number, c: number, d: number) => [number, number, number];
+export const webeditor_load: (a: number, b: number, c: number, d: number, e: number) => [number, number];
+export const webeditor_new: (a: any, b: any, c: number, d: number, e: number, f: number) => [number, number, number];
+export const webeditor_pasteHtml: (a: number, b: number, c: number) => [number, number, number];
+export const webeditor_pasteText: (a: number, b: number, c: number) => [number, number, number];
+export const webeditor_pointerDown: (a: number, b: number, c: number, d: number, e: number) => [number, number, number];
+export const webeditor_pointerMove: (a: number, b: number, c: number) => [number, number, number];
+export const webeditor_pointerUp: (a: number) => void;
+export const webeditor_query: (a: number, b: number, c: number, d: number, e: number) => [number, number, number, number];
+export const webeditor_redo: (a: number) => [number, number, number];
+export const webeditor_replaceText: (a: number, b: number, c: number, d: number, e: number) => [number, number, number];
+export const webeditor_resize: (a: number, b: number, c: number, d: number, e: number, f: number) => void;
+export const webeditor_run: (a: number, b: number, c: number, d: number, e: number) => [number, number, number];
+export const webeditor_select: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => [number, number];
+export const webeditor_selection: (a: number) => [number, number];
+export const webeditor_selectionBounds: (a: number) => [number, number];
+export const webeditor_setBorderScale: (a: number, b: number) => void;
+export const webeditor_setCaretOn: (a: number, b: number) => void;
+export const webeditor_setComposition: (a: number, b: number, c: number) => [number, number, number];
+export const webeditor_setFocused: (a: number, b: number) => void;
+export const webeditor_setPixelGrid: (a: number, b: number, c: number) => [number, number];
+export const webeditor_setTop: (a: number, b: number) => void;
+export const webeditor_stats: (a: number) => [number, number];
+export const webeditor_svg: (a: number) => [number, number, number, number];
+export const webeditor_undo: (a: number) => [number, number, number];
+export const __wbindgen_malloc: (a: number, b: number) => number;
+export const __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
+export const __wbindgen_exn_store: (a: number) => void;
+export const __externref_table_alloc: () => number;
+export const __wbindgen_externrefs: WebAssembly.Table;
+export const __externref_drop_slice: (a: number, b: number) => void;
+export const __wbindgen_free: (a: number, b: number, c: number) => void;
+export const __externref_table_dealloc: (a: number) => void;
+export const __wbindgen_start: () => void;

package/wasm-collab/canvist_web.d.ts

@@ -0,0 +1,391 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/** The JavaScript half of text measurement; `@canvist/web` implements it with a canvas. */
+export interface HostMeasurer {
+    addFont(id: number, css: string): void;
+    paintFont(id: number): string;
+    measure(
+    metrics: Uint32Array,
+    lineFonts: Uint32Array,
+    lineHeights: Float32Array,
+    fonts: Uint32Array,
+    text: string,
+    lengths: Uint32Array,
+    ): Float32Array;
+}
+
+
+
+/**
+ * One editor on one canvas.
+ */
+export class WebEditor {
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Body text's CSS `font` shorthand and colour, as `[font, color]`, for
+     * text the host draws over the canvas in the document's style, such as
+     * a placeholder.
+     */
+    bodyStyle(): string[];
+    /**
+     * Whether the named command would apply. Nothing changes.
+     */
+    can(name: string, args: string): boolean;
+    /**
+     * The rectangle of a caret at `path` and `offset` (UTF-16 code units),
+     * in document coordinates as `[x, y, width, height]`, or an empty array
+     * when the document has no such position or it is not laid out. Hosts
+     * draw collaborators' carets with it.
+     */
+    caretRectAt(path: Uint32Array, offset: number): Float32Array;
+    /**
+     * The caret's rectangle in document coordinates as `[x, y, width,
+     * height]`, or an empty array when the selection is not a caret. Hosts
+     * place IME windows and scroll the caret into view with it.
+     */
+    caretRect(): Float32Array;
+    /**
+     * The rectangles of the characters in UTF-16 range `start..end` of the
+     * head's text block, as `[x, y, width, height]` per character in
+     * document coordinates, for placing IME candidate windows.
+     */
+    characterBounds(start: number, end: number): Float32Array;
+    /**
+     * Commit the composition as `text`.
+     */
+    commitComposition(text: string): boolean;
+    /**
+     * The selection as `[html, text]` for the clipboard, or empty when
+     * nothing is selected.
+     */
+    copySelection(): string[];
+    /**
+     * Cut the selection, returning it as [`WebEditor::copy_selection`]
+     * does.
+     */
+    cutSelection(): string[];
+    /**
+     * Drop content at `(x, y)`: `html` when the source offered it, otherwise
+     * `text`. With `moving`, the content is this editor's own selection,
+     * dragged: it leaves its old place. A drop inside the dragged selection
+     * does nothing.
+     */
+    dropAt(x: number, y: number, html: string | null | undefined, text: string, moving: boolean): boolean;
+    /**
+     * The text an `EditContext` edits: the text block holding the
+     * selection's head, and the selection within it in UTF-16 code units, as
+     * `[text, start, end]`. A selection reaching into another block is
+     * clamped to this one. Empty when the head is not in a text block.
+     */
+    editContextState(): [text: string, start: number, end: number] | [];
+    /**
+     * The document as `format`.
+     */
+    export(format: string): string;
+    /**
+     * This editor's changes since the last call, as y-sync messages for the
+     * server.
+     */
+    flushSync(): Uint8Array[];
+    /**
+     * Font faces of `families` finished loading: forget only the
+     * measurements of fonts that list one of them, so the blocks using them
+     * lay out again on the next frame. Returns how many measured blocks were
+     * invalidated.
+     */
+    fontsLoaded(families: string[]): number;
+    /**
+     * The CSS `font` shorthand of every font the layout has used, indexed
+     * by font id.
+     */
+    fonts(): string[];
+    /**
+     * Forget every measurement, as when the device pixel ratio changes:
+     * browsers round font metrics to device pixels, so line positions can
+     * move. Blocks lay out again as they come into view.
+     */
+    forgetMeasurements(): void;
+    /**
+     * Lay out the viewport and paint whatever changed since the last frame.
+     * Returns what it did as `[height, shift, laidOut, measured, drawn,
+     * full, painted]`: `height` is the document's height in CSS px, `shift`
+     * how far content at the viewport's top moved (add it to the scroll
+     * position), and the flags are 0 or 1.
+     */
+    frame(): Float64Array;
+    /**
+     * The whole document laid out, as JSON: block rectangles, caret stops,
+     * and text runs (see the parity tests). Lays out every block first.
+     */
+    geometry(): string;
+    /**
+     * Lay out text in `families` but draw it invisibly, as browsers do
+     * during a `font-display` block period. Pass an empty list once the
+     * faces load or the period ends.
+     */
+    hideFamilies(families: string[]): void;
+    /**
+     * Server-rendered HTML for the document at the current width, as
+     * `[fragment, stylesheet]`: what SSR sends down, and what the
+     * accessibility mirror shows.
+     */
+    html(): string[];
+    /**
+     * Replace the selection with `text`, running input rules as typing
+     * does. Returns whether anything changed.
+     */
+    insertText(text: string): boolean;
+    /**
+     * Whether the document is a single empty text block, as a new one is.
+     * Hosts show a placeholder then.
+     */
+    isEmpty(): boolean;
+    /**
+     * Whether `(x, y)` is inside a non-empty selection, where a press starts
+     * dragging the selection rather than selecting.
+     */
+    isInSelection(x: number, y: number): boolean;
+    /**
+     * Whether the editor holds a shared document, as it does once the
+     * server's state has arrived.
+     */
+    isShared(): boolean;
+    /**
+     * Start joining a shared document as yrs client `client_id`, which must
+     * be unique among the room's peers. Returns the message to send the
+     * server first. The current document stays on screen until the
+     * server's state arrives in [`WebEditor::receive_sync`].
+     */
+    join(client_id: number): Uint8Array;
+    /**
+     * Run the key binding for `key`, a DOM `KeyboardEvent.key`, with
+     * `modifiers` (bits: 1 Shift, 2 Ctrl, 4 Alt, 8 Meta). Returns whether a
+     * binding applied; when none did, the host lets the browser handle the
+     * key.
+     */
+    keyDown(key: string, modifiers: number): boolean;
+    /**
+     * Replace the document with `input` read as `format` (`json`, `html`,
+     * `markdown`, or `text`).
+     */
+    load(format: string, input: string): void;
+    /**
+     * An editor painting on `canvas`, measuring through `measurer`, with the
+     * named extensions and JSON `options` (see `@canvist/web`'s
+     * `EditorOptions`).
+     */
+    constructor(canvas: HTMLCanvasElement, measurer: HostMeasurer, extensions: string[], options: string);
+    /**
+     * Paste HTML over the selection.
+     * Excessive nesting throws a `parse` error without changing the document.
+     */
+    pasteHtml(html: string): boolean;
+    /**
+     * Paste plain text over the selection; paste rules apply.
+     */
+    pasteText(text: string): boolean;
+    /**
+     * Press the pointer at document coordinates `(x, y)`. One click places
+     * the caret, or extends the selection with `extend`; two select a word
+     * and three the whole text block, and dragging afterwards extends by
+     * that unit.
+     */
+    pointerDown(x: number, y: number, extend: boolean, clicks: number): boolean;
+    /**
+     * Move a pressed pointer to `(x, y)`, extending the selection from the
+     * press.
+     */
+    pointerMove(x: number, y: number): boolean;
+    /**
+     * Release the pointer.
+     */
+    pointerUp(): void;
+    /**
+     * Answer the query an extension registered as `name`, as JSON.
+     */
+    query(name: string, args: string): string;
+    /**
+     * Handle one binary y-sync message from the server, as
+     * `[replies, changed]`: the messages to send back, and whether the
+     * document changed, in which case the next frame shows it.
+     */
+    receiveSync(message: Uint8Array): [replies: Uint8Array[], changed: boolean];
+    /**
+     * Redo the last undone change.
+     */
+    redo(): boolean;
+    /**
+     * Replace UTF-16 range `start..end` of the head's text block with
+     * `text`, as an input method or the platform's text input does. A
+     * replacement at a caret is typing, so input rules apply.
+     */
+    replaceText(start: number, end: number, text: string): boolean;
+    /**
+     * Size the canvas: `width` and `height` in CSS pixels, `scale` device
+     * pixels per CSS pixel, and the backing store in device pixels. The
+     * document is laid out to `width`.
+     */
+    resize(width: number, height: number, scale: number, pixel_width: number, pixel_height: number): void;
+    /**
+     * Run the command an extension registered as `name`, with JSON `args`
+     * (`null` for none). Returns whether it applied.
+     */
+    run(name: string, args: string): boolean;
+    /**
+     * Select from (`anchor_path`, `anchor_offset`) to (`head_path`,
+     * `head_offset`). Offsets count UTF-16 code units.
+     */
+    select(anchor_path: Uint32Array, anchor_offset: number, head_path: Uint32Array, head_offset: number): void;
+    /**
+     * The smallest rectangle around the selection in document coordinates,
+     * as `[x, y, width, height]`: the caret's rectangle for a caret, and
+     * empty while the selection is not laid out. Hosts anchor menus to it.
+     */
+    selectionBounds(): Float32Array;
+    /**
+     * The anchor and head as JSON positions, or `null` for a block
+     * selection.
+     */
+    selection(): string;
+    /**
+     * Snap border widths down to `scale` device pixels per CSS pixel, as
+     * this browser draws them, or not at all when `scale` is not positive.
+     */
+    setBorderScale(scale: number): void;
+    /**
+     * Blink the caret.
+     */
+    setCaretOn(on: boolean): void;
+    /**
+     * Show `text` as IME preedit text at the selection, replacing any
+     * earlier preedit.
+     */
+    setComposition(text: string): boolean;
+    /**
+     * Show or hide the caret: hosts call this on focus and blur.
+     */
+    setFocused(focused: boolean): void;
+    /**
+     * Snap text baselines and rectangle edges to the grid the browser
+     * snaps DOM content to: `"device"` pixels, or `"css"` pixels for
+     * Chromium laying out in CSS units on a high-density screen.
+     */
+    setPixelGrid(grid: string): void;
+    /**
+     * Scroll so document coordinate `top` is at the canvas's top edge.
+     */
+    setTop(top: number): void;
+    /**
+     * Measurement and cache statistics as JSON: cache hits and misses,
+     * cached bytes per font, and how many segments and batches the browser
+     * measured. The host derives the hit rate, so no float is formatted here
+     * (see `canvist_layout::css_number`).
+     */
+    stats(): string;
+    /**
+     * The whole document as an SVG image painted from the same display
+     * list as the canvas. Lays out every block first.
+     */
+    svg(): string;
+    /**
+     * The message to send a server on reconnecting: sync step 1, which asks
+     * for what this editor missed.
+     */
+    syncStart(): Uint8Array;
+    /**
+     * Undo the last change. A shared document undoes only this editor's
+     * own changes.
+     */
+    undo(): boolean;
+}
+
+export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+
+export interface InitOutput {
+    readonly memory: WebAssembly.Memory;
+    readonly __wbg_webeditor_free: (a: number, b: number) => void;
+    readonly webeditor_bodyStyle: (a: number) => [number, number];
+    readonly webeditor_can: (a: number, b: number, c: number, d: number, e: number) => [number, number, number];
+    readonly webeditor_caretRect: (a: number) => [number, number];
+    readonly webeditor_caretRectAt: (a: number, b: number, c: number, d: number) => [number, number];
+    readonly webeditor_characterBounds: (a: number, b: number, c: number) => [number, number];
+    readonly webeditor_commitComposition: (a: number, b: number, c: number) => [number, number, number];
+    readonly webeditor_copySelection: (a: number) => [number, number, number, number];
+    readonly webeditor_cutSelection: (a: number) => [number, number, number, number];
+    readonly webeditor_dropAt: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number) => [number, number, number];
+    readonly webeditor_editContextState: (a: number) => any;
+    readonly webeditor_export: (a: number, b: number, c: number) => [number, number, number, number];
+    readonly webeditor_flushSync: (a: number) => [number, number, number];
+    readonly webeditor_fonts: (a: number) => [number, number];
+    readonly webeditor_fontsLoaded: (a: number, b: number, c: number) => number;
+    readonly webeditor_forgetMeasurements: (a: number) => void;
+    readonly webeditor_frame: (a: number) => [number, number, number, number];
+    readonly webeditor_geometry: (a: number) => [number, number, number, number];
+    readonly webeditor_hideFamilies: (a: number, b: number, c: number) => void;
+    readonly webeditor_html: (a: number) => [number, number];
+    readonly webeditor_insertText: (a: number, b: number, c: number) => [number, number, number];
+    readonly webeditor_isEmpty: (a: number) => number;
+    readonly webeditor_isInSelection: (a: number, b: number, c: number) => number;
+    readonly webeditor_isShared: (a: number) => number;
+    readonly webeditor_join: (a: number, b: number) => [number, number];
+    readonly webeditor_keyDown: (a: number, b: number, c: number, d: number) => [number, number, number];
+    readonly webeditor_load: (a: number, b: number, c: number, d: number, e: number) => [number, number];
+    readonly webeditor_new: (a: any, b: any, c: number, d: number, e: number, f: number) => [number, number, number];
+    readonly webeditor_pasteHtml: (a: number, b: number, c: number) => [number, number, number];
+    readonly webeditor_pasteText: (a: number, b: number, c: number) => [number, number, number];
+    readonly webeditor_pointerDown: (a: number, b: number, c: number, d: number, e: number) => [number, number, number];
+    readonly webeditor_pointerMove: (a: number, b: number, c: number) => [number, number, number];
+    readonly webeditor_pointerUp: (a: number) => void;
+    readonly webeditor_query: (a: number, b: number, c: number, d: number, e: number) => [number, number, number, number];
+    readonly webeditor_receiveSync: (a: number, b: number, c: number) => [number, number, number];
+    readonly webeditor_redo: (a: number) => [number, number, number];
+    readonly webeditor_replaceText: (a: number, b: number, c: number, d: number, e: number) => [number, number, number];
+    readonly webeditor_resize: (a: number, b: number, c: number, d: number, e: number, f: number) => void;
+    readonly webeditor_run: (a: number, b: number, c: number, d: number, e: number) => [number, number, number];
+    readonly webeditor_select: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => [number, number];
+    readonly webeditor_selection: (a: number) => [number, number];
+    readonly webeditor_selectionBounds: (a: number) => [number, number];
+    readonly webeditor_setBorderScale: (a: number, b: number) => void;
+    readonly webeditor_setCaretOn: (a: number, b: number) => void;
+    readonly webeditor_setComposition: (a: number, b: number, c: number) => [number, number, number];
+    readonly webeditor_setFocused: (a: number, b: number) => void;
+    readonly webeditor_setPixelGrid: (a: number, b: number, c: number) => [number, number];
+    readonly webeditor_setTop: (a: number, b: number) => void;
+    readonly webeditor_stats: (a: number) => [number, number];
+    readonly webeditor_svg: (a: number) => [number, number, number, number];
+    readonly webeditor_syncStart: (a: number) => [number, number, number, number];
+    readonly webeditor_undo: (a: number) => [number, number, number];
+    readonly __wbindgen_malloc: (a: number, b: number) => number;
+    readonly __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
+    readonly __wbindgen_exn_store: (a: number) => void;
+    readonly __externref_table_alloc: () => number;
+    readonly __wbindgen_externrefs: WebAssembly.Table;
+    readonly __externref_drop_slice: (a: number, b: number) => void;
+    readonly __wbindgen_free: (a: number, b: number, c: number) => void;
+    readonly __externref_table_dealloc: (a: 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>;