ragpack-js 0.1.0 → 1.0.0

package/README.md

@@ -5,13 +5,13 @@ TypeScript SDK for [RagPack](https://github.com/eozsahin1993/ragpack) — a self
 ## Installation
 
 ```bash
-npm install ragpack
+npm install ragpack-js
 ```
 
 ## Quick start
 
 ```ts
-import { RagPack } from "ragpack";
+import { RagPack } from "ragpack-js";
 
 const client = new RagPack({
   baseUrl: "http://localhost:9000",
@@ -24,7 +24,10 @@ const collection = await client.collections.create("my-docs");
 // Ingest a file
 await collection.ingest(file);
 
-// Or ingest from a remote URI
+// Or ingest from a URL
+await collection.ingest({ uri: "https://example.com/docs/guide" });
+
+// Or from S3
 await collection.ingest({ uri: "s3://my-bucket/report.pdf" });
 
 // Wait for ingestion to finish
@@ -67,13 +70,14 @@ Returns a `CollectionClient` scoped to that collection.
 | Method                              | Description                              |
 |-------------------------------------|------------------------------------------|
 | `ingest(file, filename?)`           | Upload a file directly                   |
-| `ingest({ uri, mimeType? })`        | Ingest from a remote URI, MIME type auto-detected if omitted |
+| `ingest({ uri, mimeType? })`        | Ingest from a URL or S3 URI, MIME type auto-detected if omitted |
 | `rag(options)`                      | Full RAG pipeline — retrieves chunks and returns an LLM answer |
 | `findSimilar({ query, topK? })`     | Semantic search without LLM, returns ranked chunks |
 | `jobs.list()`                       | List ingestion jobs for this collection  |
 | `jobs.get(id)`                      | Get a single job by ID                   |
 | `jobs.waitUntilComplete(id)`        | Poll until job is `complete` or `failed` |
 | `documents.list(options?)`          | List indexed documents                   |
+| `documents.rename(id, name)`        | Set the display name of a document       |
 | `documents.delete(id)`              | Delete a document and its chunks         |
 
 #### `rag(options)`
@@ -111,7 +115,7 @@ const prompts = await client.prompts.list();
 All methods throw `RagPackError` on non-2xx responses:
 
 ```ts
-import { RagPack, RagPackError } from "ragpack";
+import { RagPack, RagPackError } from "ragpack-js";
 
 try {
   await collection.findSimilar({ query: "..." });
@@ -126,3 +130,7 @@ try {
 
 - Node.js 18+
 - A running RagPack backend ([setup guide](https://github.com/eozsahin1993/ragpack))
+
+## License
+
+MIT

package/dist/index.cjs

@@ -118,6 +118,17 @@ var DocumentsResource = class {
     );
     return r.documents;
   }
+  /**
+   * Rename a document.
+   * @param id - The document ID.
+   * @param name - The new display name.
+   */
+  rename(id, name) {
+    return this.req(`/collections/${this.slug}/documents/${id}`, {
+      method: "PATCH",
+      body: JSON.stringify({ name })
+    });
+  }
   /**
    * Delete a document and all its chunks from this collection.
    * @param id - The document ID.
@@ -294,7 +305,7 @@ var EmbeddersResource = class {
   }
   /** List all configured embedding models and the server default. */
   list() {
-    return this.req("/embedders");
+    return this.req("/embeddings");
   }
 };
 

package/dist/index.d.cts

@@ -39,6 +39,7 @@ interface Job {
     collection_id: string;
     file_uri: string;
     mime_type: string;
+    display_name?: string;
     status: "pending" | "processing" | "complete" | "failed";
     error?: string;
     created_at: string;
@@ -50,6 +51,7 @@ interface Document {
     job_id: string;
     file_uri: string;
     mime_type: string;
+    name?: string;
     chunk_count: number;
     status: "ingesting" | "complete" | "failed";
     error?: string;
@@ -144,6 +146,12 @@ declare class DocumentsResource {
         limit?: number;
         offset?: number;
     }): Promise<Document[]>;
+    /**
+     * Rename a document.
+     * @param id - The document ID.
+     * @param name - The new display name.
+     */
+    rename(id: string, name: string): Promise<Document>;
     /**
      * Delete a document and all its chunks from this collection.
      * @param id - The document ID.

package/dist/index.d.ts

@@ -39,6 +39,7 @@ interface Job {
     collection_id: string;
     file_uri: string;
     mime_type: string;
+    display_name?: string;
     status: "pending" | "processing" | "complete" | "failed";
     error?: string;
     created_at: string;
@@ -50,6 +51,7 @@ interface Document {
     job_id: string;
     file_uri: string;
     mime_type: string;
+    name?: string;
     chunk_count: number;
     status: "ingesting" | "complete" | "failed";
     error?: string;
@@ -144,6 +146,12 @@ declare class DocumentsResource {
         limit?: number;
         offset?: number;
     }): Promise<Document[]>;
+    /**
+     * Rename a document.
+     * @param id - The document ID.
+     * @param name - The new display name.
+     */
+    rename(id: string, name: string): Promise<Document>;
     /**
      * Delete a document and all its chunks from this collection.
      * @param id - The document ID.

package/dist/index.js

@@ -91,6 +91,17 @@ var DocumentsResource = class {
     );
     return r.documents;
   }
+  /**
+   * Rename a document.
+   * @param id - The document ID.
+   * @param name - The new display name.
+   */
+  rename(id, name) {
+    return this.req(`/collections/${this.slug}/documents/${id}`, {
+      method: "PATCH",
+      body: JSON.stringify({ name })
+    });
+  }
   /**
    * Delete a document and all its chunks from this collection.
    * @param id - The document ID.
@@ -267,7 +278,7 @@ var EmbeddersResource = class {
   }
   /** List all configured embedding models and the server default. */
   list() {
-    return this.req("/embedders");
+    return this.req("/embeddings");
   }
 };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ragpack-js",
-  "version": "0.1.0",
+  "version": "1.0.0",
   "description": "TypeScript client for the Ragpack self-hosted RAG engine",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -32,7 +32,7 @@
     "node": ">=18"
   },
   "type": "module",
-  "license": "MIT",
+  "license": "Apache-2.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/eozsahin1993/ragpack.git",