@morphemeris/armilla-core 0.1.0

package/wasm-web/armilla_wasm.d.ts

@@ -0,0 +1,150 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Encode a view state as a URL-safe bookmark string (spec §11.5).
+ *
+ * # Errors
+ *
+ * The §15 `Error` record as a JSON string when the view state is invalid.
+ */
+export function bookmark(view_state: string): string;
+
+/**
+ * The compiled-in default theme as JSON (spec §10.2).
+ */
+export function default_theme(): string;
+
+/**
+ * Report which rule set a resolved property (spec §13.4).
+ *
+ * # Errors
+ *
+ * The §15 `Error` record as a JSON string.
+ */
+export function explain(scene: string, theme_chain: string, mark_id: string, property: string): string;
+
+/**
+ * Lay out a chart input under a theme chain, view state, environment, and
+ * panel options; returns the scene as JSON (spec §13.5 `layout`).
+ *
+ * # Errors
+ *
+ * The §15 `Error` record as a JSON string.
+ */
+export function layout(chart_input: string, theme_chain: string, view_state: string, environment: string, options: string): string;
+
+/**
+ * Lint a theme chain; returns the findings as a JSON array (spec §10.7).
+ *
+ * # Errors
+ *
+ * The §15 `Error` record as a JSON string when the chain does not parse.
+ */
+export function lint(theme_chain: string): string;
+
+/**
+ * Build the map panels' line model (spec §12.2).
+ *
+ * # Errors
+ *
+ * The §15 `Error` record as a JSON string.
+ */
+export function map_lines(chart_input: string, view_state: string, environment: string): string;
+
+/**
+ * Migrate a document forward to the current schema version (spec §4.2).
+ *
+ * # Errors
+ *
+ * The §15 `Error` record as a JSON string.
+ */
+export function migrate(kind: string, doc: string): string;
+
+/**
+ * Paint a scene as an SVG document string (spec §14).
+ *
+ * # Errors
+ *
+ * The §15 `Error` record as a JSON string.
+ */
+export function paint_svg(scene: string, pack_manifests: string): string;
+
+/**
+ * Build a table panel's row model (spec §12.1).
+ *
+ * # Errors
+ *
+ * The §15 `Error` record as a JSON string.
+ */
+export function table_rows(chart_input: string, view_state: string, environment: string, options: string): string;
+
+/**
+ * Decode a bookmark back into a view state as JSON (spec §11.5).
+ *
+ * # Errors
+ *
+ * The §15 `Error` record as a JSON string.
+ */
+export function unbookmark(s: string): string;
+
+/**
+ * Parse and validate a workspace document, returning it normalized
+ * (spec §12): hosts consume workspaces; the core only checks them.
+ *
+ * # Errors
+ *
+ * The §15 `Error` record as a JSON string.
+ */
+export function validate_workspace(workspace: string): string;
+
+/**
+ * The core version, for provenance and binding checks.
+ */
+export function version(): string;
+
+export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+
+export interface InitOutput {
+    readonly memory: WebAssembly.Memory;
+    readonly bookmark: (a: number, b: number) => [number, number, number, number];
+    readonly default_theme: () => [number, number];
+    readonly explain: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number) => [number, number, number, number];
+    readonly layout: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number, j: number) => [number, number, number, number];
+    readonly lint: (a: number, b: number) => [number, number, number, number];
+    readonly map_lines: (a: number, b: number, c: number, d: number, e: number, f: number) => [number, number, number, number];
+    readonly migrate: (a: number, b: number, c: number, d: number) => [number, number, number, number];
+    readonly paint_svg: (a: number, b: number, c: number, d: number) => [number, number, number, number];
+    readonly table_rows: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number) => [number, number, number, number];
+    readonly unbookmark: (a: number, b: number) => [number, number, number, number];
+    readonly validate_workspace: (a: number, b: number) => [number, number, number, number];
+    readonly version: () => [number, number];
+    readonly __wbindgen_externrefs: WebAssembly.Table;
+    readonly __wbindgen_malloc: (a: number, b: number) => number;
+    readonly __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
+    readonly __externref_table_dealloc: (a: number) => void;
+    readonly __wbindgen_free: (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>;