@realtimex/sdk 1.1.3 → 1.1.4

package/dist/index.d.mts

@@ -396,6 +396,36 @@ interface VectorListWorkspacesResponse {
     workspaces?: string[];
     error?: string;
     code?: string;
+    error_message?: string;
+}
+interface VectorRegisterResponse {
+    success: boolean;
+    message?: string;
+    error?: string;
+    code?: string;
+}
+interface VectorConfigResponse {
+    success: boolean;
+    provider?: string;
+    config?: Record<string, any>;
+    error?: string;
+    code?: string;
+}
+interface VectorProviderField {
+    name: string;
+    label: string;
+    type: 'string' | 'password';
+    placeholder?: string;
+}
+interface VectorProviderMetadata {
+    name: string;
+    label: string;
+    description?: string;
+    fields: VectorProviderField[];
+}
+interface VectorProvidersResponse {
+    success: boolean;
+    providers: VectorProviderMetadata[];
 }
 /**
  * @deprecated Use PermissionRequiredError from api module instead
@@ -468,6 +498,29 @@ declare class VectorStore {
      * ```
      */
     listWorkspaces(): Promise<VectorListWorkspacesResponse>;
+    /**
+     * Register a custom vector database configuration for this app
+     *
+     * @example
+     * ```ts
+     * await sdk.llm.vectors.registerConfig('lancedb', { });
+     * ```
+     */
+    registerConfig(provider: string, config: Record<string, any>): Promise<VectorRegisterResponse>;
+    /**
+     * List all supported vector database providers and their configuration requirements
+     */
+    listProviders(): Promise<VectorProvidersResponse>;
+    /**
+     * Get the current vector database configuration for this app
+     *
+     * @example
+     * ```ts
+     * const { provider, config } = await sdk.llm.vectors.getConfig();
+     * console.log(`App is using ${provider}`);
+     * ```
+     */
+    getConfig(): Promise<VectorConfigResponse>;
 }
 declare class LLMModule {
     private baseUrl;
@@ -623,6 +676,11 @@ declare class RealtimeXSDK {
         appId?: string;
         timestamp: string;
     }>;
+    /**
+     * Get the absolute path to the data directory for this app.
+     * Path: ~/.realtimex.ai/Resources/local-apps/{appId}
+     */
+    getAppDataDir(): Promise<string>;
 }
 
 export { ActivitiesModule, type Activity, type Agent, ApiModule, type ChatMessage, type ChatOptions, type ChatResponse, type EmbedOptions, type EmbedResponse, LLMModule, LLMPermissionError, LLMProviderError, PermissionDeniedError, PermissionRequiredError, PortModule, type Provider, type ProvidersResponse, RealtimeXSDK, type SDKConfig, type StreamChunk, type Task, TaskModule, type TaskRun, type Thread, type TriggerAgentPayload, type TriggerAgentResponse, type VectorDeleteOptions, type VectorDeleteResponse, type VectorQueryOptions, type VectorQueryResponse, type VectorQueryResult, type VectorRecord, VectorStore, type VectorUpsertOptions, type VectorUpsertResponse, WebhookModule, type Workspace };

package/dist/index.d.ts

@@ -396,6 +396,36 @@ interface VectorListWorkspacesResponse {
     workspaces?: string[];
     error?: string;
     code?: string;
+    error_message?: string;
+}
+interface VectorRegisterResponse {
+    success: boolean;
+    message?: string;
+    error?: string;
+    code?: string;
+}
+interface VectorConfigResponse {
+    success: boolean;
+    provider?: string;
+    config?: Record<string, any>;
+    error?: string;
+    code?: string;
+}
+interface VectorProviderField {
+    name: string;
+    label: string;
+    type: 'string' | 'password';
+    placeholder?: string;
+}
+interface VectorProviderMetadata {
+    name: string;
+    label: string;
+    description?: string;
+    fields: VectorProviderField[];
+}
+interface VectorProvidersResponse {
+    success: boolean;
+    providers: VectorProviderMetadata[];
 }
 /**
  * @deprecated Use PermissionRequiredError from api module instead
@@ -468,6 +498,29 @@ declare class VectorStore {
      * ```
      */
     listWorkspaces(): Promise<VectorListWorkspacesResponse>;
+    /**
+     * Register a custom vector database configuration for this app
+     *
+     * @example
+     * ```ts
+     * await sdk.llm.vectors.registerConfig('lancedb', { });
+     * ```
+     */
+    registerConfig(provider: string, config: Record<string, any>): Promise<VectorRegisterResponse>;
+    /**
+     * List all supported vector database providers and their configuration requirements
+     */
+    listProviders(): Promise<VectorProvidersResponse>;
+    /**
+     * Get the current vector database configuration for this app
+     *
+     * @example
+     * ```ts
+     * const { provider, config } = await sdk.llm.vectors.getConfig();
+     * console.log(`App is using ${provider}`);
+     * ```
+     */
+    getConfig(): Promise<VectorConfigResponse>;
 }
 declare class LLMModule {
     private baseUrl;
@@ -623,6 +676,11 @@ declare class RealtimeXSDK {
         appId?: string;
         timestamp: string;
     }>;
+    /**
+     * Get the absolute path to the data directory for this app.
+     * Path: ~/.realtimex.ai/Resources/local-apps/{appId}
+     */
+    getAppDataDir(): Promise<string>;
 }
 
 export { ActivitiesModule, type Activity, type Agent, ApiModule, type ChatMessage, type ChatOptions, type ChatResponse, type EmbedOptions, type EmbedResponse, LLMModule, LLMPermissionError, LLMProviderError, PermissionDeniedError, PermissionRequiredError, PortModule, type Provider, type ProvidersResponse, RealtimeXSDK, type SDKConfig, type StreamChunk, type Task, TaskModule, type TaskRun, type Thread, type TriggerAgentPayload, type TriggerAgentResponse, type VectorDeleteOptions, type VectorDeleteResponse, type VectorQueryOptions, type VectorQueryResponse, type VectorQueryResult, type VectorRecord, VectorStore, type VectorUpsertOptions, type VectorUpsertResponse, WebhookModule, type Workspace };

package/dist/index.js

@@ -643,6 +643,38 @@ var VectorStore = class {
   async listWorkspaces() {
     return this.request("GET", "/sdk/llm/vectors/workspaces");
   }
+  /**
+   * Register a custom vector database configuration for this app
+   * 
+   * @example
+   * ```ts
+   * await sdk.llm.vectors.registerConfig('lancedb', { });
+   * ```
+   */
+  async registerConfig(provider, config) {
+    return this.request("POST", "/sdk/llm/vectors/register", {
+      provider,
+      config
+    });
+  }
+  /**
+   * List all supported vector database providers and their configuration requirements
+   */
+  async listProviders() {
+    return this.request("GET", "/sdk/llm/vectors/providers");
+  }
+  /**
+   * Get the current vector database configuration for this app
+   * 
+   * @example
+   * ```ts
+   * const { provider, config } = await sdk.llm.vectors.getConfig();
+   * console.log(`App is using ${provider}`);
+   * ```
+   */
+  async getConfig() {
+    return this.request("GET", "/sdk/llm/vectors/config");
+  }
 };
 var LLMModule = class {
   constructor(baseUrl, appId, appName = "Local App", apiKey) {
@@ -1034,6 +1066,31 @@ var _RealtimeXSDK = class _RealtimeXSDK {
       throw new Error(`Connection failed: ${error.message}`);
     }
   }
+  /**
+   * Get the absolute path to the data directory for this app.
+   * Path: ~/.realtimex.ai/Resources/local-apps/{appId}
+   */
+  async getAppDataDir() {
+    try {
+      const headers = { "Content-Type": "application/json" };
+      if (this.apiKey) {
+        headers["Authorization"] = `Bearer ${this.apiKey}`;
+      } else if (this.appId) {
+        headers["x-app-id"] = this.appId;
+      }
+      const response = await fetch(`${this.realtimexUrl.replace(/\/$/, "")}/sdk/local-apps/data-dir`, {
+        method: "GET",
+        headers
+      });
+      const data = await response.json();
+      if (!response.ok) {
+        throw new Error(data.error || "Failed to get data directory");
+      }
+      return data.dataDir;
+    } catch (error) {
+      throw new Error(`Failed to get app data directory: ${error.message}`);
+    }
+  }
 };
 _RealtimeXSDK.DEFAULT_REALTIMEX_URL = "http://localhost:3001";
 var RealtimeXSDK = _RealtimeXSDK;

package/dist/index.mjs

@@ -596,6 +596,38 @@ var VectorStore = class {
   async listWorkspaces() {
     return this.request("GET", "/sdk/llm/vectors/workspaces");
   }
+  /**
+   * Register a custom vector database configuration for this app
+   * 
+   * @example
+   * ```ts
+   * await sdk.llm.vectors.registerConfig('lancedb', { });
+   * ```
+   */
+  async registerConfig(provider, config) {
+    return this.request("POST", "/sdk/llm/vectors/register", {
+      provider,
+      config
+    });
+  }
+  /**
+   * List all supported vector database providers and their configuration requirements
+   */
+  async listProviders() {
+    return this.request("GET", "/sdk/llm/vectors/providers");
+  }
+  /**
+   * Get the current vector database configuration for this app
+   * 
+   * @example
+   * ```ts
+   * const { provider, config } = await sdk.llm.vectors.getConfig();
+   * console.log(`App is using ${provider}`);
+   * ```
+   */
+  async getConfig() {
+    return this.request("GET", "/sdk/llm/vectors/config");
+  }
 };
 var LLMModule = class {
   constructor(baseUrl, appId, appName = "Local App", apiKey) {
@@ -987,6 +1019,31 @@ var _RealtimeXSDK = class _RealtimeXSDK {
       throw new Error(`Connection failed: ${error.message}`);
     }
   }
+  /**
+   * Get the absolute path to the data directory for this app.
+   * Path: ~/.realtimex.ai/Resources/local-apps/{appId}
+   */
+  async getAppDataDir() {
+    try {
+      const headers = { "Content-Type": "application/json" };
+      if (this.apiKey) {
+        headers["Authorization"] = `Bearer ${this.apiKey}`;
+      } else if (this.appId) {
+        headers["x-app-id"] = this.appId;
+      }
+      const response = await fetch(`${this.realtimexUrl.replace(/\/$/, "")}/sdk/local-apps/data-dir`, {
+        method: "GET",
+        headers
+      });
+      const data = await response.json();
+      if (!response.ok) {
+        throw new Error(data.error || "Failed to get data directory");
+      }
+      return data.dataDir;
+    } catch (error) {
+      throw new Error(`Failed to get app data directory: ${error.message}`);
+    }
+  }
 };
 _RealtimeXSDK.DEFAULT_REALTIMEX_URL = "http://localhost:3001";
 var RealtimeXSDK = _RealtimeXSDK;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@realtimex/sdk",
-    "version": "1.1.3",
+    "version": "1.1.4",
     "description": "SDK for building Local Apps that integrate with RealtimeX",
     "main": "dist/index.js",
     "module": "dist/index.mjs",