@axiom-lattice/protocols 2.1.14 → 2.1.16

package/dist/index.d.ts

@@ -176,14 +176,20 @@ interface BrowserMiddlewareConfig {
 interface SqlMiddlewareConfig {
     databaseKeys?: string[];
 }
-type MiddlewareType = "filesystem" | "code_eval" | "browser" | "sql" | "skill" | "http" | "custom";
+interface MetricsMiddlewareConfig {
+    /** List of configured metrics server keys */
+    serverKeys: string[];
+    /** Optional descriptions for each server */
+    serverDescriptions?: Record<string, string>;
+}
+type MiddlewareType = "filesystem" | "code_eval" | "browser" | "sql" | "skill" | "http" | "custom" | "metrics";
 interface AgentMiddlewareConfig {
     id: string;
     type: MiddlewareType;
     name: string;
     description: string;
     enabled: boolean;
-    config: SandboxMiddlewareConfig | CodeEvalMiddlewareConfig | BrowserMiddlewareConfig | SqlMiddlewareConfig | Record<string, any>;
+    config: SandboxMiddlewareConfig | CodeEvalMiddlewareConfig | BrowserMiddlewareConfig | SqlMiddlewareConfig | MetricsMiddlewareConfig | Record<string, any>;
 }
 /**
  * REACT agent configuration
@@ -1297,6 +1303,19 @@ interface SkillStore {
      * @returns Array of sub-skills if found, empty array otherwise
      */
     getSubSkills(parentSkillName: string): Promise<Skill[]>;
+    /**
+     * List all resources in a skill's resources directory
+     * @param id Skill identifier
+     * @returns Array of resource paths relative to resources/ directory
+     */
+    listSkillResources?(id: string): Promise<string[]>;
+    /**
+     * Load a specific resource from a skill's resources directory
+     * @param id Skill identifier
+     * @param resourcePath Path to the resource relative to resources/ directory
+     * @returns The resource content as string, or null if not found
+     */
+    loadSkillResource?(id: string, resourcePath: string): Promise<string | null>;
 }
 
 /**
@@ -1659,6 +1678,56 @@ interface ProjectStore {
     deleteProject(tenantId: string, id: string): Promise<boolean>;
 }
 
+/**
+ * TenantStoreProtocol
+ *
+ * Tenant store protocol definitions
+ * for the Axiom Lattice framework
+ */
+type TenantStatus = 'active' | 'inactive' | 'suspended';
+/**
+ * Tenant type definition
+ */
+interface Tenant {
+    id: string;
+    name: string;
+    description?: string;
+    status: TenantStatus;
+    metadata?: Record<string, any>;
+    createdAt: Date;
+    updatedAt: Date;
+}
+/**
+ * Create tenant request type
+ */
+interface CreateTenantRequest {
+    name: string;
+    description?: string;
+    status?: TenantStatus;
+    metadata?: Record<string, any>;
+}
+/**
+ * Update tenant request type
+ */
+interface UpdateTenantRequest {
+    name?: string;
+    description?: string;
+    status?: TenantStatus;
+    metadata?: Record<string, any>;
+}
+/**
+ * TenantStore interface
+ * Provides CRUD operations for tenant data
+ * Note: Tenant is a top-level entity, so no tenantId parameter is needed
+ */
+interface TenantStore {
+    getAllTenants(): Promise<Tenant[]>;
+    getTenantById(id: string): Promise<Tenant | null>;
+    createTenant(id: string, data: CreateTenantRequest): Promise<Tenant>;
+    updateTenant(id: string, updates: UpdateTenantRequest): Promise<Tenant | null>;
+    deleteTenant(id: string): Promise<boolean>;
+}
+
 /**
  * DatabaseConfigStoreProtocol
  *
@@ -1823,6 +1892,471 @@ interface DatabaseConfigStore {
     hasConfig(tenantId: string, id: string): Promise<boolean>;
 }
 
+/**
+ * MetricsServerConfigStoreProtocol
+ *
+ * Metrics Server configuration store protocol for the Axiom Lattice framework
+ * Provides standardized interfaces for metrics server connection config management
+ */
+/**
+ * Supported metrics server types
+ */
+type MetricsServerType = 'prometheus' | 'grafana' | 'custom' | 'semantic';
+/**
+ * Metrics server connection configuration
+ */
+interface MetricsServerConfig {
+    /** Server type */
+    type: MetricsServerType;
+    /** Server base URL (e.g., http://localhost:9090) */
+    serverUrl: string;
+    /** Optional API key for authentication */
+    apiKey?: string;
+    /** Optional username for basic auth */
+    username?: string;
+    /** Optional password for basic auth */
+    password?: string;
+    /** Optional additional headers */
+    headers?: Record<string, string>;
+    /** Optional timeout in milliseconds (default: 30000) */
+    timeout?: number;
+}
+/**
+ * Metrics server configuration entry stored in the store
+ */
+interface MetricsServerConfigEntry {
+    /**
+     * Unique identifier for the configuration
+     */
+    id: string;
+    /**
+     * Tenant identifier for multi-tenant isolation
+     */
+    tenantId: string;
+    /**
+     * Business key for the configuration (unique within tenant)
+     */
+    key: string;
+    /**
+     * Metrics server connection configuration
+     */
+    config: MetricsServerConfig;
+    /**
+     * Optional friendly name
+     */
+    name?: string;
+    /**
+     * Optional description
+     */
+    description?: string;
+    /**
+     * Creation timestamp
+     */
+    createdAt: Date;
+    /**
+     * Last update timestamp
+     */
+    updatedAt: Date;
+}
+/**
+ * Request to create a new metrics server configuration
+ */
+interface CreateMetricsServerConfigRequest {
+    /**
+     * Business key for the configuration (unique within tenant)
+     */
+    key: string;
+    /**
+     * Metrics server connection configuration
+     */
+    config: MetricsServerConfig;
+    /**
+     * Optional friendly name
+     */
+    name?: string;
+    /**
+     * Optional description
+     */
+    description?: string;
+}
+/**
+ * Request to update an existing metrics server configuration
+ */
+interface UpdateMetricsServerConfigRequest {
+    /**
+     * Business key for the configuration
+     */
+    key?: string;
+    /**
+     * Metrics server connection configuration
+     */
+    config?: MetricsServerConfig;
+    /**
+     * Optional friendly name
+     */
+    name?: string;
+    /**
+     * Optional description
+     */
+    description?: string;
+}
+/**
+ * Metric metadata information
+ */
+interface MetricMeta {
+    /** Metric name */
+    name: string;
+    /** Metric type (gauge, counter, histogram, summary) */
+    type?: string;
+    /** Metric description/help text */
+    description?: string;
+    /** Available label names */
+    labels?: string[];
+    /** Unit of measurement */
+    unit?: string;
+}
+/**
+ * Metric data point
+ */
+interface MetricDataPoint {
+    /** Timestamp */
+    timestamp: number;
+    /** Metric value */
+    value: number;
+    /** Label values */
+    labels?: Record<string, string>;
+}
+/**
+ * Metric query result
+ */
+interface MetricQueryResult {
+    /** Metric name */
+    metricName: string;
+    /** Data points */
+    dataPoints: MetricDataPoint[];
+    /** Query metadata */
+    metadata?: {
+        startTime?: number;
+        endTime?: number;
+        step?: number;
+    };
+}
+/**
+ * Data source information for semantic metrics server
+ */
+interface DataSource {
+    /** Unique identifier for the data source */
+    id: string | number;
+    /** Display name of the data source */
+    name: string;
+    /** JDBC connection URL or similar */
+    url: string;
+    /** Username for connection */
+    username?: string;
+    /** Schema name in the database */
+    schemaName?: string;
+    /** Description of the data source */
+    description?: string;
+    /** Status code */
+    status: number;
+    /** Status label (e.g., "active", "inactive") */
+    statusLabel?: string;
+    /** Whether the data source is currently connected */
+    connected: boolean;
+    /** Creation timestamp */
+    createdAt?: string;
+    /** Last update timestamp */
+    updatedAt?: string;
+}
+/**
+ * Semantic metrics server configuration
+ * Extends base config with semantic-specific properties
+ */
+interface SemanticMetricsServerConfig extends MetricsServerConfig {
+    /** Must be 'semantic' */
+    type: 'semantic';
+    /** IDs of selected data sources */
+    selectedDataSources?: string[];
+}
+/**
+ * Filter definition for semantic metrics query
+ */
+interface SemanticMetricsFilter {
+    /** Dimension/column name to filter on */
+    dimension: string;
+    /** Operator (e.g., "BETWEEN", "=", ">", "<") */
+    operator: string;
+    /** Values for the filter */
+    values: (string | number | boolean)[];
+}
+/**
+ * Request body for semantic metrics query
+ */
+interface SemanticMetricsQueryRequest {
+    /** Data source ID to query */
+    datasourceId: string | number;
+    /** Array of metric names to query */
+    metrics: string[];
+    /** Optional group by dimensions */
+    groupBy?: string[];
+    /** Optional filters */
+    filters?: SemanticMetricsFilter[];
+    /** Optional result limit */
+    limit?: number;
+}
+/**
+ * Single data point in semantic metrics query response
+ */
+interface SemanticMetricDataPoint {
+    /** Timestamp in milliseconds */
+    timestamp?: number;
+    /** Metric value */
+    value: number;
+    /** Metric name */
+    metricName?: string;
+    /** Additional dimension values */
+    labels?: Record<string, string>;
+    /** Group by dimension values */
+    groupByValues?: Record<string, string>;
+}
+/**
+ * AI Hints for a single metric result
+ */
+interface SemanticMetricAiHints {
+    polarity: string;
+    valueInterpretation: string;
+    thresholds?: Array<{
+        metric: string;
+        operator: string;
+        value: number;
+        level: string;
+    }>;
+    suggestedFollowup?: string[];
+}
+/**
+ * Single metric result from semantic metrics query
+ */
+interface SemanticMetricResult {
+    metricName: string;
+    displayName: string;
+    dataType: string;
+    format: string;
+    polarity: string;
+    columns: string[];
+    rows: Array<Record<string, unknown>>;
+    rowCount: number;
+    executionTimeMs: number;
+    aiHints: SemanticMetricAiHints;
+}
+/**
+ * Response from semantic metrics query
+ */
+interface SemanticMetricsQueryResponse {
+    /** Data source ID that was queried */
+    datasourceId: string | number;
+    /** Data source name */
+    datasourceName?: string;
+    /** Query results for each metric */
+    results: SemanticMetricResult[];
+    /** Total execution time in ms */
+    totalExecutionTimeMs?: number;
+}
+/**
+ * Request body for executing custom SQL query
+ */
+interface ExecuteSqlQueryRequest {
+    /** Data source ID to query */
+    datasourceId: string | number;
+    /** Custom SQL query string with named parameters (e.g., :year, :category) */
+    customSql: string;
+    /** Optional parameters for the SQL query */
+    params?: Record<string, string | number | boolean>;
+    /** Optional result limit */
+    limit?: number;
+}
+/**
+ * Response from custom SQL query execution
+ */
+interface ExecuteSqlQueryResponse {
+    /** Data source ID that was queried */
+    datasourceId: string | number;
+    /** Data source name */
+    datasourceName?: string;
+    /** Column names */
+    columns: string[];
+    /** Query result rows */
+    rows: Array<Record<string, unknown>>;
+    /** Total row count */
+    rowCount: number;
+    /** Execution time in milliseconds */
+    executionTimeMs: number;
+    /** The actual executed SQL (for debugging) */
+    executedSql?: string;
+}
+/**
+ * MetricsServerConfigStore interface
+ * Provides CRUD operations for metrics server configuration data
+ */
+interface MetricsServerConfigStore {
+    /**
+     * Get all metrics server configurations for a tenant
+     * @param tenantId - Tenant identifier
+     * @returns Array of all metrics server configurations
+     */
+    getAllConfigs(tenantId: string): Promise<MetricsServerConfigEntry[]>;
+    /**
+     * Get all metrics server configurations across all tenants
+     * @returns Array of all metrics server configurations
+     */
+    getAllConfigsWithoutTenant(): Promise<MetricsServerConfigEntry[]>;
+    /**
+     * Get metrics server configuration by ID
+     * @param tenantId - Tenant identifier
+     * @param id - Configuration identifier
+     * @returns Configuration if found, null otherwise
+     */
+    getConfigById(tenantId: string, id: string): Promise<MetricsServerConfigEntry | null>;
+    /**
+     * Get metrics server configuration by business key
+     * @param tenantId - Tenant identifier
+     * @param key - Business key
+     * @returns Configuration if found, null otherwise
+     */
+    getConfigByKey(tenantId: string, key: string): Promise<MetricsServerConfigEntry | null>;
+    /**
+     * Create a new metrics server configuration
+     * @param tenantId - Tenant identifier
+     * @param id - Configuration identifier
+     * @param data - Configuration creation data
+     * @returns Created configuration
+     */
+    createConfig(tenantId: string, id: string, data: CreateMetricsServerConfigRequest): Promise<MetricsServerConfigEntry>;
+    /**
+     * Update an existing metrics server configuration
+     * @param tenantId - Tenant identifier
+     * @param id - Configuration identifier
+     * @param updates - Partial configuration data to update
+     * @returns Updated configuration if found, null otherwise
+     */
+    updateConfig(tenantId: string, id: string, updates: Partial<UpdateMetricsServerConfigRequest>): Promise<MetricsServerConfigEntry | null>;
+    /**
+     * Delete a metrics server configuration by ID
+     * @param tenantId - Tenant identifier
+     * @param id - Configuration identifier
+     * @returns true if deleted, false otherwise
+     */
+    deleteConfig(tenantId: string, id: string): Promise<boolean>;
+    /**
+     * Check if configuration exists
+     * @param tenantId - Tenant identifier
+     * @param id - Configuration identifier
+     * @returns true if configuration exists, false otherwise
+     */
+    hasConfig(tenantId: string, id: string): Promise<boolean>;
+}
+
+type UserStatus = 'active' | 'pending' | 'suspended';
+interface User {
+    id: string;
+    email: string;
+    name: string;
+    status: UserStatus;
+    metadata?: Record<string, any>;
+    createdAt: Date;
+    updatedAt: Date;
+}
+interface CreateUserRequest {
+    email: string;
+    name: string;
+    status?: UserStatus;
+    metadata?: Record<string, any>;
+}
+interface UpdateUserRequest {
+    email?: string;
+    name?: string;
+    status?: UserStatus;
+    metadata?: Record<string, any>;
+}
+interface UserStore {
+    getAllUsers(): Promise<User[]>;
+    getUserById(id: string): Promise<User | null>;
+    getUserByEmail(email: string): Promise<User | null>;
+    createUser(id: string, data: CreateUserRequest): Promise<User>;
+    updateUser(id: string, updates: UpdateUserRequest): Promise<User | null>;
+    deleteUser(id: string): Promise<boolean>;
+}
+
+/**
+ * UserTenantLinkProtocol
+ *
+ * User-Tenant relationship store protocol
+ * Supports many-to-many relationship between users and tenants
+ */
+/**
+ * User role in tenant
+ */
+type UserTenantRole = 'owner' | 'admin' | 'member';
+/**
+ * User-Tenant link type definition
+ */
+interface UserTenantLink {
+    userId: string;
+    tenantId: string;
+    role: UserTenantRole;
+    joinedAt: Date;
+    metadata?: Record<string, any>;
+}
+/**
+ * Create user-tenant link request
+ */
+interface CreateUserTenantLinkRequest {
+    userId: string;
+    tenantId: string;
+    role?: UserTenantRole;
+    metadata?: Record<string, any>;
+}
+/**
+ * Update user-tenant link request
+ */
+interface UpdateUserTenantLinkRequest {
+    role?: UserTenantRole;
+    metadata?: Record<string, any>;
+}
+/**
+ * UserTenantLinkStore interface
+ * Manages many-to-many relationship between users and tenants
+ */
+interface UserTenantLinkStore {
+    /**
+     * Get all tenants for a user
+     */
+    getTenantsByUser(userId: string): Promise<UserTenantLink[]>;
+    /**
+     * Get all users for a tenant
+     */
+    getUsersByTenant(tenantId: string): Promise<UserTenantLink[]>;
+    /**
+     * Get specific link
+     */
+    getLink(userId: string, tenantId: string): Promise<UserTenantLink | null>;
+    /**
+     * Create link between user and tenant
+     */
+    createLink(data: CreateUserTenantLinkRequest): Promise<UserTenantLink>;
+    /**
+     * Update link
+     */
+    updateLink(userId: string, tenantId: string, updates: UpdateUserTenantLinkRequest): Promise<UserTenantLink | null>;
+    /**
+     * Delete link
+     */
+    deleteLink(userId: string, tenantId: string): Promise<boolean>;
+    /**
+     * Check if user belongs to tenant
+     */
+    hasLink(userId: string, tenantId: string): Promise<boolean>;
+}
+
 /**
  * 通用类型定义
  *
@@ -1886,4 +2420,4 @@ type Timestamp = number;
  */
 type Callback<T = any, R = void> = (data: T) => R | Promise<R>;
 
-export { type AgentClient, type AgentConfig, type AgentConfigWithTools, type AgentLatticeProtocol, type AgentMiddlewareConfig, type AgentRunConfig, AgentType, type Assistant, type AssistantMessage, type AssistantStore, type AvailableModule, type BaseLatticeProtocol, type BaseMessage, type BrowserMiddlewareConfig, type Callback, type CodeEvalMiddlewareConfig, type CreateAssistantRequest, type CreateDatabaseConfigRequest, type CreateProjectRequest, type CreateSkillRequest, type CreateThreadRequest, type CreateWorkspaceRequest, type DatabaseConfig, type DatabaseConfigEntry, type DatabaseConfigStore, type DatabaseType, type DeepAgentConfig, type DeveloperMessage, type EmbeddingsConfig, type EmbeddingsLatticeProtocol, type FilterCondition, type GraphBuildOptions, type ID, type InterruptMessage, type LLMConfig, type LatticeError, type LatticeEventBus, type LatticeMessage, type LoggerClient, type LoggerConfig, type LoggerContext, type LoggerLatticeProtocol, LoggerType, type McpClient, type McpClientOptions, type McpConnectionStatus, type McpLatticeMessage, type McpLatticeProtocol, McpMessageType, type McpServerConfig, type McpStats, type McpTool, type McpToolResult, type McpTransportType, type MemoryClient, type MemoryConfig, type MemoryLatticeProtocol, MemoryType, type Message, type MessageChunk, type MiddlewareType, type ModelLatticeProtocol, type PaginatedResult, type PaginationParams, type PinoFileOptions, type Project, type ProjectStore, type QueryParams, type QueueClient, type QueueConfig, type QueueLatticeProtocol, type QueueResult, QueueType, type ReactAgentConfig, type Result, type SandboxMiddlewareConfig, type ScheduleClient, type ScheduleConfig, type ScheduleCronOptions, ScheduleExecutionType, type ScheduleLatticeProtocol, type ScheduleOnceOptions, type ScheduleStorage, ScheduleType, type ScheduledTaskDefinition, ScheduledTaskStatus, type Skill, type SkillClient, type SkillClientType, type SkillConfig, type SkillLatticeProtocol, type SkillStore, type SqlMiddlewareConfig, type StorageType, type SystemMessage, type TaskHandler, type TeamAgentConfig, type TeamTeammateConfig, type Thread, type ThreadStore, type Timestamp, type ToolCall, type ToolConfig, type ToolExecutor, type ToolLatticeProtocol, type ToolMessage, type UIComponent, UIComponentType, type UIConfig, type UILatticeProtocol, type UpdateDatabaseConfigRequest, type UpdateProjectRequest, type UpdateWorkspaceRequest, type UserMessage, type VectorStoreConfig, type VectorStoreLatticeProtocol, type Workspace, type WorkspaceStore, getSubAgentsFromConfig, getToolsFromConfig, hasTools, isDeepAgentConfig, isTeamAgentConfig };
+export { type AgentClient, type AgentConfig, type AgentConfigWithTools, type AgentLatticeProtocol, type AgentMiddlewareConfig, type AgentRunConfig, AgentType, type Assistant, type AssistantMessage, type AssistantStore, type AvailableModule, type BaseLatticeProtocol, type BaseMessage, type BrowserMiddlewareConfig, type Callback, type CodeEvalMiddlewareConfig, type CreateAssistantRequest, type CreateDatabaseConfigRequest, type CreateMetricsServerConfigRequest, type CreateProjectRequest, type CreateSkillRequest, type CreateTenantRequest, type CreateThreadRequest, type CreateUserRequest, type CreateUserTenantLinkRequest, type CreateWorkspaceRequest, type DataSource, type DatabaseConfig, type DatabaseConfigEntry, type DatabaseConfigStore, type DatabaseType, type DeepAgentConfig, type DeveloperMessage, type EmbeddingsConfig, type EmbeddingsLatticeProtocol, type ExecuteSqlQueryRequest, type ExecuteSqlQueryResponse, type FilterCondition, type GraphBuildOptions, type ID, type InterruptMessage, type LLMConfig, type LatticeError, type LatticeEventBus, type LatticeMessage, type LoggerClient, type LoggerConfig, type LoggerContext, type LoggerLatticeProtocol, LoggerType, type McpClient, type McpClientOptions, type McpConnectionStatus, type McpLatticeMessage, type McpLatticeProtocol, McpMessageType, type McpServerConfig, type McpStats, type McpTool, type McpToolResult, type McpTransportType, type MemoryClient, type MemoryConfig, type MemoryLatticeProtocol, MemoryType, type Message, type MessageChunk, type MetricDataPoint, type MetricMeta, type MetricQueryResult, type MetricsMiddlewareConfig, type MetricsServerConfig, type MetricsServerConfigEntry, type MetricsServerConfigStore, type MetricsServerType, type MiddlewareType, type ModelLatticeProtocol, type PaginatedResult, type PaginationParams, type PinoFileOptions, type Project, type ProjectStore, type QueryParams, type QueueClient, type QueueConfig, type QueueLatticeProtocol, type QueueResult, QueueType, type ReactAgentConfig, type Result, type SandboxMiddlewareConfig, type ScheduleClient, type ScheduleConfig, type ScheduleCronOptions, ScheduleExecutionType, type ScheduleLatticeProtocol, type ScheduleOnceOptions, type ScheduleStorage, ScheduleType, type ScheduledTaskDefinition, ScheduledTaskStatus, type SemanticMetricAiHints, type SemanticMetricDataPoint, type SemanticMetricResult, type SemanticMetricsFilter, type SemanticMetricsQueryRequest, type SemanticMetricsQueryResponse, type SemanticMetricsServerConfig, type Skill, type SkillClient, type SkillClientType, type SkillConfig, type SkillLatticeProtocol, type SkillStore, type SqlMiddlewareConfig, type StorageType, type SystemMessage, type TaskHandler, type TeamAgentConfig, type TeamTeammateConfig, type Tenant, type TenantStatus, type TenantStore, type Thread, type ThreadStore, type Timestamp, type ToolCall, type ToolConfig, type ToolExecutor, type ToolLatticeProtocol, type ToolMessage, type UIComponent, UIComponentType, type UIConfig, type UILatticeProtocol, type UpdateDatabaseConfigRequest, type UpdateMetricsServerConfigRequest, type UpdateProjectRequest, type UpdateTenantRequest, type UpdateUserRequest, type UpdateUserTenantLinkRequest, type UpdateWorkspaceRequest, type User, type UserMessage, type UserStatus, type UserStore, type UserTenantLink, type UserTenantLinkStore, type UserTenantRole, type VectorStoreConfig, type VectorStoreLatticeProtocol, type Workspace, type WorkspaceStore, getSubAgentsFromConfig, getToolsFromConfig, hasTools, isDeepAgentConfig, isTeamAgentConfig };