@oxilite/d1 0.1.0

package/wasm/web/oxilite_wasm.d.ts

@@ -0,0 +1,173 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * The oxilite engine for one database.
+ */
+export class Engine {
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Inserts quads (JSON array of RDF/JS quads) atomically.
+     */
+    add(quads: string): Job;
+    /**
+     * Loads a document in several batches (not atomic), then refreshes statistics.
+     */
+    bulkLoad(data: string, format_name: string, base?: string | null, graph?: string | null): Job;
+    /**
+     * Removes every materialized inference.
+     */
+    clearInferences(): Job;
+    /**
+     * Removes everything.
+     */
+    clear(): Job;
+    /**
+     * Removes quads (JSON array of RDF/JS quads) atomically.
+     */
+    delete(quads: string): Job;
+    /**
+     * Serializes the dataset (or one graph, JSON graph term) in an RDF format.
+     */
+    dump(format_name: string, graph?: string | null): Job;
+    /**
+     * How an update would run (SQL per operation).
+     */
+    explainUpdate(sparql: string): string;
+    /**
+     * The SQL a query compiles to, with the planner's notes.
+     */
+    explain(sparql: string): string;
+    /**
+     * Does the store contain a quad (JSON RDF/JS quad)?
+     */
+    has(quad: string): Job;
+    /**
+     * Loads a document atomically (one batch). `graph` is a JSON graph term.
+     */
+    load(data: string, format_name: string, base?: string | null, graph?: string | null): Job;
+    /**
+     * Quads matching a pattern; each argument is a JSON term or null.
+     */
+    match(subject?: string | null, predicate?: string | null, object?: string | null, graph?: string | null): Job;
+    /**
+     * Computes the OWL 2 RL closure into the inference table (one batch per rule round);
+     * the result is `{"kind": "number"}`, the number of inferred triples.
+     */
+    materialize(): Job;
+    /**
+     * `capabilities` (JSON, optional) defaults to Cloudflare D1's; `options` (JSON,
+     * optional) are the store options, e.g. `{"graphIndex": false}`.
+     */
+    constructor(capabilities?: string | null, options?: string | null);
+    /**
+     * Loads planner statistics only (schema applied by a migration).
+     */
+    openExisting(): Job;
+    /**
+     * Creates the schema if needed and loads planner statistics.
+     */
+    open(): Job;
+    /**
+     * Recomputes planner statistics.
+     */
+    optimize(): Job;
+    /**
+     * A SPARQL query whose result is SPARQL 1.1 JSON results (`{"kind": "text", "value"}`).
+     */
+    queryJson(sparql: string): Job;
+    /**
+     * A SPARQL query. `options` (JSON) uses Oxigraph's JS names: `base_iri`,
+     * `use_default_graph_as_union`, `default_graph`, `named_graphs`, `results_format`. The
+     * result is `oxilite_core::json::output_to_json`, or `{"kind": "text"}` when a
+     * `results_format` is given.
+     */
+    query(sparql: string, options?: string | null): Job;
+    /**
+     * The schema as a SQL script (for `wrangler d1 migrations`).
+     */
+    schemaSql(): string;
+    /**
+     * Number of quads.
+     */
+    size(): Job;
+    /**
+     * A SPARQL update, applied as one atomic request (one D1 batch).
+     */
+    update(sparql: string, base_iri?: string | null): Job;
+}
+
+/**
+ * A resumable operation (see the crate documentation).
+ */
+export class Job {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Advances the job: `response` is the JSON response to the previous request (or null).
+     * Returns `{"execute": request}` or `{"done": value}` as JSON.
+     */
+    step(response?: string | null): string;
+}
+
+export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+
+export interface InitOutput {
+    readonly memory: WebAssembly.Memory;
+    readonly __wbg_engine_free: (a: number, b: number) => void;
+    readonly __wbg_job_free: (a: number, b: number) => void;
+    readonly engine_add: (a: number, b: number, c: number) => [number, number, number];
+    readonly engine_bulkLoad: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number) => [number, number, number];
+    readonly engine_clear: (a: number) => number;
+    readonly engine_clearInferences: (a: number) => number;
+    readonly engine_delete: (a: number, b: number, c: number) => [number, number, number];
+    readonly engine_dump: (a: number, b: number, c: number, d: number, e: number) => [number, number, number];
+    readonly engine_explain: (a: number, b: number, c: number) => [number, number, number, number];
+    readonly engine_explainUpdate: (a: number, b: number, c: number) => [number, number, number, number];
+    readonly engine_has: (a: number, b: number, c: number) => [number, number, number];
+    readonly engine_load: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number) => [number, number, number];
+    readonly engine_match: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number) => [number, number, number];
+    readonly engine_materialize: (a: number) => number;
+    readonly engine_new: (a: number, b: number, c: number, d: number) => [number, number, number];
+    readonly engine_open: (a: number) => number;
+    readonly engine_openExisting: (a: number) => number;
+    readonly engine_optimize: (a: number) => number;
+    readonly engine_query: (a: number, b: number, c: number, d: number, e: number) => [number, number, number];
+    readonly engine_queryJson: (a: number, b: number, c: number) => [number, number, number];
+    readonly engine_schemaSql: (a: number) => [number, number];
+    readonly engine_size: (a: number) => number;
+    readonly engine_update: (a: number, b: number, c: number, d: number, e: number) => [number, number, number];
+    readonly job_step: (a: number, b: number, c: number) => [number, number, number, number];
+    readonly __wbindgen_exn_store: (a: number) => void;
+    readonly __externref_table_alloc: () => 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>;