@crdt-sync/core 0.3.1 → 0.3.3

package/pkg/web/crdt_sync.d.ts

@@ -1,24 +1,145 @@
 /* tslint:disable */
 /* eslint-disable */
+
 /**
- * Type declarations for the @crdt-sync/core WASM stub.
+ * A WebAssembly-compatible wrapper around [`StateStore`].
  *
- * These types match the interface generated by wasm-bindgen.
- * Replace this file with the real wasm-pack output when building for production.
+ * Methods accept and return JSON-encoded strings at the Wasm boundary so that
+ * [`Envelope`] payloads and CRDT values can be exchanged between Rust and
+ * JavaScript without sharing memory structures directly.
  */
-
 export class WasmStateStore {
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Apply a remote [`Envelope`] (serialised as a JSON string) to this store.
+     *
+     * Throws a JavaScript error if the JSON cannot be deserialised.
+     */
+    apply_envelope(envelope_json: string): void;
+    /**
+     * Return the current Lamport clock value.
+     *
+     * Returned as `f64` because JavaScript's `Number` type cannot safely
+     * represent all `u64` values.  Values up to `2^53 − 1`
+     * (`Number.MAX_SAFE_INTEGER`) are represented exactly.  For distributed
+     * systems that could conceivably tick the clock beyond that threshold,
+     * treat the returned value as approximate or use `BigInt` on the JS side.
+     */
+    clock(): number;
+    /**
+     * Read the current value of a named LWW register as a JSON string.
+     *
+     * Returns `undefined` in JavaScript if the key has never been written.
+     */
+    get_register(key: string): string | undefined;
+    /**
+     * Create a new `WasmStateStore` for the given node identifier.
+     */
     constructor(node_id: string);
+    /**
+     * Delete the element at visible `index` in the named RGA sequence.
+     *
+     * Returns the resulting [`Envelope`] as a JSON string, or `undefined` if
+     * `index` is out of bounds.
+     */
+    seq_delete(key: string, index: number): string | undefined;
+    /**
+     * Insert a JSON-encoded element at `index` in the named RGA sequence.
+     *
+     * Returns the resulting [`Envelope`] as a JSON string.
+     */
+    seq_insert(key: string, index: number, value_json: string): string;
+    /**
+     * Return all visible elements of the named sequence as a JSON array string.
+     *
+     * Throws a JavaScript error if serialisation fails.
+     */
+    seq_items(key: string): string;
+    /**
+     * Return the number of visible elements in the named sequence.
+     */
+    seq_len(key: string): number;
+    /**
+     * Add a JSON-encoded element to the named OR-Set.
+     *
+     * Returns the resulting [`Envelope`] as a JSON string.
+     */
+    set_add(key: string, value_json: string): string;
+    /**
+     * Returns `true` if the named OR-Set contains the JSON-encoded `value`.
+     */
+    set_contains(key: string, value_json: string): boolean;
+    /**
+     * Return all elements of the named OR-Set as a JSON array string.
+     *
+     * Throws a JavaScript error if serialisation fails.
+     */
+    set_items(key: string): string;
+    /**
+     * Write a JSON-encoded value to the named LWW register.
+     *
+     * Returns the resulting [`Envelope`] serialised as a JSON string, ready
+     * to broadcast to peer nodes.
+     */
     set_register(key: string, value_json: string): string;
-    get_register(key: string): string | undefined;
-    apply_envelope(envelope_json: string): void;
+    /**
+     * Remove a JSON-encoded element from the named OR-Set.
+     *
+     * Returns the resulting [`Envelope`] as a JSON string, or `undefined` if
+     * the element was not present in the set.
+     *
+     * Throws a JavaScript error if `value_json` is not valid JSON.
+     */
+    set_remove(key: string, value_json: string): string | undefined;
+}
+
+export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+
+export interface InitOutput {
+    readonly memory: WebAssembly.Memory;
+    readonly __wbg_wasmstatestore_free: (a: number, b: number) => void;
+    readonly wasmstatestore_apply_envelope: (a: number, b: number, c: number) => [number, number];
+    readonly wasmstatestore_clock: (a: number) => number;
+    readonly wasmstatestore_get_register: (a: number, b: number, c: number) => [number, number];
+    readonly wasmstatestore_new: (a: number, b: number) => number;
+    readonly wasmstatestore_seq_delete: (a: number, b: number, c: number, d: number) => [number, number];
+    readonly wasmstatestore_seq_insert: (a: number, b: number, c: number, d: number, e: number, f: number) => [number, number, number, number];
+    readonly wasmstatestore_seq_items: (a: number, b: number, c: number) => [number, number, number, number];
+    readonly wasmstatestore_seq_len: (a: number, b: number, c: number) => number;
+    readonly wasmstatestore_set_add: (a: number, b: number, c: number, d: number, e: number) => [number, number, number, number];
+    readonly wasmstatestore_set_contains: (a: number, b: number, c: number, d: number, e: number) => number;
+    readonly wasmstatestore_set_items: (a: number, b: number, c: number) => [number, number, number, number];
+    readonly wasmstatestore_set_register: (a: number, b: number, c: number, d: number, e: number) => [number, number, number, number];
+    readonly wasmstatestore_set_remove: (a: number, b: number, c: number, d: number, e: 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 InitInput =
-    | RequestInfo
-    | URL
-    | Response
-    | BufferSource
-    | WebAssembly.Module;
+export type SyncInitInput = BufferSource | WebAssembly.Module;
 
-export default function init(input?: InitInput | Promise<InitInput>): Promise<void>;
+/**
+ * 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>;