@wiscale/tauri-plugin-velesdb 0.5.1

package/dist/index.d.mts

@@ -0,0 +1,273 @@
+/**
+ * @module tauri-plugin-velesdb
+ *
+ * TypeScript bindings for the VelesDB Tauri plugin.
+ * Provides type-safe access to vector database operations in desktop apps.
+ *
+ * @example
+ * ```typescript
+ * import { createCollection, search, upsert } from 'tauri-plugin-velesdb';
+ *
+ * // Create a collection
+ * await createCollection({ name: 'docs', dimension: 768, metric: 'cosine' });
+ *
+ * // Insert vectors
+ * await upsert({
+ *   collection: 'docs',
+ *   points: [{ id: 1, vector: [...], payload: { title: 'Doc' } }]
+ * });
+ *
+ * // Search
+ * const results = await search({ collection: 'docs', vector: [...], topK: 10 });
+ * ```
+ */
+/** Distance metric for vector similarity. */
+type DistanceMetric = 'cosine' | 'euclidean' | 'dot' | 'hamming' | 'jaccard';
+/** Request to create a new collection. */
+interface CreateCollectionRequest {
+    /** Collection name (unique identifier). */
+    name: string;
+    /** Vector dimension (e.g., 768 for BERT, 1536 for GPT). */
+    dimension: number;
+    /** Distance metric for similarity calculations. Default: 'cosine'. */
+    metric?: DistanceMetric;
+}
+/** Collection information. */
+interface CollectionInfo {
+    /** Collection name. */
+    name: string;
+    /** Vector dimension. */
+    dimension: number;
+    /** Distance metric. */
+    metric: string;
+    /** Number of vectors in the collection. */
+    count: number;
+}
+/** A point (vector with metadata) to insert. */
+interface PointInput {
+    /** Unique point identifier. */
+    id: number;
+    /** Vector data (must match collection dimension). */
+    vector: number[];
+    /** Optional JSON payload with metadata. */
+    payload?: Record<string, unknown>;
+}
+/** Request to upsert points. */
+interface UpsertRequest {
+    /** Target collection name. */
+    collection: string;
+    /** Points to insert or update. */
+    points: PointInput[];
+}
+/** Request for vector similarity search. */
+interface SearchRequest {
+    /** Target collection name. */
+    collection: string;
+    /** Query vector. */
+    vector: number[];
+    /** Number of results to return. Default: 10. */
+    topK?: number;
+}
+/** Request for BM25 text search. */
+interface TextSearchRequest {
+    /** Target collection name. */
+    collection: string;
+    /** Text query for BM25 search. */
+    query: string;
+    /** Number of results to return. Default: 10. */
+    topK?: number;
+}
+/** Request for hybrid (vector + text) search. */
+interface HybridSearchRequest {
+    /** Target collection name. */
+    collection: string;
+    /** Query vector for similarity search. */
+    vector: number[];
+    /** Text query for BM25 search. */
+    query: string;
+    /** Number of results to return. Default: 10. */
+    topK?: number;
+    /** Weight for vector results (0.0-1.0). Default: 0.5. */
+    vectorWeight?: number;
+}
+/** Request for VelesQL query. */
+interface QueryRequest {
+    /** VelesQL query string. */
+    query: string;
+    /** Query parameters (for parameterized queries). */
+    params?: Record<string, unknown>;
+}
+/** Search result item. */
+interface SearchResult {
+    /** Point ID. */
+    id: number;
+    /** Similarity/distance score. */
+    score: number;
+    /** Point payload (if any). */
+    payload?: Record<string, unknown>;
+}
+/** Response from search operations. */
+interface SearchResponse {
+    /** Search results ordered by relevance. */
+    results: SearchResult[];
+    /** Query execution time in milliseconds. */
+    timingMs: number;
+}
+/** Error returned by plugin commands. */
+interface CommandError {
+    /** Human-readable error message. */
+    message: string;
+    /** Error code for programmatic handling. */
+    code: string;
+}
+/**
+ * Creates a new vector collection.
+ *
+ * @param request - Collection configuration
+ * @returns Collection info
+ * @throws {CommandError} If collection already exists or parameters are invalid
+ *
+ * @example
+ * ```typescript
+ * const info = await createCollection({
+ *   name: 'documents',
+ *   dimension: 768,
+ *   metric: 'cosine'
+ * });
+ * console.log(`Created collection with ${info.count} vectors`);
+ * ```
+ */
+declare function createCollection(request: CreateCollectionRequest): Promise<CollectionInfo>;
+/**
+ * Deletes a collection and all its data.
+ *
+ * @param name - Collection name to delete
+ * @throws {CommandError} If collection doesn't exist
+ *
+ * @example
+ * ```typescript
+ * await deleteCollection('documents');
+ * ```
+ */
+declare function deleteCollection(name: string): Promise<void>;
+/**
+ * Lists all collections in the database.
+ *
+ * @returns Array of collection info objects
+ *
+ * @example
+ * ```typescript
+ * const collections = await listCollections();
+ * collections.forEach(c => console.log(`${c.name}: ${c.count} vectors`));
+ * ```
+ */
+declare function listCollections(): Promise<CollectionInfo[]>;
+/**
+ * Gets information about a specific collection.
+ *
+ * @param name - Collection name
+ * @returns Collection info
+ * @throws {CommandError} If collection doesn't exist
+ *
+ * @example
+ * ```typescript
+ * const info = await getCollection('documents');
+ * console.log(`Dimension: ${info.dimension}, Count: ${info.count}`);
+ * ```
+ */
+declare function getCollection(name: string): Promise<CollectionInfo>;
+/**
+ * Inserts or updates vectors in a collection.
+ *
+ * @param request - Upsert request with collection name and points
+ * @returns Number of points upserted
+ * @throws {CommandError} If collection doesn't exist or vectors are invalid
+ *
+ * @example
+ * ```typescript
+ * const count = await upsert({
+ *   collection: 'documents',
+ *   points: [
+ *     { id: 1, vector: [0.1, 0.2, ...], payload: { title: 'Doc 1' } },
+ *     { id: 2, vector: [0.3, 0.4, ...], payload: { title: 'Doc 2' } }
+ *   ]
+ * });
+ * console.log(`Upserted ${count} points`);
+ * ```
+ */
+declare function upsert(request: UpsertRequest): Promise<number>;
+/**
+ * Performs vector similarity search.
+ *
+ * @param request - Search request with query vector
+ * @returns Search response with results and timing
+ * @throws {CommandError} If collection doesn't exist or vector dimension mismatches
+ *
+ * @example
+ * ```typescript
+ * const response = await search({
+ *   collection: 'documents',
+ *   vector: queryEmbedding,
+ *   topK: 5
+ * });
+ * response.results.forEach(r => {
+ *   console.log(`ID: ${r.id}, Score: ${r.score}, Title: ${r.payload?.title}`);
+ * });
+ * ```
+ */
+declare function search(request: SearchRequest): Promise<SearchResponse>;
+/**
+ * Performs BM25 full-text search across payloads.
+ *
+ * @param request - Text search request
+ * @returns Search response with results and timing
+ * @throws {CommandError} If collection doesn't exist
+ *
+ * @example
+ * ```typescript
+ * const response = await textSearch({
+ *   collection: 'documents',
+ *   query: 'machine learning tutorial',
+ *   topK: 10
+ * });
+ * ```
+ */
+declare function textSearch(request: TextSearchRequest): Promise<SearchResponse>;
+/**
+ * Performs hybrid search combining vector similarity and BM25 text relevance.
+ * Uses Reciprocal Rank Fusion (RRF) to merge results.
+ *
+ * @param request - Hybrid search request
+ * @returns Search response with fused results and timing
+ * @throws {CommandError} If collection doesn't exist or parameters are invalid
+ *
+ * @example
+ * ```typescript
+ * const response = await hybridSearch({
+ *   collection: 'documents',
+ *   vector: queryEmbedding,
+ *   query: 'neural networks',
+ *   topK: 10,
+ *   vectorWeight: 0.7  // 70% vector, 30% text
+ * });
+ * ```
+ */
+declare function hybridSearch(request: HybridSearchRequest): Promise<SearchResponse>;
+/**
+ * Executes a VelesQL query.
+ *
+ * @param request - Query request with VelesQL string
+ * @returns Search response with results and timing
+ * @throws {CommandError} If query syntax is invalid or collection doesn't exist
+ *
+ * @example
+ * ```typescript
+ * const response = await query({
+ *   query: "SELECT * FROM documents WHERE content MATCH 'rust programming' LIMIT 10",
+ *   params: {}
+ * });
+ * ```
+ */
+declare function query(request: QueryRequest): Promise<SearchResponse>;
+
+export { type CollectionInfo, type CommandError, type CreateCollectionRequest, type DistanceMetric, type HybridSearchRequest, type PointInput, type QueryRequest, type SearchRequest, type SearchResponse, type SearchResult, type TextSearchRequest, type UpsertRequest, createCollection, deleteCollection, getCollection, hybridSearch, listCollections, query, search, textSearch, upsert };

package/dist/index.d.ts

@@ -0,0 +1,273 @@
+/**
+ * @module tauri-plugin-velesdb
+ *
+ * TypeScript bindings for the VelesDB Tauri plugin.
+ * Provides type-safe access to vector database operations in desktop apps.
+ *
+ * @example
+ * ```typescript
+ * import { createCollection, search, upsert } from 'tauri-plugin-velesdb';
+ *
+ * // Create a collection
+ * await createCollection({ name: 'docs', dimension: 768, metric: 'cosine' });
+ *
+ * // Insert vectors
+ * await upsert({
+ *   collection: 'docs',
+ *   points: [{ id: 1, vector: [...], payload: { title: 'Doc' } }]
+ * });
+ *
+ * // Search
+ * const results = await search({ collection: 'docs', vector: [...], topK: 10 });
+ * ```
+ */
+/** Distance metric for vector similarity. */
+type DistanceMetric = 'cosine' | 'euclidean' | 'dot' | 'hamming' | 'jaccard';
+/** Request to create a new collection. */
+interface CreateCollectionRequest {
+    /** Collection name (unique identifier). */
+    name: string;
+    /** Vector dimension (e.g., 768 for BERT, 1536 for GPT). */
+    dimension: number;
+    /** Distance metric for similarity calculations. Default: 'cosine'. */
+    metric?: DistanceMetric;
+}
+/** Collection information. */
+interface CollectionInfo {
+    /** Collection name. */
+    name: string;
+    /** Vector dimension. */
+    dimension: number;
+    /** Distance metric. */
+    metric: string;
+    /** Number of vectors in the collection. */
+    count: number;
+}
+/** A point (vector with metadata) to insert. */
+interface PointInput {
+    /** Unique point identifier. */
+    id: number;
+    /** Vector data (must match collection dimension). */
+    vector: number[];
+    /** Optional JSON payload with metadata. */
+    payload?: Record<string, unknown>;
+}
+/** Request to upsert points. */
+interface UpsertRequest {
+    /** Target collection name. */
+    collection: string;
+    /** Points to insert or update. */
+    points: PointInput[];
+}
+/** Request for vector similarity search. */
+interface SearchRequest {
+    /** Target collection name. */
+    collection: string;
+    /** Query vector. */
+    vector: number[];
+    /** Number of results to return. Default: 10. */
+    topK?: number;
+}
+/** Request for BM25 text search. */
+interface TextSearchRequest {
+    /** Target collection name. */
+    collection: string;
+    /** Text query for BM25 search. */
+    query: string;
+    /** Number of results to return. Default: 10. */
+    topK?: number;
+}
+/** Request for hybrid (vector + text) search. */
+interface HybridSearchRequest {
+    /** Target collection name. */
+    collection: string;
+    /** Query vector for similarity search. */
+    vector: number[];
+    /** Text query for BM25 search. */
+    query: string;
+    /** Number of results to return. Default: 10. */
+    topK?: number;
+    /** Weight for vector results (0.0-1.0). Default: 0.5. */
+    vectorWeight?: number;
+}
+/** Request for VelesQL query. */
+interface QueryRequest {
+    /** VelesQL query string. */
+    query: string;
+    /** Query parameters (for parameterized queries). */
+    params?: Record<string, unknown>;
+}
+/** Search result item. */
+interface SearchResult {
+    /** Point ID. */
+    id: number;
+    /** Similarity/distance score. */
+    score: number;
+    /** Point payload (if any). */
+    payload?: Record<string, unknown>;
+}
+/** Response from search operations. */
+interface SearchResponse {
+    /** Search results ordered by relevance. */
+    results: SearchResult[];
+    /** Query execution time in milliseconds. */
+    timingMs: number;
+}
+/** Error returned by plugin commands. */
+interface CommandError {
+    /** Human-readable error message. */
+    message: string;
+    /** Error code for programmatic handling. */
+    code: string;
+}
+/**
+ * Creates a new vector collection.
+ *
+ * @param request - Collection configuration
+ * @returns Collection info
+ * @throws {CommandError} If collection already exists or parameters are invalid
+ *
+ * @example
+ * ```typescript
+ * const info = await createCollection({
+ *   name: 'documents',
+ *   dimension: 768,
+ *   metric: 'cosine'
+ * });
+ * console.log(`Created collection with ${info.count} vectors`);
+ * ```
+ */
+declare function createCollection(request: CreateCollectionRequest): Promise<CollectionInfo>;
+/**
+ * Deletes a collection and all its data.
+ *
+ * @param name - Collection name to delete
+ * @throws {CommandError} If collection doesn't exist
+ *
+ * @example
+ * ```typescript
+ * await deleteCollection('documents');
+ * ```
+ */
+declare function deleteCollection(name: string): Promise<void>;
+/**
+ * Lists all collections in the database.
+ *
+ * @returns Array of collection info objects
+ *
+ * @example
+ * ```typescript
+ * const collections = await listCollections();
+ * collections.forEach(c => console.log(`${c.name}: ${c.count} vectors`));
+ * ```
+ */
+declare function listCollections(): Promise<CollectionInfo[]>;
+/**
+ * Gets information about a specific collection.
+ *
+ * @param name - Collection name
+ * @returns Collection info
+ * @throws {CommandError} If collection doesn't exist
+ *
+ * @example
+ * ```typescript
+ * const info = await getCollection('documents');
+ * console.log(`Dimension: ${info.dimension}, Count: ${info.count}`);
+ * ```
+ */
+declare function getCollection(name: string): Promise<CollectionInfo>;
+/**
+ * Inserts or updates vectors in a collection.
+ *
+ * @param request - Upsert request with collection name and points
+ * @returns Number of points upserted
+ * @throws {CommandError} If collection doesn't exist or vectors are invalid
+ *
+ * @example
+ * ```typescript
+ * const count = await upsert({
+ *   collection: 'documents',
+ *   points: [
+ *     { id: 1, vector: [0.1, 0.2, ...], payload: { title: 'Doc 1' } },
+ *     { id: 2, vector: [0.3, 0.4, ...], payload: { title: 'Doc 2' } }
+ *   ]
+ * });
+ * console.log(`Upserted ${count} points`);
+ * ```
+ */
+declare function upsert(request: UpsertRequest): Promise<number>;
+/**
+ * Performs vector similarity search.
+ *
+ * @param request - Search request with query vector
+ * @returns Search response with results and timing
+ * @throws {CommandError} If collection doesn't exist or vector dimension mismatches
+ *
+ * @example
+ * ```typescript
+ * const response = await search({
+ *   collection: 'documents',
+ *   vector: queryEmbedding,
+ *   topK: 5
+ * });
+ * response.results.forEach(r => {
+ *   console.log(`ID: ${r.id}, Score: ${r.score}, Title: ${r.payload?.title}`);
+ * });
+ * ```
+ */
+declare function search(request: SearchRequest): Promise<SearchResponse>;
+/**
+ * Performs BM25 full-text search across payloads.
+ *
+ * @param request - Text search request
+ * @returns Search response with results and timing
+ * @throws {CommandError} If collection doesn't exist
+ *
+ * @example
+ * ```typescript
+ * const response = await textSearch({
+ *   collection: 'documents',
+ *   query: 'machine learning tutorial',
+ *   topK: 10
+ * });
+ * ```
+ */
+declare function textSearch(request: TextSearchRequest): Promise<SearchResponse>;
+/**
+ * Performs hybrid search combining vector similarity and BM25 text relevance.
+ * Uses Reciprocal Rank Fusion (RRF) to merge results.
+ *
+ * @param request - Hybrid search request
+ * @returns Search response with fused results and timing
+ * @throws {CommandError} If collection doesn't exist or parameters are invalid
+ *
+ * @example
+ * ```typescript
+ * const response = await hybridSearch({
+ *   collection: 'documents',
+ *   vector: queryEmbedding,
+ *   query: 'neural networks',
+ *   topK: 10,
+ *   vectorWeight: 0.7  // 70% vector, 30% text
+ * });
+ * ```
+ */
+declare function hybridSearch(request: HybridSearchRequest): Promise<SearchResponse>;
+/**
+ * Executes a VelesQL query.
+ *
+ * @param request - Query request with VelesQL string
+ * @returns Search response with results and timing
+ * @throws {CommandError} If query syntax is invalid or collection doesn't exist
+ *
+ * @example
+ * ```typescript
+ * const response = await query({
+ *   query: "SELECT * FROM documents WHERE content MATCH 'rust programming' LIMIT 10",
+ *   params: {}
+ * });
+ * ```
+ */
+declare function query(request: QueryRequest): Promise<SearchResponse>;
+
+export { type CollectionInfo, type CommandError, type CreateCollectionRequest, type DistanceMetric, type HybridSearchRequest, type PointInput, type QueryRequest, type SearchRequest, type SearchResponse, type SearchResult, type TextSearchRequest, type UpsertRequest, createCollection, deleteCollection, getCollection, hybridSearch, listCollections, query, search, textSearch, upsert };

package/dist/index.js

@@ -0,0 +1,73 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// index.ts
+var index_exports = {};
+__export(index_exports, {
+  createCollection: () => createCollection,
+  deleteCollection: () => deleteCollection,
+  getCollection: () => getCollection,
+  hybridSearch: () => hybridSearch,
+  listCollections: () => listCollections,
+  query: () => query,
+  search: () => search,
+  textSearch: () => textSearch,
+  upsert: () => upsert
+});
+module.exports = __toCommonJS(index_exports);
+var import_core = require("@tauri-apps/api/core");
+async function createCollection(request) {
+  return (0, import_core.invoke)("plugin:velesdb|create_collection", { request });
+}
+async function deleteCollection(name) {
+  return (0, import_core.invoke)("plugin:velesdb|delete_collection", { name });
+}
+async function listCollections() {
+  return (0, import_core.invoke)("plugin:velesdb|list_collections");
+}
+async function getCollection(name) {
+  return (0, import_core.invoke)("plugin:velesdb|get_collection", { name });
+}
+async function upsert(request) {
+  return (0, import_core.invoke)("plugin:velesdb|upsert", { request });
+}
+async function search(request) {
+  return (0, import_core.invoke)("plugin:velesdb|search", { request });
+}
+async function textSearch(request) {
+  return (0, import_core.invoke)("plugin:velesdb|text_search", { request });
+}
+async function hybridSearch(request) {
+  return (0, import_core.invoke)("plugin:velesdb|hybrid_search", { request });
+}
+async function query(request) {
+  return (0, import_core.invoke)("plugin:velesdb|query", { request });
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  createCollection,
+  deleteCollection,
+  getCollection,
+  hybridSearch,
+  listCollections,
+  query,
+  search,
+  textSearch,
+  upsert
+});

package/dist/index.mjs

@@ -0,0 +1,40 @@
+// index.ts
+import { invoke } from "@tauri-apps/api/core";
+async function createCollection(request) {
+  return invoke("plugin:velesdb|create_collection", { request });
+}
+async function deleteCollection(name) {
+  return invoke("plugin:velesdb|delete_collection", { name });
+}
+async function listCollections() {
+  return invoke("plugin:velesdb|list_collections");
+}
+async function getCollection(name) {
+  return invoke("plugin:velesdb|get_collection", { name });
+}
+async function upsert(request) {
+  return invoke("plugin:velesdb|upsert", { request });
+}
+async function search(request) {
+  return invoke("plugin:velesdb|search", { request });
+}
+async function textSearch(request) {
+  return invoke("plugin:velesdb|text_search", { request });
+}
+async function hybridSearch(request) {
+  return invoke("plugin:velesdb|hybrid_search", { request });
+}
+async function query(request) {
+  return invoke("plugin:velesdb|query", { request });
+}
+export {
+  createCollection,
+  deleteCollection,
+  getCollection,
+  hybridSearch,
+  listCollections,
+  query,
+  search,
+  textSearch,
+  upsert
+};

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@wiscale/tauri-plugin-velesdb",
+  "version": "0.5.1",
+  "description": "TypeScript bindings for the VelesDB Tauri plugin - Vector search in desktop apps",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsup index.ts --format cjs,esm --dts",
+    "lint": "eslint index.ts",
+    "typecheck": "tsc --noEmit"
+  },
+  "keywords": [
+    "tauri",
+    "plugin",
+    "velesdb",
+    "vector",
+    "database",
+    "search",
+    "embeddings",
+    "ai",
+    "desktop"
+  ],
+  "author": "Cyberlife Coder",
+  "license": "Elastic-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/cyberlife-coder/VelesDB.git",
+    "directory": "integrations/tauri-plugin-velesdb/guest-js"
+  },
+  "bugs": {
+    "url": "https://github.com/cyberlife-coder/VelesDB/issues"
+  },
+  "homepage": "https://velesdb.com",
+  "peerDependencies": {
+    "@tauri-apps/api": ">=2.0.0"
+  },
+  "devDependencies": {
+    "@tauri-apps/api": "^2.0.0",
+    "tsup": "^8.0.0",
+    "typescript": "^5.3.0"
+  }
+}