@objectstack/service-ai 4.0.2 → 4.0.4

package/dist/index.d.cts

@@ -363,23 +363,19 @@ declare class ObjectQLConversationService implements IAIConversationService {
 interface DataToolContext {
     /** ObjectQL data engine for record-level operations. */
     dataEngine: IDataEngine;
-    /** Metadata service for schema/object introspection. */
-    metadataService: IMetadataService;
 }
-/** All built-in data tool definitions. */
+/** All built-in data tools definitions. */
 declare const DATA_TOOL_DEFINITIONS: AIToolDefinition[];
 /**
  * Register all built-in data tools on the given {@link ToolRegistry}.
  *
- * Typically called from the `ai:ready` hook after both the data engine
- * and metadata service are available.
+ * Typically called from the `ai:ready` hook after the data engine is available.
  *
  * @example
  * ```ts
  * ctx.hook('ai:ready', async (aiService) => {
  *   const dataEngine = ctx.getService<IDataEngine>('data');
- *   const metadataService = ctx.getService<IMetadataService>('metadata');
- *   registerDataTools(aiService.toolRegistry, { dataEngine, metadataService });
+ *   registerDataTools(aiService.toolRegistry, { dataEngine });
  * });
  * ```
  */
@@ -400,7 +396,7 @@ declare const createObjectTool: {
     requiresConfirmation: boolean;
     active: boolean;
     builtIn: boolean;
-    category?: "flow" | "action" | "vector_search" | "data" | "utility" | "integration" | "analytics" | undefined;
+    category?: "action" | "flow" | "vector_search" | "data" | "utility" | "integration" | "analytics" | undefined;
     outputSchema?: Record<string, unknown> | undefined;
     objectName?: string | undefined;
     permissions?: string[] | undefined;
@@ -421,7 +417,7 @@ declare const addFieldTool: {
     requiresConfirmation: boolean;
     active: boolean;
     builtIn: boolean;
-    category?: "flow" | "action" | "vector_search" | "data" | "utility" | "integration" | "analytics" | undefined;
+    category?: "action" | "flow" | "vector_search" | "data" | "utility" | "integration" | "analytics" | undefined;
     outputSchema?: Record<string, unknown> | undefined;
     objectName?: string | undefined;
     permissions?: string[] | undefined;
@@ -441,7 +437,7 @@ declare const modifyFieldTool: {
     requiresConfirmation: boolean;
     active: boolean;
     builtIn: boolean;
-    category?: "flow" | "action" | "vector_search" | "data" | "utility" | "integration" | "analytics" | undefined;
+    category?: "action" | "flow" | "vector_search" | "data" | "utility" | "integration" | "analytics" | undefined;
     outputSchema?: Record<string, unknown> | undefined;
     objectName?: string | undefined;
     permissions?: string[] | undefined;
@@ -461,20 +457,20 @@ declare const deleteFieldTool: {
     requiresConfirmation: boolean;
     active: boolean;
     builtIn: boolean;
-    category?: "flow" | "action" | "vector_search" | "data" | "utility" | "integration" | "analytics" | undefined;
+    category?: "action" | "flow" | "vector_search" | "data" | "utility" | "integration" | "analytics" | undefined;
     outputSchema?: Record<string, unknown> | undefined;
     objectName?: string | undefined;
     permissions?: string[] | undefined;
 };
 
 /**
- * list_metadata_objects — AI Tool Metadata
+ * list_objects — AI Tool Metadata
  *
- * Lists all registered metadata objects (tables) with optional filtering.
- * Uses a unique name (`list_metadata_objects`) to avoid collision with
- * the data-tools `list_objects` tool.
+ * Lists all registered data objects (tables) with optional filtering
+ * and field summaries. This is the single, unified tool for listing
+ * objects — used by both data_chat and metadata_assistant agents.
  */
-declare const listMetadataObjectsTool: {
+declare const listObjectsTool: {
     name: string;
     label: string;
     description: string;
@@ -482,21 +478,20 @@ declare const listMetadataObjectsTool: {
     requiresConfirmation: boolean;
     active: boolean;
     builtIn: boolean;
-    category?: "flow" | "action" | "vector_search" | "data" | "utility" | "integration" | "analytics" | undefined;
+    category?: "action" | "flow" | "vector_search" | "data" | "utility" | "integration" | "analytics" | undefined;
     outputSchema?: Record<string, unknown> | undefined;
     objectName?: string | undefined;
     permissions?: string[] | undefined;
 };
 
 /**
- * describe_metadata_object — AI Tool Metadata
+ * describe_object — AI Tool Metadata
  *
- * Returns the full metadata schema of a data object including all
- * fields, types, relationships, and configuration. Uses a unique name
- * (`describe_metadata_object`) to avoid collision with the data-tools
- * `describe_object` tool.
+ * Returns the full schema of a data object including all fields, types,
+ * relationships, and configuration. This is the single, unified tool for
+ * describing objects — used by both data_chat and metadata_assistant agents.
  */
-declare const describeMetadataObjectTool: {
+declare const describeObjectTool: {
     name: string;
     label: string;
     description: string;
@@ -504,7 +499,7 @@ declare const describeMetadataObjectTool: {
     requiresConfirmation: boolean;
     active: boolean;
     builtIn: boolean;
-    category?: "flow" | "action" | "vector_search" | "data" | "utility" | "integration" | "analytics" | undefined;
+    category?: "action" | "flow" | "vector_search" | "data" | "utility" | "integration" | "analytics" | undefined;
     outputSchema?: Record<string, unknown> | undefined;
     objectName?: string | undefined;
     permissions?: string[] | undefined;
@@ -969,7 +964,7 @@ declare const AiConversationObject: Omit<{
     actions?: {
         name: string;
         label: string;
-        type: "url" | "script" | "modal" | "flow" | "api";
+        type: "url" | "flow" | "api" | "script" | "modal";
         refreshAfter: boolean;
         objectName?: string | undefined;
         icon?: string | undefined;
@@ -2410,7 +2405,7 @@ declare const AiMessageObject: Omit<{
     actions?: {
         name: string;
         label: string;
-        type: "url" | "script" | "modal" | "flow" | "api";
+        type: "url" | "flow" | "api" | "script" | "modal";
         refreshAfter: boolean;
         objectName?: string | undefined;
         icon?: string | undefined;
@@ -3670,4 +3665,14 @@ declare function buildAIRoutes(aiService: IAIService, conversationService: IAICo
  */
 declare function buildAgentRoutes(aiService: AIService, agentRuntime: AgentRuntime, logger: Logger): RouteDefinition[];
 
-export { AIService, type AIServiceConfig, AIServicePlugin, type AIServicePluginOptions, type AgentChatContext, AgentRuntime, AiConversationObject, AiMessageObject, DATA_CHAT_AGENT, DATA_TOOL_DEFINITIONS, type DataToolContext, InMemoryConversationService, METADATA_ASSISTANT_AGENT, METADATA_TOOL_DEFINITIONS, MemoryLLMAdapter, type MetadataToolContext, ObjectQLConversationService, type RouteDefinition, type RouteRequest, type RouteResponse, type RouteUserContext, type ToolExecutionResult, type ToolHandler, ToolRegistry, VercelLLMAdapter, type VercelLLMAdapterConfig, addFieldTool, buildAIRoutes, buildAgentRoutes, createObjectTool, deleteFieldTool, describeMetadataObjectTool, encodeStreamPart, encodeVercelDataStream, listMetadataObjectsTool, modifyFieldTool, registerDataTools, registerMetadataTools };
+/**
+ * Build tool-specific REST routes.
+ *
+ * | Method | Path | Description |
+ * |:---|:---|:---|
+ * | GET  | /api/v1/ai/tools | List all registered tools |
+ * | POST | /api/v1/ai/tools/:toolName/execute | Execute a tool with parameters |
+ */
+declare function buildToolRoutes(aiService: AIService, logger: Logger): RouteDefinition[];
+
+export { AIService, type AIServiceConfig, AIServicePlugin, type AIServicePluginOptions, type AgentChatContext, AgentRuntime, AiConversationObject, AiMessageObject, DATA_CHAT_AGENT, DATA_TOOL_DEFINITIONS, type DataToolContext, InMemoryConversationService, METADATA_ASSISTANT_AGENT, METADATA_TOOL_DEFINITIONS, MemoryLLMAdapter, type MetadataToolContext, ObjectQLConversationService, type RouteDefinition, type RouteRequest, type RouteResponse, type RouteUserContext, type ToolExecutionResult, type ToolHandler, ToolRegistry, VercelLLMAdapter, type VercelLLMAdapterConfig, addFieldTool, buildAIRoutes, buildAgentRoutes, buildToolRoutes, createObjectTool, deleteFieldTool, describeObjectTool, encodeStreamPart, encodeVercelDataStream, listObjectsTool, modifyFieldTool, registerDataTools, registerMetadataTools };

package/dist/index.d.ts

@@ -363,23 +363,19 @@ declare class ObjectQLConversationService implements IAIConversationService {
 interface DataToolContext {
     /** ObjectQL data engine for record-level operations. */
     dataEngine: IDataEngine;
-    /** Metadata service for schema/object introspection. */
-    metadataService: IMetadataService;
 }
-/** All built-in data tool definitions. */
+/** All built-in data tools definitions. */
 declare const DATA_TOOL_DEFINITIONS: AIToolDefinition[];
 /**
  * Register all built-in data tools on the given {@link ToolRegistry}.
  *
- * Typically called from the `ai:ready` hook after both the data engine
- * and metadata service are available.
+ * Typically called from the `ai:ready` hook after the data engine is available.
  *
  * @example
  * ```ts
  * ctx.hook('ai:ready', async (aiService) => {
  *   const dataEngine = ctx.getService<IDataEngine>('data');
- *   const metadataService = ctx.getService<IMetadataService>('metadata');
- *   registerDataTools(aiService.toolRegistry, { dataEngine, metadataService });
+ *   registerDataTools(aiService.toolRegistry, { dataEngine });
  * });
  * ```
  */
@@ -400,7 +396,7 @@ declare const createObjectTool: {
     requiresConfirmation: boolean;
     active: boolean;
     builtIn: boolean;
-    category?: "flow" | "action" | "vector_search" | "data" | "utility" | "integration" | "analytics" | undefined;
+    category?: "action" | "flow" | "vector_search" | "data" | "utility" | "integration" | "analytics" | undefined;
     outputSchema?: Record<string, unknown> | undefined;
     objectName?: string | undefined;
     permissions?: string[] | undefined;
@@ -421,7 +417,7 @@ declare const addFieldTool: {
     requiresConfirmation: boolean;
     active: boolean;
     builtIn: boolean;
-    category?: "flow" | "action" | "vector_search" | "data" | "utility" | "integration" | "analytics" | undefined;
+    category?: "action" | "flow" | "vector_search" | "data" | "utility" | "integration" | "analytics" | undefined;
     outputSchema?: Record<string, unknown> | undefined;
     objectName?: string | undefined;
     permissions?: string[] | undefined;
@@ -441,7 +437,7 @@ declare const modifyFieldTool: {
     requiresConfirmation: boolean;
     active: boolean;
     builtIn: boolean;
-    category?: "flow" | "action" | "vector_search" | "data" | "utility" | "integration" | "analytics" | undefined;
+    category?: "action" | "flow" | "vector_search" | "data" | "utility" | "integration" | "analytics" | undefined;
     outputSchema?: Record<string, unknown> | undefined;
     objectName?: string | undefined;
     permissions?: string[] | undefined;
@@ -461,20 +457,20 @@ declare const deleteFieldTool: {
     requiresConfirmation: boolean;
     active: boolean;
     builtIn: boolean;
-    category?: "flow" | "action" | "vector_search" | "data" | "utility" | "integration" | "analytics" | undefined;
+    category?: "action" | "flow" | "vector_search" | "data" | "utility" | "integration" | "analytics" | undefined;
     outputSchema?: Record<string, unknown> | undefined;
     objectName?: string | undefined;
     permissions?: string[] | undefined;
 };
 
 /**
- * list_metadata_objects — AI Tool Metadata
+ * list_objects — AI Tool Metadata
  *
- * Lists all registered metadata objects (tables) with optional filtering.
- * Uses a unique name (`list_metadata_objects`) to avoid collision with
- * the data-tools `list_objects` tool.
+ * Lists all registered data objects (tables) with optional filtering
+ * and field summaries. This is the single, unified tool for listing
+ * objects — used by both data_chat and metadata_assistant agents.
  */
-declare const listMetadataObjectsTool: {
+declare const listObjectsTool: {
     name: string;
     label: string;
     description: string;
@@ -482,21 +478,20 @@ declare const listMetadataObjectsTool: {
     requiresConfirmation: boolean;
     active: boolean;
     builtIn: boolean;
-    category?: "flow" | "action" | "vector_search" | "data" | "utility" | "integration" | "analytics" | undefined;
+    category?: "action" | "flow" | "vector_search" | "data" | "utility" | "integration" | "analytics" | undefined;
     outputSchema?: Record<string, unknown> | undefined;
     objectName?: string | undefined;
     permissions?: string[] | undefined;
 };
 
 /**
- * describe_metadata_object — AI Tool Metadata
+ * describe_object — AI Tool Metadata
  *
- * Returns the full metadata schema of a data object including all
- * fields, types, relationships, and configuration. Uses a unique name
- * (`describe_metadata_object`) to avoid collision with the data-tools
- * `describe_object` tool.
+ * Returns the full schema of a data object including all fields, types,
+ * relationships, and configuration. This is the single, unified tool for
+ * describing objects — used by both data_chat and metadata_assistant agents.
  */
-declare const describeMetadataObjectTool: {
+declare const describeObjectTool: {
     name: string;
     label: string;
     description: string;
@@ -504,7 +499,7 @@ declare const describeMetadataObjectTool: {
     requiresConfirmation: boolean;
     active: boolean;
     builtIn: boolean;
-    category?: "flow" | "action" | "vector_search" | "data" | "utility" | "integration" | "analytics" | undefined;
+    category?: "action" | "flow" | "vector_search" | "data" | "utility" | "integration" | "analytics" | undefined;
     outputSchema?: Record<string, unknown> | undefined;
     objectName?: string | undefined;
     permissions?: string[] | undefined;
@@ -969,7 +964,7 @@ declare const AiConversationObject: Omit<{
     actions?: {
         name: string;
         label: string;
-        type: "url" | "script" | "modal" | "flow" | "api";
+        type: "url" | "flow" | "api" | "script" | "modal";
         refreshAfter: boolean;
         objectName?: string | undefined;
         icon?: string | undefined;
@@ -2410,7 +2405,7 @@ declare const AiMessageObject: Omit<{
     actions?: {
         name: string;
         label: string;
-        type: "url" | "script" | "modal" | "flow" | "api";
+        type: "url" | "flow" | "api" | "script" | "modal";
         refreshAfter: boolean;
         objectName?: string | undefined;
         icon?: string | undefined;
@@ -3670,4 +3665,14 @@ declare function buildAIRoutes(aiService: IAIService, conversationService: IAICo
  */
 declare function buildAgentRoutes(aiService: AIService, agentRuntime: AgentRuntime, logger: Logger): RouteDefinition[];
 
-export { AIService, type AIServiceConfig, AIServicePlugin, type AIServicePluginOptions, type AgentChatContext, AgentRuntime, AiConversationObject, AiMessageObject, DATA_CHAT_AGENT, DATA_TOOL_DEFINITIONS, type DataToolContext, InMemoryConversationService, METADATA_ASSISTANT_AGENT, METADATA_TOOL_DEFINITIONS, MemoryLLMAdapter, type MetadataToolContext, ObjectQLConversationService, type RouteDefinition, type RouteRequest, type RouteResponse, type RouteUserContext, type ToolExecutionResult, type ToolHandler, ToolRegistry, VercelLLMAdapter, type VercelLLMAdapterConfig, addFieldTool, buildAIRoutes, buildAgentRoutes, createObjectTool, deleteFieldTool, describeMetadataObjectTool, encodeStreamPart, encodeVercelDataStream, listMetadataObjectsTool, modifyFieldTool, registerDataTools, registerMetadataTools };
+/**
+ * Build tool-specific REST routes.
+ *
+ * | Method | Path | Description |
+ * |:---|:---|:---|
+ * | GET  | /api/v1/ai/tools | List all registered tools |
+ * | POST | /api/v1/ai/tools/:toolName/execute | Execute a tool with parameters |
+ */
+declare function buildToolRoutes(aiService: AIService, logger: Logger): RouteDefinition[];
+
+export { AIService, type AIServiceConfig, AIServicePlugin, type AIServicePluginOptions, type AgentChatContext, AgentRuntime, AiConversationObject, AiMessageObject, DATA_CHAT_AGENT, DATA_TOOL_DEFINITIONS, type DataToolContext, InMemoryConversationService, METADATA_ASSISTANT_AGENT, METADATA_TOOL_DEFINITIONS, MemoryLLMAdapter, type MetadataToolContext, ObjectQLConversationService, type RouteDefinition, type RouteRequest, type RouteResponse, type RouteUserContext, type ToolExecutionResult, type ToolHandler, ToolRegistry, VercelLLMAdapter, type VercelLLMAdapterConfig, addFieldTool, buildAIRoutes, buildAgentRoutes, buildToolRoutes, createObjectTool, deleteFieldTool, describeObjectTool, encodeStreamPart, encodeVercelDataStream, listObjectsTool, modifyFieldTool, registerDataTools, registerMetadataTools };