koru-delta 2.0.0

package/koru_delta.d.ts

@@ -0,0 +1,206 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Initialize panic hook for better error messages in the browser console
+ */
+export function init(): void;
+/**
+ * WASM-friendly wrapper around KoruDelta
+ */
+export class KoruDeltaWasm {
+  private constructor();
+  free(): void;
+  [Symbol.dispose](): void;
+  /**
+   * Get the complete history for a key
+   *
+   * # Arguments
+   * * `namespace` - The namespace
+   * * `key` - The key within the namespace
+   *
+   * # Returns
+   * Array of version history entries
+   */
+  history(namespace: string, key: string): Promise<any>;
+  /**
+   * Check if a key exists
+   */
+  contains(namespace: string, key: string): Promise<boolean>;
+  /**
+   * List all keys in a namespace
+   */
+  listKeys(namespace: string): Promise<any>;
+  /**
+   * Store multiple key-value pairs as a batch operation
+   *
+   * This is significantly faster than calling put() multiple times, especially
+   * when persistence is enabled, as it performs a single fsync for all items.
+   *
+   * # Arguments
+   * * `items` - A JavaScript array of objects with `namespace`, `key`, and `value` properties
+   *
+   * # Returns
+   * A JavaScript array of versioned metadata objects for each stored item
+   *
+   * # Example (JavaScript)
+   * ```javascript
+   * const items = [
+   *     { namespace: 'users', key: 'alice', value: { name: 'Alice', age: 30 } },
+   *     { namespace: 'users', key: 'bob', value: { name: 'Bob', age: 25 } }
+   * ];
+   * const results = await db.putBatch(items);
+   * ```
+   */
+  putBatch(items: any): Promise<any>;
+  /**
+   * Check if the database is using IndexedDB persistence
+   */
+  isPersistent(): boolean;
+  /**
+   * List all views
+   */
+  listViews(): Promise<any>;
+  /**
+   * Query a view
+   */
+  queryView(name: string): Promise<any>;
+  /**
+   * Create a materialized view
+   *
+   * # Arguments
+   * * `name` - View name
+   * * `source_namespace` - Source collection/namespace
+   */
+  createView(name: string, source_namespace: string): Promise<void>;
+  /**
+   * Delete a view
+   */
+  deleteView(name: string): Promise<void>;
+  /**
+   * Create a new persistent KoruDelta database instance with IndexedDB
+   *
+   * Data will be automatically saved to IndexedDB and loaded on startup.
+   * Falls back to memory-only if IndexedDB is unavailable.
+   *
+   * # Example (JavaScript)
+   * ```javascript
+   * const db = await KoruDeltaWasm.newPersistent();
+   *
+   * // Check if persistence is working
+   * if (db.isPersistent()) {
+   *   console.log("Data will survive page refreshes!");
+   * }
+   * ```
+   */
+  static newPersistent(): Promise<KoruDeltaWasm>;
+  /**
+   * Delete an embedding
+   */
+  deleteEmbed(namespace: string, key: string): Promise<void>;
+  /**
+   * Search for similar documents by vector
+   *
+   * # Arguments
+   * * `namespace` - Namespace to search
+   * * `query` - Array of f32 values (the query embedding)
+   * * `limit` - Maximum number of results (default: 10)
+   *
+   * # Returns
+   * Array of search results with namespace, key, and similarity score
+   */
+  embedSearch(namespace: string, query: Float32Array, limit?: number | null): Promise<any>;
+  /**
+   * Refresh a view
+   */
+  refreshView(name: string): Promise<void>;
+  /**
+   * Clear all persisted data from IndexedDB
+   *
+   * This will delete all data stored in IndexedDB. Use with caution!
+   */
+  clearPersistence(): Promise<void>;
+  /**
+   * List all namespaces in the database
+   */
+  listNamespaces(): Promise<any>;
+  /**
+   * Check if IndexedDB is supported in the current environment
+   */
+  static isIndexedDbSupported(): boolean;
+  /**
+   * Create a new in-memory KoruDelta database instance
+   *
+   * Data will be lost when the page is refreshed. For persistent storage,
+   * use `newPersistent()` instead.
+   *
+   * # Example (JavaScript)
+   * ```javascript
+   * const db = await KoruDeltaWasm.new();
+   * ```
+   */
+  static new(): Promise<KoruDeltaWasm>;
+  /**
+   * Retrieve the current value for a key
+   *
+   * # Arguments
+   * * `namespace` - The namespace
+   * * `key` - The key within the namespace
+   *
+   * # Returns
+   * A JavaScript object with the value and metadata
+   */
+  get(namespace: string, key: string): Promise<any>;
+  /**
+   * Store a value in the database
+   *
+   * # Arguments
+   * * `namespace` - The namespace (e.g., "users")
+   * * `key` - The key within the namespace (e.g., "alice")
+   * * `value` - JSON value to store (as JavaScript object/value)
+   *
+   * # Returns
+   * A JavaScript object with version information
+   */
+  put(namespace: string, key: string, value: any): Promise<any>;
+  /**
+   * Store a vector embedding associated with a document
+   *
+   * # Arguments
+   * * `namespace` - Document namespace
+   * * `key` - Document key
+   * * `vector` - Array of f32 values (the embedding)
+   * * `model` - Optional model identifier
+   */
+  embed(namespace: string, key: string, vector: Float32Array, model?: string | null): Promise<void>;
+  /**
+   * Query the database with filters
+   *
+   * # Arguments
+   * * `namespace` - Namespace to query
+   * * `filter` - Filter object (e.g., {status: "active", age: 30})
+   * * `limit` - Maximum results
+   */
+  query(namespace: string, filter: any, limit?: number | null): Promise<any>;
+  /**
+   * Get database statistics
+   */
+  stats(): Promise<any>;
+  /**
+   * Delete a key
+   *
+   * Also removes the key from IndexedDB if persistence is enabled.
+   */
+  delete(namespace: string, key: string): Promise<void>;
+  /**
+   * Get value at a specific timestamp
+   *
+   * # Arguments
+   * * `namespace` - The namespace
+   * * `key` - The key
+   * * `timestamp_iso` - ISO 8601 timestamp string
+   *
+   * # Returns
+   * The value at that point in time
+   */
+  getAt(namespace: string, key: string, timestamp_iso: string): Promise<any>;
+}