@rcrsr/rill-ext-chroma 0.9.0 → 0.16.0

package/dist/index.d.ts

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

package/dist/index.js

@@ -1,9 +1,13 @@
+// src/index.ts
+import { createRequire } from "module";
+
 // src/factory.ts
 import { ChromaClient } from "chromadb";
 import {
-  RuntimeError as RuntimeError4,
+  RuntimeError as RuntimeError6,
   emitExtensionEvent as emitExtensionEvent3,
-  createVector
+  createVector,
+  rillTypeToTypeValue
 } from "@rcrsr/rill";
 
 // ../../shared/ext-vector/dist/errors.js
@@ -87,6 +91,146 @@ 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
+   * @param fields - Optional structural field definitions (RillFieldDef with type and optional defaultValue)
+   * @returns RillParam with type 'dict' (with fields if provided)
+   */
+  dict(name, desc, def, fields) {
+    validateParamName2(name);
+    const type = fields !== void 0 ? { type: "dict", fields } : { type: "dict" };
+    return {
+      name,
+      type,
+      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,17 +245,17 @@ 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();
         try {
           checkDisposed(disposalState, "chroma");
-          const id = args[0];
-          const vector = args[1];
-          const metadata = args[2] ?? {};
+          const id = args["id"];
+          const vector = args["vector"];
+          const metadata = args["metadata"] ?? {};
           const collection = await client.getOrCreateCollection({
             name: factoryCollection
           });
@@ -144,17 +288,17 @@ function createChromaExtension(config) {
           throw rillError;
         }
       },
-      description: "Insert or update single vector with metadata",
-      returnType: "dict"
+      annotations: { description: "Insert or update single vector with metadata" },
+      returnType: rillTypeToTypeValue({ type: "dict", fields: { id: { type: { type: "string" } }, success: { type: { type: "bool" } } } })
     },
     // 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 {
           checkDisposed(disposalState, "chroma");
-          const items = args[0];
+          const items = args["items"];
           let succeeded = 0;
           const collection = await client.getOrCreateCollection({
             name: factoryCollection
@@ -229,21 +373,24 @@ function createChromaExtension(config) {
           throw rillError;
         }
       },
-      description: "Batch insert/update vectors",
-      returnType: "dict"
+      annotations: { description: "Batch insert/update vectors" },
+      returnType: rillTypeToTypeValue({ type: "dict", fields: { succeeded: { type: { type: "number" } }, failed: { type: { type: "string" } }, error: { type: { type: "string" } } } })
     },
     // IR-3: chroma::search
     search: {
       params: [
-        { name: "vector", type: "vector" },
-        { name: "options", type: "dict", defaultValue: {} }
+        vectorParam("vector"),
+        p.dict("options", void 0, {}, {
+          k: { type: { type: "number" }, defaultValue: 10 },
+          filter: { type: { type: "dict" }, defaultValue: {} }
+        })
       ],
       fn: async (args, ctx) => {
         const startTime = Date.now();
         try {
           checkDisposed(disposalState, "chroma");
-          const vector = args[0];
-          const options = args[1] ?? {};
+          const vector = args["vector"];
+          const options = args["options"] ?? {};
           const k = typeof options["k"] === "number" ? options["k"] : 10;
           const filter = options["filter"] ?? {};
           const collection = await client.getOrCreateCollection({
@@ -283,17 +430,17 @@ function createChromaExtension(config) {
           throw rillError;
         }
       },
-      description: "Search k nearest neighbors",
-      returnType: "list"
+      annotations: { description: "Search k nearest neighbors" },
+      returnType: rillTypeToTypeValue({ type: "list", element: { type: "dict", fields: { id: { type: { type: "string" } }, score: { type: { type: "number" } }, metadata: { type: { type: "dict" } } } } })
     },
     // IR-4: chroma::get
     get: {
-      params: [{ name: "id", type: "string" }],
+      params: [p.str("id")],
       fn: async (args, ctx) => {
         const startTime = Date.now();
         try {
           checkDisposed(disposalState, "chroma");
-          const id = args[0];
+          const id = args["id"];
           const collection = await client.getOrCreateCollection({
             name: factoryCollection
           });
@@ -301,12 +448,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"
             );
@@ -338,17 +485,17 @@ function createChromaExtension(config) {
           throw rillError;
         }
       },
-      description: "Fetch vector by ID",
-      returnType: "dict"
+      annotations: { description: "Fetch vector by ID" },
+      returnType: rillTypeToTypeValue({ type: "dict", fields: { id: { type: { type: "string" } }, vector: { type: { type: "vector" } }, metadata: { type: { 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 {
           checkDisposed(disposalState, "chroma");
-          const id = args[0];
+          const id = args["id"];
           const collection = await client.getOrCreateCollection({
             name: factoryCollection
           });
@@ -379,17 +526,17 @@ function createChromaExtension(config) {
           throw rillError;
         }
       },
-      description: "Delete vector by ID",
-      returnType: "dict"
+      annotations: { description: "Delete vector by ID" },
+      returnType: rillTypeToTypeValue({ type: "dict", fields: { id: { type: { type: "string" } }, deleted: { type: { type: "bool" } } } })
     },
     // 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 {
           checkDisposed(disposalState, "chroma");
-          const ids = args[0];
+          const ids = args["ids"];
           let succeeded = 0;
           const collection = await client.getOrCreateCollection({
             name: factoryCollection
@@ -441,8 +588,8 @@ function createChromaExtension(config) {
           throw rillError;
         }
       },
-      description: "Batch delete vectors",
-      returnType: "dict"
+      annotations: { description: "Batch delete vectors" },
+      returnType: rillTypeToTypeValue({ type: "dict", fields: { succeeded: { type: { type: "number" } }, failed: { type: { type: "string" } }, error: { type: { type: "string" } } } })
     },
     // IR-7: chroma::count
     count: {
@@ -475,21 +622,23 @@ function createChromaExtension(config) {
           throw rillError;
         }
       },
-      description: "Return total vector count in collection",
-      returnType: "number"
+      annotations: { description: "Return total vector count in collection" },
+      returnType: rillTypeToTypeValue({ 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, {}, {
+          metadata: { type: { type: "dict" }, defaultValue: {} }
+        })
       ],
       fn: async (args, ctx) => {
         const startTime = Date.now();
         try {
           checkDisposed(disposalState, "chroma");
-          const name = args[0];
-          const options = args[1] ?? {};
+          const name = args["name"];
+          const options = args["options"] ?? {};
           const metadata = options["metadata"] ?? {};
           await client.createCollection({
             name,
@@ -519,17 +668,17 @@ function createChromaExtension(config) {
           throw rillError;
         }
       },
-      description: "Create new vector collection",
-      returnType: "dict"
+      annotations: { description: "Create new vector collection" },
+      returnType: rillTypeToTypeValue({ type: "dict", fields: { name: { type: { type: "string" } }, created: { type: { type: "bool" } } } })
     },
     // 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 {
           checkDisposed(disposalState, "chroma");
-          const name = args[0];
+          const name = args["name"];
           await client.deleteCollection({ name });
           const result2 = {
             name,
@@ -555,8 +704,8 @@ function createChromaExtension(config) {
           throw rillError;
         }
       },
-      description: "Delete vector collection",
-      returnType: "dict"
+      annotations: { description: "Delete vector collection" },
+      returnType: rillTypeToTypeValue({ type: "dict", fields: { name: { type: { type: "string" } }, deleted: { type: { type: "bool" } } } })
     },
     // IR-10: chroma::list_collections
     list_collections: {
@@ -586,8 +735,8 @@ function createChromaExtension(config) {
           throw rillError;
         }
       },
-      description: "List all collection names",
-      returnType: "list"
+      annotations: { description: "List all collection names" },
+      returnType: rillTypeToTypeValue({ type: "list", element: { type: "string" } })
     },
     // IR-11: chroma::describe
     describe: {
@@ -624,8 +773,8 @@ function createChromaExtension(config) {
           throw rillError;
         }
       },
-      description: "Describe configured collection",
-      returnType: "dict"
+      annotations: { description: "Describe configured collection" },
+      returnType: rillTypeToTypeValue({ type: "dict", fields: { name: { type: { type: "string" } }, count: { type: { type: "number" } } } })
     }
   };
   result.dispose = async () => {
@@ -636,15 +785,23 @@ function createChromaExtension(config) {
 }
 
 // src/index.ts
+var _require = createRequire(import.meta.url);
+var _pkg = _require("../package.json");
+var VERSION = _pkg.version;
 var configSchema = {
   url: { type: "string" },
   collection: { type: "string", required: true },
   embeddingFunction: { type: "string" },
   timeout: { type: "number" }
 };
-var CHROMA_EXTENSION_VERSION = "0.0.1";
+var extensionManifest = {
+  factory: createChromaExtension,
+  configSchema,
+  version: VERSION
+};
 export {
-  CHROMA_EXTENSION_VERSION,
+  VERSION,
   configSchema,
-  createChromaExtension
+  createChromaExtension,
+  extensionManifest
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rcrsr/rill-ext-chroma",
-  "version": "0.9.0",
+  "version": "0.16.0",
   "description": "rill extension for ChromaDB vector database integration",
   "license": "MIT",
   "author": "Andre Bremer",
@@ -18,10 +18,10 @@
     "scripting"
   ],
   "peerDependencies": {
-    "@rcrsr/rill": "^0.9.0"
+    "@rcrsr/rill": "~0.16.0"
   },
   "devDependencies": {
-    "@rcrsr/rill": "^0.9.0",
+    "@rcrsr/rill": "~0.16.0",
     "@types/node": "^25.3.0",
     "dts-bundle-generator": "^9.5.1",
     "tsup": "^8.5.1",
@@ -44,7 +44,8 @@
     "access": "public"
   },
   "dependencies": {
-    "chromadb": "^3.3.1"
+    "chromadb": "^3.3.1",
+    "@rcrsr/rill-ext-param-shared": "^0.0.1"
   },
   "scripts": {
     "build": "tsup && dts-bundle-generator --config dts-bundle-generator.config.cjs",