Skip to main content

TypeScript Interfaces

This document provides comprehensive documentation for all TypeScript interfaces, types, and enums used in KiraPilot.

Generated on: 2025-08-24T14:14:12.207Z

Table of Contents​

Enums​

Priority​

enum Priority {
  LOW = 0,
  MEDIUM = 1,
  HIGH = 2,
  URGENT = 3,
}

TaskStatus​

enum TaskStatus {
  PENDING = 'pending',
  IN_PROGRESS = 'in_progress',
  COMPLETED = 'completed',
  CANCELLED = 'cancelled',
}

FocusLevel​

enum FocusLevel {
  LOW = 'low',
  MEDIUM = 'medium',
  HIGH = 'high',
  DEEP = 'deep',
}

DistractionLevel​

enum DistractionLevel {
  NONE = 'none',
  MINIMAL = 'minimal',
  MODERATE = 'moderate',
  FULL = 'full',
}

TimePreset​

enum TimePreset {
  FIFTEEN_MIN = 15,
  THIRTY_MIN = 30,
  SIXTY_MIN = 60,
  CUSTOM = -1,
  NOT_APPLICABLE = 0,
}

Core Interfaces​

TrendData​

interface TrendData {
  timestamp: Date;
  value: number;
  type: 'energy' | 'focus' | 'productivity' | 'tasks_completed';
}

TimeSlot​

interface TimeSlot {
  start: string;
  end: string;
  dayOfWeek: number;
}

WeeklyPlan​

interface WeeklyPlan {
  id: string;
  weekStart: Date;
  tasks: PlannedTask[];
  goals: WeeklyGoal[];
  totalPlannedHours: number;
  actualHours: number;
  completionRate: number;
  createdAt: Date;
  updatedAt: Date;
}

WeeklyGoal​

interface WeeklyGoal {
  id: string;
  title: string;
  description: string;
  targetValue: number;
  currentValue: number;
  unit: string;
  completed: boolean;
}

AppContext​

interface AppContext {
  currentTask?: Task;
  activeSession?: TimerSession;
  activeFocusSession?: FocusSession;
  focusMode: boolean;
  timeOfDay: string;
  dayOfWeek: number;
  currentEnergy: number;
  recentActivity: ActivityEvent[];
  weeklyPlan?: WeeklyPlan;
  preferences: UserPreferences;
}

ActivityEvent​

interface ActivityEvent {
  id: string;
  type:
    | 'task_created'
    | 'task_completed'
    | 'timer_started'
    | 'timer_stopped'
    | 'focus_started'
    | 'focus_ended';
  timestamp: Date;
  data: Record<string, unknown>;
}

UserPreferences​

interface UserPreferences {
  workingHours: {
    start: string; // HH:MM
    end: string; // HH:MM
  };
  breakPreferences: {
    shortBreakDuration: number; // minutes
    longBreakDuration: number; // minutes
    breakInterval: number; // minutes
  };
  focusPreferences: {
    defaultDuration: number; // minutes
    distractionLevel: DistractionLevel;
    backgroundAudio: AudioConfig;
  };
  notifications: {
    breakReminders: boolean;
    taskDeadlines: boolean;
    dailySummary: boolean;
    weeklyReview: boolean;
  };
  aiSettings: {
    conversationHistory: boolean;
    autoSuggestions: boolean;
    toolPermissions: boolean;
    responseStyle: 'concise' | 'balanced' | 'detailed';
    suggestionFrequency: 'minimal' | 'moderate' | 'frequent';
    modelType?: 'local' | 'gemini';
    geminiApiKey?: string;
    localModelConfig?: {
      threads?: number;
      contextSize?: number;
      temperature?: number;
      maxTokens?: number;
    };
    logging?: {
      enabled: boolean;
      logLevel: 'minimal' | 'standard' | 'detailed';
      retentionDays: number;
      maxLogSize: number;
      includeSystemPrompts: boolean;
      includeToolExecutions: boolean;
      includePerformanceMetrics: boolean;
      autoCleanup: boolean;
      exportFormat: 'json' | 'csv';
    };
  };
  taskSettings: {
    defaultPriority: Priority;
    autoScheduling: boolean;
    smartDependencies: boolean;
    weekStartDay: 0 | 1; // 0 = Sunday, 1 = Monday
    showCompletedTasks: boolean;
    compactView: boolean;
  };
  dateFormat: 'DD/MM/YYYY' | 'MM/DD/YYYY' | 'YYYY-MM-DD';
  theme: 'light' | 'dark' | 'auto';
  language: string;
}

ValidationResult​

interface ValidationResult {
  isValid: boolean;
  errors: string[];
  warnings: string[];
}

Task Management​

Task​

interface Task {
  id: string;
  title: string;
  description: string;
  priority: Priority;
  status: TaskStatus;
  order: number; // Sort order within the same column/context (0-based)
  dependencies: string[];
  timePreset: TimePreset; // Preset timing option
  timeEstimate: number; // in minutes - for custom values or calculated from preset
  actualTime: number; // in minutes
  dueDate?: Date;
  scheduledDate?: Date; // When the task is scheduled to be worked on (for day view planning)
  tags: string[];
  projectId?: string;
  parentTaskId?: string;
  subtasks: string[];
  taskListId: string; // Foreign key to task list
  completedAt?: Date;
  createdAt: Date;
  updatedAt: Date;
}

CreateTaskRequest​

interface CreateTaskRequest {
  title: string;
  description?: string;
  priority?: Priority;
  order?: number; // Sort order within the same column/context
  timePreset?: TimePreset;
  timeEstimate?: number;
  dueDate?: Date;
  scheduledDate?: Date;
  tags?: string[];
  dependencies?: string[];
  projectId?: string;
  parentTaskId?: string;
  taskListId?: string; // Optional - defaults to current selection or default list
}

UpdateTaskRequest​

interface UpdateTaskRequest {
  title?: string;
  description?: string;
  priority?: Priority;
  status?: TaskStatus;
  order?: number; // Sort order within the same column/context
  timePreset?: TimePreset;
  timeEstimate?: number;
  dueDate?: Date;
  scheduledDate?: Date;
  tags?: string[];
  dependencies?: string[];
  taskListId?: string; // Allow moving tasks between lists
}

TaskList​

interface TaskList {
  id: string;
  name: string;
  isDefault: boolean;
  createdAt: Date;
  updatedAt: Date;
}

CreateTaskListRequest​

interface CreateTaskListRequest {
  name: string;
}

UpdateTaskListRequest​

interface UpdateTaskListRequest {
  name: string;
}

TaskListSelection​

interface TaskListSelection {
  type: 'all' | 'specific';
  taskListId?: string;
  taskList?: TaskList;
}

TaskListService​

interface TaskListService {}

PlannedTask​

interface PlannedTask {
  taskId: string;
  scheduledStart: Date;
  scheduledEnd: Date;
  actualStart?: Date;
  actualEnd?: Date;
  completed: boolean;
}

TaskFilters​

interface TaskFilters {
  status?: TaskStatus[];
  priority?: Priority[];
  tags?: string[];
  dueDate?: {
    from?: Date;
    to?: Date;
  };
  projectId?: string;
  taskListId?: string;
  search?: string;
}

TaskSortOptions​

interface TaskSortOptions {
  field: 'title' | 'priority' | 'dueDate' | 'createdAt' | 'updatedAt';
  direction: 'asc' | 'desc';
}

Time Tracking​

TimerSession​

interface TimerSession {
  id: string;
  taskId: string;
  startTime: Date;
  endTime?: Date;
  pausedTime: number;
  isActive: boolean;
  notes: string;
  breaks: TimerBreak[];
  createdAt: Date;
}

TimerBreak​

interface TimerBreak {
  id: string;
  startTime: Date;
  endTime: Date;
  reason: string;
}

CompletedSession​

interface CompletedSession {
  id: string;
  taskId: string;
  duration: number;
  actualWork: number;
  breaks: TimerBreak[];
  notes: string;
  productivity: number;
  createdAt: Date;
}

FocusSession​

interface FocusSession {
  id: string;
  taskId: string;
  plannedDuration: number;
  actualDuration?: number;
  focusScore?: number;
  distractionCount: number;
  distractionLevel: DistractionLevel;
  backgroundAudio?: AudioConfig;
  notes: string;
  breaks: FocusBreak[];
  metrics: FocusMetrics;
  createdAt: Date;
  completedAt?: Date;
}

TaskTimerProps​

interface TaskTimerProps {
  onTimerStart: () => void;
  onTimerPause: () => void;
  onTimerStop: () => void;
  activeTimerTaskId: string | null;
  isTimerRunning: boolean;
  elapsedTime: number;
}

SessionStatistics​

interface SessionStatistics {
  totalSessions: number;
  totalTime: number;
  totalWorkTime: number;
  totalBreakTime: number;
  averageSessionLength: number;
  averageProductivity: number;
  mostProductiveHour: number;
  sessionsPerDay: Record<string, number>;
}

AI & Analytics​

AISuggestion​

interface AISuggestion {
  id: string;
  type: 'task' | 'schedule' | 'break' | 'focus' | 'energy' | 'productivity';
  title: string;
  description: string;
  confidence: number;
  actionable: boolean;
  priority: Priority;
  estimatedImpact: number;
  reasoning: string;
  actions?: AIAction[];
  createdAt: Date;
  dismissedAt?: Date;
  appliedAt?: Date;
}

AIAction​

interface AIAction {
  type:
    | 'CREATE_TASK'
    | 'UPDATE_TASK'
    | 'START_TIMER'
    | 'STOP_TIMER'
    | 'SCHEDULE_FOCUS'
    | 'TAKE_BREAK'
    | 'ANALYZE_PRODUCTIVITY'
    | 'SUGGEST_SCHEDULE';
  parameters: Record<string, unknown>;
  context: AppContext;
  confidence: number;
  reasoning?: string;
}

Configuration​

FocusConfig​

interface FocusConfig {
  duration: number;
  taskId: string;
  distractionLevel: DistractionLevel;
  backgroundAudio?: AudioConfig;
  breakReminders: boolean;
  breakInterval?: number;
}

AudioConfig​

interface AudioConfig {
  type: 'white_noise' | 'nature' | 'music' | 'silence';
  volume: number;
  url?: string;
}

Types & Constants​

Constants​

TASK_LIST_ALL​

const TASK_LIST_ALL: inferred = '__ALL__';

TASK_LIST_DEFAULT​

const TASK_LIST_DEFAULT: inferred = '__DEFAULT__';