@cilow/sdk 0.2.0 → 0.2.1

package/dist/client.d.mts

@@ -0,0 +1,224 @@
+import { CilowConfig, CreateMemoryOptions, SearchResult, Memory, UpdateMemoryOptions, PaginatedResponse, MemorySummary, SearchQuery, AdvancedSearchOptions, ContextResult, ConversationTurn, GraphNode, GraphEdge, GraphTraversalOptions, GraphSubgraph, MemoryStats, TagCount, UserStats, HealthCheck } from './types.mjs';
+
+/**
+ * Cilow Client - Core HTTP Client for Cilow API
+ *
+ * Provides a clean, type-safe interface for interacting with the Cilow
+ * memory system API.
+ */
+
+/**
+ * Custom error class for Cilow API errors
+ */
+declare class CilowApiError extends Error {
+    readonly code: string;
+    readonly statusCode: number;
+    readonly details?: Record<string, unknown> | undefined;
+    constructor(message: string, code: string, statusCode: number, details?: Record<string, unknown> | undefined);
+}
+/**
+ * CilowClient - Main client class for interacting with the Cilow API
+ *
+ * @example
+ * ```typescript
+ * const client = new CilowClient({
+ *   apiUrl: 'https://api.cilow.ai',
+ *   apiKey: 'your-api-key'
+ * });
+ *
+ * // Store a memory
+ * const memoryId = await client.remember("User prefers dark mode", {
+ *   tags: ["preference", "ui"]
+ * });
+ *
+ * // Search memories
+ * const results = await client.recall("user preferences");
+ *
+ * // Delete memories
+ * await client.forget({ tags: ["old"] });
+ * ```
+ */
+declare class CilowClient {
+    private readonly baseUrl;
+    private readonly apiKey;
+    private readonly timeout;
+    private readonly retries;
+    private readonly headers;
+    private readonly debug;
+    constructor(config: CilowConfig);
+    /**
+     * Make an API request
+     */
+    private request;
+    /**
+     * Store a memory (simple API)
+     *
+     * @param content - The content to remember
+     * @param options - Optional configuration
+     * @returns The created memory ID
+     *
+     * @example
+     * ```typescript
+     * await cilow.remember("User prefers dark mode", {
+     *   tags: ["preference"],
+     *   userId: "user-123"
+     * });
+     * ```
+     */
+    remember(content: string, options?: CreateMemoryOptions): Promise<string>;
+    /**
+     * Search memories (simple API)
+     *
+     * @param query - Search query text
+     * @param options - Search options
+     * @returns Array of search results
+     *
+     * @example
+     * ```typescript
+     * const memories = await cilow.recall("user preferences", {
+     *   limit: 10,
+     *   tags: ["preference"]
+     * });
+     * ```
+     */
+    recall(query: string, options?: {
+        limit?: number;
+        minRelevance?: number;
+        tags?: string[];
+        userId?: string;
+    }): Promise<SearchResult[]>;
+    /**
+     * Delete memories (simple API)
+     *
+     * @param filter - Filter criteria for deletion
+     * @returns Number of memories deleted
+     *
+     * @example
+     * ```typescript
+     * // Delete by tags
+     * await cilow.forget({ tags: ["temporary"] });
+     *
+     * // Delete by user
+     * await cilow.forget({ userId: "user-123" });
+     *
+     * // Delete specific memory
+     * await cilow.forget({ memoryId: "mem-abc" });
+     * ```
+     */
+    forget(filter: {
+        memoryId?: string;
+        tags?: string[];
+        userId?: string;
+        sessionId?: string;
+        olderThan?: string;
+    }): Promise<number>;
+    /**
+     * Create a new memory
+     */
+    createMemory(content: string, options?: CreateMemoryOptions): Promise<Memory>;
+    /**
+     * Get a memory by ID
+     */
+    getMemory(memoryId: string): Promise<Memory>;
+    /**
+     * Update a memory
+     */
+    updateMemory(memoryId: string, updates: UpdateMemoryOptions): Promise<Memory>;
+    /**
+     * Delete a memory
+     */
+    deleteMemory(memoryId: string): Promise<void>;
+    /**
+     * List memories with pagination
+     */
+    listMemories(options?: {
+        limit?: number;
+        offset?: number;
+        userId?: string;
+        sessionId?: string;
+        tags?: string[];
+        tier?: string;
+    }): Promise<PaginatedResponse<MemorySummary>>;
+    /**
+     * Search memories with full options
+     */
+    searchMemories(query: SearchQuery): Promise<SearchResult[]>;
+    /**
+     * Advanced search with reranking and boosts
+     */
+    advancedSearch(query: AdvancedSearchOptions): Promise<SearchResult[]>;
+    /**
+     * Get context for AI applications
+     */
+    getContext(query: string, options?: {
+        maxTokens?: number;
+        userId?: string;
+        tags?: string[];
+    }): Promise<ContextResult>;
+    /**
+     * Store a conversation turn
+     */
+    storeConversation(turn: ConversationTurn & {
+        userId: string;
+    }): Promise<string>;
+    /**
+     * Get conversation history for a session
+     */
+    getConversationHistory(sessionId: string, options?: {
+        limit?: number;
+        offset?: number;
+    }): Promise<MemorySummary[]>;
+    /**
+     * Get a graph node
+     */
+    getGraphNode(nodeId: string): Promise<GraphNode>;
+    /**
+     * Create a graph node
+     */
+    createGraphNode(type: string, name: string, properties?: Record<string, unknown>): Promise<GraphNode>;
+    /**
+     * Create a graph edge
+     */
+    createGraphEdge(sourceId: string, targetId: string, type: string, properties?: Record<string, unknown>): Promise<GraphEdge>;
+    /**
+     * Traverse the graph from a starting node
+     */
+    traverseGraph(options: GraphTraversalOptions): Promise<GraphSubgraph>;
+    /**
+     * Get related nodes for a memory
+     */
+    getRelatedNodes(memoryId: string): Promise<GraphNode[]>;
+    /**
+     * Get memory statistics
+     */
+    getStats(): Promise<MemoryStats>;
+    /**
+     * Get all tags with counts
+     */
+    getTags(): Promise<TagCount[]>;
+    /**
+     * Get user statistics
+     */
+    getUserStats(userId: string): Promise<UserStats>;
+    /**
+     * Health check
+     */
+    healthCheck(): Promise<HealthCheck>;
+    /**
+     * Batch create memories
+     */
+    batchCreate(items: Array<{
+        content: string;
+        options?: CreateMemoryOptions;
+    }>): Promise<string[]>;
+    /**
+     * Batch delete memories
+     */
+    batchDelete(memoryIds: string[]): Promise<number>;
+}
+/**
+ * Create a Cilow client instance (convenience function)
+ */
+declare function createClient(config: CilowConfig): CilowClient;
+
+export { CilowApiError, CilowClient, createClient };

package/dist/client.d.ts

@@ -0,0 +1,224 @@
+import { CilowConfig, CreateMemoryOptions, SearchResult, Memory, UpdateMemoryOptions, PaginatedResponse, MemorySummary, SearchQuery, AdvancedSearchOptions, ContextResult, ConversationTurn, GraphNode, GraphEdge, GraphTraversalOptions, GraphSubgraph, MemoryStats, TagCount, UserStats, HealthCheck } from './types.js';
+
+/**
+ * Cilow Client - Core HTTP Client for Cilow API
+ *
+ * Provides a clean, type-safe interface for interacting with the Cilow
+ * memory system API.
+ */
+
+/**
+ * Custom error class for Cilow API errors
+ */
+declare class CilowApiError extends Error {
+    readonly code: string;
+    readonly statusCode: number;
+    readonly details?: Record<string, unknown> | undefined;
+    constructor(message: string, code: string, statusCode: number, details?: Record<string, unknown> | undefined);
+}
+/**
+ * CilowClient - Main client class for interacting with the Cilow API
+ *
+ * @example
+ * ```typescript
+ * const client = new CilowClient({
+ *   apiUrl: 'https://api.cilow.ai',
+ *   apiKey: 'your-api-key'
+ * });
+ *
+ * // Store a memory
+ * const memoryId = await client.remember("User prefers dark mode", {
+ *   tags: ["preference", "ui"]
+ * });
+ *
+ * // Search memories
+ * const results = await client.recall("user preferences");
+ *
+ * // Delete memories
+ * await client.forget({ tags: ["old"] });
+ * ```
+ */
+declare class CilowClient {
+    private readonly baseUrl;
+    private readonly apiKey;
+    private readonly timeout;
+    private readonly retries;
+    private readonly headers;
+    private readonly debug;
+    constructor(config: CilowConfig);
+    /**
+     * Make an API request
+     */
+    private request;
+    /**
+     * Store a memory (simple API)
+     *
+     * @param content - The content to remember
+     * @param options - Optional configuration
+     * @returns The created memory ID
+     *
+     * @example
+     * ```typescript
+     * await cilow.remember("User prefers dark mode", {
+     *   tags: ["preference"],
+     *   userId: "user-123"
+     * });
+     * ```
+     */
+    remember(content: string, options?: CreateMemoryOptions): Promise<string>;
+    /**
+     * Search memories (simple API)
+     *
+     * @param query - Search query text
+     * @param options - Search options
+     * @returns Array of search results
+     *
+     * @example
+     * ```typescript
+     * const memories = await cilow.recall("user preferences", {
+     *   limit: 10,
+     *   tags: ["preference"]
+     * });
+     * ```
+     */
+    recall(query: string, options?: {
+        limit?: number;
+        minRelevance?: number;
+        tags?: string[];
+        userId?: string;
+    }): Promise<SearchResult[]>;
+    /**
+     * Delete memories (simple API)
+     *
+     * @param filter - Filter criteria for deletion
+     * @returns Number of memories deleted
+     *
+     * @example
+     * ```typescript
+     * // Delete by tags
+     * await cilow.forget({ tags: ["temporary"] });
+     *
+     * // Delete by user
+     * await cilow.forget({ userId: "user-123" });
+     *
+     * // Delete specific memory
+     * await cilow.forget({ memoryId: "mem-abc" });
+     * ```
+     */
+    forget(filter: {
+        memoryId?: string;
+        tags?: string[];
+        userId?: string;
+        sessionId?: string;
+        olderThan?: string;
+    }): Promise<number>;
+    /**
+     * Create a new memory
+     */
+    createMemory(content: string, options?: CreateMemoryOptions): Promise<Memory>;
+    /**
+     * Get a memory by ID
+     */
+    getMemory(memoryId: string): Promise<Memory>;
+    /**
+     * Update a memory
+     */
+    updateMemory(memoryId: string, updates: UpdateMemoryOptions): Promise<Memory>;
+    /**
+     * Delete a memory
+     */
+    deleteMemory(memoryId: string): Promise<void>;
+    /**
+     * List memories with pagination
+     */
+    listMemories(options?: {
+        limit?: number;
+        offset?: number;
+        userId?: string;
+        sessionId?: string;
+        tags?: string[];
+        tier?: string;
+    }): Promise<PaginatedResponse<MemorySummary>>;
+    /**
+     * Search memories with full options
+     */
+    searchMemories(query: SearchQuery): Promise<SearchResult[]>;
+    /**
+     * Advanced search with reranking and boosts
+     */
+    advancedSearch(query: AdvancedSearchOptions): Promise<SearchResult[]>;
+    /**
+     * Get context for AI applications
+     */
+    getContext(query: string, options?: {
+        maxTokens?: number;
+        userId?: string;
+        tags?: string[];
+    }): Promise<ContextResult>;
+    /**
+     * Store a conversation turn
+     */
+    storeConversation(turn: ConversationTurn & {
+        userId: string;
+    }): Promise<string>;
+    /**
+     * Get conversation history for a session
+     */
+    getConversationHistory(sessionId: string, options?: {
+        limit?: number;
+        offset?: number;
+    }): Promise<MemorySummary[]>;
+    /**
+     * Get a graph node
+     */
+    getGraphNode(nodeId: string): Promise<GraphNode>;
+    /**
+     * Create a graph node
+     */
+    createGraphNode(type: string, name: string, properties?: Record<string, unknown>): Promise<GraphNode>;
+    /**
+     * Create a graph edge
+     */
+    createGraphEdge(sourceId: string, targetId: string, type: string, properties?: Record<string, unknown>): Promise<GraphEdge>;
+    /**
+     * Traverse the graph from a starting node
+     */
+    traverseGraph(options: GraphTraversalOptions): Promise<GraphSubgraph>;
+    /**
+     * Get related nodes for a memory
+     */
+    getRelatedNodes(memoryId: string): Promise<GraphNode[]>;
+    /**
+     * Get memory statistics
+     */
+    getStats(): Promise<MemoryStats>;
+    /**
+     * Get all tags with counts
+     */
+    getTags(): Promise<TagCount[]>;
+    /**
+     * Get user statistics
+     */
+    getUserStats(userId: string): Promise<UserStats>;
+    /**
+     * Health check
+     */
+    healthCheck(): Promise<HealthCheck>;
+    /**
+     * Batch create memories
+     */
+    batchCreate(items: Array<{
+        content: string;
+        options?: CreateMemoryOptions;
+    }>): Promise<string[]>;
+    /**
+     * Batch delete memories
+     */
+    batchDelete(memoryIds: string[]): Promise<number>;
+}
+/**
+ * Create a Cilow client instance (convenience function)
+ */
+declare function createClient(config: CilowConfig): CilowClient;
+
+export { CilowApiError, CilowClient, createClient };