@larkup-rag/client-js 1.0.0

package/dist/index.cjs

@@ -0,0 +1,127 @@
+"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);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  LarkupRAGClient: () => LarkupRAGClient
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/client.ts
+var LarkupRAGClient = class {
+  baseUrl;
+  apiKey;
+  constructor(options = {}) {
+    this.baseUrl = (options.baseUrl ?? process.env.LARKUP_RAG_API_URL ?? "http://localhost:8080").replace(/\/$/, "");
+    this.apiKey = options.apiKey ?? process.env.LARKUP_RAG_API_KEY;
+  }
+  async fetchApi(path, options = {}) {
+    const url = `${this.baseUrl}${path}`;
+    const headers = new Headers(options.headers || {});
+    if (this.apiKey) {
+      headers.set("Authorization", `Bearer ${this.apiKey}`);
+    }
+    if (!(options.body instanceof FormData)) {
+      headers.set("Content-Type", "application/json");
+    }
+    const response = await fetch(url, { ...options, headers });
+    if (!response.ok) {
+      let errorMsg = response.statusText;
+      try {
+        const errBody = await response.json();
+        if (errBody.error) {
+          errorMsg = errBody.error;
+        }
+      } catch {
+      }
+      throw new Error(`LarkupRAG API Error (${response.status}): ${errorMsg}`);
+    }
+    return response.json();
+  }
+  /**
+   * Health check
+   */
+  async health() {
+    return this.fetchApi("/health");
+  }
+  /**
+   * Query the RAG knowledge base
+   */
+  async query(request, topK) {
+    const body = typeof request === "string" ? { query: request, topK } : request;
+    return this.fetchApi("/query", {
+      method: "POST",
+      body: JSON.stringify(body)
+    });
+  }
+  /**
+   * List documents with pagination
+   */
+  async listDocuments(page = 1, limit = 20) {
+    return this.fetchApi(
+      `/documents?page=${page}&limit=${limit}`
+    );
+  }
+  /**
+   * Get a specific document by ID
+   */
+  async getDocument(id) {
+    return this.fetchApi(`/documents/${id}`);
+  }
+  /**
+   * Add a new document to the vector store
+   */
+  async addDocument(document) {
+    return this.fetchApi("/documents", {
+      method: "POST",
+      body: JSON.stringify(document)
+    });
+  }
+  /**
+   * Update an existing document
+   */
+  async updateDocument(id, document) {
+    return this.fetchApi(`/documents/${id}`, {
+      method: "PUT",
+      body: JSON.stringify(document)
+    });
+  }
+  /**
+   * Delete a document
+   */
+  async deleteDocument(id) {
+    return this.fetchApi(`/documents/${id}`, {
+      method: "DELETE"
+    });
+  }
+  /**
+   * Scrape a URL and add it to the corpus
+   */
+  async scrape(url) {
+    return this.fetchApi("/scrape", {
+      method: "POST",
+      body: JSON.stringify({ url })
+    });
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  LarkupRAGClient
+});

package/dist/index.d.cts

@@ -0,0 +1,98 @@
+interface LarkupRAGClientOptions {
+    /** The URL of the Larkup RAG Server (e.g. http://localhost:8080) */
+    baseUrl?: string;
+    /** The server API key, required if the server is protected */
+    apiKey?: string;
+}
+interface Document {
+    id: string;
+    text: string;
+    title?: string;
+    url?: string;
+    documentId?: string;
+}
+interface QueryRequest {
+    query: string;
+    topK?: number;
+}
+interface QueryHit {
+    id: string;
+    score: number;
+    text: string;
+    title: string;
+    url?: string;
+    documentId: string;
+}
+interface QueryResponse {
+    query: string;
+    hits: QueryHit[];
+}
+interface PaginatedDocuments {
+    documents: Document[];
+    total: number;
+    page: number;
+    limit: number;
+    totalPages: number;
+}
+interface ScrapeRequest {
+    url: string;
+}
+interface ScrapeResponse {
+    success: boolean;
+    documentId?: string;
+    error?: string;
+}
+interface HealthResponse {
+    ok: boolean;
+    service?: string;
+}
+
+declare class LarkupRAGClient {
+    private baseUrl;
+    private apiKey?;
+    constructor(options?: LarkupRAGClientOptions);
+    private fetchApi;
+    /**
+     * Health check
+     */
+    health(): Promise<HealthResponse>;
+    /**
+     * Query the RAG knowledge base
+     */
+    query(request: QueryRequest | string, topK?: number): Promise<QueryResponse>;
+    /**
+     * List documents with pagination
+     */
+    listDocuments(page?: number, limit?: number): Promise<PaginatedDocuments>;
+    /**
+     * Get a specific document by ID
+     */
+    getDocument(id: string): Promise<Document>;
+    /**
+     * Add a new document to the vector store
+     */
+    addDocument(document: Omit<Document, "id"> & {
+        id?: string;
+    }): Promise<{
+        success: boolean;
+        id: string;
+    }>;
+    /**
+     * Update an existing document
+     */
+    updateDocument(id: string, document: Omit<Document, "id">): Promise<{
+        success: boolean;
+    }>;
+    /**
+     * Delete a document
+     */
+    deleteDocument(id: string): Promise<{
+        success: boolean;
+    }>;
+    /**
+     * Scrape a URL and add it to the corpus
+     */
+    scrape(url: string): Promise<ScrapeResponse>;
+}
+
+export { type Document, type HealthResponse, LarkupRAGClient, type LarkupRAGClientOptions, type PaginatedDocuments, type QueryHit, type QueryRequest, type QueryResponse, type ScrapeRequest, type ScrapeResponse };

package/dist/index.d.ts

@@ -0,0 +1,98 @@
+interface LarkupRAGClientOptions {
+    /** The URL of the Larkup RAG Server (e.g. http://localhost:8080) */
+    baseUrl?: string;
+    /** The server API key, required if the server is protected */
+    apiKey?: string;
+}
+interface Document {
+    id: string;
+    text: string;
+    title?: string;
+    url?: string;
+    documentId?: string;
+}
+interface QueryRequest {
+    query: string;
+    topK?: number;
+}
+interface QueryHit {
+    id: string;
+    score: number;
+    text: string;
+    title: string;
+    url?: string;
+    documentId: string;
+}
+interface QueryResponse {
+    query: string;
+    hits: QueryHit[];
+}
+interface PaginatedDocuments {
+    documents: Document[];
+    total: number;
+    page: number;
+    limit: number;
+    totalPages: number;
+}
+interface ScrapeRequest {
+    url: string;
+}
+interface ScrapeResponse {
+    success: boolean;
+    documentId?: string;
+    error?: string;
+}
+interface HealthResponse {
+    ok: boolean;
+    service?: string;
+}
+
+declare class LarkupRAGClient {
+    private baseUrl;
+    private apiKey?;
+    constructor(options?: LarkupRAGClientOptions);
+    private fetchApi;
+    /**
+     * Health check
+     */
+    health(): Promise<HealthResponse>;
+    /**
+     * Query the RAG knowledge base
+     */
+    query(request: QueryRequest | string, topK?: number): Promise<QueryResponse>;
+    /**
+     * List documents with pagination
+     */
+    listDocuments(page?: number, limit?: number): Promise<PaginatedDocuments>;
+    /**
+     * Get a specific document by ID
+     */
+    getDocument(id: string): Promise<Document>;
+    /**
+     * Add a new document to the vector store
+     */
+    addDocument(document: Omit<Document, "id"> & {
+        id?: string;
+    }): Promise<{
+        success: boolean;
+        id: string;
+    }>;
+    /**
+     * Update an existing document
+     */
+    updateDocument(id: string, document: Omit<Document, "id">): Promise<{
+        success: boolean;
+    }>;
+    /**
+     * Delete a document
+     */
+    deleteDocument(id: string): Promise<{
+        success: boolean;
+    }>;
+    /**
+     * Scrape a URL and add it to the corpus
+     */
+    scrape(url: string): Promise<ScrapeResponse>;
+}
+
+export { type Document, type HealthResponse, LarkupRAGClient, type LarkupRAGClientOptions, type PaginatedDocuments, type QueryHit, type QueryRequest, type QueryResponse, type ScrapeRequest, type ScrapeResponse };

package/dist/index.js

@@ -0,0 +1,100 @@
+// src/client.ts
+var LarkupRAGClient = class {
+  baseUrl;
+  apiKey;
+  constructor(options = {}) {
+    this.baseUrl = (options.baseUrl ?? process.env.LARKUP_RAG_API_URL ?? "http://localhost:8080").replace(/\/$/, "");
+    this.apiKey = options.apiKey ?? process.env.LARKUP_RAG_API_KEY;
+  }
+  async fetchApi(path, options = {}) {
+    const url = `${this.baseUrl}${path}`;
+    const headers = new Headers(options.headers || {});
+    if (this.apiKey) {
+      headers.set("Authorization", `Bearer ${this.apiKey}`);
+    }
+    if (!(options.body instanceof FormData)) {
+      headers.set("Content-Type", "application/json");
+    }
+    const response = await fetch(url, { ...options, headers });
+    if (!response.ok) {
+      let errorMsg = response.statusText;
+      try {
+        const errBody = await response.json();
+        if (errBody.error) {
+          errorMsg = errBody.error;
+        }
+      } catch {
+      }
+      throw new Error(`LarkupRAG API Error (${response.status}): ${errorMsg}`);
+    }
+    return response.json();
+  }
+  /**
+   * Health check
+   */
+  async health() {
+    return this.fetchApi("/health");
+  }
+  /**
+   * Query the RAG knowledge base
+   */
+  async query(request, topK) {
+    const body = typeof request === "string" ? { query: request, topK } : request;
+    return this.fetchApi("/query", {
+      method: "POST",
+      body: JSON.stringify(body)
+    });
+  }
+  /**
+   * List documents with pagination
+   */
+  async listDocuments(page = 1, limit = 20) {
+    return this.fetchApi(
+      `/documents?page=${page}&limit=${limit}`
+    );
+  }
+  /**
+   * Get a specific document by ID
+   */
+  async getDocument(id) {
+    return this.fetchApi(`/documents/${id}`);
+  }
+  /**
+   * Add a new document to the vector store
+   */
+  async addDocument(document) {
+    return this.fetchApi("/documents", {
+      method: "POST",
+      body: JSON.stringify(document)
+    });
+  }
+  /**
+   * Update an existing document
+   */
+  async updateDocument(id, document) {
+    return this.fetchApi(`/documents/${id}`, {
+      method: "PUT",
+      body: JSON.stringify(document)
+    });
+  }
+  /**
+   * Delete a document
+   */
+  async deleteDocument(id) {
+    return this.fetchApi(`/documents/${id}`, {
+      method: "DELETE"
+    });
+  }
+  /**
+   * Scrape a URL and add it to the corpus
+   */
+  async scrape(url) {
+    return this.fetchApi("/scrape", {
+      method: "POST",
+      body: JSON.stringify({ url })
+    });
+  }
+};
+export {
+  LarkupRAGClient
+};

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@larkup-rag/client-js",
+  "version": "1.0.0",
+  "description": "JavaScript/TypeScript SDK for Larkup RAG servers",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "type": "module",
+  "exports": {
+    ".": {
+      "require": "./dist/index.js",
+      "import": "./dist/index.mjs",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "devDependencies": {
+    "@types/node": "^26.0.0",
+    "tsup": "^8.5.1",
+    "typescript": "^5.7.3",
+    "vitest": "^1.6.1"
+  },
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm --dts",
+    "dev": "tsup src/index.ts --format cjs,esm --dts --watch",
+    "test": "vitest run"
+  }
+}