@rcrsr/rill-ext-chroma 0.8.2 → 0.8.4

package/dist/index.d.ts

@@ -1,8 +1,93 @@
+// Generated by dts-bundle-generator v9.5.1
+
+import { ExtensionResult } from '@rcrsr/rill';
+
 /**
- * ChromaDB extension for rill.
- * Provides vector database operations using ChromaDB.
+ * Type definitions for ChromaDB extension.
+ * Defines configuration for connecting to ChromaDB vector database.
  */
-export type { ChromaConfig, ChromaExtensionConfig } from './types.js';
-export { createChromaExtension } from './factory.js';
+/**
+ * Configuration options for ChromaDB extension.
+ *
+ * Defines connection parameters for ChromaDB client including
+ * optional API URL, collection name, embedding function, and timeout settings.
+ *
+ * @example
+ * ```typescript
+ * // Embedded mode (default)
+ * const embeddedConfig: ChromaConfig = {
+ *   collection: 'my_collection',
+ * };
+ *
+ * // HTTP client mode
+ * const httpConfig: ChromaConfig = {
+ *   url: 'http://localhost:8000',
+ *   collection: 'my_collection',
+ *   embeddingFunction: 'openai',
+ *   timeout: 30000,
+ * };
+ * ```
+ */
+export interface ChromaConfig {
+	/**
+	 * API endpoint URL for ChromaDB server.
+	 *
+	 * Optional - when undefined, uses embedded mode.
+	 * HTTP mode: 'http://localhost:8000'
+	 */
+	readonly url?: string | undefined;
+	/**
+	 * Collection name for vector operations.
+	 *
+	 * Required - identifies the collection to use for operations.
+	 */
+	readonly collection: string;
+	/**
+	 * Embedding function name.
+	 *
+	 * Optional - when undefined, database uses collection default.
+	 * Examples: 'openai', 'cohere', 'huggingface'
+	 */
+	readonly embeddingFunction?: string | undefined;
+	/**
+	 * Request timeout in milliseconds.
+	 *
+	 * Must be a positive integer.
+	 * Default: SDK default (30000ms)
+	 */
+	readonly timeout?: number | undefined;
+}
+/**
+ * Legacy type alias for ChromaConfig.
+ *
+ * @deprecated Use ChromaConfig instead.
+ */
+export type ChromaExtensionConfig = ChromaConfig;
+/**
+ * Create ChromaDB extension instance.
+ * Validates configuration and returns host functions with cleanup.
+ *
+ * @param config - Extension configuration
+ * @returns ExtensionResult with 11 vector database functions and dispose
+ * @throws Error for invalid configuration (AC-10)
+ *
+ * @example
+ * ```typescript
+ * // Embedded mode
+ * const ext = createChromaExtension({
+ *   collection: 'my_vectors',
+ * });
+ *
+ * // HTTP mode
+ * const ext = createChromaExtension({
+ *   url: 'http://localhost:8000',
+ *   collection: 'my_vectors',
+ * });
+ * // Use with rill runtime...
+ * await ext.dispose();
+ * ```
+ */
+export declare function createChromaExtension(config: ChromaConfig): ExtensionResult;
 export declare const CHROMA_EXTENSION_VERSION = "0.0.1";
-//# sourceMappingURL=index.d.ts.map
+
+export {};