@guidemode/types

Shared TypeScript types for the GuideMode ecosystem.

Type definitions used across all GuideMode packages for type safety and consistency.

Installation

npm install @guidemode/types

Usage

import type { AgentSession, SessionMetrics } from '@guidemode/types'

const session: AgentSession = {
  sessionId: 'session-123',
  provider: 'claude-code',
  startTime: new Date(),
  // ...
}

What's Included

• Session Types - AgentSession, ParsedMessage, SessionPhase
• Metrics Types - Performance, Usage, Quality, Engagement, Error metrics
• API Types - Request/response shapes for all endpoints
• Database Types - Schema types matching database models
• Auth Types - OAuth, sessions, permissions
• Canonical Format Types - Universal message format for all providers

Key Features

• ✅ Dual Module Support - ESM and CommonJS
• ✅ Full Type Safety - Strict TypeScript compilation
• ✅ Canonical Format - Unified types for all AI providers
• ✅ Runtime Validation - Zod schemas for provider data

For Developers

Build from Source

git clone https://github.com/guidemode/types.git
cd types
pnpm install
pnpm build

See CLAUDE.md for:

• Complete type catalog
• Semantic organization structure
• How to add new types

Related Packages

• @guidemode/desktop - Desktop app
• @guidemode/session-processing - Analytics engine
• @guidemode/cli - CLI tool

License

MIT License - see LICENSE

Support

• 💬 Discussions - Ask questions, share ideas
• 🐛 Issues - Report bugs, request features
• 📧 Email: [email protected]