@axiom-lattice/protocols 1.0.1

package/.turbo/turbo-build.log

@@ -0,0 +1,20 @@
+
+> @axiom-lattice/protocols@1.0.0 build /home/runner/work/agentic/agentic/packages/protocols
+> tsup src/index.ts --format cjs,esm --dts --sourcemap
+
+CLI Building entry: src/index.ts
+CLI Using tsconfig: tsconfig.json
+CLI tsup v8.5.0
+CLI Target: es2020
+CJS Build start
+ESM Build start
+CJS dist/index.js     2.67 KB
+CJS dist/index.js.map 6.47 KB
+CJS ⚡️ Build success in 41ms
+ESM dist/index.mjs     1.56 KB
+ESM dist/index.mjs.map 5.96 KB
+ESM ⚡️ Build success in 42ms
+DTS Build start
+DTS ⚡️ Build success in 2317ms
+DTS dist/index.d.ts  10.35 KB
+DTS dist/index.d.mts 10.35 KB

package/README.md

@@ -0,0 +1,68 @@
+# @axiom-lattice/protocols
+
+Unified protocol type definitions for the Axiom Lattice framework.
+
+## Overview
+
+This package provides a collection of standardized protocol interfaces for the Axiom Lattice framework. These protocols define the contract between different components of the system, ensuring consistent behavior and interoperability.
+
+## Protocols
+
+- `BaseLatticeProtocol`: Base protocol for all lattice types
+- `ModelLatticeProtocol`: Protocol for LLM model integration
+- `ToolLatticeProtocol`: Protocol for tool execution
+- `AgentLatticeProtocol`: Protocol for agent behavior
+- `MemoryLatticeProtocol`: Protocol for memory management
+- `StorageLatticeProtocol`: Protocol for data storage
+- `UILatticeProtocol`: Protocol for UI components
+- `MessageProtocol`: Protocol for standardized message communication
+
+## Usage
+
+```typescript
+import {
+  ModelLatticeProtocol,
+  ToolLatticeProtocol,
+  MessageProtocol,
+  Message,
+  UserMessage,
+  AssistantMessage,
+} from "@axiom-lattice/protocols";
+
+// Implement a model lattice
+class MyModelLattice implements ModelLatticeProtocol {
+  // Implementation details...
+}
+
+// Implement a tool lattice
+class MyToolLattice implements ToolLatticeProtocol {
+  // Implementation details...
+}
+
+// Use message protocol for communication
+class MyMessageHandler implements MessageProtocol {
+  // Implementation details...
+
+  // Example of creating a conversation
+  createConversation() {
+    const messages: Message[] = [
+      {
+        id: "user_1",
+        role: "user",
+        content: "Hello, can you help me?",
+      },
+      {
+        id: "asst_1",
+        role: "assistant",
+        content: "Of course! What can I help you with today?",
+      },
+    ];
+
+    return messages;
+  }
+}
+```
+
+## License
+
+MIT

package/dist/index.d.mts

@@ -0,0 +1,468 @@
+import { StructuredTool } from '@langchain/core/tools';
+import { ZodSchema } from 'zod';
+import { BaseChatModel } from '@langchain/core/language_models/chat_models';
+import { BaseMessage as BaseMessage$1 } from '@langchain/core/messages';
+import { ChatResult } from '@langchain/core/outputs';
+import { CompiledStateGraph } from '@langchain/langgraph';
+
+/**
+ * BaseLatticeProtocol
+ *
+ * 所有Lattice类型的基础协议，定义了通用接口和行为
+ */
+/**
+ * 基础Lattice协议接口
+ * @template TConfig 配置类型
+ * @template TClient 客户端类型
+ */
+interface BaseLatticeProtocol<TConfig = any, TClient = any> {
+    key: string;
+    config: TConfig;
+    client: TClient;
+}
+/**
+ * Lattice消息接口
+ */
+interface LatticeMessage {
+    type: string;
+    source: string;
+    target?: string;
+    payload: any;
+    timestamp: number;
+    metadata?: Record<string, any>;
+}
+/**
+ * Lattice错误接口
+ */
+interface LatticeError {
+    code: string;
+    message: string;
+    source: string;
+    stack?: string;
+    metadata?: Record<string, any>;
+}
+/**
+ * Lattice事件总线接口
+ */
+interface LatticeEventBus {
+    subscribe: (eventType: string, handler: (message: LatticeMessage) => void) => void;
+    unsubscribe: (eventType: string, handler: (message: LatticeMessage) => void) => void;
+    publish: (eventType: string, message: LatticeMessage) => void;
+}
+
+/**
+ * ToolLatticeProtocol
+ *
+ * 工具Lattice的协议，用于定义可执行的功能单元
+ */
+
+/**
+ * 工具配置接口
+ */
+interface ToolConfig {
+    name: string;
+    description: string;
+    schema?: ZodSchema<any>;
+    returnDirect?: boolean;
+    needUserApprove?: boolean;
+}
+/**
+ * 工具执行函数类型
+ */
+type ToolExecutor<TInput = any, TOutput = any> = (input: TInput, config?: any) => Promise<TOutput>;
+/**
+ * 工具Lattice协议接口
+ */
+interface ToolLatticeProtocol extends BaseLatticeProtocol<ToolConfig, StructuredTool> {
+    execute: ToolExecutor;
+    validate: (input: any) => boolean;
+}
+
+/**
+ * ModelLatticeProtocol
+ *
+ * 模型Lattice的协议，用于封装各种LLM模型的统一接口
+ */
+
+/**
+ * LLM配置接口
+ */
+interface LLMConfig {
+    provider: "azure" | "openai" | "deepseek" | "siliconcloud" | "volcengine";
+    model: string;
+    maxTokens?: number;
+    temperature?: number;
+    timeout?: number;
+    maxRetries?: number;
+    streaming?: boolean;
+    apiKeyEnvName?: string;
+    baseURL?: string;
+}
+/**
+ * 模型Lattice协议接口
+ */
+interface ModelLatticeProtocol extends BaseLatticeProtocol<LLMConfig, BaseChatModel> {
+    generate: (messages: BaseMessage$1[], options?: any) => Promise<ChatResult>;
+    invokeWithStructuredOutput: <T>(input: any, schema: ZodSchema<T>, options?: any) => Promise<T>;
+    bindTools: (tools: any[], options?: any) => any;
+}
+
+/**
+ * AgentLatticeProtocol
+ *
+ * 智能体Lattice的协议，定义了智能体的行为和组合方式
+ */
+
+/**
+ * 智能体类型枚举
+ */
+declare enum AgentType {
+    REACT = "react",
+    DEEP_AGENT = "deep_agent",
+    PLAN_EXECUTE = "plan_execute",
+    SEQUENTIAL = "sequential"
+}
+/**
+ * 智能体配置接口
+ */
+interface AgentConfig {
+    key: string;
+    name: string;
+    description: string;
+    type: AgentType;
+    tools?: string[];
+    subAgents?: string[];
+    prompt: string;
+    schema?: ZodSchema<any>;
+    modelKey?: string;
+}
+/**
+ * 智能体客户端类型
+ */
+type AgentClient = CompiledStateGraph<any, any, any, any, any>;
+/**
+ * Graph构建选项
+ */
+interface GraphBuildOptions {
+    overrideTools?: string[];
+    overrideModel?: string;
+    metadata?: Record<string, any>;
+}
+/**
+ * 智能体Lattice协议接口
+ */
+interface AgentLatticeProtocol extends BaseLatticeProtocol<AgentConfig, AgentClient> {
+    invoke: (input: any, options?: any) => Promise<any>;
+    buildGraph: (options?: GraphBuildOptions) => Promise<AgentClient>;
+}
+
+/**
+ * MemoryLatticeProtocol
+ *
+ * 记忆Lattice的协议，用于管理智能体的上下文和记忆
+ */
+
+/**
+ * 记忆类型枚举
+ */
+declare enum MemoryType {
+    SHORT_TERM = "short_term",
+    LONG_TERM = "long_term",
+    EPISODIC = "episodic",
+    SEMANTIC = "semantic",
+    WORKING = "working"
+}
+/**
+ * 记忆配置接口
+ */
+interface MemoryConfig {
+    name: string;
+    description: string;
+    type: MemoryType;
+    ttl?: number;
+    capacity?: number;
+}
+/**
+ * 记忆客户端接口
+ */
+interface MemoryClient {
+    add: (key: string, value: any) => Promise<void>;
+    get: (key: string) => Promise<any>;
+    update: (key: string, value: any) => Promise<void>;
+    delete: (key: string) => Promise<void>;
+    search: (query: string, options?: any) => Promise<any[]>;
+    clear: () => Promise<void>;
+}
+/**
+ * 记忆Lattice协议接口
+ */
+interface MemoryLatticeProtocol extends BaseLatticeProtocol<MemoryConfig, MemoryClient> {
+    add: (key: string, value: any) => Promise<void>;
+    get: (key: string) => Promise<any>;
+    update: (key: string, value: any) => Promise<void>;
+    delete: (key: string) => Promise<void>;
+    search: (query: string, options?: any) => Promise<any[]>;
+    clear: () => Promise<void>;
+}
+
+/**
+ * StorageLatticeProtocol
+ *
+ * 存储Lattice的协议，用于数据持久化和状态管理
+ */
+
+/**
+ * 存储类型枚举
+ */
+declare enum StorageType {
+    MEMORY = "memory",
+    LOCAL = "local",
+    DATABASE = "database",
+    CLOUD = "cloud",
+    DISTRIBUTED = "distributed"
+}
+/**
+ * 存储配置接口
+ */
+interface StorageConfig {
+    name: string;
+    description: string;
+    type: StorageType;
+    connectionString?: string;
+    options?: Record<string, any>;
+}
+/**
+ * 存储客户端接口
+ */
+interface StorageClient {
+    set: (key: string, value: any) => Promise<void>;
+    get: (key: string) => Promise<any>;
+    has: (key: string) => Promise<boolean>;
+    delete: (key: string) => Promise<boolean>;
+    clear: () => Promise<void>;
+    transaction: <T>(operations: () => Promise<T>) => Promise<T>;
+}
+/**
+ * 存储Lattice协议接口
+ */
+interface StorageLatticeProtocol extends BaseLatticeProtocol<StorageConfig, StorageClient> {
+    set: (key: string, value: any) => Promise<void>;
+    get: (key: string) => Promise<any>;
+    has: (key: string) => Promise<boolean>;
+    delete: (key: string) => Promise<boolean>;
+    clear: () => Promise<void>;
+    transaction: <T>(operations: () => Promise<T>) => Promise<T>;
+}
+
+/**
+ * UILatticeProtocol
+ *
+ * UI Lattice的协议，用于定义用户界面组件
+ */
+
+/**
+ * UI组件类型枚举
+ */
+declare enum UIComponentType {
+    CONTAINER = "container",
+    INPUT = "input",
+    BUTTON = "button",
+    LIST = "list",
+    TABLE = "table",
+    CHART = "chart",
+    FORM = "form",
+    CARD = "card",
+    MODAL = "modal",
+    CUSTOM = "custom"
+}
+/**
+ * UI配置接口
+ */
+interface UIConfig {
+    name: string;
+    description: string;
+    type: UIComponentType;
+    props?: Record<string, any>;
+    children?: string[];
+}
+/**
+ * UI组件接口
+ * 使用泛型以适应不同的UI框架(React, Vue等)
+ */
+interface UIComponent<T = any> {
+    render: (props?: any) => T;
+    addEventListener: (event: string, handler: Function) => void;
+    removeEventListener: (event: string, handler: Function) => void;
+}
+/**
+ * UI Lattice协议接口
+ */
+interface UILatticeProtocol<T = any> extends BaseLatticeProtocol<UIConfig, UIComponent<T>> {
+    render: (props?: any) => T;
+    addEventListener: (event: string, handler: Function) => void;
+    removeEventListener: (event: string, handler: Function) => void;
+}
+
+/**
+ * MessageProtocol
+ *
+ */
+/**
+ * Base message interface
+ */
+interface BaseMessage {
+    id: string;
+    role: string;
+    content?: string;
+    name?: string;
+}
+/**
+ * User message interface
+ */
+interface UserMessage extends BaseMessage {
+    role: "human";
+    content: string;
+    files?: Array<{
+        name: string;
+        id: string;
+    }>;
+}
+/**
+ * Tool call interface
+ */
+interface ToolCall {
+    id: string;
+    name: string;
+    args: Record<string, any>;
+    type: "tool_call";
+    response?: string;
+}
+/**
+ * Assistant message interface
+ */
+interface AssistantMessage extends BaseMessage {
+    role: "ai";
+    content?: string;
+    tool_calls?: ToolCall[];
+}
+/**
+ * System message interface
+ */
+interface SystemMessage extends BaseMessage {
+    role: "system";
+    content: string;
+}
+/**
+ * Tool message interface
+ */
+interface ToolMessage extends BaseMessage {
+    role: "tool";
+    content: string;
+    tool_call_id: string;
+}
+/**
+ * Developer message interface
+ */
+interface DeveloperMessage extends BaseMessage {
+    role: "developer";
+    content: string;
+}
+interface MessageChunk {
+    type: string;
+    data: {
+        id: string;
+        content?: string;
+        tool_call_chunks?: Array<{
+            name?: string;
+            args?: string;
+            id?: string;
+            index: number;
+        }>;
+        tool_calls?: Array<{
+            name: string;
+            args: Record<string, any>;
+            id: string;
+            type: string;
+            response?: string;
+        }>;
+        additional_kwargs?: {
+            tool_calls?: Array<{
+                function?: {
+                    name?: string;
+                    arguments?: any;
+                };
+                id?: string;
+            }>;
+        };
+        tool_call_id?: string;
+    };
+}
+/**
+ * Message type union
+ */
+type Message = UserMessage | AssistantMessage | SystemMessage | ToolMessage | DeveloperMessage;
+
+/**
+ * 通用类型定义
+ *
+ * 提供跨Lattice使用的通用类型
+ */
+/**
+ * 通用结果接口
+ */
+interface Result<T = any> {
+    success: boolean;
+    data?: T;
+    error?: string;
+    metadata?: Record<string, any>;
+}
+/**
+ * 分页请求参数
+ */
+interface PaginationParams {
+    page?: number;
+    pageSize?: number;
+    sortBy?: string;
+    sortOrder?: "asc" | "desc";
+}
+/**
+ * 分页响应结果
+ */
+interface PaginatedResult<T = any> {
+    items: T[];
+    total: number;
+    page: number;
+    pageSize: number;
+    totalPages: number;
+}
+/**
+ * 过滤条件
+ */
+interface FilterCondition {
+    field: string;
+    operator: "eq" | "neq" | "gt" | "gte" | "lt" | "lte" | "in" | "nin" | "contains" | "startsWith" | "endsWith";
+    value: any;
+}
+/**
+ * 查询参数
+ */
+interface QueryParams {
+    pagination?: PaginationParams;
+    filters?: FilterCondition[];
+    search?: string;
+    includes?: string[];
+}
+/**
+ * 通用ID类型
+ */
+type ID = string | number;
+/**
+ * 时间戳类型
+ */
+type Timestamp = number;
+/**
+ * 通用回调函数类型
+ */
+type Callback<T = any, R = void> = (data: T) => R | Promise<R>;
+
+export { type AgentClient, type AgentConfig, type AgentLatticeProtocol, AgentType, type AssistantMessage, type BaseLatticeProtocol, type BaseMessage, type Callback, type DeveloperMessage, type FilterCondition, type GraphBuildOptions, type ID, type LLMConfig, type LatticeError, type LatticeEventBus, type LatticeMessage, type MemoryClient, type MemoryConfig, type MemoryLatticeProtocol, MemoryType, type Message, type MessageChunk, type ModelLatticeProtocol, type PaginatedResult, type PaginationParams, type QueryParams, type Result, type StorageClient, type StorageConfig, type StorageLatticeProtocol, StorageType, type SystemMessage, type Timestamp, type ToolCall, type ToolConfig, type ToolExecutor, type ToolLatticeProtocol, type ToolMessage, type UIComponent, UIComponentType, type UIConfig, type UILatticeProtocol, type UserMessage };