@agentxjs/core 1.9.5-dev → 1.9.7-dev

package/dist/base-m40r3Qgu.d.ts

@@ -0,0 +1,157 @@
+/**
+ * Base Event Types - SystemEvent, EventSource, EventIntent, EventCategory, EventContext
+ *
+ * Foundation types for the event system.
+ */
+/**
+ * BusEvent - Base event type for EventBus
+ *
+ * All events flowing through the EventBus must conform to this structure.
+ * This is a minimal event type that can be extended for specific use cases.
+ *
+ * @deprecated Use SystemEvent instead for full event system support
+ */
+interface BusEvent<T extends string = string, D = unknown> {
+    /**
+     * Event type identifier (e.g., "text_delta", "assistant_message")
+     */
+    readonly type: T;
+    /**
+     * Event timestamp (Unix milliseconds)
+     */
+    readonly timestamp: number;
+    /**
+     * Event payload data
+     */
+    readonly data: D;
+    /**
+     * Event source (optional, for routing/filtering)
+     */
+    readonly source?: string;
+    /**
+     * Event category (optional, for classification)
+     */
+    readonly category?: string;
+    /**
+     * Event intent (optional, for command pattern)
+     */
+    readonly intent?: string;
+}
+/**
+ * Event source - where the event originated
+ */
+type EventSource = "driver" | "agent" | "session" | "container" | "sandbox" | "command";
+/**
+ * Event intent - what the event represents
+ */
+type EventIntent = "request" | "result" | "notification";
+/**
+ * Event category - fine-grained classification within source
+ */
+type EventCategory = "stream" | "connection" | "state" | "message" | "turn" | "error" | "lifecycle" | "persist" | "action" | "workdir" | "mcp" | "request" | "response";
+/**
+ * EventContext - Scope information attached to events
+ */
+interface EventContext {
+    /**
+     * Container ID (isolation boundary)
+     */
+    containerId?: string;
+    /**
+     * Image ID (persistent conversation identity)
+     */
+    imageId?: string;
+    /**
+     * Agent ID (if event is agent-scoped)
+     */
+    agentId?: string;
+    /**
+     * Session ID (if event is session-scoped)
+     */
+    sessionId?: string;
+    /**
+     * Turn ID (for correlating events within a single turn)
+     * A turn = one user message + assistant response cycle
+     */
+    turnId?: string;
+    /**
+     * Correlation ID (for request-response tracking)
+     */
+    correlationId?: string;
+}
+/**
+ * SystemEvent - Base interface for ALL events in the system
+ *
+ * Every event has:
+ * - type: What happened (e.g., "text_delta", "session_saved")
+ * - timestamp: When it happened
+ * - data: Event payload
+ * - source: Where it came from
+ * - category: What kind of event
+ * - intent: What it means (notification/request/result)
+ * - context: Optional scope information
+ * - broadcastable: Whether to broadcast to external clients (default: true)
+ */
+interface SystemEvent<T extends string = string, D = unknown, S extends EventSource = EventSource, C extends EventCategory = EventCategory, I extends EventIntent = EventIntent> {
+    /**
+     * Event type identifier (e.g., "text_delta", "session_saved")
+     */
+    readonly type: T;
+    /**
+     * Event timestamp (Unix milliseconds)
+     */
+    readonly timestamp: number;
+    /**
+     * Event payload data
+     */
+    readonly data: D;
+    /**
+     * Event source - where the event originated
+     */
+    readonly source: S;
+    /**
+     * Event category - fine-grained classification
+     */
+    readonly category: C;
+    /**
+     * Event intent - what the event represents
+     */
+    readonly intent: I;
+    /**
+     * Event context - scope information (optional)
+     */
+    readonly context?: EventContext;
+    /**
+     * Whether to broadcast this event to external clients (SSE/WebSocket)
+     *
+     * - true or undefined: Broadcast to all external clients
+     * - false: Only consumed internally, not broadcast
+     *
+     * Used for internal events like DriveableEvent that should be
+     * processed by the engine but not sent directly to clients.
+     * @default true
+     */
+    readonly broadcastable?: boolean;
+}
+/**
+ * Check if event is from a specific source
+ */
+declare function isFromSource<S extends EventSource>(event: SystemEvent, source: S): event is SystemEvent<string, unknown, S>;
+/**
+ * Check if event has a specific intent
+ */
+declare function hasIntent<I extends EventIntent>(event: SystemEvent, intent: I): event is SystemEvent<string, unknown, EventSource, EventCategory, I>;
+/**
+ * Check if event is a request
+ */
+declare function isRequest(event: SystemEvent): boolean;
+/**
+ * Check if event is a result
+ */
+declare function isResult(event: SystemEvent): boolean;
+/**
+ * Check if event is a notification
+ */
+declare function isNotification(event: SystemEvent): boolean;
+
+export { type BusEvent as B, type EventSource as E, type SystemEvent as S, type EventIntent as a, type EventCategory as b, type EventContext as c, isRequest as d, isResult as e, isNotification as f, hasIntent as h, isFromSource as i };