@anvailabs/proximadb-client 0.3.0

package/dist/types.js

@@ -0,0 +1,185 @@
+"use strict";
+/**
+ * ProximaDB TypeScript SDK - Type Definitions
+ *
+ * Copyright 2025 ProximaDB Contributors
+ * Licensed under the Apache License, Version 2.0
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProximaDBError = exports.ErrorCode = exports.TraversalDirection = exports.SearchMode = exports.LogicalOp = exports.FilterOp = exports.IndexType = exports.StorageEngine = exports.DistanceMetric = void 0;
+// ============================================================================
+// ENUMS
+// ============================================================================
+/**
+ * Distance metrics for vector similarity search
+ */
+var DistanceMetric;
+(function (DistanceMetric) {
+    /** Cosine similarity (normalized dot product) */
+    DistanceMetric["Cosine"] = "cosine";
+    /** Euclidean (L2) distance */
+    DistanceMetric["Euclidean"] = "euclidean";
+    /** Dot product similarity */
+    DistanceMetric["DotProduct"] = "dot_product";
+    /** Manhattan (L1) distance */
+    DistanceMetric["Manhattan"] = "manhattan";
+    /** Hamming distance for binary vectors */
+    DistanceMetric["Hamming"] = "hamming";
+    /** Jaccard similarity for set-like vectors */
+    DistanceMetric["Jaccard"] = "jaccard";
+})(DistanceMetric || (exports.DistanceMetric = DistanceMetric = {}));
+/**
+ * Storage engines available in ProximaDB
+ */
+var StorageEngine;
+(function (StorageEngine) {
+    /** Write-optimized, real-time workloads */
+    StorageEngine["Sst"] = "sst";
+    /** Locality-optimized with Hilbert curves */
+    StorageEngine["Helix"] = "helix";
+    /** Columnar Parquet for analytics */
+    StorageEngine["Viper"] = "viper";
+    /** Ultra-low latency for small datasets */
+    StorageEngine["Swift"] = "swift";
+    /** Progressive columnar for mixed workloads */
+    StorageEngine["Nova"] = "nova";
+    /** Adaptive row-group for dynamic workloads */
+    StorageEngine["Raptor"] = "raptor";
+})(StorageEngine || (exports.StorageEngine = StorageEngine = {}));
+/**
+ * Index types for vector search
+ */
+var IndexType;
+(function (IndexType) {
+    /** Hierarchical Navigable Small World */
+    IndexType["Hnsw"] = "hnsw";
+    /** Inverted File Index */
+    IndexType["Ivf"] = "ivf";
+    /** Locality Sensitive Hashing */
+    IndexType["Lsh"] = "lsh";
+    /** Brute force (no index) */
+    IndexType["Flat"] = "flat";
+    /** Product Quantization */
+    IndexType["Pq"] = "pq";
+    /** Approximate Nearest Neighbors Oh Yeah */
+    IndexType["Annoy"] = "annoy";
+})(IndexType || (exports.IndexType = IndexType = {}));
+/**
+ * Filter operations for metadata filtering
+ */
+var FilterOp;
+(function (FilterOp) {
+    /** Equal to */
+    FilterOp["Eq"] = "equals";
+    /** Not equal to */
+    FilterOp["Ne"] = "not_equals";
+    /** Greater than */
+    FilterOp["Gt"] = "gt";
+    /** Greater than or equal */
+    FilterOp["Gte"] = "gte";
+    /** Less than */
+    FilterOp["Lt"] = "lt";
+    /** Less than or equal */
+    FilterOp["Lte"] = "lte";
+    /** In list of values */
+    FilterOp["In"] = "in";
+    /** Not in list of values */
+    FilterOp["NotIn"] = "not_in";
+    /** Contains (for strings/arrays) */
+    FilterOp["Contains"] = "contains";
+    /** Starts with (for strings) */
+    FilterOp["StartsWith"] = "starts_with";
+    /** Ends with (for strings) */
+    FilterOp["EndsWith"] = "ends_with";
+    /** Field exists */
+    FilterOp["Exists"] = "exists";
+    /** Field is null */
+    FilterOp["IsNull"] = "is_null";
+})(FilterOp || (exports.FilterOp = FilterOp = {}));
+/**
+ * Logical operators for combining filter conditions
+ */
+var LogicalOp;
+(function (LogicalOp) {
+    /** All conditions must match */
+    LogicalOp["And"] = "and";
+    /** Any condition must match */
+    LogicalOp["Or"] = "or";
+})(LogicalOp || (exports.LogicalOp = LogicalOp = {}));
+/**
+ * Search mode for controlling recall vs performance tradeoff
+ */
+var SearchMode;
+(function (SearchMode) {
+    /** Exact search - 100% recall, searches all partitions */
+    SearchMode["Exact"] = "exact";
+    /** Approximate search - faster with ~95% recall */
+    SearchMode["Approximate"] = "approximate";
+    /** Adaptive search - auto-selects based on dataset size */
+    SearchMode["Adaptive"] = "adaptive";
+})(SearchMode || (exports.SearchMode = SearchMode = {}));
+/**
+ * Traversal direction for graph queries
+ */
+var TraversalDirection;
+(function (TraversalDirection) {
+    /** Traverse outgoing edges */
+    TraversalDirection["Outgoing"] = "outgoing";
+    /** Traverse incoming edges */
+    TraversalDirection["Incoming"] = "incoming";
+    /** Traverse both directions */
+    TraversalDirection["Both"] = "both";
+})(TraversalDirection || (exports.TraversalDirection = TraversalDirection = {}));
+// ============================================================================
+// ERROR TYPES
+// ============================================================================
+/**
+ * ProximaDB error codes
+ */
+var ErrorCode;
+(function (ErrorCode) {
+    /** Unknown error */
+    ErrorCode["Unknown"] = "UNKNOWN";
+    /** Network error */
+    ErrorCode["Network"] = "NETWORK_ERROR";
+    /** Authentication failed */
+    ErrorCode["AuthenticationFailed"] = "AUTHENTICATION_FAILED";
+    /** Authorization denied */
+    ErrorCode["AuthorizationDenied"] = "AUTHORIZATION_DENIED";
+    /** Rate limited */
+    ErrorCode["RateLimited"] = "RATE_LIMITED";
+    /** Collection not found */
+    ErrorCode["CollectionNotFound"] = "COLLECTION_NOT_FOUND";
+    /** Collection already exists */
+    ErrorCode["CollectionExists"] = "COLLECTION_EXISTS";
+    /** Vector not found */
+    ErrorCode["VectorNotFound"] = "VECTOR_NOT_FOUND";
+    /** Invalid vector dimension */
+    ErrorCode["InvalidDimension"] = "INVALID_DIMENSION";
+    /** Invalid configuration */
+    ErrorCode["InvalidConfig"] = "INVALID_CONFIG";
+    /** Invalid filter */
+    ErrorCode["InvalidFilter"] = "INVALID_FILTER";
+    /** Timeout */
+    ErrorCode["Timeout"] = "TIMEOUT";
+    /** Server error */
+    ErrorCode["ServerError"] = "SERVER_ERROR";
+})(ErrorCode || (exports.ErrorCode = ErrorCode = {}));
+/**
+ * ProximaDB error
+ */
+class ProximaDBError extends Error {
+    code;
+    statusCode;
+    details;
+    constructor(message, code = ErrorCode.Unknown, statusCode, details) {
+        super(message);
+        this.code = code;
+        this.statusCode = statusCode;
+        this.details = details;
+        this.name = "ProximaDBError";
+        Object.setPrototypeOf(this, ProximaDBError.prototype);
+    }
+}
+exports.ProximaDBError = ProximaDBError;
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,+EAA+E;AAC/E,QAAQ;AACR,+EAA+E;AAE/E;;GAEG;AACH,IAAY,cAaX;AAbD,WAAY,cAAc;IACxB,iDAAiD;IACjD,mCAAiB,CAAA;IACjB,8BAA8B;IAC9B,yCAAuB,CAAA;IACvB,6BAA6B;IAC7B,4CAA0B,CAAA;IAC1B,8BAA8B;IAC9B,yCAAuB,CAAA;IACvB,0CAA0C;IAC1C,qCAAmB,CAAA;IACnB,8CAA8C;IAC9C,qCAAmB,CAAA;AACrB,CAAC,EAbW,cAAc,8BAAd,cAAc,QAazB;AAED;;GAEG;AACH,IAAY,aAaX;AAbD,WAAY,aAAa;IACvB,2CAA2C;IAC3C,4BAAW,CAAA;IACX,6CAA6C;IAC7C,gCAAe,CAAA;IACf,qCAAqC;IACrC,gCAAe,CAAA;IACf,2CAA2C;IAC3C,gCAAe,CAAA;IACf,+CAA+C;IAC/C,8BAAa,CAAA;IACb,+CAA+C;IAC/C,kCAAiB,CAAA;AACnB,CAAC,EAbW,aAAa,6BAAb,aAAa,QAaxB;AAED;;GAEG;AACH,IAAY,SAaX;AAbD,WAAY,SAAS;IACnB,yCAAyC;IACzC,0BAAa,CAAA;IACb,0BAA0B;IAC1B,wBAAW,CAAA;IACX,iCAAiC;IACjC,wBAAW,CAAA;IACX,6BAA6B;IAC7B,0BAAa,CAAA;IACb,2BAA2B;IAC3B,sBAAS,CAAA;IACT,4CAA4C;IAC5C,4BAAe,CAAA;AACjB,CAAC,EAbW,SAAS,yBAAT,SAAS,QAapB;AAED;;GAEG;AACH,IAAY,QA2BX;AA3BD,WAAY,QAAQ;IAClB,eAAe;IACf,yBAAa,CAAA;IACb,mBAAmB;IACnB,6BAAiB,CAAA;IACjB,mBAAmB;IACnB,qBAAS,CAAA;IACT,4BAA4B;IAC5B,uBAAW,CAAA;IACX,gBAAgB;IAChB,qBAAS,CAAA;IACT,yBAAyB;IACzB,uBAAW,CAAA;IACX,wBAAwB;IACxB,qBAAS,CAAA;IACT,4BAA4B;IAC5B,4BAAgB,CAAA;IAChB,oCAAoC;IACpC,iCAAqB,CAAA;IACrB,gCAAgC;IAChC,sCAA0B,CAAA;IAC1B,8BAA8B;IAC9B,kCAAsB,CAAA;IACtB,mBAAmB;IACnB,6BAAiB,CAAA;IACjB,oBAAoB;IACpB,8BAAkB,CAAA;AACpB,CAAC,EA3BW,QAAQ,wBAAR,QAAQ,QA2BnB;AAED;;GAEG;AACH,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,gCAAgC;IAChC,wBAAW,CAAA;IACX,+BAA+B;IAC/B,sBAAS,CAAA;AACX,CAAC,EALW,SAAS,yBAAT,SAAS,QAKpB;AAED;;GAEG;AACH,IAAY,UAOX;AAPD,WAAY,UAAU;IACpB,0DAA0D;IAC1D,6BAAe,CAAA;IACf,mDAAmD;IACnD,yCAA2B,CAAA;IAC3B,2DAA2D;IAC3D,mCAAqB,CAAA;AACvB,CAAC,EAPW,UAAU,0BAAV,UAAU,QAOrB;AAED;;GAEG;AACH,IAAY,kBAOX;AAPD,WAAY,kBAAkB;IAC5B,8BAA8B;IAC9B,2CAAqB,CAAA;IACrB,8BAA8B;IAC9B,2CAAqB,CAAA;IACrB,+BAA+B;IAC/B,mCAAa,CAAA;AACf,CAAC,EAPW,kBAAkB,kCAAlB,kBAAkB,QAO7B;AAsgBD,+EAA+E;AAC/E,cAAc;AACd,+EAA+E;AAE/E;;GAEG;AACH,IAAY,SA2BX;AA3BD,WAAY,SAAS;IACnB,oBAAoB;IACpB,gCAAmB,CAAA;IACnB,oBAAoB;IACpB,sCAAyB,CAAA;IACzB,4BAA4B;IAC5B,2DAA8C,CAAA;IAC9C,2BAA2B;IAC3B,yDAA4C,CAAA;IAC5C,mBAAmB;IACnB,yCAA4B,CAAA;IAC5B,2BAA2B;IAC3B,wDAA2C,CAAA;IAC3C,gCAAgC;IAChC,mDAAsC,CAAA;IACtC,uBAAuB;IACvB,gDAAmC,CAAA;IACnC,+BAA+B;IAC/B,mDAAsC,CAAA;IACtC,4BAA4B;IAC5B,6CAAgC,CAAA;IAChC,qBAAqB;IACrB,6CAAgC,CAAA;IAChC,cAAc;IACd,gCAAmB,CAAA;IACnB,mBAAmB;IACnB,yCAA4B,CAAA;AAC9B,CAAC,EA3BW,SAAS,yBAAT,SAAS,QA2BpB;AAED;;GAEG;AACH,MAAa,cAAe,SAAQ,KAAK;IAGrB;IACA;IACA;IAJlB,YACE,OAAe,EACC,OAAkB,SAAS,CAAC,OAAO,EACnC,UAAmB,EACnB,OAAiC;QAEjD,KAAK,CAAC,OAAO,CAAC,CAAC;QAJC,SAAI,GAAJ,IAAI,CAA+B;QACnC,eAAU,GAAV,UAAU,CAAS;QACnB,YAAO,GAAP,OAAO,CAA0B;QAGjD,IAAI,CAAC,IAAI,GAAG,gBAAgB,CAAC;QAC7B,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,cAAc,CAAC,SAAS,CAAC,CAAC;IACxD,CAAC;CACF;AAXD,wCAWC"}

package/package.json

@@ -0,0 +1,72 @@
+{
+  "name": "@anvailabs/proximadb-client",
+  "version": "0.3.0",
+  "description": "TypeScript/Node.js SDK for ProximaDB vector database",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "module": "dist/index.mjs",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "src"
+  ],
+  "scripts": {
+    "build": "tsc && tsc -p tsconfig.esm.json",
+    "clean": "rm -rf dist",
+    "prepublishOnly": "npm run clean && npm run build",
+    "lint": "tsc --noEmit",
+    "format": "prettier --write src/**/*.ts",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "gen-sdk": "bash codegen/gen.sh"
+  },
+  "keywords": [
+    "proximadb",
+    "vector",
+    "database",
+    "embeddings",
+    "similarity-search",
+    "ai",
+    "ml",
+    "graph",
+    "typescript"
+  ],
+  "author": "ProximaDB Contributors",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/anvai-labs/proximaDB.git",
+    "directory": "clients/nodejs-embedded"
+  },
+  "bugs": {
+    "url": "https://github.com/proximadb/proximadb/issues"
+  },
+  "homepage": "https://github.com/proximadb/proximadb#readme",
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "dependencies": {
+    "openapi-fetch": "0.17.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.10.0",
+    "@vitest/coverage-v8": "^4.1.10",
+    "openapi-typescript": "7.13.0",
+    "typescript": "^5.3.0",
+    "vitest": "^4.1.7",
+    "yaml": "^2.9.0"
+  },
+  "overrides": {
+    "js-yaml": "^4.3.0",
+    "brace-expansion": "^2.1.4"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}