@deimoscloud/coreai 0.1.0

package/src/knowledge-library/types.ts

@@ -0,0 +1,432 @@
+/**
+ * KnowledgeLibrary Types
+ *
+ * Type definitions for local agent state management.
+ */
+
+/**
+ * Message type for inbox/outbox messages
+ */
+export type MessageType =
+  | 'task-assignment'
+  | 'completion-report'
+  | 'review-request'
+  | 'feedback'
+  | 'status-update'
+  | 'question'
+  | 'response';
+
+/**
+ * Priority levels for messages
+ */
+export type MessagePriority = 'P0' | 'P1' | 'P2' | 'P3';
+
+/**
+ * Message metadata from frontmatter
+ */
+export interface MessageMetadata {
+  /**
+   * Message type
+   */
+  type: MessageType;
+
+  /**
+   * Sender agent name
+   */
+  from: string;
+
+  /**
+   * Recipient agent name
+   */
+  to: string;
+
+  /**
+   * Timestamp of the message
+   */
+  date: Date;
+
+  /**
+   * Associated ticket key (optional)
+   */
+  ticket?: string;
+
+  /**
+   * Message priority (optional)
+   */
+  priority?: MessagePriority;
+
+  /**
+   * Message subject
+   */
+  subject?: string;
+}
+
+/**
+ * An inbox/outbox message
+ */
+export interface Message {
+  /**
+   * Message filename
+   */
+  filename: string;
+
+  /**
+   * Full file path
+   */
+  path: string;
+
+  /**
+   * Message metadata from frontmatter
+   */
+  metadata: MessageMetadata;
+
+  /**
+   * Raw message content (including frontmatter)
+   */
+  rawContent: string;
+
+  /**
+   * Message body (excluding frontmatter)
+   */
+  body: string;
+}
+
+/**
+ * Agent context state
+ */
+export interface AgentContext {
+  /**
+   * Current task or assignment
+   */
+  currentTask?: string;
+
+  /**
+   * Current ticket being worked on
+   */
+  currentTicket?: string;
+
+  /**
+   * Current state/status
+   */
+  status?: string;
+
+  /**
+   * Last updated timestamp
+   */
+  lastUpdated: Date;
+
+  /**
+   * Additional context notes
+   */
+  notes?: string;
+}
+
+/**
+ * Agent objective entry
+ */
+export interface Objective {
+  /**
+   * Objective description
+   */
+  description: string;
+
+  /**
+   * Success criteria
+   */
+  successCriteria?: string[];
+
+  /**
+   * Deadline (optional)
+   */
+  deadline?: Date;
+
+  /**
+   * Priority
+   */
+  priority?: MessagePriority;
+
+  /**
+   * Status
+   */
+  status: 'pending' | 'in_progress' | 'completed' | 'blocked';
+}
+
+/**
+ * Decision log entry
+ */
+export interface Decision {
+  /**
+   * Decision timestamp
+   */
+  date: Date;
+
+  /**
+   * What was decided
+   */
+  decision: string;
+
+  /**
+   * Context/reasoning
+   */
+  reasoning?: string;
+
+  /**
+   * Related ticket or task
+   */
+  relatedTo?: string;
+}
+
+/**
+ * Dependency tracking entry
+ */
+export interface Dependency {
+  /**
+   * What this agent/task depends on
+   */
+  blockedBy?: string[];
+
+  /**
+   * What depends on this agent/task
+   */
+  blocking?: string[];
+
+  /**
+   * Last updated
+   */
+  lastUpdated: Date;
+}
+
+/**
+ * Agent control state (objectives, decisions, dependencies)
+ */
+export interface AgentControl {
+  objectives: Objective[];
+  decisions: Decision[];
+  dependencies: Dependency;
+}
+
+/**
+ * Directory paths within an agent's KnowledgeLibrary
+ */
+export interface AgentDirectories {
+  /**
+   * Root directory for this agent
+   */
+  root: string;
+
+  /**
+   * Inbox for incoming messages
+   */
+  inbox: string;
+
+  /**
+   * Processed messages archive
+   */
+  inboxProcessed: string;
+
+  /**
+   * Outbox for sent messages
+   */
+  outbox: string;
+
+  /**
+   * Context directory
+   */
+  context: string;
+
+  /**
+   * Control directory (objectives, decisions, dependencies)
+   */
+  control: string;
+
+  /**
+   * Historical records
+   */
+  history: string;
+
+  /**
+   * Technical notes and research
+   */
+  tech: string;
+}
+
+/**
+ * Full KnowledgeLibrary state for an agent
+ */
+export interface AgentKnowledgeState {
+  /**
+   * Agent name/identifier
+   */
+  agentName: string;
+
+  /**
+   * Directory paths
+   */
+  directories: AgentDirectories;
+
+  /**
+   * Current context
+   */
+  context?: AgentContext;
+
+  /**
+   * Control state
+   */
+  control?: AgentControl;
+
+  /**
+   * Unprocessed inbox messages
+   */
+  pendingMessages: Message[];
+
+  /**
+   * Initialization status
+   */
+  initialized: boolean;
+}
+
+/**
+ * Options for initializing KnowledgeLibrary
+ */
+export interface InitKnowledgeLibraryOptions {
+  /**
+   * Project root directory
+   */
+  projectRoot?: string;
+
+  /**
+   * Base directory for KnowledgeLibrary
+   * Default: KnowledgeLibrary
+   */
+  basePath?: string;
+
+  /**
+   * Whether to create default files
+   */
+  createDefaults?: boolean;
+}
+
+/**
+ * Result of KnowledgeLibrary initialization
+ */
+export interface InitKnowledgeLibraryResult {
+  /**
+   * Whether initialization was successful
+   */
+  success: boolean;
+
+  /**
+   * Created directories
+   */
+  createdDirs: string[];
+
+  /**
+   * Created files
+   */
+  createdFiles: string[];
+
+  /**
+   * Error message if failed
+   */
+  error?: string;
+}
+
+/**
+ * Options for reading messages
+ */
+export interface ReadMessagesOptions {
+  /**
+   * Filter by message type
+   */
+  type?: MessageType;
+
+  /**
+   * Filter by sender
+   */
+  from?: string;
+
+  /**
+   * Filter by priority
+   */
+  priority?: MessagePriority;
+
+  /**
+   * Include processed messages
+   */
+  includeProcessed?: boolean;
+
+  /**
+   * Maximum number of messages to return
+   */
+  limit?: number;
+}
+
+/**
+ * Options for writing a message
+ */
+export interface WriteMessageOptions {
+  /**
+   * Message type
+   */
+  type: MessageType;
+
+  /**
+   * Sender agent
+   */
+  from: string;
+
+  /**
+   * Recipient agent
+   */
+  to: string;
+
+  /**
+   * Message subject
+   */
+  subject: string;
+
+  /**
+   * Message body content
+   */
+  body: string;
+
+  /**
+   * Associated ticket key
+   */
+  ticket?: string;
+
+  /**
+   * Message priority
+   */
+  priority?: MessagePriority;
+}
+
+/**
+ * Global KnowledgeLibrary state
+ */
+export interface KnowledgeLibraryState {
+  /**
+   * Base path for KnowledgeLibrary
+   */
+  basePath: string;
+
+  /**
+   * Global context file path
+   */
+  contextPath: string;
+
+  /**
+   * Architecture notes file path
+   */
+  architecturePath: string;
+
+  /**
+   * PRD file path
+   */
+  prdPath: string;
+
+  /**
+   * List of initialized agents
+   */
+  agents: string[];
+}