@retrivora-ai/rag-engine 0.1.5 → 0.1.6

package/dist/handlers/index.mjs

@@ -3,7 +3,7 @@ import {
   createHealthHandler,
   createIngestHandler,
   createUploadHandler
-} from "../chunk-BP4U4TT5.mjs";
+} from "../chunk-HSBXE2WV.mjs";
 import "../chunk-JI6VD5TJ.mjs";
 import "../chunk-UKDXCXW7.mjs";
 import "../chunk-I4E63NIC.mjs";

package/dist/index-Bx182KKn.d.ts

@@ -0,0 +1,64 @@
+import { a as RagConfig, C as ChatResponse } from './RagConfig-hBGXJmSx.js';
+import { NextRequest, NextResponse } from 'next/server';
+
+/**
+ * ProviderHealthCheck.ts — Pre-flight validation for vector DB and LLM providers.
+ *
+ * Performs connectivity tests, credential validation, and capability checks
+ * before initializing providers.
+ */
+
+interface HealthCheckResult {
+    healthy: boolean;
+    provider: string;
+    version?: string;
+    capabilities?: Record<string, unknown>;
+    error?: string;
+    timestamp: number;
+}
+
+/**
+ * createChatHandler — factory that returns a Next.js App Router POST handler
+ */
+declare function createChatHandler(config?: Partial<RagConfig>): (req: NextRequest) => Promise<NextResponse<{
+    error: string;
+}> | NextResponse<ChatResponse>>;
+/**
+ * createIngestHandler — factory for the document ingestion endpoint.
+ */
+declare function createIngestHandler(config?: Partial<RagConfig>): (req: NextRequest) => Promise<NextResponse<{
+    error: string;
+}> | NextResponse<{
+    results: {
+        docId: string | number;
+        chunksIngested: number;
+    }[];
+}>>;
+/**
+ * createHealthHandler — factory for the health-check endpoint.
+ */
+declare function createHealthHandler(config?: Partial<RagConfig>): () => Promise<NextResponse<{
+    timestamp: string;
+    vectorDb: HealthCheckResult;
+    llm: HealthCheckResult;
+    embedding?: HealthCheckResult;
+    allHealthy: boolean;
+    status: string;
+}> | NextResponse<{
+    status: string;
+    error: string;
+}>>;
+/**
+ * createUploadHandler — factory for the file upload ingestion endpoint.
+ */
+declare function createUploadHandler(config?: Partial<RagConfig>): (req: NextRequest) => Promise<NextResponse<{
+    error: string;
+}> | NextResponse<{
+    message: string;
+    results: {
+        docId: string | number;
+        chunksIngested: number;
+    }[];
+}>>;
+
+export { type HealthCheckResult as H, createHealthHandler as a, createIngestHandler as b, createChatHandler as c, createUploadHandler as d };

package/dist/index-Ck2pt7-8.d.mts

@@ -0,0 +1,64 @@
+import { a as RagConfig, C as ChatResponse } from './RagConfig-hBGXJmSx.mjs';
+import { NextRequest, NextResponse } from 'next/server';
+
+/**
+ * ProviderHealthCheck.ts — Pre-flight validation for vector DB and LLM providers.
+ *
+ * Performs connectivity tests, credential validation, and capability checks
+ * before initializing providers.
+ */
+
+interface HealthCheckResult {
+    healthy: boolean;
+    provider: string;
+    version?: string;
+    capabilities?: Record<string, unknown>;
+    error?: string;
+    timestamp: number;
+}
+
+/**
+ * createChatHandler — factory that returns a Next.js App Router POST handler
+ */
+declare function createChatHandler(config?: Partial<RagConfig>): (req: NextRequest) => Promise<NextResponse<{
+    error: string;
+}> | NextResponse<ChatResponse>>;
+/**
+ * createIngestHandler — factory for the document ingestion endpoint.
+ */
+declare function createIngestHandler(config?: Partial<RagConfig>): (req: NextRequest) => Promise<NextResponse<{
+    error: string;
+}> | NextResponse<{
+    results: {
+        docId: string | number;
+        chunksIngested: number;
+    }[];
+}>>;
+/**
+ * createHealthHandler — factory for the health-check endpoint.
+ */
+declare function createHealthHandler(config?: Partial<RagConfig>): () => Promise<NextResponse<{
+    timestamp: string;
+    vectorDb: HealthCheckResult;
+    llm: HealthCheckResult;
+    embedding?: HealthCheckResult;
+    allHealthy: boolean;
+    status: string;
+}> | NextResponse<{
+    status: string;
+    error: string;
+}>>;
+/**
+ * createUploadHandler — factory for the file upload ingestion endpoint.
+ */
+declare function createUploadHandler(config?: Partial<RagConfig>): (req: NextRequest) => Promise<NextResponse<{
+    error: string;
+}> | NextResponse<{
+    message: string;
+    results: {
+        docId: string | number;
+        chunksIngested: number;
+    }[];
+}>>;
+
+export { type HealthCheckResult as H, createHealthHandler as a, createIngestHandler as b, createChatHandler as c, createUploadHandler as d };

package/dist/index.d.mts

@@ -1,9 +1,9 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import React$1, { ReactNode } from 'react';
-import { C as ChatMessage } from './DocumentChunker-cfaMidtA.mjs';
-export { a as ChatOptions, b as Chunk, c as ChunkOptions, E as EmbedOptions, I as ILLMProvider } from './DocumentChunker-cfaMidtA.mjs';
-import { V as VectorMatch, U as UIConfig } from './RagConfig-DG_0f8ka.mjs';
-export { C as ChatResponse, E as EmbeddingConfig, I as IngestDocument, L as LLMConfig, R as RAGConfig, a as RagConfig, b as UpsertDocument, c as VectorDBConfig } from './RagConfig-DG_0f8ka.mjs';
+import { C as ChatMessage } from './DocumentChunker-BEyzadsv.mjs';
+export { a as ChatOptions, b as Chunk, c as ChunkOptions, E as EmbedOptions, I as ILLMProvider } from './DocumentChunker-BEyzadsv.mjs';
+import { V as VectorMatch, U as UIConfig } from './RagConfig-hBGXJmSx.mjs';
+export { C as ChatResponse, E as EmbeddingConfig, I as IngestDocument, L as LLMConfig, R as RAGConfig, a as RagConfig, b as UpsertDocument, c as VectorDBConfig } from './RagConfig-hBGXJmSx.mjs';
 
 interface ChatWidgetProps {
     /** Position of the floating button. Defaults to bottom-right. */

package/dist/index.d.ts

@@ -1,9 +1,9 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import React$1, { ReactNode } from 'react';
-import { C as ChatMessage } from './DocumentChunker-cfaMidtA.js';
-export { a as ChatOptions, b as Chunk, c as ChunkOptions, E as EmbedOptions, I as ILLMProvider } from './DocumentChunker-cfaMidtA.js';
-import { V as VectorMatch, U as UIConfig } from './RagConfig-DG_0f8ka.js';
-export { C as ChatResponse, E as EmbeddingConfig, I as IngestDocument, L as LLMConfig, R as RAGConfig, a as RagConfig, b as UpsertDocument, c as VectorDBConfig } from './RagConfig-DG_0f8ka.js';
+import { C as ChatMessage } from './DocumentChunker-BEyzadsv.js';
+export { a as ChatOptions, b as Chunk, c as ChunkOptions, E as EmbedOptions, I as ILLMProvider } from './DocumentChunker-BEyzadsv.js';
+import { V as VectorMatch, U as UIConfig } from './RagConfig-hBGXJmSx.js';
+export { C as ChatResponse, E as EmbeddingConfig, I as IngestDocument, L as LLMConfig, R as RAGConfig, a as RagConfig, b as UpsertDocument, c as VectorDBConfig } from './RagConfig-hBGXJmSx.js';
 
 interface ChatWidgetProps {
     /** Position of the floating button. Defaults to bottom-right. */

package/dist/server.d.mts

@@ -1,13 +1,21 @@
-import { a as RagConfig, C as ChatResponse, I as IngestDocument, c as VectorDBConfig, b as UpsertDocument, V as VectorMatch, L as LLMConfig, E as EmbeddingConfig } from './RagConfig-DG_0f8ka.mjs';
-export { R as RAGConfig, U as UIConfig } from './RagConfig-DG_0f8ka.mjs';
-import { C as ChatMessage, I as ILLMProvider, a as ChatOptions, E as EmbedOptions } from './DocumentChunker-cfaMidtA.mjs';
-export { b as Chunk, c as ChunkOptions, D as DocumentChunker } from './DocumentChunker-cfaMidtA.mjs';
-export { createChatHandler, createHealthHandler, createIngestHandler, createUploadHandler } from './handlers/index.mjs';
+import { a as RagConfig, C as ChatResponse, I as IngestDocument, c as VectorDBConfig, b as UpsertDocument, V as VectorMatch, L as LLMConfig, E as EmbeddingConfig } from './RagConfig-hBGXJmSx.mjs';
+export { R as RAGConfig, U as UIConfig } from './RagConfig-hBGXJmSx.mjs';
+import { C as ChatMessage, I as ILLMProvider, a as ChatOptions, E as EmbedOptions } from './DocumentChunker-BEyzadsv.mjs';
+export { b as Chunk, c as ChunkOptions, D as DocumentChunker } from './DocumentChunker-BEyzadsv.mjs';
+import { H as HealthCheckResult } from './index-Ck2pt7-8.mjs';
+export { c as createChatHandler, a as createHealthHandler, b as createIngestHandler, d as createUploadHandler } from './index-Ck2pt7-8.mjs';
 import 'next/server';
 
 /**
  * VectorPlugin — main orchestrator class.
  * This is the primary interface for host applications.
+ *
+ * Features:
+ * - Configuration resolution from host + environment
+ * - Configuration validation with detailed error messages
+ * - Provider health checks before initialization
+ * - Multi-provider support (Vector DBs & LLMs)
+ * - Per-tenant data isolation via namespacing
  */
 declare class VectorPlugin {
     private config;
@@ -15,12 +23,40 @@ declare class VectorPlugin {
     /**
      * Initializes the plugin with the host configuration.
      * @param hostConfig - Configuration object passed from the host application.
+     * @throws Error if configuration is invalid or providers are unhealthy
+     *
+     * @example
+     * const plugin = new VectorPlugin({
+     *   projectId: 'my-app',
+     *   vectorDb: {
+     *     provider: 'pinecone',
+     *     indexName: 'my-index',
+     *     options: { apiKey: process.env.PINECONE_API_KEY }
+     *   },
+     *   llm: {
+     *     provider: 'openai',
+     *     model: 'gpt-4o',
+     *     apiKey: process.env.OPENAI_API_KEY
+     *   }
+     * });
      */
     constructor(hostConfig?: Partial<RagConfig>);
     /**
      * Get the current resolved configuration.
      */
     getConfig(): RagConfig;
+    /**
+     * Perform pre-flight health checks on all configured providers.
+     * Useful to verify connectivity before running operations.
+     *
+     * @returns Health status for vector DB, LLM, and embedding providers
+     */
+    checkHealth(): Promise<{
+        vectorDb: HealthCheckResult;
+        llm: HealthCheckResult;
+        embedding?: HealthCheckResult;
+        allHealthy: boolean;
+    }>;
     /**
      * Run a chat query.
      */
@@ -29,17 +65,20 @@ declare class VectorPlugin {
      * Ingest documents into the vector database.
      */
     ingest(documents: IngestDocument[], namespace?: string): Promise<Array<{
-        docId: string;
+        docId: string | number;
         chunksIngested: number;
     }>>;
-    /**
-     * Check the health of the connected providers.
-     */
-    health(): Promise<Record<string, boolean>>;
 }
 
 /**
  * Pipeline — orchestrates the RAG flow: Embed → Search → Augment → Generate.
+ *
+ * Features:
+ * - Lazy initialization of providers
+ * - Batch processing with retry logic
+ * - Configurable embedding strategies
+ * - Error recovery for transient failures
+ * - Support for multi-tenancy via namespacing
  */
 declare class Pipeline {
     private vectorDB;
@@ -50,12 +89,15 @@ declare class Pipeline {
     private initialised;
     constructor(config: RagConfig);
     initialize(): Promise<void>;
+    /**
+     * Ingest documents with automatic chunking, embedding, and batch processing.
+     * Handles retries for transient failures.
+     */
     ingest(documents: IngestDocument[], namespace?: string): Promise<Array<{
-        docId: string;
+        docId: string | number;
         chunksIngested: number;
     }>>;
     ask(question: string, history?: ChatMessage[], namespace?: string): Promise<ChatResponse>;
-    health(): Promise<Record<string, boolean>>;
 }
 
 /**
@@ -101,7 +143,7 @@ declare abstract class BaseVectorProvider {
     /**
      * Delete a stored vector by ID.
      */
-    abstract delete(id: string, namespace?: string): Promise<void>;
+    abstract delete(id: string | number, namespace?: string): Promise<void>;
     /**
      * Delete all vectors in a namespace (full data reset for a project).
      */
@@ -153,7 +195,7 @@ declare class PineconeProvider extends BaseVectorProvider {
     upsert(doc: UpsertDocument, namespace?: string): Promise<void>;
     batchUpsert(docs: UpsertDocument[], namespace?: string): Promise<void>;
     query(vector: number[], topK: number, namespace?: string, filter?: Record<string, unknown>): Promise<VectorMatch[]>;
-    delete(id: string, namespace?: string): Promise<void>;
+    delete(id: string | number, namespace?: string): Promise<void>;
     deleteNamespace(namespace: string): Promise<void>;
     ping(): Promise<boolean>;
     disconnect(): Promise<void>;
@@ -172,7 +214,7 @@ declare class PostgreSQLProvider extends BaseVectorProvider {
     upsert(doc: UpsertDocument, namespace?: string): Promise<void>;
     batchUpsert(docs: UpsertDocument[], namespace?: string): Promise<void>;
     query(vector: number[], topK: number, namespace?: string, filter?: Record<string, unknown>): Promise<VectorMatch[]>;
-    delete(id: string, namespace?: string): Promise<void>;
+    delete(id: string | number, namespace?: string): Promise<void>;
     deleteNamespace(namespace: string): Promise<void>;
     ping(): Promise<boolean>;
     disconnect(): Promise<void>;
@@ -195,7 +237,7 @@ declare class MongoDBProvider extends BaseVectorProvider {
     upsert(doc: UpsertDocument, namespace?: string): Promise<void>;
     batchUpsert(docs: UpsertDocument[], namespace?: string): Promise<void>;
     query(vector: number[], topK: number, namespace?: string, filter?: Record<string, unknown>): Promise<VectorMatch[]>;
-    delete(id: string, namespace?: string): Promise<void>;
+    delete(id: string | number, namespace?: string): Promise<void>;
     deleteNamespace(namespace: string): Promise<void>;
     ping(): Promise<boolean>;
     disconnect(): Promise<void>;
@@ -211,7 +253,7 @@ declare class MilvusProvider extends BaseVectorProvider {
     upsert(doc: UpsertDocument, namespace?: string): Promise<void>;
     batchUpsert(docs: UpsertDocument[], namespace?: string): Promise<void>;
     query(vector: number[], topK: number, namespace?: string, _filter?: Record<string, unknown>): Promise<VectorMatch[]>;
-    delete(id: string, _namespace?: string): Promise<void>;
+    delete(id: string | number, _namespace?: string): Promise<void>;
     deleteNamespace(_namespace: string): Promise<void>;
     ping(): Promise<boolean>;
     disconnect(): Promise<void>;
@@ -224,10 +266,15 @@ declare class QdrantProvider extends BaseVectorProvider {
     private http;
     constructor(config: VectorDBConfig);
     initialize(): Promise<void>;
+    /**
+     * Ensures that the 'namespace' field has a keyword index for efficient filtering.
+     * Qdrant requires this for search filters to work in many configurations.
+     */
+    private ensureIndex;
     upsert(doc: UpsertDocument, namespace?: string): Promise<void>;
     batchUpsert(docs: UpsertDocument[], namespace?: string): Promise<void>;
     query(vector: number[], topK: number, namespace?: string, _filter?: Record<string, unknown>): Promise<VectorMatch[]>;
-    delete(id: string, _namespace?: string): Promise<void>;
+    delete(id: string | number, _namespace?: string): Promise<void>;
     deleteNamespace(_namespace: string): Promise<void>;
     ping(): Promise<boolean>;
     disconnect(): Promise<void>;

package/dist/server.d.ts

@@ -1,13 +1,21 @@
-import { a as RagConfig, C as ChatResponse, I as IngestDocument, c as VectorDBConfig, b as UpsertDocument, V as VectorMatch, L as LLMConfig, E as EmbeddingConfig } from './RagConfig-DG_0f8ka.js';
-export { R as RAGConfig, U as UIConfig } from './RagConfig-DG_0f8ka.js';
-import { C as ChatMessage, I as ILLMProvider, a as ChatOptions, E as EmbedOptions } from './DocumentChunker-cfaMidtA.js';
-export { b as Chunk, c as ChunkOptions, D as DocumentChunker } from './DocumentChunker-cfaMidtA.js';
-export { createChatHandler, createHealthHandler, createIngestHandler, createUploadHandler } from './handlers/index.js';
+import { a as RagConfig, C as ChatResponse, I as IngestDocument, c as VectorDBConfig, b as UpsertDocument, V as VectorMatch, L as LLMConfig, E as EmbeddingConfig } from './RagConfig-hBGXJmSx.js';
+export { R as RAGConfig, U as UIConfig } from './RagConfig-hBGXJmSx.js';
+import { C as ChatMessage, I as ILLMProvider, a as ChatOptions, E as EmbedOptions } from './DocumentChunker-BEyzadsv.js';
+export { b as Chunk, c as ChunkOptions, D as DocumentChunker } from './DocumentChunker-BEyzadsv.js';
+import { H as HealthCheckResult } from './index-Bx182KKn.js';
+export { c as createChatHandler, a as createHealthHandler, b as createIngestHandler, d as createUploadHandler } from './index-Bx182KKn.js';
 import 'next/server';
 
 /**
  * VectorPlugin — main orchestrator class.
  * This is the primary interface for host applications.
+ *
+ * Features:
+ * - Configuration resolution from host + environment
+ * - Configuration validation with detailed error messages
+ * - Provider health checks before initialization
+ * - Multi-provider support (Vector DBs & LLMs)
+ * - Per-tenant data isolation via namespacing
  */
 declare class VectorPlugin {
     private config;
@@ -15,12 +23,40 @@ declare class VectorPlugin {
     /**
      * Initializes the plugin with the host configuration.
      * @param hostConfig - Configuration object passed from the host application.
+     * @throws Error if configuration is invalid or providers are unhealthy
+     *
+     * @example
+     * const plugin = new VectorPlugin({
+     *   projectId: 'my-app',
+     *   vectorDb: {
+     *     provider: 'pinecone',
+     *     indexName: 'my-index',
+     *     options: { apiKey: process.env.PINECONE_API_KEY }
+     *   },
+     *   llm: {
+     *     provider: 'openai',
+     *     model: 'gpt-4o',
+     *     apiKey: process.env.OPENAI_API_KEY
+     *   }
+     * });
      */
     constructor(hostConfig?: Partial<RagConfig>);
     /**
      * Get the current resolved configuration.
      */
     getConfig(): RagConfig;
+    /**
+     * Perform pre-flight health checks on all configured providers.
+     * Useful to verify connectivity before running operations.
+     *
+     * @returns Health status for vector DB, LLM, and embedding providers
+     */
+    checkHealth(): Promise<{
+        vectorDb: HealthCheckResult;
+        llm: HealthCheckResult;
+        embedding?: HealthCheckResult;
+        allHealthy: boolean;
+    }>;
     /**
      * Run a chat query.
      */
@@ -29,17 +65,20 @@ declare class VectorPlugin {
      * Ingest documents into the vector database.
      */
     ingest(documents: IngestDocument[], namespace?: string): Promise<Array<{
-        docId: string;
+        docId: string | number;
         chunksIngested: number;
     }>>;
-    /**
-     * Check the health of the connected providers.
-     */
-    health(): Promise<Record<string, boolean>>;
 }
 
 /**
  * Pipeline — orchestrates the RAG flow: Embed → Search → Augment → Generate.
+ *
+ * Features:
+ * - Lazy initialization of providers
+ * - Batch processing with retry logic
+ * - Configurable embedding strategies
+ * - Error recovery for transient failures
+ * - Support for multi-tenancy via namespacing
  */
 declare class Pipeline {
     private vectorDB;
@@ -50,12 +89,15 @@ declare class Pipeline {
     private initialised;
     constructor(config: RagConfig);
     initialize(): Promise<void>;
+    /**
+     * Ingest documents with automatic chunking, embedding, and batch processing.
+     * Handles retries for transient failures.
+     */
     ingest(documents: IngestDocument[], namespace?: string): Promise<Array<{
-        docId: string;
+        docId: string | number;
         chunksIngested: number;
     }>>;
     ask(question: string, history?: ChatMessage[], namespace?: string): Promise<ChatResponse>;
-    health(): Promise<Record<string, boolean>>;
 }
 
 /**
@@ -101,7 +143,7 @@ declare abstract class BaseVectorProvider {
     /**
      * Delete a stored vector by ID.
      */
-    abstract delete(id: string, namespace?: string): Promise<void>;
+    abstract delete(id: string | number, namespace?: string): Promise<void>;
     /**
      * Delete all vectors in a namespace (full data reset for a project).
      */
@@ -153,7 +195,7 @@ declare class PineconeProvider extends BaseVectorProvider {
     upsert(doc: UpsertDocument, namespace?: string): Promise<void>;
     batchUpsert(docs: UpsertDocument[], namespace?: string): Promise<void>;
     query(vector: number[], topK: number, namespace?: string, filter?: Record<string, unknown>): Promise<VectorMatch[]>;
-    delete(id: string, namespace?: string): Promise<void>;
+    delete(id: string | number, namespace?: string): Promise<void>;
     deleteNamespace(namespace: string): Promise<void>;
     ping(): Promise<boolean>;
     disconnect(): Promise<void>;
@@ -172,7 +214,7 @@ declare class PostgreSQLProvider extends BaseVectorProvider {
     upsert(doc: UpsertDocument, namespace?: string): Promise<void>;
     batchUpsert(docs: UpsertDocument[], namespace?: string): Promise<void>;
     query(vector: number[], topK: number, namespace?: string, filter?: Record<string, unknown>): Promise<VectorMatch[]>;
-    delete(id: string, namespace?: string): Promise<void>;
+    delete(id: string | number, namespace?: string): Promise<void>;
     deleteNamespace(namespace: string): Promise<void>;
     ping(): Promise<boolean>;
     disconnect(): Promise<void>;
@@ -195,7 +237,7 @@ declare class MongoDBProvider extends BaseVectorProvider {
     upsert(doc: UpsertDocument, namespace?: string): Promise<void>;
     batchUpsert(docs: UpsertDocument[], namespace?: string): Promise<void>;
     query(vector: number[], topK: number, namespace?: string, filter?: Record<string, unknown>): Promise<VectorMatch[]>;
-    delete(id: string, namespace?: string): Promise<void>;
+    delete(id: string | number, namespace?: string): Promise<void>;
     deleteNamespace(namespace: string): Promise<void>;
     ping(): Promise<boolean>;
     disconnect(): Promise<void>;
@@ -211,7 +253,7 @@ declare class MilvusProvider extends BaseVectorProvider {
     upsert(doc: UpsertDocument, namespace?: string): Promise<void>;
     batchUpsert(docs: UpsertDocument[], namespace?: string): Promise<void>;
     query(vector: number[], topK: number, namespace?: string, _filter?: Record<string, unknown>): Promise<VectorMatch[]>;
-    delete(id: string, _namespace?: string): Promise<void>;
+    delete(id: string | number, _namespace?: string): Promise<void>;
     deleteNamespace(_namespace: string): Promise<void>;
     ping(): Promise<boolean>;
     disconnect(): Promise<void>;
@@ -224,10 +266,15 @@ declare class QdrantProvider extends BaseVectorProvider {
     private http;
     constructor(config: VectorDBConfig);
     initialize(): Promise<void>;
+    /**
+     * Ensures that the 'namespace' field has a keyword index for efficient filtering.
+     * Qdrant requires this for search filters to work in many configurations.
+     */
+    private ensureIndex;
     upsert(doc: UpsertDocument, namespace?: string): Promise<void>;
     batchUpsert(docs: UpsertDocument[], namespace?: string): Promise<void>;
     query(vector: number[], topK: number, namespace?: string, _filter?: Record<string, unknown>): Promise<VectorMatch[]>;
-    delete(id: string, _namespace?: string): Promise<void>;
+    delete(id: string | number, _namespace?: string): Promise<void>;
     deleteNamespace(_namespace: string): Promise<void>;
     ping(): Promise<boolean>;
     disconnect(): Promise<void>;