march-ai-sdk 0.3.0

package/src/types.ts

@@ -0,0 +1,196 @@
+/**
+ * March Agent SDK - Shared Types
+ * Port of Python march_agent types
+ */
+
+import { z } from 'zod'
+
+// ============================================================================
+// Kafka Message Types
+// ============================================================================
+
+export interface KafkaMessage {
+    topic: string
+    partition: number
+    offset: number
+    key: string
+    headers: Record<string, string>
+    body: Record<string, unknown>
+    timestamp: number
+}
+
+export interface KafkaHeaders {
+    conversationId?: string
+    userId?: string
+    from_?: string
+    to_?: string
+    messageMetadata?: string
+    messageSchema?: string
+    attachment?: string
+    [key: string]: string | undefined
+}
+
+// ============================================================================
+// Agent Registration Types
+// ============================================================================
+
+export interface AgentRegistrationData {
+    id: string
+    name: string
+    about: string
+    document: string
+    representationName?: string
+    baseUrl?: string
+    metadata?: Record<string, unknown>
+    relatedPages?: RelatedPage[]
+}
+
+export interface RelatedPage {
+    name: string
+    endpoint: string
+}
+
+export interface RegisterOptions {
+    name: string
+    about: string
+    document: string
+    representationName?: string
+    baseUrl?: string
+    metadata?: Record<string, unknown>
+    relatedPages?: RelatedPage[]
+}
+
+// ============================================================================
+// Message Types
+// ============================================================================
+
+// Forward reference - actual Message class is imported where needed
+// Using 'any' here to avoid circular dependency, but consumers should use Message type
+export interface MessageHandler {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    (message: any, sender: string): void | Promise<void>
+}
+
+export interface SenderFilterOptions {
+    senders?: string[]
+}
+
+// ============================================================================
+// Streamer Types
+// ============================================================================
+
+export interface StreamOptions {
+    persist?: boolean
+    eventType?: string
+}
+
+export interface StreamerOptions {
+    awaiting?: boolean
+    sendTo?: string
+}
+
+// ============================================================================
+// Attachment Types
+// ============================================================================
+
+export const AttachmentInfoSchema = z.object({
+    url: z.string(),
+    filename: z.string(),
+    contentType: z.string(),
+    size: z.number().optional(),
+    fileType: z.string().optional(),
+})
+
+export type AttachmentInfo = z.infer<typeof AttachmentInfoSchema>
+
+export function isImageAttachment(attachment: AttachmentInfo): boolean {
+    return attachment.contentType?.startsWith('image/') || false
+}
+
+export function isPdfAttachment(attachment: AttachmentInfo): boolean {
+    return attachment.contentType === 'application/pdf'
+}
+
+// ============================================================================
+// Conversation Message Types
+// ============================================================================
+
+export interface ConversationMessageData {
+    id: string
+    conversationId: string
+    role: 'user' | 'assistant' | 'system'
+    content: string
+    from?: string
+    to?: string
+    createdAt: string
+    metadata?: Record<string, unknown>
+}
+
+// ============================================================================
+// Gateway Client Types
+// ============================================================================
+
+export interface ProduceAck {
+    topic: string
+    partition: number
+    offset: number
+    correlationId?: string
+}
+
+// ============================================================================
+// App Configuration Types
+// ============================================================================
+
+export interface AppOptions {
+    gatewayUrl: string
+    apiKey: string
+    heartbeatInterval?: number
+    maxConcurrentTasks?: number
+    errorMessageTemplate?: string
+    secure?: boolean
+}
+
+// ============================================================================
+// HTTP Response Types
+// ============================================================================
+
+export interface ConversationData {
+    id: string
+    userId: string
+    agentId?: string
+    awaitingRoute?: string
+    pendingResponseSchema?: Record<string, unknown>
+    createdAt: string
+    updatedAt: string
+    metadata?: Record<string, unknown>
+}
+
+export interface GetMessagesOptions {
+    role?: string
+    from?: string
+    to?: string
+    limit?: number
+    offset?: number
+}
+
+// ============================================================================
+// Memory Types
+// ============================================================================
+
+export interface MemoryMessage {
+    role: 'user' | 'assistant'
+    content: string
+    timestamp?: string
+}
+
+export interface MemorySearchResult {
+    content: string
+    similarity: number
+    metadata?: Record<string, unknown>
+}
+
+export interface UserSummary {
+    userId: string
+    summary: string
+    updatedAt: string
+}