@wiscale/velesdb-sdk 1.3.0 → 1.5.1

package/dist/index.d.mts

@@ -8,6 +8,8 @@ type DistanceMetric = 'cosine' | 'euclidean' | 'dot' | 'hamming' | 'jaccard';
 type StorageMode = 'full' | 'sq8' | 'binary';
 /** Backend type for VelesDB connection */
 type BackendType = 'wasm' | 'rest';
+/** Numeric point ID required by velesdb-server REST API (`u64`). */
+type RestPointId = number;
 /** Configuration options for VelesDB client */
 interface VelesDBConfig {
     /** Backend type: 'wasm' for browser/Node.js, 'rest' for server */
@@ -53,6 +55,8 @@ interface Collection {
     /** Creation timestamp */
     createdAt?: Date;
 }
+/** Sparse vector: mapping from term/dimension index to weight */
+type SparseVector = Record<number, number>;
 /** Vector document to insert */
 interface VectorDocument {
     /** Unique identifier */
@@ -61,6 +65,8 @@ interface VectorDocument {
     vector: number[] | Float32Array;
     /** Optional payload/metadata */
     payload?: Record<string, unknown>;
+    /** Optional sparse vector for hybrid search */
+    sparseVector?: SparseVector;
 }
 /** Search options */
 interface SearchOptions {
@@ -70,15 +76,26 @@ interface SearchOptions {
     filter?: Record<string, unknown>;
     /** Include vectors in results (default: false) */
     includeVectors?: boolean;
+    /** Optional sparse vector for hybrid sparse+dense search */
+    sparseVector?: SparseVector;
+}
+/** PQ (Product Quantization) training options */
+interface PqTrainOptions {
+    /** Number of subquantizers (default: 8) */
+    m?: number;
+    /** Number of centroids per subquantizer (default: 256) */
+    k?: number;
+    /** Enable Optimized Product Quantization (default: false) */
+    opq?: boolean;
 }
 /** Fusion strategy for multi-query search */
-type FusionStrategy = 'rrf' | 'average' | 'maximum' | 'weighted';
+type FusionStrategy$1 = 'rrf' | 'average' | 'maximum' | 'weighted';
 /** Multi-query search options */
 interface MultiQuerySearchOptions {
     /** Number of results to return (default: 10) */
     k?: number;
     /** Fusion strategy (default: 'rrf') */
-    fusion?: FusionStrategy;
+    fusion?: FusionStrategy$1;
     /** Fusion parameters */
     fusionParams?: {
         /** RRF k parameter (default: 60) */
@@ -191,6 +208,106 @@ interface DegreeResponse {
     /** Number of outgoing edges */
     outDegree: number;
 }
+/** VelesQL query options */
+interface QueryOptions {
+    /** Timeout in milliseconds (default: 30000) */
+    timeoutMs?: number;
+    /** Enable streaming response */
+    stream?: boolean;
+}
+/** Query result from multi-model VelesQL query */
+interface QueryResult {
+    /** Node/point ID */
+    nodeId: bigint | number;
+    /** Vector similarity score (if applicable) */
+    vectorScore: number | null;
+    /** Graph relevance score (if applicable) */
+    graphScore: number | null;
+    /** Combined fused score */
+    fusedScore: number;
+    /** Variable bindings from MATCH clause */
+    bindings: Record<string, unknown>;
+    /** Column data from JOIN (if applicable) */
+    columnData: Record<string, unknown> | null;
+}
+/** Query execution statistics */
+interface QueryStats {
+    /** Execution time in milliseconds */
+    executionTimeMs: number;
+    /** Execution strategy used */
+    strategy: string;
+    /** Number of nodes scanned */
+    scannedNodes: number;
+}
+/** Full query response with results and stats */
+interface QueryResponse {
+    /** Query results */
+    results: QueryResult[];
+    /** Execution statistics */
+    stats: QueryStats;
+}
+/** Aggregation query response from VelesQL (`GROUP BY`, `COUNT`, `SUM`, etc.). */
+interface AggregationQueryResponse {
+    /** Aggregation result payload as returned by server. */
+    result: Record<string, unknown> | unknown[];
+    /** Execution statistics */
+    stats: QueryStats;
+}
+/** Unified response type for `query()` (rows or aggregation). */
+type QueryApiResponse = QueryResponse | AggregationQueryResponse;
+/** Query explain request/response metadata */
+interface ExplainPlanStep {
+    step: number;
+    operation: string;
+    description: string;
+    estimatedRows: number | null;
+}
+interface ExplainCost {
+    usesIndex: boolean;
+    indexName: string | null;
+    selectivity: number;
+    complexity: string;
+}
+interface ExplainFeatures {
+    hasVectorSearch: boolean;
+    hasFilter: boolean;
+    hasOrderBy: boolean;
+    hasGroupBy: boolean;
+    hasAggregation: boolean;
+    hasJoin: boolean;
+    hasFusion: boolean;
+    limit: number | null;
+    offset: number | null;
+}
+interface ExplainResponse {
+    query: string;
+    queryType: string;
+    collection: string;
+    plan: ExplainPlanStep[];
+    estimatedCost: ExplainCost;
+    features: ExplainFeatures;
+}
+interface CollectionSanityChecks {
+    hasVectors: boolean;
+    searchReady: boolean;
+    dimensionConfigured: boolean;
+}
+interface CollectionSanityDiagnostics {
+    searchRequestsTotal: number;
+    dimensionMismatchTotal: number;
+    emptySearchResultsTotal: number;
+    filterParseErrorsTotal: number;
+}
+interface CollectionSanityResponse {
+    collection: string;
+    dimension: number;
+    metric: string;
+    pointCount: number;
+    isEmpty: boolean;
+    checks: CollectionSanityChecks;
+    diagnostics: CollectionSanityDiagnostics;
+    hints: string[];
+}
 /** Index type for property indexes */
 type IndexType = 'hash' | 'range';
 /** Index information */
@@ -256,8 +373,12 @@ interface IVelesDBBackend {
         vectorWeight?: number;
         filter?: Record<string, unknown>;
     }): Promise<SearchResult[]>;
-    /** Execute VelesQL query */
-    query(queryString: string, params?: Record<string, unknown>): Promise<SearchResult[]>;
+    /** Execute VelesQL multi-model query (EPIC-031 US-011) */
+    query(collection: string, queryString: string, params?: Record<string, unknown>, options?: QueryOptions): Promise<QueryApiResponse>;
+    /** Explain a VelesQL query without executing it */
+    queryExplain(queryString: string, params?: Record<string, unknown>): Promise<ExplainResponse>;
+    /** Run collection sanity checks */
+    collectionSanity(collection: string): Promise<CollectionSanityResponse>;
     /** Multi-query fusion search */
     multiQuerySearch(collection: string, vectors: Array<number[] | Float32Array>, options?: MultiQuerySearchOptions): Promise<SearchResult[]>;
     /** Check if collection is empty */
@@ -282,6 +403,10 @@ interface IVelesDBBackend {
     traverseGraph(collection: string, request: TraverseRequest): Promise<TraverseResponse>;
     /** Get the in-degree and out-degree of a node */
     getNodeDegree(collection: string, nodeId: number): Promise<DegreeResponse>;
+    /** Train Product Quantization on a collection */
+    trainPq(collection: string, options?: PqTrainOptions): Promise<string>;
+    /** Stream-insert documents with backpressure support */
+    streamInsert(collection: string, docs: VectorDocument[]): Promise<void>;
 }
 /** Error types */
 declare class VelesDBError extends Error {
@@ -298,6 +423,10 @@ declare class ValidationError extends VelesDBError {
 declare class NotFoundError extends VelesDBError {
     constructor(resource: string);
 }
+/** Thrown when stream insert receives 429 Too Many Requests (backpressure) */
+declare class BackpressureError extends VelesDBError {
+    constructor(message?: string);
+}
 
 /**
  * VelesDB Client - Unified interface for all backends
@@ -398,6 +527,7 @@ declare class VelesDB {
      */
     insertBatch(collection: string, docs: VectorDocument[]): Promise<void>;
     private validateDocument;
+    private validateRestPointId;
     /**
      * Search for similar vectors
      *
@@ -462,13 +592,28 @@ declare class VelesDB {
         filter?: Record<string, unknown>;
     }): Promise<SearchResult[]>;
     /**
-     * Execute a VelesQL query
+     * Execute a VelesQL multi-model query (EPIC-031 US-011)
+     *
+     * Supports hybrid vector + graph queries with VelesQL syntax.
      *
+     * @param collection - Collection name
      * @param queryString - VelesQL query string
-     * @param params - Optional query parameters
-     * @returns Query results
+     * @param params - Query parameters (vectors, scalars)
+     * @param options - Query options (timeout, streaming)
+     * @returns Query response with results and execution stats
+     *
+     * @example
+     * ```typescript
+     * const response = await db.query('docs', `
+     *   MATCH (d:Doc) WHERE vector NEAR $q LIMIT 20
+     * `, { q: queryVector });
+     *
+     * for (const r of response.results) {
+     *   console.log(`Node ${r.nodeId}: ${r.fusedScore}`);
+     * }
+     * ```
      */
-    query(queryString: string, params?: Record<string, unknown>): Promise<SearchResult[]>;
+    query(collection: string, queryString: string, params?: Record<string, unknown>, options?: QueryOptions): Promise<QueryApiResponse>;
     /**
      * Multi-query fusion search combining results from multiple query vectors
      *
@@ -496,7 +641,27 @@ declare class VelesDB {
      * });
      * ```
      */
+    queryExplain(queryString: string, params?: Record<string, unknown>): Promise<ExplainResponse>;
+    collectionSanity(collection: string): Promise<CollectionSanityResponse>;
     multiQuerySearch(collection: string, vectors: Array<number[] | Float32Array>, options?: MultiQuerySearchOptions): Promise<SearchResult[]>;
+    /**
+     * Train Product Quantization on a collection
+     *
+     * @param collection - Collection name
+     * @param options - PQ training options (m, k, opq)
+     * @returns Server response message
+     */
+    trainPq(collection: string, options?: PqTrainOptions): Promise<string>;
+    /**
+     * Stream-insert documents with backpressure support
+     *
+     * Sends documents sequentially to respect server backpressure.
+     * Throws BackpressureError on 429 responses.
+     *
+     * @param collection - Collection name
+     * @param docs - Documents to insert
+     */
+    streamInsert(collection: string, docs: VectorDocument[]): Promise<void>;
     /**
      * Check if a collection is empty
      *
@@ -650,6 +815,9 @@ declare class WasmBackend implements IVelesDBBackend {
     init(): Promise<void>;
     isInitialized(): boolean;
     private ensureInitialized;
+    private normalizeIdString;
+    private canonicalPayloadKeyFromResultId;
+    private canonicalPayloadKey;
     createCollection(name: string, config: CollectionConfig): Promise<void>;
     deleteCollection(name: string): Promise<void>;
     getCollection(name: string): Promise<Collection | null>;
@@ -673,11 +841,14 @@ declare class WasmBackend implements IVelesDBBackend {
         vectorWeight?: number;
         filter?: Record<string, unknown>;
     }): Promise<SearchResult[]>;
-    query(_queryString: string, _params?: Record<string, unknown>): Promise<SearchResult[]>;
+    query(_collection: string, _queryString: string, _params?: Record<string, unknown>, _options?: QueryOptions): Promise<QueryApiResponse>;
     multiQuerySearch(_collection: string, _vectors: Array<number[] | Float32Array>, _options?: MultiQuerySearchOptions): Promise<SearchResult[]>;
+    queryExplain(_queryString: string, _params?: Record<string, unknown>): Promise<ExplainResponse>;
+    collectionSanity(_collection: string): Promise<CollectionSanityResponse>;
     isEmpty(collectionName: string): Promise<boolean>;
     flush(collectionName: string): Promise<void>;
     close(): Promise<void>;
+    private sparseVectorToArrays;
     private toNumericId;
     createIndex(_collection: string, _options: CreateIndexOptions): Promise<void>;
     listIndexes(_collection: string): Promise<IndexInfo[]>;
@@ -687,6 +858,8 @@ declare class WasmBackend implements IVelesDBBackend {
     getEdges(_collection: string, _options?: GetEdgesOptions): Promise<GraphEdge[]>;
     traverseGraph(_collection: string, _request: TraverseRequest): Promise<TraverseResponse>;
     getNodeDegree(_collection: string, _nodeId: number): Promise<DegreeResponse>;
+    trainPq(_collection: string, _options?: PqTrainOptions): Promise<string>;
+    streamInsert(_collection: string, _docs: VectorDocument[]): Promise<void>;
 }
 
 /**
@@ -711,6 +884,13 @@ declare class RestBackend implements IVelesDBBackend {
     private ensureInitialized;
     private mapStatusToErrorCode;
     private extractErrorPayload;
+    /**
+     * Parse node ID safely to handle u64 values above Number.MAX_SAFE_INTEGER.
+     * Returns bigint for large values, number for safe values.
+     */
+    private parseNodeId;
+    private parseRestPointId;
+    private isLikelyAggregationQuery;
     private request;
     createCollection(name: string, config: CollectionConfig): Promise<void>;
     deleteCollection(name: string): Promise<void>;
@@ -718,6 +898,7 @@ declare class RestBackend implements IVelesDBBackend {
     listCollections(): Promise<Collection[]>;
     insert(collection: string, doc: VectorDocument): Promise<void>;
     insertBatch(collection: string, docs: VectorDocument[]): Promise<void>;
+    private sparseVectorToRestFormat;
     search(collection: string, query: number[] | Float32Array, options?: SearchOptions): Promise<SearchResult[]>;
     searchBatch(collection: string, searches: Array<{
         vector: number[] | Float32Array;
@@ -735,10 +916,14 @@ declare class RestBackend implements IVelesDBBackend {
         vectorWeight?: number;
         filter?: Record<string, unknown>;
     }): Promise<SearchResult[]>;
-    query(queryString: string, params?: Record<string, unknown>): Promise<SearchResult[]>;
+    query(collection: string, queryString: string, params?: Record<string, unknown>, options?: QueryOptions): Promise<QueryApiResponse>;
+    queryExplain(queryString: string, params?: Record<string, unknown>): Promise<ExplainResponse>;
+    collectionSanity(collection: string): Promise<CollectionSanityResponse>;
     multiQuerySearch(collection: string, vectors: Array<number[] | Float32Array>, options?: MultiQuerySearchOptions): Promise<SearchResult[]>;
     isEmpty(collection: string): Promise<boolean>;
     flush(collection: string): Promise<void>;
+    trainPq(collection: string, options?: PqTrainOptions): Promise<string>;
+    streamInsert(collection: string, docs: VectorDocument[]): Promise<void>;
     close(): Promise<void>;
     createIndex(collection: string, options: CreateIndexOptions): Promise<void>;
     listIndexes(collection: string): Promise<IndexInfo[]>;
@@ -750,4 +935,194 @@ declare class RestBackend implements IVelesDBBackend {
     getNodeDegree(collection: string, nodeId: number): Promise<DegreeResponse>;
 }
 
-export { type AddEdgeRequest, type BackendType, type Collection, type CollectionConfig, type CollectionType, ConnectionError, type CreateIndexOptions, type DegreeResponse, type DistanceMetric, type EdgesResponse, type FusionStrategy, type GetEdgesOptions, type GraphEdge, type IVelesDBBackend, type IndexInfo, type IndexType, type MultiQuerySearchOptions, NotFoundError, RestBackend, type SearchOptions, type SearchResult, type StorageMode, type TraversalResultItem, type TraversalStats, type TraverseRequest, type TraverseResponse, ValidationError, type VectorDocument, VelesDB, type VelesDBConfig, VelesDBError, WasmBackend };
+/**
+ * VelesQL Query Builder (EPIC-012/US-004)
+ *
+ * Fluent, type-safe API for building VelesQL queries.
+ *
+ * @example
+ * ```typescript
+ * import { velesql } from '@velesdb/sdk';
+ *
+ * const query = velesql()
+ *   .match('d', 'Document')
+ *   .nearVector('$q', embedding)
+ *   .andWhere('d.category = $cat', { cat: 'tech' })
+ *   .limit(20)
+ *   .toVelesQL();
+ * ```
+ *
+ * @packageDocumentation
+ */
+/** Direction for relationship traversal */
+type RelDirection = 'outgoing' | 'incoming' | 'both';
+/** Fusion strategy for hybrid queries */
+type FusionStrategy = 'rrf' | 'average' | 'maximum' | 'weighted';
+/** Options for relationship patterns */
+interface RelOptions {
+    direction?: RelDirection;
+    minHops?: number;
+    maxHops?: number;
+}
+/** Options for vector NEAR clause */
+interface NearVectorOptions {
+    topK?: number;
+}
+/** Fusion configuration */
+interface FusionOptions {
+    strategy: FusionStrategy;
+    k?: number;
+    vectorWeight?: number;
+    graphWeight?: number;
+}
+/** Internal state for the query builder */
+interface BuilderState {
+    matchClauses: string[];
+    whereClauses: string[];
+    whereOperators: string[];
+    params: Record<string, unknown>;
+    limitValue?: number;
+    offsetValue?: number;
+    orderByClause?: string;
+    returnClause?: string;
+    fusionOptions?: FusionOptions;
+    currentNode?: string;
+    pendingRel?: {
+        type: string;
+        alias?: string;
+        options?: RelOptions;
+    };
+}
+/**
+ * VelesQL Query Builder
+ *
+ * Immutable builder for constructing VelesQL queries with type safety.
+ */
+declare class VelesQLBuilder {
+    private readonly state;
+    constructor(state?: Partial<BuilderState>);
+    private clone;
+    /**
+     * Start a MATCH clause with a node pattern
+     *
+     * @param alias - Node alias (e.g., 'n', 'person')
+     * @param label - Optional node label(s)
+     */
+    match(alias: string, label?: string | string[]): VelesQLBuilder;
+    /**
+     * Add a relationship pattern
+     *
+     * @param type - Relationship type (e.g., 'KNOWS', 'FOLLOWS')
+     * @param alias - Optional relationship alias
+     * @param options - Relationship options (direction, hops)
+     */
+    rel(type: string, alias?: string, options?: RelOptions): VelesQLBuilder;
+    /**
+     * Complete a relationship pattern with target node
+     *
+     * @param alias - Target node alias
+     * @param label - Optional target node label(s)
+     */
+    to(alias: string, label?: string | string[]): VelesQLBuilder;
+    /**
+     * Add a WHERE clause
+     *
+     * @param condition - WHERE condition
+     * @param params - Optional parameters
+     */
+    where(condition: string, params?: Record<string, unknown>): VelesQLBuilder;
+    /**
+     * Add an AND WHERE clause
+     *
+     * @param condition - WHERE condition
+     * @param params - Optional parameters
+     */
+    andWhere(condition: string, params?: Record<string, unknown>): VelesQLBuilder;
+    /**
+     * Add an OR WHERE clause
+     *
+     * @param condition - WHERE condition
+     * @param params - Optional parameters
+     */
+    orWhere(condition: string, params?: Record<string, unknown>): VelesQLBuilder;
+    /**
+     * Add a vector NEAR clause for similarity search
+     *
+     * @param paramName - Parameter name (e.g., '$query', '$embedding')
+     * @param vector - Vector data
+     * @param options - NEAR options (topK)
+     */
+    nearVector(paramName: string, vector: number[] | Float32Array, options?: NearVectorOptions): VelesQLBuilder;
+    /**
+     * Add LIMIT clause
+     *
+     * @param value - Maximum number of results
+     */
+    limit(value: number): VelesQLBuilder;
+    /**
+     * Add OFFSET clause
+     *
+     * @param value - Number of results to skip
+     */
+    offset(value: number): VelesQLBuilder;
+    /**
+     * Add ORDER BY clause
+     *
+     * @param field - Field to order by
+     * @param direction - Sort direction (ASC or DESC)
+     */
+    orderBy(field: string, direction?: 'ASC' | 'DESC'): VelesQLBuilder;
+    /**
+     * Add RETURN clause with specific fields
+     *
+     * @param fields - Fields to return (array or object with aliases)
+     */
+    return(fields: string[] | Record<string, string>): VelesQLBuilder;
+    /**
+     * Add RETURN * clause
+     */
+    returnAll(): VelesQLBuilder;
+    /**
+     * Set fusion strategy for hybrid queries
+     *
+     * @param strategy - Fusion strategy
+     * @param options - Fusion parameters
+     */
+    fusion(strategy: FusionStrategy, options?: {
+        k?: number;
+        vectorWeight?: number;
+        graphWeight?: number;
+    }): VelesQLBuilder;
+    /**
+     * Get the fusion options
+     */
+    getFusionOptions(): FusionOptions | undefined;
+    /**
+     * Get all parameters
+     */
+    getParams(): Record<string, unknown>;
+    /**
+     * Build the VelesQL query string
+     */
+    toVelesQL(): string;
+    private formatLabel;
+    private formatRelationship;
+    private formatHops;
+    private buildWhereClause;
+}
+/**
+ * Create a new VelesQL query builder
+ *
+ * @example
+ * ```typescript
+ * const query = velesql()
+ *   .match('n', 'Person')
+ *   .where('n.age > 21')
+ *   .limit(10)
+ *   .toVelesQL();
+ * // => "MATCH (n:Person) WHERE n.age > 21 LIMIT 10"
+ * ```
+ */
+declare function velesql(): VelesQLBuilder;
+
+export { type AddEdgeRequest, type AggregationQueryResponse, type BackendType, BackpressureError, type Collection, type CollectionConfig, type CollectionSanityChecks, type CollectionSanityDiagnostics, type CollectionSanityResponse, type CollectionType, ConnectionError, type CreateIndexOptions, type DegreeResponse, type DistanceMetric, type EdgesResponse, type ExplainCost, type ExplainFeatures, type ExplainPlanStep, type ExplainResponse, type FusionOptions, type FusionStrategy$1 as FusionStrategy, type GetEdgesOptions, type GraphEdge, type IVelesDBBackend, type IndexInfo, type IndexType, type MultiQuerySearchOptions, type NearVectorOptions, NotFoundError, type PqTrainOptions, type QueryApiResponse, type QueryOptions, type QueryResponse, type QueryResult, type QueryStats, type RelDirection, type RelOptions, RestBackend, type RestPointId, type SearchOptions, type SearchResult, type SparseVector, type StorageMode, type TraversalResultItem, type TraversalStats, type TraverseRequest, type TraverseResponse, ValidationError, type VectorDocument, VelesDB, type VelesDBConfig, VelesDBError, VelesQLBuilder, WasmBackend, velesql };