cognitor 0.1.0

package/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright (c) 2026 Riccardo Lucato
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,155 @@
+# cognitor-typescript
+
+TypeScript SDK for [Cognitor](https://github.com/tanaos/cognitor).
+
+## Installation
+
+```bash
+npm install cognitor
+```
+
+## Quick start
+
+```ts
+import { Cognitor } from "cognitor";
+
+const client = new Cognitor("http://localhost:7530", {
+	apiKey: "your-api-key",
+});
+
+console.log(await client.ping());
+console.log(await client.healthReady()); // "ready" or "loading"
+
+client.close();
+```
+
+The `apiKey` parameter is optional, omit it if your [cognitor instance](https://github.com/tanaos/cognitor) does not require authentication.
+
+## Usage
+
+### Collections
+
+```ts
+// Create a collection (server-side embedding)
+const collection = await client.createCollection("my-collection", {
+	embModel: "text-embedding-3-small",
+});
+
+// Create a collection with a fixed vector dimension (client-side embedding)
+const collectionWithDim = await client.createCollection("my-collection-2", {
+	dim: 1536,
+});
+
+// List all collections
+const collections = await client.listCollections();
+
+// Get a single collection
+const oneCollection = await client.getCollection("my-collection");
+
+// Delete a collection
+await client.deleteCollection("my-collection");
+```
+
+### Documents
+
+```ts
+// Add documents (texts are embedded server-side when embModel is set)
+const ids = await client.addDocuments(
+	"my-collection",
+	["Hello world", "Cognitor is a vector store"],
+	[{ source: "docs" }, { source: "docs" }],
+);
+
+// Add documents with explicit vectors (client-side embedding)
+const idsWithVectors = await client.addDocuments(
+	"my-collection",
+	["Hello world"],
+	[{ source: "docs" }],
+	{ vectors: [[0.1, 0.2]] },
+);
+
+// Add a large number of documents in batches
+const bulkIds = await client.bulkAddDocuments(
+	"my-collection",
+	["doc 1", "doc 2"],
+	[{ source: "docs" }, { source: "docs" }],
+	{ batchSize: 512 },
+);
+
+// List documents (paginated)
+const page = await client.listDocuments("my-collection", { offset: 0, limit: 50 });
+console.log(page.total, page.documents);
+
+// Get a single document
+const doc = await client.getDocument("my-collection", ids[0]);
+
+// Update document metadata
+const updated = await client.updateDocumentMetadata("my-collection", ids[0], {
+	source: "updated",
+});
+
+// Delete a document
+await client.deleteDocument("my-collection", ids[0]);
+```
+
+### Search
+
+```ts
+// Search by text (requires server-side embedding model)
+const byText = await client.search("my-collection", {
+	queryText: "Hello",
+	topK: 10,
+});
+
+// Search by vector
+const byVector = await client.search("my-collection", {
+	queryVector: [0.1, 0.2],
+	topK: 10,
+});
+
+// Filter results by metadata
+const filtered = await client.search("my-collection", {
+	queryText: "Hello",
+	filters: { source: "docs" },
+});
+
+// Include vectors in results
+const withVectors = await client.search("my-collection", {
+	queryText: "Hello",
+	includeVectors: true,
+});
+
+for (const hit of withVectors.results) {
+	console.log(`score=${hit.score.toFixed(4)} text=${JSON.stringify(hit.text)}`);
+}
+```
+
+### Admin
+
+```ts
+// Compact a collection (removes deleted vectors)
+const result = await client.compact("my-collection");
+console.log(result.deletedCount, "vectors removed");
+```
+
+### Health
+
+```ts
+// Readiness probe status
+const status = await client.healthReady();
+if (status === "ready") {
+	console.log("Server is ready");
+} else {
+	console.log("Server is still loading models");
+}
+```
+
+### Authentication helpers
+
+```ts
+// Register a user and obtain an API key
+const apiKey = await client.register("username", "password");
+
+// Login and obtain an API key
+const newApiKey = await client.login("username", "password");
+```

package/dist/client.d.ts

@@ -0,0 +1,58 @@
+import { Collection, CompactionResult, Document, ListDocumentsResult, Metadata, SearchResponse, Vector } from "./models.js";
+interface CognitorOptions {
+    apiKey?: string;
+    timeout?: number;
+    fetchImpl?: typeof fetch;
+}
+type HealthReadyStatus = "ready" | "loading";
+export declare class Cognitor {
+    private readonly baseUrl;
+    private readonly headers;
+    private readonly timeoutMs;
+    private readonly fetchFn;
+    constructor(baseUrl: string, options?: CognitorOptions);
+    close(): void;
+    ping(): Promise<string>;
+    healthReady(): Promise<HealthReadyStatus>;
+    listCollections(): Promise<Collection[]>;
+    getCollection(name: string): Promise<Collection>;
+    createCollection(name: string, options?: {
+        dim?: number;
+        embModel?: string;
+    }): Promise<Collection>;
+    deleteCollection(name: string): Promise<void>;
+    addDocuments(collection: string, texts: string[], metadatas: Metadata[], options?: {
+        vectors?: Vector[];
+    }): Promise<string[]>;
+    bulkAddDocuments(collection: string, texts: string[], metadatas: Metadata[], options?: {
+        vectors?: Vector[];
+        batchSize?: number;
+    }): Promise<string[]>;
+    listDocuments(collection: string, options?: {
+        offset?: number;
+        limit?: number;
+    }): Promise<ListDocumentsResult>;
+    getDocument(collection: string, docId: string): Promise<Document>;
+    deleteDocument(collection: string, docId: string): Promise<void>;
+    updateDocumentMetadata(collection: string, docId: string, metadata: Metadata): Promise<Document>;
+    search(collection: string, options?: {
+        queryText?: string;
+        queryVector?: Vector;
+        topK?: number;
+        filters?: Metadata;
+        includeVectors?: boolean;
+        performExtractiveQA?: boolean;
+        performReranking?: boolean;
+    }): Promise<SearchResponse>;
+    compact(collection: string): Promise<CompactionResult>;
+    register(username: string, password: string): Promise<string>;
+    login(username: string, password: string): Promise<string>;
+    private mapCollection;
+    private mapCompactionResult;
+    private mapSearchResult;
+    private request;
+    private requestRaw;
+    private makeHeaders;
+    private raiseForStatus;
+}
+export {};

package/dist/client.js

@@ -0,0 +1,278 @@
+import { AuthenticationError, CognitorError, ConflictError, NotFoundError, ServerError, ValidationError, } from "./exceptions.js";
+export class Cognitor {
+    baseUrl;
+    headers;
+    timeoutMs;
+    fetchFn;
+    constructor(baseUrl, options = {}) {
+        this.baseUrl = baseUrl.replace(/\/+$/, "");
+        this.headers = new Headers();
+        if (options.apiKey) {
+            this.headers.set("Authorization", `Bearer ${options.apiKey}`);
+        }
+        this.timeoutMs = (options.timeout ?? 30) * 1000;
+        this.fetchFn = (options.fetchImpl ?? fetch).bind(globalThis);
+    }
+    close() {
+        // Kept for parity with the Python SDK. No explicit teardown is required for fetch.
+    }
+    // ------------------------------------------------------------------
+    // Base
+    // ------------------------------------------------------------------
+    async ping() {
+        const response = await this.request("/");
+        return (await response.json());
+    }
+    async healthReady() {
+        const response = await this.requestRaw("/health/ready", { method: "GET" });
+        if (response.status === 200) {
+            return "ready";
+        }
+        if (response.status === 503) {
+            return "loading";
+        }
+        await this.raiseForStatus(response);
+        return "loading";
+    }
+    // ------------------------------------------------------------------
+    // Collections
+    // ------------------------------------------------------------------
+    async listCollections() {
+        const response = await this.request("/collections");
+        const body = (await response.json());
+        return body.collections.map((collection) => this.mapCollection(collection));
+    }
+    async getCollection(name) {
+        const response = await this.request(`/collections/${encodeURIComponent(name)}`);
+        return this.mapCollection((await response.json()));
+    }
+    async createCollection(name, options = {}) {
+        const body = { name };
+        if (options.dim !== undefined) {
+            body.dim = options.dim;
+        }
+        if (options.embModel !== undefined) {
+            body.emb_model = options.embModel;
+        }
+        const response = await this.request("/collections", {
+            method: "POST",
+            body: JSON.stringify(body),
+        });
+        return this.mapCollection((await response.json()));
+    }
+    async deleteCollection(name) {
+        await this.request(`/collections/${encodeURIComponent(name)}`, { method: "DELETE" });
+    }
+    // ------------------------------------------------------------------
+    // Documents
+    // ------------------------------------------------------------------
+    async addDocuments(collection, texts, metadatas, options = {}) {
+        const body = {
+            texts,
+            metadatas,
+        };
+        if (options.vectors !== undefined) {
+            body.vectors = options.vectors;
+        }
+        const response = await this.request(`/collections/${encodeURIComponent(collection)}/documents`, {
+            method: "POST",
+            body: JSON.stringify(body),
+        });
+        const data = (await response.json());
+        return data.ids;
+    }
+    async bulkAddDocuments(collection, texts, metadatas, options = {}) {
+        const body = {
+            texts,
+            metadatas,
+        };
+        if (options.vectors !== undefined) {
+            body.vectors = options.vectors;
+        }
+        const batchSize = options.batchSize ?? 512;
+        const query = new URLSearchParams({ batch_size: String(batchSize) }).toString();
+        const response = await this.request(`/collections/${encodeURIComponent(collection)}/documents/bulk?${query}`, {
+            method: "POST",
+            body: JSON.stringify(body),
+        });
+        const data = (await response.json());
+        return data.ids;
+    }
+    async listDocuments(collection, options = {}) {
+        const offset = options.offset ?? 0;
+        const limit = options.limit ?? 50;
+        const query = new URLSearchParams({
+            offset: String(offset),
+            limit: String(limit),
+        }).toString();
+        const response = await this.request(`/collections/${encodeURIComponent(collection)}/documents?${query}`);
+        return (await response.json());
+    }
+    async getDocument(collection, docId) {
+        const response = await this.request(`/collections/${encodeURIComponent(collection)}/documents/${encodeURIComponent(docId)}`);
+        return (await response.json());
+    }
+    async deleteDocument(collection, docId) {
+        await this.request(`/collections/${encodeURIComponent(collection)}/documents/${encodeURIComponent(docId)}`, { method: "DELETE" });
+    }
+    async updateDocumentMetadata(collection, docId, metadata) {
+        const response = await this.request(`/collections/${encodeURIComponent(collection)}/documents/${encodeURIComponent(docId)}/metadata`, {
+            method: "PATCH",
+            body: JSON.stringify({ metadata }),
+        });
+        return (await response.json());
+    }
+    // ------------------------------------------------------------------
+    // Search
+    // ------------------------------------------------------------------
+    async search(collection, options = {}) {
+        const body = {
+            top_k: options.topK ?? 5,
+            include_vectors: options.includeVectors ?? false,
+            perform_extractive_qa: options.performExtractiveQA ?? true,
+            perform_reranking: options.performReranking ?? true,
+        };
+        if (options.queryText !== undefined) {
+            body.query_text = options.queryText;
+        }
+        if (options.queryVector !== undefined) {
+            body.query_vector = options.queryVector;
+        }
+        if (options.filters !== undefined) {
+            body.filters = options.filters;
+        }
+        const response = await this.request(`/collections/${encodeURIComponent(collection)}/search`, {
+            method: "POST",
+            body: JSON.stringify(body),
+        });
+        const data = (await response.json());
+        return {
+            total: data.total,
+            results: data.results.map((result) => this.mapSearchResult(result)),
+        };
+    }
+    // ------------------------------------------------------------------
+    // Admin
+    // ------------------------------------------------------------------
+    async compact(collection) {
+        const response = await this.request(`/admin/collections/${encodeURIComponent(collection)}/compact`, { method: "POST" });
+        return this.mapCompactionResult((await response.json()));
+    }
+    // ------------------------------------------------------------------
+    // Base
+    // ------------------------------------------------------------------
+    async register(username, password) {
+        const response = await this.request("/auth/register", {
+            method: "POST",
+            body: JSON.stringify({ username, password }),
+        });
+        const data = (await response.json());
+        return data.api_key;
+    }
+    async login(username, password) {
+        const response = await this.request("/auth/login", {
+            method: "POST",
+            body: JSON.stringify({ username, password }),
+        });
+        const data = (await response.json());
+        return data.api_key;
+    }
+    // ------------------------------------------------------------------
+    // Helpers
+    // ------------------------------------------------------------------
+    mapCollection(collection) {
+        return {
+            name: collection.name,
+            dim: collection.dim,
+            docCount: collection.doc_count,
+            embModel: collection.emb_model,
+        };
+    }
+    mapCompactionResult(result) {
+        return {
+            collectionName: result.collection_name,
+            vectorsBefore: result.vectors_before,
+            liveCount: result.live_count,
+            deletedCount: result.deleted_count,
+        };
+    }
+    mapSearchResult(result) {
+        return {
+            id: result.id,
+            score: result.score,
+            text: result.text,
+            metadata: result.metadata,
+            vector: result.vector,
+            answer: result.answer,
+        };
+    }
+    async request(path, init = {}) {
+        const response = await this.requestRaw(path, init);
+        await this.raiseForStatus(response);
+        return response;
+    }
+    async requestRaw(path, init) {
+        const controller = new AbortController();
+        const timeout = setTimeout(() => controller.abort(), this.timeoutMs);
+        try {
+            return await this.fetchFn(`${this.baseUrl}${path}`, {
+                ...init,
+                headers: this.makeHeaders(init.headers),
+                signal: controller.signal,
+            });
+        }
+        catch (error) {
+            if (error instanceof Error && error.name === "AbortError") {
+                throw new CognitorError(`Request timed out after ${this.timeoutMs}ms`);
+            }
+            throw error;
+        }
+        finally {
+            clearTimeout(timeout);
+        }
+    }
+    makeHeaders(requestHeaders) {
+        const headers = new Headers(this.headers);
+        if (requestHeaders) {
+            const incoming = new Headers(requestHeaders);
+            incoming.forEach((value, key) => headers.set(key, value));
+        }
+        if (!headers.has("Content-Type")) {
+            headers.set("Content-Type", "application/json");
+        }
+        return headers;
+    }
+    async raiseForStatus(response) {
+        if (response.ok) {
+            return;
+        }
+        let message = "";
+        try {
+            const json = (await response.clone().json());
+            message = typeof json.message === "string" ? json.message : "";
+        }
+        catch {
+            // Ignore JSON parsing errors and fall back to text.
+        }
+        if (!message) {
+            message = await response.text();
+        }
+        const code = response.status;
+        if (code === 401) {
+            throw new AuthenticationError(message, code);
+        }
+        if (code === 404) {
+            throw new NotFoundError(message, code);
+        }
+        if (code === 409) {
+            throw new ConflictError(message, code);
+        }
+        if (code === 400 || code === 422) {
+            throw new ValidationError(message, code);
+        }
+        if (code >= 500) {
+            throw new ServerError(message, code);
+        }
+        throw new CognitorError(message, code);
+    }
+}

package/dist/exceptions.d.ts

@@ -0,0 +1,19 @@
+export declare class CognitorError extends Error {
+    readonly statusCode?: number;
+    constructor(message: string, statusCode?: number);
+}
+export declare class AuthenticationError extends CognitorError {
+    constructor(message: string, statusCode?: number);
+}
+export declare class NotFoundError extends CognitorError {
+    constructor(message: string, statusCode?: number);
+}
+export declare class ConflictError extends CognitorError {
+    constructor(message: string, statusCode?: number);
+}
+export declare class ValidationError extends CognitorError {
+    constructor(message: string, statusCode?: number);
+}
+export declare class ServerError extends CognitorError {
+    constructor(message: string, statusCode?: number);
+}

package/dist/exceptions.js

@@ -0,0 +1,38 @@
+export class CognitorError extends Error {
+    statusCode;
+    constructor(message, statusCode) {
+        super(message);
+        this.name = "CognitorError";
+        this.statusCode = statusCode;
+    }
+}
+export class AuthenticationError extends CognitorError {
+    constructor(message, statusCode) {
+        super(message, statusCode);
+        this.name = "AuthenticationError";
+    }
+}
+export class NotFoundError extends CognitorError {
+    constructor(message, statusCode) {
+        super(message, statusCode);
+        this.name = "NotFoundError";
+    }
+}
+export class ConflictError extends CognitorError {
+    constructor(message, statusCode) {
+        super(message, statusCode);
+        this.name = "ConflictError";
+    }
+}
+export class ValidationError extends CognitorError {
+    constructor(message, statusCode) {
+        super(message, statusCode);
+        this.name = "ValidationError";
+    }
+}
+export class ServerError extends CognitorError {
+    constructor(message, statusCode) {
+        super(message, statusCode);
+        this.name = "ServerError";
+    }
+}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { Cognitor } from "./client.js";
+export { AuthenticationError, CognitorError, ConflictError, NotFoundError, ServerError, ValidationError, } from "./exceptions.js";
+export type { AnswerPassage, Collection, CompactionResult, Document, ListDocumentsResult, Metadata, SearchResponse, SearchResult, Vector, } from "./models.js";

package/dist/index.js

@@ -0,0 +1,2 @@
+export { Cognitor } from "./client.js";
+export { AuthenticationError, CognitorError, ConflictError, NotFoundError, ServerError, ValidationError, } from "./exceptions.js";

package/dist/models.d.ts

@@ -0,0 +1,43 @@
+export type Vector = number[];
+export type Metadata = Record<string, unknown>;
+export interface Collection {
+    name: string;
+    dim: number;
+    docCount: number;
+    embModel?: string;
+}
+export interface Document {
+    id: string;
+    vector: Vector;
+    text: string;
+    metadata: Metadata;
+}
+export interface ListDocumentsResult {
+    documents: Document[];
+    total: number;
+    offset: number;
+    limit: number;
+}
+export interface AnswerPassage {
+    passage: string;
+    start: number;
+    end: number;
+}
+export interface SearchResult {
+    id: string;
+    score: number;
+    text: string;
+    metadata: Metadata;
+    vector?: Vector;
+    answer?: AnswerPassage;
+}
+export interface SearchResponse {
+    results: SearchResult[];
+    total: number;
+}
+export interface CompactionResult {
+    collectionName: string;
+    vectorsBefore: number;
+    liveCount: number;
+    deletedCount: number;
+}

package/dist/models.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "cognitor",
+  "version": "0.1.0",
+  "description": "TypeScript SDK for the Cognitor search platform API.",
+  "license": "SEE LICENSE IN LICENSE.md",
+  "author": "Riccardo Lucato <riccardo@tanaos.com>",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/tanaos/cognitor-typescript.git"
+  },
+  "bugs": {
+    "url": "https://github.com/tanaos/cognitor-typescript/issues"
+  },
+  "homepage": "https://github.com/tanaos/cognitor-typescript#readme",
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "clean": "rm -rf dist",
+    "prepublishOnly": "npm run clean && npm run build"
+  },
+  "devDependencies": {
+    "typescript": "^5.8.3"
+  }
+}