@rcrsr/rill-ext-chroma 0.8.6 → 0.11.0

package/README.md

@@ -38,230 +38,16 @@ const result = await execute(parse(script), ctx);
 dispose?.();
 ```
 
-## Host Functions
-
-All vector database extensions share identical function signatures. Swap `chroma::` for `qdrant::` or `pinecone::` with no script changes.
-
-### chroma::upsert(id, vector, metadata?)
-
-Insert or update a single vector with metadata.
-
-```rill
-chroma::upsert("doc-1", $embedding, [title: "Example", page: 1]) => $result
-$result.id -> log       # "doc-1"
-$result.success -> log  # true
-```
-
-**Idempotent.** Duplicate ID overwrites existing vector.
-
-### chroma::upsert_batch(items)
-
-Batch insert or update vectors. Processes sequentially; halts on first failure.
-
-```rill
-chroma::upsert_batch([
-  [id: "doc-1", vector: $v1, metadata: [title: "First"]],
-  [id: "doc-2", vector: $v2, metadata: [title: "Second"]]
-]) => $result
-$result.succeeded -> log  # 2
-```
-
-Returns `{ succeeded }` on success. Returns `{ succeeded, failed, error }` on failure.
-
-### chroma::search(vector, options?)
-
-Search for k nearest neighbors.
-
-```rill
-chroma::search($embedding, [k: 5, score_threshold: 0.8]) => $results
-$results -> each { "{.id}: {.score}" -> log }
-```
-
-| Option | Type | Default | Description |
-|--------|------|---------|-------------|
-| `k` | number | `10` | Max results to return |
-| `filter` | dict | `{}` | Metadata filter conditions |
-| `score_threshold` | number | (none) | Exclude results below threshold |
-
-Returns `[{ id, score, metadata }]`. Empty results return `[]`.
-
-### chroma::get(id)
-
-Fetch a vector by ID.
-
-```rill
-chroma::get("doc-1") => $point
-$point.id -> log        # "doc-1"
-$point.metadata -> log  # [title: "Example", page: 1]
-```
-
-Returns `{ id, vector, metadata }`. Halts with error if ID not found.
-
-### chroma::delete(id)
-
-Delete a vector by ID.
-
-```rill
-chroma::delete("doc-1") => $result
-$result.deleted -> log  # true
-```
-
-Returns `{ id, deleted }`. Halts with error if ID not found.
-
-### chroma::delete_batch(ids)
-
-Batch delete vectors. Processes sequentially; halts on first failure.
-
-```rill
-chroma::delete_batch(["doc-1", "doc-2", "doc-3"]) => $result
-$result.succeeded -> log  # 3
-```
-
-Returns `{ succeeded }` on success. Returns `{ succeeded, failed, error }` on failure.
-
-### chroma::count()
-
-Count vectors in the collection.
-
-```rill
-chroma::count() -> log  # 42
-```
-
-Returns a number.
-
-### chroma::create_collection(name, options?)
-
-Create a new collection.
-
-```rill
-chroma::create_collection("my_vectors", [dimensions: 384, distance: "cosine"]) => $result
-$result.created -> log  # true
-```
-
-| Option | Type | Default | Description |
-|--------|------|---------|-------------|
-| `dimensions` | number | (none) | Vector dimension size |
-| `distance` | string | `"cosine"` | `"cosine"`, `"euclidean"`, or `"dot"` |
-
-Returns `{ name, created }`. **Not idempotent** — halts if collection exists.
-
-### chroma::delete_collection(id)
-
-Delete a collection.
-
-```rill
-chroma::delete_collection("old_vectors") => $result
-$result.deleted -> log  # true
-```
-
-Returns `{ name, deleted }`. **Not idempotent** — halts if collection not found.
-
-### chroma::list_collections()
-
-List all collection names.
-
-```rill
-chroma::list_collections() -> log  # ["my_vectors", "archive"]
-```
-
-Returns a list of strings.
-
-### chroma::describe()
-
-Describe the configured collection.
-
-```rill
-chroma::describe() => $info
-$info.name -> log        # "my_vectors"
-$info.count -> log       # 42
-$info.dimensions -> log  # 384
-$info.distance -> log    # "cosine"
-```
-
-Returns `{ name, count, dimensions, distance }`.
-
-## Configuration
-
-```typescript
-const ext = createChromaExtension({
-  url: 'http://localhost:8000',
-  collection: 'my_vectors',
-  embeddingFunction: 'openai',
-  timeout: 30000,
-});
-```
-
-| Option | Type | Default | Description |
-|--------|------|---------|-------------|
-| `url` | string | undefined | ChromaDB API endpoint (undefined uses embedded mode) |
-| `collection` | string | required | Default collection name |
-| `embeddingFunction` | string | undefined | Embedding function name |
-| `timeout` | number | SDK default | Request timeout in ms |
-
-## Error Handling
-
-All errors use `RuntimeError('RILL-R004', 'chroma: <message>')` and halt script execution.
-
-| Condition | Message |
-|-----------|---------|
-| HTTP 401 | `chroma: authentication failed (401)` |
-| Collection not found | `chroma: collection not found` |
-| Rate limit (429) | `chroma: rate limit exceeded` |
-| Timeout | `chroma: request timeout` |
-| Dimension mismatch | `chroma: dimension mismatch (expected N, got M)` |
-| Collection exists | `chroma: collection already exists` |
-| ID not found | `chroma: id not found` |
-| After dispose | `chroma: operation cancelled` |
-| Other | `chroma: <error message>` |
-
-## Local Setup
-
-### Embedded Mode (default)
-
-ChromaDB runs in-process without an external server:
-
-```typescript
-const ext = createChromaExtension({
-  collection: 'test_collection',
-});
-```
-
-No Docker or server setup required.
-
-### HTTP Server Mode
-
-Run ChromaDB with Docker:
-
-```bash
-docker run -p 8000:8000 chromadb/chroma
-```
-
-Verify: `curl http://localhost:8000/api/v1`
-
-```typescript
-const ext = createChromaExtension({
-  url: 'http://localhost:8000',
-  collection: 'test_collection',
-});
-```
-
-## Lifecycle
-
-```typescript
-const ext = createChromaExtension({ ... });
-// ... use extension ...
-await ext.dispose?.();
-```
+## Documentation
 
-`dispose()` aborts pending requests and closes the SDK client. Idempotent — second call resolves without error.
+See [full documentation](docs/extension-vectordb-chroma.md) for configuration, functions, error handling, and local setup.
 
-## Documentation
+## Related
 
-| Document | Description |
-|----------|-------------|
-| [Extensions Guide](https://github.com/rcrsr/rill/blob/main/docs/integration-extensions.md) | Extension contract and patterns |
-| [Host API Reference](https://github.com/rcrsr/rill/blob/main/docs/ref-host-api.md) | Runtime context and host functions |
-| [ChromaDB Documentation](https://docs.trychroma.com) | Official ChromaDB docs |
+- [rill](https://github.com/rcrsr/rill) — Core language runtime
+- [Extensions Guide](https://github.com/rcrsr/rill/blob/main/docs/integration-extensions.md) — Extension contract and patterns
+- [Host API Reference](https://github.com/rcrsr/rill/blob/main/docs/ref-host-api.md) — Runtime context and host functions
+- [ChromaDB Documentation](https://docs.trychroma.com) — Official ChromaDB docs
 
 ## License
 

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 // Generated by dts-bundle-generator v9.5.1
 
-import { ExtensionResult } from '@rcrsr/rill';
+import { ExtensionConfigSchema, ExtensionResult } from '@rcrsr/rill';
 
 /**
  * Type definitions for ChromaDB extension.
@@ -88,6 +88,7 @@ export type ChromaExtensionConfig = ChromaConfig;
  * ```
  */
 export declare function createChromaExtension(config: ChromaConfig): ExtensionResult;
+export declare const configSchema: ExtensionConfigSchema;
 export declare const CHROMA_EXTENSION_VERSION = "0.0.1";
 
 export {};

package/dist/index.js

@@ -1,7 +1,7 @@
 // src/factory.ts
 import { ChromaClient } from "chromadb";
 import {
-  RuntimeError as RuntimeError4,
+  RuntimeError as RuntimeError6,
   emitExtensionEvent as emitExtensionEvent3,
   createVector
 } from "@rcrsr/rill";
@@ -87,6 +87,144 @@ function assertRequired(value, fieldName) {
 // ../../shared/ext-vector/dist/wrapper.js
 import { emitExtensionEvent as emitExtensionEvent2 } from "@rcrsr/rill";
 
+// ../../shared/ext-vector/dist/param.js
+import { RuntimeError as RuntimeError4 } from "@rcrsr/rill";
+function validateParamName(name) {
+  if (name === "")
+    throw new RuntimeError4("RILL-R001", "param name must not be empty");
+  if (/\s/.test(name))
+    throw new RuntimeError4("RILL-R001", "param name must be a valid identifier");
+}
+function vectorParam(name) {
+  validateParamName(name);
+  return {
+    name,
+    type: { type: "vector" },
+    defaultValue: void 0,
+    annotations: {}
+  };
+}
+
+// ../../shared/ext-param/dist/param.js
+import { RuntimeError as RuntimeError5 } from "@rcrsr/rill";
+function validateParamName2(name) {
+  if (name === "") {
+    throw new RuntimeError5("RILL-R001", "param name must not be empty");
+  }
+  if (/\s/.test(name)) {
+    throw new RuntimeError5("RILL-R001", "param name must be a valid identifier");
+  }
+}
+function buildAnnotations(desc) {
+  if (desc !== void 0) {
+    return { description: desc };
+  }
+  return {};
+}
+var p = {
+  /**
+   * IR-1: Creates a string parameter descriptor.
+   *
+   * @param name - Parameter name (must be a valid identifier)
+   * @param desc - Optional description
+   * @returns RillParam with type 'string'
+   */
+  str(name, desc) {
+    validateParamName2(name);
+    return {
+      name,
+      type: { type: "string" },
+      defaultValue: void 0,
+      annotations: buildAnnotations(desc)
+    };
+  },
+  /**
+   * IR-2: Creates a number parameter descriptor.
+   *
+   * @param name - Parameter name (must be a valid identifier)
+   * @param desc - Optional description
+   * @param def - Optional default value
+   * @returns RillParam with type 'number'
+   */
+  num(name, desc, def) {
+    validateParamName2(name);
+    return {
+      name,
+      type: { type: "number" },
+      defaultValue: def,
+      annotations: buildAnnotations(desc)
+    };
+  },
+  /**
+   * IR-3: Creates a boolean parameter descriptor.
+   *
+   * @param name - Parameter name (must be a valid identifier)
+   * @param desc - Optional description
+   * @param def - Optional default value
+   * @returns RillParam with type 'bool'
+   */
+  bool(name, desc, def) {
+    validateParamName2(name);
+    return {
+      name,
+      type: { type: "bool" },
+      defaultValue: def,
+      annotations: buildAnnotations(desc)
+    };
+  },
+  /**
+   * IR-4: Creates a dict parameter descriptor.
+   *
+   * @param name - Parameter name (must be a valid identifier)
+   * @param desc - Optional description
+   * @param def - Optional default value
+   * @returns RillParam with type 'dict'
+   */
+  dict(name, desc, def) {
+    validateParamName2(name);
+    return {
+      name,
+      type: { type: "dict" },
+      defaultValue: def,
+      annotations: buildAnnotations(desc)
+    };
+  },
+  /**
+   * IR-5: Creates a list parameter descriptor.
+   *
+   * @param name - Parameter name (must be a valid identifier)
+   * @param itemType - Optional element type; omitted when not provided
+   * @param desc - Optional description
+   * @returns RillParam with type 'list' (with element if itemType provided)
+   */
+  list(name, itemType, desc) {
+    validateParamName2(name);
+    const type = itemType !== void 0 ? { type: "list", element: itemType } : { type: "list" };
+    return {
+      name,
+      type,
+      defaultValue: void 0,
+      annotations: buildAnnotations(desc)
+    };
+  },
+  /**
+   * IR-6: Creates a callable parameter descriptor.
+   *
+   * @param name - Parameter name (must be a valid identifier)
+   * @param desc - Optional description
+   * @returns RillParam with type 'closure'
+   */
+  callable(name, desc) {
+    validateParamName2(name);
+    return {
+      name,
+      type: { type: "closure" },
+      defaultValue: void 0,
+      annotations: buildAnnotations(desc)
+    };
+  }
+};
+
 // src/factory.ts
 function createChromaExtension(config) {
   assertRequired(config.collection, "collection");
@@ -101,9 +239,9 @@ function createChromaExtension(config) {
     // IR-1: chroma::upsert
     upsert: {
       params: [
-        { name: "id", type: "string" },
-        { name: "vector", type: "vector" },
-        { name: "metadata", type: "dict", defaultValue: {} }
+        p.str("id"),
+        vectorParam("vector"),
+        p.dict("metadata", void 0, {})
       ],
       fn: async (args, ctx) => {
         const startTime = Date.now();
@@ -145,11 +283,11 @@ function createChromaExtension(config) {
         }
       },
       description: "Insert or update single vector with metadata",
-      returnType: "dict"
+      returnType: { type: "dict" }
     },
     // IR-2: chroma::upsert_batch
     upsert_batch: {
-      params: [{ name: "items", type: "list" }],
+      params: [p.list("items")],
       fn: async (args, ctx) => {
         const startTime = Date.now();
         try {
@@ -230,13 +368,13 @@ function createChromaExtension(config) {
         }
       },
       description: "Batch insert/update vectors",
-      returnType: "dict"
+      returnType: { type: "dict" }
     },
     // IR-3: chroma::search
     search: {
       params: [
-        { name: "vector", type: "vector" },
-        { name: "options", type: "dict", defaultValue: {} }
+        vectorParam("vector"),
+        p.dict("options", void 0, {})
       ],
       fn: async (args, ctx) => {
         const startTime = Date.now();
@@ -284,11 +422,11 @@ function createChromaExtension(config) {
         }
       },
       description: "Search k nearest neighbors",
-      returnType: "list"
+      returnType: { type: "list" }
     },
     // IR-4: chroma::get
     get: {
-      params: [{ name: "id", type: "string" }],
+      params: [p.str("id")],
       fn: async (args, ctx) => {
         const startTime = Date.now();
         try {
@@ -301,12 +439,12 @@ function createChromaExtension(config) {
             ids: [id]
           });
           if (response.ids.length === 0) {
-            throw new RuntimeError4("RILL-R004", "chroma: id not found");
+            throw new RuntimeError6("RILL-R004", "chroma: id not found");
           }
           const embedding = response.embeddings?.[0];
           const metadata = response.metadatas?.[0];
           if (!embedding || !Array.isArray(embedding)) {
-            throw new RuntimeError4(
+            throw new RuntimeError6(
               "RILL-R004",
               "chroma: invalid vector format"
             );
@@ -339,11 +477,11 @@ function createChromaExtension(config) {
         }
       },
       description: "Fetch vector by ID",
-      returnType: "dict"
+      returnType: { type: "dict" }
     },
     // IR-5: chroma::delete
     delete: {
-      params: [{ name: "id", type: "string" }],
+      params: [p.str("id")],
       fn: async (args, ctx) => {
         const startTime = Date.now();
         try {
@@ -380,11 +518,11 @@ function createChromaExtension(config) {
         }
       },
       description: "Delete vector by ID",
-      returnType: "dict"
+      returnType: { type: "dict" }
     },
     // IR-6: chroma::delete_batch
     delete_batch: {
-      params: [{ name: "ids", type: "list" }],
+      params: [p.list("ids")],
       fn: async (args, ctx) => {
         const startTime = Date.now();
         try {
@@ -442,7 +580,7 @@ function createChromaExtension(config) {
         }
       },
       description: "Batch delete vectors",
-      returnType: "dict"
+      returnType: { type: "dict" }
     },
     // IR-7: chroma::count
     count: {
@@ -476,13 +614,13 @@ function createChromaExtension(config) {
         }
       },
       description: "Return total vector count in collection",
-      returnType: "number"
+      returnType: { type: "number" }
     },
     // IR-8: chroma::create_collection
     create_collection: {
       params: [
-        { name: "name", type: "string" },
-        { name: "options", type: "dict", defaultValue: {} }
+        p.str("name"),
+        p.dict("options", void 0, {})
       ],
       fn: async (args, ctx) => {
         const startTime = Date.now();
@@ -520,11 +658,11 @@ function createChromaExtension(config) {
         }
       },
       description: "Create new vector collection",
-      returnType: "dict"
+      returnType: { type: "dict" }
     },
     // IR-9: chroma::delete_collection
     delete_collection: {
-      params: [{ name: "name", type: "string" }],
+      params: [p.str("name")],
       fn: async (args, ctx) => {
         const startTime = Date.now();
         try {
@@ -556,7 +694,7 @@ function createChromaExtension(config) {
         }
       },
       description: "Delete vector collection",
-      returnType: "dict"
+      returnType: { type: "dict" }
     },
     // IR-10: chroma::list_collections
     list_collections: {
@@ -565,7 +703,7 @@ function createChromaExtension(config) {
         const startTime = Date.now();
         try {
           checkDisposed(disposalState, "chroma");
-          const names = await client.listCollections();
+          const names = (await client.listCollections()).map((c) => c.name);
           const duration = Date.now() - startTime;
           emitExtensionEvent3(ctx, {
             event: "chroma:list_collections",
@@ -587,7 +725,7 @@ function createChromaExtension(config) {
         }
       },
       description: "List all collection names",
-      returnType: "list"
+      returnType: { type: "list" }
     },
     // IR-11: chroma::describe
     describe: {
@@ -625,7 +763,7 @@ function createChromaExtension(config) {
         }
       },
       description: "Describe configured collection",
-      returnType: "dict"
+      returnType: { type: "dict" }
     }
   };
   result.dispose = async () => {
@@ -636,8 +774,15 @@ function createChromaExtension(config) {
 }
 
 // src/index.ts
+var configSchema = {
+  url: { type: "string" },
+  collection: { type: "string", required: true },
+  embeddingFunction: { type: "string" },
+  timeout: { type: "number" }
+};
 var CHROMA_EXTENSION_VERSION = "0.0.1";
 export {
   CHROMA_EXTENSION_VERSION,
+  configSchema,
   createChromaExtension
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rcrsr/rill-ext-chroma",
-  "version": "0.8.6",
+  "version": "0.11.0",
   "description": "rill extension for ChromaDB vector database integration",
   "license": "MIT",
   "author": "Andre Bremer",
@@ -18,14 +18,14 @@
     "scripting"
   ],
   "peerDependencies": {
-    "@rcrsr/rill": "^0.8.6"
+    "@rcrsr/rill": "^0.11.0"
   },
   "devDependencies": {
-    "@types/node": "^25.2.3",
+    "@rcrsr/rill": "^0.11.0",
+    "@types/node": "^25.3.0",
     "dts-bundle-generator": "^9.5.1",
-    "tsup": "^8.5.0",
-    "undici-types": "^7.21.0",
-    "@rcrsr/rill": "^0.8.6",
+    "tsup": "^8.5.1",
+    "undici-types": "^7.22.0",
     "@rcrsr/rill-ext-vector-shared": "^0.0.1"
   },
   "files": [
@@ -33,18 +33,19 @@
   ],
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/rcrsr/rill.git",
+    "url": "git+https://github.com/rcrsr/rill-ext.git",
     "directory": "packages/ext/vectordb-chroma"
   },
-  "homepage": "https://rill.run/docs/extensions/chroma/",
+  "homepage": "https://github.com/rcrsr/rill-ext/tree/main/packages/ext/vectordb-chroma#readme",
   "bugs": {
-    "url": "https://github.com/rcrsr/rill/issues"
+    "url": "https://github.com/rcrsr/rill-ext/issues"
   },
   "publishConfig": {
     "access": "public"
   },
   "dependencies": {
-    "chromadb": "^1.9.2"
+    "chromadb": "^3.3.1",
+    "@rcrsr/rill-ext-param-shared": "^0.0.1"
   },
   "scripts": {
     "build": "tsup && dts-bundle-generator --config dts-bundle-generator.config.cjs",