@nebula-ai/sdk 0.0.19

package/dist/index.d.ts

@@ -0,0 +1,218 @@
+declare enum RetrievalType {
+    BASIC = "basic",
+    ADVANCED = "advanced",
+    CUSTOM = "custom"
+}
+declare enum GraphSearchResultType {
+    ENTITY = "entity",
+    RELATIONSHIP = "relationship",
+    COMMUNITY = "community"
+}
+interface MemoryResponse {
+    id: string;
+    content?: string;
+    chunks?: string[];
+    metadata: Record<string, any>;
+    cluster_ids: string[];
+    created_at?: string;
+    updated_at?: string;
+}
+interface Memory {
+    cluster_id: string;
+    content: string;
+    role?: string;
+    parent_id?: string;
+    metadata: Record<string, any>;
+}
+interface Cluster {
+    id: string;
+    name: string;
+    description?: string;
+    metadata: Record<string, any>;
+    created_at?: string;
+    updated_at?: string;
+    memory_count: number;
+    owner_id?: string;
+}
+interface SearchResult {
+    id: string;
+    score: number;
+    metadata: Record<string, any>;
+    source?: string;
+    content?: string;
+    graph_result_type?: GraphSearchResultType;
+    graph_entity?: GraphEntityResult;
+    graph_relationship?: GraphRelationshipResult;
+    graph_community?: GraphCommunityResult;
+    chunk_ids?: string[];
+}
+interface GraphEntityResult {
+    id?: string;
+    name: string;
+    description: string;
+    metadata: Record<string, any>;
+}
+interface GraphRelationshipResult {
+    id?: string;
+    subject: string;
+    predicate: string;
+    object: string;
+    subject_id?: string;
+    object_id?: string;
+    description?: string;
+    metadata: Record<string, any>;
+}
+interface GraphCommunityResult {
+    id?: string;
+    name: string;
+    summary: string;
+    metadata: Record<string, any>;
+}
+interface AgentResponse {
+    content: string;
+    agent_id: string;
+    conversation_id?: string;
+    metadata: Record<string, any>;
+    citations: Record<string, any>[];
+}
+interface SearchOptions {
+    limit: number;
+    filters?: Record<string, any>;
+    retrieval_type: RetrievalType;
+}
+interface NebulaSDKConfig {
+    apiKey: string;
+    baseUrl?: string;
+    timeout?: number;
+}
+declare class NebulaException extends Error {
+    statusCode?: number | undefined;
+    details?: any;
+    constructor(message: string, statusCode?: number | undefined, details?: any);
+}
+declare class NebulaClientException extends NebulaException {
+    cause?: Error | undefined;
+    constructor(message: string, cause?: Error | undefined);
+}
+declare class NebulaAuthenticationException extends NebulaException {
+    constructor(message?: string);
+}
+declare class NebulaRateLimitException extends NebulaException {
+    constructor(message?: string);
+}
+declare class NebulaValidationException extends NebulaException {
+    details?: any;
+    constructor(message?: string, details?: any);
+}
+declare class NebulaClusterNotFoundException extends NebulaException {
+    constructor(message?: string);
+}
+
+/**
+ * Official Nebula Cloud JavaScript/TypeScript SDK
+ * Mirrors the exact Nebula Python SDK client.py implementation
+ */
+declare class NebulaSDK {
+    private apiKey;
+    private baseUrl;
+    private timeout;
+    constructor(config: NebulaSDKConfig);
+    /**
+     * Check if API key is set
+     */
+    isApiKeySet(): boolean;
+    /**
+     * Detect if a token looks like a Nebula API key (public.raw)
+     */
+    private _isNebulaApiKey;
+    /**
+     * Build authentication headers
+     */
+    private _buildAuthHeaders;
+    /**
+     * Make an HTTP request to the Nebula API
+     */
+    private _makeRequest;
+    /**
+     * Create a new cluster
+     */
+    createCluster(name: string, description?: string, metadata?: Record<string, any>): Promise<Cluster>;
+    /**
+     * Get a specific cluster by ID
+     */
+    getCluster(clusterId: string): Promise<Cluster>;
+    /**
+     * Get a specific cluster by name
+     */
+    getClusterByName(name: string): Promise<Cluster>;
+    /**
+     * Get all clusters
+     */
+    listClusters(limit?: number, offset?: number): Promise<Cluster[]>;
+    /**
+     * List conversations for the authenticated user
+     */
+    listConversations(limit?: number, offset?: number): Promise<any[]>;
+    /**
+     * Update a cluster
+     */
+    updateCluster(clusterId: string, name?: string, description?: string, metadata?: Record<string, any>): Promise<Cluster>;
+    /**
+     * Delete a cluster
+     */
+    deleteCluster(clusterId: string): Promise<boolean>;
+    /**
+     * Store a single memory
+     */
+    storeMemory(memory: Memory | Record<string, any>): Promise<string>;
+    /**
+     * Store multiple memories
+     */
+    storeMemories(memories: Memory[]): Promise<string[]>;
+    /**
+     * Delete a specific memory
+     */
+    delete(memoryId: string): Promise<boolean>;
+    /**
+     * Get all memories from specific clusters
+     */
+    listMemories(clusterIds: string[], limit?: number, offset?: number): Promise<MemoryResponse[]>;
+    /**
+     * Get a specific memory by ID
+     */
+    getMemory(memoryId: string): Promise<MemoryResponse>;
+    /**
+     * Search within specific clusters
+     */
+    search(query: string, clusterIds: string[], limit?: number, retrievalType?: RetrievalType | string, filters?: Record<string, any>, searchSettings?: Record<string, any>): Promise<SearchResult[]>;
+    /**
+     * Check the health of the Nebula API
+     */
+    healthCheck(): Promise<Record<string, any>>;
+    /**
+     * Convert cluster dict to Cluster object
+     */
+    private _clusterFromDict;
+    /**
+     * Convert memory dict to MemoryResponse object
+     */
+    private _memoryResponseFromDict;
+    /**
+     * Convert search result dict to SearchResult object
+     */
+    private _searchResultFromDict;
+    /**
+     * Convert graph search result dict to SearchResult object
+     */
+    private _searchResultFromGraphDict;
+    /**
+     * SHA-256 hash function
+     */
+    private _sha256;
+    /**
+     * Convert object to FormData
+     */
+    private _formDataFromObject;
+}
+
+export { type AgentResponse, type Cluster, type GraphCommunityResult, type GraphEntityResult, type GraphRelationshipResult, GraphSearchResultType, type Memory, type MemoryResponse, NebulaAuthenticationException, NebulaClientException, NebulaClusterNotFoundException, NebulaException, NebulaRateLimitException, NebulaSDK, type NebulaSDKConfig, NebulaValidationException, RetrievalType, type SearchOptions, type SearchResult, NebulaSDK as default };