hermes-wasm 0.1.0

package/hermes_wasm.d.ts

@@ -0,0 +1,289 @@
+/* tslint:disable */
+/* eslint-disable */
+
+export class IndexRegistry {
+  free(): void;
+  [Symbol.dispose](): void;
+  /**
+   * Add a remote index
+   */
+  add_remote(name: string, base_url: string): Promise<void>;
+  constructor();
+  /**
+   * List index names
+   */
+  list(): any;
+  /**
+   * Remove an index
+   */
+  remove(name: string): void;
+  /**
+   * Search an index by name
+   */
+  search(index_name: string, text: string, limit: number): Promise<any>;
+}
+
+export class IpfsIndex {
+  free(): void;
+  [Symbol.dispose](): void;
+  /**
+   * Get cache statistics
+   */
+  cache_stats(): any;
+  /**
+   * Get field names
+   */
+  field_names(): any;
+  /**
+   * Export cache
+   */
+  export_cache(): Uint8Array | undefined;
+  /**
+   * Get a document by address
+   */
+  get_document(segment_id: string, doc_id: number): Promise<any>;
+  /**
+   * Import cache
+   */
+  import_cache(data: Uint8Array): void;
+  /**
+   * Get number of segments
+   */
+  num_segments(): number;
+  /**
+   * Get default fields
+   */
+  default_fields(): any;
+  /**
+   * Clear IndexedDB cache
+   */
+  clear_idb_cache(): Promise<void>;
+  /**
+   * Create with custom cache size
+   */
+  static with_cache_size(base_path: string, cache_size: number): IpfsIndex;
+  /**
+   * Save cache to IndexedDB
+   */
+  save_cache_to_idb(): Promise<void>;
+  /**
+   * Load cache from IndexedDB
+   */
+  load_cache_from_idb(): Promise<boolean>;
+  /**
+   * Create a new IPFS index
+   *
+   * @param base_path - The IPFS path (e.g., "/ipfs/Qm..." or "/ipns/...")
+   */
+  constructor(base_path: string);
+  /**
+   * Load index using JavaScript fetch functions
+   *
+   * @param fetch_fn - JS function: (path: string) => Promise<Uint8Array>
+   * @param size_fn - JS function: (path: string) => Promise<number>
+   */
+  load(fetch_fn: Function, size_fn: Function): Promise<void>;
+  /**
+   * Search the index
+   */
+  search(query_str: string, limit: number): Promise<any>;
+  /**
+   * Get number of documents
+   */
+  num_docs(): number;
+}
+
+export class RemoteIndex {
+  free(): void;
+  [Symbol.dispose](): void;
+  /**
+   * Get cache statistics
+   */
+  cache_stats(): any;
+  /**
+   * Get field names
+   */
+  field_names(): any;
+  /**
+   * Export the current slice cache as bytes
+   *
+   * Returns the serialized cache data that can be stored in IndexedDB
+   * or other persistent storage for later restoration.
+   */
+  export_cache(): Uint8Array | undefined;
+  /**
+   * Get a document by its address (segment_id + doc_id)
+   *
+   * Returns the document as a JSON object, or null if not found.
+   */
+  get_document(segment_id: string, doc_id: number): Promise<any>;
+  /**
+   * Import a previously exported slice cache
+   *
+   * Merges the cached slices into the current cache, reducing
+   * network requests for previously fetched data.
+   */
+  import_cache(data: Uint8Array): void;
+  /**
+   * Get number of segments
+   */
+  num_segments(): number;
+  /**
+   * Get network statistics (requests made, bytes transferred, etc.)
+   */
+  network_stats(): any;
+  /**
+   * Get default field names for query parsing
+   */
+  default_fields(): any;
+  /**
+   * Clear the persisted cache from IndexedDB
+   */
+  clear_idb_cache(): Promise<void>;
+  /**
+   * Create with custom cache size (in bytes)
+   */
+  static with_cache_size(base_url: string, cache_size: number): RemoteIndex;
+  /**
+   * Save the slice cache to IndexedDB for persistence across sessions
+   *
+   * The cache is stored under a key derived from the base URL.
+   */
+  save_cache_to_idb(): Promise<void>;
+  /**
+   * Load the slice cache from IndexedDB
+   *
+   * Call this after load() to restore cached data from a previous session.
+   */
+  load_cache_from_idb(): Promise<boolean>;
+  /**
+   * Reset network statistics
+   */
+  reset_network_stats(): void;
+  /**
+   * Create a new remote index pointing to a URL
+   */
+  constructor(base_url: string);
+  /**
+   * Load index from URL using hermes-core Index with slice caching
+   *
+   * Automatically attempts to load the slice cache file (index.slicecache)
+   * to prefill the cache with hot data, reducing cold-start latency.
+   */
+  load(): Promise<void>;
+  /**
+   * Search the index
+   *
+   * Accepts both query language syntax (field:term, AND, OR, NOT, grouping)
+   * and simple text (tokenized and searched across default fields).
+   * Returns document addresses (segment_id + doc_id) without document content.
+   */
+  search(query_str: string, limit: number): Promise<any>;
+  /**
+   * Get number of documents
+   */
+  num_docs(): number;
+}
+
+/**
+ * Initialize panic hook and logging
+ */
+export function init(): void;
+
+/**
+ * Setup logging to browser console (can be called explicitly)
+ */
+export function setup_logging(): void;
+
+export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+
+export interface InitOutput {
+  readonly memory: WebAssembly.Memory;
+  readonly __wbg_ipfsindex_free: (a: number, b: number) => void;
+  readonly ipfsindex_cache_stats: (a: number) => any;
+  readonly ipfsindex_clear_idb_cache: (a: number) => any;
+  readonly ipfsindex_default_fields: (a: number) => any;
+  readonly ipfsindex_export_cache: (a: number) => [number, number];
+  readonly ipfsindex_field_names: (a: number) => any;
+  readonly ipfsindex_get_document: (a: number, b: number, c: number, d: number) => any;
+  readonly ipfsindex_import_cache: (a: number, b: number, c: number) => [number, number];
+  readonly ipfsindex_load: (a: number, b: any, c: any) => any;
+  readonly ipfsindex_load_cache_from_idb: (a: number) => any;
+  readonly ipfsindex_new: (a: number, b: number) => number;
+  readonly ipfsindex_num_docs: (a: number) => number;
+  readonly ipfsindex_num_segments: (a: number) => number;
+  readonly ipfsindex_save_cache_to_idb: (a: number) => any;
+  readonly ipfsindex_search: (a: number, b: number, c: number, d: number) => any;
+  readonly ipfsindex_with_cache_size: (a: number, b: number, c: number) => number;
+  readonly init: () => void;
+  readonly setup_logging: () => void;
+  readonly __wbg_indexregistry_free: (a: number, b: number) => void;
+  readonly indexregistry_add_remote: (a: number, b: number, c: number, d: number, e: number) => any;
+  readonly indexregistry_list: (a: number) => any;
+  readonly indexregistry_new: () => number;
+  readonly indexregistry_remove: (a: number, b: number, c: number) => void;
+  readonly indexregistry_search: (a: number, b: number, c: number, d: number, e: number, f: number) => any;
+  readonly __wbg_remoteindex_free: (a: number, b: number) => void;
+  readonly remoteindex_cache_stats: (a: number) => any;
+  readonly remoteindex_clear_idb_cache: (a: number) => any;
+  readonly remoteindex_default_fields: (a: number) => any;
+  readonly remoteindex_export_cache: (a: number) => [number, number];
+  readonly remoteindex_field_names: (a: number) => any;
+  readonly remoteindex_get_document: (a: number, b: number, c: number, d: number) => any;
+  readonly remoteindex_import_cache: (a: number, b: number, c: number) => [number, number];
+  readonly remoteindex_load: (a: number) => any;
+  readonly remoteindex_load_cache_from_idb: (a: number) => any;
+  readonly remoteindex_network_stats: (a: number) => any;
+  readonly remoteindex_new: (a: number, b: number) => number;
+  readonly remoteindex_num_docs: (a: number) => number;
+  readonly remoteindex_num_segments: (a: number) => number;
+  readonly remoteindex_reset_network_stats: (a: number) => void;
+  readonly remoteindex_save_cache_to_idb: (a: number) => any;
+  readonly remoteindex_search: (a: number, b: number, c: number, d: number) => any;
+  readonly remoteindex_with_cache_size: (a: number, b: number, c: number) => number;
+  readonly rust_zstd_wasm_shim_calloc: (a: number, b: number) => number;
+  readonly rust_zstd_wasm_shim_free: (a: number) => void;
+  readonly rust_zstd_wasm_shim_malloc: (a: number) => number;
+  readonly rust_zstd_wasm_shim_memcmp: (a: number, b: number, c: number) => number;
+  readonly rust_zstd_wasm_shim_memcpy: (a: number, b: number, c: number) => number;
+  readonly rust_zstd_wasm_shim_memmove: (a: number, b: number, c: number) => number;
+  readonly rust_zstd_wasm_shim_memset: (a: number, b: number, c: number) => number;
+  readonly rust_zstd_wasm_shim_qsort: (a: number, b: number, c: number, d: number) => void;
+  readonly wasm_bindgen__convert__closures_____invoke__hf0ae6e1302402218: (a: number, b: number, c: any) => void;
+  readonly wasm_bindgen__closure__destroy__he02095c7bca1c472: (a: number, b: number) => void;
+  readonly wasm_bindgen__convert__closures_____invoke__he0fab6886ed0c11a: (a: number, b: number, c: any) => void;
+  readonly wasm_bindgen__closure__destroy__h3d8374674b985d9e: (a: number, b: number) => void;
+  readonly wasm_bindgen__convert__closures_____invoke__hb63c839732b74d13: (a: number, b: number) => void;
+  readonly wasm_bindgen__closure__destroy__h1bff8044f851153e: (a: number, b: number) => void;
+  readonly wasm_bindgen__convert__closures_____invoke__h24eb9da7cece06fa: (a: number, b: number, c: any, d: any) => 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_externrefs: WebAssembly.Table;
+  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>;