@larkup-rag/client-js 1.0.0 → 1.0.1

package/README.md

@@ -0,0 +1,59 @@
+# Larkup RAG JavaScript SDK
+
+The official JavaScript/TypeScript client for the **Larkup RAG** platform. 
+
+This SDK provides a convenient interface to connect your Node.js or browser applications to a running Larkup RAG server. It abstracts away the API layer so you can focus on building your AI agents and applications.
+
+## Installation
+
+Install the SDK via npm, yarn, or pnpm:
+
+```bash
+npm install @larkup-rag/client-js
+```
+
+## Quick Start
+
+Initialize the `LarkupRAGClient` with the URL of your running Larkup RAG server. 
+
+```typescript
+import { LarkupRAGClient } from "@larkup-rag/client-js";
+
+// Initialize the client
+const client = new LarkupRAGClient({
+  baseUrl: "http://localhost:4567", // Replace with your deployed server URL
+});
+
+async function main() {
+  // 1. Query the RAG Pipeline
+  const queryResponse = await client.query({
+    query: "What is Larkup?",
+    topK: 5
+  });
+
+  console.log("Retrieved Documents:", queryResponse.hits);
+
+  // 2. Add Documents to the Pipeline
+  await client.documents.add({
+    content: "Larkup is building a new learning system for the AI Era.",
+    metadata: { source: "manual-entry" }
+  });
+  
+  // 3. Trigger Indexing
+  await client.index();
+  console.log("Documents indexed successfully.");
+}
+
+main();
+```
+
+## Features
+
+- **Querying**: Easily execute semantic searches against your vector store.
+- **Data Ingestion**: Add text, URLs, and files programmatically.
+- **Indexing**: Trigger ETL pipelines to chunk and embed documents on the fly.
+- **TypeScript Support**: Full type safety out-of-the-box.
+
+## Documentation
+
+For full API reference and advanced usage, visit the [Larkup Documentation](https://larkup.de/docs).

package/package.json

@@ -1,30 +1,33 @@
 {
   "name": "@larkup-rag/client-js",
-  "version": "1.0.0",
+  "version": "1.0.1",
+  "publishConfig": {
+    "access": "public"
+  },
   "description": "JavaScript/TypeScript SDK for Larkup RAG servers",
-  "main": "./dist/index.js",
-  "module": "./dist/index.mjs",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "type": "module",
   "exports": {
     ".": {
-      "require": "./dist/index.js",
-      "import": "./dist/index.mjs",
-      "types": "./dist/index.d.ts"
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.cjs",
+      "import": "./dist/index.js"
     }
   },
   "files": [
     "dist"
   ],
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm --dts",
+    "dev": "tsup src/index.ts --format cjs,esm --dts --watch",
+    "test": "vitest run"
+  },
   "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"
   }
-}
+}