endee 1.0.0-beta.1

package/README.md

@@ -0,0 +1,163 @@
+# Endee - TypeScript Vector Database Client
+
+Endee is a TypeScript client for a vector database designed for maximum speed and efficiency. This package provides full type safety, modern ES module support, and optimized code for rapid Approximate Nearest Neighbor (ANN) searches on vector data.
+
+## Key Features
+
+- **TypeScript First**: Full type safety and IntelliSense support
+- **Fast ANN Searches**: Efficient similarity searches on vector data
+- **Multiple Distance Metrics**: Support for cosine, L2, and inner product distance metrics
+- **Metadata Support**: Attach and search with metadata and filters
+- **High Performance**: Optimized for speed and efficiency
+- **Modern ES Modules**: Native ES module support with proper tree-shaking
+
+## Installation
+
+```bash
+npm install endee
+```
+
+## Quick Start
+
+```typescript
+import { Endee } from "endee";
+
+// Initialize client with your API token
+const endee = new Endee("user_id:api_token:region");
+
+// Create a new index
+await endee.createIndex({
+  name: "my_vectors",
+  dimension: 1536, // Your vector dimension
+  spaceType: "cosine" // Distance metric (cosine, l2, ip)
+});
+
+// Get index reference
+const index = await endee.getIndex("my_vectors");
+
+// Insert vectors
+await index.upsert([
+  {
+    id: "doc1",
+    vector: [0.1, 0.2, 0.3 /* ... */], // Your vector data
+    meta: { text: "Example document", category: "reference" },
+  },
+]);
+
+// Query similar vectors
+const results = await index.query({
+  vector: [0.2, 0.3, 0.4 /* ... */], // Query vector
+  topK: 10,
+  filter: { category: { eq: "reference" } }, // Optional filter
+});
+
+// Process results
+for (const item of results) {
+  console.log(`ID: ${item.id}, Similarity: ${item.similarity}`);
+  console.log(`Metadata:`, item.meta);
+}
+```
+
+## Basic Usage
+
+### Initializing the Client
+
+```typescript
+import { Endee } from "endee";
+
+// Production with specific region
+const endee = new Endee("user_id:api_token:region");
+
+// Local development (defaults to http://127.0.0.1:8080/api/v1)
+const endee = new Endee();
+```
+
+### Managing Indexes
+
+```typescript
+// List all indexes
+const indexes = await endee.listIndexes();
+
+// Create an index with custom parameters
+await endee.createIndex({
+  name: "my_custom_index",
+  dimension: 384,
+  spaceType: "l2", // space type
+  M: 32, // M: Graph connectivity parameter
+  efCon: 200, // efCon: Construction-time parameter
+  useFp16: true // useFp16: Use half-precision for storage optimization
+});
+
+// Delete an index
+await endee.deleteIndex("my_index");
+```
+
+### Working with Vectors
+
+```typescript
+// Get index reference
+const index = await endee.getIndex("my_index");
+
+// Insert multiple vectors in a batch
+await index.upsert([
+  {
+    id: "vec1",
+    vector: [/* ... */], // Your vector
+    meta: { title: "First document" },
+    filter: { tags: "important" },
+  },
+  {
+    id: "vec2",
+    vector: [/* ... */], // Another vector
+    filter: { visibility: "public" }, // Optional filter values
+  },
+]);
+
+// Query with custom parameters
+const results = await index.query({
+  vector: [/* ... */], // Query vector
+  topK: 5, // Number of results to return
+  filter: { tags: "important" }, // Filter for matching
+  ef: 128, // Runtime parameter for search quality
+  includeVectors: true, // Include vector data in results
+});
+
+// Delete vectors
+await index.deleteVector("vec1");
+await index.deleteWithFilter({ visibility: "public" });
+
+// Get a specific vector
+const vector = await index.getVector("vec1");
+
+// Get index description
+const description = await index.describe();
+console.log(description);
+```
+
+## TypeScript Types
+
+The package includes comprehensive TypeScript types:
+
+```typescript
+import type {
+  VectorItem,
+  QueryOptions,
+  QueryResult,
+  CreateIndexOptions,
+  IndexDescription,
+  SpaceType
+} from "endee";
+```
+
+## Requirements
+
+- Node.js >= 18.0.0
+- TypeScript >= 5.0.0 (for development)
+
+## License
+
+MIT
+
+## Author
+
+Pankaj Singh

package/dist/crypto.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Cryptographic utilities for Endee-DB
+ */
+export declare function jsonZip(obj: Record<string, unknown> | null | undefined): Buffer;
+export declare function jsonUnzip(compressed: Buffer | Uint8Array | string | Record<string, unknown> | null | undefined): Record<string, unknown>;
+//# sourceMappingURL=crypto.d.ts.map

package/dist/crypto.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"crypto.d.ts","sourceRoot":"","sources":["../src/crypto.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH,wBAAgB,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,CAI/E;AAED,wBAAgB,SAAS,CAAC,UAAU,EAAE,MAAM,GAAG,UAAU,GAAG,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAuBxI"}

package/dist/crypto.js

@@ -0,0 +1,35 @@
+/**
+ * Cryptographic utilities for Endee-DB
+ */
+import * as zlib from 'zlib';
+export function jsonZip(obj) {
+    if (!obj || Object.keys(obj).length === 0)
+        return Buffer.alloc(0);
+    const jsonStr = JSON.stringify(obj);
+    return zlib.deflateSync(Buffer.from(jsonStr, 'utf-8'));
+}
+export function jsonUnzip(compressed) {
+    if (!compressed || (compressed instanceof Buffer && compressed.length === 0))
+        return {};
+    if (typeof compressed === "object" && !Buffer.isBuffer(compressed) && !(compressed instanceof Uint8Array)) {
+        return compressed;
+    }
+    if (typeof compressed === "string") {
+        try {
+            return JSON.parse(compressed);
+        }
+        catch {
+            // Not JSON, fall through to zlib
+        }
+    }
+    try {
+        const buffer = Buffer.isBuffer(compressed) ? compressed : Buffer.from(compressed);
+        const decompressed = zlib.inflateSync(buffer);
+        return JSON.parse(decompressed.toString('utf-8'));
+    }
+    catch (err) {
+        const error = err;
+        throw new Error(`Failed to decompress data: ${error.message}`);
+    }
+}
+//# sourceMappingURL=crypto.js.map

package/dist/crypto.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"crypto.js","sourceRoot":"","sources":["../src/crypto.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAE7B,MAAM,UAAU,OAAO,CAAC,GAA+C;IACrE,IAAI,CAAC,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAClE,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;IACpC,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;AACzD,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,UAAqF;IAC7G,IAAI,CAAC,UAAU,IAAI,CAAC,UAAU,YAAY,MAAM,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,CAAC;QAAE,OAAO,EAAE,CAAC;IAExF,IAAI,OAAO,UAAU,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,UAAU,YAAY,UAAU,CAAC,EAAE,CAAC;QAC1G,OAAO,UAAqC,CAAC;IAC/C,CAAC;IAED,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE,CAAC;QACnC,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,KAAK,CAAC,UAAU,CAA4B,CAAC;QAC3D,CAAC;QAAC,MAAM,CAAC;YACP,iCAAiC;QACnC,CAAC;IACH,CAAC;IAED,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAClF,MAAM,YAAY,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QAC9C,OAAO,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,QAAQ,CAAC,OAAO,CAAC,CAA4B,CAAC;IAC/E,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,MAAM,KAAK,GAAG,GAAY,CAAC;QAC3B,MAAM,IAAI,KAAK,CAAC,8BAA8B,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;IACjE,CAAC;AACH,CAAC"}

package/dist/endee.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Main Endee client for Endee-DB
+ */
+import { Index } from './indexClient.js';
+import type { CreateIndexOptions } from './types/index.js';
+export declare class Endee {
+    private token;
+    private baseUrl;
+    private version;
+    constructor(token?: string | null);
+    createIndex(options: CreateIndexOptions): Promise<string>;
+    listIndexes(): Promise<unknown>;
+    deleteIndex(name: string): Promise<string>;
+    getIndex(name: string): Promise<Index>;
+}
+//# sourceMappingURL=endee.d.ts.map

package/dist/endee.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"endee.d.ts","sourceRoot":"","sources":["../src/endee.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAIzC,OAAO,KAAK,EACV,kBAAkB,EAEnB,MAAM,kBAAkB,CAAC;AAE1B,qBAAa,KAAK;IAChB,OAAO,CAAC,KAAK,CAAgB;IAC7B,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,OAAO,CAAS;gBAEZ,KAAK,GAAE,MAAM,GAAG,IAAW;IAajC,WAAW,CACf,OAAO,EAAE,kBAAkB,GAC1B,OAAO,CAAC,MAAM,CAAC;IAyDZ,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC;IAgB/B,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAuB1C,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;CA0B7C"}

package/dist/endee.js

@@ -0,0 +1,131 @@
+/**
+ * Main Endee client for Endee-DB
+ */
+import axios from 'axios';
+import { raiseException } from './exceptions.js';
+import { Index } from './indexClient.js';
+import { isValidIndexName, } from './utils.js';
+export class Endee {
+    token;
+    baseUrl;
+    version;
+    constructor(token = null) {
+        this.token = token;
+        this.baseUrl = "http://127.0.0.1:8080/api/v1";
+        if (token) {
+            const tokenParts = token.split(":");
+            if (tokenParts.length > 2) {
+                this.baseUrl = `https://${tokenParts[2]}.endee.io/api/v1`;
+                this.token = `${tokenParts[0]}:${tokenParts[1]}`;
+            }
+        }
+        this.version = 1;
+    }
+    async createIndex(options) {
+        const { name, dimension, spaceType = 'cosine', M = 16, efCon = 128, useFp16 = true, version, } = options;
+        if (!isValidIndexName(name)) {
+            throw new Error("Invalid index name. Index name must be alphanumeric and can contain underscores and less than 48 characters");
+        }
+        if (dimension > 10000) {
+            throw new Error("Dimension cannot be greater than 10000");
+        }
+        const normalizedSpaceType = spaceType.toLowerCase();
+        if (!["cosine", "l2", "ip"].includes(normalizedSpaceType)) {
+            throw new Error(`Invalid space type: ${spaceType}`);
+        }
+        const headers = {
+            Authorization: `${this.token}`,
+            "Content-Type": "application/json",
+        };
+        const data = {
+            index_name: name,
+            dim: dimension,
+            space_type: normalizedSpaceType,
+            M: M,
+            ef_con: efCon,
+            use_fp16: useFp16,
+        };
+        if (version !== undefined) {
+            data.version = version;
+        }
+        let response;
+        try {
+            response = await axios.post(`${this.baseUrl}/index/create`, data, {
+                headers,
+            });
+        }
+        catch (err) {
+            if (axios.isAxiosError(err) && err.response) {
+                console.error(err.response.data);
+                raiseException(err.response.status, err.response.data);
+            }
+            throw err;
+        }
+        if (response.status !== 200) {
+            console.error(response.data);
+            raiseException(response.status, response.data);
+        }
+        return "Index created successfully";
+    }
+    async listIndexes() {
+        const headers = {
+            Authorization: `${this.token}`,
+        };
+        let response;
+        try {
+            response = await axios.get(`${this.baseUrl}/index/list`, { headers });
+        }
+        catch (err) {
+            if (axios.isAxiosError(err) && err.response) {
+                raiseException(err.response.status, err.response.data);
+            }
+            throw err;
+        }
+        return response.data;
+    }
+    async deleteIndex(name) {
+        const headers = {
+            Authorization: `${this.token}`,
+        };
+        let response;
+        try {
+            response = await axios.delete(`${this.baseUrl}/index/${name}/delete`, {
+                headers,
+            });
+        }
+        catch (err) {
+            if (axios.isAxiosError(err) && err.response) {
+                console.error(err.response.data);
+                raiseException(err.response.status, err.response.data);
+            }
+            throw err;
+        }
+        if (response.status !== 200) {
+            console.error(response.data);
+            raiseException(response.status, response.data);
+        }
+        return `Index ${name} deleted successfully`;
+    }
+    async getIndex(name) {
+        const headers = {
+            Authorization: `${this.token}`,
+            "Content-Type": "application/json",
+        };
+        let response;
+        try {
+            response = await axios.get(`${this.baseUrl}/index/${name}/info`, {
+                headers,
+            });
+        }
+        catch (err) {
+            if (axios.isAxiosError(err) && err.response) {
+                raiseException(err.response.status, err.response.data);
+            }
+            throw err;
+        }
+        const data = response.data;
+        const idx = new Index(name, this.token, this.baseUrl, this.version, data);
+        return idx;
+    }
+}
+//# sourceMappingURL=endee.js.map

package/dist/endee.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"endee.js","sourceRoot":"","sources":["../src/endee.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACzC,OAAO,EACL,gBAAgB,GACjB,MAAM,YAAY,CAAC;AAMpB,MAAM,OAAO,KAAK;IACR,KAAK,CAAgB;IACrB,OAAO,CAAS;IAChB,OAAO,CAAS;IAExB,YAAY,QAAuB,IAAI;QACrC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,OAAO,GAAG,8BAA8B,CAAC;QAC9C,IAAI,KAAK,EAAE,CAAC;YACV,MAAM,UAAU,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACpC,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC1B,IAAI,CAAC,OAAO,GAAG,WAAW,UAAU,CAAC,CAAC,CAAC,kBAAkB,CAAC;gBAC1D,IAAI,CAAC,KAAK,GAAG,GAAG,UAAU,CAAC,CAAC,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC;YACnD,CAAC;QACH,CAAC;QACD,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC;IACnB,CAAC;IAED,KAAK,CAAC,WAAW,CACf,OAA2B;QAE3B,MAAM,EACJ,IAAI,EACJ,SAAS,EACT,SAAS,GAAG,QAAQ,EACpB,CAAC,GAAG,EAAE,EACN,KAAK,GAAG,GAAG,EACX,OAAO,GAAG,IAAI,EACd,OAAO,GACR,GAAG,OAAO,CAAC;QAEZ,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC;YAC5B,MAAM,IAAI,KAAK,CACb,6GAA6G,CAC9G,CAAC;QACJ,CAAC;QACD,IAAI,SAAS,GAAG,KAAK,EAAE,CAAC;YACtB,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;QAC5D,CAAC;QACD,MAAM,mBAAmB,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC;QACpD,IAAI,CAAC,CAAC,QAAQ,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,QAAQ,CAAC,mBAAmB,CAAC,EAAE,CAAC;YAC1D,MAAM,IAAI,KAAK,CAAC,uBAAuB,SAAS,EAAE,CAAC,CAAC;QACtD,CAAC;QACD,MAAM,OAAO,GAAG;YACd,aAAa,EAAE,GAAG,IAAI,CAAC,KAAK,EAAE;YAC9B,cAAc,EAAE,kBAAkB;SACnC,CAAC;QACF,MAAM,IAAI,GAA4B;YACpC,UAAU,EAAE,IAAI;YAChB,GAAG,EAAE,SAAS;YACd,UAAU,EAAE,mBAAmB;YAC/B,CAAC,EAAE,CAAC;YACJ,MAAM,EAAE,KAAK;YACb,QAAQ,EAAE,OAAO;SAClB,CAAC;QACF,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YAC1B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACzB,CAAC;QACD,IAAI,QAAQ,CAAC;QACb,IAAI,CAAC;YACH,QAAQ,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,OAAO,eAAe,EAAE,IAAI,EAAE;gBAChE,OAAO;aACR,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,QAAQ,EAAE,CAAC;gBAC5C,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;gBACjC,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,EAAE,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACzD,CAAC;YACD,MAAM,GAAG,CAAC;QACZ,CAAC;QACD,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YAC5B,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC7B,cAAc,CAAC,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;QACjD,CAAC;QACD,OAAO,4BAA4B,CAAC;IACtC,CAAC;IAED,KAAK,CAAC,WAAW;QACf,MAAM,OAAO,GAAG;YACd,aAAa,EAAE,GAAG,IAAI,CAAC,KAAK,EAAE;SAC/B,CAAC;QACF,IAAI,QAAQ,CAAC;QACb,IAAI,CAAC;YACH,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,OAAO,aAAa,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;QACxE,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,QAAQ,EAAE,CAAC;gBAC5C,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,EAAE,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACzD,CAAC;YACD,MAAM,GAAG,CAAC;QACZ,CAAC;QACD,OAAO,QAAQ,CAAC,IAAI,CAAC;IACvB,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,IAAY;QAC5B,MAAM,OAAO,GAAG;YACd,aAAa,EAAE,GAAG,IAAI,CAAC,KAAK,EAAE;SAC/B,CAAC;QACF,IAAI,QAAQ,CAAC;QACb,IAAI,CAAC;YACH,QAAQ,GAAG,MAAM,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,OAAO,UAAU,IAAI,SAAS,EAAE;gBACpE,OAAO;aACR,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,QAAQ,EAAE,CAAC;gBAC5C,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;gBACjC,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,EAAE,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACzD,CAAC;YACD,MAAM,GAAG,CAAC;QACZ,CAAC;QACD,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YAC5B,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC7B,cAAc,CAAC,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;QACjD,CAAC;QACD,OAAO,SAAS,IAAI,uBAAuB,CAAC;IAC9C,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,IAAY;QACzB,MAAM,OAAO,GAAG;YACd,aAAa,EAAE,GAAG,IAAI,CAAC,KAAK,EAAE;YAC9B,cAAc,EAAE,kBAAkB;SACnC,CAAC;QACF,IAAI,QAAQ,CAAC;QACb,IAAI,CAAC;YACH,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,OAAO,UAAU,IAAI,OAAO,EAAE;gBAC/D,OAAO;aACR,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,QAAQ,EAAE,CAAC;gBAC5C,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,EAAE,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACzD,CAAC;YACD,MAAM,GAAG,CAAC;QACZ,CAAC;QACD,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAiB,CAAC;QACxC,MAAM,GAAG,GAAG,IAAI,KAAK,CACnB,IAAI,EACJ,IAAI,CAAC,KAAM,EACX,IAAI,CAAC,OAAO,EACZ,IAAI,CAAC,OAAO,EACZ,IAAI,CACL,CAAC;QACF,OAAO,GAAG,CAAC;IACb,CAAC;CACF"}

package/dist/exceptions.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Exception classes for Endee-DB
+ */
+export declare class EndeeException extends Error {
+    constructor(message?: string);
+}
+export declare class APIException extends EndeeException {
+    constructor(message: string);
+}
+export declare class ServerException extends EndeeException {
+    constructor(message: string);
+}
+export declare class ForbiddenException extends EndeeException {
+    constructor(message: string);
+}
+export declare class ConflictException extends EndeeException {
+    constructor(message: string);
+}
+export declare class NotFoundException extends EndeeException {
+    constructor(message: string);
+}
+export declare class AuthenticationException extends EndeeException {
+    constructor(message: string);
+}
+export declare class SubscriptionException extends EndeeException {
+    constructor(message: string);
+}
+export declare function raiseException(code: number, text: string | unknown): never;
+//# sourceMappingURL=exceptions.d.ts.map

package/dist/exceptions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"exceptions.d.ts","sourceRoot":"","sources":["../src/exceptions.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,qBAAa,cAAe,SAAQ,KAAK;gBAC3B,OAAO,SAAkC;CAKtD;AAED,qBAAa,YAAa,SAAQ,cAAc;gBAClC,OAAO,EAAE,MAAM;CAK5B;AAED,qBAAa,eAAgB,SAAQ,cAAc;gBACrC,OAAO,EAAE,MAAM;CAK5B;AAED,qBAAa,kBAAmB,SAAQ,cAAc;gBACxC,OAAO,EAAE,MAAM;CAK5B;AAED,qBAAa,iBAAkB,SAAQ,cAAc;gBACvC,OAAO,EAAE,MAAM;CAK5B;AAED,qBAAa,iBAAkB,SAAQ,cAAc;gBACvC,OAAO,EAAE,MAAM;CAK5B;AAED,qBAAa,uBAAwB,SAAQ,cAAc;gBAC7C,OAAO,EAAE,MAAM;CAK5B;AAED,qBAAa,qBAAsB,SAAQ,cAAc;gBAC3C,OAAO,EAAE,MAAM;CAK5B;AAED,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,GAAG,KAAK,CAgC1E"}

package/dist/exceptions.js

@@ -0,0 +1,102 @@
+/**
+ * Exception classes for Endee-DB
+ */
+export class EndeeException extends Error {
+    constructor(message = "An error occurred in Endee-DB") {
+        super(message);
+        this.name = "EndeeException";
+        Object.setPrototypeOf(this, EndeeException.prototype);
+    }
+}
+export class APIException extends EndeeException {
+    constructor(message) {
+        super(`API Error: ${message}`);
+        this.name = "APIException";
+        Object.setPrototypeOf(this, APIException.prototype);
+    }
+}
+export class ServerException extends EndeeException {
+    constructor(message) {
+        super(`Server Busy: ${message}`);
+        this.name = "ServerException";
+        Object.setPrototypeOf(this, ServerException.prototype);
+    }
+}
+export class ForbiddenException extends EndeeException {
+    constructor(message) {
+        super(`Forbidden: ${message}`);
+        this.name = "ForbiddenException";
+        Object.setPrototypeOf(this, ForbiddenException.prototype);
+    }
+}
+export class ConflictException extends EndeeException {
+    constructor(message) {
+        super(`Conflict: ${message}`);
+        this.name = "ConflictException";
+        Object.setPrototypeOf(this, ConflictException.prototype);
+    }
+}
+export class NotFoundException extends EndeeException {
+    constructor(message) {
+        super(`Resource Not Found: ${message}`);
+        this.name = "NotFoundException";
+        Object.setPrototypeOf(this, NotFoundException.prototype);
+    }
+}
+export class AuthenticationException extends EndeeException {
+    constructor(message) {
+        super(`Authentication Error: ${message}`);
+        this.name = "AuthenticationException";
+        Object.setPrototypeOf(this, AuthenticationException.prototype);
+    }
+}
+export class SubscriptionException extends EndeeException {
+    constructor(message) {
+        super(`Subscription Error: ${message}`);
+        this.name = "SubscriptionException";
+        Object.setPrototypeOf(this, SubscriptionException.prototype);
+    }
+}
+export function raiseException(code, text) {
+    let message;
+    try {
+        if (typeof text === 'string') {
+            const parsed = JSON.parse(text);
+            message = parsed.error || "Unknown error";
+        }
+        else if (text && typeof text === 'object' && 'error' in text) {
+            message = String(text.error) || "Unknown error";
+        }
+        else {
+            message = String(text) || "Unknown error";
+        }
+    }
+    catch {
+        message = String(text) || "Unknown error";
+    }
+    if (code === 400) {
+        throw new APIException(message);
+    }
+    else if (code === 401) {
+        throw new AuthenticationException(message);
+    }
+    else if (code === 402) {
+        throw new SubscriptionException(message);
+    }
+    else if (code === 403) {
+        throw new ForbiddenException(message);
+    }
+    else if (code === 404) {
+        throw new NotFoundException(message);
+    }
+    else if (code === 409) {
+        throw new ConflictException(message);
+    }
+    else if (code >= 500) {
+        throw new ServerException("Server is busy. Please try again in sometime");
+    }
+    else {
+        throw new APIException("Unknown Error. Please try again in sometime");
+    }
+}
+//# sourceMappingURL=exceptions.js.map

package/dist/exceptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"exceptions.js","sourceRoot":"","sources":["../src/exceptions.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,MAAM,OAAO,cAAe,SAAQ,KAAK;IACvC,YAAY,OAAO,GAAG,+BAA+B;QACnD,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,gBAAgB,CAAC;QAC7B,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,cAAc,CAAC,SAAS,CAAC,CAAC;IACxD,CAAC;CACF;AAED,MAAM,OAAO,YAAa,SAAQ,cAAc;IAC9C,YAAY,OAAe;QACzB,KAAK,CAAC,cAAc,OAAO,EAAE,CAAC,CAAC;QAC/B,IAAI,CAAC,IAAI,GAAG,cAAc,CAAC;QAC3B,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,YAAY,CAAC,SAAS,CAAC,CAAC;IACtD,CAAC;CACF;AAED,MAAM,OAAO,eAAgB,SAAQ,cAAc;IACjD,YAAY,OAAe;QACzB,KAAK,CAAC,gBAAgB,OAAO,EAAE,CAAC,CAAC;QACjC,IAAI,CAAC,IAAI,GAAG,iBAAiB,CAAC;QAC9B,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,eAAe,CAAC,SAAS,CAAC,CAAC;IACzD,CAAC;CACF;AAED,MAAM,OAAO,kBAAmB,SAAQ,cAAc;IACpD,YAAY,OAAe;QACzB,KAAK,CAAC,cAAc,OAAO,EAAE,CAAC,CAAC;QAC/B,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC;QACjC,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,kBAAkB,CAAC,SAAS,CAAC,CAAC;IAC5D,CAAC;CACF;AAED,MAAM,OAAO,iBAAkB,SAAQ,cAAc;IACnD,YAAY,OAAe;QACzB,KAAK,CAAC,aAAa,OAAO,EAAE,CAAC,CAAC;QAC9B,IAAI,CAAC,IAAI,GAAG,mBAAmB,CAAC;QAChC,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,iBAAiB,CAAC,SAAS,CAAC,CAAC;IAC3D,CAAC;CACF;AAED,MAAM,OAAO,iBAAkB,SAAQ,cAAc;IACnD,YAAY,OAAe;QACzB,KAAK,CAAC,uBAAuB,OAAO,EAAE,CAAC,CAAC;QACxC,IAAI,CAAC,IAAI,GAAG,mBAAmB,CAAC;QAChC,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,iBAAiB,CAAC,SAAS,CAAC,CAAC;IAC3D,CAAC;CACF;AAED,MAAM,OAAO,uBAAwB,SAAQ,cAAc;IACzD,YAAY,OAAe;QACzB,KAAK,CAAC,yBAAyB,OAAO,EAAE,CAAC,CAAC;QAC1C,IAAI,CAAC,IAAI,GAAG,yBAAyB,CAAC;QACtC,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,uBAAuB,CAAC,SAAS,CAAC,CAAC;IACjE,CAAC;CACF;AAED,MAAM,OAAO,qBAAsB,SAAQ,cAAc;IACvD,YAAY,OAAe;QACzB,KAAK,CAAC,uBAAuB,OAAO,EAAE,CAAC,CAAC;QACxC,IAAI,CAAC,IAAI,GAAG,uBAAuB,CAAC;QACpC,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,qBAAqB,CAAC,SAAS,CAAC,CAAC;IAC/D,CAAC;CACF;AAED,MAAM,UAAU,cAAc,CAAC,IAAY,EAAE,IAAsB;IACjE,IAAI,OAAe,CAAC;IACpB,IAAI,CAAC;QACH,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAChC,OAAO,GAAG,MAAM,CAAC,KAAK,IAAI,eAAe,CAAC;QAC5C,CAAC;aAAM,IAAI,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;YAC/D,OAAO,GAAG,MAAM,CAAE,IAA2B,CAAC,KAAK,CAAC,IAAI,eAAe,CAAC;QAC1E,CAAC;aAAM,CAAC;YACN,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,eAAe,CAAC;QAC5C,CAAC;IACH,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,eAAe,CAAC;IAC5C,CAAC;IAED,IAAI,IAAI,KAAK,GAAG,EAAE,CAAC;QACjB,MAAM,IAAI,YAAY,CAAC,OAAO,CAAC,CAAC;IAClC,CAAC;SAAM,IAAI,IAAI,KAAK,GAAG,EAAE,CAAC;QACxB,MAAM,IAAI,uBAAuB,CAAC,OAAO,CAAC,CAAC;IAC7C,CAAC;SAAM,IAAI,IAAI,KAAK,GAAG,EAAE,CAAC;QACxB,MAAM,IAAI,qBAAqB,CAAC,OAAO,CAAC,CAAC;IAC3C,CAAC;SAAM,IAAI,IAAI,KAAK,GAAG,EAAE,CAAC;QACxB,MAAM,IAAI,kBAAkB,CAAC,OAAO,CAAC,CAAC;IACxC,CAAC;SAAM,IAAI,IAAI,KAAK,GAAG,EAAE,CAAC;QACxB,MAAM,IAAI,iBAAiB,CAAC,OAAO,CAAC,CAAC;IACvC,CAAC;SAAM,IAAI,IAAI,KAAK,GAAG,EAAE,CAAC;QACxB,MAAM,IAAI,iBAAiB,CAAC,OAAO,CAAC,CAAC;IACvC,CAAC;SAAM,IAAI,IAAI,IAAI,GAAG,EAAE,CAAC;QACvB,MAAM,IAAI,eAAe,CAAC,8CAA8C,CAAC,CAAC;IAC5E,CAAC;SAAM,CAAC;QACN,MAAM,IAAI,YAAY,CAAC,6CAA6C,CAAC,CAAC;IACxE,CAAC;AACH,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Main export file for Endee-DB
+ */
+export { Endee } from './endee.js';
+export { Index } from './indexClient.js';
+export * from './exceptions.js';
+export * from './types/index.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACzC,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC"}

package/dist/index.js

@@ -0,0 +1,8 @@
+/**
+ * Main export file for Endee-DB
+ */
+export { Endee } from './endee.js';
+export { Index } from './indexClient.js';
+export * from './exceptions.js';
+export * from './types/index.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACzC,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC"}

package/dist/indexClient.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Index client for Endee-DB
+ */
+import type { VectorItem, QueryOptions, QueryResult, IndexInfo, IndexDescription } from './types/index.js';
+export declare class Index {
+    private name;
+    private token;
+    private url;
+    private count;
+    private space_type;
+    private dimension;
+    private precision;
+    private M;
+    constructor(name: string, token: string, url: string, _version?: number, params?: Partial<IndexInfo>);
+    toString(): string;
+    private _normalizeVector;
+    upsert(inputArray: VectorItem[]): Promise<string>;
+    query(options: QueryOptions): Promise<QueryResult[]>;
+    deleteVector(id: string): Promise<string>;
+    deleteWithFilter(filter: Record<string, unknown>): Promise<unknown>;
+    getVector(id: string): Promise<{
+        id: string;
+        meta: Record<string, unknown>;
+        filter: string;
+        norm: number;
+        vector: number[];
+    }>;
+    describe(): IndexDescription;
+}
+//# sourceMappingURL=indexClient.d.ts.map

package/dist/indexClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"indexClient.d.ts","sourceRoot":"","sources":["../src/indexClient.ts"],"names":[],"mappings":"AAAA;;GAEG;AAOH,OAAO,KAAK,EACV,UAAU,EACV,YAAY,EACZ,WAAW,EACX,SAAS,EACT,gBAAgB,EAEjB,MAAM,kBAAkB,CAAC;AAE1B,qBAAa,KAAK;IAChB,OAAO,CAAC,IAAI,CAAS;IACrB,OAAO,CAAC,KAAK,CAAS;IACtB,OAAO,CAAC,GAAG,CAAS;IACpB,OAAO,CAAC,KAAK,CAAS;IACtB,OAAO,CAAC,UAAU,CAAY;IAC9B,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,CAAC,CAAS;gBAGhB,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,EACb,GAAG,EAAE,MAAM,EACX,QAAQ,SAAI,EACZ,MAAM,GAAE,OAAO,CAAC,SAAS,CAAM;IAYjC,QAAQ,IAAI,MAAM;IAIlB,OAAO,CAAC,gBAAgB;IAalB,MAAM,CAAC,UAAU,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC;IA2CjD,KAAK,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;IA4FpD,YAAY,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAoBzC,gBAAgB,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAqBnE,SAAS,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC;QACnC,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAC9B,MAAM,EAAE,MAAM,CAAC;QACf,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,EAAE,MAAM,EAAE,CAAC;KAClB,CAAC;IAgCF,QAAQ,IAAI,gBAAgB;CAU7B"}