@loro-dev/flock-wasm 0.1.0

package/web/flock_wasm.d.ts

@@ -0,0 +1,377 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Initializes the WASM module.
+ *
+ * This function is automatically called when the WASM module is loaded.
+ * It sets up the panic hook to route Rust panics to the JavaScript console.
+ */
+export function start(): void;
+/**
+ * Drains the pending callback queue, invoking all enqueued callbacks.
+ *
+ * This function is exported to JavaScript and can be called manually,
+ * but is typically invoked automatically via microtasks.
+ *
+ * Callbacks are invoked sequentially. If any callback throws an error,
+ * the error is propagated to JavaScript after the current batch completes.
+ */
+export function callPendingEvents(): void;
+/**
+ * The main WASM-exposed flock instance.
+ *
+ * Wraps the underlying [`flock::Flock`] and provides JavaScript-compatible
+ * methods for all CRDT operations including put, get, delete, scan, merge,
+ * import/export, and event subscription.
+ */
+export class RawFlock {
+  free(): void;
+  /**
+   * Commits the current transaction.
+   *
+   * Flushes all buffered operations and delivers batched events.
+   *
+   * # Errors
+   *
+   * Returns an error if no transaction is active or if commit fails.
+   */
+  txnCommit(): void;
+  exportFile(): Uint8Array;
+  /**
+   * Exports the current state as a JSON bundle.
+   *
+   * # Arguments
+   *
+   * * `from` - Optional version vector for incremental export
+   * * `prune_tombstones_before` - Optional timestamp to prune tombstones older than this
+   * * `peer_id` - Optional peer ID filter to only export entries from this peer
+   *
+   * # Returns
+   *
+   * An export bundle containing entries and version information.
+   *
+   * # Errors
+   *
+   * Returns an error if arguments are invalid or serialization fails.
+   */
+  exportJson(from: any, prune_tombstones_before: any, peer_id: any): any;
+  /**
+   * Imports a JSON bundle into this flock instance.
+   *
+   * # Arguments
+   *
+   * * `bundle` - The export bundle to import
+   *
+   * # Returns
+   *
+   * An import report containing counts of accepted and skipped entries.
+   *
+   * # Errors
+   *
+   * Returns an error if the bundle is invalid or import fails.
+   */
+  importJson(bundle: any): any;
+  /**
+   * Sets a new peer ID for this flock instance.
+   *
+   * # Arguments
+   *
+   * * `peer_id` - The new peer ID to set
+   *
+   * # Errors
+   *
+   * Returns an error if the peer ID is invalid.
+   */
+  setPeerId(peer_id: string): void;
+  /**
+   * Unsubscribes from change events.
+   *
+   * # Arguments
+   *
+   * * `id` - The subscription ID returned from `subscribe`
+   *
+   * # Returns
+   *
+   * `true` if a subscription was removed, `false` if the ID was not found.
+   */
+  unsubscribe(id: number): boolean;
+  /**
+   * Rolls back the current transaction.
+   *
+   * Discards all buffered operations since `txnBegin` was called.
+   * Note: Data changes are not rolled back, only event emission is affected.
+   */
+  txnRollback(): void;
+  /**
+   * Stores a value with associated metadata at the specified key.
+   *
+   * # Arguments
+   *
+   * * `key` - The key as a JSON array
+   * * `value` - The value to store
+   * * `metadata` - Optional metadata object to associate with this entry
+   * * `now` - Optional timestamp in milliseconds
+   *
+   * # Errors
+   *
+   * Returns an error if any argument is invalid or the operation fails.
+   */
+  putWithMeta(key: any, value: any, metadata: any, now: any): void;
+  /**
+   * Returns the inclusive version vector for this flock.
+   *
+   * The inclusive version includes all peers ever seen, even if their
+   * entries have been overridden by other peers.
+   *
+   * # Errors
+   *
+   * Returns an error if serialization fails.
+   */
+  inclusiveVersion(): any;
+  /**
+   * Returns the maximum physical time across all entries in this flock.
+   *
+   * This is useful for determining a safe timestamp for tombstone pruning.
+   */
+  getMaxPhysicalTime(): number;
+  /**
+   * Retrieves the value at the specified key.
+   *
+   * Returns `undefined` if the key doesn't exist or has been deleted.
+   *
+   * # Arguments
+   *
+   * * `key` - The key as a JSON array
+   *
+   * # Errors
+   *
+   * Returns an error if serialization of the result fails.
+   */
+  get(key: any): any;
+  /**
+   * Creates a new WASM flock instance with the given peer ID.
+   *
+   * The instance is created in buffered mode with memtable enabled.
+   * Use transactions (`txnBegin` + `txnCommit`) to flush buffered writes explicitly.
+   *
+   * # Arguments
+   *
+   * * `peer_id` - The unique identifier for this peer
+   *
+   * # Errors
+   *
+   * Returns an error if the peer ID is invalid or if instance creation fails.
+   */
+  constructor(peer_id: string);
+  /**
+   * Stores a value at the specified key.
+   *
+   * # Arguments
+   *
+   * * `key` - The key as a JSON array
+   * * `value` - The value to store (any JSON-serializable value)
+   * * `now` - Optional timestamp in milliseconds (uses current time if undefined)
+   *
+   * # Errors
+   *
+   * Returns an error if the key or value is invalid, or if the operation fails.
+   */
+  put(key: any, value: any, now: any): void;
+  /**
+   * Scans entries within the specified bounds and prefix.
+   *
+   * # Arguments
+   *
+   * * `start` - Optional start bound (inclusive/exclusive/unbounded)
+   * * `end` - Optional end bound
+   * * `prefix` - Optional key prefix to filter by
+   *
+   * # Returns
+   *
+   * An array of scan rows containing keys, values, and raw records.
+   *
+   * # Errors
+   *
+   * Returns an error if scan bounds are invalid or serialization fails.
+   */
+  scan(start: any, end: any, prefix: any): any;
+  /**
+   * Merges state from another flock instance into this one.
+   *
+   * # Arguments
+   *
+   * * `other` - The other flock instance to merge from
+   *
+   * # Returns
+   *
+   * An import report containing counts of accepted and skipped entries.
+   *
+   * # Errors
+   *
+   * Returns an error if the merge operation fails.
+   */
+  merge(other: RawFlock): any;
+  /**
+   * Deletes the value at the specified key (creates a tombstone).
+   *
+   * # Arguments
+   *
+   * * `key` - The key as a JSON array
+   * * `now` - Optional timestamp in milliseconds
+   *
+   * # Errors
+   *
+   * Returns an error if the key is invalid or the operation fails.
+   */
+  delete(key: any, now: any): void;
+  /**
+   * Returns the current peer ID of this flock instance.
+   */
+  peerId(): string;
+  /**
+   * Returns the exclusive version vector for this flock.
+   *
+   * The exclusive version only includes peers that have at least one entry
+   * in the current state (excluding tombstones and overridden entries).
+   *
+   * # Errors
+   *
+   * Returns an error if serialization fails.
+   */
+  version(): any;
+  /**
+   * Creates a new flock instance from a file bytes array.
+   *
+   * # Arguments
+   *
+   * * `peer_id` - The peer ID for the new instance
+   * * `bytes` - The file contents as a Uint8Array
+   *
+   * # Errors
+   *
+   * Returns an error if the file format is invalid or loading fails.
+   */
+  static fromFile(peer_id: string, bytes: Uint8Array): RawFlock;
+  /**
+   * Creates a new flock instance from a JSON export bundle.
+   *
+   * # Arguments
+   *
+   * * `bundle` - The export bundle as a JavaScript object
+   * * `peer_id` - The peer ID for the new instance
+   *
+   * # Errors
+   *
+   * Returns an error if the bundle is invalid or import fails.
+   */
+  static fromJson(bundle: any, peer_id: string): RawFlock;
+  /**
+   * Retrieves complete entry information including data, metadata, and clock.
+   *
+   * Returns `undefined` if the key doesn't exist.
+   *
+   * # Arguments
+   *
+   * * `key` - The key as a JSON array
+   *
+   * # Errors
+   *
+   * Returns an error if serialization of the result fails.
+   */
+  getEntry(key: any): any;
+  /**
+   * Returns whether a transaction is currently active.
+   */
+  isInTxn(): boolean;
+  /**
+   * Subscribes to change events from this flock instance.
+   *
+   * # Arguments
+   *
+   * * `listener` - A JavaScript function that will be called with event batches
+   *
+   * # Returns
+   *
+   * A subscription ID that can be used to unsubscribe later.
+   *
+   * # Errors
+   *
+   * Returns an error if the subscription fails or the ID overflows.
+   */
+  subscribe(listener: Function): number;
+  /**
+   * Begins a transaction.
+   *
+   * All subsequent put/delete operations will be buffered until `txnCommit`
+   * is called. Events will be batched and delivered as a single batch on commit.
+   *
+   * # Errors
+   *
+   * Returns an error if a transaction is already active or if begin fails.
+   */
+  txnBegin(): void;
+}
+
+export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+
+export interface InitOutput {
+  readonly memory: WebAssembly.Memory;
+  readonly __wbg_rawflock_free: (a: number, b: number) => void;
+  readonly callPendingEvents: () => void;
+  readonly rawflock_delete: (a: number, b: any, c: any) => [number, number];
+  readonly rawflock_exportFile: (a: number) => [number, number, number, number];
+  readonly rawflock_exportJson: (a: number, b: any, c: any, d: any) => [number, number, number];
+  readonly rawflock_fromFile: (a: number, b: number, c: number, d: number) => [number, number, number];
+  readonly rawflock_fromJson: (a: any, b: number, c: number) => [number, number, number];
+  readonly rawflock_get: (a: number, b: any) => [number, number, number];
+  readonly rawflock_getEntry: (a: number, b: any) => [number, number, number];
+  readonly rawflock_getMaxPhysicalTime: (a: number) => number;
+  readonly rawflock_importJson: (a: number, b: any) => [number, number, number];
+  readonly rawflock_inclusiveVersion: (a: number) => [number, number, number];
+  readonly rawflock_isInTxn: (a: number) => number;
+  readonly rawflock_merge: (a: number, b: number) => [number, number, number];
+  readonly rawflock_new: (a: number, b: number) => [number, number, number];
+  readonly rawflock_peerId: (a: number) => [number, number];
+  readonly rawflock_put: (a: number, b: any, c: any, d: any) => [number, number];
+  readonly rawflock_putWithMeta: (a: number, b: any, c: any, d: any, e: any) => [number, number];
+  readonly rawflock_scan: (a: number, b: any, c: any, d: any) => [number, number, number];
+  readonly rawflock_setPeerId: (a: number, b: number, c: number) => [number, number];
+  readonly rawflock_subscribe: (a: number, b: any) => [number, number, number];
+  readonly rawflock_txnBegin: (a: number) => [number, number];
+  readonly rawflock_txnCommit: (a: number) => [number, number];
+  readonly rawflock_txnRollback: (a: number) => void;
+  readonly rawflock_unsubscribe: (a: number, b: number) => number;
+  readonly rawflock_version: (a: number) => [number, number, number];
+  readonly start: () => void;
+  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_export_4: WebAssembly.Table;
+  readonly __wbindgen_free: (a: number, b: number, c: number) => void;
+  readonly __wbindgen_export_6: WebAssembly.Table;
+  readonly __externref_table_dealloc: (a: number) => void;
+  readonly closure38_externref_shim: (a: number, b: number, c: any) => 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>;