@wiscale/tauri-plugin-velesdb 7.1.0 → 8.0.0

package/README.md

@@ -0,0 +1,57 @@
+# @wiscale/tauri-plugin-velesdb
+
+Typed frontend wrapper for [`tauri-plugin-velesdb`](https://crates.io/crates/tauri-plugin-velesdb),
+the Tauri 2 plugin that embeds VelesDB (vector search, knowledge graph and
+agent memory) in a desktop app. Each function calls one plugin command through
+`invoke` and returns its typed result.
+
+The wrapper is optional: the plugin's commands can be called with
+`invoke('plugin:velesdb|<command>', { request })` and no extra dependency.
+
+## Install
+
+The Rust plugin must be registered and its commands granted first; see the
+[plugin README](https://github.com/cyberlife-coder/VelesDB/tree/main/crates/tauri-plugin-velesdb#readme)
+(`tauri_plugin_velesdb::init()` and a capability with `velesdb:default`).
+
+```bash
+npm install @wiscale/tauri-plugin-velesdb
+```
+
+Use the same version as the `tauri-plugin-velesdb` crate.
+
+## Usage
+
+```typescript
+import { createCollection, upsert, search } from '@wiscale/tauri-plugin-velesdb';
+
+await createCollection({ name: 'demo', dimension: 4, metric: 'cosine' });
+
+await upsert({
+  collection: 'demo',
+  points: [
+    { id: 1, vector: [1, 0, 0, 0], payload: { title: 'north' } },
+    { id: 2, vector: [0, 1, 0, 0], payload: { title: 'east' } },
+  ],
+});
+
+const { results } = await search({ collection: 'demo', vector: [1, 0, 0, 0], topK: 2 });
+console.log(results[0].payload); // { title: 'north' }
+```
+
+A rejected command rejects with a `CommandError`: a `code` (core's `VELES-###`,
+or `TASK_JOIN` when the plugin's task could not be joined), a `message` and a
+`recoverable` flag (see the
+[plugin reference](https://github.com/cyberlife-coder/VelesDB/blob/main/docs/guides/TAURI_PLUGIN_REFERENCE.md)).
+
+## API
+
+The exported functions and request types are declared in
+[`index.ts`](https://github.com/cyberlife-coder/VelesDB/blob/main/crates/tauri-plugin-velesdb/guest-js/index.ts),
+one per plugin command. The
+[plugin reference](https://github.com/cyberlife-coder/VelesDB/blob/main/docs/guides/TAURI_PLUGIN_REFERENCE.md)
+documents every command.
+
+## License
+
+VelesDB Core License 1.0, see `LICENSE`.

package/dist/index.d.mts

@@ -266,8 +266,13 @@ interface QueryResponse {
 interface CommandError {
     /** Human-readable error message. */
     message: string;
-    /** Error code for programmatic handling. */
+    /**
+     * Core taxonomy code (`VELES-###`) for programmatic handling, or
+     * `TASK_JOIN` when the plugin's blocking task could not be joined.
+     */
     code: string;
+    /** Whether retrying can succeed, as core answers for the same condition. */
+    recoverable: boolean;
 }
 /**
  * Creates a new vector collection.
@@ -759,6 +764,8 @@ interface SemanticQueryRequest {
     embedding: number[];
     /** Number of results to return. Default: 10. */
     topK?: number;
+    /** Search quality: 'fast', 'balanced', 'accurate', 'perfect', 'auto', 'custom:<ef>' or 'adaptive:<min_ef>:<max_ef>', each ef in 16-4096; any other value is refused. Omitted keeps the memory collection's own quality. */
+    quality?: string;
 }
 /** Result from semantic memory query. */
 interface SemanticQueryResult {
@@ -997,15 +1004,15 @@ interface ListIndexesRequest {
 }
 /** A single secondary index entry. */
 interface IndexInfoOutput {
-    /** Node label (or field name for secondary indexes). */
+    /** Node label (`secondary` for a secondary payload index). */
     label: string;
-    /** Property name. */
+    /** Property name (the payload field for a secondary index). */
     property: string;
-    /** Index type (`hash`, `range`, or `secondary`). */
+    /** Index type: `hash` (graph property), `range` (graph range) or `btree` (secondary payload index). */
     indexType: string;
-    /** Number of unique values indexed. */
+    /** Number of distinct values indexed. */
     cardinality: number;
-    /** Memory usage in bytes. */
+    /** Estimated heap size of the index, in bytes. */
     memoryBytes: number;
 }
 /**

package/dist/index.d.ts

@@ -266,8 +266,13 @@ interface QueryResponse {
 interface CommandError {
     /** Human-readable error message. */
     message: string;
-    /** Error code for programmatic handling. */
+    /**
+     * Core taxonomy code (`VELES-###`) for programmatic handling, or
+     * `TASK_JOIN` when the plugin's blocking task could not be joined.
+     */
     code: string;
+    /** Whether retrying can succeed, as core answers for the same condition. */
+    recoverable: boolean;
 }
 /**
  * Creates a new vector collection.
@@ -759,6 +764,8 @@ interface SemanticQueryRequest {
     embedding: number[];
     /** Number of results to return. Default: 10. */
     topK?: number;
+    /** Search quality: 'fast', 'balanced', 'accurate', 'perfect', 'auto', 'custom:<ef>' or 'adaptive:<min_ef>:<max_ef>', each ef in 16-4096; any other value is refused. Omitted keeps the memory collection's own quality. */
+    quality?: string;
 }
 /** Result from semantic memory query. */
 interface SemanticQueryResult {
@@ -997,15 +1004,15 @@ interface ListIndexesRequest {
 }
 /** A single secondary index entry. */
 interface IndexInfoOutput {
-    /** Node label (or field name for secondary indexes). */
+    /** Node label (`secondary` for a secondary payload index). */
     label: string;
-    /** Property name. */
+    /** Property name (the payload field for a secondary index). */
     property: string;
-    /** Index type (`hash`, `range`, or `secondary`). */
+    /** Index type: `hash` (graph property), `range` (graph range) or `btree` (secondary payload index). */
     indexType: string;
-    /** Number of unique values indexed. */
+    /** Number of distinct values indexed. */
     cardinality: number;
-    /** Memory usage in bytes. */
+    /** Estimated heap size of the index, in bytes. */
     memoryBytes: number;
 }
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wiscale/tauri-plugin-velesdb",
-  "version": "7.1.0",
+  "version": "8.0.0",
   "description": "TypeScript bindings for the VelesDB Tauri plugin - Vector search in desktop apps",
   "main": "dist/index.js",
   "module": "dist/index.mjs",