diff --git a/Dockerfile b/Dockerfile index efd68ae..669e938 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,20 +1,23 @@ # Use Bun as the base image -FROM oven/bun:1.0.26 +FROM oven/bun:1.0.25 # Set working directory WORKDIR /app -# Copy source code -COPY . . +# Copy package files +COPY package.json bun.lockb ./ # Install dependencies RUN bun install +# Copy source code +COPY . . + # Build TypeScript RUN bun run build -# Expose the port the app runs on -EXPOSE 3000 +# Expose port +EXPOSE 4000 # Start the application CMD ["bun", "run", "start"] \ No newline at end of file diff --git a/package.json b/package.json index db4c1fe..d83f525 100644 --- a/package.json +++ b/package.json @@ -16,7 +16,7 @@ "prepare": "husky install" }, "dependencies": { - "@digital-alchemy/core": "^0.1.0", + "@digital-alchemy/core": "^25.1.3", "@digital-alchemy/hass": "^25.1.1", "@jest/globals": "^29.7.0", "@types/express": "^4.17.21", @@ -52,4 +52,4 @@ "engines": { "bun": ">=1.0.0" } -} \ No newline at end of file +} diff --git a/src/__mocks__/@digital-alchemy/hass.ts b/src/__mocks__/@digital-alchemy/hass.ts index 9da8e5a..6f2c5c3 100644 --- a/src/__mocks__/@digital-alchemy/hass.ts +++ b/src/__mocks__/@digital-alchemy/hass.ts @@ -1,77 +1,77 @@ -import { mock } from 'bun:test'; +import { mock } from "bun:test"; export const LIB_HASS = { - configuration: { - name: 'Home Assistant', - version: '2024.2.0', - location_name: 'Home', - time_zone: 'UTC', - components: ['automation', 'script', 'light', 'switch'], - unit_system: { - temperature: '°C', - length: 'm', - mass: 'kg', - pressure: 'hPa', - volume: 'L' - } + configuration: { + name: "Home Assistant", + version: "2024.2.0", + location_name: "Home", + time_zone: "UTC", + components: ["automation", "script", "light", "switch"], + unit_system: { + temperature: "°C", + length: "m", + mass: "kg", + pressure: "hPa", + volume: "L", }, - services: { - light: { - turn_on: mock(() => Promise.resolve()), - turn_off: mock(() => Promise.resolve()), - toggle: mock(() => Promise.resolve()) - }, - switch: { - turn_on: mock(() => Promise.resolve()), - turn_off: mock(() => Promise.resolve()), - toggle: mock(() => Promise.resolve()) - }, - automation: { - trigger: mock(() => Promise.resolve()), - turn_on: mock(() => Promise.resolve()), - turn_off: mock(() => Promise.resolve()) - }, - script: { - turn_on: mock(() => Promise.resolve()), - turn_off: mock(() => Promise.resolve()), - toggle: mock(() => Promise.resolve()) - } + }, + services: { + light: { + turn_on: mock(() => Promise.resolve()), + turn_off: mock(() => Promise.resolve()), + toggle: mock(() => Promise.resolve()), }, - states: { - light: { - 'light.living_room': { - state: 'on', - attributes: { - brightness: 255, - color_temp: 300, - friendly_name: 'Living Room Light' - } - }, - 'light.bedroom': { - state: 'off', - attributes: { - friendly_name: 'Bedroom Light' - } - } + switch: { + turn_on: mock(() => Promise.resolve()), + turn_off: mock(() => Promise.resolve()), + toggle: mock(() => Promise.resolve()), + }, + automation: { + trigger: mock(() => Promise.resolve()), + turn_on: mock(() => Promise.resolve()), + turn_off: mock(() => Promise.resolve()), + }, + script: { + turn_on: mock(() => Promise.resolve()), + turn_off: mock(() => Promise.resolve()), + toggle: mock(() => Promise.resolve()), + }, + }, + states: { + light: { + "light.living_room": { + state: "on", + attributes: { + brightness: 255, + color_temp: 300, + friendly_name: "Living Room Light", }, - switch: { - 'switch.tv': { - state: 'off', - attributes: { - friendly_name: 'TV' - } - } - } + }, + "light.bedroom": { + state: "off", + attributes: { + friendly_name: "Bedroom Light", + }, + }, }, - events: { - subscribe: mock(() => Promise.resolve()), - unsubscribe: mock(() => Promise.resolve()), - fire: mock(() => Promise.resolve()) + switch: { + "switch.tv": { + state: "off", + attributes: { + friendly_name: "TV", + }, + }, }, - connection: { - subscribeEvents: mock(() => Promise.resolve()), - subscribeMessage: mock(() => Promise.resolve()), - sendMessage: mock(() => Promise.resolve()), - close: mock(() => Promise.resolve()) - } -}; \ No newline at end of file + }, + events: { + subscribe: mock(() => Promise.resolve()), + unsubscribe: mock(() => Promise.resolve()), + fire: mock(() => Promise.resolve()), + }, + connection: { + subscribeEvents: mock(() => Promise.resolve()), + subscribeMessage: mock(() => Promise.resolve()), + sendMessage: mock(() => Promise.resolve()), + close: mock(() => Promise.resolve()), + }, +}; diff --git a/src/__mocks__/litemcp.ts b/src/__mocks__/litemcp.ts index 8c3c105..9ddd307 100644 --- a/src/__mocks__/litemcp.ts +++ b/src/__mocks__/litemcp.ts @@ -1,61 +1,61 @@ export class LiteMCP { - name: string; - version: string; - config: any; + name: string; + version: string; + config: any; - constructor(config: any = {}) { - this.name = 'home-assistant'; - this.version = '1.0.0'; - this.config = config; - } + constructor(config: any = {}) { + this.name = "home-assistant"; + this.version = "1.0.0"; + this.config = config; + } - async start() { - return Promise.resolve(); - } + async start() { + return Promise.resolve(); + } - async stop() { - return Promise.resolve(); - } + async stop() { + return Promise.resolve(); + } - async connect() { - return Promise.resolve(); - } + async connect() { + return Promise.resolve(); + } - async disconnect() { - return Promise.resolve(); - } + async disconnect() { + return Promise.resolve(); + } - async callService(domain: string, service: string, data: any = {}) { - return Promise.resolve({ success: true }); - } + async callService(domain: string, service: string, data: any = {}) { + return Promise.resolve({ success: true }); + } - async getStates() { - return Promise.resolve([]); - } + async getStates() { + return Promise.resolve([]); + } - async getState(entityId: string) { - return Promise.resolve({ - entity_id: entityId, - state: 'unknown', - attributes: {}, - last_changed: new Date().toISOString(), - last_updated: new Date().toISOString() - }); - } + async getState(entityId: string) { + return Promise.resolve({ + entity_id: entityId, + state: "unknown", + attributes: {}, + last_changed: new Date().toISOString(), + last_updated: new Date().toISOString(), + }); + } - async setState(entityId: string, state: string, attributes: any = {}) { - return Promise.resolve({ success: true }); - } + async setState(entityId: string, state: string, attributes: any = {}) { + return Promise.resolve({ success: true }); + } - onStateChanged(callback: (event: any) => void) { - // Mock implementation - } + onStateChanged(callback: (event: any) => void) { + // Mock implementation + } - onEvent(eventType: string, callback: (event: any) => void) { - // Mock implementation - } + onEvent(eventType: string, callback: (event: any) => void) { + // Mock implementation + } } export const createMCP = (config: any = {}) => { - return new LiteMCP(config); -}; \ No newline at end of file + return new LiteMCP(config); +}; diff --git a/src/__tests__/setup.ts b/src/__tests__/setup.ts index 0ff5791..c3e3d40 100644 --- a/src/__tests__/setup.ts +++ b/src/__tests__/setup.ts @@ -1,140 +1,154 @@ -import { config } from 'dotenv'; -import path from 'path'; -import { TEST_CONFIG } from '../config/__tests__/test.config'; -import { beforeAll, afterAll, beforeEach, describe, expect, it, mock, test } from 'bun:test'; +import { config } from "dotenv"; +import path from "path"; +import { TEST_CONFIG } from "../config/__tests__/test.config"; +import { + beforeAll, + afterAll, + beforeEach, + describe, + expect, + it, + mock, + test, +} from "bun:test"; // Load test environment variables -config({ path: path.resolve(process.cwd(), '.env.test') }); +config({ path: path.resolve(process.cwd(), ".env.test") }); // Global test setup beforeAll(() => { - // Set required environment variables - process.env.NODE_ENV = 'test'; - process.env.JWT_SECRET = TEST_CONFIG.TEST_JWT_SECRET; - process.env.TEST_TOKEN = TEST_CONFIG.TEST_TOKEN; + // Set required environment variables + process.env.NODE_ENV = "test"; + process.env.JWT_SECRET = TEST_CONFIG.TEST_JWT_SECRET; + process.env.TEST_TOKEN = TEST_CONFIG.TEST_TOKEN; - // Configure console output for tests - const originalConsoleError = console.error; - const originalConsoleWarn = console.warn; - const originalConsoleLog = console.log; + // Configure console output for tests + const originalConsoleError = console.error; + const originalConsoleWarn = console.warn; + const originalConsoleLog = console.log; - // Suppress console output during tests unless explicitly enabled - if (!process.env.DEBUG) { - console.error = mock(() => { }); - console.warn = mock(() => { }); - console.log = mock(() => { }); - } + // Suppress console output during tests unless explicitly enabled + if (!process.env.DEBUG) { + console.error = mock(() => {}); + console.warn = mock(() => {}); + console.log = mock(() => {}); + } - // Store original console methods for cleanup - (global as any).__ORIGINAL_CONSOLE__ = { - error: originalConsoleError, - warn: originalConsoleWarn, - log: originalConsoleLog - }; + // Store original console methods for cleanup + (global as any).__ORIGINAL_CONSOLE__ = { + error: originalConsoleError, + warn: originalConsoleWarn, + log: originalConsoleLog, + }; }); // Global test teardown afterAll(() => { - // Restore original console methods - const originalConsole = (global as any).__ORIGINAL_CONSOLE__; - if (originalConsole) { - console.error = originalConsole.error; - console.warn = originalConsole.warn; - console.log = originalConsole.log; - delete (global as any).__ORIGINAL_CONSOLE__; - } + // Restore original console methods + const originalConsole = (global as any).__ORIGINAL_CONSOLE__; + if (originalConsole) { + console.error = originalConsole.error; + console.warn = originalConsole.warn; + console.log = originalConsole.log; + delete (global as any).__ORIGINAL_CONSOLE__; + } }); // Reset mocks between tests beforeEach(() => { - // Clear all mock function calls - const mockFns = Object.values(mock).filter(value => typeof value === 'function'); - mockFns.forEach(mockFn => { - if (mockFn.mock) { - mockFn.mock.calls = []; - mockFn.mock.results = []; - mockFn.mock.instances = []; - mockFn.mock.lastCall = undefined; - } - }); + // Clear all mock function calls + const mockFns = Object.values(mock).filter( + (value) => typeof value === "function", + ); + mockFns.forEach((mockFn) => { + if (mockFn.mock) { + mockFn.mock.calls = []; + mockFn.mock.results = []; + mockFn.mock.instances = []; + mockFn.mock.lastCall = undefined; + } + }); }); // Custom test environment setup const setupTestEnvironment = () => { - return { - // Mock WebSocket for SSE tests - mockWebSocket: () => { - const mockWs = { - on: mock(() => { }), - send: mock(() => { }), - close: mock(() => { }) - }; - return mockWs; - }, + return { + // Mock WebSocket for SSE tests + mockWebSocket: () => { + const mockWs = { + on: mock(() => {}), + send: mock(() => {}), + close: mock(() => {}), + }; + return mockWs; + }, - // Mock HTTP response for API tests - mockResponse: () => { - const res: any = {}; - res.status = mock(() => res); - res.json = mock(() => res); - res.send = mock(() => res); - res.end = mock(() => res); - res.setHeader = mock(() => res); - res.writeHead = mock(() => res); - res.write = mock(() => true); - res.removeHeader = mock(() => res); - return res; - }, + // Mock HTTP response for API tests + mockResponse: () => { + const res: any = {}; + res.status = mock(() => res); + res.json = mock(() => res); + res.send = mock(() => res); + res.end = mock(() => res); + res.setHeader = mock(() => res); + res.writeHead = mock(() => res); + res.write = mock(() => true); + res.removeHeader = mock(() => res); + return res; + }, - // Mock HTTP request for API tests - mockRequest: (overrides = {}) => { - return { - headers: { 'content-type': 'application/json' }, - body: {}, - query: {}, - params: {}, - ip: TEST_CONFIG.TEST_CLIENT_IP, - method: 'GET', - path: '/api/test', - is: mock((type: string) => type === 'application/json'), - ...overrides - }; - }, + // Mock HTTP request for API tests + mockRequest: (overrides = {}) => { + return { + headers: { "content-type": "application/json" }, + body: {}, + query: {}, + params: {}, + ip: TEST_CONFIG.TEST_CLIENT_IP, + method: "GET", + path: "/api/test", + is: mock((type: string) => type === "application/json"), + ...overrides, + }; + }, - // Create test client for SSE tests - createTestClient: (id: string = 'test-client') => ({ - id, - ip: TEST_CONFIG.TEST_CLIENT_IP, - connectedAt: new Date(), - send: mock(() => { }), - rateLimit: { - count: 0, - lastReset: Date.now() - }, - connectionTime: Date.now() - }), + // Create test client for SSE tests + createTestClient: (id: string = "test-client") => ({ + id, + ip: TEST_CONFIG.TEST_CLIENT_IP, + connectedAt: new Date(), + send: mock(() => {}), + rateLimit: { + count: 0, + lastReset: Date.now(), + }, + connectionTime: Date.now(), + }), - // Create test event for SSE tests - createTestEvent: (type: string = 'test_event', data: any = {}) => ({ - event_type: type, - data, - origin: 'test', - time_fired: new Date().toISOString(), - context: { id: 'test' } - }), + // Create test event for SSE tests + createTestEvent: (type: string = "test_event", data: any = {}) => ({ + event_type: type, + data, + origin: "test", + time_fired: new Date().toISOString(), + context: { id: "test" }, + }), - // Create test entity for Home Assistant tests - createTestEntity: (entityId: string = 'test.entity', state: string = 'on') => ({ - entity_id: entityId, - state, - attributes: {}, - last_changed: new Date().toISOString(), - last_updated: new Date().toISOString() - }), + // Create test entity for Home Assistant tests + createTestEntity: ( + entityId: string = "test.entity", + state: string = "on", + ) => ({ + entity_id: entityId, + state, + attributes: {}, + last_changed: new Date().toISOString(), + last_updated: new Date().toISOString(), + }), - // Helper to wait for async operations - wait: (ms: number) => new Promise(resolve => setTimeout(resolve, ms)) - }; + // Helper to wait for async operations + wait: (ms: number) => new Promise((resolve) => setTimeout(resolve, ms)), + }; }; // Export test utilities @@ -152,4 +166,4 @@ export { beforeAll, afterAll, beforeEach, describe, expect, it, mock, test }; (global as any).beforeAll = beforeAll; (global as any).afterAll = afterAll; (global as any).beforeEach = beforeEach; -(global as any).mock = mock; \ No newline at end of file +(global as any).mock = mock; diff --git a/src/ai/endpoints/ai-router.ts b/src/ai/endpoints/ai-router.ts index 8b40a87..77ae373 100644 --- a/src/ai/endpoints/ai-router.ts +++ b/src/ai/endpoints/ai-router.ts @@ -1,207 +1,234 @@ -import express from 'express'; -import { z } from 'zod'; -import { NLPProcessor } from '../nlp/processor.js'; -import { AIRateLimit, AIContext, AIResponse, AIError, AIModel } from '../types/index.js'; -import rateLimit from 'express-rate-limit'; +import express from "express"; +import { z } from "zod"; +import { NLPProcessor } from "../nlp/processor.js"; +import { + AIRateLimit, + AIContext, + AIResponse, + AIError, + AIModel, +} from "../types/index.js"; +import rateLimit from "express-rate-limit"; const router = express.Router(); const nlpProcessor = new NLPProcessor(); // Rate limiting configuration const rateLimitConfig: AIRateLimit = { - requests_per_minute: 100, - requests_per_hour: 1000, - concurrent_requests: 10, - model_specific_limits: { - claude: { - requests_per_minute: 100, - requests_per_hour: 1000 - }, - gpt4: { - requests_per_minute: 50, - requests_per_hour: 500 - }, - custom: { - requests_per_minute: 200, - requests_per_hour: 2000 - } - } + requests_per_minute: 100, + requests_per_hour: 1000, + concurrent_requests: 10, + model_specific_limits: { + claude: { + requests_per_minute: 100, + requests_per_hour: 1000, + }, + gpt4: { + requests_per_minute: 50, + requests_per_hour: 500, + }, + custom: { + requests_per_minute: 200, + requests_per_hour: 2000, + }, + }, }; // Request validation schemas const interpretRequestSchema = z.object({ - input: z.string(), - context: z.object({ - user_id: z.string(), - session_id: z.string(), - timestamp: z.string(), - location: z.string(), - previous_actions: z.array(z.any()), - environment_state: z.record(z.any()) - }), - model: z.enum(['claude', 'gpt4', 'custom']).optional() + input: z.string(), + context: z.object({ + user_id: z.string(), + session_id: z.string(), + timestamp: z.string(), + location: z.string(), + previous_actions: z.array(z.any()), + environment_state: z.record(z.any()), + }), + model: z.enum(["claude", "gpt4", "custom"]).optional(), }); // Rate limiters const globalLimiter = rateLimit({ - windowMs: 60 * 1000, // 1 minute - max: rateLimitConfig.requests_per_minute + windowMs: 60 * 1000, // 1 minute + max: rateLimitConfig.requests_per_minute, }); -const modelSpecificLimiter = (model: string) => rateLimit({ +const modelSpecificLimiter = (model: string) => + rateLimit({ windowMs: 60 * 1000, - max: rateLimitConfig.model_specific_limits[model as AIModel]?.requests_per_minute || - rateLimitConfig.requests_per_minute -}); + max: + rateLimitConfig.model_specific_limits[model as AIModel] + ?.requests_per_minute || rateLimitConfig.requests_per_minute, + }); // Error handler middleware const errorHandler = ( - error: Error, - req: express.Request, - res: express.Response, - next: express.NextFunction + error: Error, + req: express.Request, + res: express.Response, + next: express.NextFunction, ) => { - const aiError: AIError = { - code: 'PROCESSING_ERROR', - message: error.message, - suggestion: 'Please try again with a different command format', - recovery_options: [ - 'Simplify your command', - 'Use standard command patterns', - 'Check device names and parameters' - ], - context: req.body.context - }; + const aiError: AIError = { + code: "PROCESSING_ERROR", + message: error.message, + suggestion: "Please try again with a different command format", + recovery_options: [ + "Simplify your command", + "Use standard command patterns", + "Check device names and parameters", + ], + context: req.body.context, + }; - res.status(500).json({ error: aiError }); + res.status(500).json({ error: aiError }); }; // Endpoints router.post( - '/interpret', - globalLimiter, - async (req: express.Request, res: express.Response, next: express.NextFunction) => { - try { - const { input, context, model = 'claude' } = interpretRequestSchema.parse(req.body); + "/interpret", + globalLimiter, + async ( + req: express.Request, + res: express.Response, + next: express.NextFunction, + ) => { + try { + const { + input, + context, + model = "claude", + } = interpretRequestSchema.parse(req.body); - // Apply model-specific rate limiting - modelSpecificLimiter(model)(req, res, async () => { - const { intent, confidence, error } = await nlpProcessor.processCommand(input, context); + // Apply model-specific rate limiting + modelSpecificLimiter(model)(req, res, async () => { + const { intent, confidence, error } = await nlpProcessor.processCommand( + input, + context, + ); - if (error) { - return res.status(400).json({ error }); - } - - const isValid = await nlpProcessor.validateIntent(intent, confidence); - - if (!isValid) { - const suggestions = await nlpProcessor.suggestCorrections(input, { - code: 'INVALID_INTENT', - message: 'Could not understand the command with high confidence', - suggestion: 'Please try rephrasing your command', - recovery_options: [], - context - }); - - return res.status(400).json({ - error: { - code: 'INVALID_INTENT', - message: 'Could not understand the command with high confidence', - suggestion: 'Please try rephrasing your command', - recovery_options: suggestions, - context - } - }); - } - - const response: AIResponse = { - natural_language: `I'll ${intent.action} the ${intent.target.split('.').pop()}`, - structured_data: { - success: true, - action_taken: intent.action, - entities_affected: [intent.target], - state_changes: intent.parameters - }, - next_suggestions: [ - 'Would you like to adjust any settings?', - 'Should I perform this action in other rooms?', - 'Would you like to schedule this action?' - ], - confidence, - context - }; - - res.json(response); - }); - } catch (error) { - next(error); + if (error) { + return res.status(400).json({ error }); } + + const isValid = await nlpProcessor.validateIntent(intent, confidence); + + if (!isValid) { + const suggestions = await nlpProcessor.suggestCorrections(input, { + code: "INVALID_INTENT", + message: "Could not understand the command with high confidence", + suggestion: "Please try rephrasing your command", + recovery_options: [], + context, + }); + + return res.status(400).json({ + error: { + code: "INVALID_INTENT", + message: "Could not understand the command with high confidence", + suggestion: "Please try rephrasing your command", + recovery_options: suggestions, + context, + }, + }); + } + + const response: AIResponse = { + natural_language: `I'll ${intent.action} the ${intent.target.split(".").pop()}`, + structured_data: { + success: true, + action_taken: intent.action, + entities_affected: [intent.target], + state_changes: intent.parameters, + }, + next_suggestions: [ + "Would you like to adjust any settings?", + "Should I perform this action in other rooms?", + "Would you like to schedule this action?", + ], + confidence, + context, + }; + + res.json(response); + }); + } catch (error) { + next(error); } + }, ); router.post( - '/execute', - globalLimiter, - async (req: express.Request, res: express.Response, next: express.NextFunction) => { - try { - const { intent, context, model = 'claude' } = req.body; + "/execute", + globalLimiter, + async ( + req: express.Request, + res: express.Response, + next: express.NextFunction, + ) => { + try { + const { intent, context, model = "claude" } = req.body; - // Apply model-specific rate limiting - modelSpecificLimiter(model)(req, res, async () => { - // Execute the intent through Home Assistant - // This would integrate with your existing Home Assistant service + // Apply model-specific rate limiting + modelSpecificLimiter(model)(req, res, async () => { + // Execute the intent through Home Assistant + // This would integrate with your existing Home Assistant service - const response: AIResponse = { - natural_language: `Successfully executed ${intent.action} on ${intent.target}`, - structured_data: { - success: true, - action_taken: intent.action, - entities_affected: [intent.target], - state_changes: intent.parameters - }, - next_suggestions: [ - 'Would you like to verify the state?', - 'Should I perform any related actions?', - 'Would you like to undo this action?' - ], - confidence: { overall: 1, intent: 1, entities: 1, context: 1 }, - context - }; + const response: AIResponse = { + natural_language: `Successfully executed ${intent.action} on ${intent.target}`, + structured_data: { + success: true, + action_taken: intent.action, + entities_affected: [intent.target], + state_changes: intent.parameters, + }, + next_suggestions: [ + "Would you like to verify the state?", + "Should I perform any related actions?", + "Would you like to undo this action?", + ], + confidence: { overall: 1, intent: 1, entities: 1, context: 1 }, + context, + }; - res.json(response); - }); - } catch (error) { - next(error); - } + res.json(response); + }); + } catch (error) { + next(error); } + }, ); router.get( - '/suggestions', - globalLimiter, - async (req: express.Request, res: express.Response, next: express.NextFunction) => { - try { - const { context, model = 'claude' } = req.body; + "/suggestions", + globalLimiter, + async ( + req: express.Request, + res: express.Response, + next: express.NextFunction, + ) => { + try { + const { context, model = "claude" } = req.body; - // Apply model-specific rate limiting - modelSpecificLimiter(model)(req, res, async () => { - // Generate context-aware suggestions - const suggestions = [ - 'Turn on the lights in the living room', - 'Set the temperature to 72 degrees', - 'Show me the current state of all devices', - 'Start the evening routine' - ]; + // Apply model-specific rate limiting + modelSpecificLimiter(model)(req, res, async () => { + // Generate context-aware suggestions + const suggestions = [ + "Turn on the lights in the living room", + "Set the temperature to 72 degrees", + "Show me the current state of all devices", + "Start the evening routine", + ]; - res.json({ suggestions }); - }); - } catch (error) { - next(error); - } + res.json({ suggestions }); + }); + } catch (error) { + next(error); } + }, ); // Apply error handler router.use(errorHandler); -export default router; \ No newline at end of file +export default router; diff --git a/src/ai/nlp/context-analyzer.ts b/src/ai/nlp/context-analyzer.ts index 3e15175..7188f6c 100644 --- a/src/ai/nlp/context-analyzer.ts +++ b/src/ai/nlp/context-analyzer.ts @@ -1,135 +1,146 @@ -import { AIContext, AIIntent } from '../types/index.js'; +import { AIContext, AIIntent } from "../types/index.js"; interface ContextAnalysis { - confidence: number; - relevant_params: Record; + confidence: number; + relevant_params: Record; } interface ContextRule { - condition: (context: AIContext, intent: AIIntent) => boolean; - relevance: number; - params?: (context: AIContext) => Record; + condition: (context: AIContext, intent: AIIntent) => boolean; + relevance: number; + params?: (context: AIContext) => Record; } export class ContextAnalyzer { - private contextRules: ContextRule[]; + private contextRules: ContextRule[]; - constructor() { - this.contextRules = [ - // Location-based context - { - condition: (context, intent) => - Boolean(context.location && intent.target.includes(context.location.toLowerCase())), - relevance: 0.8, - params: (context) => ({ location: context.location }) - }, + constructor() { + this.contextRules = [ + // Location-based context + { + condition: (context, intent) => + Boolean( + context.location && + intent.target.includes(context.location.toLowerCase()), + ), + relevance: 0.8, + params: (context) => ({ location: context.location }), + }, - // Time-based context - { - condition: (context) => { - const hour = new Date(context.timestamp).getHours(); - return hour >= 0 && hour <= 23; - }, - relevance: 0.6, - params: (context) => ({ - time_of_day: this.getTimeOfDay(new Date(context.timestamp)) - }) - }, + // Time-based context + { + condition: (context) => { + const hour = new Date(context.timestamp).getHours(); + return hour >= 0 && hour <= 23; + }, + relevance: 0.6, + params: (context) => ({ + time_of_day: this.getTimeOfDay(new Date(context.timestamp)), + }), + }, - // Previous action context - { - condition: (context, intent) => { - const recentActions = context.previous_actions.slice(-3); - return recentActions.some(action => - action.target === intent.target || - action.action === intent.action - ); - }, - relevance: 0.7, - params: (context) => ({ - recent_action: context.previous_actions[context.previous_actions.length - 1] - }) - }, + // Previous action context + { + condition: (context, intent) => { + const recentActions = context.previous_actions.slice(-3); + return recentActions.some( + (action) => + action.target === intent.target || + action.action === intent.action, + ); + }, + relevance: 0.7, + params: (context) => ({ + recent_action: + context.previous_actions[context.previous_actions.length - 1], + }), + }, - // Environment state context - { - condition: (context, intent) => { - return Object.keys(context.environment_state).some(key => - intent.target.includes(key) || - intent.parameters[key] !== undefined - ); - }, - relevance: 0.9, - params: (context) => ({ environment: context.environment_state }) - } - ]; + // Environment state context + { + condition: (context, intent) => { + return Object.keys(context.environment_state).some( + (key) => + intent.target.includes(key) || + intent.parameters[key] !== undefined, + ); + }, + relevance: 0.9, + params: (context) => ({ environment: context.environment_state }), + }, + ]; + } + + async analyze( + intent: AIIntent, + context: AIContext, + ): Promise { + let totalConfidence = 0; + let relevantParams: Record = {}; + let applicableRules = 0; + + for (const rule of this.contextRules) { + if (rule.condition(context, intent)) { + totalConfidence += rule.relevance; + applicableRules++; + + if (rule.params) { + relevantParams = { + ...relevantParams, + ...rule.params(context), + }; + } + } } - async analyze(intent: AIIntent, context: AIContext): Promise { - let totalConfidence = 0; - let relevantParams: Record = {}; - let applicableRules = 0; + // Calculate normalized confidence + const confidence = + applicableRules > 0 ? totalConfidence / applicableRules : 0.5; // Default confidence if no rules apply - for (const rule of this.contextRules) { - if (rule.condition(context, intent)) { - totalConfidence += rule.relevance; - applicableRules++; + return { + confidence, + relevant_params: relevantParams, + }; + } - if (rule.params) { - relevantParams = { - ...relevantParams, - ...rule.params(context) - }; - } - } - } + private getTimeOfDay(date: Date): string { + const hour = date.getHours(); - // Calculate normalized confidence - const confidence = applicableRules > 0 - ? totalConfidence / applicableRules - : 0.5; // Default confidence if no rules apply + if (hour >= 5 && hour < 12) return "morning"; + if (hour >= 12 && hour < 17) return "afternoon"; + if (hour >= 17 && hour < 22) return "evening"; + return "night"; + } - return { - confidence, - relevant_params: relevantParams - }; + async updateContextRules(newRules: ContextRule[]): Promise { + this.contextRules = [...this.contextRules, ...newRules]; + } + + async validateContext(context: AIContext): Promise { + // Validate required context fields + if (!context.timestamp || !context.user_id || !context.session_id) { + return false; } - private getTimeOfDay(date: Date): string { - const hour = date.getHours(); - - if (hour >= 5 && hour < 12) return 'morning'; - if (hour >= 12 && hour < 17) return 'afternoon'; - if (hour >= 17 && hour < 22) return 'evening'; - return 'night'; + // Validate timestamp format + const timestamp = new Date(context.timestamp); + if (isNaN(timestamp.getTime())) { + return false; } - async updateContextRules(newRules: ContextRule[]): Promise { - this.contextRules = [...this.contextRules, ...newRules]; + // Validate previous actions array + if (!Array.isArray(context.previous_actions)) { + return false; } - async validateContext(context: AIContext): Promise { - // Validate required context fields - if (!context.timestamp || !context.user_id || !context.session_id) { - return false; - } - - // Validate timestamp format - const timestamp = new Date(context.timestamp); - if (isNaN(timestamp.getTime())) { - return false; - } - - // Validate previous actions array - if (!Array.isArray(context.previous_actions)) { - return false; - } - - // Validate environment state - if (typeof context.environment_state !== 'object' || context.environment_state === null) { - return false; - } - - return true; + // Validate environment state + if ( + typeof context.environment_state !== "object" || + context.environment_state === null + ) { + return false; } -} \ No newline at end of file + + return true; + } +} diff --git a/src/ai/nlp/entity-extractor.ts b/src/ai/nlp/entity-extractor.ts index 9853c48..d2934ba 100644 --- a/src/ai/nlp/entity-extractor.ts +++ b/src/ai/nlp/entity-extractor.ts @@ -1,103 +1,115 @@ -import { AIContext } from '../types/index.js'; +import { AIContext } from "../types/index.js"; interface ExtractedEntities { - primary_target: string; - parameters: Record; - confidence: number; + primary_target: string; + parameters: Record; + confidence: number; } export class EntityExtractor { - private deviceNameMap: Map; - private parameterPatterns: Map; + private deviceNameMap: Map; + private parameterPatterns: Map; - constructor() { - this.deviceNameMap = new Map(); - this.parameterPatterns = new Map(); - this.initializePatterns(); - } + constructor() { + this.deviceNameMap = new Map(); + this.parameterPatterns = new Map(); + this.initializePatterns(); + } - private initializePatterns(): void { - // Device name variations - this.deviceNameMap.set('living room light', 'light.living_room'); - this.deviceNameMap.set('kitchen light', 'light.kitchen'); - this.deviceNameMap.set('bedroom light', 'light.bedroom'); + private initializePatterns(): void { + // Device name variations + this.deviceNameMap.set("living room light", "light.living_room"); + this.deviceNameMap.set("kitchen light", "light.kitchen"); + this.deviceNameMap.set("bedroom light", "light.bedroom"); - // Parameter patterns - this.parameterPatterns.set('brightness', /(\d+)\s*(%|percent)|bright(ness)?\s+(\d+)/i); - this.parameterPatterns.set('temperature', /(\d+)\s*(degrees?|°)[CF]?/i); - this.parameterPatterns.set('color', /(red|green|blue|white|warm|cool)/i); - } + // Parameter patterns + this.parameterPatterns.set( + "brightness", + /(\d+)\s*(%|percent)|bright(ness)?\s+(\d+)/i, + ); + this.parameterPatterns.set("temperature", /(\d+)\s*(degrees?|°)[CF]?/i); + this.parameterPatterns.set("color", /(red|green|blue|white|warm|cool)/i); + } - async extract(input: string): Promise { - const entities: ExtractedEntities = { - primary_target: '', - parameters: {}, - confidence: 0 - }; + async extract(input: string): Promise { + const entities: ExtractedEntities = { + primary_target: "", + parameters: {}, + confidence: 0, + }; - try { - // Find device name - for (const [key, value] of this.deviceNameMap) { - if (input.toLowerCase().includes(key)) { - entities.primary_target = value; - break; - } - } - - // Extract parameters - for (const [param, pattern] of this.parameterPatterns) { - const match = input.match(pattern); - if (match) { - entities.parameters[param] = this.normalizeParameterValue(param, match[1]); - } - } - - // Calculate confidence based on matches - entities.confidence = this.calculateConfidence(entities, input); - - return entities; - } catch (error) { - console.error('Entity extraction error:', error); - return { - primary_target: '', - parameters: {}, - confidence: 0 - }; + try { + // Find device name + for (const [key, value] of this.deviceNameMap) { + if (input.toLowerCase().includes(key)) { + entities.primary_target = value; + break; } - } + } - private normalizeParameterValue(parameter: string, value: string): number | string { - switch (parameter) { - case 'brightness': - return Math.min(100, Math.max(0, parseInt(value))); - case 'temperature': - return parseInt(value); - case 'color': - return value.toLowerCase(); - default: - return value; + // Extract parameters + for (const [param, pattern] of this.parameterPatterns) { + const match = input.match(pattern); + if (match) { + entities.parameters[param] = this.normalizeParameterValue( + param, + match[1], + ); } + } + + // Calculate confidence based on matches + entities.confidence = this.calculateConfidence(entities, input); + + return entities; + } catch (error) { + console.error("Entity extraction error:", error); + return { + primary_target: "", + parameters: {}, + confidence: 0, + }; + } + } + + private normalizeParameterValue( + parameter: string, + value: string, + ): number | string { + switch (parameter) { + case "brightness": + return Math.min(100, Math.max(0, parseInt(value))); + case "temperature": + return parseInt(value); + case "color": + return value.toLowerCase(); + default: + return value; + } + } + + private calculateConfidence( + entities: ExtractedEntities, + input: string, + ): number { + let confidence = 0; + + // Device confidence + if (entities.primary_target) { + confidence += 0.5; } - private calculateConfidence(entities: ExtractedEntities, input: string): number { - let confidence = 0; + // Parameter confidence + const paramCount = Object.keys(entities.parameters).length; + confidence += paramCount * 0.25; - // Device confidence - if (entities.primary_target) { - confidence += 0.5; - } + // Normalize confidence to 0-1 range + return Math.min(1, confidence); + } - // Parameter confidence - const paramCount = Object.keys(entities.parameters).length; - confidence += paramCount * 0.25; - - // Normalize confidence to 0-1 range - return Math.min(1, confidence); + async updateDeviceMap(devices: Record): Promise { + for (const [key, value] of Object.entries(devices)) { + this.deviceNameMap.set(key, value); } - - async updateDeviceMap(devices: Record): Promise { - for (const [key, value] of Object.entries(devices)) { - this.deviceNameMap.set(key, value); - } - } -} \ No newline at end of file + } +} diff --git a/src/ai/nlp/intent-classifier.ts b/src/ai/nlp/intent-classifier.ts index 2ae3a60..8081218 100644 --- a/src/ai/nlp/intent-classifier.ts +++ b/src/ai/nlp/intent-classifier.ts @@ -1,177 +1,180 @@ interface ClassifiedIntent { - action: string; - target: string; - confidence: number; - parameters: Record; - raw_input: string; + action: string; + target: string; + confidence: number; + parameters: Record; + raw_input: string; } interface ActionPattern { - action: string; - patterns: RegExp[]; - parameters?: string[]; + action: string; + patterns: RegExp[]; + parameters?: string[]; } export class IntentClassifier { - private actionPatterns: ActionPattern[]; + private actionPatterns: ActionPattern[]; - constructor() { - this.actionPatterns = [ - { - action: 'turn_on', - patterns: [ - /turn\s+on/i, - /switch\s+on/i, - /enable/i, - /activate/i - ] - }, - { - action: 'turn_off', - patterns: [ - /turn\s+off/i, - /switch\s+off/i, - /disable/i, - /deactivate/i - ] - }, - { - action: 'set', - patterns: [ - /set\s+(?:the\s+)?(.+)\s+to/i, - /change\s+(?:the\s+)?(.+)\s+to/i, - /adjust\s+(?:the\s+)?(.+)\s+to/i - ], - parameters: ['brightness', 'temperature', 'color'] - }, - { - action: 'query', - patterns: [ - /what\s+is/i, - /get\s+(?:the\s+)?(.+)/i, - /show\s+(?:the\s+)?(.+)/i, - /tell\s+me/i - ] - } - ]; - } + constructor() { + this.actionPatterns = [ + { + action: "turn_on", + patterns: [/turn\s+on/i, /switch\s+on/i, /enable/i, /activate/i], + }, + { + action: "turn_off", + patterns: [/turn\s+off/i, /switch\s+off/i, /disable/i, /deactivate/i], + }, + { + action: "set", + patterns: [ + /set\s+(?:the\s+)?(.+)\s+to/i, + /change\s+(?:the\s+)?(.+)\s+to/i, + /adjust\s+(?:the\s+)?(.+)\s+to/i, + ], + parameters: ["brightness", "temperature", "color"], + }, + { + action: "query", + patterns: [ + /what\s+is/i, + /get\s+(?:the\s+)?(.+)/i, + /show\s+(?:the\s+)?(.+)/i, + /tell\s+me/i, + ], + }, + ]; + } - async classify( - input: string, - extractedEntities: { parameters: Record; primary_target: string } - ): Promise { - let bestMatch: ClassifiedIntent = { - action: '', - target: '', - confidence: 0, - parameters: {}, - raw_input: input - }; + async classify( + input: string, + extractedEntities: { + parameters: Record; + primary_target: string; + }, + ): Promise { + let bestMatch: ClassifiedIntent = { + action: "", + target: "", + confidence: 0, + parameters: {}, + raw_input: input, + }; - for (const actionPattern of this.actionPatterns) { - for (const pattern of actionPattern.patterns) { - const match = input.match(pattern); - if (match) { - const confidence = this.calculateConfidence(match[0], input); - if (confidence > bestMatch.confidence) { - bestMatch = { - action: actionPattern.action, - target: extractedEntities.primary_target, - confidence, - parameters: this.extractActionParameters(actionPattern, match, extractedEntities), - raw_input: input - }; - } - } - } - } - - // If no match found, try to infer from context - if (!bestMatch.action) { - bestMatch = this.inferFromContext(input, extractedEntities); - } - - return bestMatch; - } - - private calculateConfidence(match: string, input: string): number { - // Base confidence from match length relative to input length - const lengthRatio = match.length / input.length; - let confidence = lengthRatio * 0.7; - - // Boost confidence for exact matches - if (match.toLowerCase() === input.toLowerCase()) { - confidence += 0.3; - } - - // Additional confidence for specific keywords - const keywords = ['please', 'can you', 'would you']; - for (const keyword of keywords) { - if (input.toLowerCase().includes(keyword)) { - confidence += 0.1; - } - } - - return Math.min(1, confidence); - } - - private extractActionParameters( - actionPattern: ActionPattern, - match: RegExpMatchArray, - extractedEntities: { parameters: Record; primary_target: string } - ): Record { - const parameters: Record = {}; - - // Copy relevant extracted entities - if (actionPattern.parameters) { - for (const param of actionPattern.parameters) { - if (extractedEntities.parameters[param] !== undefined) { - parameters[param] = extractedEntities.parameters[param]; - } - } - } - - // Extract additional parameters from match groups - if (match.length > 1 && match[1]) { - parameters.raw_parameter = match[1].trim(); - } - - return parameters; - } - - private inferFromContext( - input: string, - extractedEntities: { parameters: Record; primary_target: string } - ): ClassifiedIntent { - // Default to 'set' action if parameters are present - if (Object.keys(extractedEntities.parameters).length > 0) { - return { - action: 'set', - target: extractedEntities.primary_target, - confidence: 0.5, - parameters: extractedEntities.parameters, - raw_input: input + for (const actionPattern of this.actionPatterns) { + for (const pattern of actionPattern.patterns) { + const match = input.match(pattern); + if (match) { + const confidence = this.calculateConfidence(match[0], input); + if (confidence > bestMatch.confidence) { + bestMatch = { + action: actionPattern.action, + target: extractedEntities.primary_target, + confidence, + parameters: this.extractActionParameters( + actionPattern, + match, + extractedEntities, + ), + raw_input: input, }; + } } - - // Default to 'query' for question-like inputs - if (input.match(/^(what|when|where|who|how|why)/i)) { - return { - action: 'query', - target: extractedEntities.primary_target || 'system', - confidence: 0.6, - parameters: {}, - raw_input: input - }; - } - - // Fallback with low confidence - return { - action: 'unknown', - target: extractedEntities.primary_target || 'system', - confidence: 0.3, - parameters: {}, - raw_input: input - }; + } } -} \ No newline at end of file + + // If no match found, try to infer from context + if (!bestMatch.action) { + bestMatch = this.inferFromContext(input, extractedEntities); + } + + return bestMatch; + } + + private calculateConfidence(match: string, input: string): number { + // Base confidence from match length relative to input length + const lengthRatio = match.length / input.length; + let confidence = lengthRatio * 0.7; + + // Boost confidence for exact matches + if (match.toLowerCase() === input.toLowerCase()) { + confidence += 0.3; + } + + // Additional confidence for specific keywords + const keywords = ["please", "can you", "would you"]; + for (const keyword of keywords) { + if (input.toLowerCase().includes(keyword)) { + confidence += 0.1; + } + } + + return Math.min(1, confidence); + } + + private extractActionParameters( + actionPattern: ActionPattern, + match: RegExpMatchArray, + extractedEntities: { + parameters: Record; + primary_target: string; + }, + ): Record { + const parameters: Record = {}; + + // Copy relevant extracted entities + if (actionPattern.parameters) { + for (const param of actionPattern.parameters) { + if (extractedEntities.parameters[param] !== undefined) { + parameters[param] = extractedEntities.parameters[param]; + } + } + } + + // Extract additional parameters from match groups + if (match.length > 1 && match[1]) { + parameters.raw_parameter = match[1].trim(); + } + + return parameters; + } + + private inferFromContext( + input: string, + extractedEntities: { + parameters: Record; + primary_target: string; + }, + ): ClassifiedIntent { + // Default to 'set' action if parameters are present + if (Object.keys(extractedEntities.parameters).length > 0) { + return { + action: "set", + target: extractedEntities.primary_target, + confidence: 0.5, + parameters: extractedEntities.parameters, + raw_input: input, + }; + } + + // Default to 'query' for question-like inputs + if (input.match(/^(what|when|where|who|how|why)/i)) { + return { + action: "query", + target: extractedEntities.primary_target || "system", + confidence: 0.6, + parameters: {}, + raw_input: input, + }; + } + + // Fallback with low confidence + return { + action: "unknown", + target: extractedEntities.primary_target || "system", + confidence: 0.3, + parameters: {}, + raw_input: input, + }; + } +} diff --git a/src/ai/nlp/processor.ts b/src/ai/nlp/processor.ts index c58e6ae..24c5dcc 100644 --- a/src/ai/nlp/processor.ts +++ b/src/ai/nlp/processor.ts @@ -1,132 +1,137 @@ -import { AIIntent, AIContext, AIConfidence, AIError } from '../types/index.js'; -import { EntityExtractor } from './entity-extractor.js'; -import { IntentClassifier } from './intent-classifier.js'; -import { ContextAnalyzer } from './context-analyzer.js'; +import { AIIntent, AIContext, AIConfidence, AIError } from "../types/index.js"; +import { EntityExtractor } from "./entity-extractor.js"; +import { IntentClassifier } from "./intent-classifier.js"; +import { ContextAnalyzer } from "./context-analyzer.js"; export class NLPProcessor { - private entityExtractor: EntityExtractor; - private intentClassifier: IntentClassifier; - private contextAnalyzer: ContextAnalyzer; + private entityExtractor: EntityExtractor; + private intentClassifier: IntentClassifier; + private contextAnalyzer: ContextAnalyzer; - constructor() { - this.entityExtractor = new EntityExtractor(); - this.intentClassifier = new IntentClassifier(); - this.contextAnalyzer = new ContextAnalyzer(); + constructor() { + this.entityExtractor = new EntityExtractor(); + this.intentClassifier = new IntentClassifier(); + this.contextAnalyzer = new ContextAnalyzer(); + } + + async processCommand( + input: string, + context: AIContext, + ): Promise<{ + intent: AIIntent; + confidence: AIConfidence; + error?: AIError; + }> { + try { + // Extract entities from the input + const entities = await this.entityExtractor.extract(input); + + // Classify the intent + const intent = await this.intentClassifier.classify(input, entities); + + // Analyze context relevance + const contextRelevance = await this.contextAnalyzer.analyze( + intent, + context, + ); + + // Calculate confidence scores + const confidence: AIConfidence = { + overall: + (intent.confidence + + entities.confidence + + contextRelevance.confidence) / + 3, + intent: intent.confidence, + entities: entities.confidence, + context: contextRelevance.confidence, + }; + + // Create structured intent + const structuredIntent: AIIntent = { + action: intent.action, + target: entities.primary_target, + parameters: { + ...entities.parameters, + ...intent.parameters, + context_parameters: contextRelevance.relevant_params, + }, + raw_input: input, + }; + + return { + intent: structuredIntent, + confidence, + }; + } catch (error: unknown) { + const errorMessage = + error instanceof Error ? error.message : "Unknown error occurred"; + return { + intent: { + action: "error", + target: "system", + parameters: {}, + raw_input: input, + }, + confidence: { + overall: 0, + intent: 0, + entities: 0, + context: 0, + }, + error: { + code: "NLP_PROCESSING_ERROR", + message: errorMessage, + suggestion: "Please try rephrasing your command", + recovery_options: [ + "Use simpler language", + "Break down the command into smaller parts", + "Specify the target device explicitly", + ], + context, + }, + }; + } + } + + async validateIntent( + intent: AIIntent, + confidence: AIConfidence, + threshold = 0.7, + ): Promise { + return ( + confidence.overall >= threshold && + confidence.intent >= threshold && + confidence.entities >= threshold && + confidence.context >= threshold + ); + } + + async suggestCorrections(input: string, error: AIError): Promise { + // Implement correction suggestions based on the error + const suggestions: string[] = []; + + if (error.code === "ENTITY_NOT_FOUND") { + suggestions.push( + "Try specifying the device name more clearly", + "Use the exact device name from your Home Assistant setup", + ); } - async processCommand( - input: string, - context: AIContext - ): Promise<{ - intent: AIIntent; - confidence: AIConfidence; - error?: AIError; - }> { - try { - // Extract entities from the input - const entities = await this.entityExtractor.extract(input); - - // Classify the intent - const intent = await this.intentClassifier.classify(input, entities); - - // Analyze context relevance - const contextRelevance = await this.contextAnalyzer.analyze(intent, context); - - // Calculate confidence scores - const confidence: AIConfidence = { - overall: (intent.confidence + entities.confidence + contextRelevance.confidence) / 3, - intent: intent.confidence, - entities: entities.confidence, - context: contextRelevance.confidence - }; - - // Create structured intent - const structuredIntent: AIIntent = { - action: intent.action, - target: entities.primary_target, - parameters: { - ...entities.parameters, - ...intent.parameters, - context_parameters: contextRelevance.relevant_params - }, - raw_input: input - }; - - return { - intent: structuredIntent, - confidence - }; - } catch (error: unknown) { - const errorMessage = error instanceof Error ? error.message : 'Unknown error occurred'; - return { - intent: { - action: 'error', - target: 'system', - parameters: {}, - raw_input: input - }, - confidence: { - overall: 0, - intent: 0, - entities: 0, - context: 0 - }, - error: { - code: 'NLP_PROCESSING_ERROR', - message: errorMessage, - suggestion: 'Please try rephrasing your command', - recovery_options: [ - 'Use simpler language', - 'Break down the command into smaller parts', - 'Specify the target device explicitly' - ], - context - } - }; - } + if (error.code === "AMBIGUOUS_INTENT") { + suggestions.push( + "Please specify what you want to do with the device", + 'Use action words like "turn on", "set", "adjust"', + ); } - async validateIntent( - intent: AIIntent, - confidence: AIConfidence, - threshold = 0.7 - ): Promise { - return ( - confidence.overall >= threshold && - confidence.intent >= threshold && - confidence.entities >= threshold && - confidence.context >= threshold - ); + if (error.code === "CONTEXT_MISMATCH") { + suggestions.push( + "Specify the location if referring to a device", + "Clarify which device you mean in the current context", + ); } - async suggestCorrections( - input: string, - error: AIError - ): Promise { - // Implement correction suggestions based on the error - const suggestions: string[] = []; - - if (error.code === 'ENTITY_NOT_FOUND') { - suggestions.push( - 'Try specifying the device name more clearly', - 'Use the exact device name from your Home Assistant setup' - ); - } - - if (error.code === 'AMBIGUOUS_INTENT') { - suggestions.push( - 'Please specify what you want to do with the device', - 'Use action words like "turn on", "set", "adjust"' - ); - } - - if (error.code === 'CONTEXT_MISMATCH') { - suggestions.push( - 'Specify the location if referring to a device', - 'Clarify which device you mean in the current context' - ); - } - - return suggestions; - } -} \ No newline at end of file + return suggestions; + } +} diff --git a/src/ai/templates/prompt-templates.ts b/src/ai/templates/prompt-templates.ts index d1943de..ca85a0d 100644 --- a/src/ai/templates/prompt-templates.ts +++ b/src/ai/templates/prompt-templates.ts @@ -1,135 +1,138 @@ -import { AIModel } from '../types/index.js'; +import { AIModel } from "../types/index.js"; interface PromptTemplate { - system: string; + system: string; + user: string; + examples: Array<{ user: string; - examples: Array<{ - user: string; - assistant: string; - }>; + assistant: string; + }>; } interface PromptVariables { - device_name?: string; - location?: string; - action?: string; - parameters?: Record; - context?: Record; - [key: string]: any; + device_name?: string; + location?: string; + action?: string; + parameters?: Record; + context?: Record; + [key: string]: any; } class PromptTemplates { - private templates: Record; + private templates: Record; - constructor() { - this.templates = { - [AIModel.CLAUDE]: { - system: `You are Claude, an AI assistant specialized in home automation control through natural language. + constructor() { + this.templates = { + [AIModel.CLAUDE]: { + system: `You are Claude, an AI assistant specialized in home automation control through natural language. Your role is to interpret user commands and translate them into specific device control actions. Always maintain context awareness and consider user preferences and patterns. Provide clear, concise responses and suggest relevant follow-up actions.`, - user: `Control the {device_name} in the {location} by {action} with parameters: {parameters}. + user: `Control the {device_name} in the {location} by {action} with parameters: {parameters}. Current context: {context}`, - examples: [ - { - user: "Turn on the living room lights", - assistant: "I'll turn on the lights in the living room. Would you like me to set a specific brightness level?" - }, - { - user: "Set the temperature to 72 degrees", - assistant: "I'll set the temperature to 72°F. I'll monitor the temperature and let you know when it reaches the target." - } - ] - }, - [AIModel.GPT4]: { - system: `You are a home automation assistant powered by GPT-4. + examples: [ + { + user: "Turn on the living room lights", + assistant: + "I'll turn on the lights in the living room. Would you like me to set a specific brightness level?", + }, + { + user: "Set the temperature to 72 degrees", + assistant: + "I'll set the temperature to 72°F. I'll monitor the temperature and let you know when it reaches the target.", + }, + ], + }, + [AIModel.GPT4]: { + system: `You are a home automation assistant powered by GPT-4. Focus on precise command interpretation and execution. Maintain high accuracy in device control and parameter settings. Provide feedback on action success and system state changes.`, - user: `Command: {action} {device_name} in {location} + user: `Command: {action} {device_name} in {location} Parameters: {parameters} Context: {context}`, - examples: [ - { - user: "Dim the bedroom lights to 50%", - assistant: "Setting bedroom light brightness to 50%. The change has been applied successfully." - }, - { - user: "Start the evening routine", - assistant: "Initiating evening routine: dimming lights, adjusting temperature, and enabling security system." - } - ] - }, - [AIModel.CUSTOM]: { - system: `Custom home automation assistant configuration. + examples: [ + { + user: "Dim the bedroom lights to 50%", + assistant: + "Setting bedroom light brightness to 50%. The change has been applied successfully.", + }, + { + user: "Start the evening routine", + assistant: + "Initiating evening routine: dimming lights, adjusting temperature, and enabling security system.", + }, + ], + }, + [AIModel.CUSTOM]: { + system: `Custom home automation assistant configuration. Adapt to user preferences and patterns. Learn from interactions and optimize responses. Provide detailed feedback and suggestions.`, - user: `Action requested: {action} + user: `Action requested: {action} Target device: {device_name} Location: {location} Parameters: {parameters} Current context: {context}`, - examples: [ - { - user: "Make it cooler in here", - assistant: "Based on your preferences, I'll lower the temperature by 2 degrees. Current temperature is 74°F, adjusting to 72°F." - }, - { - user: "Set up movie mode", - assistant: "Activating movie mode: dimming lights to 20%, closing blinds, setting TV input to HDMI 1, and adjusting sound system." - } - ] - } - }; + examples: [ + { + user: "Make it cooler in here", + assistant: + "Based on your preferences, I'll lower the temperature by 2 degrees. Current temperature is 74°F, adjusting to 72°F.", + }, + { + user: "Set up movie mode", + assistant: + "Activating movie mode: dimming lights to 20%, closing blinds, setting TV input to HDMI 1, and adjusting sound system.", + }, + ], + }, + }; + } + + getTemplate(model: AIModel): PromptTemplate { + return this.templates[model]; + } + + formatPrompt(model: AIModel, variables: PromptVariables): string { + const template = this.getTemplate(model); + let prompt = template.user; + + // Replace variables in the prompt + for (const [key, value] of Object.entries(variables)) { + const placeholder = `{${key}}`; + if (typeof value === "object") { + prompt = prompt.replace(placeholder, JSON.stringify(value)); + } else { + prompt = prompt.replace(placeholder, String(value)); + } } - getTemplate(model: AIModel): PromptTemplate { - return this.templates[model]; - } + return prompt; + } - formatPrompt(model: AIModel, variables: PromptVariables): string { - const template = this.getTemplate(model); - let prompt = template.user; + getSystemPrompt(model: AIModel): string { + return this.templates[model].system; + } - // Replace variables in the prompt - for (const [key, value] of Object.entries(variables)) { - const placeholder = `{${key}}`; - if (typeof value === 'object') { - prompt = prompt.replace(placeholder, JSON.stringify(value)); - } else { - prompt = prompt.replace(placeholder, String(value)); - } - } + getExamples(model: AIModel): Array<{ user: string; assistant: string }> { + return this.templates[model].examples; + } - return prompt; - } + addExample( + model: AIModel, + example: { user: string; assistant: string }, + ): void { + this.templates[model].examples.push(example); + } - getSystemPrompt(model: AIModel): string { - return this.templates[model].system; - } + updateSystemPrompt(model: AIModel, newPrompt: string): void { + this.templates[model].system = newPrompt; + } - getExamples(model: AIModel): Array<{ user: string; assistant: string }> { - return this.templates[model].examples; - } - - addExample( - model: AIModel, - example: { user: string; assistant: string } - ): void { - this.templates[model].examples.push(example); - } - - updateSystemPrompt(model: AIModel, newPrompt: string): void { - this.templates[model].system = newPrompt; - } - - createCustomTemplate( - model: AIModel.CUSTOM, - template: PromptTemplate - ): void { - this.templates[model] = template; - } + createCustomTemplate(model: AIModel.CUSTOM, template: PromptTemplate): void { + this.templates[model] = template; + } } -export default new PromptTemplates(); \ No newline at end of file +export default new PromptTemplates(); diff --git a/src/ai/types/index.ts b/src/ai/types/index.ts index c246162..eadf124 100644 --- a/src/ai/types/index.ts +++ b/src/ai/types/index.ts @@ -1,123 +1,128 @@ -import { z } from 'zod'; +import { z } from "zod"; // AI Model Types export enum AIModel { - CLAUDE = 'claude', - GPT4 = 'gpt4', - CUSTOM = 'custom' + CLAUDE = "claude", + GPT4 = "gpt4", + CUSTOM = "custom", } // AI Confidence Level export interface AIConfidence { - overall: number; - intent: number; - entities: number; - context: number; + overall: number; + intent: number; + entities: number; + context: number; } // AI Intent export interface AIIntent { - action: string; - target: string; - parameters: Record; - raw_input: string; + action: string; + target: string; + parameters: Record; + raw_input: string; } // AI Context export interface AIContext { - user_id: string; - session_id: string; - timestamp: string; - location: string; - previous_actions: AIIntent[]; - environment_state: Record; + user_id: string; + session_id: string; + timestamp: string; + location: string; + previous_actions: AIIntent[]; + environment_state: Record; } // AI Response export interface AIResponse { - natural_language: string; - structured_data: { - success: boolean; - action_taken: string; - entities_affected: string[]; - state_changes: Record; - }; - next_suggestions: string[]; - confidence: AIConfidence; - context: AIContext; + natural_language: string; + structured_data: { + success: boolean; + action_taken: string; + entities_affected: string[]; + state_changes: Record; + }; + next_suggestions: string[]; + confidence: AIConfidence; + context: AIContext; } // AI Error export interface AIError { - code: string; - message: string; - suggestion: string; - recovery_options: string[]; - context: AIContext; + code: string; + message: string; + suggestion: string; + recovery_options: string[]; + context: AIContext; } // Rate Limiting export interface AIRateLimit { - requests_per_minute: number; - requests_per_hour: number; - concurrent_requests: number; - model_specific_limits: Record; + requests_per_minute: number; + requests_per_hour: number; + concurrent_requests: number; + model_specific_limits: Record< + AIModel, + { + requests_per_minute: number; + requests_per_hour: number; + } + >; } // Zod Schemas export const AIConfidenceSchema = z.object({ - overall: z.number().min(0).max(1), - intent: z.number().min(0).max(1), - entities: z.number().min(0).max(1), - context: z.number().min(0).max(1) + overall: z.number().min(0).max(1), + intent: z.number().min(0).max(1), + entities: z.number().min(0).max(1), + context: z.number().min(0).max(1), }); export const AIIntentSchema = z.object({ - action: z.string(), - target: z.string(), - parameters: z.record(z.any()), - raw_input: z.string() + action: z.string(), + target: z.string(), + parameters: z.record(z.any()), + raw_input: z.string(), }); export const AIContextSchema = z.object({ - user_id: z.string(), - session_id: z.string(), - timestamp: z.string(), - location: z.string(), - previous_actions: z.array(AIIntentSchema), - environment_state: z.record(z.any()) + user_id: z.string(), + session_id: z.string(), + timestamp: z.string(), + location: z.string(), + previous_actions: z.array(AIIntentSchema), + environment_state: z.record(z.any()), }); export const AIResponseSchema = z.object({ - natural_language: z.string(), - structured_data: z.object({ - success: z.boolean(), - action_taken: z.string(), - entities_affected: z.array(z.string()), - state_changes: z.record(z.any()) - }), - next_suggestions: z.array(z.string()), - confidence: AIConfidenceSchema, - context: AIContextSchema + natural_language: z.string(), + structured_data: z.object({ + success: z.boolean(), + action_taken: z.string(), + entities_affected: z.array(z.string()), + state_changes: z.record(z.any()), + }), + next_suggestions: z.array(z.string()), + confidence: AIConfidenceSchema, + context: AIContextSchema, }); export const AIErrorSchema = z.object({ - code: z.string(), - message: z.string(), - suggestion: z.string(), - recovery_options: z.array(z.string()), - context: AIContextSchema + code: z.string(), + message: z.string(), + suggestion: z.string(), + recovery_options: z.array(z.string()), + context: AIContextSchema, }); export const AIRateLimitSchema = z.object({ - requests_per_minute: z.number(), - requests_per_hour: z.number(), - concurrent_requests: z.number(), - model_specific_limits: z.record(z.object({ - requests_per_minute: z.number(), - requests_per_hour: z.number() - })) -}); \ No newline at end of file + requests_per_minute: z.number(), + requests_per_hour: z.number(), + concurrent_requests: z.number(), + model_specific_limits: z.record( + z.object({ + requests_per_minute: z.number(), + requests_per_hour: z.number(), + }), + ), +}); diff --git a/src/api/routes.ts b/src/api/routes.ts index 7ab2170..5defc13 100644 --- a/src/api/routes.ts +++ b/src/api/routes.ts @@ -1,180 +1,191 @@ -import { Router } from 'express'; -import { MCP_SCHEMA } from '../mcp/schema.js'; -import { middleware } from '../middleware/index.js'; -import { sseManager } from '../sse/index.js'; -import { v4 as uuidv4 } from 'uuid'; -import { TokenManager } from '../security/index.js'; -import { tools } from '../tools/index.js'; -import { Tool } from '../interfaces/index.js'; +import { Router } from "express"; +import { MCP_SCHEMA } from "../mcp/schema.js"; +import { middleware } from "../middleware/index.js"; +import { sseManager } from "../sse/index.js"; +import { v4 as uuidv4 } from "uuid"; +import { TokenManager } from "../security/index.js"; +import { tools } from "../tools/index.js"; +import { Tool } from "../interfaces/index.js"; const router = Router(); // MCP schema endpoint - no auth required as it's just the schema -router.get('/mcp', (_req, res) => { - res.json(MCP_SCHEMA); +router.get("/mcp", (_req, res) => { + res.json(MCP_SCHEMA); }); // MCP execute endpoint - requires authentication -router.post('/mcp/execute', middleware.authenticate, async (req, res) => { - try { - const { tool: toolName, parameters } = req.body; +router.post("/mcp/execute", middleware.authenticate, async (req, res) => { + try { + const { tool: toolName, parameters } = req.body; - // Find the requested tool - const tool = tools.find((t: Tool) => t.name === toolName); - if (!tool) { - return res.status(404).json({ - success: false, - message: `Tool '${toolName}' not found` - }); - } - - // Execute the tool with the provided parameters - const result = await tool.execute(parameters); - res.json(result); - } catch (error) { - res.status(500).json({ - success: false, - message: error instanceof Error ? error.message : 'Unknown error occurred' - }); + // Find the requested tool + const tool = tools.find((t: Tool) => t.name === toolName); + if (!tool) { + return res.status(404).json({ + success: false, + message: `Tool '${toolName}' not found`, + }); } + + // Execute the tool with the provided parameters + const result = await tool.execute(parameters); + res.json(result); + } catch (error) { + res.status(500).json({ + success: false, + message: + error instanceof Error ? error.message : "Unknown error occurred", + }); + } }); // Health check endpoint -router.get('/health', (_req, res) => { - res.json({ - status: 'ok', - timestamp: new Date().toISOString(), - version: '0.1.0' - }); +router.get("/health", (_req, res) => { + res.json({ + status: "ok", + timestamp: new Date().toISOString(), + version: "0.1.0", + }); }); // List devices endpoint -router.get('/list_devices', middleware.authenticate, async (req, res) => { - try { - const tool = tools.find((t: Tool) => t.name === 'list_devices'); - if (!tool) { - return res.status(404).json({ - success: false, - message: 'Tool not found' - }); - } - - const result = await tool.execute({ token: req.headers.authorization?.replace('Bearer ', '') }); - res.json(result); - } catch (error) { - res.status(500).json({ - success: false, - message: error instanceof Error ? error.message : 'Unknown error occurred' - }); +router.get("/list_devices", middleware.authenticate, async (req, res) => { + try { + const tool = tools.find((t: Tool) => t.name === "list_devices"); + if (!tool) { + return res.status(404).json({ + success: false, + message: "Tool not found", + }); } + + const result = await tool.execute({ + token: req.headers.authorization?.replace("Bearer ", ""), + }); + res.json(result); + } catch (error) { + res.status(500).json({ + success: false, + message: + error instanceof Error ? error.message : "Unknown error occurred", + }); + } }); // Device control endpoint -router.post('/control', middleware.authenticate, async (req, res) => { - try { - const tool = tools.find((t: Tool) => t.name === 'control'); - if (!tool) { - return res.status(404).json({ - success: false, - message: 'Tool not found' - }); - } - - const result = await tool.execute({ - ...req.body, - token: req.headers.authorization?.replace('Bearer ', '') - }); - res.json(result); - } catch (error) { - res.status(500).json({ - success: false, - message: error instanceof Error ? error.message : 'Unknown error occurred' - }); +router.post("/control", middleware.authenticate, async (req, res) => { + try { + const tool = tools.find((t: Tool) => t.name === "control"); + if (!tool) { + return res.status(404).json({ + success: false, + message: "Tool not found", + }); } + + const result = await tool.execute({ + ...req.body, + token: req.headers.authorization?.replace("Bearer ", ""), + }); + res.json(result); + } catch (error) { + res.status(500).json({ + success: false, + message: + error instanceof Error ? error.message : "Unknown error occurred", + }); + } }); // SSE endpoints -router.get('/subscribe_events', middleware.wsRateLimiter, (req, res) => { - try { - // Get token from query parameter - const token = req.query.token?.toString(); +router.get("/subscribe_events", middleware.wsRateLimiter, (req, res) => { + try { + // Get token from query parameter + const token = req.query.token?.toString(); - if (!token || !TokenManager.validateToken(token)) { - return res.status(401).json({ - success: false, - message: 'Unauthorized - Invalid token' - }); - } - - // Set SSE headers - res.writeHead(200, { - 'Content-Type': 'text/event-stream', - 'Cache-Control': 'no-cache', - 'Connection': 'keep-alive', - 'Access-Control-Allow-Origin': '*' - }); - - // Send initial connection message - res.write(`data: ${JSON.stringify({ - type: 'connection', - status: 'connected', - timestamp: new Date().toISOString() - })}\n\n`); - - const clientId = uuidv4(); - const client = { - id: clientId, - send: (data: string) => { - res.write(`data: ${data}\n\n`); - } - }; - - // Add client to SSE manager - const sseClient = sseManager.addClient(client, token); - if (!sseClient || !sseClient.authenticated) { - res.write(`data: ${JSON.stringify({ - type: 'error', - message: sseClient ? 'Authentication failed' : 'Maximum client limit reached', - timestamp: new Date().toISOString() - })}\n\n`); - return res.end(); - } - - // Subscribe to events if specified - const events = req.query.events?.toString().split(',').filter(Boolean); - if (events?.length) { - events.forEach(event => sseManager.subscribeToEvent(clientId, event)); - } - - // Subscribe to entity if specified - const entityId = req.query.entity_id?.toString(); - if (entityId) { - sseManager.subscribeToEntity(clientId, entityId); - } - - // Subscribe to domain if specified - const domain = req.query.domain?.toString(); - if (domain) { - sseManager.subscribeToDomain(clientId, domain); - } - - // Handle client disconnect - req.on('close', () => { - sseManager.removeClient(clientId); - }); - - } catch (error) { - res.status(500).json({ - success: false, - message: error instanceof Error ? error.message : 'Unknown error occurred' - }); + if (!token || !TokenManager.validateToken(token)) { + return res.status(401).json({ + success: false, + message: "Unauthorized - Invalid token", + }); } + + // Set SSE headers + res.writeHead(200, { + "Content-Type": "text/event-stream", + "Cache-Control": "no-cache", + Connection: "keep-alive", + "Access-Control-Allow-Origin": "*", + }); + + // Send initial connection message + res.write( + `data: ${JSON.stringify({ + type: "connection", + status: "connected", + timestamp: new Date().toISOString(), + })}\n\n`, + ); + + const clientId = uuidv4(); + const client = { + id: clientId, + send: (data: string) => { + res.write(`data: ${data}\n\n`); + }, + }; + + // Add client to SSE manager + const sseClient = sseManager.addClient(client, token); + if (!sseClient || !sseClient.authenticated) { + res.write( + `data: ${JSON.stringify({ + type: "error", + message: sseClient + ? "Authentication failed" + : "Maximum client limit reached", + timestamp: new Date().toISOString(), + })}\n\n`, + ); + return res.end(); + } + + // Subscribe to events if specified + const events = req.query.events?.toString().split(",").filter(Boolean); + if (events?.length) { + events.forEach((event) => sseManager.subscribeToEvent(clientId, event)); + } + + // Subscribe to entity if specified + const entityId = req.query.entity_id?.toString(); + if (entityId) { + sseManager.subscribeToEntity(clientId, entityId); + } + + // Subscribe to domain if specified + const domain = req.query.domain?.toString(); + if (domain) { + sseManager.subscribeToDomain(clientId, domain); + } + + // Handle client disconnect + req.on("close", () => { + sseManager.removeClient(clientId); + }); + } catch (error) { + res.status(500).json({ + success: false, + message: + error instanceof Error ? error.message : "Unknown error occurred", + }); + } }); /** * SSE Statistics Endpoint * Returns detailed statistics about SSE connections and subscriptions. - * + * * @route GET /get_sse_stats * @authentication Required - Bearer token * @returns {Object} Statistics object containing: @@ -185,21 +196,22 @@ router.get('/subscribe_events', middleware.wsRateLimiter, (req, res) => { * - total_entities_tracked: Number of entities being tracked * - subscriptions: Lists of entity, event, and domain subscriptions */ -router.get('/get_sse_stats', middleware.authenticate, (_req, res) => { - try { - const stats = sseManager.getStatistics(); - res.json({ - success: true, - timestamp: new Date().toISOString(), - data: stats - }); - } catch (error) { - res.status(500).json({ - success: false, - message: error instanceof Error ? error.message : 'Unknown error occurred', - timestamp: new Date().toISOString() - }); - } +router.get("/get_sse_stats", middleware.authenticate, (_req, res) => { + try { + const stats = sseManager.getStatistics(); + res.json({ + success: true, + timestamp: new Date().toISOString(), + data: stats, + }); + } catch (error) { + res.status(500).json({ + success: false, + message: + error instanceof Error ? error.message : "Unknown error occurred", + timestamp: new Date().toISOString(), + }); + } }); -export default router; \ No newline at end of file +export default router; diff --git a/src/commands.ts b/src/commands.ts new file mode 100644 index 0000000..4592689 --- /dev/null +++ b/src/commands.ts @@ -0,0 +1,27 @@ +// Common commands that work with most entities +export const commonCommands = ["turn_on", "turn_off", "toggle"] as const; + +// Commands specific to cover entities +export const coverCommands = [ + ...commonCommands, + "open", + "close", + "stop", + "set_position", + "set_tilt_position", +] as const; + +// Commands specific to climate entities +export const climateCommands = [ + ...commonCommands, + "set_temperature", + "set_hvac_mode", + "set_fan_mode", + "set_humidity", +] as const; + +// Types for command validation +export type CommonCommand = (typeof commonCommands)[number]; +export type CoverCommand = (typeof coverCommands)[number]; +export type ClimateCommand = (typeof climateCommands)[number]; +export type Command = CommonCommand | CoverCommand | ClimateCommand; diff --git a/src/config/__tests__/test.config.ts b/src/config/__tests__/test.config.ts index 3ff03ff..a6c164e 100644 --- a/src/config/__tests__/test.config.ts +++ b/src/config/__tests__/test.config.ts @@ -1,135 +1,162 @@ -import { z } from 'zod'; +import { z } from "zod"; // Test configuration schema const testConfigSchema = z.object({ - // Test Environment - TEST_PORT: z.number().default(3001), - TEST_HOST: z.string().default('http://localhost'), - TEST_WEBSOCKET_PORT: z.number().default(3002), + // Test Environment + TEST_PORT: z.number().default(3001), + TEST_HOST: z.string().default("http://localhost"), + TEST_WEBSOCKET_PORT: z.number().default(3002), - // Mock Authentication - TEST_JWT_SECRET: z.string().default('test_jwt_secret_key_that_is_at_least_32_chars'), - TEST_TOKEN: z.string().default('test_token_that_is_at_least_32_chars_long'), - TEST_INVALID_TOKEN: z.string().default('invalid_token'), + // Mock Authentication + TEST_JWT_SECRET: z + .string() + .default("test_jwt_secret_key_that_is_at_least_32_chars"), + TEST_TOKEN: z.string().default("test_token_that_is_at_least_32_chars_long"), + TEST_INVALID_TOKEN: z.string().default("invalid_token"), - // Mock Client Settings - TEST_CLIENT_IP: z.string().default('127.0.0.1'), - TEST_MAX_CLIENTS: z.number().default(10), - TEST_PING_INTERVAL: z.number().default(100), - TEST_CLEANUP_INTERVAL: z.number().default(200), - TEST_MAX_CONNECTION_AGE: z.number().default(1000), + // Mock Client Settings + TEST_CLIENT_IP: z.string().default("127.0.0.1"), + TEST_MAX_CLIENTS: z.number().default(10), + TEST_PING_INTERVAL: z.number().default(100), + TEST_CLEANUP_INTERVAL: z.number().default(200), + TEST_MAX_CONNECTION_AGE: z.number().default(1000), - // Mock Rate Limiting - TEST_RATE_LIMIT_WINDOW: z.number().default(60000), // 1 minute - TEST_RATE_LIMIT_MAX_REQUESTS: z.number().default(100), - TEST_RATE_LIMIT_WEBSOCKET: z.number().default(1000), + // Mock Rate Limiting + TEST_RATE_LIMIT_WINDOW: z.number().default(60000), // 1 minute + TEST_RATE_LIMIT_MAX_REQUESTS: z.number().default(100), + TEST_RATE_LIMIT_WEBSOCKET: z.number().default(1000), - // Mock Events - TEST_EVENT_TYPES: z.array(z.string()).default([ - 'state_changed', - 'automation_triggered', - 'script_executed', - 'service_called' + // Mock Events + TEST_EVENT_TYPES: z + .array(z.string()) + .default([ + "state_changed", + "automation_triggered", + "script_executed", + "service_called", ]), - // Mock Entities - TEST_ENTITIES: z.array(z.object({ + // Mock Entities + TEST_ENTITIES: z + .array( + z.object({ entity_id: z.string(), state: z.string(), attributes: z.record(z.any()), last_changed: z.string(), - last_updated: z.string() - })).default([ - { - entity_id: 'light.test_light', - state: 'on', - attributes: { - brightness: 255, - color_temp: 400 - }, - last_changed: new Date().toISOString(), - last_updated: new Date().toISOString() + last_updated: z.string(), + }), + ) + .default([ + { + entity_id: "light.test_light", + state: "on", + attributes: { + brightness: 255, + color_temp: 400, }, - { - entity_id: 'switch.test_switch', - state: 'off', - attributes: {}, - last_changed: new Date().toISOString(), - last_updated: new Date().toISOString() - } + last_changed: new Date().toISOString(), + last_updated: new Date().toISOString(), + }, + { + entity_id: "switch.test_switch", + state: "off", + attributes: {}, + last_changed: new Date().toISOString(), + last_updated: new Date().toISOString(), + }, ]), - // Mock Services - TEST_SERVICES: z.array(z.object({ + // Mock Services + TEST_SERVICES: z + .array( + z.object({ domain: z.string(), service: z.string(), - data: z.record(z.any()) - })).default([ - { - domain: 'light', - service: 'turn_on', - data: { - entity_id: 'light.test_light', - brightness: 255 - } + data: z.record(z.any()), + }), + ) + .default([ + { + domain: "light", + service: "turn_on", + data: { + entity_id: "light.test_light", + brightness: 255, }, - { - domain: 'switch', - service: 'turn_off', - data: { - entity_id: 'switch.test_switch' - } - } + }, + { + domain: "switch", + service: "turn_off", + data: { + entity_id: "switch.test_switch", + }, + }, ]), - // Mock Error Scenarios - TEST_ERROR_SCENARIOS: z.array(z.object({ + // Mock Error Scenarios + TEST_ERROR_SCENARIOS: z + .array( + z.object({ type: z.string(), message: z.string(), - code: z.number() - })).default([ - { - type: 'authentication_error', - message: 'Invalid token', - code: 401 - }, - { - type: 'rate_limit_error', - message: 'Too many requests', - code: 429 - }, - { - type: 'validation_error', - message: 'Invalid request body', - code: 400 - } - ]) + code: z.number(), + }), + ) + .default([ + { + type: "authentication_error", + message: "Invalid token", + code: 401, + }, + { + type: "rate_limit_error", + message: "Too many requests", + code: 429, + }, + { + type: "validation_error", + message: "Invalid request body", + code: 400, + }, + ]), }); // Parse environment variables or use defaults const parseTestConfig = () => { - const config = { - TEST_PORT: parseInt(process.env.TEST_PORT || '3001'), - TEST_HOST: process.env.TEST_HOST || 'http://localhost', - TEST_WEBSOCKET_PORT: parseInt(process.env.TEST_WEBSOCKET_PORT || '3002'), - TEST_JWT_SECRET: process.env.TEST_JWT_SECRET || 'test_jwt_secret_key_that_is_at_least_32_chars', - TEST_TOKEN: process.env.TEST_TOKEN || 'test_token_that_is_at_least_32_chars_long', - TEST_INVALID_TOKEN: process.env.TEST_INVALID_TOKEN || 'invalid_token', - TEST_CLIENT_IP: process.env.TEST_CLIENT_IP || '127.0.0.1', - TEST_MAX_CLIENTS: parseInt(process.env.TEST_MAX_CLIENTS || '10'), - TEST_PING_INTERVAL: parseInt(process.env.TEST_PING_INTERVAL || '100'), - TEST_CLEANUP_INTERVAL: parseInt(process.env.TEST_CLEANUP_INTERVAL || '200'), - TEST_MAX_CONNECTION_AGE: parseInt(process.env.TEST_MAX_CONNECTION_AGE || '1000'), - TEST_RATE_LIMIT_WINDOW: parseInt(process.env.TEST_RATE_LIMIT_WINDOW || '60000'), - TEST_RATE_LIMIT_MAX_REQUESTS: parseInt(process.env.TEST_RATE_LIMIT_MAX_REQUESTS || '100'), - TEST_RATE_LIMIT_WEBSOCKET: parseInt(process.env.TEST_RATE_LIMIT_WEBSOCKET || '1000'), - }; + const config = { + TEST_PORT: parseInt(process.env.TEST_PORT || "3001"), + TEST_HOST: process.env.TEST_HOST || "http://localhost", + TEST_WEBSOCKET_PORT: parseInt(process.env.TEST_WEBSOCKET_PORT || "3002"), + TEST_JWT_SECRET: + process.env.TEST_JWT_SECRET || + "test_jwt_secret_key_that_is_at_least_32_chars", + TEST_TOKEN: + process.env.TEST_TOKEN || "test_token_that_is_at_least_32_chars_long", + TEST_INVALID_TOKEN: process.env.TEST_INVALID_TOKEN || "invalid_token", + TEST_CLIENT_IP: process.env.TEST_CLIENT_IP || "127.0.0.1", + TEST_MAX_CLIENTS: parseInt(process.env.TEST_MAX_CLIENTS || "10"), + TEST_PING_INTERVAL: parseInt(process.env.TEST_PING_INTERVAL || "100"), + TEST_CLEANUP_INTERVAL: parseInt(process.env.TEST_CLEANUP_INTERVAL || "200"), + TEST_MAX_CONNECTION_AGE: parseInt( + process.env.TEST_MAX_CONNECTION_AGE || "1000", + ), + TEST_RATE_LIMIT_WINDOW: parseInt( + process.env.TEST_RATE_LIMIT_WINDOW || "60000", + ), + TEST_RATE_LIMIT_MAX_REQUESTS: parseInt( + process.env.TEST_RATE_LIMIT_MAX_REQUESTS || "100", + ), + TEST_RATE_LIMIT_WEBSOCKET: parseInt( + process.env.TEST_RATE_LIMIT_WEBSOCKET || "1000", + ), + }; - return testConfigSchema.parse(config); + return testConfigSchema.parse(config); }; // Export the validated test configuration export const TEST_CONFIG = parseTestConfig(); // Export types -export type TestConfig = z.infer; \ No newline at end of file +export type TestConfig = z.infer; diff --git a/src/config/app.config.ts b/src/config/app.config.ts index 2b3c42d..dc9ce64 100644 --- a/src/config/app.config.ts +++ b/src/config/app.config.ts @@ -1,5 +1,6 @@ -import { config } from 'dotenv'; -import { resolve } from 'path'; +import { config } from "dotenv"; +import { resolve } from "path"; +import { z } from "zod"; /** * Load environment variables based on NODE_ENV @@ -7,11 +8,12 @@ import { resolve } from 'path'; * Test: .env.test * Production: .env */ -const envFile = process.env.NODE_ENV === 'production' - ? '.env' - : process.env.NODE_ENV === 'test' - ? '.env.test' - : '.env.development'; +const envFile = + process.env.NODE_ENV === "production" + ? ".env" + : process.env.NODE_ENV === "test" + ? ".env.test" + : ".env.development"; console.log(`Loading environment from ${envFile}`); config({ path: resolve(process.cwd(), envFile) }); @@ -20,66 +22,95 @@ config({ path: resolve(process.cwd(), envFile) }); * Application configuration object * Contains all configuration settings for the application */ -export const APP_CONFIG = { - /** Server Configuration */ - PORT: process.env.PORT || 3000, - NODE_ENV: process.env.NODE_ENV || 'development', +export const AppConfigSchema = z.object({ + /** Server Configuration */ + PORT: z.number().default(4000), + NODE_ENV: z + .enum(["development", "production", "test"]) + .default("development"), - /** Home Assistant Configuration */ - HASS_HOST: process.env.HASS_HOST || 'http://192.168.178.63:8123', - HASS_TOKEN: process.env.HASS_TOKEN, + /** Home Assistant Configuration */ + HASS_HOST: z.string().default("http://192.168.178.63:8123"), + HASS_TOKEN: z.string().optional(), - /** Security Configuration */ - JWT_SECRET: process.env.JWT_SECRET || 'your-secret-key', - RATE_LIMIT: { - /** Time window for rate limiting in milliseconds */ - windowMs: 15 * 60 * 1000, // 15 minutes - /** Maximum number of requests per window */ - max: 100 // limit each IP to 100 requests per windowMs - }, + /** Security Configuration */ + JWT_SECRET: z.string().default("your-secret-key"), + RATE_LIMIT: z.object({ + /** Time window for rate limiting in milliseconds */ + windowMs: z.number().default(15 * 60 * 1000), // 15 minutes + /** Maximum number of requests per window */ + max: z.number().default(100), // limit each IP to 100 requests per windowMs + }), - /** Server-Sent Events Configuration */ - SSE: { - /** Maximum number of concurrent SSE clients */ - MAX_CLIENTS: 1000, - /** Ping interval in milliseconds to keep connections alive */ - PING_INTERVAL: 30000 // 30 seconds - }, + /** Server-Sent Events Configuration */ + SSE: z.object({ + /** Maximum number of concurrent SSE clients */ + MAX_CLIENTS: z.number().default(1000), + /** Ping interval in milliseconds to keep connections alive */ + PING_INTERVAL: z.number().default(30000), // 30 seconds + }), - /** Logging Configuration */ - LOGGING: { - /** Log level (error, warn, info, http, debug) */ - LEVEL: process.env.LOG_LEVEL || 'info', - /** Directory for log files */ - DIR: process.env.LOG_DIR || 'logs', - /** Maximum log file size before rotation */ - MAX_SIZE: process.env.LOG_MAX_SIZE || '20m', - /** Maximum number of days to keep log files */ - MAX_DAYS: process.env.LOG_MAX_DAYS || '14d', - /** Whether to compress rotated logs */ - COMPRESS: process.env.LOG_COMPRESS === 'true', - /** Format for timestamps in logs */ - TIMESTAMP_FORMAT: 'YYYY-MM-DD HH:mm:ss:ms', - /** Whether to include request logging */ - LOG_REQUESTS: process.env.LOG_REQUESTS === 'true', - }, + /** Logging Configuration */ + LOGGING: z.object({ + /** Log level (error, warn, info, http, debug) */ + LEVEL: z.enum(["error", "warn", "info", "debug", "trace"]).default("info"), + /** Directory for log files */ + DIR: z.string().default("logs"), + /** Maximum log file size before rotation */ + MAX_SIZE: z.string().default("20m"), + /** Maximum number of days to keep log files */ + MAX_DAYS: z.string().default("14d"), + /** Whether to compress rotated logs */ + COMPRESS: z.boolean().default(false), + /** Format for timestamps in logs */ + TIMESTAMP_FORMAT: z.string().default("YYYY-MM-DD HH:mm:ss:ms"), + /** Whether to include request logging */ + LOG_REQUESTS: z.boolean().default(false), + }), - /** Application Version */ - VERSION: '0.1.0' -} as const; + /** Application Version */ + VERSION: z.string().default("0.1.0"), +}); /** Type definition for the configuration object */ -export type AppConfig = typeof APP_CONFIG; +export type AppConfig = z.infer; /** Required environment variables that must be set */ -const requiredEnvVars = ['HASS_TOKEN'] as const; +const requiredEnvVars = ["HASS_TOKEN"] as const; /** * Validate that all required environment variables are set * Throws an error if any required variable is missing */ for (const envVar of requiredEnvVars) { - if (!process.env[envVar]) { - throw new Error(`Missing required environment variable: ${envVar}`); - } -} \ No newline at end of file + if (!process.env[envVar]) { + throw new Error(`Missing required environment variable: ${envVar}`); + } +} + +// Load and validate configuration +export const APP_CONFIG = AppConfigSchema.parse({ + PORT: process.env.PORT || 4000, + NODE_ENV: process.env.NODE_ENV || "development", + HASS_HOST: process.env.HASS_HOST || "http://192.168.178.63:8123", + HASS_TOKEN: process.env.HASS_TOKEN, + JWT_SECRET: process.env.JWT_SECRET || "your-secret-key", + RATE_LIMIT: { + windowMs: 15 * 60 * 1000, // 15 minutes + max: 100, // limit each IP to 100 requests per windowMs + }, + SSE: { + MAX_CLIENTS: 1000, + PING_INTERVAL: 30000, // 30 seconds + }, + LOGGING: { + LEVEL: process.env.LOG_LEVEL || "info", + DIR: process.env.LOG_DIR || "logs", + MAX_SIZE: process.env.LOG_MAX_SIZE || "20m", + MAX_DAYS: process.env.LOG_MAX_DAYS || "14d", + COMPRESS: process.env.LOG_COMPRESS === "true", + TIMESTAMP_FORMAT: "YYYY-MM-DD HH:mm:ss:ms", + LOG_REQUESTS: process.env.LOG_REQUESTS === "true", + }, + VERSION: "0.1.0", +}); diff --git a/src/config/boilerplate.config.ts b/src/config/boilerplate.config.ts new file mode 100644 index 0000000..e1c9cda --- /dev/null +++ b/src/config/boilerplate.config.ts @@ -0,0 +1,35 @@ +export const BOILERPLATE_CONFIG = { + configuration: { + LOG_LEVEL: { + type: "string" as const, + default: "debug", + description: "Logging level", + enum: ["error", "warn", "info", "debug", "trace"], + }, + CACHE_DIRECTORY: { + type: "string" as const, + default: ".cache", + description: "Directory for cache files", + }, + CONFIG_DIRECTORY: { + type: "string" as const, + default: ".config", + description: "Directory for configuration files", + }, + DATA_DIRECTORY: { + type: "string" as const, + default: ".data", + description: "Directory for data files", + }, + }, + internal: { + boilerplate: { + configuration: { + LOG_LEVEL: "debug", + CACHE_DIRECTORY: ".cache", + CONFIG_DIRECTORY: ".config", + DATA_DIRECTORY: ".data", + }, + }, + }, +}; diff --git a/src/config/hass.config.ts b/src/config/hass.config.ts index 66c4f63..e1c6867 100644 --- a/src/config/hass.config.ts +++ b/src/config/hass.config.ts @@ -1,11 +1,50 @@ -import dotenv from 'dotenv'; +import { config } from "dotenv"; +import { resolve } from "path"; -// Load environment variables -dotenv.config(); +// Load environment variables based on NODE_ENV +const envFile = + process.env.NODE_ENV === "production" + ? ".env" + : process.env.NODE_ENV === "test" + ? ".env.test" + : ".env.development"; + +config({ path: resolve(process.cwd(), envFile) }); export const HASS_CONFIG = { - BASE_URL: process.env.HASS_HOST || 'http://homeassistant.local:8123', - TOKEN: process.env.HASS_TOKEN || '', - SOCKET_URL: process.env.HASS_SOCKET_URL || '', - SOCKET_TOKEN: process.env.HASS_TOKEN || '', -}; \ No newline at end of file + // Base configuration + BASE_URL: process.env.HASS_HOST || "http://localhost:8123", + TOKEN: process.env.HASS_TOKEN || "", + SOCKET_URL: process.env.HASS_WS_URL || "ws://localhost:8123/api/websocket", + SOCKET_TOKEN: process.env.HASS_TOKEN || "", + + // Boilerplate configuration + BOILERPLATE: { + CACHE_DIRECTORY: ".cache", + CONFIG_DIRECTORY: ".config", + DATA_DIRECTORY: ".data", + LOG_LEVEL: "debug", + ENVIRONMENT: process.env.NODE_ENV || "development", + }, + + // Application configuration + APP_NAME: "homeassistant-mcp", + APP_VERSION: "1.0.0", + + // API configuration + API_VERSION: "1.0.0", + API_PREFIX: "/api", + + // Security configuration + RATE_LIMIT: { + WINDOW_MS: 15 * 60 * 1000, // 15 minutes + MAX_REQUESTS: 100, + }, + + // WebSocket configuration + WS_CONFIG: { + AUTO_RECONNECT: true, + MAX_RECONNECT_ATTEMPTS: 3, + RECONNECT_DELAY: 1000, + }, +}; diff --git a/src/config/index.ts b/src/config/index.ts index 404b143..3d449db 100644 --- a/src/config/index.ts +++ b/src/config/index.ts @@ -1,77 +1,86 @@ -import { config } from 'dotenv'; -import { resolve } from 'path'; +import { config } from "dotenv"; +import { resolve } from "path"; // Load environment variables based on NODE_ENV -const envFile = process.env.NODE_ENV === 'production' - ? '.env' - : process.env.NODE_ENV === 'test' - ? '.env.test' - : '.env.development'; +const envFile = + process.env.NODE_ENV === "production" + ? ".env" + : process.env.NODE_ENV === "test" + ? ".env.test" + : ".env.development"; console.log(`Loading environment from ${envFile}`); config({ path: resolve(process.cwd(), envFile) }); // Home Assistant Configuration export const HASS_CONFIG = { - HOST: process.env.HASS_HOST || 'http://homeassistant.local:8123', - TOKEN: process.env.HASS_TOKEN, - SOCKET_URL: process.env.HASS_SOCKET_URL || 'ws://homeassistant.local:8123/api/websocket', - BASE_URL: process.env.HASS_HOST || 'http://homeassistant.local:8123', - SOCKET_TOKEN: process.env.HASS_TOKEN + HOST: process.env.HASS_HOST || "http://homeassistant.local:8123", + TOKEN: process.env.HASS_TOKEN, + SOCKET_URL: + process.env.HASS_SOCKET_URL || + "ws://homeassistant.local:8123/api/websocket", + BASE_URL: process.env.HASS_HOST || "http://homeassistant.local:8123", + SOCKET_TOKEN: process.env.HASS_TOKEN, }; // Server Configuration export const SERVER_CONFIG = { - PORT: parseInt(process.env.PORT || '3000', 10), - NODE_ENV: process.env.NODE_ENV || 'development', - DEBUG: process.env.DEBUG === 'true', - LOG_LEVEL: process.env.LOG_LEVEL || 'info' + PORT: parseInt(process.env.PORT || "3000", 10), + NODE_ENV: process.env.NODE_ENV || "development", + DEBUG: process.env.DEBUG === "true", + LOG_LEVEL: process.env.LOG_LEVEL || "info", }; // AI Configuration export const AI_CONFIG = { - PROCESSOR_TYPE: process.env.PROCESSOR_TYPE || 'claude', - OPENAI_API_KEY: process.env.OPENAI_API_KEY + PROCESSOR_TYPE: process.env.PROCESSOR_TYPE || "claude", + OPENAI_API_KEY: process.env.OPENAI_API_KEY, }; // Rate Limiting Configuration export const RATE_LIMIT_CONFIG = { - REGULAR: parseInt(process.env.RATE_LIMIT_REGULAR || '100', 10), - WEBSOCKET: parseInt(process.env.RATE_LIMIT_WEBSOCKET || '1000', 10) + REGULAR: parseInt(process.env.RATE_LIMIT_REGULAR || "100", 10), + WEBSOCKET: parseInt(process.env.RATE_LIMIT_WEBSOCKET || "1000", 10), }; // Security Configuration export const SECURITY_CONFIG = { - JWT_SECRET: process.env.JWT_SECRET || 'default_secret_key_change_in_production', - CORS_ORIGINS: (process.env.CORS_ORIGINS || 'http://localhost:3000,http://localhost:8123') - .split(',') - .map(origin => origin.trim()) + JWT_SECRET: + process.env.JWT_SECRET || "default_secret_key_change_in_production", + CORS_ORIGINS: ( + process.env.CORS_ORIGINS || "http://localhost:3000,http://localhost:8123" + ) + .split(",") + .map((origin) => origin.trim()), }; // Test Configuration export const TEST_CONFIG = { - HASS_HOST: process.env.TEST_HASS_HOST || 'http://localhost:8123', - HASS_TOKEN: process.env.TEST_HASS_TOKEN || 'test_token', - HASS_SOCKET_URL: process.env.TEST_HASS_SOCKET_URL || 'ws://localhost:8123/api/websocket', - PORT: parseInt(process.env.TEST_PORT || '3001', 10) + HASS_HOST: process.env.TEST_HASS_HOST || "http://localhost:8123", + HASS_TOKEN: process.env.TEST_HASS_TOKEN || "test_token", + HASS_SOCKET_URL: + process.env.TEST_HASS_SOCKET_URL || "ws://localhost:8123/api/websocket", + PORT: parseInt(process.env.TEST_PORT || "3001", 10), }; // Mock Configuration (for testing) export const MOCK_CONFIG = { - SERVICES: process.env.MOCK_SERVICES === 'true', - RESPONSES_DIR: process.env.MOCK_RESPONSES_DIR || '__tests__/mock-responses' + SERVICES: process.env.MOCK_SERVICES === "true", + RESPONSES_DIR: process.env.MOCK_RESPONSES_DIR || "__tests__/mock-responses", }; // Validate required configuration function validateConfig() { - const missingVars: string[] = []; + const missingVars: string[] = []; - if (!HASS_CONFIG.TOKEN) missingVars.push('HASS_TOKEN'); - if (!SECURITY_CONFIG.JWT_SECRET) missingVars.push('JWT_SECRET'); + if (!HASS_CONFIG.TOKEN) missingVars.push("HASS_TOKEN"); + if (!SECURITY_CONFIG.JWT_SECRET) missingVars.push("JWT_SECRET"); - if (missingVars.length > 0) { - throw new Error(`Missing required environment variables: ${missingVars.join(', ')}`); - } + if (missingVars.length > 0) { + throw new Error( + `Missing required environment variables: ${missingVars.join(", ")}`, + ); + } } // Export configuration validation @@ -79,11 +88,11 @@ export const validateConfiguration = validateConfig; // Export all configurations as a single object export const AppConfig = { - HASS: HASS_CONFIG, - SERVER: SERVER_CONFIG, - AI: AI_CONFIG, - RATE_LIMIT: RATE_LIMIT_CONFIG, - SECURITY: SECURITY_CONFIG, - TEST: TEST_CONFIG, - MOCK: MOCK_CONFIG -}; \ No newline at end of file + HASS: HASS_CONFIG, + SERVER: SERVER_CONFIG, + AI: AI_CONFIG, + RATE_LIMIT: RATE_LIMIT_CONFIG, + SECURITY: SECURITY_CONFIG, + TEST: TEST_CONFIG, + MOCK: MOCK_CONFIG, +}; diff --git a/src/config/security.config.ts b/src/config/security.config.ts index b28d321..8a16b66 100644 --- a/src/config/security.config.ts +++ b/src/config/security.config.ts @@ -1,112 +1,129 @@ -import { z } from 'zod'; +import { z } from "zod"; // Security configuration schema const securityConfigSchema = z.object({ - // JWT Configuration - JWT_SECRET: z.string().min(32), - JWT_EXPIRY: z.number().default(24 * 60 * 60 * 1000), // 24 hours - JWT_MAX_AGE: z.number().default(30 * 24 * 60 * 60 * 1000), // 30 days - JWT_ALGORITHM: z.enum(['HS256', 'HS384', 'HS512']).default('HS256'), + // JWT Configuration + JWT_SECRET: z.string().min(32), + JWT_EXPIRY: z.number().default(24 * 60 * 60 * 1000), // 24 hours + JWT_MAX_AGE: z.number().default(30 * 24 * 60 * 60 * 1000), // 30 days + JWT_ALGORITHM: z.enum(["HS256", "HS384", "HS512"]).default("HS256"), - // Rate Limiting - RATE_LIMIT_WINDOW: z.number().default(15 * 60 * 1000), // 15 minutes - RATE_LIMIT_MAX_REQUESTS: z.number().default(100), - RATE_LIMIT_WEBSOCKET: z.number().default(1000), + // Rate Limiting + RATE_LIMIT_WINDOW: z.number().default(15 * 60 * 1000), // 15 minutes + RATE_LIMIT_MAX_REQUESTS: z.number().default(100), + RATE_LIMIT_WEBSOCKET: z.number().default(1000), - // Token Security - TOKEN_MIN_LENGTH: z.number().default(32), - MAX_FAILED_ATTEMPTS: z.number().default(5), - LOCKOUT_DURATION: z.number().default(15 * 60 * 1000), // 15 minutes + // Token Security + TOKEN_MIN_LENGTH: z.number().default(32), + MAX_FAILED_ATTEMPTS: z.number().default(5), + LOCKOUT_DURATION: z.number().default(15 * 60 * 1000), // 15 minutes - // CORS Configuration - CORS_ORIGINS: z.array(z.string()).default(['http://localhost:3000', 'http://localhost:8123']), - CORS_METHODS: z.array(z.string()).default(['GET', 'POST', 'PUT', 'DELETE', 'OPTIONS']), - CORS_ALLOWED_HEADERS: z.array(z.string()).default([ - 'Content-Type', - 'Authorization', - 'X-Requested-With' - ]), - CORS_EXPOSED_HEADERS: z.array(z.string()).default([]), - CORS_CREDENTIALS: z.boolean().default(true), - CORS_MAX_AGE: z.number().default(24 * 60 * 60), // 24 hours + // CORS Configuration + CORS_ORIGINS: z + .array(z.string()) + .default(["http://localhost:3000", "http://localhost:8123"]), + CORS_METHODS: z + .array(z.string()) + .default(["GET", "POST", "PUT", "DELETE", "OPTIONS"]), + CORS_ALLOWED_HEADERS: z + .array(z.string()) + .default(["Content-Type", "Authorization", "X-Requested-With"]), + CORS_EXPOSED_HEADERS: z.array(z.string()).default([]), + CORS_CREDENTIALS: z.boolean().default(true), + CORS_MAX_AGE: z.number().default(24 * 60 * 60), // 24 hours - // Content Security Policy - CSP_ENABLED: z.boolean().default(true), - CSP_REPORT_ONLY: z.boolean().default(false), - CSP_REPORT_URI: z.string().optional(), + // Content Security Policy + CSP_ENABLED: z.boolean().default(true), + CSP_REPORT_ONLY: z.boolean().default(false), + CSP_REPORT_URI: z.string().optional(), - // SSL/TLS Configuration - REQUIRE_HTTPS: z.boolean().default(process.env.NODE_ENV === 'production'), - HSTS_MAX_AGE: z.number().default(31536000), // 1 year - HSTS_INCLUDE_SUBDOMAINS: z.boolean().default(true), - HSTS_PRELOAD: z.boolean().default(true), + // SSL/TLS Configuration + REQUIRE_HTTPS: z.boolean().default(process.env.NODE_ENV === "production"), + HSTS_MAX_AGE: z.number().default(31536000), // 1 year + HSTS_INCLUDE_SUBDOMAINS: z.boolean().default(true), + HSTS_PRELOAD: z.boolean().default(true), - // Cookie Security - COOKIE_SECRET: z.string().min(32).optional(), - COOKIE_SECURE: z.boolean().default(process.env.NODE_ENV === 'production'), - COOKIE_HTTP_ONLY: z.boolean().default(true), - COOKIE_SAME_SITE: z.enum(['Strict', 'Lax', 'None']).default('Strict'), + // Cookie Security + COOKIE_SECRET: z.string().min(32).optional(), + COOKIE_SECURE: z.boolean().default(process.env.NODE_ENV === "production"), + COOKIE_HTTP_ONLY: z.boolean().default(true), + COOKIE_SAME_SITE: z.enum(["Strict", "Lax", "None"]).default("Strict"), - // Request Limits - MAX_REQUEST_SIZE: z.number().default(1024 * 1024), // 1MB - MAX_REQUEST_FIELDS: z.number().default(1000), + // Request Limits + MAX_REQUEST_SIZE: z.number().default(1024 * 1024), // 1MB + MAX_REQUEST_FIELDS: z.number().default(1000), }); // Parse environment variables const parseEnvConfig = () => { - const config = { - JWT_SECRET: process.env.JWT_SECRET || 'default_secret_key_change_in_production', - JWT_EXPIRY: parseInt(process.env.JWT_EXPIRY || '86400000'), - JWT_MAX_AGE: parseInt(process.env.JWT_MAX_AGE || '2592000000'), - JWT_ALGORITHM: process.env.JWT_ALGORITHM || 'HS256', + const config = { + JWT_SECRET: + process.env.JWT_SECRET || "default_secret_key_change_in_production", + JWT_EXPIRY: parseInt(process.env.JWT_EXPIRY || "86400000"), + JWT_MAX_AGE: parseInt(process.env.JWT_MAX_AGE || "2592000000"), + JWT_ALGORITHM: process.env.JWT_ALGORITHM || "HS256", - RATE_LIMIT_WINDOW: parseInt(process.env.RATE_LIMIT_WINDOW || '900000'), - RATE_LIMIT_MAX_REQUESTS: parseInt(process.env.RATE_LIMIT_MAX_REQUESTS || '100'), - RATE_LIMIT_WEBSOCKET: parseInt(process.env.RATE_LIMIT_WEBSOCKET || '1000'), + RATE_LIMIT_WINDOW: parseInt(process.env.RATE_LIMIT_WINDOW || "900000"), + RATE_LIMIT_MAX_REQUESTS: parseInt( + process.env.RATE_LIMIT_MAX_REQUESTS || "100", + ), + RATE_LIMIT_WEBSOCKET: parseInt(process.env.RATE_LIMIT_WEBSOCKET || "1000"), - TOKEN_MIN_LENGTH: parseInt(process.env.TOKEN_MIN_LENGTH || '32'), - MAX_FAILED_ATTEMPTS: parseInt(process.env.MAX_FAILED_ATTEMPTS || '5'), - LOCKOUT_DURATION: parseInt(process.env.LOCKOUT_DURATION || '900000'), + TOKEN_MIN_LENGTH: parseInt(process.env.TOKEN_MIN_LENGTH || "32"), + MAX_FAILED_ATTEMPTS: parseInt(process.env.MAX_FAILED_ATTEMPTS || "5"), + LOCKOUT_DURATION: parseInt(process.env.LOCKOUT_DURATION || "900000"), - CORS_ORIGINS: (process.env.CORS_ORIGINS || 'http://localhost:3000,http://localhost:8123') - .split(',') - .map(origin => origin.trim()), - CORS_METHODS: (process.env.CORS_METHODS || 'GET,POST,PUT,DELETE,OPTIONS') - .split(',') - .map(method => method.trim()), - CORS_ALLOWED_HEADERS: (process.env.CORS_ALLOWED_HEADERS || 'Content-Type,Authorization,X-Requested-With') - .split(',') - .map(header => header.trim()), - CORS_EXPOSED_HEADERS: (process.env.CORS_EXPOSED_HEADERS || '') - .split(',') - .filter(Boolean) - .map(header => header.trim()), - CORS_CREDENTIALS: process.env.CORS_CREDENTIALS !== 'false', - CORS_MAX_AGE: parseInt(process.env.CORS_MAX_AGE || '86400'), + CORS_ORIGINS: ( + process.env.CORS_ORIGINS || "http://localhost:3000,http://localhost:8123" + ) + .split(",") + .map((origin) => origin.trim()), + CORS_METHODS: (process.env.CORS_METHODS || "GET,POST,PUT,DELETE,OPTIONS") + .split(",") + .map((method) => method.trim()), + CORS_ALLOWED_HEADERS: ( + process.env.CORS_ALLOWED_HEADERS || + "Content-Type,Authorization,X-Requested-With" + ) + .split(",") + .map((header) => header.trim()), + CORS_EXPOSED_HEADERS: (process.env.CORS_EXPOSED_HEADERS || "") + .split(",") + .filter(Boolean) + .map((header) => header.trim()), + CORS_CREDENTIALS: process.env.CORS_CREDENTIALS !== "false", + CORS_MAX_AGE: parseInt(process.env.CORS_MAX_AGE || "86400"), - CSP_ENABLED: process.env.CSP_ENABLED !== 'false', - CSP_REPORT_ONLY: process.env.CSP_REPORT_ONLY === 'true', - CSP_REPORT_URI: process.env.CSP_REPORT_URI, + CSP_ENABLED: process.env.CSP_ENABLED !== "false", + CSP_REPORT_ONLY: process.env.CSP_REPORT_ONLY === "true", + CSP_REPORT_URI: process.env.CSP_REPORT_URI, - REQUIRE_HTTPS: process.env.REQUIRE_HTTPS !== 'false' && process.env.NODE_ENV === 'production', - HSTS_MAX_AGE: parseInt(process.env.HSTS_MAX_AGE || '31536000'), - HSTS_INCLUDE_SUBDOMAINS: process.env.HSTS_INCLUDE_SUBDOMAINS !== 'false', - HSTS_PRELOAD: process.env.HSTS_PRELOAD !== 'false', + REQUIRE_HTTPS: + process.env.REQUIRE_HTTPS !== "false" && + process.env.NODE_ENV === "production", + HSTS_MAX_AGE: parseInt(process.env.HSTS_MAX_AGE || "31536000"), + HSTS_INCLUDE_SUBDOMAINS: process.env.HSTS_INCLUDE_SUBDOMAINS !== "false", + HSTS_PRELOAD: process.env.HSTS_PRELOAD !== "false", - COOKIE_SECRET: process.env.COOKIE_SECRET, - COOKIE_SECURE: process.env.COOKIE_SECURE !== 'false' && process.env.NODE_ENV === 'production', - COOKIE_HTTP_ONLY: process.env.COOKIE_HTTP_ONLY !== 'false', - COOKIE_SAME_SITE: (process.env.COOKIE_SAME_SITE || 'Strict') as 'Strict' | 'Lax' | 'None', + COOKIE_SECRET: process.env.COOKIE_SECRET, + COOKIE_SECURE: + process.env.COOKIE_SECURE !== "false" && + process.env.NODE_ENV === "production", + COOKIE_HTTP_ONLY: process.env.COOKIE_HTTP_ONLY !== "false", + COOKIE_SAME_SITE: (process.env.COOKIE_SAME_SITE || "Strict") as + | "Strict" + | "Lax" + | "None", - MAX_REQUEST_SIZE: parseInt(process.env.MAX_REQUEST_SIZE || '1048576'), - MAX_REQUEST_FIELDS: parseInt(process.env.MAX_REQUEST_FIELDS || '1000'), - }; + MAX_REQUEST_SIZE: parseInt(process.env.MAX_REQUEST_SIZE || "1048576"), + MAX_REQUEST_FIELDS: parseInt(process.env.MAX_REQUEST_FIELDS || "1000"), + }; - return securityConfigSchema.parse(config); + return securityConfigSchema.parse(config); }; // Export the validated configuration export const SECURITY_CONFIG = parseEnvConfig(); // Export types -export type SecurityConfig = z.infer; \ No newline at end of file +export type SecurityConfig = z.infer; diff --git a/src/context/index.ts b/src/context/index.ts index f920ab7..fd7045f 100644 --- a/src/context/index.ts +++ b/src/context/index.ts @@ -1,226 +1,239 @@ -import { EventEmitter } from 'events'; +import { EventEmitter } from "events"; // Resource types export enum ResourceType { - DEVICE = 'device', - AREA = 'area', - USER = 'user', - AUTOMATION = 'automation', - SCENE = 'scene', - SCRIPT = 'script', - GROUP = 'group' + DEVICE = "device", + AREA = "area", + USER = "user", + AUTOMATION = "automation", + SCENE = "scene", + SCRIPT = "script", + GROUP = "group", } // Resource state interface export interface ResourceState { - id: string; - type: ResourceType; - state: any; - attributes: Record; - lastUpdated: number; - context?: Record; + id: string; + type: ResourceType; + state: any; + attributes: Record; + lastUpdated: number; + context?: Record; } // Resource relationship types export enum RelationType { - CONTAINS = 'contains', - CONTROLS = 'controls', - TRIGGERS = 'triggers', - DEPENDS_ON = 'depends_on', - GROUPS = 'groups' + CONTAINS = "contains", + CONTROLS = "controls", + TRIGGERS = "triggers", + DEPENDS_ON = "depends_on", + GROUPS = "groups", } // Resource relationship interface export interface ResourceRelationship { - sourceId: string; - targetId: string; - type: RelationType; - metadata?: Record; + sourceId: string; + targetId: string; + type: RelationType; + metadata?: Record; } // Context manager class export class ContextManager extends EventEmitter { - private resources: Map = new Map(); - private relationships: ResourceRelationship[] = []; - private stateHistory: Map = new Map(); - private historyLimit = 100; + private resources: Map = new Map(); + private relationships: ResourceRelationship[] = []; + private stateHistory: Map = new Map(); + private historyLimit = 100; - constructor() { - super(); + constructor() { + super(); + } + + // Resource management + public addResource(resource: ResourceState): void { + this.resources.set(resource.id, resource); + this.emit("resource_added", resource); + } + + public updateResource(id: string, update: Partial): void { + const resource = this.resources.get(id); + if (resource) { + // Store current state in history + this.addToHistory(resource); + + // Update resource + const updatedResource = { + ...resource, + ...update, + lastUpdated: Date.now(), + }; + this.resources.set(id, updatedResource); + this.emit("resource_updated", updatedResource); } + } - // Resource management - public addResource(resource: ResourceState): void { - this.resources.set(resource.id, resource); - this.emit('resource_added', resource); + public removeResource(id: string): void { + const resource = this.resources.get(id); + if (resource) { + this.resources.delete(id); + // Remove related relationships + this.relationships = this.relationships.filter( + (rel) => rel.sourceId !== id && rel.targetId !== id, + ); + this.emit("resource_removed", resource); } + } - public updateResource(id: string, update: Partial): void { - const resource = this.resources.get(id); - if (resource) { - // Store current state in history - this.addToHistory(resource); + // Relationship management + public addRelationship(relationship: ResourceRelationship): void { + this.relationships.push(relationship); + this.emit("relationship_added", relationship); + } - // Update resource - const updatedResource = { - ...resource, - ...update, - lastUpdated: Date.now() - }; - this.resources.set(id, updatedResource); - this.emit('resource_updated', updatedResource); - } + public removeRelationship( + sourceId: string, + targetId: string, + type: RelationType, + ): void { + const index = this.relationships.findIndex( + (rel) => + rel.sourceId === sourceId && + rel.targetId === targetId && + rel.type === type, + ); + if (index !== -1) { + const removed = this.relationships.splice(index, 1)[0]; + this.emit("relationship_removed", removed); } + } - public removeResource(id: string): void { - const resource = this.resources.get(id); - if (resource) { - this.resources.delete(id); - // Remove related relationships - this.relationships = this.relationships.filter( - rel => rel.sourceId !== id && rel.targetId !== id - ); - this.emit('resource_removed', resource); - } + // History management + private addToHistory(state: ResourceState): void { + const history = this.stateHistory.get(state.id) || []; + history.push({ ...state }); + if (history.length > this.historyLimit) { + history.shift(); } + this.stateHistory.set(state.id, history); + } - // Relationship management - public addRelationship(relationship: ResourceRelationship): void { - this.relationships.push(relationship); - this.emit('relationship_added', relationship); - } + public getHistory(id: string): ResourceState[] { + return this.stateHistory.get(id) || []; + } - public removeRelationship(sourceId: string, targetId: string, type: RelationType): void { - const index = this.relationships.findIndex( - rel => rel.sourceId === sourceId && rel.targetId === targetId && rel.type === type - ); - if (index !== -1) { - const removed = this.relationships.splice(index, 1)[0]; - this.emit('relationship_removed', removed); - } - } + // Context queries + public getResource(id: string): ResourceState | undefined { + return this.resources.get(id); + } - // History management - private addToHistory(state: ResourceState): void { - const history = this.stateHistory.get(state.id) || []; - history.push({ ...state }); - if (history.length > this.historyLimit) { - history.shift(); - } - this.stateHistory.set(state.id, history); - } + public getResourcesByType(type: ResourceType): ResourceState[] { + return Array.from(this.resources.values()).filter( + (resource) => resource.type === type, + ); + } - public getHistory(id: string): ResourceState[] { - return this.stateHistory.get(id) || []; - } + public getRelatedResources( + id: string, + type?: RelationType, + depth: number = 1, + ): ResourceState[] { + const related = new Set(); + const visited = new Set(); - // Context queries - public getResource(id: string): ResourceState | undefined { - return this.resources.get(id); - } + const traverse = (currentId: string, currentDepth: number) => { + if (currentDepth > depth || visited.has(currentId)) return; + visited.add(currentId); - public getResourcesByType(type: ResourceType): ResourceState[] { - return Array.from(this.resources.values()).filter( - resource => resource.type === type - ); - } + this.relationships + .filter( + (rel) => + (rel.sourceId === currentId || rel.targetId === currentId) && + (!type || rel.type === type), + ) + .forEach((rel) => { + const relatedId = + rel.sourceId === currentId ? rel.targetId : rel.sourceId; + const relatedResource = this.resources.get(relatedId); + if (relatedResource) { + related.add(relatedResource); + traverse(relatedId, currentDepth + 1); + } + }); + }; - public getRelatedResources( - id: string, - type?: RelationType, - depth: number = 1 - ): ResourceState[] { - const related = new Set(); - const visited = new Set(); + traverse(id, 0); + return Array.from(related); + } - const traverse = (currentId: string, currentDepth: number) => { - if (currentDepth > depth || visited.has(currentId)) return; - visited.add(currentId); + // Context analysis + public analyzeResourceUsage(id: string): { + dependencies: string[]; + dependents: string[]; + groups: string[]; + usage: { + triggerCount: number; + controlCount: number; + groupCount: number; + }; + } { + const dependencies = this.relationships + .filter( + (rel) => rel.sourceId === id && rel.type === RelationType.DEPENDS_ON, + ) + .map((rel) => rel.targetId); - this.relationships - .filter(rel => - (rel.sourceId === currentId || rel.targetId === currentId) && - (!type || rel.type === type) - ) - .forEach(rel => { - const relatedId = rel.sourceId === currentId ? rel.targetId : rel.sourceId; - const relatedResource = this.resources.get(relatedId); - if (relatedResource) { - related.add(relatedResource); - traverse(relatedId, currentDepth + 1); - } - }); - }; + const dependents = this.relationships + .filter( + (rel) => rel.targetId === id && rel.type === RelationType.DEPENDS_ON, + ) + .map((rel) => rel.sourceId); - traverse(id, 0); - return Array.from(related); - } + const groups = this.relationships + .filter((rel) => rel.targetId === id && rel.type === RelationType.GROUPS) + .map((rel) => rel.sourceId); - // Context analysis - public analyzeResourceUsage(id: string): { - dependencies: string[]; - dependents: string[]; - groups: string[]; - usage: { - triggerCount: number; - controlCount: number; - groupCount: number; - }; - } { - const dependencies = this.relationships - .filter(rel => rel.sourceId === id && rel.type === RelationType.DEPENDS_ON) - .map(rel => rel.targetId); + const usage = { + triggerCount: this.relationships.filter( + (rel) => rel.sourceId === id && rel.type === RelationType.TRIGGERS, + ).length, + controlCount: this.relationships.filter( + (rel) => rel.sourceId === id && rel.type === RelationType.CONTROLS, + ).length, + groupCount: groups.length, + }; - const dependents = this.relationships - .filter(rel => rel.targetId === id && rel.type === RelationType.DEPENDS_ON) - .map(rel => rel.sourceId); + return { dependencies, dependents, groups, usage }; + } - const groups = this.relationships - .filter(rel => rel.targetId === id && rel.type === RelationType.GROUPS) - .map(rel => rel.sourceId); + // Event subscriptions + public subscribeToResource( + id: string, + callback: (state: ResourceState) => void, + ): () => void { + const handler = (resource: ResourceState) => { + if (resource.id === id) { + callback(resource); + } + }; - const usage = { - triggerCount: this.relationships.filter( - rel => rel.sourceId === id && rel.type === RelationType.TRIGGERS - ).length, - controlCount: this.relationships.filter( - rel => rel.sourceId === id && rel.type === RelationType.CONTROLS - ).length, - groupCount: groups.length - }; + this.on("resource_updated", handler); + return () => this.off("resource_updated", handler); + } - return { dependencies, dependents, groups, usage }; - } + public subscribeToType( + type: ResourceType, + callback: (state: ResourceState) => void, + ): () => void { + const handler = (resource: ResourceState) => { + if (resource.type === type) { + callback(resource); + } + }; - // Event subscriptions - public subscribeToResource( - id: string, - callback: (state: ResourceState) => void - ): () => void { - const handler = (resource: ResourceState) => { - if (resource.id === id) { - callback(resource); - } - }; - - this.on('resource_updated', handler); - return () => this.off('resource_updated', handler); - } - - public subscribeToType( - type: ResourceType, - callback: (state: ResourceState) => void - ): () => void { - const handler = (resource: ResourceState) => { - if (resource.type === type) { - callback(resource); - } - }; - - this.on('resource_updated', handler); - return () => this.off('resource_updated', handler); - } + this.on("resource_updated", handler); + return () => this.off("resource_updated", handler); + } } // Export context manager instance -export const contextManager = new ContextManager(); \ No newline at end of file +export const contextManager = new ContextManager(); diff --git a/src/hass/index.ts b/src/hass/index.ts index fba1d9a..7267088 100644 --- a/src/hass/index.ts +++ b/src/hass/index.ts @@ -1,429 +1,64 @@ -import { CreateApplication, TServiceParams, ServiceFunction, AlsExtension, GetApisResult, ILogger, InternalDefinition, TContext, TInjectedConfig, TLifecycleBase, TScheduler } from "@digital-alchemy/core"; -import { Area, Backup, CallProxy, Configure, Device, EntityManager, EventsService, FetchAPI, FetchInternals, Floor, IDByExtension, Label, LIB_HASS, ReferenceService, Registry, WebsocketAPI, Zone } from "@digital-alchemy/hass"; -import { DomainSchema } from "../schemas.js"; -import { HASS_CONFIG } from "../config/hass.config.js"; -import { WebSocket } from 'ws'; -import { EventEmitter } from 'events'; -import * as HomeAssistant from '../types/hass.js'; +import { CreateApplication } from "@digital-alchemy/core"; +import { LIB_HASS } from "@digital-alchemy/hass"; -type Environments = "development" | "production" | "test"; - -// Define the type for Home Assistant services -type HassServiceMethod = (data: Record) => Promise; - -type HassServices = { - [K in keyof typeof DomainSchema.Values]: { - [service: string]: HassServiceMethod; - }; -}; - -// Define the type for Home Assistant instance -interface HassInstance extends TServiceParams { - baseUrl: string; - token: string; - wsClient: HassWebSocketClient | undefined; - services: HassServices; - als: AlsExtension; - context: TContext; - event: EventEmitter<[never]>; - internal: InternalDefinition; - lifecycle: TLifecycleBase; - logger: ILogger; - scheduler: TScheduler; - config: TInjectedConfig; - params: TServiceParams; - hass: GetApisResult<{ - area: typeof Area; - backup: typeof Backup; - call: typeof CallProxy; - configure: typeof Configure; - device: typeof Device; - entity: typeof EntityManager; - events: typeof EventsService; - fetch: typeof FetchAPI; - floor: typeof Floor; - idBy: typeof IDByExtension; - internals: typeof FetchInternals; - label: typeof Label; - refBy: typeof ReferenceService; - registry: typeof Registry; - socket: typeof WebsocketAPI; - zone: typeof Zone; - }>; -} - -// Configuration type for application with more specific constraints -type ApplicationConfiguration = { - NODE_ENV: ServiceFunction; -}; - -// Strict configuration type for Home Assistant -type HassConfiguration = { - BASE_URL: { - type: "string"; - description: string; - required: true; - default: string; - }; - TOKEN: { - type: "string"; - description: string; - required: true; - default: string; - }; - SOCKET_URL: { - type: "string"; - description: string; - required: true; - default: string; - }; - SOCKET_TOKEN: { - type: "string"; - description: string; - required: true; - default: string; - }; -}; - -// application -const MY_APP = CreateApplication({ +// Create the application following the documentation example +const app = CreateApplication({ + libraries: [LIB_HASS], + name: "home_automation", configuration: { - NODE_ENV: { - type: "string", - default: "development", - enum: ["development", "production", "test"], - description: "Code runner addon can set with it's own NODE_ENV", + hass: { + BASE_URL: { + type: "string" as const, + default: process.env.HASS_HOST || "http://localhost:8123", + description: "Home Assistant URL", + }, + TOKEN: { + type: "string" as const, + default: process.env.HASS_TOKEN || "", + description: "Home Assistant long-lived access token", + }, }, }, - services: { - NODE_ENV: () => { - // Directly return the default value or use process.env - return (process.env.NODE_ENV as Environments) || "development"; - } - }, - libraries: [ - { - ...LIB_HASS, - configuration: { - BASE_URL: { - type: "string", - description: "Home Assistant base URL", - required: true, - default: HASS_CONFIG.BASE_URL - }, - TOKEN: { - type: "string", - description: "Home Assistant long-lived access token", - required: true, - default: HASS_CONFIG.TOKEN - }, - SOCKET_URL: { - type: "string", - description: "Home Assistant WebSocket URL", - required: true, - default: HASS_CONFIG.SOCKET_URL - }, - SOCKET_TOKEN: { - type: "string", - description: "Home Assistant WebSocket token", - required: true, - default: HASS_CONFIG.SOCKET_TOKEN - } - } - } - ], - name: 'hass' as const }); -export interface HassConfig { - host: string; - token: string; +let instance: Awaited>; + +export async function get_hass() { + if (!instance) { + try { + instance = await app.bootstrap(); + } catch (error) { + console.error("Failed to initialize Home Assistant:", error); + throw error; + } + } + return instance; } -const CONFIG: Record = { - development: { - host: process.env.HASS_HOST || 'http://localhost:8123', - token: process.env.HASS_TOKEN || '' - }, - production: { - host: process.env.HASS_HOST || '', - token: process.env.HASS_TOKEN || '' - }, - test: { - host: 'http://localhost:8123', - token: 'test_token' - } -}; - -export class HassWebSocketClient extends EventEmitter { - private ws: WebSocket | null = null; - private messageId = 1; - private subscriptions = new Map void>(); - private reconnectAttempts = 0; - private options: { - autoReconnect: boolean; - maxReconnectAttempts: number; - reconnectDelay: number; - }; - - constructor( - private url: string, - private token: string, - options: Partial = {} - ) { - super(); - this.options = { - autoReconnect: true, - maxReconnectAttempts: 3, - reconnectDelay: 1000, - ...options - }; - } - - async connect(): Promise { - if (this.ws && this.ws.readyState === WebSocket.OPEN) { - return; - } - - return new Promise((resolve, reject) => { - this.ws = new WebSocket(this.url); - - this.ws.on('open', () => { - this.emit('open'); - const authMessage: HomeAssistant.AuthMessage = { - type: 'auth', - access_token: this.token - }; - this.ws?.send(JSON.stringify(authMessage)); - }); - - this.ws.on('message', (data: string) => { - try { - const message = JSON.parse(data); - this.handleMessage(message); - } catch (error) { - this.emit('error', new Error('Failed to parse message')); - } - }); - - this.ws.on('close', () => { - this.emit('disconnected'); - if (this.options.autoReconnect && this.reconnectAttempts < this.options.maxReconnectAttempts) { - setTimeout(() => { - this.reconnectAttempts++; - this.connect(); - }, this.options.reconnectDelay); - } - }); - - this.ws.on('error', (error) => { - this.emit('error', error); - reject(error); - }); - }); - } - - private handleMessage(message: any): void { - switch (message.type) { - case 'auth_ok': - this.emit('auth_ok'); - break; - case 'auth_invalid': - this.emit('auth_invalid'); - break; - case 'result': - // Handle command results - break; - case 'event': - if (message.event) { - this.emit('event', message.event); - const subscription = this.subscriptions.get(message.id); - if (subscription) { - subscription(message.event.data); - } - } - break; - default: - this.emit('error', new Error(`Unknown message type: ${message.type}`)); - } - } - - async subscribeEvents(callback: (data: any) => void, eventType?: string): Promise { - const id = this.messageId++; - const message = { - id, - type: 'subscribe_events', - event_type: eventType - }; - - return new Promise((resolve, reject) => { - if (!this.ws || this.ws.readyState !== WebSocket.OPEN) { - reject(new Error('WebSocket not connected')); - return; - } - - this.subscriptions.set(id, callback); - this.ws.send(JSON.stringify(message)); - resolve(id); - }); - } - - async unsubscribeEvents(subscriptionId: number): Promise { - const message = { - id: this.messageId++, - type: 'unsubscribe_events', - subscription: subscriptionId - }; - - return new Promise((resolve, reject) => { - if (!this.ws || this.ws.readyState !== WebSocket.OPEN) { - reject(new Error('WebSocket not connected')); - return; - } - - this.ws.send(JSON.stringify(message)); - this.subscriptions.delete(subscriptionId); - resolve(); - }); - } - - disconnect(): void { - if (this.ws) { - this.ws.close(); - this.ws = null; - } - } +// Helper function to call Home Assistant services +export async function call_service( + domain: string, + service: string, + data: Record, +) { + const hass = await get_hass(); + return hass.hass.internals.callService(domain, service, data); } -export class HassInstanceImpl implements HassInstance { - public readonly baseUrl: string; - public readonly token: string; - public wsClient: HassWebSocketClient | undefined; - - public services!: HassServices; - public als!: AlsExtension; - public context!: TContext; - public event!: EventEmitter<[never]>; - public internal!: InternalDefinition; - public lifecycle!: TLifecycleBase; - public logger!: ILogger; - public scheduler!: TScheduler; - public config!: TInjectedConfig; - public params!: TServiceParams; - public hass!: GetApisResult<{ - area: typeof Area; - backup: typeof Backup; - call: typeof CallProxy; - configure: typeof Configure; - device: typeof Device; - entity: typeof EntityManager; - events: typeof EventsService; - fetch: typeof FetchAPI; - floor: typeof Floor; - idBy: typeof IDByExtension; - internals: typeof FetchInternals; - label: typeof Label; - refBy: typeof ReferenceService; - registry: typeof Registry; - socket: typeof WebsocketAPI; - zone: typeof Zone; - }>; - - constructor(baseUrl: string, token: string) { - this.baseUrl = baseUrl; - this.token = token; - this.initialize(); - } - - private initialize() { - // Initialize all required properties with proper type instantiation - this.services = {} as HassServices; - this.als = {} as AlsExtension; - this.context = {} as TContext; - this.event = new EventEmitter(); - this.internal = {} as InternalDefinition; - this.lifecycle = {} as TLifecycleBase; - this.logger = {} as ILogger; - this.scheduler = {} as TScheduler; - this.config = {} as TInjectedConfig; - this.params = {} as TServiceParams; - this.hass = {} as GetApisResult; - } - - async fetchStates(): Promise { - const response = await fetch(`${this.baseUrl}/api/states`, { - headers: { - Authorization: `Bearer ${this.token}`, - 'Content-Type': 'application/json', - }, - }); - - if (!response.ok) { - throw new Error(`Failed to fetch states: ${response.statusText}`); - } - - const data = await response.json(); - return data as HomeAssistant.Entity[]; - } - - async fetchState(entityId: string): Promise { - const response = await fetch(`${this.baseUrl}/api/states/${entityId}`, { - headers: { - Authorization: `Bearer ${this.token}`, - 'Content-Type': 'application/json', - }, - }); - - if (!response.ok) { - throw new Error(`Failed to fetch state: ${response.statusText}`); - } - - const data = await response.json(); - return data as HomeAssistant.Entity; - } - - async callService(domain: string, service: string, data: Record): Promise { - const response = await fetch(`${this.baseUrl}/api/services/${domain}/${service}`, { - method: 'POST', - headers: { - Authorization: `Bearer ${this.token}`, - 'Content-Type': 'application/json', - }, - body: JSON.stringify(data), - }); - - if (!response.ok) { - throw new Error(`Service call failed: ${response.statusText}`); - } - } - - async subscribeEvents(callback: (event: HomeAssistant.Event) => void, eventType?: string): Promise { - if (!this.wsClient) { - this.wsClient = new HassWebSocketClient( - this.baseUrl.replace(/^http/, 'ws') + '/api/websocket', - this.token - ); - await this.wsClient.connect(); - } - - return this.wsClient.subscribeEvents(callback, eventType); - } - - async unsubscribeEvents(subscriptionId: number): Promise { - if (this.wsClient) { - await this.wsClient.unsubscribeEvents(subscriptionId); - } - } +// Helper function to list devices +export async function list_devices() { + const hass = await get_hass(); + return hass.hass.device.list(); } -let hassInstance: HassInstance | null = null; +// Helper function to get entity states +export async function get_states() { + const hass = await get_hass(); + return hass.hass.internals.getStates(); +} -export async function get_hass(): Promise { - if (!hassInstance) { - // Safely get configuration keys, providing an empty object as fallback - const _sortedConfigKeys = Object.keys(MY_APP.configuration ?? {}).sort(); - const instance = await MY_APP.bootstrap(); - hassInstance = instance as HassInstance; - } - return hassInstance; -} \ No newline at end of file +// Helper function to get a specific entity state +export async function get_state(entity_id: string) { + const hass = await get_hass(); + return hass.hass.internals.getState(entity_id); +} diff --git a/src/health-check.ts b/src/health-check.ts index c53fb1a..3bf2104 100644 --- a/src/health-check.ts +++ b/src/health-check.ts @@ -1,16 +1,16 @@ const check = async () => { - try { - const response = await fetch('http://localhost:3000/health'); - if (!response.ok) { - console.error('Health check failed:', response.status); - process.exit(1); - } - console.log('Health check passed'); - process.exit(0); - } catch (error) { - console.error('Health check failed:', error); - process.exit(1); + try { + const response = await fetch("http://localhost:3000/health"); + if (!response.ok) { + console.error("Health check failed:", response.status); + process.exit(1); } + console.log("Health check passed"); + process.exit(0); + } catch (error) { + console.error("Health check failed:", error); + process.exit(1); + } }; -check(); \ No newline at end of file +check(); diff --git a/src/index.ts b/src/index.ts index b98a155..b62b282 100644 --- a/src/index.ts +++ b/src/index.ts @@ -1,33 +1,45 @@ -import './polyfills.js'; -import { config } from 'dotenv'; -import { resolve } from 'path'; -import { v4 as uuidv4 } from 'uuid'; -import { sseManager } from './sse/index.js'; -import { ILogger } from "@digital-alchemy/core"; -import express from 'express'; -import { rateLimiter, securityHeaders, validateRequest, sanitizeInput, errorHandler } from './security/index.js'; +import "./polyfills.js"; +import { config } from "dotenv"; +import { resolve } from "path"; +import express from "express"; +import { + rateLimiter, + securityHeaders, + validateRequest, + sanitizeInput, + errorHandler, +} from "./security/index.js"; +import { + get_hass, + call_service, + list_devices, + get_states, + get_state, +} from "./hass/index.js"; +import { z } from "zod"; +import { + commonCommands, + coverCommands, + climateCommands, + type Command, +} from "./commands.js"; // Load environment variables based on NODE_ENV -const envFile = process.env.NODE_ENV === 'production' - ? '.env' - : process.env.NODE_ENV === 'test' - ? '.env.test' - : '.env.development'; +const envFile = + process.env.NODE_ENV === "production" + ? ".env" + : process.env.NODE_ENV === "test" + ? ".env.test" + : ".env.development"; console.log(`Loading environment from ${envFile}`); config({ path: resolve(process.cwd(), envFile) }); -import { get_hass } from './hass/index.js'; -import { LiteMCP } from './mcp/litemcp.js'; -import { z } from 'zod'; -import { DomainSchema } from './schemas.js'; - // Configuration -const HASS_HOST = process.env.HASS_HOST || 'http://192.168.178.63:8123'; const HASS_TOKEN = process.env.HASS_TOKEN; -const PORT = process.env.PORT || 3000; +const PORT = parseInt(process.env.PORT || "4000", 10); -console.log('Initializing Home Assistant connection...'); +console.log("Initializing Home Assistant connection..."); // Initialize Express app const app = express(); @@ -39,15 +51,12 @@ app.use(express.json()); app.use(validateRequest); app.use(sanitizeInput); -// Initialize LiteMCP -const server = new LiteMCP('home-assistant', '0.1.0'); - // Health check endpoint -app.get('/health', (req, res) => { +app.get("/health", (req, res) => { res.json({ - status: 'ok', + status: "ok", timestamp: new Date().toISOString(), - version: '0.1.0' + version: "0.1.0", }); }); @@ -59,1218 +68,98 @@ interface Tool { execute: (params: any) => Promise; } -// Array to track tools +// Array to store tools const tools: Tool[] = []; -// List devices endpoint -app.get('/list_devices', async (req, res) => { - try { - // Get token from Authorization header - const token = req.headers.authorization?.replace('Bearer ', ''); - - if (!token || token !== HASS_TOKEN) { - return res.status(401).json({ +// Define the list devices tool +const listDevicesTool: Tool = { + name: "list_devices", + description: "List all available Home Assistant devices", + parameters: z.object({}), + execute: async () => { + try { + const devices = await list_devices(); + return { + success: true, + devices, + }; + } catch (error) { + return { success: false, - message: 'Unauthorized - Invalid token' + message: + error instanceof Error ? error.message : "Unknown error occurred", + }; + } + }, +}; + +// Add tools to the array +tools.push(listDevicesTool); + +// Add the Home Assistant control tool +const controlTool: Tool = { + name: "control", + description: "Control Home Assistant devices and services", + parameters: z.object({ + command: z.enum([ + ...commonCommands, + ...coverCommands, + ...climateCommands, + ] as [string, ...string[]]), + entity_id: z.string().describe("The ID of the entity to control"), + }), + execute: async (params: { command: Command; entity_id: string }) => { + try { + const [domain] = params.entity_id.split("."); + await call_service(domain, params.command, { + entity_id: params.entity_id, + }); + return { + success: true, + message: `Command ${params.command} executed successfully on ${params.entity_id}`, + }; + } catch (error) { + return { + success: false, + message: + error instanceof Error ? error.message : "Unknown error occurred", + }; + } + }, +}; + +// Add the control tool to the array +tools.push(controlTool); + +// Create API endpoints for each tool +tools.forEach((tool) => { + app.post(`/api/tools/${tool.name}`, async (req, res) => { + try { + const result = await tool.execute(req.body); + res.json(result); + } catch (error) { + res.status(500).json({ + success: false, + message: + error instanceof Error ? error.message : "Unknown error occurred", }); } - - const tool = tools.find(t => t.name === 'list_devices'); - if (!tool) { - return res.status(404).json({ - success: false, - message: 'Tool not found' - }); - } - - const result = await tool.execute({ token }); - res.json(result); - } catch (error) { - res.status(500).json({ - success: false, - message: error instanceof Error ? error.message : 'Unknown error occurred' - }); - } -}); - -app.post('/control', async (req, res) => { - try { - // Get token from Authorization header - const token = req.headers.authorization?.replace('Bearer ', ''); - - if (!token || token !== HASS_TOKEN) { - return res.status(401).json({ - success: false, - message: 'Unauthorized - Invalid token' - }); - } - - const tool = tools.find(t => t.name === 'control'); - if (!tool) { - return res.status(404).json({ - success: false, - message: 'Tool not found' - }); - } - - const result = await tool.execute({ - ...req.body, - token - }); - res.json(result); - } catch (error) { - res.status(500).json({ - success: false, - message: error instanceof Error ? error.message : 'Unknown error occurred' - }); - } -}); - -// SSE endpoints -app.get('/subscribe_events', (req, res) => { - try { - // Get token from query parameter - const token = req.query.token?.toString(); - - if (!token || token !== HASS_TOKEN) { - return res.status(401).json({ - success: false, - message: 'Unauthorized - Invalid token' - }); - } - - const tool = tools.find(t => t.name === 'subscribe_events'); - if (!tool) { - return res.status(404).json({ - success: false, - message: 'Tool not found' - }); - } - - tool.execute({ - token, - events: req.query.events?.toString().split(','), - entity_id: req.query.entity_id?.toString(), - domain: req.query.domain?.toString(), - response: res - }); - } catch (error) { - res.status(500).json({ - success: false, - message: error instanceof Error ? error.message : 'Unknown error occurred' - }); - } -}); - -app.get('/get_sse_stats', async (req, res) => { - try { - // Get token from query parameter - const token = req.query.token?.toString(); - - if (!token || token !== HASS_TOKEN) { - return res.status(401).json({ - success: false, - message: 'Unauthorized - Invalid token' - }); - } - - const tool = tools.find(t => t.name === 'get_sse_stats'); - if (!tool) { - return res.status(404).json({ - success: false, - message: 'Tool not found' - }); - } - - const result = await tool.execute({ token }); - res.json(result); - } catch (error) { - res.status(500).json({ - success: false, - message: error instanceof Error ? error.message : 'Unknown error occurred' - }); - } + }); }); // Error handling middleware app.use(errorHandler); -interface CommandParams { - command: string; - entity_id: string; - // Common parameters - state?: string; - // Light parameters - brightness?: number; - color_temp?: number; - rgb_color?: [number, number, number]; - // Cover parameters - position?: number; - tilt_position?: number; - // Climate parameters - temperature?: number; - target_temp_high?: number; - target_temp_low?: number; - hvac_mode?: string; - fan_mode?: string; - humidity?: number; -} - -const commonCommands = ['turn_on', 'turn_off', 'toggle'] as const; -const coverCommands = [...commonCommands, 'open', 'close', 'stop', 'set_position', 'set_tilt_position'] as const; -const climateCommands = [...commonCommands, 'set_temperature', 'set_hvac_mode', 'set_fan_mode', 'set_humidity'] as const; - -interface HassEntity { - entity_id: string; - state: string; - attributes: Record; - last_changed?: string; - last_updated?: string; - context?: { - id: string; - parent_id?: string; - user_id?: string; - }; -} - -interface HassState { - entity_id: string; - state: string; - attributes: { - friendly_name?: string; - description?: string; - [key: string]: any; - }; -} - -interface HassAddon { - name: string; - slug: string; - description: string; - version: string; - installed: boolean; - available: boolean; - state: string; -} - -interface HassAddonResponse { - data: { - addons: HassAddon[]; - }; -} - -interface HassAddonInfoResponse { - data: { - name: string; - slug: string; - description: string; - version: string; - state: string; - status: string; - options: Record; - [key: string]: any; - }; -} - -interface HacsRepository { - name: string; - description: string; - category: string; - installed: boolean; - version_installed: string; - available_version: string; - authors: string[]; - domain: string; -} - -interface HacsResponse { - repositories: HacsRepository[]; -} - -interface AutomationConfig { - alias: string; - description?: string; - mode?: 'single' | 'parallel' | 'queued' | 'restart'; - trigger: any[]; - condition?: any[]; - action: any[]; -} - -interface AutomationResponse { - automation_id: string; -} - -interface SSEHeaders { - onAbort?: () => void; -} - -interface SSEParams { - token: string; - events?: string[]; - entity_id?: string; - domain?: string; -} - -interface HistoryParams { - entity_id: string; - start_time?: string; - end_time?: string; - minimal_response?: boolean; - significant_changes_only?: boolean; -} - -interface SceneParams { - action: 'list' | 'activate'; - scene_id?: string; -} - -interface NotifyParams { - message: string; - title?: string; - target?: string; - data?: Record; -} - -interface AutomationParams { - action: 'list' | 'toggle' | 'trigger'; - automation_id?: string; -} - -interface AddonParams { - action: 'list' | 'info' | 'install' | 'uninstall' | 'start' | 'stop' | 'restart'; - slug?: string; - version?: string; -} - -interface PackageParams { - action: 'list' | 'install' | 'uninstall' | 'update'; - category: 'integration' | 'plugin' | 'theme' | 'python_script' | 'appdaemon' | 'netdaemon'; - repository?: string; - version?: string; -} - -interface AutomationConfigParams { - action: 'create' | 'update' | 'delete' | 'duplicate'; - automation_id?: string; - config?: { - alias: string; - description?: string; - mode?: 'single' | 'parallel' | 'queued' | 'restart'; - trigger: any[]; - condition?: any[]; - action: any[]; - }; -} - -async function main() { - const hass = await get_hass(); - const logger: ILogger = (hass as any).logger; - - // Add the list devices tool - const listDevicesTool = { - name: 'list_devices', - description: 'List all available Home Assistant devices', - parameters: z.object({}).describe('No parameters required'), - execute: async () => { - try { - const response = await fetch(`${HASS_HOST}/api/states`, { - headers: { - Authorization: `Bearer ${HASS_TOKEN}`, - 'Content-Type': 'application/json', - }, - }); - - if (!response.ok) { - throw new Error(`Failed to fetch devices: ${response.statusText}`); - } - - const states = await response.json() as HassState[]; - const devices: Record = {}; - - // Group devices by domain - states.forEach(state => { - const [domain] = state.entity_id.split('.'); - if (!devices[domain]) { - devices[domain] = []; - } - devices[domain].push(state); - }); - - return { - success: true, - devices - }; - } catch (error) { - return { - success: false, - message: error instanceof Error ? error.message : 'Unknown error occurred' - }; - } - } - }; - server.addTool(listDevicesTool); - tools.push(listDevicesTool); - - // Add the Home Assistant control tool - const controlTool = { - name: 'control', - description: 'Control Home Assistant devices and services', - parameters: z.object({ - command: z.enum([...commonCommands, ...coverCommands, ...climateCommands]) - .describe('The command to execute'), - entity_id: z.string().describe('The entity ID to control'), - // Common parameters - state: z.string().optional().describe('The desired state for the entity'), - // Light parameters - brightness: z.number().min(0).max(255).optional() - .describe('Brightness level for lights (0-255)'), - color_temp: z.number().optional() - .describe('Color temperature for lights'), - rgb_color: z.tuple([z.number(), z.number(), z.number()]).optional() - .describe('RGB color values'), - // Cover parameters - position: z.number().min(0).max(100).optional() - .describe('Position for covers (0-100)'), - tilt_position: z.number().min(0).max(100).optional() - .describe('Tilt position for covers (0-100)'), - // Climate parameters - temperature: z.number().optional() - .describe('Target temperature for climate devices'), - target_temp_high: z.number().optional() - .describe('Target high temperature for climate devices'), - target_temp_low: z.number().optional() - .describe('Target low temperature for climate devices'), - hvac_mode: z.enum(['off', 'heat', 'cool', 'heat_cool', 'auto', 'dry', 'fan_only']).optional() - .describe('HVAC mode for climate devices'), - fan_mode: z.enum(['auto', 'low', 'medium', 'high']).optional() - .describe('Fan mode for climate devices'), - humidity: z.number().min(0).max(100).optional() - .describe('Target humidity for climate devices') - }), - execute: async (params: CommandParams) => { - try { - const domain = params.entity_id.split('.')[0] as keyof typeof DomainSchema.Values; - - if (!Object.values(DomainSchema.Values).includes(domain)) { - throw new Error(`Unsupported domain: ${domain}`); - } - - const service = params.command; - const serviceData: Record = { - entity_id: params.entity_id - }; - - // Handle domain-specific parameters - switch (domain) { - case 'light': - if (params.brightness !== undefined) { - serviceData.brightness = params.brightness; - } - if (params.color_temp !== undefined) { - serviceData.color_temp = params.color_temp; - } - if (params.rgb_color !== undefined) { - serviceData.rgb_color = params.rgb_color; - } - break; - - case 'cover': - if (service === 'set_position' && params.position !== undefined) { - serviceData.position = params.position; - } - if (service === 'set_tilt_position' && params.tilt_position !== undefined) { - serviceData.tilt_position = params.tilt_position; - } - break; - - case 'climate': - if (service === 'set_temperature') { - if (params.temperature !== undefined) { - serviceData.temperature = params.temperature; - } - if (params.target_temp_high !== undefined) { - serviceData.target_temp_high = params.target_temp_high; - } - if (params.target_temp_low !== undefined) { - serviceData.target_temp_low = params.target_temp_low; - } - } - if (service === 'set_hvac_mode' && params.hvac_mode !== undefined) { - serviceData.hvac_mode = params.hvac_mode; - } - if (service === 'set_fan_mode' && params.fan_mode !== undefined) { - serviceData.fan_mode = params.fan_mode; - } - if (service === 'set_humidity' && params.humidity !== undefined) { - serviceData.humidity = params.humidity; - } - break; - - case 'switch': - case 'contact': - // These domains only support basic operations (turn_on, turn_off, toggle) - break; - - default: - throw new Error(`Unsupported operation for domain: ${domain}`); - } - - // Call Home Assistant service - try { - const response = await fetch(`${HASS_HOST}/api/services/${domain}/${service}`, { - method: 'POST', - headers: { - Authorization: `Bearer ${HASS_TOKEN}`, - 'Content-Type': 'application/json', - }, - body: JSON.stringify(serviceData), - }); - - if (!response.ok) { - throw new Error(`Failed to execute ${service} for ${params.entity_id}: ${response.statusText}`); - } - - return { - success: true, - message: `Successfully executed ${service} for ${params.entity_id}` - }; - } catch (error) { - throw new Error(`Failed to execute ${service} for ${params.entity_id}: ${error instanceof Error ? error.message : 'Unknown error occurred'}`); - } - } catch (error) { - return { - success: false, - message: error instanceof Error ? error.message : 'Unknown error occurred' - }; - } - } - }; - server.addTool(controlTool); - tools.push(controlTool); - - // Add the history tool - const historyTool = { - name: 'get_history', - description: 'Get state history for Home Assistant entities', - parameters: z.object({ - entity_id: z.string().describe('The entity ID to get history for'), - start_time: z.string().optional().describe('Start time in ISO format. Defaults to 24 hours ago'), - end_time: z.string().optional().describe('End time in ISO format. Defaults to now'), - minimal_response: z.boolean().optional().describe('Return minimal response to reduce data size'), - significant_changes_only: z.boolean().optional().describe('Only return significant state changes'), - }), - execute: async (params: HistoryParams) => { - try { - const now = new Date(); - const startTime = params.start_time ? new Date(params.start_time) : new Date(now.getTime() - 24 * 60 * 60 * 1000); - const endTime = params.end_time ? new Date(params.end_time) : now; - - // Build query parameters - const queryParams = new URLSearchParams({ - filter_entity_id: params.entity_id, - minimal_response: String(!!params.minimal_response), - significant_changes_only: String(!!params.significant_changes_only), - start_time: startTime.toISOString(), - end_time: endTime.toISOString(), - }); - - const response = await fetch(`${HASS_HOST}/api/history/period/${startTime.toISOString()}?${queryParams.toString()}`, { - headers: { - Authorization: `Bearer ${HASS_TOKEN}`, - 'Content-Type': 'application/json', - }, - }); - - if (!response.ok) { - throw new Error(`Failed to fetch history: ${response.statusText}`); - } - - const history = await response.json(); - return { - success: true, - history, - }; - } catch (error) { - return { - success: false, - message: error instanceof Error ? error.message : 'Unknown error occurred', - }; - } - }, - }; - server.addTool(historyTool); - tools.push(historyTool); - - // Add the scenes tool - const sceneTool = { - name: 'scene', - description: 'Manage and activate Home Assistant scenes', - parameters: z.object({ - action: z.enum(['list', 'activate']).describe('Action to perform with scenes'), - scene_id: z.string().optional().describe('Scene ID to activate (required for activate action)'), - }), - execute: async (params: SceneParams) => { - try { - if (params.action === 'list') { - const response = await fetch(`${HASS_HOST}/api/states`, { - headers: { - Authorization: `Bearer ${HASS_TOKEN}`, - 'Content-Type': 'application/json', - }, - }); - - if (!response.ok) { - throw new Error(`Failed to fetch scenes: ${response.statusText}`); - } - - const states = (await response.json()) as HassState[]; - const scenes = states.filter((state) => state.entity_id.startsWith('scene.')); - - return { - success: true, - scenes: scenes.map((scene) => ({ - entity_id: scene.entity_id, - name: scene.attributes.friendly_name || scene.entity_id.split('.')[1], - description: scene.attributes.description, - })), - }; - } else if (params.action === 'activate') { - if (!params.scene_id) { - throw new Error('Scene ID is required for activate action'); - } - - const response = await fetch(`${HASS_HOST}/api/services/scene/turn_on`, { - method: 'POST', - headers: { - Authorization: `Bearer ${HASS_TOKEN}`, - 'Content-Type': 'application/json', - }, - body: JSON.stringify({ - entity_id: params.scene_id, - }), - }); - - if (!response.ok) { - throw new Error(`Failed to activate scene: ${response.statusText}`); - } - - return { - success: true, - message: `Successfully activated scene ${params.scene_id}`, - }; - } - - throw new Error('Invalid action specified'); - } catch (error) { - return { - success: false, - message: error instanceof Error ? error.message : 'Unknown error occurred', - }; - } - }, - }; - server.addTool(sceneTool); - tools.push(sceneTool); - - // Add the notification tool - const notifyTool = { - name: 'notify', - description: 'Send notifications through Home Assistant', - parameters: z.object({ - message: z.string().describe('The notification message'), - title: z.string().optional().describe('The notification title'), - target: z.string().optional().describe('Specific notification target (e.g., mobile_app_phone)'), - data: z.record(z.any()).optional().describe('Additional notification data'), - }), - execute: async (params: NotifyParams) => { - try { - const service = params.target ? `notify.${params.target}` : 'notify.notify'; - const [domain, service_name] = service.split('.'); - - const response = await fetch(`${HASS_HOST}/api/services/${domain}/${service_name}`, { - method: 'POST', - headers: { - Authorization: `Bearer ${HASS_TOKEN}`, - 'Content-Type': 'application/json', - }, - body: JSON.stringify({ - message: params.message, - title: params.title, - data: params.data, - }), - }); - - if (!response.ok) { - throw new Error(`Failed to send notification: ${response.statusText}`); - } - - return { - success: true, - message: 'Notification sent successfully', - }; - } catch (error) { - return { - success: false, - message: error instanceof Error ? error.message : 'Unknown error occurred', - }; - } - }, - }; - server.addTool(notifyTool); - tools.push(notifyTool); - - // Add the automation tool - const automationTool = { - name: 'automation', - description: 'Manage Home Assistant automations', - parameters: z.object({ - action: z.enum(['list', 'toggle', 'trigger']).describe('Action to perform with automation'), - automation_id: z.string().optional().describe('Automation ID (required for toggle and trigger actions)'), - }), - execute: async (params: AutomationParams) => { - try { - if (params.action === 'list') { - const response = await fetch(`${HASS_HOST}/api/states`, { - headers: { - Authorization: `Bearer ${HASS_TOKEN}`, - 'Content-Type': 'application/json', - }, - }); - - if (!response.ok) { - throw new Error(`Failed to fetch automations: ${response.statusText}`); - } - - const states = (await response.json()) as HassState[]; - const automations = states.filter((state) => state.entity_id.startsWith('automation.')); - - return { - success: true, - automations: automations.map((automation) => ({ - entity_id: automation.entity_id, - name: automation.attributes.friendly_name || automation.entity_id.split('.')[1], - state: automation.state, - last_triggered: automation.attributes.last_triggered, - })), - }; - } else { - if (!params.automation_id) { - throw new Error('Automation ID is required for toggle and trigger actions'); - } - - const service = params.action === 'toggle' ? 'toggle' : 'trigger'; - const response = await fetch(`${HASS_HOST}/api/services/automation/${service}`, { - method: 'POST', - headers: { - Authorization: `Bearer ${HASS_TOKEN}`, - 'Content-Type': 'application/json', - }, - body: JSON.stringify({ - entity_id: params.automation_id, - }), - }); - - if (!response.ok) { - throw new Error(`Failed to ${service} automation: ${response.statusText}`); - } - - const responseData = await response.json() as AutomationResponse; - return { - success: true, - message: `Successfully ${service}d automation ${params.automation_id}`, - automation_id: responseData.automation_id, - }; - } - } catch (error) { - return { - success: false, - message: error instanceof Error ? error.message : 'Unknown error occurred', - }; - } - }, - }; - server.addTool(automationTool); - tools.push(automationTool); - - // Add the addon tool - const addonTool = { - name: 'addon', - description: 'Manage Home Assistant add-ons', - parameters: z.object({ - action: z.enum(['list', 'info', 'install', 'uninstall', 'start', 'stop', 'restart']).describe('Action to perform with add-on'), - slug: z.string().optional().describe('Add-on slug (required for all actions except list)'), - version: z.string().optional().describe('Version to install (only for install action)'), - }), - execute: async (params: AddonParams) => { - try { - if (params.action === 'list') { - const response = await fetch(`${HASS_HOST}/api/hassio/store`, { - headers: { - Authorization: `Bearer ${HASS_TOKEN}`, - 'Content-Type': 'application/json', - }, - }); - - if (!response.ok) { - throw new Error(`Failed to fetch add-ons: ${response.statusText}`); - } - - const data = await response.json() as HassAddonResponse; - return { - success: true, - addons: data.data.addons.map((addon) => ({ - name: addon.name, - slug: addon.slug, - description: addon.description, - version: addon.version, - installed: addon.installed, - available: addon.available, - state: addon.state, - })), - }; - } else { - if (!params.slug) { - throw new Error('Add-on slug is required for this action'); - } - - let endpoint = ''; - let method = 'GET'; - const body: Record = {}; - - switch (params.action) { - case 'info': - endpoint = `/api/hassio/addons/${params.slug}/info`; - break; - case 'install': - endpoint = `/api/hassio/addons/${params.slug}/install`; - method = 'POST'; - if (params.version) { - body.version = params.version; - } - break; - case 'uninstall': - endpoint = `/api/hassio/addons/${params.slug}/uninstall`; - method = 'POST'; - break; - case 'start': - endpoint = `/api/hassio/addons/${params.slug}/start`; - method = 'POST'; - break; - case 'stop': - endpoint = `/api/hassio/addons/${params.slug}/stop`; - method = 'POST'; - break; - case 'restart': - endpoint = `/api/hassio/addons/${params.slug}/restart`; - method = 'POST'; - break; - } - - const response = await fetch(`${HASS_HOST}${endpoint}`, { - method, - headers: { - Authorization: `Bearer ${HASS_TOKEN}`, - 'Content-Type': 'application/json', - }, - ...(Object.keys(body).length > 0 && { body: JSON.stringify(body) }), - }); - - if (!response.ok) { - throw new Error(`Failed to ${params.action} add-on: ${response.statusText}`); - } - - const data = await response.json() as HassAddonInfoResponse; - return { - success: true, - message: `Successfully ${params.action}ed add-on ${params.slug}`, - data: data.data, - }; - } - } catch (error) { - return { - success: false, - message: error instanceof Error ? error.message : 'Unknown error occurred', - }; - } - }, - }; - server.addTool(addonTool); - tools.push(addonTool); - - // Add the package tool - const packageTool = { - name: 'package', - description: 'Manage HACS packages and custom components', - parameters: z.object({ - action: z.enum(['list', 'install', 'uninstall', 'update']).describe('Action to perform with package'), - category: z.enum(['integration', 'plugin', 'theme', 'python_script', 'appdaemon', 'netdaemon']) - .describe('Package category'), - repository: z.string().optional().describe('Repository URL or name (required for install)'), - version: z.string().optional().describe('Version to install'), - }), - execute: async (params: PackageParams) => { - try { - const hacsBase = `${HASS_HOST}/api/hacs`; - - if (params.action === 'list') { - const response = await fetch(`${hacsBase}/repositories?category=${params.category}`, { - headers: { - Authorization: `Bearer ${HASS_TOKEN}`, - 'Content-Type': 'application/json', - }, - }); - - if (!response.ok) { - throw new Error(`Failed to fetch packages: ${response.statusText}`); - } - - const data = await response.json() as HacsResponse; - return { - success: true, - packages: data.repositories, - }; - } else { - if (!params.repository) { - throw new Error('Repository is required for this action'); - } - - let endpoint = ''; - const body: Record = { - category: params.category, - repository: params.repository, - }; - - switch (params.action) { - case 'install': - endpoint = '/repository/install'; - if (params.version) { - body.version = params.version; - } - break; - case 'uninstall': - endpoint = '/repository/uninstall'; - break; - case 'update': - endpoint = '/repository/update'; - break; - } - - const response = await fetch(`${hacsBase}${endpoint}`, { - method: 'POST', - headers: { - Authorization: `Bearer ${HASS_TOKEN}`, - 'Content-Type': 'application/json', - }, - body: JSON.stringify(body), - }); - - if (!response.ok) { - throw new Error(`Failed to ${params.action} package: ${response.statusText}`); - } - - return { - success: true, - message: `Successfully ${params.action}ed package ${params.repository}`, - }; - } - } catch (error) { - return { - success: false, - message: error instanceof Error ? error.message : 'Unknown error occurred', - }; - } - }, - }; - server.addTool(packageTool); - tools.push(packageTool); - - // Extend the automation tool with more functionality - const automationConfigTool = { - name: 'automation_config', - description: 'Advanced automation configuration and management', - parameters: z.object({ - action: z.enum(['create', 'update', 'delete', 'duplicate']).describe('Action to perform with automation config'), - automation_id: z.string().optional().describe('Automation ID (required for update, delete, and duplicate)'), - config: z.object({ - alias: z.string().describe('Friendly name for the automation'), - description: z.string().optional().describe('Description of what the automation does'), - mode: z.enum(['single', 'parallel', 'queued', 'restart']).optional().describe('How multiple triggerings are handled'), - trigger: z.array(z.any()).describe('List of triggers'), - condition: z.array(z.any()).optional().describe('List of conditions'), - action: z.array(z.any()).describe('List of actions'), - }).optional().describe('Automation configuration (required for create and update)'), - }), - execute: async (params: AutomationConfigParams) => { - try { - switch (params.action) { - case 'create': { - if (!params.config) { - throw new Error('Configuration is required for creating automation'); - } - - const response = await fetch(`${HASS_HOST}/api/config/automation/config`, { - method: 'POST', - headers: { - Authorization: `Bearer ${HASS_TOKEN}`, - 'Content-Type': 'application/json', - }, - body: JSON.stringify(params.config), - }); - - if (!response.ok) { - throw new Error(`Failed to create automation: ${response.statusText}`); - } - - const responseData = await response.json() as { automation_id: string }; - return { - success: true, - message: 'Successfully created automation', - automation_id: responseData.automation_id, - }; - } - - case 'update': { - if (!params.automation_id || !params.config) { - throw new Error('Automation ID and configuration are required for updating automation'); - } - - const response = await fetch(`${HASS_HOST}/api/config/automation/config/${params.automation_id}`, { - method: 'PUT', - headers: { - Authorization: `Bearer ${HASS_TOKEN}`, - 'Content-Type': 'application/json', - }, - body: JSON.stringify(params.config), - }); - - if (!response.ok) { - throw new Error(`Failed to update automation: ${response.statusText}`); - } - - const responseData = await response.json() as { automation_id: string }; - return { - success: true, - automation_id: responseData.automation_id, - message: 'Automation updated successfully' - }; - } - - case 'delete': { - if (!params.automation_id) { - throw new Error('Automation ID is required for deleting automation'); - } - - const response = await fetch(`${HASS_HOST}/api/config/automation/config/${params.automation_id}`, { - method: 'DELETE', - headers: { - Authorization: `Bearer ${HASS_TOKEN}`, - 'Content-Type': 'application/json', - }, - }); - - if (!response.ok) { - throw new Error(`Failed to delete automation: ${response.statusText}`); - } - - return { - success: true, - message: `Successfully deleted automation ${params.automation_id}`, - }; - } - - case 'duplicate': { - if (!params.automation_id) { - throw new Error('Automation ID is required for duplicating automation'); - } - - // First, get the existing automation config - const getResponse = await fetch(`${HASS_HOST}/api/config/automation/config/${params.automation_id}`, { - headers: { - Authorization: `Bearer ${HASS_TOKEN}`, - 'Content-Type': 'application/json', - }, - }); - - if (!getResponse.ok) { - throw new Error(`Failed to get automation config: ${getResponse.statusText}`); - } - - const config = await getResponse.json() as AutomationConfig; - config.alias = `${config.alias} (Copy)`; - - // Create new automation with modified config - const createResponse = await fetch(`${HASS_HOST}/api/config/automation/config`, { - method: 'POST', - headers: { - Authorization: `Bearer ${HASS_TOKEN}`, - 'Content-Type': 'application/json', - }, - body: JSON.stringify(config), - }); - - if (!createResponse.ok) { - throw new Error(`Failed to create duplicate automation: ${createResponse.statusText}`); - } - - const newAutomation = await createResponse.json() as AutomationResponse; - return { - success: true, - message: `Successfully duplicated automation ${params.automation_id}`, - new_automation_id: newAutomation.automation_id, - }; - } - } - } catch (error) { - return { - success: false, - message: error instanceof Error ? error.message : 'Unknown error occurred', - }; - } - }, - }; - server.addTool(automationConfigTool); - tools.push(automationConfigTool); - - // Add SSE endpoint - const subscribeEventsTool = { - name: 'subscribe_events', - description: 'Subscribe to Home Assistant events via Server-Sent Events (SSE)', - parameters: z.object({ - token: z.string().describe('Authentication token (required)'), - events: z.array(z.string()).optional().describe('List of event types to subscribe to'), - entity_id: z.string().optional().describe('Specific entity ID to monitor for state changes'), - domain: z.string().optional().describe('Domain to monitor (e.g., "light", "switch", etc.)'), - }), - execute: async (params: SSEParams) => { - const clientId = uuidv4(); - - // Set up SSE headers - const responseHeaders = { - 'Content-Type': 'text/event-stream', - 'Cache-Control': 'no-cache', - 'Connection': 'keep-alive', - }; - - // Create SSE client - const client = { - id: clientId, - send: (data: string) => { - return { - headers: responseHeaders, - body: `data: ${data}\n\n`, - keepAlive: true - }; - } - }; - - // Add client to SSE manager with authentication - const sseClient = sseManager.addClient(client, params.token); - - if (!sseClient || !sseClient.authenticated) { - return { - success: false, - message: sseClient ? 'Authentication failed' : 'Maximum client limit reached' - }; - } - - // Subscribe to specific events if provided - if (params.events?.length) { - console.log(`Client ${clientId} subscribing to events:`, params.events); - for (const eventType of params.events) { - sseManager.subscribeToEvent(clientId, eventType); - } - } - - // Subscribe to specific entity if provided - if (params.entity_id) { - console.log(`Client ${clientId} subscribing to entity:`, params.entity_id); - sseManager.subscribeToEntity(clientId, params.entity_id); - } - - // Subscribe to domain if provided - if (params.domain) { - console.log(`Client ${clientId} subscribing to domain:`, params.domain); - sseManager.subscribeToDomain(clientId, params.domain); - } - - return { - headers: responseHeaders, - body: `data: ${JSON.stringify({ - type: 'connection', - status: 'connected', - id: clientId, - authenticated: true, - subscriptions: { - events: params.events || [], - entities: params.entity_id ? [params.entity_id] : [], - domains: params.domain ? [params.domain] : [] - }, - timestamp: new Date().toISOString() - })}\n\n`, - keepAlive: true - }; - } - }; - server.addTool(subscribeEventsTool); - tools.push(subscribeEventsTool); - - // Add statistics endpoint - const getSSEStatsTool = { - name: 'get_sse_stats', - description: 'Get SSE connection statistics', - parameters: z.object({ - token: z.string().describe('Authentication token (required)') - }), - execute: async (params: { token: string }) => { - if (params.token !== HASS_TOKEN) { - return { - success: false, - message: 'Authentication failed' - }; - } - - return { - success: true, - statistics: sseManager.getStatistics() - }; - } - }; - server.addTool(getSSEStatsTool); - tools.push(getSSEStatsTool); - - logger.debug('[server:init]', 'Initializing MCP Server...'); - - // Start the server - await server.start(); - logger.info('[server:init]', `MCP Server started on port ${PORT}`); - logger.info('[server:init]', 'Home Assistant server running on stdio'); - logger.info('[server:init]', 'SSE endpoints initialized'); - - // Log available endpoints using our tracked tools array - logger.info('[server:endpoints]', '\nAvailable API Endpoints:'); - tools.forEach((tool: Tool) => { - logger.info('[server:endpoints]', `- ${tool.name}: ${tool.description}`); +// Start the server +const server = app.listen(PORT, () => { + console.log(`Server is running on port ${PORT}`); +}); + +// Handle server shutdown +process.on("SIGTERM", () => { + console.log("Received SIGTERM. Shutting down gracefully..."); + void server.close(() => { + console.log("Server closed"); + process.exit(0); }); - - // Log SSE endpoints - logger.info('[server:endpoints]', '\nAvailable SSE Endpoints:'); - logger.info('[server:endpoints]', '- /subscribe_events'); - logger.info('[server:endpoints]', ' Parameters:'); - logger.info('[server:endpoints]', ' - token: Authentication token (required)'); - logger.info('[server:endpoints]', ' - events: List of event types to subscribe to (optional)'); - logger.info('[server:endpoints]', ' - entity_id: Specific entity ID to monitor (optional)'); - logger.info('[server:endpoints]', ' - domain: Domain to monitor (e.g., "light", "switch") (optional)'); - logger.info('[server:endpoints]', '\n- /get_sse_stats'); - logger.info('[server:endpoints]', ' Parameters:'); - logger.info('[server:endpoints]', ' - token: Authentication token (required)'); - - // Log successful initialization - logger.info('[server:init]', '\nServer initialization complete. Ready to handle requests.'); - - // Start the Express server - app.listen(PORT, () => { - logger.info('[server:init]', `Express server listening on port ${PORT}`); - }); -} - -main().catch(console.error); \ No newline at end of file +}); diff --git a/src/interfaces/hass.ts b/src/interfaces/hass.ts index c566b13..79dc845 100644 --- a/src/interfaces/hass.ts +++ b/src/interfaces/hass.ts @@ -2,79 +2,92 @@ // Home Assistant entity types export interface HassEntity { - entity_id: string; - state: string; - attributes: Record; - last_changed?: string; - last_updated?: string; - context?: { - id: string; - parent_id?: string; - user_id?: string; - }; + entity_id: string; + state: string; + attributes: Record; + last_changed?: string; + last_updated?: string; + context?: { + id: string; + parent_id?: string; + user_id?: string; + }; } export interface HassState { - entity_id: string; - state: string; - attributes: { - friendly_name?: string; - description?: string; - [key: string]: any; - }; + entity_id: string; + state: string; + attributes: { + friendly_name?: string; + description?: string; + [key: string]: any; + }; } // Home Assistant instance types export interface HassInstance { - states: HassStates; - services: HassServices; - connection: HassConnection; - subscribeEvents: (callback: (event: HassEvent) => void, eventType?: string) => Promise; - unsubscribeEvents: (subscription: number) => void; + states: HassStates; + services: HassServices; + connection: HassConnection; + subscribeEvents: ( + callback: (event: HassEvent) => void, + eventType?: string, + ) => Promise; + unsubscribeEvents: (subscription: number) => void; } export interface HassStates { - get: () => Promise; - subscribe: (callback: (states: HassEntity[]) => void) => Promise; - unsubscribe: (subscription: number) => void; + get: () => Promise; + subscribe: (callback: (states: HassEntity[]) => void) => Promise; + unsubscribe: (subscription: number) => void; } export interface HassServices { - get: () => Promise>>; - call: (domain: string, service: string, serviceData?: Record) => Promise; + get: () => Promise>>; + call: ( + domain: string, + service: string, + serviceData?: Record, + ) => Promise; } export interface HassConnection { - socket: WebSocket; - subscribeEvents: (callback: (event: HassEvent) => void, eventType?: string) => Promise; - unsubscribeEvents: (subscription: number) => void; + socket: WebSocket; + subscribeEvents: ( + callback: (event: HassEvent) => void, + eventType?: string, + ) => Promise; + unsubscribeEvents: (subscription: number) => void; } export interface HassService { - name: string; - description: string; - target?: { - entity?: { - domain: string[]; - }; + name: string; + description: string; + target?: { + entity?: { + domain: string[]; }; - fields: Record; + }; + fields: Record< + string, + { + name: string; + description: string; + required?: boolean; + example?: any; + selector?: any; + } + >; } export interface HassEvent { - event_type: string; - data: Record; - origin: string; - time_fired: string; - context: { - id: string; - parent_id?: string; - user_id?: string; - }; -} \ No newline at end of file + event_type: string; + data: Record; + origin: string; + time_fired: string; + context: { + id: string; + parent_id?: string; + user_id?: string; + }; +} diff --git a/src/interfaces/index.ts b/src/interfaces/index.ts index 3a4be28..97d8505 100644 --- a/src/interfaces/index.ts +++ b/src/interfaces/index.ts @@ -1,170 +1,183 @@ -import { z } from 'zod'; +import { z } from "zod"; // Tool interfaces export interface Tool { - name: string; - description: string; - parameters: z.ZodType; - execute: (params: any) => Promise; + name: string; + description: string; + parameters: z.ZodType; + execute: (params: any) => Promise; } // Command interfaces export interface CommandParams { - command: string; - entity_id: string; - // Common parameters - state?: string; - // Light parameters - brightness?: number; - color_temp?: number; - rgb_color?: [number, number, number]; - // Cover parameters - position?: number; - tilt_position?: number; - // Climate parameters - temperature?: number; - target_temp_high?: number; - target_temp_low?: number; - hvac_mode?: string; - fan_mode?: string; - humidity?: number; + command: string; + entity_id: string; + // Common parameters + state?: string; + // Light parameters + brightness?: number; + color_temp?: number; + rgb_color?: [number, number, number]; + // Cover parameters + position?: number; + tilt_position?: number; + // Climate parameters + temperature?: number; + target_temp_high?: number; + target_temp_low?: number; + hvac_mode?: string; + fan_mode?: string; + humidity?: number; } // Re-export Home Assistant types export type { - HassInstance, - HassStates, - HassServices, - HassConnection, - HassService, - HassEvent, - HassEntity, - HassState -} from './hass.js'; + HassInstance, + HassStates, + HassServices, + HassConnection, + HassService, + HassEvent, + HassEntity, + HassState, +} from "./hass.js"; // Home Assistant interfaces export interface HassAddon { + name: string; + slug: string; + description: string; + version: string; + installed: boolean; + available: boolean; + state: string; +} + +export interface HassAddonResponse { + data: { + addons: HassAddon[]; + }; +} + +export interface HassAddonInfoResponse { + data: { name: string; slug: string; description: string; version: string; - installed: boolean; - available: boolean; state: string; -} - -export interface HassAddonResponse { - data: { - addons: HassAddon[]; - }; -} - -export interface HassAddonInfoResponse { - data: { - name: string; - slug: string; - description: string; - version: string; - state: string; - status: string; - options: Record; - [key: string]: any; - }; + status: string; + options: Record; + [key: string]: any; + }; } // HACS interfaces export interface HacsRepository { - name: string; - description: string; - category: string; - installed: boolean; - version_installed: string; - available_version: string; - authors: string[]; - domain: string; + name: string; + description: string; + category: string; + installed: boolean; + version_installed: string; + available_version: string; + authors: string[]; + domain: string; } export interface HacsResponse { - repositories: HacsRepository[]; + repositories: HacsRepository[]; } // Automation interfaces export interface AutomationConfig { - alias: string; - description?: string; - mode?: 'single' | 'parallel' | 'queued' | 'restart'; - trigger: any[]; - condition?: any[]; - action: any[]; + alias: string; + description?: string; + mode?: "single" | "parallel" | "queued" | "restart"; + trigger: any[]; + condition?: any[]; + action: any[]; } export interface AutomationResponse { - automation_id: string; + automation_id: string; } // SSE interfaces export interface SSEHeaders { - onAbort?: () => void; + onAbort?: () => void; } export interface SSEParams { - token: string; - events?: string[]; - entity_id?: string; - domain?: string; + token: string; + events?: string[]; + entity_id?: string; + domain?: string; } // History interfaces export interface HistoryParams { - entity_id: string; - start_time?: string; - end_time?: string; - minimal_response?: boolean; - significant_changes_only?: boolean; + entity_id: string; + start_time?: string; + end_time?: string; + minimal_response?: boolean; + significant_changes_only?: boolean; } // Scene interfaces export interface SceneParams { - action: 'list' | 'activate'; - scene_id?: string; + action: "list" | "activate"; + scene_id?: string; } // Notification interfaces export interface NotifyParams { - message: string; - title?: string; - target?: string; - data?: Record; + message: string; + title?: string; + target?: string; + data?: Record; } // Automation parameter interfaces export interface AutomationParams { - action: 'list' | 'toggle' | 'trigger'; - automation_id?: string; + action: "list" | "toggle" | "trigger"; + automation_id?: string; } export interface AddonParams { - action: 'list' | 'info' | 'install' | 'uninstall' | 'start' | 'stop' | 'restart'; - slug?: string; - version?: string; + action: + | "list" + | "info" + | "install" + | "uninstall" + | "start" + | "stop" + | "restart"; + slug?: string; + version?: string; } export interface PackageParams { - action: 'list' | 'install' | 'uninstall' | 'update'; - category: 'integration' | 'plugin' | 'theme' | 'python_script' | 'appdaemon' | 'netdaemon'; - repository?: string; - version?: string; + action: "list" | "install" | "uninstall" | "update"; + category: + | "integration" + | "plugin" + | "theme" + | "python_script" + | "appdaemon" + | "netdaemon"; + repository?: string; + version?: string; } export interface AutomationConfigParams { - action: 'create' | 'update' | 'delete' | 'duplicate'; - automation_id?: string; - config?: { - alias: string; - description?: string; - mode?: 'single' | 'parallel' | 'queued' | 'restart'; - trigger: any[]; - condition?: any[]; - action: any[]; - }; -} \ No newline at end of file + action: "create" | "update" | "delete" | "duplicate"; + automation_id?: string; + config?: { + alias: string; + description?: string; + mode?: "single" | "parallel" | "queued" | "restart"; + trigger: any[]; + condition?: any[]; + action: any[]; + }; +} diff --git a/src/mcp/litemcp.ts b/src/mcp/litemcp.ts index 533bd0d..2b637c0 100644 --- a/src/mcp/litemcp.ts +++ b/src/mcp/litemcp.ts @@ -1,61 +1,67 @@ -import { EventEmitter } from 'events'; +import { EventEmitter } from "events"; export class LiteMCP extends EventEmitter { - private static instance: LiteMCP; - private constructor() { - super(); - // Initialize with default configuration - this.configure({}); - } + private static instance: LiteMCP; + private constructor() { + super(); + // Initialize with default configuration + this.configure({}); + } - public static getInstance(): LiteMCP { - if (!LiteMCP.instance) { - LiteMCP.instance = new LiteMCP(); - } - return LiteMCP.instance; + public static getInstance(): LiteMCP { + if (!LiteMCP.instance) { + LiteMCP.instance = new LiteMCP(); } + return LiteMCP.instance; + } - public configure(config: Record): void { - // Store configuration - this.config = { - ...this.defaultConfig, - ...config - }; - } - - private config: Record = {}; - private defaultConfig = { - maxRetries: 3, - retryDelay: 1000, - timeout: 5000 + public configure(config: Record): void { + // Store configuration + this.config = { + ...this.defaultConfig, + ...config, }; + } - public async execute(command: string, params: Record = {}): Promise { - try { - // Emit command execution event - this.emit('command', { command, params }); + private config: Record = {}; + private defaultConfig = { + maxRetries: 3, + retryDelay: 1000, + timeout: 5000, + }; - // Execute command logic here - const result = await this.processCommand(command, params); + public async execute( + command: string, + params: Record = {}, + ): Promise { + try { + // Emit command execution event + this.emit("command", { command, params }); - // Emit success event - this.emit('success', { command, params, result }); + // Execute command logic here + const result = await this.processCommand(command, params); - return result; - } catch (error) { - // Emit error event - this.emit('error', { command, params, error }); - throw error; - } + // Emit success event + this.emit("success", { command, params, result }); + + return result; + } catch (error) { + // Emit error event + this.emit("error", { command, params, error }); + throw error; } + } - private async processCommand(command: string, params: Record): Promise { - // Command processing logic - return { command, params, status: 'processed' }; - } + private async processCommand( + command: string, + params: Record, + ): Promise { + // Command processing logic + return { command, params, status: "processed" }; + } - public async shutdown(): Promise { - // Cleanup logic - this.removeAllListeners(); - } -} \ No newline at end of file + public async shutdown(): Promise { + // Cleanup logic + this.removeAllListeners(); + } +} diff --git a/src/mcp/schema.ts b/src/mcp/schema.ts index b040912..f6fb965 100644 --- a/src/mcp/schema.ts +++ b/src/mcp/schema.ts @@ -1,357 +1,398 @@ -import { z } from 'zod'; -import { DomainSchema } from '../schemas.js'; +import { z } from "zod"; +import { DomainSchema } from "../schemas.js"; export const MCP_SCHEMA = { - tools: [ - { - name: "list_devices", - description: "List all devices connected to Home Assistant", - parameters: { - type: "object", - properties: { - domain: { - type: "string", - enum: [ - "light", - "climate", - "alarm_control_panel", - "cover", - "switch", - "contact", - "media_player", - "fan", - "lock", - "vacuum", - "scene", - "script", - "camera" - ] - }, - area: { type: "string" }, - floor: { type: "string" } - }, - required: [] - } + tools: [ + { + name: "list_devices", + description: "List all devices connected to Home Assistant", + parameters: { + type: "object", + properties: { + domain: { + type: "string", + enum: [ + "light", + "climate", + "alarm_control_panel", + "cover", + "switch", + "contact", + "media_player", + "fan", + "lock", + "vacuum", + "scene", + "script", + "camera", + ], + }, + area: { type: "string" }, + floor: { type: "string" }, }, - { - name: "control", - description: "Control Home Assistant entities (lights, climate, etc.)", - parameters: { - type: "object", - properties: { - command: { - type: "string", - enum: [ - "turn_on", - "turn_off", - "toggle", - "open", - "close", - "stop", - "set_position", - "set_tilt_position", - "set_temperature", - "set_hvac_mode", - "set_fan_mode", - "set_humidity" - ] - }, - entity_id: { type: "string" }, - state: { type: "string" }, - brightness: { type: "number" }, - color_temp: { type: "number" }, - rgb_color: { - type: "array", - items: { type: "number" }, - minItems: 3, - maxItems: 3 - }, - position: { type: "number" }, - tilt_position: { type: "number" }, - temperature: { type: "number" }, - target_temp_high: { type: "number" }, - target_temp_low: { type: "number" }, - hvac_mode: { type: "string" }, - fan_mode: { type: "string" }, - humidity: { type: "number" } - }, - required: ["command", "entity_id"] - } + required: [], + }, + }, + { + name: "control", + description: "Control Home Assistant entities (lights, climate, etc.)", + parameters: { + type: "object", + properties: { + command: { + type: "string", + enum: [ + "turn_on", + "turn_off", + "toggle", + "open", + "close", + "stop", + "set_position", + "set_tilt_position", + "set_temperature", + "set_hvac_mode", + "set_fan_mode", + "set_humidity", + ], + }, + entity_id: { type: "string" }, + state: { type: "string" }, + brightness: { type: "number" }, + color_temp: { type: "number" }, + rgb_color: { + type: "array", + items: { type: "number" }, + minItems: 3, + maxItems: 3, + }, + position: { type: "number" }, + tilt_position: { type: "number" }, + temperature: { type: "number" }, + target_temp_high: { type: "number" }, + target_temp_low: { type: "number" }, + hvac_mode: { type: "string" }, + fan_mode: { type: "string" }, + humidity: { type: "number" }, }, - { - name: "subscribe_events", - description: "Subscribe to Home Assistant events via SSE", - parameters: { - type: "object", - properties: { - events: { - type: "array", - items: { type: "string" } - }, - entity_id: { type: "string" }, - domain: { type: "string" } - }, - required: [] - } + required: ["command", "entity_id"], + }, + }, + { + name: "subscribe_events", + description: "Subscribe to Home Assistant events via SSE", + parameters: { + type: "object", + properties: { + events: { + type: "array", + items: { type: "string" }, + }, + entity_id: { type: "string" }, + domain: { type: "string" }, }, - { - name: "get_sse_stats", - description: "Get statistics about SSE connections", - parameters: { - type: "object", - properties: {}, - required: [] - } - }, - { - name: "automation_config", - description: "Manage Home Assistant automations", - parameters: { - type: "object", - properties: { - action: { - type: "string", - enum: ["list", "toggle", "trigger", "create", "update", "delete"] - }, - automation_id: { type: "string" }, - config: { - type: "object", - properties: { - alias: { type: "string" }, - description: { type: "string" }, - mode: { - type: "string", - enum: ["single", "parallel", "queued", "restart"] - }, - trigger: { type: "array" }, - condition: { type: "array" }, - action: { type: "array" } - }, - required: ["alias", "trigger", "action"] - } - }, - required: ["action"] - } - }, - { - name: "addon_management", - description: "Manage Home Assistant add-ons", - parameters: { - type: "object", - properties: { - action: { - type: "string", - enum: ["list", "info", "install", "uninstall", "start", "stop", "restart"] - }, - slug: { type: "string" }, - version: { type: "string" } - }, - required: ["action"] - } - }, - { - name: "package_management", - description: "Manage HACS packages", - parameters: { - type: "object", - properties: { - action: { - type: "string", - enum: ["list", "install", "uninstall", "update"] - }, - category: { - type: "string", - enum: ["integration", "plugin", "theme", "python_script", "appdaemon", "netdaemon"] - }, - repository: { type: "string" }, - version: { type: "string" } - }, - required: ["action", "category"] - } - }, - { - name: "scene_control", - description: "Manage and activate scenes", - parameters: { - type: "object", - properties: { - action: { - type: "string", - enum: ["list", "activate"] - }, - scene_id: { type: "string" } - }, - required: ["action"] - } - }, - { - name: "notify", - description: "Send notifications through Home Assistant", - parameters: { - type: "object", - properties: { - message: { type: "string" }, - title: { type: "string" }, - target: { type: "string" }, - data: { - type: "object", - additionalProperties: true - } - }, - required: ["message"] - } - }, - { - name: "history", - description: "Retrieve historical data for entities", - parameters: { - type: "object", - properties: { - entity_id: { type: "string" }, - start_time: { type: "string" }, - end_time: { type: "string" }, - minimal_response: { type: "boolean" }, - significant_changes_only: { type: "boolean" } - }, - required: ["entity_id"] - } - } - ], - prompts: [ - { - name: "claude", - description: "Claude-specific prompt template for home automation control", - template: { - system: "You are Claude, an AI assistant specialized in home automation control through natural language. Your role is to interpret user commands and translate them into specific device control actions. Always maintain context awareness and consider user preferences and patterns. Provide clear, concise responses and suggest relevant follow-up actions.", - user: "Control the {device_name} in the {location} by {action} with parameters: {parameters}. Current context: {context}", - examples: [ - { - user: "Turn on the living room lights", - assistant: "I'll turn on the lights in the living room. Would you like me to set a specific brightness level?" - }, - { - user: "Set the temperature to 72 degrees", - assistant: "I'll set the temperature to 72°F. I'll monitor the temperature and let you know when it reaches the target." - }, - { - user: "Open the kitchen blinds halfway", - assistant: "Setting the kitchen blinds to 50% open position. Would you like me to adjust the slat angle as well?" - }, - { - user: "Start the coffee maker", - assistant: "I'll start the coffee maker in the kitchen. Based on your usual preferences, I'll use the strong brew setting. Would you like me to adjust any settings?" - }, - { - user: "Set up the house for bedtime", - assistant: "I'll activate the bedtime routine: dimming hallway lights to 20%, turning off all other lights, setting temperature to your preferred sleeping temperature of 68°F, locking all doors, and arming the security system." - }, - { - user: "Play some music in the bedroom", - assistant: "I'll start playing music on the bedroom speaker. Based on this time of day and your preferences, I'll start your 'Evening Relaxation' playlist at 40% volume. Would you like to adjust any of these settings?" - }, - { - user: "Check if I left any windows open", - assistant: "I'll check all window sensors. The kitchen window and guest bedroom window are currently open. Would you like me to notify you if any windows remain open after sunset?" - } - ] - } - }, - { - name: "gpt4", - description: "GPT-4 specific prompt template for precise home automation control", - template: { - system: "You are a home automation assistant powered by GPT-4. Focus on precise command interpretation and execution. Maintain high accuracy in device control and parameter settings. Provide feedback on action success and system state changes.", - user: "Command: {action} {device_name} in {location}\nParameters: {parameters}\nContext: {context}", - examples: [ - { - user: "Dim the bedroom lights to 50%", - assistant: "Setting bedroom light brightness to 50%. The change has been applied successfully." - }, - { - user: "Start the evening routine", - assistant: "Initiating evening routine: dimming lights, adjusting temperature, and enabling security system." - }, - { - user: "Set living room AC to 74 degrees and high fan", - assistant: "Configuring living room climate control: temperature set to 74°F, fan mode set to high. Current temperature is 78°F, estimated time to target: 15 minutes." - }, - { - user: "Lock all doors and windows", - assistant: "Security check initiated. All 4 doors locked successfully. 6/7 windows locked. Alert: Kitchen window cannot be locked remotely - manual intervention required." - }, - { - user: "Turn on outdoor lights at sunset", - assistant: "Scheduled task created. Outdoor lights (porch, pathway, garage) will activate at sunset (7:45 PM today). Current light sensor reading: 24,000 lux." - }, - { - user: "Set up the media room for movie night", - assistant: "Executing media room configuration: TV power on, input set to HDMI 2, surround sound activated at 40%, lights dimmed to 10%, blackout blinds closed. Room temperature adjusted to 72°F." - }, - { - user: "Show me energy usage for today", - assistant: "Retrieving energy data: Total usage today: 24.5 kWh. Peak consumption: 3.2 kWh (2-3 PM). Major consumers: HVAC (45%), Water Heater (25%), Kitchen Appliances (15%)." - } - ] - } - }, - { - name: "custom", - description: "Customizable prompt template for home automation control", - template: { - system: "Custom home automation assistant configuration. Adapt to user preferences and patterns. Learn from interactions and optimize responses. Provide detailed feedback and suggestions.", - user: "Action requested: {action}\nTarget device: {device_name}\nLocation: {location}\nParameters: {parameters}\nCurrent context: {context}", - examples: [ - { - user: "Make it cooler in here", - assistant: "Based on your preferences, I'll lower the temperature by 2 degrees. Current temperature is 74°F, adjusting to 72°F." - }, - { - user: "Set up movie mode", - assistant: "Activating movie mode: dimming lights to 20%, closing blinds, setting TV input to HDMI 1, and adjusting sound system." - }, - { - user: "I'm heading to bed", - assistant: "Initiating personalized bedtime sequence: Setting master bedroom temperature to 68°F, activating white noise machine at volume level 3, dimming hallway lights to 15%, turning off all other lights, closing all blinds, and enabling sleep mode on your phone charger." - }, - { - user: "Start my morning routine", - assistant: "Good morning! Executing your weekday morning routine: Gradually increasing bedroom lights (now at 30%), starting coffee maker with your weekday strength setting, setting bathroom heater to 72°F, and pulling up today's weather and calendar on your kitchen display." - }, - { - user: "I'm working from home today", - assistant: "Activating work-from-home environment: Setting home office lights to your preferred 5000K color temperature at 80% brightness, adjusting HVAC for daytime occupancy, enabling do-not-disturb on doorbell, and configuring automated breaks reminder every 2 hours." - }, - { - user: "We're having guests over", - assistant: "Preparing home for guests: Adjusting living room and dining room temperature to 72°F, setting accent lighting to warm white (2700K), activating air purifier in high mode, enabling guest WiFi network, and preheating the oven as per your usual entertaining preferences." - }, - { - user: "Monitor the baby's room", - assistant: "Activating enhanced nursery monitoring: Setting up temperature alerts (68-72°F range), enabling sound monitoring with smart notification threshold, maintaining humidity at 50%, and activating the smart night light with color changing based on sleep schedule. Current readings: 70°F, 48% humidity, sound level: minimal." - } - ] + required: [], + }, + }, + { + name: "get_sse_stats", + description: "Get statistics about SSE connections", + parameters: { + type: "object", + properties: {}, + required: [], + }, + }, + { + name: "automation_config", + description: "Manage Home Assistant automations", + parameters: { + type: "object", + properties: { + action: { + type: "string", + enum: ["list", "toggle", "trigger", "create", "update", "delete"], + }, + automation_id: { type: "string" }, + config: { + type: "object", + properties: { + alias: { type: "string" }, + description: { type: "string" }, + mode: { + type: "string", + enum: ["single", "parallel", "queued", "restart"], + }, + trigger: { type: "array" }, + condition: { type: "array" }, + action: { type: "array" }, }, - variables: { - device_name: "string", - location: "string", - action: "string", - parameters: "object", - context: "object" - } - } - ], - resources: [ - { - name: "Home Assistant API", - url: "https://developers.home-assistant.io/docs/api/rest/" + required: ["alias", "trigger", "action"], + }, }, - { - name: "Home Assistant WebSocket API", - url: "https://developers.home-assistant.io/docs/api/websocket" + required: ["action"], + }, + }, + { + name: "addon_management", + description: "Manage Home Assistant add-ons", + parameters: { + type: "object", + properties: { + action: { + type: "string", + enum: [ + "list", + "info", + "install", + "uninstall", + "start", + "stop", + "restart", + ], + }, + slug: { type: "string" }, + version: { type: "string" }, }, - { - name: "HACS Documentation", - url: "https://hacs.xyz" - } - ] -}; \ No newline at end of file + required: ["action"], + }, + }, + { + name: "package_management", + description: "Manage HACS packages", + parameters: { + type: "object", + properties: { + action: { + type: "string", + enum: ["list", "install", "uninstall", "update"], + }, + category: { + type: "string", + enum: [ + "integration", + "plugin", + "theme", + "python_script", + "appdaemon", + "netdaemon", + ], + }, + repository: { type: "string" }, + version: { type: "string" }, + }, + required: ["action", "category"], + }, + }, + { + name: "scene_control", + description: "Manage and activate scenes", + parameters: { + type: "object", + properties: { + action: { + type: "string", + enum: ["list", "activate"], + }, + scene_id: { type: "string" }, + }, + required: ["action"], + }, + }, + { + name: "notify", + description: "Send notifications through Home Assistant", + parameters: { + type: "object", + properties: { + message: { type: "string" }, + title: { type: "string" }, + target: { type: "string" }, + data: { + type: "object", + additionalProperties: true, + }, + }, + required: ["message"], + }, + }, + { + name: "history", + description: "Retrieve historical data for entities", + parameters: { + type: "object", + properties: { + entity_id: { type: "string" }, + start_time: { type: "string" }, + end_time: { type: "string" }, + minimal_response: { type: "boolean" }, + significant_changes_only: { type: "boolean" }, + }, + required: ["entity_id"], + }, + }, + ], + prompts: [ + { + name: "claude", + description: + "Claude-specific prompt template for home automation control", + template: { + system: + "You are Claude, an AI assistant specialized in home automation control through natural language. Your role is to interpret user commands and translate them into specific device control actions. Always maintain context awareness and consider user preferences and patterns. Provide clear, concise responses and suggest relevant follow-up actions.", + user: "Control the {device_name} in the {location} by {action} with parameters: {parameters}. Current context: {context}", + examples: [ + { + user: "Turn on the living room lights", + assistant: + "I'll turn on the lights in the living room. Would you like me to set a specific brightness level?", + }, + { + user: "Set the temperature to 72 degrees", + assistant: + "I'll set the temperature to 72°F. I'll monitor the temperature and let you know when it reaches the target.", + }, + { + user: "Open the kitchen blinds halfway", + assistant: + "Setting the kitchen blinds to 50% open position. Would you like me to adjust the slat angle as well?", + }, + { + user: "Start the coffee maker", + assistant: + "I'll start the coffee maker in the kitchen. Based on your usual preferences, I'll use the strong brew setting. Would you like me to adjust any settings?", + }, + { + user: "Set up the house for bedtime", + assistant: + "I'll activate the bedtime routine: dimming hallway lights to 20%, turning off all other lights, setting temperature to your preferred sleeping temperature of 68°F, locking all doors, and arming the security system.", + }, + { + user: "Play some music in the bedroom", + assistant: + "I'll start playing music on the bedroom speaker. Based on this time of day and your preferences, I'll start your 'Evening Relaxation' playlist at 40% volume. Would you like to adjust any of these settings?", + }, + { + user: "Check if I left any windows open", + assistant: + "I'll check all window sensors. The kitchen window and guest bedroom window are currently open. Would you like me to notify you if any windows remain open after sunset?", + }, + ], + }, + }, + { + name: "gpt4", + description: + "GPT-4 specific prompt template for precise home automation control", + template: { + system: + "You are a home automation assistant powered by GPT-4. Focus on precise command interpretation and execution. Maintain high accuracy in device control and parameter settings. Provide feedback on action success and system state changes.", + user: "Command: {action} {device_name} in {location}\nParameters: {parameters}\nContext: {context}", + examples: [ + { + user: "Dim the bedroom lights to 50%", + assistant: + "Setting bedroom light brightness to 50%. The change has been applied successfully.", + }, + { + user: "Start the evening routine", + assistant: + "Initiating evening routine: dimming lights, adjusting temperature, and enabling security system.", + }, + { + user: "Set living room AC to 74 degrees and high fan", + assistant: + "Configuring living room climate control: temperature set to 74°F, fan mode set to high. Current temperature is 78°F, estimated time to target: 15 minutes.", + }, + { + user: "Lock all doors and windows", + assistant: + "Security check initiated. All 4 doors locked successfully. 6/7 windows locked. Alert: Kitchen window cannot be locked remotely - manual intervention required.", + }, + { + user: "Turn on outdoor lights at sunset", + assistant: + "Scheduled task created. Outdoor lights (porch, pathway, garage) will activate at sunset (7:45 PM today). Current light sensor reading: 24,000 lux.", + }, + { + user: "Set up the media room for movie night", + assistant: + "Executing media room configuration: TV power on, input set to HDMI 2, surround sound activated at 40%, lights dimmed to 10%, blackout blinds closed. Room temperature adjusted to 72°F.", + }, + { + user: "Show me energy usage for today", + assistant: + "Retrieving energy data: Total usage today: 24.5 kWh. Peak consumption: 3.2 kWh (2-3 PM). Major consumers: HVAC (45%), Water Heater (25%), Kitchen Appliances (15%).", + }, + ], + }, + }, + { + name: "custom", + description: "Customizable prompt template for home automation control", + template: { + system: + "Custom home automation assistant configuration. Adapt to user preferences and patterns. Learn from interactions and optimize responses. Provide detailed feedback and suggestions.", + user: "Action requested: {action}\nTarget device: {device_name}\nLocation: {location}\nParameters: {parameters}\nCurrent context: {context}", + examples: [ + { + user: "Make it cooler in here", + assistant: + "Based on your preferences, I'll lower the temperature by 2 degrees. Current temperature is 74°F, adjusting to 72°F.", + }, + { + user: "Set up movie mode", + assistant: + "Activating movie mode: dimming lights to 20%, closing blinds, setting TV input to HDMI 1, and adjusting sound system.", + }, + { + user: "I'm heading to bed", + assistant: + "Initiating personalized bedtime sequence: Setting master bedroom temperature to 68°F, activating white noise machine at volume level 3, dimming hallway lights to 15%, turning off all other lights, closing all blinds, and enabling sleep mode on your phone charger.", + }, + { + user: "Start my morning routine", + assistant: + "Good morning! Executing your weekday morning routine: Gradually increasing bedroom lights (now at 30%), starting coffee maker with your weekday strength setting, setting bathroom heater to 72°F, and pulling up today's weather and calendar on your kitchen display.", + }, + { + user: "I'm working from home today", + assistant: + "Activating work-from-home environment: Setting home office lights to your preferred 5000K color temperature at 80% brightness, adjusting HVAC for daytime occupancy, enabling do-not-disturb on doorbell, and configuring automated breaks reminder every 2 hours.", + }, + { + user: "We're having guests over", + assistant: + "Preparing home for guests: Adjusting living room and dining room temperature to 72°F, setting accent lighting to warm white (2700K), activating air purifier in high mode, enabling guest WiFi network, and preheating the oven as per your usual entertaining preferences.", + }, + { + user: "Monitor the baby's room", + assistant: + "Activating enhanced nursery monitoring: Setting up temperature alerts (68-72°F range), enabling sound monitoring with smart notification threshold, maintaining humidity at 50%, and activating the smart night light with color changing based on sleep schedule. Current readings: 70°F, 48% humidity, sound level: minimal.", + }, + ], + }, + variables: { + device_name: "string", + location: "string", + action: "string", + parameters: "object", + context: "object", + }, + }, + ], + resources: [ + { + name: "Home Assistant API", + url: "https://developers.home-assistant.io/docs/api/rest/", + }, + { + name: "Home Assistant WebSocket API", + url: "https://developers.home-assistant.io/docs/api/websocket", + }, + { + name: "HACS Documentation", + url: "https://hacs.xyz", + }, + ], +}; diff --git a/src/middleware/__tests__/security.middleware.test.ts b/src/middleware/__tests__/security.middleware.test.ts index a85647f..cc56dd7 100644 --- a/src/middleware/__tests__/security.middleware.test.ts +++ b/src/middleware/__tests__/security.middleware.test.ts @@ -1,163 +1,203 @@ -import { Request, Response } from 'express'; -import { validateRequest, sanitizeInput, errorHandler } from '../index'; -import { TokenManager } from '../../security/index'; -import { jest } from '@jest/globals'; +import { Request, Response } from "express"; +import { validateRequest, sanitizeInput, errorHandler } from "../index"; +import { TokenManager } from "../../security/index"; +import { jest } from "@jest/globals"; -const TEST_SECRET = 'test-secret-that-is-long-enough-for-testing-purposes'; +const TEST_SECRET = "test-secret-that-is-long-enough-for-testing-purposes"; -describe('Security Middleware', () => { - let mockRequest: Partial; - let mockResponse: Partial; - let nextFunction: jest.Mock; +describe("Security Middleware", () => { + let mockRequest: Partial; + let mockResponse: Partial; + let nextFunction: jest.Mock; - beforeEach(() => { - process.env.JWT_SECRET = TEST_SECRET; - mockRequest = { - method: 'POST', - headers: {}, - body: {}, - ip: '127.0.0.1' - }; + beforeEach(() => { + process.env.JWT_SECRET = TEST_SECRET; + mockRequest = { + method: "POST", + headers: {}, + body: {}, + ip: "127.0.0.1", + }; - const mockJson = jest.fn().mockReturnThis(); - const mockStatus = jest.fn().mockReturnThis(); - const mockSetHeader = jest.fn().mockReturnThis(); - const mockRemoveHeader = jest.fn().mockReturnThis(); + const mockJson = jest.fn().mockReturnThis(); + const mockStatus = jest.fn().mockReturnThis(); + const mockSetHeader = jest.fn().mockReturnThis(); + const mockRemoveHeader = jest.fn().mockReturnThis(); - mockResponse = { - status: mockStatus as any, - json: mockJson as any, - setHeader: mockSetHeader as any, - removeHeader: mockRemoveHeader as any - }; - nextFunction = jest.fn(); + mockResponse = { + status: mockStatus as any, + json: mockJson as any, + setHeader: mockSetHeader as any, + removeHeader: mockRemoveHeader as any, + }; + nextFunction = jest.fn(); + }); + + afterEach(() => { + delete process.env.JWT_SECRET; + jest.clearAllMocks(); + }); + + describe("Request Validation", () => { + it("should pass valid requests", () => { + mockRequest.headers = { + authorization: "Bearer valid-token", + "content-type": "application/json", + }; + jest + .spyOn(TokenManager, "validateToken") + .mockReturnValue({ valid: true }); + + validateRequest( + mockRequest as Request, + mockResponse as Response, + nextFunction, + ); + expect(nextFunction).toHaveBeenCalled(); }); - afterEach(() => { - delete process.env.JWT_SECRET; - jest.clearAllMocks(); + it("should reject requests without authorization header", () => { + validateRequest( + mockRequest as Request, + mockResponse as Response, + nextFunction, + ); + expect(mockResponse.status).toHaveBeenCalledWith(401); + expect(mockResponse.json).toHaveBeenCalledWith({ + success: false, + message: "Unauthorized", + error: "Missing or invalid authorization header", + timestamp: expect.any(String), + }); }); - describe('Request Validation', () => { - it('should pass valid requests', () => { - mockRequest.headers = { - 'authorization': 'Bearer valid-token', - 'content-type': 'application/json' - }; - jest.spyOn(TokenManager, 'validateToken').mockReturnValue({ valid: true }); - - validateRequest(mockRequest as Request, mockResponse as Response, nextFunction); - expect(nextFunction).toHaveBeenCalled(); - }); - - it('should reject requests without authorization header', () => { - validateRequest(mockRequest as Request, mockResponse as Response, nextFunction); - expect(mockResponse.status).toHaveBeenCalledWith(401); - expect(mockResponse.json).toHaveBeenCalledWith({ - success: false, - message: 'Unauthorized', - error: 'Missing or invalid authorization header', - timestamp: expect.any(String) - }); - }); - - it('should reject requests with invalid authorization format', () => { - mockRequest.headers = { - 'authorization': 'invalid-format', - 'content-type': 'application/json' - }; - validateRequest(mockRequest as Request, mockResponse as Response, nextFunction); - expect(mockResponse.status).toHaveBeenCalledWith(401); - expect(mockResponse.json).toHaveBeenCalledWith({ - success: false, - message: 'Unauthorized', - error: 'Missing or invalid authorization header', - timestamp: expect.any(String) - }); - }); - - it('should reject oversized requests', () => { - mockRequest.headers = { - 'authorization': 'Bearer valid-token', - 'content-type': 'application/json', - 'content-length': '1048577' // 1MB + 1 byte - }; - validateRequest(mockRequest as Request, mockResponse as Response, nextFunction); - expect(mockResponse.status).toHaveBeenCalledWith(413); - expect(mockResponse.json).toHaveBeenCalledWith({ - success: false, - message: 'Payload Too Large', - error: 'Request body must not exceed 1048576 bytes', - timestamp: expect.any(String) - }); - }); + it("should reject requests with invalid authorization format", () => { + mockRequest.headers = { + authorization: "invalid-format", + "content-type": "application/json", + }; + validateRequest( + mockRequest as Request, + mockResponse as Response, + nextFunction, + ); + expect(mockResponse.status).toHaveBeenCalledWith(401); + expect(mockResponse.json).toHaveBeenCalledWith({ + success: false, + message: "Unauthorized", + error: "Missing or invalid authorization header", + timestamp: expect.any(String), + }); }); - describe('Input Sanitization', () => { - it('should sanitize HTML in request body', () => { - mockRequest.body = { - text: 'Test ', - nested: { - html: 'World' - } - }; - sanitizeInput(mockRequest as Request, mockResponse as Response, nextFunction); - expect(mockRequest.body.text).toBe('Test '); - expect(mockRequest.body.nested.html).toBe('World'); - expect(nextFunction).toHaveBeenCalled(); - }); + it("should reject oversized requests", () => { + mockRequest.headers = { + authorization: "Bearer valid-token", + "content-type": "application/json", + "content-length": "1048577", // 1MB + 1 byte + }; + validateRequest( + mockRequest as Request, + mockResponse as Response, + nextFunction, + ); + expect(mockResponse.status).toHaveBeenCalledWith(413); + expect(mockResponse.json).toHaveBeenCalledWith({ + success: false, + message: "Payload Too Large", + error: "Request body must not exceed 1048576 bytes", + timestamp: expect.any(String), + }); + }); + }); - it('should handle non-object bodies', () => { - mockRequest.body = '

text

'; - sanitizeInput(mockRequest as Request, mockResponse as Response, nextFunction); - expect(mockRequest.body).toBe('text'); - expect(nextFunction).toHaveBeenCalled(); - }); - - it('should preserve non-string values', () => { - mockRequest.body = { - number: 123, - boolean: true, - array: [1, 2, 3], - nested: { value: 456 } - }; - sanitizeInput(mockRequest as Request, mockResponse as Response, nextFunction); - expect(mockRequest.body).toEqual({ - number: 123, - boolean: true, - array: [1, 2, 3], - nested: { value: 456 } - }); - expect(nextFunction).toHaveBeenCalled(); - }); + describe("Input Sanitization", () => { + it("should sanitize HTML in request body", () => { + mockRequest.body = { + text: 'Test ', + nested: { + html: 'World', + }, + }; + sanitizeInput( + mockRequest as Request, + mockResponse as Response, + nextFunction, + ); + expect(mockRequest.body.text).toBe("Test "); + expect(mockRequest.body.nested.html).toBe("World"); + expect(nextFunction).toHaveBeenCalled(); }); - describe('Error Handler', () => { - it('should handle errors in production mode', () => { - process.env.NODE_ENV = 'production'; - const error = new Error('Test error'); - errorHandler(error, mockRequest as Request, mockResponse as Response, nextFunction); - expect(mockResponse.status).toHaveBeenCalledWith(500); - expect(mockResponse.json).toHaveBeenCalledWith({ - success: false, - message: 'Internal Server Error', - error: 'An unexpected error occurred', - timestamp: expect.any(String) - }); - }); - - it('should include error details in development mode', () => { - process.env.NODE_ENV = 'development'; - const error = new Error('Test error'); - errorHandler(error, mockRequest as Request, mockResponse as Response, nextFunction); - expect(mockResponse.status).toHaveBeenCalledWith(500); - expect(mockResponse.json).toHaveBeenCalledWith({ - success: false, - message: 'Internal Server Error', - error: 'Test error', - stack: expect.any(String), - timestamp: expect.any(String) - }); - }); + it("should handle non-object bodies", () => { + mockRequest.body = "

text

"; + sanitizeInput( + mockRequest as Request, + mockResponse as Response, + nextFunction, + ); + expect(mockRequest.body).toBe("text"); + expect(nextFunction).toHaveBeenCalled(); }); -}); \ No newline at end of file + + it("should preserve non-string values", () => { + mockRequest.body = { + number: 123, + boolean: true, + array: [1, 2, 3], + nested: { value: 456 }, + }; + sanitizeInput( + mockRequest as Request, + mockResponse as Response, + nextFunction, + ); + expect(mockRequest.body).toEqual({ + number: 123, + boolean: true, + array: [1, 2, 3], + nested: { value: 456 }, + }); + expect(nextFunction).toHaveBeenCalled(); + }); + }); + + describe("Error Handler", () => { + it("should handle errors in production mode", () => { + process.env.NODE_ENV = "production"; + const error = new Error("Test error"); + errorHandler( + error, + mockRequest as Request, + mockResponse as Response, + nextFunction, + ); + expect(mockResponse.status).toHaveBeenCalledWith(500); + expect(mockResponse.json).toHaveBeenCalledWith({ + success: false, + message: "Internal Server Error", + error: "An unexpected error occurred", + timestamp: expect.any(String), + }); + }); + + it("should include error details in development mode", () => { + process.env.NODE_ENV = "development"; + const error = new Error("Test error"); + errorHandler( + error, + mockRequest as Request, + mockResponse as Response, + nextFunction, + ); + expect(mockResponse.status).toHaveBeenCalledWith(500); + expect(mockResponse.json).toHaveBeenCalledWith({ + success: false, + message: "Internal Server Error", + error: "Test error", + stack: expect.any(String), + timestamp: expect.any(String), + }); + }); + }); +}); diff --git a/src/middleware/index.ts b/src/middleware/index.ts index d0381b4..7ceb23e 100644 --- a/src/middleware/index.ts +++ b/src/middleware/index.ts @@ -1,256 +1,294 @@ -import { Request, Response, NextFunction } from 'express'; -import { HASS_CONFIG, RATE_LIMIT_CONFIG } from '../config/index.js'; -import rateLimit from 'express-rate-limit'; -import { TokenManager } from '../security/index.js'; -import sanitizeHtml from 'sanitize-html'; -import helmet from 'helmet'; -import { SECURITY_CONFIG } from '../config/security.config.js'; +import { Request, Response, NextFunction } from "express"; +import { HASS_CONFIG, RATE_LIMIT_CONFIG } from "../config/index.js"; +import rateLimit from "express-rate-limit"; +import { TokenManager } from "../security/index.js"; +import sanitizeHtml from "sanitize-html"; +import helmet from "helmet"; +import { SECURITY_CONFIG } from "../config/security.config.js"; // Rate limiter middleware with enhanced configuration export const rateLimiter = rateLimit({ - windowMs: SECURITY_CONFIG.RATE_LIMIT_WINDOW, - max: SECURITY_CONFIG.RATE_LIMIT_MAX_REQUESTS, - message: { - success: false, - message: 'Too Many Requests', - error: 'Rate limit exceeded. Please try again later.', - timestamp: new Date().toISOString() - } + windowMs: SECURITY_CONFIG.RATE_LIMIT_WINDOW, + max: SECURITY_CONFIG.RATE_LIMIT_MAX_REQUESTS, + message: { + success: false, + message: "Too Many Requests", + error: "Rate limit exceeded. Please try again later.", + timestamp: new Date().toISOString(), + }, }); // WebSocket rate limiter middleware with enhanced configuration export const wsRateLimiter = rateLimit({ - windowMs: 60 * 1000, // 1 minute - max: RATE_LIMIT_CONFIG.WEBSOCKET, - standardHeaders: true, - legacyHeaders: false, - message: { - success: false, - message: 'Too many WebSocket connections, please try again later.', - reset_time: new Date(Date.now() + 60 * 1000).toISOString() - }, - skipSuccessfulRequests: false, - keyGenerator: (req) => req.ip || req.socket.remoteAddress || 'unknown' + windowMs: 60 * 1000, // 1 minute + max: RATE_LIMIT_CONFIG.WEBSOCKET, + standardHeaders: true, + legacyHeaders: false, + message: { + success: false, + message: "Too many WebSocket connections, please try again later.", + reset_time: new Date(Date.now() + 60 * 1000).toISOString(), + }, + skipSuccessfulRequests: false, + keyGenerator: (req) => req.ip || req.socket.remoteAddress || "unknown", }); // Authentication middleware with enhanced security -export const authenticate = (req: Request, res: Response, next: NextFunction) => { - const authHeader = req.headers.authorization; - if (!authHeader || !authHeader.startsWith('Bearer ')) { - return res.status(401).json({ - success: false, - message: 'Unauthorized', - error: 'Missing or invalid authorization header', - timestamp: new Date().toISOString() - }); - } +export const authenticate = ( + req: Request, + res: Response, + next: NextFunction, +) => { + const authHeader = req.headers.authorization; + if (!authHeader || !authHeader.startsWith("Bearer ")) { + return res.status(401).json({ + success: false, + message: "Unauthorized", + error: "Missing or invalid authorization header", + timestamp: new Date().toISOString(), + }); + } - const token = authHeader.replace('Bearer ', ''); - const clientIp = req.ip || req.socket.remoteAddress || ''; + const token = authHeader.replace("Bearer ", ""); + const clientIp = req.ip || req.socket.remoteAddress || ""; - const validationResult = TokenManager.validateToken(token, clientIp); + const validationResult = TokenManager.validateToken(token, clientIp); - if (!validationResult.valid) { - return res.status(401).json({ - success: false, - message: 'Unauthorized', - error: validationResult.error || 'Invalid token', - timestamp: new Date().toISOString() - }); - } + if (!validationResult.valid) { + return res.status(401).json({ + success: false, + message: "Unauthorized", + error: validationResult.error || "Invalid token", + timestamp: new Date().toISOString(), + }); + } - next(); + next(); }; // Enhanced security headers middleware using helmet const helmetMiddleware = helmet({ - contentSecurityPolicy: { - directives: { - defaultSrc: ["'self'"], - scriptSrc: ["'self'", "'unsafe-inline'"], - styleSrc: ["'self'", "'unsafe-inline'"], - imgSrc: ["'self'", 'data:', 'https:'], - connectSrc: ["'self'", 'wss:', 'https:'], - frameSrc: ["'none'"], - objectSrc: ["'none'"], - baseUri: ["'self'"], - formAction: ["'self'"], - frameAncestors: ["'none'"] - } + contentSecurityPolicy: { + directives: { + defaultSrc: ["'self'"], + scriptSrc: ["'self'", "'unsafe-inline'"], + styleSrc: ["'self'", "'unsafe-inline'"], + imgSrc: ["'self'", "data:", "https:"], + connectSrc: ["'self'", "wss:", "https:"], + frameSrc: ["'none'"], + objectSrc: ["'none'"], + baseUri: ["'self'"], + formAction: ["'self'"], + frameAncestors: ["'none'"], }, - crossOriginEmbedderPolicy: true, - crossOriginOpenerPolicy: { policy: 'same-origin' }, - crossOriginResourcePolicy: { policy: 'same-origin' }, - dnsPrefetchControl: { allow: false }, - frameguard: { action: 'deny' }, - hidePoweredBy: true, - hsts: { - maxAge: 31536000, - includeSubDomains: true, - preload: true - }, - ieNoOpen: true, - noSniff: true, - originAgentCluster: true, - permittedCrossDomainPolicies: { permittedPolicies: 'none' }, - referrerPolicy: { policy: 'strict-origin-when-cross-origin' }, - xssFilter: true + }, + crossOriginEmbedderPolicy: true, + crossOriginOpenerPolicy: { policy: "same-origin" }, + crossOriginResourcePolicy: { policy: "same-origin" }, + dnsPrefetchControl: { allow: false }, + frameguard: { action: "deny" }, + hidePoweredBy: true, + hsts: { + maxAge: 31536000, + includeSubDomains: true, + preload: true, + }, + ieNoOpen: true, + noSniff: true, + originAgentCluster: true, + permittedCrossDomainPolicies: { permittedPolicies: "none" }, + referrerPolicy: { policy: "strict-origin-when-cross-origin" }, + xssFilter: true, }); // Wrapper for helmet middleware to handle mock responses in tests -export const securityHeaders = (req: Request, res: Response, next: NextFunction): void => { - // Basic security headers - res.setHeader('X-Content-Type-Options', 'nosniff'); - res.setHeader('X-Frame-Options', 'DENY'); - res.setHeader('X-XSS-Protection', '1; mode=block'); - res.setHeader('Referrer-Policy', 'strict-origin-when-cross-origin'); - res.setHeader('X-Permitted-Cross-Domain-Policies', 'none'); - res.setHeader('X-Download-Options', 'noopen'); +export const securityHeaders = ( + req: Request, + res: Response, + next: NextFunction, +): void => { + // Basic security headers + res.setHeader("X-Content-Type-Options", "nosniff"); + res.setHeader("X-Frame-Options", "DENY"); + res.setHeader("X-XSS-Protection", "1; mode=block"); + res.setHeader("Referrer-Policy", "strict-origin-when-cross-origin"); + res.setHeader("X-Permitted-Cross-Domain-Policies", "none"); + res.setHeader("X-Download-Options", "noopen"); - // Content Security Policy - res.setHeader('Content-Security-Policy', [ - "default-src 'self'", - "script-src 'self'", - "style-src 'self'", - "img-src 'self'", - "font-src 'self'", - "connect-src 'self'", - "media-src 'self'", - "object-src 'none'", - "frame-ancestors 'none'", - "base-uri 'self'", - "form-action 'self'" - ].join('; ')); + // Content Security Policy + res.setHeader( + "Content-Security-Policy", + [ + "default-src 'self'", + "script-src 'self'", + "style-src 'self'", + "img-src 'self'", + "font-src 'self'", + "connect-src 'self'", + "media-src 'self'", + "object-src 'none'", + "frame-ancestors 'none'", + "base-uri 'self'", + "form-action 'self'", + ].join("; "), + ); - // HSTS (only in production) - if (process.env.NODE_ENV === 'production') { - res.setHeader('Strict-Transport-Security', 'max-age=31536000; includeSubDomains; preload'); - } + // HSTS (only in production) + if (process.env.NODE_ENV === "production") { + res.setHeader( + "Strict-Transport-Security", + "max-age=31536000; includeSubDomains; preload", + ); + } - next(); + next(); }; /** * Validates incoming requests for proper authentication and content type */ -export const validateRequest = (req: Request, res: Response, next: NextFunction): Response | void => { - // Skip validation for health and MCP schema endpoints - if (req.path === '/health' || req.path === '/mcp') { - return next(); - } +export const validateRequest = ( + req: Request, + res: Response, + next: NextFunction, +): Response | void => { + // Skip validation for health and MCP schema endpoints + if (req.path === "/health" || req.path === "/mcp") { + return next(); + } - // Validate content type for non-GET requests - if (['POST', 'PUT', 'PATCH'].includes(req.method)) { - const contentType = req.headers['content-type'] || ''; - if (!contentType.toLowerCase().includes('application/json')) { - return res.status(415).json({ - success: false, - message: 'Unsupported Media Type', - error: 'Content-Type must be application/json', - timestamp: new Date().toISOString() - }); - } + // Validate content type for non-GET requests + if (["POST", "PUT", "PATCH"].includes(req.method)) { + const contentType = req.headers["content-type"] || ""; + if (!contentType.toLowerCase().includes("application/json")) { + return res.status(415).json({ + success: false, + message: "Unsupported Media Type", + error: "Content-Type must be application/json", + timestamp: new Date().toISOString(), + }); } + } - // Validate authorization header - const authHeader = req.headers.authorization; - if (!authHeader || !authHeader.startsWith('Bearer ')) { - return res.status(401).json({ - success: false, - message: 'Unauthorized', - error: 'Missing or invalid authorization header', - timestamp: new Date().toISOString() - }); + // Validate authorization header + const authHeader = req.headers.authorization; + if (!authHeader || !authHeader.startsWith("Bearer ")) { + return res.status(401).json({ + success: false, + message: "Unauthorized", + error: "Missing or invalid authorization header", + timestamp: new Date().toISOString(), + }); + } + + // Validate token + const token = authHeader.replace("Bearer ", ""); + const validationResult = TokenManager.validateToken(token, req.ip); + if (!validationResult.valid) { + return res.status(401).json({ + success: false, + message: "Unauthorized", + error: validationResult.error || "Invalid token", + timestamp: new Date().toISOString(), + }); + } + + // Validate request body structure + if (req.method !== "GET" && req.body) { + if (typeof req.body !== "object" || Array.isArray(req.body)) { + return res.status(400).json({ + success: false, + message: "Bad Request", + error: "Invalid request body structure", + timestamp: new Date().toISOString(), + }); } + } - // Validate token - const token = authHeader.replace('Bearer ', ''); - const validationResult = TokenManager.validateToken(token, req.ip); - if (!validationResult.valid) { - return res.status(401).json({ - success: false, - message: 'Unauthorized', - error: validationResult.error || 'Invalid token', - timestamp: new Date().toISOString() - }); - } - - // Validate request body structure - if (req.method !== 'GET' && req.body) { - if (typeof req.body !== 'object' || Array.isArray(req.body)) { - return res.status(400).json({ - success: false, - message: 'Bad Request', - error: 'Invalid request body structure', - timestamp: new Date().toISOString() - }); - } - } - - next(); + next(); }; /** * Sanitizes input data to prevent XSS attacks */ -export const sanitizeInput = (req: Request, res: Response, next: NextFunction): void => { - if (req.body && typeof req.body === 'object' && !Array.isArray(req.body)) { - const sanitizeValue = (value: unknown): unknown => { - if (typeof value === 'string') { - let sanitized = value; - // Remove script tags and their content - sanitized = sanitized.replace(/)<[^<]*)*<\/script>/gi, ''); - // Remove style tags and their content - sanitized = sanitized.replace(/)<[^<]*)*<\/style>/gi, ''); - // Remove remaining HTML tags - sanitized = sanitized.replace(/<[^>]+>/g, ''); - // Remove javascript: protocol - sanitized = sanitized.replace(/javascript:/gi, ''); - // Remove event handlers - sanitized = sanitized.replace(/on\w+\s*=\s*(?:".*?"|'.*?'|[^"'>\s]+)/gi, ''); - // Trim whitespace - return sanitized.trim(); - } else if (typeof value === 'object' && value !== null) { - const result: Record = {}; - Object.entries(value as Record).forEach(([key, val]) => { - result[key] = sanitizeValue(val); - }); - return result; - } - return value; - }; +export const sanitizeInput = ( + req: Request, + res: Response, + next: NextFunction, +): void => { + if (req.body && typeof req.body === "object" && !Array.isArray(req.body)) { + const sanitizeValue = (value: unknown): unknown => { + if (typeof value === "string") { + let sanitized = value; + // Remove script tags and their content + sanitized = sanitized.replace( + /)<[^<]*)*<\/script>/gi, + "", + ); + // Remove style tags and their content + sanitized = sanitized.replace( + /)<[^<]*)*<\/style>/gi, + "", + ); + // Remove remaining HTML tags + sanitized = sanitized.replace(/<[^>]+>/g, ""); + // Remove javascript: protocol + sanitized = sanitized.replace(/javascript:/gi, ""); + // Remove event handlers + sanitized = sanitized.replace( + /on\w+\s*=\s*(?:".*?"|'.*?'|[^"'>\s]+)/gi, + "", + ); + // Trim whitespace + return sanitized.trim(); + } else if (typeof value === "object" && value !== null) { + const result: Record = {}; + Object.entries(value as Record).forEach( + ([key, val]) => { + result[key] = sanitizeValue(val); + }, + ); + return result; + } + return value; + }; - req.body = sanitizeValue(req.body) as Record; - } - next(); + req.body = sanitizeValue(req.body) as Record; + } + next(); }; /** * Handles errors in a consistent way */ -export const errorHandler = (err: Error, req: Request, res: Response, next: NextFunction): Response => { - const isDevelopment = process.env.NODE_ENV === 'development'; - const response: Record = { - success: false, - message: 'Internal Server Error', - timestamp: new Date().toISOString() - }; +export const errorHandler = ( + err: Error, + req: Request, + res: Response, + next: NextFunction, +): Response => { + const isDevelopment = process.env.NODE_ENV === "development"; + const response: Record = { + success: false, + message: "Internal Server Error", + timestamp: new Date().toISOString(), + }; - if (isDevelopment) { - response.error = err.message; - response.stack = err.stack; - } + if (isDevelopment) { + response.error = err.message; + response.stack = err.stack; + } - return res.status(500).json(response); + return res.status(500).json(response); }; // Export all middleware export const middleware = { - rateLimiter, - wsRateLimiter, - securityHeaders, - validateRequest, - sanitizeInput, - authenticate, - errorHandler -}; \ No newline at end of file + rateLimiter, + wsRateLimiter, + securityHeaders, + validateRequest, + sanitizeInput, + authenticate, + errorHandler, +}; diff --git a/src/middleware/logging.middleware.ts b/src/middleware/logging.middleware.ts index 25f649d..b42cb94 100644 --- a/src/middleware/logging.middleware.ts +++ b/src/middleware/logging.middleware.ts @@ -1,21 +1,21 @@ /** * Logging Middleware - * + * * This middleware provides request logging functionality. * It logs incoming requests and their responses. - * + * * @module logging-middleware */ -import { Request, Response, NextFunction } from 'express'; -import { logger } from '../utils/logger.js'; -import { APP_CONFIG } from '../config/app.config.js'; +import { Request, Response, NextFunction } from "express"; +import { logger } from "../utils/logger.js"; +import { APP_CONFIG } from "../config/app.config.js"; /** * Interface for extended request object with timing information */ interface TimedRequest extends Request { - startTime?: number; + startTime?: number; } /** @@ -24,10 +24,10 @@ interface TimedRequest extends Request { * @returns Response time in milliseconds */ const getResponseTime = (startTime: number): number => { - const NS_PER_SEC = 1e9; // nanoseconds per second - const NS_TO_MS = 1e6; // nanoseconds to milliseconds - const diff = process.hrtime(); - return (diff[0] * NS_PER_SEC + diff[1]) / NS_TO_MS - startTime; + const NS_PER_SEC = 1e9; // nanoseconds per second + const NS_TO_MS = 1e6; // nanoseconds to milliseconds + const diff = process.hrtime(); + return (diff[0] * NS_PER_SEC + diff[1]) / NS_TO_MS - startTime; }; /** @@ -36,11 +36,11 @@ const getResponseTime = (startTime: number): number => { * @returns Client IP address */ const getClientIp = (req: Request): string => { - return ( - (req.headers['x-forwarded-for'] as string)?.split(',')[0] || - req.socket.remoteAddress || - 'unknown' - ); + return ( + (req.headers["x-forwarded-for"] as string)?.split(",")[0] || + req.socket.remoteAddress || + "unknown" + ); }; /** @@ -49,7 +49,7 @@ const getClientIp = (req: Request): string => { * @returns Formatted log message */ const formatRequestLog = (req: TimedRequest): string => { - return `${req.method} ${req.originalUrl} - IP: ${getClientIp(req)}`; + return `${req.method} ${req.originalUrl} - IP: ${getClientIp(req)}`; }; /** @@ -59,48 +59,64 @@ const formatRequestLog = (req: TimedRequest): string => { * @param time - Response time in milliseconds * @returns Formatted log message */ -const formatResponseLog = (req: TimedRequest, res: Response, time: number): string => { - return `${req.method} ${req.originalUrl} - ${res.statusCode} - ${time.toFixed(2)}ms`; +const formatResponseLog = ( + req: TimedRequest, + res: Response, + time: number, +): string => { + return `${req.method} ${req.originalUrl} - ${res.statusCode} - ${time.toFixed(2)}ms`; }; /** * Request logging middleware * Logs information about incoming requests and their responses */ -export const requestLogger = (req: TimedRequest, res: Response, next: NextFunction): void => { - if (!APP_CONFIG.LOGGING.LOG_REQUESTS) { - next(); - return; - } - - // Record start time - req.startTime = Date.now(); - - // Log request - logger.http(formatRequestLog(req)); - - // Log response - res.on('finish', () => { - const responseTime = Date.now() - (req.startTime || 0); - const logLevel = res.statusCode >= 400 ? 'warn' : 'http'; - logger[logLevel](formatResponseLog(req, res, responseTime)); - }); - +export const requestLogger = ( + req: TimedRequest, + res: Response, + next: NextFunction, +): void => { + if (!APP_CONFIG.LOGGING.LOG_REQUESTS) { next(); + return; + } + + // Record start time + req.startTime = Date.now(); + + // Log request + logger.http(formatRequestLog(req)); + + // Log response + res.on("finish", () => { + const responseTime = Date.now() - (req.startTime || 0); + const logLevel = res.statusCode >= 400 ? "warn" : "http"; + logger[logLevel](formatResponseLog(req, res, responseTime)); + }); + + next(); }; /** * Error logging middleware * Logs errors that occur during request processing */ -export const errorLogger = (err: Error, req: Request, res: Response, next: NextFunction): void => { - logger.error(`Error processing ${req.method} ${req.originalUrl}: ${err.message}`, { - error: err.stack, - method: req.method, - url: req.originalUrl, - body: req.body, - query: req.query, - ip: getClientIp(req) - }); - next(err); -}; \ No newline at end of file +export const errorLogger = ( + err: Error, + req: Request, + res: Response, + next: NextFunction, +): void => { + logger.error( + `Error processing ${req.method} ${req.originalUrl}: ${err.message}`, + { + error: err.stack, + method: req.method, + url: req.originalUrl, + body: req.body, + query: req.query, + ip: getClientIp(req), + }, + ); + next(err); +}; diff --git a/src/platforms/macos/integration.ts b/src/platforms/macos/integration.ts index bd6415d..6aa0865 100644 --- a/src/platforms/macos/integration.ts +++ b/src/platforms/macos/integration.ts @@ -1,92 +1,96 @@ -import { exec } from 'child_process'; -import { promisify } from 'util'; -import { EventEmitter } from 'events'; +import { exec } from "child_process"; +import { promisify } from "util"; +import { EventEmitter } from "events"; const execAsync = promisify(exec); interface MacOSNotification { - title: string; - message: string; - subtitle?: string; - sound?: boolean; + title: string; + message: string; + subtitle?: string; + sound?: boolean; } interface MacOSPermissions { - notifications: boolean; - automation: boolean; - accessibility: boolean; + notifications: boolean; + automation: boolean; + accessibility: boolean; } class MacOSIntegration extends EventEmitter { - private permissions: MacOSPermissions; + private permissions: MacOSPermissions; - constructor() { - super(); - this.permissions = { - notifications: false, - automation: false, - accessibility: false - }; + constructor() { + super(); + this.permissions = { + notifications: false, + automation: false, + accessibility: false, + }; + } + + async initialize(): Promise { + await this.checkPermissions(); + await this.registerSystemEvents(); + } + + async checkPermissions(): Promise { + try { + // Check notification permissions + const { stdout: notifPerms } = await execAsync( + "osascript -e 'tell application \"System Events\" to get properties'", + ); + this.permissions.notifications = notifPerms.includes( + "notifications enabled:true", + ); + + // Check automation permissions + const { stdout: autoPerms } = await execAsync( + "osascript -e 'tell application \"System Events\" to get UI elements enabled'", + ); + this.permissions.automation = autoPerms.includes("true"); + + // Check accessibility permissions + const { stdout: accessPerms } = await execAsync( + "osascript -e 'tell application \"System Events\" to get processes'", + ); + this.permissions.accessibility = !accessPerms.includes("error"); + + return this.permissions; + } catch (error) { + console.error("Error checking permissions:", error); + return this.permissions; + } + } + + async sendNotification(notification: MacOSNotification): Promise { + if (!this.permissions.notifications) { + throw new Error("Notification permission not granted"); } - async initialize(): Promise { - await this.checkPermissions(); - await this.registerSystemEvents(); - } - - async checkPermissions(): Promise { - try { - // Check notification permissions - const { stdout: notifPerms } = await execAsync( - 'osascript -e \'tell application "System Events" to get properties\'' - ); - this.permissions.notifications = notifPerms.includes('notifications enabled:true'); - - // Check automation permissions - const { stdout: autoPerms } = await execAsync( - 'osascript -e \'tell application "System Events" to get UI elements enabled\'' - ); - this.permissions.automation = autoPerms.includes('true'); - - // Check accessibility permissions - const { stdout: accessPerms } = await execAsync( - 'osascript -e \'tell application "System Events" to get processes\'' - ); - this.permissions.accessibility = !accessPerms.includes('error'); - - return this.permissions; - } catch (error) { - console.error('Error checking permissions:', error); - return this.permissions; - } - } - - async sendNotification(notification: MacOSNotification): Promise { - if (!this.permissions.notifications) { - throw new Error('Notification permission not granted'); - } - - const script = ` - display notification "${notification.message}"${notification.subtitle ? ` with subtitle "${notification.subtitle}"` : '' - } with title "${notification.title}"${notification.sound ? ' sound name "default"' : '' - } + const script = ` + display notification "${notification.message}"${ + notification.subtitle ? ` with subtitle "${notification.subtitle}"` : "" + } with title "${notification.title}"${ + notification.sound ? ' sound name "default"' : "" + } `; - try { - await execAsync(`osascript -e '${script}'`); - } catch (error) { - console.error('Error sending notification:', error); - throw error; - } + try { + await execAsync(`osascript -e '${script}'`); + } catch (error) { + console.error("Error sending notification:", error); + throw error; + } + } + + async registerSystemEvents(): Promise { + if (!this.permissions.automation) { + throw new Error("Automation permission not granted"); } - async registerSystemEvents(): Promise { - if (!this.permissions.automation) { - throw new Error('Automation permission not granted'); - } - - // Monitor system events - const script = ` + // Monitor system events + const script = ` tell application "System Events" set eventList to {} @@ -110,106 +114,110 @@ class MacOSIntegration extends EventEmitter { end tell `; - try { - const { stdout } = await execAsync(`osascript -e '${script}'`); - const events = stdout.split(',').map(e => e.trim()); - events.forEach(event => this.emit('system_event', event)); - } catch (error) { - console.error('Error monitoring system events:', error); - } + try { + const { stdout } = await execAsync(`osascript -e '${script}'`); + const events = stdout.split(",").map((e) => e.trim()); + events.forEach((event) => this.emit("system_event", event)); + } catch (error) { + console.error("Error monitoring system events:", error); + } + } + + async executeAutomation(script: string): Promise { + if (!this.permissions.automation) { + throw new Error("Automation permission not granted"); } - async executeAutomation(script: string): Promise { - if (!this.permissions.automation) { - throw new Error('Automation permission not granted'); - } + try { + const { stdout } = await execAsync(`osascript -e '${script}'`); + return stdout; + } catch (error) { + console.error("Error executing automation:", error); + throw error; + } + } - try { - const { stdout } = await execAsync(`osascript -e '${script}'`); - return stdout; - } catch (error) { - console.error('Error executing automation:', error); - throw error; - } + async getSystemInfo(): Promise> { + const info: Record = {}; + + try { + // Get macOS version + const { stdout: version } = await execAsync("sw_vers -productVersion"); + info.os_version = version.trim(); + + // Get hardware info + const { stdout: hardware } = await execAsync( + "system_profiler SPHardwareDataType", + ); + info.hardware = this.parseSystemProfile(hardware); + + // Get power info + const { stdout: power } = await execAsync("pmset -g batt"); + info.power = this.parsePowerInfo(power); + + // Get network info + const { stdout: network } = await execAsync( + "networksetup -listallhardwareports", + ); + info.network = this.parseNetworkInfo(network); + + return info; + } catch (error) { + console.error("Error getting system info:", error); + throw error; + } + } + + private parseSystemProfile(output: string): Record { + const info: Record = {}; + const lines = output.split("\n"); + + for (const line of lines) { + const [key, value] = line.split(":").map((s) => s.trim()); + if (key && value) { + info[key.toLowerCase().replace(/\s+/g, "_")] = value; + } } - async getSystemInfo(): Promise> { - const info: Record = {}; + return info; + } - try { - // Get macOS version - const { stdout: version } = await execAsync('sw_vers -productVersion'); - info.os_version = version.trim(); + private parsePowerInfo(output: string): Record { + const info: Record = {}; + const lines = output.split("\n"); - // Get hardware info - const { stdout: hardware } = await execAsync('system_profiler SPHardwareDataType'); - info.hardware = this.parseSystemProfile(hardware); - - // Get power info - const { stdout: power } = await execAsync('pmset -g batt'); - info.power = this.parsePowerInfo(power); - - // Get network info - const { stdout: network } = await execAsync('networksetup -listallhardwareports'); - info.network = this.parseNetworkInfo(network); - - return info; - } catch (error) { - console.error('Error getting system info:', error); - throw error; + for (const line of lines) { + if (line.includes("Now drawing from")) { + info.power_source = line.includes("Battery") ? "battery" : "ac_power"; + } else if (line.includes("%")) { + const matches = line.match(/(\d+)%/); + if (matches) { + info.battery_percentage = parseInt(matches[1]); } + } } - private parseSystemProfile(output: string): Record { - const info: Record = {}; - const lines = output.split('\n'); + return info; + } - for (const line of lines) { - const [key, value] = line.split(':').map(s => s.trim()); - if (key && value) { - info[key.toLowerCase().replace(/\s+/g, '_')] = value; - } - } + private parseNetworkInfo(output: string): Record { + const info: Record = {}; + const lines = output.split("\n"); + let currentInterface: string | null = null; - return info; + for (const line of lines) { + if (line.includes("Hardware Port:")) { + currentInterface = line.split(":")[1].trim(); + info[currentInterface] = {}; + } else if (currentInterface && line.includes("Device:")) { + info[currentInterface].device = line.split(":")[1].trim(); + } else if (currentInterface && line.includes("Ethernet Address:")) { + info[currentInterface].mac = line.split(":")[1].trim(); + } } - private parsePowerInfo(output: string): Record { - const info: Record = {}; - const lines = output.split('\n'); - - for (const line of lines) { - if (line.includes('Now drawing from')) { - info.power_source = line.includes('Battery') ? 'battery' : 'ac_power'; - } else if (line.includes('%')) { - const matches = line.match(/(\d+)%/); - if (matches) { - info.battery_percentage = parseInt(matches[1]); - } - } - } - - return info; - } - - private parseNetworkInfo(output: string): Record { - const info: Record = {}; - const lines = output.split('\n'); - let currentInterface: string | null = null; - - for (const line of lines) { - if (line.includes('Hardware Port:')) { - currentInterface = line.split(':')[1].trim(); - info[currentInterface] = {}; - } else if (currentInterface && line.includes('Device:')) { - info[currentInterface].device = line.split(':')[1].trim(); - } else if (currentInterface && line.includes('Ethernet Address:')) { - info[currentInterface].mac = line.split(':')[1].trim(); - } - } - - return info; - } + return info; + } } -export default MacOSIntegration; \ No newline at end of file +export default MacOSIntegration; diff --git a/src/routes/health.routes.ts b/src/routes/health.routes.ts index 85b2bc7..705292f 100644 --- a/src/routes/health.routes.ts +++ b/src/routes/health.routes.ts @@ -1,15 +1,15 @@ -import { Router } from 'express'; -import { APP_CONFIG } from '../config/app.config.js'; +import { Router } from "express"; +import { APP_CONFIG } from "../config/app.config.js"; const router = Router(); // Health check endpoint -router.get('/', (_req, res) => { - res.json({ - status: 'ok', - timestamp: new Date().toISOString(), - version: APP_CONFIG.VERSION - }); +router.get("/", (_req, res) => { + res.json({ + status: "ok", + timestamp: new Date().toISOString(), + version: APP_CONFIG.VERSION, + }); }); -export { router as healthRoutes }; \ No newline at end of file +export { router as healthRoutes }; diff --git a/src/routes/index.ts b/src/routes/index.ts index 19baca3..a2c4da5 100644 --- a/src/routes/index.ts +++ b/src/routes/index.ts @@ -1,18 +1,18 @@ /** * API Routes Module - * + * * This module exports the main router that combines all API routes * into a single router instance. Each route group is mounted under * its respective path prefix. - * + * * @module routes */ -import { Router } from 'express'; -import { mcpRoutes } from './mcp.routes.js'; -import { sseRoutes } from './sse.routes.js'; -import { toolRoutes } from './tool.routes.js'; -import { healthRoutes } from './health.routes.js'; +import { Router } from "express"; +import { mcpRoutes } from "./mcp.routes.js"; +import { sseRoutes } from "./sse.routes.js"; +import { toolRoutes } from "./tool.routes.js"; +import { healthRoutes } from "./health.routes.js"; /** * Create main router instance @@ -27,13 +27,13 @@ const router = Router(); * - /tools: Tool management endpoints * - /health: Health check endpoint */ -router.use('/mcp', mcpRoutes); -router.use('/sse', sseRoutes); -router.use('/tools', toolRoutes); -router.use('/health', healthRoutes); +router.use("/mcp", mcpRoutes); +router.use("/sse", sseRoutes); +router.use("/tools", toolRoutes); +router.use("/health", healthRoutes); /** * Export the configured router * This will be mounted in the main application */ -export { router as apiRoutes }; \ No newline at end of file +export { router as apiRoutes }; diff --git a/src/routes/mcp.routes.ts b/src/routes/mcp.routes.ts index 143aaf9..548b61a 100644 --- a/src/routes/mcp.routes.ts +++ b/src/routes/mcp.routes.ts @@ -1,16 +1,16 @@ /** * MCP Routes Module - * + * * This module provides routes for accessing and executing MCP functionality. * It includes endpoints for retrieving the MCP schema and executing MCP tools. - * + * * @module mcp-routes */ -import { Router } from 'express'; -import { MCP_SCHEMA } from '../mcp/schema.js'; -import { APP_CONFIG } from '../config/app.config.js'; -import { Tool } from '../types/index.js'; +import { Router } from "express"; +import { MCP_SCHEMA } from "../mcp/schema.js"; +import { APP_CONFIG } from "../config/app.config.js"; +import { Tool } from "../types/index.js"; /** * Create router instance for MCP routes @@ -28,15 +28,15 @@ const tools: Tool[] = []; * Returns the MCP schema without requiring authentication * This endpoint allows clients to discover available tools and their parameters */ -router.get('/', (_req, res) => { - res.json(MCP_SCHEMA); +router.get("/", (_req, res) => { + res.json(MCP_SCHEMA); }); /** * POST /mcp/execute * Execute a tool with the provided parameters * Requires authentication via Bearer token - * + * * @param {Object} req.body.tool - Name of the tool to execute * @param {Object} req.body.parameters - Parameters for the tool * @returns {Object} Tool execution result @@ -44,42 +44,43 @@ router.get('/', (_req, res) => { * @throws {404} If tool is not found * @throws {500} If execution fails */ -router.post('/execute', async (req, res) => { - try { - // Get token from Authorization header - const token = req.headers.authorization?.replace('Bearer ', ''); +router.post("/execute", async (req, res) => { + try { + // Get token from Authorization header + const token = req.headers.authorization?.replace("Bearer ", ""); - if (!token || token !== APP_CONFIG.HASS_TOKEN) { - return res.status(401).json({ - success: false, - message: 'Unauthorized - Invalid token' - }); - } - - const { tool: toolName, parameters } = req.body; - - // Find the requested tool - const tool = tools.find(t => t.name === toolName); - if (!tool) { - return res.status(404).json({ - success: false, - message: `Tool '${toolName}' not found` - }); - } - - // Execute the tool with the provided parameters - const result = await tool.execute(parameters); - res.json(result); - } catch (error) { - res.status(500).json({ - success: false, - message: error instanceof Error ? error.message : 'Unknown error occurred' - }); + if (!token || token !== APP_CONFIG.HASS_TOKEN) { + return res.status(401).json({ + success: false, + message: "Unauthorized - Invalid token", + }); } + + const { tool: toolName, parameters } = req.body; + + // Find the requested tool + const tool = tools.find((t) => t.name === toolName); + if (!tool) { + return res.status(404).json({ + success: false, + message: `Tool '${toolName}' not found`, + }); + } + + // Execute the tool with the provided parameters + const result = await tool.execute(parameters); + res.json(result); + } catch (error) { + res.status(500).json({ + success: false, + message: + error instanceof Error ? error.message : "Unknown error occurred", + }); + } }); /** * Export the configured router * This will be mounted under /api/mcp in the main application */ -export { router as mcpRoutes }; \ No newline at end of file +export { router as mcpRoutes }; diff --git a/src/routes/sse.routes.ts b/src/routes/sse.routes.ts index 202fc3f..234dac2 100644 --- a/src/routes/sse.routes.ts +++ b/src/routes/sse.routes.ts @@ -1,108 +1,115 @@ -import { Router } from 'express'; -import { v4 as uuidv4 } from 'uuid'; -import { sseManager } from '../sse/index.js'; -import { TokenManager } from '../security/index.js'; -import { middleware } from '../middleware/index.js'; +import { Router } from "express"; +import { v4 as uuidv4 } from "uuid"; +import { sseManager } from "../sse/index.js"; +import { TokenManager } from "../security/index.js"; +import { middleware } from "../middleware/index.js"; const router = Router(); // SSE endpoints -router.get('/subscribe_events', middleware.wsRateLimiter, (req, res) => { - try { - // Get token from query parameter and validate - const token = req.query.token?.toString() || ''; - const clientIp = req.ip || req.socket.remoteAddress || ''; - const validationResult = TokenManager.validateToken(token, clientIp); +router.get("/subscribe_events", middleware.wsRateLimiter, (req, res) => { + try { + // Get token from query parameter and validate + const token = req.query.token?.toString() || ""; + const clientIp = req.ip || req.socket.remoteAddress || ""; + const validationResult = TokenManager.validateToken(token, clientIp); - if (!validationResult.valid) { - return res.status(401).json({ - success: false, - message: 'Unauthorized', - error: validationResult.error, - timestamp: new Date().toISOString() - }); - } - - // Set SSE headers with enhanced security - res.writeHead(200, { - 'Content-Type': 'text/event-stream', - 'Cache-Control': 'no-cache, no-transform', - 'Connection': 'keep-alive', - 'X-Accel-Buffering': 'no', - 'Access-Control-Allow-Origin': '*', - 'Access-Control-Allow-Credentials': 'true' - }); - - // Send initial connection message - res.write(`data: ${JSON.stringify({ - type: 'connection', - status: 'connected', - timestamp: new Date().toISOString() - })}\n\n`); - - const clientId = uuidv4(); - const client = { - id: clientId, - ip: clientIp, - connectedAt: new Date(), - send: (data: string) => { - res.write(`data: ${data}\n\n`); - } - }; - - // Add client to SSE manager with enhanced tracking - const sseClient = sseManager.addClient(client, token); - if (!sseClient || !sseClient.authenticated) { - const errorMessage = JSON.stringify({ - type: 'error', - message: sseClient ? 'Authentication failed' : 'Maximum client limit reached', - timestamp: new Date().toISOString() - }); - res.write(`data: ${errorMessage}\n\n`); - return res.end(); - } - - // Handle client disconnect - req.on('close', () => { - sseManager.removeClient(clientId); - console.log(`Client ${clientId} disconnected at ${new Date().toISOString()}`); - }); - - // Handle errors - req.on('error', (error) => { - console.error(`SSE Error for client ${clientId}:`, error); - const errorMessage = JSON.stringify({ - type: 'error', - message: 'Connection error', - timestamp: new Date().toISOString() - }); - res.write(`data: ${errorMessage}\n\n`); - sseManager.removeClient(clientId); - res.end(); - }); - - } catch (error) { - console.error('SSE Setup Error:', error); - res.status(500).json({ - success: false, - message: 'Internal Server Error', - error: error instanceof Error ? error.message : 'An unexpected error occurred', - timestamp: new Date().toISOString() - }); + if (!validationResult.valid) { + return res.status(401).json({ + success: false, + message: "Unauthorized", + error: validationResult.error, + timestamp: new Date().toISOString(), + }); } + + // Set SSE headers with enhanced security + res.writeHead(200, { + "Content-Type": "text/event-stream", + "Cache-Control": "no-cache, no-transform", + Connection: "keep-alive", + "X-Accel-Buffering": "no", + "Access-Control-Allow-Origin": "*", + "Access-Control-Allow-Credentials": "true", + }); + + // Send initial connection message + res.write( + `data: ${JSON.stringify({ + type: "connection", + status: "connected", + timestamp: new Date().toISOString(), + })}\n\n`, + ); + + const clientId = uuidv4(); + const client = { + id: clientId, + ip: clientIp, + connectedAt: new Date(), + send: (data: string) => { + res.write(`data: ${data}\n\n`); + }, + }; + + // Add client to SSE manager with enhanced tracking + const sseClient = sseManager.addClient(client, token); + if (!sseClient || !sseClient.authenticated) { + const errorMessage = JSON.stringify({ + type: "error", + message: sseClient + ? "Authentication failed" + : "Maximum client limit reached", + timestamp: new Date().toISOString(), + }); + res.write(`data: ${errorMessage}\n\n`); + return res.end(); + } + + // Handle client disconnect + req.on("close", () => { + sseManager.removeClient(clientId); + console.log( + `Client ${clientId} disconnected at ${new Date().toISOString()}`, + ); + }); + + // Handle errors + req.on("error", (error) => { + console.error(`SSE Error for client ${clientId}:`, error); + const errorMessage = JSON.stringify({ + type: "error", + message: "Connection error", + timestamp: new Date().toISOString(), + }); + res.write(`data: ${errorMessage}\n\n`); + sseManager.removeClient(clientId); + res.end(); + }); + } catch (error) { + console.error("SSE Setup Error:", error); + res.status(500).json({ + success: false, + message: "Internal Server Error", + error: + error instanceof Error ? error.message : "An unexpected error occurred", + timestamp: new Date().toISOString(), + }); + } }); // Get SSE stats endpoint -router.get('/stats', async (req, res) => { - try { - const stats = await sseManager.getStatistics(); - res.json(stats); - } catch (error) { - res.status(500).json({ - success: false, - message: error instanceof Error ? error.message : 'Unknown error occurred' - }); - } +router.get("/stats", async (req, res) => { + try { + const stats = await sseManager.getStatistics(); + res.json(stats); + } catch (error) { + res.status(500).json({ + success: false, + message: + error instanceof Error ? error.message : "Unknown error occurred", + }); + } }); -export default router; \ No newline at end of file +export default router; diff --git a/src/routes/tool.routes.ts b/src/routes/tool.routes.ts index a9d4394..335e8ac 100644 --- a/src/routes/tool.routes.ts +++ b/src/routes/tool.routes.ts @@ -1,6 +1,6 @@ -import { Router } from 'express'; -import { APP_CONFIG } from '../config/app.config.js'; -import { Tool } from '../types/index.js'; +import { Router } from "express"; +import { APP_CONFIG } from "../config/app.config.js"; +import { Tool } from "../types/index.js"; const router = Router(); @@ -8,68 +8,70 @@ const router = Router(); const tools: Tool[] = []; // List devices endpoint -router.get('/devices', async (req, res) => { - try { - // Get token from Authorization header - const token = req.headers.authorization?.replace('Bearer ', ''); +router.get("/devices", async (req, res) => { + try { + // Get token from Authorization header + const token = req.headers.authorization?.replace("Bearer ", ""); - if (!token || token !== APP_CONFIG.HASS_TOKEN) { - return res.status(401).json({ - success: false, - message: 'Unauthorized - Invalid token' - }); - } - - const tool = tools.find(t => t.name === 'list_devices'); - if (!tool) { - return res.status(404).json({ - success: false, - message: 'Tool not found' - }); - } - - const result = await tool.execute({ token }); - res.json(result); - } catch (error) { - res.status(500).json({ - success: false, - message: error instanceof Error ? error.message : 'Unknown error occurred' - }); + if (!token || token !== APP_CONFIG.HASS_TOKEN) { + return res.status(401).json({ + success: false, + message: "Unauthorized - Invalid token", + }); } + + const tool = tools.find((t) => t.name === "list_devices"); + if (!tool) { + return res.status(404).json({ + success: false, + message: "Tool not found", + }); + } + + const result = await tool.execute({ token }); + res.json(result); + } catch (error) { + res.status(500).json({ + success: false, + message: + error instanceof Error ? error.message : "Unknown error occurred", + }); + } }); // Control device endpoint -router.post('/control', async (req, res) => { - try { - // Get token from Authorization header - const token = req.headers.authorization?.replace('Bearer ', ''); +router.post("/control", async (req, res) => { + try { + // Get token from Authorization header + const token = req.headers.authorization?.replace("Bearer ", ""); - if (!token || token !== APP_CONFIG.HASS_TOKEN) { - return res.status(401).json({ - success: false, - message: 'Unauthorized - Invalid token' - }); - } - - const tool = tools.find(t => t.name === 'control'); - if (!tool) { - return res.status(404).json({ - success: false, - message: 'Tool not found' - }); - } - - const result = await tool.execute({ - ...req.body, - token - }); - res.json(result); - } catch (error) { - res.status(500).json({ - success: false, - message: error instanceof Error ? error.message : 'Unknown error occurred' - }); + if (!token || token !== APP_CONFIG.HASS_TOKEN) { + return res.status(401).json({ + success: false, + message: "Unauthorized - Invalid token", + }); } + + const tool = tools.find((t) => t.name === "control"); + if (!tool) { + return res.status(404).json({ + success: false, + message: "Tool not found", + }); + } + + const result = await tool.execute({ + ...req.body, + token, + }); + res.json(result); + } catch (error) { + res.status(500).json({ + success: false, + message: + error instanceof Error ? error.message : "Unknown error occurred", + }); + } }); -export { router as toolRoutes }; \ No newline at end of file +export { router as toolRoutes }; diff --git a/src/schemas.ts b/src/schemas.ts index 3a2376e..188c522 100644 --- a/src/schemas.ts +++ b/src/schemas.ts @@ -1,229 +1,226 @@ import { z } from "zod"; - export const DomainSchema = z.enum([ - "light", - "climate", - "alarm_control_panel", - "cover", - "switch", - "contact", - "media_player", - "fan", - "lock", - "vacuum", - "scene", - "script", - "camera" + "light", + "climate", + "alarm_control_panel", + "cover", + "switch", + "contact", + "media_player", + "fan", + "lock", + "vacuum", + "scene", + "script", + "camera", ]); // Generic list request schema export const ListRequestSchema = z.object({ - domain: DomainSchema, - area: z.string().optional(), - floor: z.string().optional(), + domain: DomainSchema, + area: z.string().optional(), + floor: z.string().optional(), }); // Areas export const AreaSchema = z.object({ - id: z.string(), - name: z.string(), - floor: z.string(), + id: z.string(), + name: z.string(), + floor: z.string(), }); export const FloorSchema = z.object({ - id: z.string(), - name: z.string(), + id: z.string(), + name: z.string(), }); export const ListFloorsResponseSchema = z.object({ - floors: z.array(FloorSchema), + floors: z.array(FloorSchema), }); // Alarm export const AlarmAttributesSchema = z.object({ - code_format: z.string().optional(), - changed_by: z.string().optional(), - code_arm_required: z.boolean().optional(), - friendly_name: z.string().optional(), - supported_features: z.number().optional(), + code_format: z.string().optional(), + changed_by: z.string().optional(), + code_arm_required: z.boolean().optional(), + friendly_name: z.string().optional(), + supported_features: z.number().optional(), }); export const AlarmSchema = z.object({ - entity_id: z.string(), - state: z.string(), - state_attributes: AlarmAttributesSchema, + entity_id: z.string(), + state: z.string(), + state_attributes: AlarmAttributesSchema, }); - export const ListAlarmsResponseSchema = z.object({ - alarms: z.array(AlarmSchema), + alarms: z.array(AlarmSchema), }); - // Devices export const DeviceSchema = z.object({ - id: z.string(), - name: z.string(), - name_by_user: z.string().optional(), - model: z.string(), - model_id: z.string().nullable(), - manufacturer: z.string(), - area_id: z.string().nullable(), - config_entries: z.array(z.string()), - primary_config_entry: z.string(), - connections: z.array(z.tuple([z.string(), z.string()])), - configuration_url: z.string().nullable(), - disabled_by: z.string().nullable(), - entry_type: z.string().nullable(), - hw_version: z.string().nullable(), - sw_version: z.string().nullable(), - via_device_id: z.string().nullable(), - created_at: z.number(), - modified_at: z.number(), - identifiers: z.array(z.any()), - labels: z.array(z.string()), - serial_number: z.string().optional() + id: z.string(), + name: z.string(), + name_by_user: z.string().optional(), + model: z.string(), + model_id: z.string().nullable(), + manufacturer: z.string(), + area_id: z.string().nullable(), + config_entries: z.array(z.string()), + primary_config_entry: z.string(), + connections: z.array(z.tuple([z.string(), z.string()])), + configuration_url: z.string().nullable(), + disabled_by: z.string().nullable(), + entry_type: z.string().nullable(), + hw_version: z.string().nullable(), + sw_version: z.string().nullable(), + via_device_id: z.string().nullable(), + created_at: z.number(), + modified_at: z.number(), + identifiers: z.array(z.any()), + labels: z.array(z.string()), + serial_number: z.string().optional(), }); export const ListDevicesResponseSchema = z.object({ - _meta: z.object({}).optional(), - devices: z.array(DeviceSchema) + _meta: z.object({}).optional(), + devices: z.array(DeviceSchema), }); // Media Player export const MediaPlayerAttributesSchema = z.object({ - volume_level: z.number().optional(), - is_volume_muted: z.boolean().optional(), - media_content_id: z.string().optional(), - media_content_type: z.string().optional(), - media_duration: z.number().optional(), - media_position: z.number().optional(), - media_title: z.string().optional(), - source: z.string().optional(), - source_list: z.array(z.string()).optional(), - supported_features: z.number().optional(), + volume_level: z.number().optional(), + is_volume_muted: z.boolean().optional(), + media_content_id: z.string().optional(), + media_content_type: z.string().optional(), + media_duration: z.number().optional(), + media_position: z.number().optional(), + media_title: z.string().optional(), + source: z.string().optional(), + source_list: z.array(z.string()).optional(), + supported_features: z.number().optional(), }); export const MediaPlayerSchema = z.object({ - entity_id: z.string(), - state: z.string(), - state_attributes: MediaPlayerAttributesSchema, + entity_id: z.string(), + state: z.string(), + state_attributes: MediaPlayerAttributesSchema, }); // Fan export const FanAttributesSchema = z.object({ - percentage: z.number().optional(), - preset_mode: z.string().optional(), - preset_modes: z.array(z.string()).optional(), - oscillating: z.boolean().optional(), - direction: z.string().optional(), - supported_features: z.number().optional(), + percentage: z.number().optional(), + preset_mode: z.string().optional(), + preset_modes: z.array(z.string()).optional(), + oscillating: z.boolean().optional(), + direction: z.string().optional(), + supported_features: z.number().optional(), }); export const FanSchema = z.object({ - entity_id: z.string(), - state: z.string(), - state_attributes: FanAttributesSchema, + entity_id: z.string(), + state: z.string(), + state_attributes: FanAttributesSchema, }); // Lock export const LockAttributesSchema = z.object({ - code_format: z.string().optional(), - changed_by: z.string().optional(), - locked: z.boolean(), - supported_features: z.number().optional(), + code_format: z.string().optional(), + changed_by: z.string().optional(), + locked: z.boolean(), + supported_features: z.number().optional(), }); export const LockSchema = z.object({ - entity_id: z.string(), - state: z.string(), - state_attributes: LockAttributesSchema, + entity_id: z.string(), + state: z.string(), + state_attributes: LockAttributesSchema, }); // Vacuum export const VacuumAttributesSchema = z.object({ - battery_level: z.number().optional(), - fan_speed: z.string().optional(), - fan_speed_list: z.array(z.string()).optional(), - status: z.string().optional(), - supported_features: z.number().optional(), + battery_level: z.number().optional(), + fan_speed: z.string().optional(), + fan_speed_list: z.array(z.string()).optional(), + status: z.string().optional(), + supported_features: z.number().optional(), }); export const VacuumSchema = z.object({ - entity_id: z.string(), - state: z.string(), - state_attributes: VacuumAttributesSchema, + entity_id: z.string(), + state: z.string(), + state_attributes: VacuumAttributesSchema, }); // Scene export const SceneAttributesSchema = z.object({ - entity_id: z.array(z.string()).optional(), - supported_features: z.number().optional(), + entity_id: z.array(z.string()).optional(), + supported_features: z.number().optional(), }); export const SceneSchema = z.object({ - entity_id: z.string(), - state: z.string(), - state_attributes: SceneAttributesSchema, + entity_id: z.string(), + state: z.string(), + state_attributes: SceneAttributesSchema, }); // Script export const ScriptAttributesSchema = z.object({ - last_triggered: z.string().optional(), - mode: z.string().optional(), - variables: z.record(z.any()).optional(), - supported_features: z.number().optional(), + last_triggered: z.string().optional(), + mode: z.string().optional(), + variables: z.record(z.any()).optional(), + supported_features: z.number().optional(), }); export const ScriptSchema = z.object({ - entity_id: z.string(), - state: z.string(), - state_attributes: ScriptAttributesSchema, + entity_id: z.string(), + state: z.string(), + state_attributes: ScriptAttributesSchema, }); // Camera export const CameraAttributesSchema = z.object({ - motion_detection: z.boolean().optional(), - frontend_stream_type: z.string().optional(), - supported_features: z.number().optional(), + motion_detection: z.boolean().optional(), + frontend_stream_type: z.string().optional(), + supported_features: z.number().optional(), }); export const CameraSchema = z.object({ - entity_id: z.string(), - state: z.string(), - state_attributes: CameraAttributesSchema, + entity_id: z.string(), + state: z.string(), + state_attributes: CameraAttributesSchema, }); // Response schemas for new devices export const ListMediaPlayersResponseSchema = z.object({ - media_players: z.array(MediaPlayerSchema), + media_players: z.array(MediaPlayerSchema), }); export const ListFansResponseSchema = z.object({ - fans: z.array(FanSchema), + fans: z.array(FanSchema), }); export const ListLocksResponseSchema = z.object({ - locks: z.array(LockSchema), + locks: z.array(LockSchema), }); export const ListVacuumsResponseSchema = z.object({ - vacuums: z.array(VacuumSchema), + vacuums: z.array(VacuumSchema), }); export const ListScenesResponseSchema = z.object({ - scenes: z.array(SceneSchema), + scenes: z.array(SceneSchema), }); export const ListScriptsResponseSchema = z.object({ - scripts: z.array(ScriptSchema), + scripts: z.array(ScriptSchema), }); export const ListCamerasResponseSchema = z.object({ - cameras: z.array(CameraSchema), -}); \ No newline at end of file + cameras: z.array(CameraSchema), +}); diff --git a/src/schemas/hass.ts b/src/schemas/hass.ts index 69769c0..8699915 100644 --- a/src/schemas/hass.ts +++ b/src/schemas/hass.ts @@ -1,268 +1,292 @@ -import { JSONSchemaType } from 'ajv'; -import { Entity, StateChangedEvent } from '../types/hass.js'; +import { JSONSchemaType } from "ajv"; +import { Entity, StateChangedEvent } from "../types/hass.js"; // Define base types for automation components type TriggerType = { - platform: string; - event?: string | null; - entity_id?: string | null; - to?: string | null; - from?: string | null; - offset?: string | null; - [key: string]: any; + platform: string; + event?: string | null; + entity_id?: string | null; + to?: string | null; + from?: string | null; + offset?: string | null; + [key: string]: any; }; type ConditionType = { - condition: string; - conditions?: Array> | null; - [key: string]: any; + condition: string; + conditions?: Array> | null; + [key: string]: any; }; type ActionType = { - service: string; - target?: { - entity_id?: string | string[] | null; - [key: string]: any; - } | null; - data?: Record | null; + service: string; + target?: { + entity_id?: string | string[] | null; [key: string]: any; + } | null; + data?: Record | null; + [key: string]: any; }; type AutomationType = { - alias: string; - description?: string | null; - mode?: ('single' | 'parallel' | 'queued' | 'restart') | null; - trigger: TriggerType[]; - condition?: ConditionType[] | null; - action: ActionType[]; + alias: string; + description?: string | null; + mode?: ("single" | "parallel" | "queued" | "restart") | null; + trigger: TriggerType[]; + condition?: ConditionType[] | null; + action: ActionType[]; }; type DeviceControlType = { - domain: 'light' | 'switch' | 'climate' | 'cover' | 'fan' | 'scene' | 'script' | 'media_player'; - command: string; - entity_id: string | string[]; - parameters?: Record | null; + domain: + | "light" + | "switch" + | "climate" + | "cover" + | "fan" + | "scene" + | "script" + | "media_player"; + command: string; + entity_id: string | string[]; + parameters?: Record | null; }; // Define missing types export interface Service { - name: string; - description: string; - target?: { - entity?: string[]; - device?: string[]; - area?: string[]; - } | null; - fields: Record; + name: string; + description: string; + target?: { + entity?: string[]; + device?: string[]; + area?: string[]; + } | null; + fields: Record; } export interface Config { - components: string[]; - config_dir: string; - elevation: number; - latitude: number; - longitude: number; - location_name: string; - time_zone: string; - unit_system: { - length: string; - mass: string; - temperature: string; - volume: string; - }; - version: string; + components: string[]; + config_dir: string; + elevation: number; + latitude: number; + longitude: number; + location_name: string; + time_zone: string; + unit_system: { + length: string; + mass: string; + temperature: string; + volume: string; + }; + version: string; } // Define base schemas const contextSchema = { - type: 'object', - properties: { - id: { type: 'string' }, - parent_id: { type: 'string', nullable: true }, - user_id: { type: 'string', nullable: true } - }, - required: ['id', 'parent_id', 'user_id'], - additionalProperties: false + type: "object", + properties: { + id: { type: "string" }, + parent_id: { type: "string", nullable: true }, + user_id: { type: "string", nullable: true }, + }, + required: ["id", "parent_id", "user_id"], + additionalProperties: false, } as const; // Entity schema export const entitySchema = { - type: 'object', - properties: { - entity_id: { type: 'string' }, - state: { type: 'string' }, - attributes: { - type: 'object', - additionalProperties: true - }, - last_changed: { type: 'string' }, - last_updated: { type: 'string' }, - context: contextSchema + type: "object", + properties: { + entity_id: { type: "string" }, + state: { type: "string" }, + attributes: { + type: "object", + additionalProperties: true, }, - required: ['entity_id', 'state', 'attributes', 'last_changed', 'last_updated', 'context'], - additionalProperties: false + last_changed: { type: "string" }, + last_updated: { type: "string" }, + context: contextSchema, + }, + required: [ + "entity_id", + "state", + "attributes", + "last_changed", + "last_updated", + "context", + ], + additionalProperties: false, } as const; // Service schema export const serviceSchema = { - type: 'object', - properties: { - name: { type: 'string' }, - description: { type: 'string' }, - target: { - type: 'object', - nullable: true, - properties: { - entity: { type: 'array', items: { type: 'string' }, nullable: true }, - device: { type: 'array', items: { type: 'string' }, nullable: true }, - area: { type: 'array', items: { type: 'string' }, nullable: true } - }, - required: [], - additionalProperties: false - }, - fields: { - type: 'object', - additionalProperties: true - } + type: "object", + properties: { + name: { type: "string" }, + description: { type: "string" }, + target: { + type: "object", + nullable: true, + properties: { + entity: { type: "array", items: { type: "string" }, nullable: true }, + device: { type: "array", items: { type: "string" }, nullable: true }, + area: { type: "array", items: { type: "string" }, nullable: true }, + }, + required: [], + additionalProperties: false, }, - required: ['name', 'description', 'fields'], - additionalProperties: false + fields: { + type: "object", + additionalProperties: true, + }, + }, + required: ["name", "description", "fields"], + additionalProperties: false, } as const; // Define the trigger schema without type assertion export const triggerSchema = { - type: 'object', - properties: { - platform: { type: 'string' }, - event: { type: 'string', nullable: true }, - entity_id: { type: 'string', nullable: true }, - to: { type: 'string', nullable: true }, - from: { type: 'string', nullable: true }, - offset: { type: 'string', nullable: true } - }, - required: ['platform'], - additionalProperties: true + type: "object", + properties: { + platform: { type: "string" }, + event: { type: "string", nullable: true }, + entity_id: { type: "string", nullable: true }, + to: { type: "string", nullable: true }, + from: { type: "string", nullable: true }, + offset: { type: "string", nullable: true }, + }, + required: ["platform"], + additionalProperties: true, }; // Define the automation schema export const automationSchema = { - type: 'object', - properties: { - alias: { type: 'string' }, - description: { type: 'string', nullable: true }, - mode: { - type: 'string', - enum: ['single', 'parallel', 'queued', 'restart'], - nullable: true - }, - trigger: { - type: 'array', - items: triggerSchema - }, - condition: { - type: 'array', - items: { - type: 'object', - additionalProperties: true - }, - nullable: true - }, - action: { - type: 'array', - items: { - type: 'object', - additionalProperties: true - } - } + type: "object", + properties: { + alias: { type: "string" }, + description: { type: "string", nullable: true }, + mode: { + type: "string", + enum: ["single", "parallel", "queued", "restart"], + nullable: true, }, - required: ['alias', 'trigger', 'action'], - additionalProperties: false + trigger: { + type: "array", + items: triggerSchema, + }, + condition: { + type: "array", + items: { + type: "object", + additionalProperties: true, + }, + nullable: true, + }, + action: { + type: "array", + items: { + type: "object", + additionalProperties: true, + }, + }, + }, + required: ["alias", "trigger", "action"], + additionalProperties: false, }; export const deviceControlSchema: JSONSchemaType = { - type: 'object', - properties: { - domain: { - type: 'string', - enum: ['light', 'switch', 'climate', 'cover', 'fan', 'scene', 'script', 'media_player'] - }, - command: { type: 'string' }, - entity_id: { - anyOf: [ - { type: 'string' }, - { - type: 'array', - items: { type: 'string' } - } - ] - }, - parameters: { - type: 'object', - nullable: true, - additionalProperties: true - } + type: "object", + properties: { + domain: { + type: "string", + enum: [ + "light", + "switch", + "climate", + "cover", + "fan", + "scene", + "script", + "media_player", + ], }, - required: ['domain', 'command', 'entity_id'], - additionalProperties: false + command: { type: "string" }, + entity_id: { + anyOf: [ + { type: "string" }, + { + type: "array", + items: { type: "string" }, + }, + ], + }, + parameters: { + type: "object", + nullable: true, + additionalProperties: true, + }, + }, + required: ["domain", "command", "entity_id"], + additionalProperties: false, }; // State changed event schema export const stateChangedEventSchema = { - type: 'object', - properties: { - event_type: { type: 'string', const: 'state_changed' }, - data: { - type: 'object', - properties: { - entity_id: { type: 'string' }, - new_state: { ...entitySchema, nullable: true }, - old_state: { ...entitySchema, nullable: true } - }, - required: ['entity_id', 'new_state', 'old_state'], - additionalProperties: false - }, - origin: { type: 'string' }, - time_fired: { type: 'string' }, - context: contextSchema + type: "object", + properties: { + event_type: { type: "string", const: "state_changed" }, + data: { + type: "object", + properties: { + entity_id: { type: "string" }, + new_state: { ...entitySchema, nullable: true }, + old_state: { ...entitySchema, nullable: true }, + }, + required: ["entity_id", "new_state", "old_state"], + additionalProperties: false, }, - required: ['event_type', 'data', 'origin', 'time_fired', 'context'], - additionalProperties: false + origin: { type: "string" }, + time_fired: { type: "string" }, + context: contextSchema, + }, + required: ["event_type", "data", "origin", "time_fired", "context"], + additionalProperties: false, } as const; // Config schema export const configSchema = { - type: 'object', - properties: { - components: { type: 'array', items: { type: 'string' } }, - config_dir: { type: 'string' }, - elevation: { type: 'number' }, - latitude: { type: 'number' }, - longitude: { type: 'number' }, - location_name: { type: 'string' }, - time_zone: { type: 'string' }, - unit_system: { - type: 'object', - properties: { - length: { type: 'string' }, - mass: { type: 'string' }, - temperature: { type: 'string' }, - volume: { type: 'string' } - }, - required: ['length', 'mass', 'temperature', 'volume'], - additionalProperties: false - }, - version: { type: 'string' } + type: "object", + properties: { + components: { type: "array", items: { type: "string" } }, + config_dir: { type: "string" }, + elevation: { type: "number" }, + latitude: { type: "number" }, + longitude: { type: "number" }, + location_name: { type: "string" }, + time_zone: { type: "string" }, + unit_system: { + type: "object", + properties: { + length: { type: "string" }, + mass: { type: "string" }, + temperature: { type: "string" }, + volume: { type: "string" }, + }, + required: ["length", "mass", "temperature", "volume"], + additionalProperties: false, }, - required: [ - 'components', - 'config_dir', - 'elevation', - 'latitude', - 'longitude', - 'location_name', - 'time_zone', - 'unit_system', - 'version' - ], - additionalProperties: false -} as const; \ No newline at end of file + version: { type: "string" }, + }, + required: [ + "components", + "config_dir", + "elevation", + "latitude", + "longitude", + "location_name", + "time_zone", + "unit_system", + "version", + ], + additionalProperties: false, +} as const; diff --git a/src/security/__tests__/security.test.ts b/src/security/__tests__/security.test.ts index bb8ac28..0f33a4f 100644 --- a/src/security/__tests__/security.test.ts +++ b/src/security/__tests__/security.test.ts @@ -1,136 +1,150 @@ -import { TokenManager } from '../index'; -import { SECURITY_CONFIG } from '../../config/security.config'; -import jwt from 'jsonwebtoken'; -import { jest } from '@jest/globals'; +import { TokenManager } from "../index"; +import { SECURITY_CONFIG } from "../../config/security.config"; +import jwt from "jsonwebtoken"; +import { jest } from "@jest/globals"; -describe('TokenManager', () => { - const validSecret = 'test_secret_key_that_is_at_least_32_chars_long'; - const testIp = '127.0.0.1'; +describe("TokenManager", () => { + const validSecret = "test_secret_key_that_is_at_least_32_chars_long"; + const testIp = "127.0.0.1"; - beforeEach(() => { - process.env.JWT_SECRET = validSecret; - jest.clearAllMocks(); + beforeEach(() => { + process.env.JWT_SECRET = validSecret; + jest.clearAllMocks(); + }); + + afterEach(() => { + delete process.env.JWT_SECRET; + }); + + describe("Token Validation", () => { + it("should validate a properly formatted token", () => { + const payload = { userId: "123", role: "user" }; + const token = jwt.sign(payload, validSecret); + const result = TokenManager.validateToken(token, testIp); + expect(result.valid).toBe(true); + expect(result.error).toBeUndefined(); }); - afterEach(() => { - delete process.env.JWT_SECRET; + it("should reject an invalid token", () => { + const result = TokenManager.validateToken("invalid_token", testIp); + expect(result.valid).toBe(false); + expect(result.error).toBe("Token length below minimum requirement"); }); - describe('Token Validation', () => { - it('should validate a properly formatted token', () => { - const payload = { userId: '123', role: 'user' }; - const token = jwt.sign(payload, validSecret); - const result = TokenManager.validateToken(token, testIp); - expect(result.valid).toBe(true); - expect(result.error).toBeUndefined(); - }); - - it('should reject an invalid token', () => { - const result = TokenManager.validateToken('invalid_token', testIp); - expect(result.valid).toBe(false); - expect(result.error).toBe('Token length below minimum requirement'); - }); - - it('should reject a token that is too short', () => { - const result = TokenManager.validateToken('short', testIp); - expect(result.valid).toBe(false); - expect(result.error).toBe('Token length below minimum requirement'); - }); - - it('should reject an expired token', () => { - const now = Math.floor(Date.now() / 1000); - const payload = { - userId: '123', - role: 'user', - iat: now - 7200, // 2 hours ago - exp: now - 3600 // expired 1 hour ago - }; - const token = jwt.sign(payload, validSecret); - const result = TokenManager.validateToken(token, testIp); - expect(result.valid).toBe(false); - expect(result.error).toBe('Token has expired'); - }); - - it('should implement rate limiting for failed attempts', async () => { - // Simulate multiple failed attempts - for (let i = 0; i < SECURITY_CONFIG.MAX_FAILED_ATTEMPTS; i++) { - const result = TokenManager.validateToken('invalid_token', testIp); - expect(result.valid).toBe(false); - } - - // Next attempt should be blocked by rate limiting - const result = TokenManager.validateToken('invalid_token', testIp); - expect(result.valid).toBe(false); - expect(result.error).toBe('Too many failed attempts. Please try again later.'); - - // Wait for rate limit to expire - await new Promise(resolve => setTimeout(resolve, SECURITY_CONFIG.LOCKOUT_DURATION + 100)); - - // Should be able to try again - const validPayload = { userId: '123', role: 'user' }; - const validToken = jwt.sign(validPayload, validSecret); - const finalResult = TokenManager.validateToken(validToken, testIp); - expect(finalResult.valid).toBe(true); - }); + it("should reject a token that is too short", () => { + const result = TokenManager.validateToken("short", testIp); + expect(result.valid).toBe(false); + expect(result.error).toBe("Token length below minimum requirement"); }); - describe('Token Generation', () => { - it('should generate a valid JWT token', () => { - const payload = { userId: '123', role: 'user' }; - const token = TokenManager.generateToken(payload); - expect(token).toBeDefined(); - expect(typeof token).toBe('string'); - - // Verify the token can be decoded - const decoded = jwt.verify(token, validSecret) as any; - expect(decoded.userId).toBe(payload.userId); - expect(decoded.role).toBe(payload.role); - }); - - it('should include required claims in generated tokens', () => { - const payload = { userId: '123' }; - const token = TokenManager.generateToken(payload); - const decoded = jwt.verify(token, validSecret) as any; - - expect(decoded.iat).toBeDefined(); - expect(decoded.exp).toBeDefined(); - expect(decoded.exp - decoded.iat).toBe( - Math.floor(24 * 60 * 60) // 24 hours in seconds - ); - }); - - it('should throw error when JWT secret is not configured', () => { - delete process.env.JWT_SECRET; - const payload = { userId: '123' }; - expect(() => TokenManager.generateToken(payload)).toThrow('JWT secret not configured'); - }); + it("should reject an expired token", () => { + const now = Math.floor(Date.now() / 1000); + const payload = { + userId: "123", + role: "user", + iat: now - 7200, // 2 hours ago + exp: now - 3600, // expired 1 hour ago + }; + const token = jwt.sign(payload, validSecret); + const result = TokenManager.validateToken(token, testIp); + expect(result.valid).toBe(false); + expect(result.error).toBe("Token has expired"); }); - describe('Token Encryption', () => { - const encryptionKey = 'encryption_key_that_is_at_least_32_chars_long'; + it("should implement rate limiting for failed attempts", async () => { + // Simulate multiple failed attempts + for (let i = 0; i < SECURITY_CONFIG.MAX_FAILED_ATTEMPTS; i++) { + const result = TokenManager.validateToken("invalid_token", testIp); + expect(result.valid).toBe(false); + } - it('should encrypt and decrypt a token successfully', () => { - const originalToken = 'test_token_to_encrypt'; - const encrypted = TokenManager.encryptToken(originalToken, encryptionKey); - const decrypted = TokenManager.decryptToken(encrypted, encryptionKey); - expect(decrypted).toBe(originalToken); - }); + // Next attempt should be blocked by rate limiting + const result = TokenManager.validateToken("invalid_token", testIp); + expect(result.valid).toBe(false); + expect(result.error).toBe( + "Too many failed attempts. Please try again later.", + ); - it('should throw error for invalid encryption inputs', () => { - expect(() => TokenManager.encryptToken('', encryptionKey)).toThrow('Invalid token'); - expect(() => TokenManager.encryptToken('valid_token', '')).toThrow('Invalid encryption key'); - }); + // Wait for rate limit to expire + await new Promise((resolve) => + setTimeout(resolve, SECURITY_CONFIG.LOCKOUT_DURATION + 100), + ); - it('should throw error for invalid decryption inputs', () => { - expect(() => TokenManager.decryptToken('', encryptionKey)).toThrow('Invalid encrypted token'); - expect(() => TokenManager.decryptToken('invalid:format', encryptionKey)).toThrow('Invalid encrypted token format'); - }); - - it('should generate different ciphertexts for same plaintext', () => { - const token = 'test_token'; - const encrypted1 = TokenManager.encryptToken(token, encryptionKey); - const encrypted2 = TokenManager.encryptToken(token, encryptionKey); - expect(encrypted1).not.toBe(encrypted2); - }); + // Should be able to try again + const validPayload = { userId: "123", role: "user" }; + const validToken = jwt.sign(validPayload, validSecret); + const finalResult = TokenManager.validateToken(validToken, testIp); + expect(finalResult.valid).toBe(true); }); -}); \ No newline at end of file + }); + + describe("Token Generation", () => { + it("should generate a valid JWT token", () => { + const payload = { userId: "123", role: "user" }; + const token = TokenManager.generateToken(payload); + expect(token).toBeDefined(); + expect(typeof token).toBe("string"); + + // Verify the token can be decoded + const decoded = jwt.verify(token, validSecret) as any; + expect(decoded.userId).toBe(payload.userId); + expect(decoded.role).toBe(payload.role); + }); + + it("should include required claims in generated tokens", () => { + const payload = { userId: "123" }; + const token = TokenManager.generateToken(payload); + const decoded = jwt.verify(token, validSecret) as any; + + expect(decoded.iat).toBeDefined(); + expect(decoded.exp).toBeDefined(); + expect(decoded.exp - decoded.iat).toBe( + Math.floor(24 * 60 * 60), // 24 hours in seconds + ); + }); + + it("should throw error when JWT secret is not configured", () => { + delete process.env.JWT_SECRET; + const payload = { userId: "123" }; + expect(() => TokenManager.generateToken(payload)).toThrow( + "JWT secret not configured", + ); + }); + }); + + describe("Token Encryption", () => { + const encryptionKey = "encryption_key_that_is_at_least_32_chars_long"; + + it("should encrypt and decrypt a token successfully", () => { + const originalToken = "test_token_to_encrypt"; + const encrypted = TokenManager.encryptToken(originalToken, encryptionKey); + const decrypted = TokenManager.decryptToken(encrypted, encryptionKey); + expect(decrypted).toBe(originalToken); + }); + + it("should throw error for invalid encryption inputs", () => { + expect(() => TokenManager.encryptToken("", encryptionKey)).toThrow( + "Invalid token", + ); + expect(() => TokenManager.encryptToken("valid_token", "")).toThrow( + "Invalid encryption key", + ); + }); + + it("should throw error for invalid decryption inputs", () => { + expect(() => TokenManager.decryptToken("", encryptionKey)).toThrow( + "Invalid encrypted token", + ); + expect(() => + TokenManager.decryptToken("invalid:format", encryptionKey), + ).toThrow("Invalid encrypted token format"); + }); + + it("should generate different ciphertexts for same plaintext", () => { + const token = "test_token"; + const encrypted1 = TokenManager.encryptToken(token, encryptionKey); + const encrypted2 = TokenManager.encryptToken(token, encryptionKey); + expect(encrypted1).not.toBe(encrypted2); + }); + }); +}); diff --git a/src/security/index.ts b/src/security/index.ts index 5c71518..8b07dc3 100644 --- a/src/security/index.ts +++ b/src/security/index.ts @@ -1,9 +1,9 @@ -import crypto from 'crypto'; -import { Request, Response, NextFunction } from 'express'; -import rateLimit from 'express-rate-limit'; -import helmet from 'helmet'; -import { HelmetOptions } from 'helmet'; -import jwt from 'jsonwebtoken'; +import crypto from "crypto"; +import { Request, Response, NextFunction } from "express"; +import rateLimit from "express-rate-limit"; +import helmet from "helmet"; +import { HelmetOptions } from "helmet"; +import jwt from "jsonwebtoken"; // Security configuration const RATE_LIMIT_WINDOW = 15 * 60 * 1000; // 15 minutes @@ -12,370 +12,400 @@ const TOKEN_EXPIRY = 24 * 60 * 60 * 1000; // 24 hours // Rate limiting middleware export const rateLimiter = rateLimit({ - windowMs: RATE_LIMIT_WINDOW, - max: RATE_LIMIT_MAX, - message: 'Too many requests from this IP, please try again later' + windowMs: RATE_LIMIT_WINDOW, + max: RATE_LIMIT_MAX, + message: "Too many requests from this IP, please try again later", }); // Security configuration const helmetConfig: HelmetOptions = { - contentSecurityPolicy: { - useDefaults: true, - directives: { - defaultSrc: ["'self'"], - scriptSrc: ["'self'", "'unsafe-inline'"], - styleSrc: ["'self'", "'unsafe-inline'"], - imgSrc: ["'self'", 'data:', 'https:'], - connectSrc: ["'self'", 'wss:', 'https:'] - } + contentSecurityPolicy: { + useDefaults: true, + directives: { + defaultSrc: ["'self'"], + scriptSrc: ["'self'", "'unsafe-inline'"], + styleSrc: ["'self'", "'unsafe-inline'"], + imgSrc: ["'self'", "data:", "https:"], + connectSrc: ["'self'", "wss:", "https:"], }, - dnsPrefetchControl: true, - frameguard: true, - hidePoweredBy: true, - hsts: true, - ieNoOpen: true, - noSniff: true, - referrerPolicy: { - policy: ['no-referrer', 'strict-origin-when-cross-origin'] - } + }, + dnsPrefetchControl: true, + frameguard: true, + hidePoweredBy: true, + hsts: true, + ieNoOpen: true, + noSniff: true, + referrerPolicy: { + policy: ["no-referrer", "strict-origin-when-cross-origin"], + }, }; // Security headers middleware export const securityHeaders = helmet(helmetConfig); -const ALGORITHM = 'aes-256-gcm'; +const ALGORITHM = "aes-256-gcm"; const IV_LENGTH = 16; const AUTH_TAG_LENGTH = 16; // Security configuration const SECURITY_CONFIG = { - TOKEN_EXPIRY: 24 * 60 * 60 * 1000, // 24 hours - MAX_TOKEN_AGE: 30 * 24 * 60 * 60 * 1000, // 30 days - MIN_TOKEN_LENGTH: 32, - MAX_FAILED_ATTEMPTS: 5, - LOCKOUT_DURATION: 15 * 60 * 1000, // 15 minutes + TOKEN_EXPIRY: 24 * 60 * 60 * 1000, // 24 hours + MAX_TOKEN_AGE: 30 * 24 * 60 * 60 * 1000, // 30 days + MIN_TOKEN_LENGTH: 32, + MAX_FAILED_ATTEMPTS: 5, + LOCKOUT_DURATION: 15 * 60 * 1000, // 15 minutes }; // Track failed authentication attempts -const failedAttempts = new Map(); +const failedAttempts = new Map< + string, + { count: number; lastAttempt: number } +>(); export class TokenManager { - /** - * Encrypts a token using AES-256-GCM - */ - static encryptToken(token: string, key: string): string { - if (!token || typeof token !== 'string') { - throw new Error('Invalid token'); - } - if (!key || typeof key !== 'string' || key.length < 32) { - throw new Error('Invalid encryption key'); - } - - try { - const iv = crypto.randomBytes(IV_LENGTH); - const cipher = crypto.createCipheriv(ALGORITHM, key.slice(0, 32), iv); - - const encrypted = Buffer.concat([ - cipher.update(token, 'utf8'), - cipher.final() - ]); - const tag = cipher.getAuthTag(); - - // Format: algorithm:iv:tag:encrypted - return `${ALGORITHM}:${iv.toString('base64')}:${tag.toString('base64')}:${encrypted.toString('base64')}`; - } catch (error) { - throw new Error('Failed to encrypt token'); - } + /** + * Encrypts a token using AES-256-GCM + */ + static encryptToken(token: string, key: string): string { + if (!token || typeof token !== "string") { + throw new Error("Invalid token"); + } + if (!key || typeof key !== "string" || key.length < 32) { + throw new Error("Invalid encryption key"); } - /** - * Decrypts a token using AES-256-GCM - */ - static decryptToken(encryptedToken: string, key: string): string { - if (!encryptedToken || typeof encryptedToken !== 'string') { - throw new Error('Invalid encrypted token'); - } - if (!key || typeof key !== 'string' || key.length < 32) { - throw new Error('Invalid encryption key'); - } + try { + const iv = crypto.randomBytes(IV_LENGTH); + const cipher = crypto.createCipheriv(ALGORITHM, key.slice(0, 32), iv); - try { - const [algorithm, ivBase64, tagBase64, encryptedBase64] = encryptedToken.split(':'); + const encrypted = Buffer.concat([ + cipher.update(token, "utf8"), + cipher.final(), + ]); + const tag = cipher.getAuthTag(); - if (algorithm !== ALGORITHM || !ivBase64 || !tagBase64 || !encryptedBase64) { - throw new Error('Invalid encrypted token format'); - } + // Format: algorithm:iv:tag:encrypted + return `${ALGORITHM}:${iv.toString("base64")}:${tag.toString("base64")}:${encrypted.toString("base64")}`; + } catch (error) { + throw new Error("Failed to encrypt token"); + } + } - const iv = Buffer.from(ivBase64, 'base64'); - const tag = Buffer.from(tagBase64, 'base64'); - const encrypted = Buffer.from(encryptedBase64, 'base64'); - - const decipher = crypto.createDecipheriv(ALGORITHM, key.slice(0, 32), iv); - decipher.setAuthTag(tag); - - return Buffer.concat([ - decipher.update(encrypted), - decipher.final() - ]).toString('utf8'); - } catch (error) { - if (error instanceof Error && error.message === 'Invalid encrypted token format') { - throw error; - } - throw new Error('Invalid encrypted token'); - } + /** + * Decrypts a token using AES-256-GCM + */ + static decryptToken(encryptedToken: string, key: string): string { + if (!encryptedToken || typeof encryptedToken !== "string") { + throw new Error("Invalid encrypted token"); + } + if (!key || typeof key !== "string" || key.length < 32) { + throw new Error("Invalid encryption key"); } - /** - * Validates a JWT token with enhanced security checks - */ - static validateToken(token: string | undefined | null, ip?: string): { valid: boolean; error?: string } { - // Check basic token format - if (!token || typeof token !== 'string') { - return { valid: false, error: 'Invalid token format' }; - } + try { + const [algorithm, ivBase64, tagBase64, encryptedBase64] = + encryptedToken.split(":"); - // Check for token length - if (token.length < SECURITY_CONFIG.MIN_TOKEN_LENGTH) { - if (ip) this.recordFailedAttempt(ip); - return { valid: false, error: 'Token length below minimum requirement' }; - } + if ( + algorithm !== ALGORITHM || + !ivBase64 || + !tagBase64 || + !encryptedBase64 + ) { + throw new Error("Invalid encrypted token format"); + } - // Check for rate limiting - if (ip && this.isRateLimited(ip)) { - return { valid: false, error: 'Too many failed attempts. Please try again later.' }; - } + const iv = Buffer.from(ivBase64, "base64"); + const tag = Buffer.from(tagBase64, "base64"); + const encrypted = Buffer.from(encryptedBase64, "base64"); - // Get JWT secret - const secret = process.env.JWT_SECRET; - if (!secret) { - return { valid: false, error: 'JWT secret not configured' }; - } + const decipher = crypto.createDecipheriv(ALGORITHM, key.slice(0, 32), iv); + decipher.setAuthTag(tag); - try { - // Verify token signature and decode - const decoded = jwt.verify(token, secret, { - algorithms: ['HS256'], - clockTolerance: 0, // No clock skew tolerance - ignoreExpiration: false // Always check expiration - }) as jwt.JwtPayload; + return Buffer.concat([ + decipher.update(encrypted), + decipher.final(), + ]).toString("utf8"); + } catch (error) { + if ( + error instanceof Error && + error.message === "Invalid encrypted token format" + ) { + throw error; + } + throw new Error("Invalid encrypted token"); + } + } - // Verify token structure - if (!decoded || typeof decoded !== 'object') { - if (ip) this.recordFailedAttempt(ip); - return { valid: false, error: 'Invalid token structure' }; - } - - // Check required claims - if (!decoded.exp || !decoded.iat) { - if (ip) this.recordFailedAttempt(ip); - return { valid: false, error: 'Token missing required claims' }; - } - - const now = Math.floor(Date.now() / 1000); - - // Check expiration - if (decoded.exp <= now) { - if (ip) this.recordFailedAttempt(ip); - return { valid: false, error: 'Token has expired' }; - } - - // Check token age - const tokenAge = (now - decoded.iat) * 1000; - if (tokenAge > SECURITY_CONFIG.MAX_TOKEN_AGE) { - if (ip) this.recordFailedAttempt(ip); - return { valid: false, error: 'Token exceeds maximum age limit' }; - } - - // Reset failed attempts on successful validation - if (ip) { - failedAttempts.delete(ip); - } - - return { valid: true }; - } catch (error) { - if (ip) this.recordFailedAttempt(ip); - if (error instanceof jwt.TokenExpiredError) { - return { valid: false, error: 'Token has expired' }; - } - if (error instanceof jwt.JsonWebTokenError) { - return { valid: false, error: 'Invalid token signature' }; - } - return { valid: false, error: 'Token validation failed' }; - } + /** + * Validates a JWT token with enhanced security checks + */ + static validateToken( + token: string | undefined | null, + ip?: string, + ): { valid: boolean; error?: string } { + // Check basic token format + if (!token || typeof token !== "string") { + return { valid: false, error: "Invalid token format" }; } - /** - * Records a failed authentication attempt for rate limiting - */ - private static recordFailedAttempt(ip?: string): void { - if (!ip) return; - - const attempt = failedAttempts.get(ip) || { count: 0, lastAttempt: Date.now() }; - attempt.count++; - attempt.lastAttempt = Date.now(); - failedAttempts.set(ip, attempt); + // Check for token length + if (token.length < SECURITY_CONFIG.MIN_TOKEN_LENGTH) { + if (ip) this.recordFailedAttempt(ip); + return { valid: false, error: "Token length below minimum requirement" }; } - /** - * Checks if an IP is rate limited due to too many failed attempts - */ - private static isRateLimited(ip: string): boolean { - const attempt = failedAttempts.get(ip); - if (!attempt) return false; - - // Reset if lockout duration has passed - if (Date.now() - attempt.lastAttempt >= SECURITY_CONFIG.LOCKOUT_DURATION) { - failedAttempts.delete(ip); - return false; - } - - return attempt.count >= SECURITY_CONFIG.MAX_FAILED_ATTEMPTS; + // Check for rate limiting + if (ip && this.isRateLimited(ip)) { + return { + valid: false, + error: "Too many failed attempts. Please try again later.", + }; } - /** - * Generates a new JWT token - */ - static generateToken(payload: Record): string { - const secret = process.env.JWT_SECRET; - if (!secret) { - throw new Error('JWT secret not configured'); - } - - // Add required claims - const now = Math.floor(Date.now() / 1000); - const tokenPayload = { - ...payload, - iat: now, - exp: now + Math.floor(TOKEN_EXPIRY / 1000) - }; - - return jwt.sign(tokenPayload, secret, { - algorithm: 'HS256' - }); + // Get JWT secret + const secret = process.env.JWT_SECRET; + if (!secret) { + return { valid: false, error: "JWT secret not configured" }; } + + try { + // Verify token signature and decode + const decoded = jwt.verify(token, secret, { + algorithms: ["HS256"], + clockTolerance: 0, // No clock skew tolerance + ignoreExpiration: false, // Always check expiration + }) as jwt.JwtPayload; + + // Verify token structure + if (!decoded || typeof decoded !== "object") { + if (ip) this.recordFailedAttempt(ip); + return { valid: false, error: "Invalid token structure" }; + } + + // Check required claims + if (!decoded.exp || !decoded.iat) { + if (ip) this.recordFailedAttempt(ip); + return { valid: false, error: "Token missing required claims" }; + } + + const now = Math.floor(Date.now() / 1000); + + // Check expiration + if (decoded.exp <= now) { + if (ip) this.recordFailedAttempt(ip); + return { valid: false, error: "Token has expired" }; + } + + // Check token age + const tokenAge = (now - decoded.iat) * 1000; + if (tokenAge > SECURITY_CONFIG.MAX_TOKEN_AGE) { + if (ip) this.recordFailedAttempt(ip); + return { valid: false, error: "Token exceeds maximum age limit" }; + } + + // Reset failed attempts on successful validation + if (ip) { + failedAttempts.delete(ip); + } + + return { valid: true }; + } catch (error) { + if (ip) this.recordFailedAttempt(ip); + if (error instanceof jwt.TokenExpiredError) { + return { valid: false, error: "Token has expired" }; + } + if (error instanceof jwt.JsonWebTokenError) { + return { valid: false, error: "Invalid token signature" }; + } + return { valid: false, error: "Token validation failed" }; + } + } + + /** + * Records a failed authentication attempt for rate limiting + */ + private static recordFailedAttempt(ip?: string): void { + if (!ip) return; + + const attempt = failedAttempts.get(ip) || { + count: 0, + lastAttempt: Date.now(), + }; + attempt.count++; + attempt.lastAttempt = Date.now(); + failedAttempts.set(ip, attempt); + } + + /** + * Checks if an IP is rate limited due to too many failed attempts + */ + private static isRateLimited(ip: string): boolean { + const attempt = failedAttempts.get(ip); + if (!attempt) return false; + + // Reset if lockout duration has passed + if (Date.now() - attempt.lastAttempt >= SECURITY_CONFIG.LOCKOUT_DURATION) { + failedAttempts.delete(ip); + return false; + } + + return attempt.count >= SECURITY_CONFIG.MAX_FAILED_ATTEMPTS; + } + + /** + * Generates a new JWT token + */ + static generateToken(payload: Record): string { + const secret = process.env.JWT_SECRET; + if (!secret) { + throw new Error("JWT secret not configured"); + } + + // Add required claims + const now = Math.floor(Date.now() / 1000); + const tokenPayload = { + ...payload, + iat: now, + exp: now + Math.floor(TOKEN_EXPIRY / 1000), + }; + + return jwt.sign(tokenPayload, secret, { + algorithm: "HS256", + }); + } } // Request validation middleware -export function validateRequest(req: Request, res: Response, next: NextFunction): Response | void { - // Skip validation for health and MCP schema endpoints - if (req.path === '/health' || req.path === '/mcp') { - return next(); +export function validateRequest( + req: Request, + res: Response, + next: NextFunction, +): Response | void { + // Skip validation for health and MCP schema endpoints + if (req.path === "/health" || req.path === "/mcp") { + return next(); + } + + // Validate content type for non-GET requests + if (["POST", "PUT", "PATCH"].includes(req.method)) { + const contentType = req.headers["content-type"] || ""; + if (!contentType.toLowerCase().includes("application/json")) { + return res.status(415).json({ + success: false, + message: "Unsupported Media Type", + error: "Content-Type must be application/json", + timestamp: new Date().toISOString(), + }); + } + } + + // Validate authorization header + const authHeader = req.headers.authorization; + if (!authHeader || !authHeader.startsWith("Bearer ")) { + return res.status(401).json({ + success: false, + message: "Unauthorized", + error: "Missing or invalid authorization header", + timestamp: new Date().toISOString(), + }); + } + + // Validate token + const token = authHeader.replace("Bearer ", ""); + const validationResult = TokenManager.validateToken(token, req.ip); + if (!validationResult.valid) { + return res.status(401).json({ + success: false, + message: "Unauthorized", + error: validationResult.error || "Invalid token", + timestamp: new Date().toISOString(), + }); + } + + // Validate request body for non-GET requests + if (["POST", "PUT", "PATCH"].includes(req.method)) { + if (!req.body || typeof req.body !== "object" || Array.isArray(req.body)) { + return res.status(400).json({ + success: false, + message: "Bad Request", + error: "Invalid request body structure", + timestamp: new Date().toISOString(), + }); } - // Validate content type for non-GET requests - if (['POST', 'PUT', 'PATCH'].includes(req.method)) { - const contentType = req.headers['content-type'] || ''; - if (!contentType.toLowerCase().includes('application/json')) { - return res.status(415).json({ - success: false, - message: 'Unsupported Media Type', - error: 'Content-Type must be application/json', - timestamp: new Date().toISOString() - }); - } + // Check request body size + const contentLength = parseInt(req.headers["content-length"] || "0", 10); + const maxSize = 1024 * 1024; // 1MB limit + if (contentLength > maxSize) { + return res.status(413).json({ + success: false, + message: "Payload Too Large", + error: `Request body must not exceed ${maxSize} bytes`, + timestamp: new Date().toISOString(), + }); } + } - // Validate authorization header - const authHeader = req.headers.authorization; - if (!authHeader || !authHeader.startsWith('Bearer ')) { - return res.status(401).json({ - success: false, - message: 'Unauthorized', - error: 'Missing or invalid authorization header', - timestamp: new Date().toISOString() - }); - } - - // Validate token - const token = authHeader.replace('Bearer ', ''); - const validationResult = TokenManager.validateToken(token, req.ip); - if (!validationResult.valid) { - return res.status(401).json({ - success: false, - message: 'Unauthorized', - error: validationResult.error || 'Invalid token', - timestamp: new Date().toISOString() - }); - } - - // Validate request body for non-GET requests - if (['POST', 'PUT', 'PATCH'].includes(req.method)) { - if (!req.body || typeof req.body !== 'object' || Array.isArray(req.body)) { - return res.status(400).json({ - success: false, - message: 'Bad Request', - error: 'Invalid request body structure', - timestamp: new Date().toISOString() - }); - } - - // Check request body size - const contentLength = parseInt(req.headers['content-length'] || '0', 10); - const maxSize = 1024 * 1024; // 1MB limit - if (contentLength > maxSize) { - return res.status(413).json({ - success: false, - message: 'Payload Too Large', - error: `Request body must not exceed ${maxSize} bytes`, - timestamp: new Date().toISOString() - }); - } - } - - next(); + next(); } // Input sanitization middleware export function sanitizeInput(req: Request, res: Response, next: NextFunction) { - if (!req.body) { - return next(); - } + if (!req.body) { + return next(); + } - function sanitizeValue(value: unknown): unknown { - if (typeof value === 'string') { - // Remove HTML tags and scripts more thoroughly - return value - .replace(/)<[^<]*)*<\/script>/gi, '') // Remove script tags and content - .replace(/)<[^<]*)*<\/style>/gi, '') // Remove style tags and content - .replace(/<[^>]+>/g, '') // Remove remaining HTML tags - .replace(/javascript:/gi, '') // Remove javascript: protocol - .replace(/on\w+\s*=\s*(?:".*?"|'.*?'|[^"'>\s]+)/gi, '') // Remove event handlers - .trim(); - } - if (Array.isArray(value)) { - return value.map(item => sanitizeValue(item)); - } - if (typeof value === 'object' && value !== null) { - const sanitized: Record = {}; - for (const [key, val] of Object.entries(value)) { - sanitized[key] = sanitizeValue(val); - } - return sanitized; - } - return value; + function sanitizeValue(value: unknown): unknown { + if (typeof value === "string") { + // Remove HTML tags and scripts more thoroughly + return value + .replace(/)<[^<]*)*<\/script>/gi, "") // Remove script tags and content + .replace(/)<[^<]*)*<\/style>/gi, "") // Remove style tags and content + .replace(/<[^>]+>/g, "") // Remove remaining HTML tags + .replace(/javascript:/gi, "") // Remove javascript: protocol + .replace(/on\w+\s*=\s*(?:".*?"|'.*?'|[^"'>\s]+)/gi, "") // Remove event handlers + .trim(); } + if (Array.isArray(value)) { + return value.map((item) => sanitizeValue(item)); + } + if (typeof value === "object" && value !== null) { + const sanitized: Record = {}; + for (const [key, val] of Object.entries(value)) { + sanitized[key] = sanitizeValue(val); + } + return sanitized; + } + return value; + } - req.body = sanitizeValue(req.body); - next(); + req.body = sanitizeValue(req.body); + next(); } // Error handling middleware -export function errorHandler(err: Error, req: Request, res: Response, next: NextFunction) { - console.error(err.stack); - res.status(500).json({ - error: 'Internal Server Error', - message: process.env.NODE_ENV === 'development' ? err.message : undefined - }); +export function errorHandler( + err: Error, + req: Request, + res: Response, + next: NextFunction, +) { + console.error(err.stack); + res.status(500).json({ + error: "Internal Server Error", + message: process.env.NODE_ENV === "development" ? err.message : undefined, + }); } // Export security middleware chain export const securityMiddleware = [ - helmet(helmetConfig), - rateLimit({ - windowMs: 15 * 60 * 1000, - max: 100 - }), - validateRequest, - sanitizeInput, - errorHandler -]; \ No newline at end of file + helmet(helmetConfig), + rateLimit({ + windowMs: 15 * 60 * 1000, + max: 100, + }), + validateRequest, + sanitizeInput, + errorHandler, +]; diff --git a/src/security/middleware.test.ts b/src/security/middleware.test.ts index 2646857..2446d0a 100644 --- a/src/security/middleware.test.ts +++ b/src/security/middleware.test.ts @@ -1,109 +1,143 @@ -import { Request, Response, NextFunction } from 'express'; -import { validateRequest, sanitizeInput } from '../../src/security/middleware'; +import { Request, Response, NextFunction } from "express"; +import { validateRequest, sanitizeInput } from "../../src/security/middleware"; type MockRequest = { - headers: { - 'content-type'?: string; - authorization?: string; - }; - body?: any; - is: jest.MockInstance; + headers: { + "content-type"?: string; + authorization?: string; + }; + body?: any; + is: jest.MockInstance; }; type MockResponse = { - status: jest.MockInstance; - json: jest.MockInstance; - setHeader: jest.MockInstance; + status: jest.MockInstance; + json: jest.MockInstance; + setHeader: jest.MockInstance; }; -describe('Security Middleware', () => { - let mockRequest: MockRequest; - let mockResponse: MockResponse; - let nextFunction: jest.Mock; +describe("Security Middleware", () => { + let mockRequest: MockRequest; + let mockResponse: MockResponse; + let nextFunction: jest.Mock; - beforeEach(() => { - mockRequest = { - headers: {}, - body: {}, - is: jest.fn().mockReturnValue('json') - }; + beforeEach(() => { + mockRequest = { + headers: {}, + body: {}, + is: jest + .fn() + .mockReturnValue("json"), + }; - mockResponse = { - status: jest.fn().mockReturnThis(), - json: jest.fn().mockReturnThis(), - setHeader: jest.fn().mockReturnThis() - }; + mockResponse = { + status: jest.fn().mockReturnThis(), + json: jest.fn().mockReturnThis(), + setHeader: jest.fn().mockReturnThis(), + }; - nextFunction = jest.fn(); + nextFunction = jest.fn(); + }); + + describe("validateRequest", () => { + it("should pass valid requests", () => { + mockRequest.headers.authorization = "Bearer valid-token"; + validateRequest( + mockRequest as unknown as Request, + mockResponse as unknown as Response, + nextFunction, + ); + expect(nextFunction).toHaveBeenCalled(); }); - describe('validateRequest', () => { - it('should pass valid requests', () => { - mockRequest.headers.authorization = 'Bearer valid-token'; - validateRequest(mockRequest as unknown as Request, mockResponse as unknown as Response, nextFunction); - expect(nextFunction).toHaveBeenCalled(); - }); - - it('should reject requests without authorization header', () => { - validateRequest(mockRequest as unknown as Request, mockResponse as unknown as Response, nextFunction); - expect(mockResponse.status).toHaveBeenCalledWith(401); - expect(mockResponse.json).toHaveBeenCalledWith(expect.objectContaining({ - error: expect.stringContaining('authorization') - })); - }); - - it('should reject requests with invalid authorization format', () => { - mockRequest.headers.authorization = 'invalid-format'; - validateRequest(mockRequest as unknown as Request, mockResponse as unknown as Response, nextFunction); - expect(mockResponse.status).toHaveBeenCalledWith(401); - expect(mockResponse.json).toHaveBeenCalledWith(expect.objectContaining({ - error: expect.stringContaining('Bearer') - })); - }); + it("should reject requests without authorization header", () => { + validateRequest( + mockRequest as unknown as Request, + mockResponse as unknown as Response, + nextFunction, + ); + expect(mockResponse.status).toHaveBeenCalledWith(401); + expect(mockResponse.json).toHaveBeenCalledWith( + expect.objectContaining({ + error: expect.stringContaining("authorization"), + }), + ); }); - describe('sanitizeInput', () => { - it('should pass requests without body', () => { - delete mockRequest.body; - sanitizeInput(mockRequest as unknown as Request, mockResponse as unknown as Response, nextFunction); - expect(nextFunction).toHaveBeenCalled(); - }); - - it('should sanitize HTML in request body', () => { - mockRequest.body = { - text: 'Hello', - nested: { - html: 'World' - } - }; - sanitizeInput(mockRequest as unknown as Request, mockResponse as unknown as Response, nextFunction); - expect(mockRequest.body.text).toBe('Hello'); - expect(mockRequest.body.nested.html).toBe('World'); - expect(nextFunction).toHaveBeenCalled(); - }); - - it('should handle non-object bodies', () => { - mockRequest.body = '

text

'; - sanitizeInput(mockRequest as unknown as Request, mockResponse as unknown as Response, nextFunction); - expect(mockRequest.body).toBe('text'); - expect(nextFunction).toHaveBeenCalled(); - }); - - it('should preserve non-string values', () => { - mockRequest.body = { - number: 42, - boolean: true, - null: null, - array: [1, 2, 3] - }; - sanitizeInput(mockRequest as unknown as Request, mockResponse as unknown as Response, nextFunction); - expect(mockRequest.body).toEqual({ - number: 42, - boolean: true, - null: null, - array: [1, 2, 3] - }); - expect(nextFunction).toHaveBeenCalled(); - }); + it("should reject requests with invalid authorization format", () => { + mockRequest.headers.authorization = "invalid-format"; + validateRequest( + mockRequest as unknown as Request, + mockResponse as unknown as Response, + nextFunction, + ); + expect(mockResponse.status).toHaveBeenCalledWith(401); + expect(mockResponse.json).toHaveBeenCalledWith( + expect.objectContaining({ + error: expect.stringContaining("Bearer"), + }), + ); }); -}); \ No newline at end of file + }); + + describe("sanitizeInput", () => { + it("should pass requests without body", () => { + delete mockRequest.body; + sanitizeInput( + mockRequest as unknown as Request, + mockResponse as unknown as Response, + nextFunction, + ); + expect(nextFunction).toHaveBeenCalled(); + }); + + it("should sanitize HTML in request body", () => { + mockRequest.body = { + text: 'Hello', + nested: { + html: 'World', + }, + }; + sanitizeInput( + mockRequest as unknown as Request, + mockResponse as unknown as Response, + nextFunction, + ); + expect(mockRequest.body.text).toBe("Hello"); + expect(mockRequest.body.nested.html).toBe("World"); + expect(nextFunction).toHaveBeenCalled(); + }); + + it("should handle non-object bodies", () => { + mockRequest.body = "

text

"; + sanitizeInput( + mockRequest as unknown as Request, + mockResponse as unknown as Response, + nextFunction, + ); + expect(mockRequest.body).toBe("text"); + expect(nextFunction).toHaveBeenCalled(); + }); + + it("should preserve non-string values", () => { + mockRequest.body = { + number: 42, + boolean: true, + null: null, + array: [1, 2, 3], + }; + sanitizeInput( + mockRequest as unknown as Request, + mockResponse as unknown as Response, + nextFunction, + ); + expect(mockRequest.body).toEqual({ + number: 42, + boolean: true, + null: null, + array: [1, 2, 3], + }); + expect(nextFunction).toHaveBeenCalled(); + }); + }); +}); diff --git a/src/sse/__tests__/sse.security.test.ts b/src/sse/__tests__/sse.security.test.ts index 9ec73f9..909fa40 100644 --- a/src/sse/__tests__/sse.security.test.ts +++ b/src/sse/__tests__/sse.security.test.ts @@ -1,200 +1,230 @@ -import { SSEManager } from '../index'; -import { TokenManager } from '../../security/index'; -import type { SSEClient } from '../types'; -import { describe, it, expect, beforeEach, afterEach, mock, Mock } from 'bun:test'; +import { SSEManager } from "../index"; +import { TokenManager } from "../../security/index"; +import type { SSEClient } from "../types"; +import { + describe, + it, + expect, + beforeEach, + afterEach, + mock, + Mock, +} from "bun:test"; -describe('SSE Security Features', () => { - const TEST_IP = '127.0.0.1'; - const validToken = 'valid_token'; - let sseManager: SSEManager; - let validateTokenMock: Mock<(token: string, ip: string) => { valid: boolean; error?: string }>; +describe("SSE Security Features", () => { + const TEST_IP = "127.0.0.1"; + const validToken = "valid_token"; + let sseManager: SSEManager; + let validateTokenMock: Mock< + (token: string, ip: string) => { valid: boolean; error?: string } + >; - beforeEach(() => { - sseManager = new SSEManager({ - maxClients: 2, - rateLimit: { - MAX_MESSAGES: 2, - WINDOW_MS: 1000, - BURST_LIMIT: 1 - } - }); - - validateTokenMock = mock((token: string) => ({ - valid: token === validToken, - error: token !== validToken ? 'Invalid token' : undefined - })); - TokenManager.validateToken = validateTokenMock; + beforeEach(() => { + sseManager = new SSEManager({ + maxClients: 2, + rateLimit: { + MAX_MESSAGES: 2, + WINDOW_MS: 1000, + BURST_LIMIT: 1, + }, }); - afterEach(() => { - validateTokenMock.mockReset(); + validateTokenMock = mock((token: string) => ({ + valid: token === validToken, + error: token !== validToken ? "Invalid token" : undefined, + })); + TokenManager.validateToken = validateTokenMock; + }); + + afterEach(() => { + validateTokenMock.mockReset(); + }); + + function createTestClient( + id: string, + ): Omit { + return { + id, + ip: TEST_IP, + connectedAt: new Date(), + connectionTime: Date.now(), + send: mock((data: string) => {}), + }; + } + + describe("Client Authentication", () => { + it("should authenticate valid clients", () => { + const client = createTestClient("test-client-1"); + const result = sseManager.addClient(client, validToken); + + expect(result).toBeTruthy(); + expect(validateTokenMock).toHaveBeenCalledWith(validToken, TEST_IP); + expect(result?.authenticated).toBe(true); }); - function createTestClient(id: string): Omit { - return { - id, - ip: TEST_IP, - connectedAt: new Date(), - connectionTime: Date.now(), - send: mock((data: string) => { }) - }; - } + it("should reject invalid tokens", () => { + const client = createTestClient("test-client-2"); + const result = sseManager.addClient(client, "invalid_token"); - describe('Client Authentication', () => { - it('should authenticate valid clients', () => { - const client = createTestClient('test-client-1'); - const result = sseManager.addClient(client, validToken); - - expect(result).toBeTruthy(); - expect(validateTokenMock).toHaveBeenCalledWith(validToken, TEST_IP); - expect(result?.authenticated).toBe(true); - }); - - it('should reject invalid tokens', () => { - const client = createTestClient('test-client-2'); - const result = sseManager.addClient(client, 'invalid_token'); - - expect(result).toBeNull(); - expect(validateTokenMock).toHaveBeenCalledWith('invalid_token', TEST_IP); - }); - - it('should enforce maximum client limit', () => { - // Add max number of clients - const client1 = createTestClient('test-client-0'); - const client2 = createTestClient('test-client-1'); - const client3 = createTestClient('test-client-2'); - - expect(sseManager.addClient(client1, validToken)).toBeTruthy(); - expect(sseManager.addClient(client2, validToken)).toBeTruthy(); - expect(sseManager.addClient(client3, validToken)).toBeNull(); - }); + expect(result).toBeNull(); + expect(validateTokenMock).toHaveBeenCalledWith("invalid_token", TEST_IP); }); - describe('Client Management', () => { - it('should track client connections', () => { - const client = createTestClient('test-client'); - sseManager.addClient(client, validToken); + it("should enforce maximum client limit", () => { + // Add max number of clients + const client1 = createTestClient("test-client-0"); + const client2 = createTestClient("test-client-1"); + const client3 = createTestClient("test-client-2"); - const stats = sseManager.getStatistics(); - expect(stats.totalClients).toBe(1); - expect(stats.authenticatedClients).toBe(1); - }); + expect(sseManager.addClient(client1, validToken)).toBeTruthy(); + expect(sseManager.addClient(client2, validToken)).toBeTruthy(); + expect(sseManager.addClient(client3, validToken)).toBeNull(); + }); + }); - it('should remove disconnected clients', () => { - const client = createTestClient('test-client'); - sseManager.addClient(client, validToken); - sseManager.removeClient('test-client'); + describe("Client Management", () => { + it("should track client connections", () => { + const client = createTestClient("test-client"); + sseManager.addClient(client, validToken); - const stats = sseManager.getStatistics(); - expect(stats.totalClients).toBe(0); - }); - - it('should cleanup inactive clients', async () => { - const client = createTestClient('test-client'); - sseManager.addClient(client, validToken); - - // Wait for cleanup interval - await new Promise(resolve => setTimeout(resolve, 250)); - - const stats = sseManager.getStatistics(); - expect(stats.totalClients).toBe(0); - }); + const stats = sseManager.getStatistics(); + expect(stats.totalClients).toBe(1); + expect(stats.authenticatedClients).toBe(1); }); - describe('Rate Limiting', () => { - it('should enforce rate limits for message sending', () => { - const client = createTestClient('test-client'); - const sseClient = sseManager.addClient(client, validToken); - expect(sseClient).toBeTruthy(); + it("should remove disconnected clients", () => { + const client = createTestClient("test-client"); + sseManager.addClient(client, validToken); + sseManager.removeClient("test-client"); - // Send messages up to the limit - sseManager['sendToClient'](sseClient!, { type: 'test', data: { value: 'first' } }); - sseManager['sendToClient'](sseClient!, { type: 'test', data: { value: 'second' } }); - - // Next message should be rate limited - sseManager['sendToClient'](sseClient!, { type: 'test', data: { value: 'overflow' } }); - - const sendMock = client.send as Mock<(data: string) => void>; - expect(sendMock.mock.calls.length).toBe(2); - }); - - it('should reset rate limits after window expires', async () => { - const client = createTestClient('test-client'); - const sseClient = sseManager.addClient(client, validToken); - expect(sseClient).toBeTruthy(); - - // Send messages up to the limit - sseManager['sendToClient'](sseClient!, { type: 'test', data: { value: 'first' } }); - sseManager['sendToClient'](sseClient!, { type: 'test', data: { value: 'second' } }); - - // Wait for rate limit window to expire - await new Promise(resolve => setTimeout(resolve, 1100)); - - // Should be able to send messages again - sseManager['sendToClient'](sseClient!, { type: 'test', data: { value: 'new message' } }); - - const sendMock = client.send as Mock<(data: string) => void>; - expect(sendMock.mock.calls.length).toBe(3); - }); + const stats = sseManager.getStatistics(); + expect(stats.totalClients).toBe(0); }); - describe('Event Broadcasting', () => { - it('should only send events to authenticated clients', () => { - const client1 = createTestClient('client1'); - const client2 = createTestClient('client2'); + it("should cleanup inactive clients", async () => { + const client = createTestClient("test-client"); + sseManager.addClient(client, validToken); - const sseClient1 = sseManager.addClient(client1, validToken); - const sseClient2 = sseManager.addClient(client2, 'invalid_token'); + // Wait for cleanup interval + await new Promise((resolve) => setTimeout(resolve, 250)); - expect(sseClient1).toBeTruthy(); - expect(sseClient2).toBeNull(); - - sseClient1!.subscriptions.add('event:test_event'); - - const event = { - event_type: 'test_event', - data: { value: 'test' }, - origin: 'test', - time_fired: new Date().toISOString(), - context: { id: 'test' } - }; - - sseManager.broadcastEvent(event); - - const client1SendMock = client1.send as Mock<(data: string) => void>; - const client2SendMock = client2.send as Mock<(data: string) => void>; - - expect(client1SendMock.mock.calls.length).toBe(1); - expect(client2SendMock.mock.calls.length).toBe(0); - }); - - it('should respect subscription filters', () => { - const client = createTestClient('test-client'); - const sseClient = sseManager.addClient(client, validToken); - expect(sseClient).toBeTruthy(); - - sseClient!.subscriptions.add('event:test_event'); - - // Send matching event - sseManager.broadcastEvent({ - event_type: 'test_event', - data: { value: 'test' }, - origin: 'test', - time_fired: new Date().toISOString(), - context: { id: 'test' } - }); - - // Send non-matching event - sseManager.broadcastEvent({ - event_type: 'other_event', - data: { value: 'test' }, - origin: 'test', - time_fired: new Date().toISOString(), - context: { id: 'test' } - }); - - const sendMock = client.send as Mock<(data: string) => void>; - expect(sendMock.mock.calls.length).toBe(1); - }); + const stats = sseManager.getStatistics(); + expect(stats.totalClients).toBe(0); }); -}); \ No newline at end of file + }); + + describe("Rate Limiting", () => { + it("should enforce rate limits for message sending", () => { + const client = createTestClient("test-client"); + const sseClient = sseManager.addClient(client, validToken); + expect(sseClient).toBeTruthy(); + + // Send messages up to the limit + sseManager["sendToClient"](sseClient!, { + type: "test", + data: { value: "first" }, + }); + sseManager["sendToClient"](sseClient!, { + type: "test", + data: { value: "second" }, + }); + + // Next message should be rate limited + sseManager["sendToClient"](sseClient!, { + type: "test", + data: { value: "overflow" }, + }); + + const sendMock = client.send as Mock<(data: string) => void>; + expect(sendMock.mock.calls.length).toBe(2); + }); + + it("should reset rate limits after window expires", async () => { + const client = createTestClient("test-client"); + const sseClient = sseManager.addClient(client, validToken); + expect(sseClient).toBeTruthy(); + + // Send messages up to the limit + sseManager["sendToClient"](sseClient!, { + type: "test", + data: { value: "first" }, + }); + sseManager["sendToClient"](sseClient!, { + type: "test", + data: { value: "second" }, + }); + + // Wait for rate limit window to expire + await new Promise((resolve) => setTimeout(resolve, 1100)); + + // Should be able to send messages again + sseManager["sendToClient"](sseClient!, { + type: "test", + data: { value: "new message" }, + }); + + const sendMock = client.send as Mock<(data: string) => void>; + expect(sendMock.mock.calls.length).toBe(3); + }); + }); + + describe("Event Broadcasting", () => { + it("should only send events to authenticated clients", () => { + const client1 = createTestClient("client1"); + const client2 = createTestClient("client2"); + + const sseClient1 = sseManager.addClient(client1, validToken); + const sseClient2 = sseManager.addClient(client2, "invalid_token"); + + expect(sseClient1).toBeTruthy(); + expect(sseClient2).toBeNull(); + + sseClient1!.subscriptions.add("event:test_event"); + + const event = { + event_type: "test_event", + data: { value: "test" }, + origin: "test", + time_fired: new Date().toISOString(), + context: { id: "test" }, + }; + + sseManager.broadcastEvent(event); + + const client1SendMock = client1.send as Mock<(data: string) => void>; + const client2SendMock = client2.send as Mock<(data: string) => void>; + + expect(client1SendMock.mock.calls.length).toBe(1); + expect(client2SendMock.mock.calls.length).toBe(0); + }); + + it("should respect subscription filters", () => { + const client = createTestClient("test-client"); + const sseClient = sseManager.addClient(client, validToken); + expect(sseClient).toBeTruthy(); + + sseClient!.subscriptions.add("event:test_event"); + + // Send matching event + sseManager.broadcastEvent({ + event_type: "test_event", + data: { value: "test" }, + origin: "test", + time_fired: new Date().toISOString(), + context: { id: "test" }, + }); + + // Send non-matching event + sseManager.broadcastEvent({ + event_type: "other_event", + data: { value: "test" }, + origin: "test", + time_fired: new Date().toISOString(), + context: { id: "test" }, + }); + + const sendMock = client.send as Mock<(data: string) => void>; + expect(sendMock.mock.calls.length).toBe(1); + }); + }); +}); diff --git a/src/sse/index.ts b/src/sse/index.ts index 7578c90..2dabe0c 100644 --- a/src/sse/index.ts +++ b/src/sse/index.ts @@ -1,6 +1,6 @@ -import { EventEmitter } from 'events'; -import { HassEntity, HassEvent } from '../interfaces/hass.js'; -import { TokenManager } from '../security/index.js'; +import { EventEmitter } from "events"; +import { HassEntity, HassEvent } from "../interfaces/hass.js"; +import { TokenManager } from "../security/index.js"; // Constants const DEFAULT_MAX_CLIENTS = 1000; @@ -8,357 +8,380 @@ const DEFAULT_PING_INTERVAL = 30000; // 30 seconds const DEFAULT_CLEANUP_INTERVAL = 60000; // 1 minute const DEFAULT_MAX_CONNECTION_AGE = 24 * 60 * 60 * 1000; // 24 hours const DEFAULT_RATE_LIMIT = { - MAX_MESSAGES: 100, // messages - WINDOW_MS: 60000, // 1 minute - BURST_LIMIT: 10 // max messages per second + MAX_MESSAGES: 100, // messages + WINDOW_MS: 60000, // 1 minute + BURST_LIMIT: 10, // max messages per second }; interface RateLimit { - count: number; - lastReset: number; - burstCount: number; - lastBurstReset: number; + count: number; + lastReset: number; + burstCount: number; + lastBurstReset: number; } export interface SSEClient { - id: string; - ip: string; - connectedAt: Date; - lastPingAt?: Date; - subscriptions: Set; - authenticated: boolean; - send: (data: string) => void; - rateLimit: RateLimit; - connectionTime: number; + id: string; + ip: string; + connectedAt: Date; + lastPingAt?: Date; + subscriptions: Set; + authenticated: boolean; + send: (data: string) => void; + rateLimit: RateLimit; + connectionTime: number; } interface ClientStats { - id: string; - ip: string; - connectedAt: Date; - lastPingAt?: Date; - subscriptionCount: number; - connectionDuration: number; - messagesSent: number; - lastActivity: Date; + id: string; + ip: string; + connectedAt: Date; + lastPingAt?: Date; + subscriptionCount: number; + connectionDuration: number; + messagesSent: number; + lastActivity: Date; } export class SSEManager extends EventEmitter { - private clients: Map = new Map(); - private static instance: SSEManager | null = null; - private entityStates: Map = new Map(); - private readonly maxClients: number; - private readonly pingInterval: number; - private readonly cleanupInterval: number; - private readonly maxConnectionAge: number; - private readonly rateLimit: typeof DEFAULT_RATE_LIMIT; + private clients: Map = new Map(); + private static instance: SSEManager | null = null; + private entityStates: Map = new Map(); + private readonly maxClients: number; + private readonly pingInterval: number; + private readonly cleanupInterval: number; + private readonly maxConnectionAge: number; + private readonly rateLimit: typeof DEFAULT_RATE_LIMIT; - constructor(options: { - maxClients?: number; - pingInterval?: number; - cleanupInterval?: number; - maxConnectionAge?: number; - rateLimit?: Partial; - } = {}) { - super(); - this.maxClients = options.maxClients || DEFAULT_MAX_CLIENTS; - this.pingInterval = options.pingInterval || DEFAULT_PING_INTERVAL; - this.cleanupInterval = options.cleanupInterval || DEFAULT_CLEANUP_INTERVAL; - this.maxConnectionAge = options.maxConnectionAge || DEFAULT_MAX_CONNECTION_AGE; - this.rateLimit = { ...DEFAULT_RATE_LIMIT, ...options.rateLimit }; + constructor( + options: { + maxClients?: number; + pingInterval?: number; + cleanupInterval?: number; + maxConnectionAge?: number; + rateLimit?: Partial; + } = {}, + ) { + super(); + this.maxClients = options.maxClients || DEFAULT_MAX_CLIENTS; + this.pingInterval = options.pingInterval || DEFAULT_PING_INTERVAL; + this.cleanupInterval = options.cleanupInterval || DEFAULT_CLEANUP_INTERVAL; + this.maxConnectionAge = + options.maxConnectionAge || DEFAULT_MAX_CONNECTION_AGE; + this.rateLimit = { ...DEFAULT_RATE_LIMIT, ...options.rateLimit }; - console.log('Initializing SSE Manager...'); - this.startMaintenanceTasks(); - } + console.log("Initializing SSE Manager..."); + this.startMaintenanceTasks(); + } - private startMaintenanceTasks(): void { - // Send periodic pings to keep connections alive - setInterval(() => { - this.clients.forEach(client => { - if (!this.isRateLimited(client)) { - try { - client.send(JSON.stringify({ - type: 'ping', - timestamp: new Date().toISOString() - })); - client.lastPingAt = new Date(); - } catch (error) { - console.error(`Failed to ping client ${client.id}:`, error); - this.removeClient(client.id); - } - } - }); - }, this.pingInterval); - - // Cleanup inactive or expired connections - setInterval(() => { - const now = Date.now(); - this.clients.forEach((client, clientId) => { - const connectionAge = now - client.connectedAt.getTime(); - const lastPingAge = client.lastPingAt ? now - client.lastPingAt.getTime() : 0; - - if (connectionAge > this.maxConnectionAge || lastPingAge > this.pingInterval * 2) { - console.log(`Removing inactive client ${clientId}`); - this.removeClient(clientId); - } - }); - }, this.cleanupInterval); - } - - static getInstance(): SSEManager { - if (!SSEManager.instance) { - SSEManager.instance = new SSEManager(); - } - return SSEManager.instance; - } - - addClient(client: Omit, token: string): SSEClient | null { - // Validate token - const validationResult = TokenManager.validateToken(token, client.ip); - if (!validationResult.valid) { - console.warn(`Invalid token for client ${client.id} from IP ${client.ip}: ${validationResult.error}`); - return null; - } - - // Check client limit - if (this.clients.size >= this.maxClients) { - console.warn(`Maximum client limit (${this.maxClients}) reached`); - return null; - } - - // Create new client with authentication and subscriptions - const newClient: SSEClient = { - ...client, - authenticated: true, - subscriptions: new Set(), - lastPingAt: new Date(), - rateLimit: { - count: 0, - lastReset: Date.now(), - burstCount: 0, - lastBurstReset: Date.now() - } - }; - - this.clients.set(client.id, newClient); - console.log(`New client ${client.id} connected from IP ${client.ip}`); - - return newClient; - } - - private isRateLimited(client: SSEClient): boolean { - const now = Date.now(); - - // Reset window counters if needed - if (now - client.rateLimit.lastReset >= this.rateLimit.WINDOW_MS) { - client.rateLimit.count = 0; - client.rateLimit.lastReset = now; - } - - // Reset burst counters if needed (every second) - if (now - client.rateLimit.lastBurstReset >= 1000) { - client.rateLimit.burstCount = 0; - client.rateLimit.lastBurstReset = now; - } - - // Check both window and burst limits - return ( - client.rateLimit.count >= this.rateLimit.MAX_MESSAGES || - client.rateLimit.burstCount >= this.rateLimit.BURST_LIMIT - ); - } - - private updateRateLimit(client: SSEClient): void { - const now = Date.now(); - client.rateLimit.count++; - client.rateLimit.burstCount++; - - // Update timestamps if needed - if (now - client.rateLimit.lastReset >= this.rateLimit.WINDOW_MS) { - client.rateLimit.lastReset = now; - client.rateLimit.count = 1; - } - - if (now - client.rateLimit.lastBurstReset >= 1000) { - client.rateLimit.lastBurstReset = now; - client.rateLimit.burstCount = 1; - } - } - - removeClient(clientId: string): void { - if (this.clients.has(clientId)) { - this.clients.delete(clientId); - console.log(`SSE client disconnected: ${clientId}`); - this.emit('client_disconnected', { - clientId, - timestamp: new Date().toISOString() - }); - } - } - - subscribeToEntity(clientId: string, entityId: string): void { - const client = this.clients.get(clientId); - if (!client?.authenticated) { - console.warn(`Unauthenticated client ${clientId} attempted to subscribe to entity: ${entityId}`); - return; - } - - client.subscriptions.add(`entity:${entityId}`); - console.log(`Client ${clientId} subscribed to entity: ${entityId}`); - - // Send current state if available - const currentState = this.entityStates.get(entityId); - if (currentState && !this.isRateLimited(client)) { - this.sendToClient(client, { - type: 'state_changed', - data: { - entity_id: currentState.entity_id, - state: currentState.state, - attributes: currentState.attributes, - last_changed: currentState.last_changed, - last_updated: currentState.last_updated - } - }); - } - } - - subscribeToDomain(clientId: string, domain: string): void { - const client = this.clients.get(clientId); - if (!client?.authenticated) { - console.warn(`Unauthenticated client ${clientId} attempted to subscribe to domain: ${domain}`); - return; - } - - client.subscriptions.add(`domain:${domain}`); - console.log(`Client ${clientId} subscribed to domain: ${domain}`); - } - - subscribeToEvent(clientId: string, eventType: string): void { - const client = this.clients.get(clientId); - if (!client?.authenticated) { - console.warn(`Unauthenticated client ${clientId} attempted to subscribe to event: ${eventType}`); - return; - } - - client.subscriptions.add(`event:${eventType}`); - console.log(`Client ${clientId} subscribed to event: ${eventType}`); - } - - broadcastStateChange(entity: HassEntity): void { - // Update stored state - this.entityStates.set(entity.entity_id, entity); - - const domain = entity.entity_id.split('.')[0]; - const message = { - type: 'state_changed', - data: { - entity_id: entity.entity_id, - state: entity.state, - attributes: entity.attributes, - last_changed: entity.last_changed, - last_updated: entity.last_updated - }, - timestamp: new Date().toISOString() - }; - - console.log(`Broadcasting state change for ${entity.entity_id}`); - - // Send to relevant subscribers only - this.clients.forEach(client => { - if (!client.authenticated || this.isRateLimited(client)) return; - - if ( - client.subscriptions.has(`entity:${entity.entity_id}`) || - client.subscriptions.has(`domain:${domain}`) || - client.subscriptions.has('event:state_changed') - ) { - this.sendToClient(client, message); - } - }); - } - - broadcastEvent(event: HassEvent): void { - const message = { - type: event.event_type, - data: event.data, - origin: event.origin, - time_fired: event.time_fired, - context: event.context, - timestamp: new Date().toISOString() - }; - - console.log(`Broadcasting event: ${event.event_type}`); - - // Send to relevant subscribers only - this.clients.forEach(client => { - if (!client.authenticated || this.isRateLimited(client)) return; - - if (client.subscriptions.has(`event:${event.event_type}`)) { - this.sendToClient(client, message); - } - }); - } - - private sendToClient(client: SSEClient, data: unknown): void { - try { - if (!client.authenticated) { - console.warn(`Attempted to send message to unauthenticated client ${client.id}`); - return; - } - - if (this.isRateLimited(client)) { - console.warn(`Rate limit exceeded for client ${client.id}`); - return; - } - - const message = typeof data === 'string' ? data : JSON.stringify(data); - client.send(message); - this.updateRateLimit(client); - } catch (error) { - console.error(`Failed to send message to client ${client.id}:`, error); + private startMaintenanceTasks(): void { + // Send periodic pings to keep connections alive + setInterval(() => { + this.clients.forEach((client) => { + if (!this.isRateLimited(client)) { + try { + client.send( + JSON.stringify({ + type: "ping", + timestamp: new Date().toISOString(), + }), + ); + client.lastPingAt = new Date(); + } catch (error) { + console.error(`Failed to ping client ${client.id}:`, error); this.removeClient(client.id); + } } + }); + }, this.pingInterval); + + // Cleanup inactive or expired connections + setInterval(() => { + const now = Date.now(); + this.clients.forEach((client, clientId) => { + const connectionAge = now - client.connectedAt.getTime(); + const lastPingAge = client.lastPingAt + ? now - client.lastPingAt.getTime() + : 0; + + if ( + connectionAge > this.maxConnectionAge || + lastPingAge > this.pingInterval * 2 + ) { + console.log(`Removing inactive client ${clientId}`); + this.removeClient(clientId); + } + }); + }, this.cleanupInterval); + } + + static getInstance(): SSEManager { + if (!SSEManager.instance) { + SSEManager.instance = new SSEManager(); + } + return SSEManager.instance; + } + + addClient( + client: Omit, + token: string, + ): SSEClient | null { + // Validate token + const validationResult = TokenManager.validateToken(token, client.ip); + if (!validationResult.valid) { + console.warn( + `Invalid token for client ${client.id} from IP ${client.ip}: ${validationResult.error}`, + ); + return null; } - getStatistics(): { - totalClients: number; - authenticatedClients: number; - clientStats: ClientStats[]; - subscriptionStats: { [key: string]: number }; - } { - const now = Date.now(); - const clientStats: ClientStats[] = []; - const subscriptionStats: { [key: string]: number } = {}; - let authenticatedClients = 0; - - this.clients.forEach(client => { - if (client.authenticated) { - authenticatedClients++; - } - - clientStats.push({ - id: client.id, - ip: client.ip, - connectedAt: client.connectedAt, - lastPingAt: client.lastPingAt, - subscriptionCount: client.subscriptions.size, - connectionDuration: now - client.connectedAt.getTime(), - messagesSent: client.rateLimit.count, - lastActivity: new Date(client.rateLimit.lastReset) - }); - - client.subscriptions.forEach(sub => { - subscriptionStats[sub] = (subscriptionStats[sub] || 0) + 1; - }); - }); - - return { - totalClients: this.clients.size, - authenticatedClients, - clientStats, - subscriptionStats - }; + // Check client limit + if (this.clients.size >= this.maxClients) { + console.warn(`Maximum client limit (${this.maxClients}) reached`); + return null; } + + // Create new client with authentication and subscriptions + const newClient: SSEClient = { + ...client, + authenticated: true, + subscriptions: new Set(), + lastPingAt: new Date(), + rateLimit: { + count: 0, + lastReset: Date.now(), + burstCount: 0, + lastBurstReset: Date.now(), + }, + }; + + this.clients.set(client.id, newClient); + console.log(`New client ${client.id} connected from IP ${client.ip}`); + + return newClient; + } + + private isRateLimited(client: SSEClient): boolean { + const now = Date.now(); + + // Reset window counters if needed + if (now - client.rateLimit.lastReset >= this.rateLimit.WINDOW_MS) { + client.rateLimit.count = 0; + client.rateLimit.lastReset = now; + } + + // Reset burst counters if needed (every second) + if (now - client.rateLimit.lastBurstReset >= 1000) { + client.rateLimit.burstCount = 0; + client.rateLimit.lastBurstReset = now; + } + + // Check both window and burst limits + return ( + client.rateLimit.count >= this.rateLimit.MAX_MESSAGES || + client.rateLimit.burstCount >= this.rateLimit.BURST_LIMIT + ); + } + + private updateRateLimit(client: SSEClient): void { + const now = Date.now(); + client.rateLimit.count++; + client.rateLimit.burstCount++; + + // Update timestamps if needed + if (now - client.rateLimit.lastReset >= this.rateLimit.WINDOW_MS) { + client.rateLimit.lastReset = now; + client.rateLimit.count = 1; + } + + if (now - client.rateLimit.lastBurstReset >= 1000) { + client.rateLimit.lastBurstReset = now; + client.rateLimit.burstCount = 1; + } + } + + removeClient(clientId: string): void { + if (this.clients.has(clientId)) { + this.clients.delete(clientId); + console.log(`SSE client disconnected: ${clientId}`); + this.emit("client_disconnected", { + clientId, + timestamp: new Date().toISOString(), + }); + } + } + + subscribeToEntity(clientId: string, entityId: string): void { + const client = this.clients.get(clientId); + if (!client?.authenticated) { + console.warn( + `Unauthenticated client ${clientId} attempted to subscribe to entity: ${entityId}`, + ); + return; + } + + client.subscriptions.add(`entity:${entityId}`); + console.log(`Client ${clientId} subscribed to entity: ${entityId}`); + + // Send current state if available + const currentState = this.entityStates.get(entityId); + if (currentState && !this.isRateLimited(client)) { + this.sendToClient(client, { + type: "state_changed", + data: { + entity_id: currentState.entity_id, + state: currentState.state, + attributes: currentState.attributes, + last_changed: currentState.last_changed, + last_updated: currentState.last_updated, + }, + }); + } + } + + subscribeToDomain(clientId: string, domain: string): void { + const client = this.clients.get(clientId); + if (!client?.authenticated) { + console.warn( + `Unauthenticated client ${clientId} attempted to subscribe to domain: ${domain}`, + ); + return; + } + + client.subscriptions.add(`domain:${domain}`); + console.log(`Client ${clientId} subscribed to domain: ${domain}`); + } + + subscribeToEvent(clientId: string, eventType: string): void { + const client = this.clients.get(clientId); + if (!client?.authenticated) { + console.warn( + `Unauthenticated client ${clientId} attempted to subscribe to event: ${eventType}`, + ); + return; + } + + client.subscriptions.add(`event:${eventType}`); + console.log(`Client ${clientId} subscribed to event: ${eventType}`); + } + + broadcastStateChange(entity: HassEntity): void { + // Update stored state + this.entityStates.set(entity.entity_id, entity); + + const domain = entity.entity_id.split(".")[0]; + const message = { + type: "state_changed", + data: { + entity_id: entity.entity_id, + state: entity.state, + attributes: entity.attributes, + last_changed: entity.last_changed, + last_updated: entity.last_updated, + }, + timestamp: new Date().toISOString(), + }; + + console.log(`Broadcasting state change for ${entity.entity_id}`); + + // Send to relevant subscribers only + this.clients.forEach((client) => { + if (!client.authenticated || this.isRateLimited(client)) return; + + if ( + client.subscriptions.has(`entity:${entity.entity_id}`) || + client.subscriptions.has(`domain:${domain}`) || + client.subscriptions.has("event:state_changed") + ) { + this.sendToClient(client, message); + } + }); + } + + broadcastEvent(event: HassEvent): void { + const message = { + type: event.event_type, + data: event.data, + origin: event.origin, + time_fired: event.time_fired, + context: event.context, + timestamp: new Date().toISOString(), + }; + + console.log(`Broadcasting event: ${event.event_type}`); + + // Send to relevant subscribers only + this.clients.forEach((client) => { + if (!client.authenticated || this.isRateLimited(client)) return; + + if (client.subscriptions.has(`event:${event.event_type}`)) { + this.sendToClient(client, message); + } + }); + } + + private sendToClient(client: SSEClient, data: unknown): void { + try { + if (!client.authenticated) { + console.warn( + `Attempted to send message to unauthenticated client ${client.id}`, + ); + return; + } + + if (this.isRateLimited(client)) { + console.warn(`Rate limit exceeded for client ${client.id}`); + return; + } + + const message = typeof data === "string" ? data : JSON.stringify(data); + client.send(message); + this.updateRateLimit(client); + } catch (error) { + console.error(`Failed to send message to client ${client.id}:`, error); + this.removeClient(client.id); + } + } + + getStatistics(): { + totalClients: number; + authenticatedClients: number; + clientStats: ClientStats[]; + subscriptionStats: { [key: string]: number }; + } { + const now = Date.now(); + const clientStats: ClientStats[] = []; + const subscriptionStats: { [key: string]: number } = {}; + let authenticatedClients = 0; + + this.clients.forEach((client) => { + if (client.authenticated) { + authenticatedClients++; + } + + clientStats.push({ + id: client.id, + ip: client.ip, + connectedAt: client.connectedAt, + lastPingAt: client.lastPingAt, + subscriptionCount: client.subscriptions.size, + connectionDuration: now - client.connectedAt.getTime(), + messagesSent: client.rateLimit.count, + lastActivity: new Date(client.rateLimit.lastReset), + }); + + client.subscriptions.forEach((sub) => { + subscriptionStats[sub] = (subscriptionStats[sub] || 0) + 1; + }); + }); + + return { + totalClients: this.clients.size, + authenticatedClients, + clientStats, + subscriptionStats, + }; + } } -export const sseManager = SSEManager.getInstance(); \ No newline at end of file +export const sseManager = SSEManager.getInstance(); diff --git a/src/sse/types.ts b/src/sse/types.ts index e15732b..ac87998 100644 --- a/src/sse/types.ts +++ b/src/sse/types.ts @@ -1,62 +1,67 @@ -import type { Mock } from 'bun:test'; +import type { Mock } from "bun:test"; export interface SSEClient { - id: string; - ip: string; - connectedAt: Date; - send: Mock<(data: string) => void>; - rateLimit: { - count: number; - lastReset: number; - }; - connectionTime: number; + id: string; + ip: string; + connectedAt: Date; + send: Mock<(data: string) => void>; + rateLimit: { + count: number; + lastReset: number; + }; + connectionTime: number; } export interface HassEventData { - [key: string]: unknown; + [key: string]: unknown; } export interface SSEEvent { - event_type: string; - data: HassEventData; - origin: string; - time_fired: string; - context: { - id: string; - [key: string]: unknown; - }; + event_type: string; + data: HassEventData; + origin: string; + time_fired: string; + context: { + id: string; + [key: string]: unknown; + }; } export interface SSEMessage { - type: string; - data?: unknown; - error?: string; + type: string; + data?: unknown; + error?: string; } export interface SSEManagerConfig { - maxClients?: number; - pingInterval?: number; - cleanupInterval?: number; - maxConnectionAge?: number; - rateLimitWindow?: number; - maxRequestsPerWindow?: number; + maxClients?: number; + pingInterval?: number; + cleanupInterval?: number; + maxConnectionAge?: number; + rateLimitWindow?: number; + maxRequestsPerWindow?: number; } export type MockSendFn = (data: string) => void; export type MockSend = Mock; -export type ValidateTokenFn = (token: string, ip?: string) => { valid: boolean; error?: string }; +export type ValidateTokenFn = ( + token: string, + ip?: string, +) => { valid: boolean; error?: string }; export type MockValidateToken = Mock; // Type guard for mock functions export function isMockFunction(value: unknown): value is Mock { - return typeof value === 'function' && 'mock' in value; + return typeof value === "function" && "mock" in value; } // Safe type assertion for mock objects -export function asMockFunction any>(value: unknown): Mock { - if (!isMockFunction(value)) { - throw new Error('Value is not a mock function'); - } - return value as Mock; -} \ No newline at end of file +export function asMockFunction any>( + value: unknown, +): Mock { + if (!isMockFunction(value)) { + throw new Error("Value is not a mock function"); + } + return value as Mock; +} diff --git a/src/tools/addon.tool.ts b/src/tools/addon.tool.ts index 8e6c5fd..cdf87e4 100644 --- a/src/tools/addon.tool.ts +++ b/src/tools/addon.tool.ts @@ -1,106 +1,132 @@ -import { z } from 'zod'; -import { Tool, AddonParams, HassAddonResponse, HassAddonInfoResponse } from '../types/index.js'; -import { APP_CONFIG } from '../config/app.config.js'; +import { z } from "zod"; +import { + Tool, + AddonParams, + HassAddonResponse, + HassAddonInfoResponse, +} from "../types/index.js"; +import { APP_CONFIG } from "../config/app.config.js"; export const addonTool: Tool = { - name: 'addon', - description: 'Manage Home Assistant add-ons', - parameters: z.object({ - action: z.enum(['list', 'info', 'install', 'uninstall', 'start', 'stop', 'restart']) - .describe('Action to perform with add-on'), - slug: z.string().optional().describe('Add-on slug (required for all actions except list)'), - version: z.string().optional().describe('Version to install (only for install action)'), - }), - execute: async (params: AddonParams) => { - try { - if (params.action === 'list') { - const response = await fetch(`${APP_CONFIG.HASS_HOST}/api/hassio/store`, { - headers: { - Authorization: `Bearer ${APP_CONFIG.HASS_TOKEN}`, - 'Content-Type': 'application/json', - }, - }); + name: "addon", + description: "Manage Home Assistant add-ons", + parameters: z.object({ + action: z + .enum([ + "list", + "info", + "install", + "uninstall", + "start", + "stop", + "restart", + ]) + .describe("Action to perform with add-on"), + slug: z + .string() + .optional() + .describe("Add-on slug (required for all actions except list)"), + version: z + .string() + .optional() + .describe("Version to install (only for install action)"), + }), + execute: async (params: AddonParams) => { + try { + if (params.action === "list") { + const response = await fetch( + `${APP_CONFIG.HASS_HOST}/api/hassio/store`, + { + headers: { + Authorization: `Bearer ${APP_CONFIG.HASS_TOKEN}`, + "Content-Type": "application/json", + }, + }, + ); - if (!response.ok) { - throw new Error(`Failed to fetch add-ons: ${response.statusText}`); - } - - const data = await response.json() as HassAddonResponse; - return { - success: true, - addons: data.data.addons.map((addon) => ({ - name: addon.name, - slug: addon.slug, - description: addon.description, - version: addon.version, - installed: addon.installed, - available: addon.available, - state: addon.state, - })), - }; - } else { - if (!params.slug) { - throw new Error('Add-on slug is required for this action'); - } - - let endpoint = ''; - let method = 'GET'; - const body: Record = {}; - - switch (params.action) { - case 'info': - endpoint = `/api/hassio/addons/${params.slug}/info`; - break; - case 'install': - endpoint = `/api/hassio/addons/${params.slug}/install`; - method = 'POST'; - if (params.version) { - body.version = params.version; - } - break; - case 'uninstall': - endpoint = `/api/hassio/addons/${params.slug}/uninstall`; - method = 'POST'; - break; - case 'start': - endpoint = `/api/hassio/addons/${params.slug}/start`; - method = 'POST'; - break; - case 'stop': - endpoint = `/api/hassio/addons/${params.slug}/stop`; - method = 'POST'; - break; - case 'restart': - endpoint = `/api/hassio/addons/${params.slug}/restart`; - method = 'POST'; - break; - } - - const response = await fetch(`${APP_CONFIG.HASS_HOST}${endpoint}`, { - method, - headers: { - Authorization: `Bearer ${APP_CONFIG.HASS_TOKEN}`, - 'Content-Type': 'application/json', - }, - ...(Object.keys(body).length > 0 && { body: JSON.stringify(body) }), - }); - - if (!response.ok) { - throw new Error(`Failed to ${params.action} add-on: ${response.statusText}`); - } - - const data = await response.json() as HassAddonInfoResponse; - return { - success: true, - message: `Successfully ${params.action}ed add-on ${params.slug}`, - data: data.data, - }; - } - } catch (error) { - return { - success: false, - message: error instanceof Error ? error.message : 'Unknown error occurred', - }; + if (!response.ok) { + throw new Error(`Failed to fetch add-ons: ${response.statusText}`); } - }, -}; \ No newline at end of file + + const data = (await response.json()) as HassAddonResponse; + return { + success: true, + addons: data.data.addons.map((addon) => ({ + name: addon.name, + slug: addon.slug, + description: addon.description, + version: addon.version, + installed: addon.installed, + available: addon.available, + state: addon.state, + })), + }; + } else { + if (!params.slug) { + throw new Error("Add-on slug is required for this action"); + } + + let endpoint = ""; + let method = "GET"; + const body: Record = {}; + + switch (params.action) { + case "info": + endpoint = `/api/hassio/addons/${params.slug}/info`; + break; + case "install": + endpoint = `/api/hassio/addons/${params.slug}/install`; + method = "POST"; + if (params.version) { + body.version = params.version; + } + break; + case "uninstall": + endpoint = `/api/hassio/addons/${params.slug}/uninstall`; + method = "POST"; + break; + case "start": + endpoint = `/api/hassio/addons/${params.slug}/start`; + method = "POST"; + break; + case "stop": + endpoint = `/api/hassio/addons/${params.slug}/stop`; + method = "POST"; + break; + case "restart": + endpoint = `/api/hassio/addons/${params.slug}/restart`; + method = "POST"; + break; + } + + const response = await fetch(`${APP_CONFIG.HASS_HOST}${endpoint}`, { + method, + headers: { + Authorization: `Bearer ${APP_CONFIG.HASS_TOKEN}`, + "Content-Type": "application/json", + }, + ...(Object.keys(body).length > 0 && { body: JSON.stringify(body) }), + }); + + if (!response.ok) { + throw new Error( + `Failed to ${params.action} add-on: ${response.statusText}`, + ); + } + + const data = (await response.json()) as HassAddonInfoResponse; + return { + success: true, + message: `Successfully ${params.action}ed add-on ${params.slug}`, + data: data.data, + }; + } + } catch (error) { + return { + success: false, + message: + error instanceof Error ? error.message : "Unknown error occurred", + }; + } + }, +}; diff --git a/src/tools/automation-config.tool.ts b/src/tools/automation-config.tool.ts index 6c9515b..3a12218 100644 --- a/src/tools/automation-config.tool.ts +++ b/src/tools/automation-config.tool.ts @@ -1,150 +1,205 @@ -import { z } from 'zod'; -import { Tool, AutomationConfigParams, AutomationConfig, AutomationResponse } from '../types/index.js'; -import { APP_CONFIG } from '../config/app.config.js'; +import { z } from "zod"; +import { + Tool, + AutomationConfigParams, + AutomationConfig, + AutomationResponse, +} from "../types/index.js"; +import { APP_CONFIG } from "../config/app.config.js"; export const automationConfigTool: Tool = { - name: 'automation_config', - description: 'Advanced automation configuration and management', - parameters: z.object({ - action: z.enum(['create', 'update', 'delete', 'duplicate']) - .describe('Action to perform with automation config'), - automation_id: z.string().optional() - .describe('Automation ID (required for update, delete, and duplicate)'), - config: z.object({ - alias: z.string().describe('Friendly name for the automation'), - description: z.string().optional().describe('Description of what the automation does'), - mode: z.enum(['single', 'parallel', 'queued', 'restart']).optional() - .describe('How multiple triggerings are handled'), - trigger: z.array(z.any()).describe('List of triggers'), - condition: z.array(z.any()).optional().describe('List of conditions'), - action: z.array(z.any()).describe('List of actions'), - }).optional().describe('Automation configuration (required for create and update)'), - }), - execute: async (params: AutomationConfigParams) => { - try { - switch (params.action) { - case 'create': { - if (!params.config) { - throw new Error('Configuration is required for creating automation'); - } + name: "automation_config", + description: "Advanced automation configuration and management", + parameters: z.object({ + action: z + .enum(["create", "update", "delete", "duplicate"]) + .describe("Action to perform with automation config"), + automation_id: z + .string() + .optional() + .describe("Automation ID (required for update, delete, and duplicate)"), + config: z + .object({ + alias: z.string().describe("Friendly name for the automation"), + description: z + .string() + .optional() + .describe("Description of what the automation does"), + mode: z + .enum(["single", "parallel", "queued", "restart"]) + .optional() + .describe("How multiple triggerings are handled"), + trigger: z.array(z.any()).describe("List of triggers"), + condition: z.array(z.any()).optional().describe("List of conditions"), + action: z.array(z.any()).describe("List of actions"), + }) + .optional() + .describe("Automation configuration (required for create and update)"), + }), + execute: async (params: AutomationConfigParams) => { + try { + switch (params.action) { + case "create": { + if (!params.config) { + throw new Error( + "Configuration is required for creating automation", + ); + } - const response = await fetch(`${APP_CONFIG.HASS_HOST}/api/config/automation/config`, { - method: 'POST', - headers: { - Authorization: `Bearer ${APP_CONFIG.HASS_TOKEN}`, - 'Content-Type': 'application/json', - }, - body: JSON.stringify(params.config), - }); + const response = await fetch( + `${APP_CONFIG.HASS_HOST}/api/config/automation/config`, + { + method: "POST", + headers: { + Authorization: `Bearer ${APP_CONFIG.HASS_TOKEN}`, + "Content-Type": "application/json", + }, + body: JSON.stringify(params.config), + }, + ); - if (!response.ok) { - throw new Error(`Failed to create automation: ${response.statusText}`); - } + if (!response.ok) { + throw new Error( + `Failed to create automation: ${response.statusText}`, + ); + } - const responseData = await response.json() as { automation_id: string }; - return { - success: true, - message: 'Successfully created automation', - automation_id: responseData.automation_id, - }; - } - - case 'update': { - if (!params.automation_id || !params.config) { - throw new Error('Automation ID and configuration are required for updating automation'); - } - - const response = await fetch(`${APP_CONFIG.HASS_HOST}/api/config/automation/config/${params.automation_id}`, { - method: 'PUT', - headers: { - Authorization: `Bearer ${APP_CONFIG.HASS_TOKEN}`, - 'Content-Type': 'application/json', - }, - body: JSON.stringify(params.config), - }); - - if (!response.ok) { - throw new Error(`Failed to update automation: ${response.statusText}`); - } - - const responseData = await response.json() as { automation_id: string }; - return { - success: true, - automation_id: responseData.automation_id, - message: 'Automation updated successfully' - }; - } - - case 'delete': { - if (!params.automation_id) { - throw new Error('Automation ID is required for deleting automation'); - } - - const response = await fetch(`${APP_CONFIG.HASS_HOST}/api/config/automation/config/${params.automation_id}`, { - method: 'DELETE', - headers: { - Authorization: `Bearer ${APP_CONFIG.HASS_TOKEN}`, - 'Content-Type': 'application/json', - }, - }); - - if (!response.ok) { - throw new Error(`Failed to delete automation: ${response.statusText}`); - } - - return { - success: true, - message: `Successfully deleted automation ${params.automation_id}`, - }; - } - - case 'duplicate': { - if (!params.automation_id) { - throw new Error('Automation ID is required for duplicating automation'); - } - - // First, get the existing automation config - const getResponse = await fetch(`${APP_CONFIG.HASS_HOST}/api/config/automation/config/${params.automation_id}`, { - headers: { - Authorization: `Bearer ${APP_CONFIG.HASS_TOKEN}`, - 'Content-Type': 'application/json', - }, - }); - - if (!getResponse.ok) { - throw new Error(`Failed to get automation config: ${getResponse.statusText}`); - } - - const config = await getResponse.json() as AutomationConfig; - config.alias = `${config.alias} (Copy)`; - - // Create new automation with modified config - const createResponse = await fetch(`${APP_CONFIG.HASS_HOST}/api/config/automation/config`, { - method: 'POST', - headers: { - Authorization: `Bearer ${APP_CONFIG.HASS_TOKEN}`, - 'Content-Type': 'application/json', - }, - body: JSON.stringify(config), - }); - - if (!createResponse.ok) { - throw new Error(`Failed to create duplicate automation: ${createResponse.statusText}`); - } - - const newAutomation = await createResponse.json() as AutomationResponse; - return { - success: true, - message: `Successfully duplicated automation ${params.automation_id}`, - new_automation_id: newAutomation.automation_id, - }; - } - } - } catch (error) { - return { - success: false, - message: error instanceof Error ? error.message : 'Unknown error occurred', - }; + const responseData = (await response.json()) as { + automation_id: string; + }; + return { + success: true, + message: "Successfully created automation", + automation_id: responseData.automation_id, + }; } - }, -}; \ No newline at end of file + + case "update": { + if (!params.automation_id || !params.config) { + throw new Error( + "Automation ID and configuration are required for updating automation", + ); + } + + const response = await fetch( + `${APP_CONFIG.HASS_HOST}/api/config/automation/config/${params.automation_id}`, + { + method: "PUT", + headers: { + Authorization: `Bearer ${APP_CONFIG.HASS_TOKEN}`, + "Content-Type": "application/json", + }, + body: JSON.stringify(params.config), + }, + ); + + if (!response.ok) { + throw new Error( + `Failed to update automation: ${response.statusText}`, + ); + } + + const responseData = (await response.json()) as { + automation_id: string; + }; + return { + success: true, + automation_id: responseData.automation_id, + message: "Automation updated successfully", + }; + } + + case "delete": { + if (!params.automation_id) { + throw new Error( + "Automation ID is required for deleting automation", + ); + } + + const response = await fetch( + `${APP_CONFIG.HASS_HOST}/api/config/automation/config/${params.automation_id}`, + { + method: "DELETE", + headers: { + Authorization: `Bearer ${APP_CONFIG.HASS_TOKEN}`, + "Content-Type": "application/json", + }, + }, + ); + + if (!response.ok) { + throw new Error( + `Failed to delete automation: ${response.statusText}`, + ); + } + + return { + success: true, + message: `Successfully deleted automation ${params.automation_id}`, + }; + } + + case "duplicate": { + if (!params.automation_id) { + throw new Error( + "Automation ID is required for duplicating automation", + ); + } + + // First, get the existing automation config + const getResponse = await fetch( + `${APP_CONFIG.HASS_HOST}/api/config/automation/config/${params.automation_id}`, + { + headers: { + Authorization: `Bearer ${APP_CONFIG.HASS_TOKEN}`, + "Content-Type": "application/json", + }, + }, + ); + + if (!getResponse.ok) { + throw new Error( + `Failed to get automation config: ${getResponse.statusText}`, + ); + } + + const config = (await getResponse.json()) as AutomationConfig; + config.alias = `${config.alias} (Copy)`; + + // Create new automation with modified config + const createResponse = await fetch( + `${APP_CONFIG.HASS_HOST}/api/config/automation/config`, + { + method: "POST", + headers: { + Authorization: `Bearer ${APP_CONFIG.HASS_TOKEN}`, + "Content-Type": "application/json", + }, + body: JSON.stringify(config), + }, + ); + + if (!createResponse.ok) { + throw new Error( + `Failed to create duplicate automation: ${createResponse.statusText}`, + ); + } + + const newAutomation = + (await createResponse.json()) as AutomationResponse; + return { + success: true, + message: `Successfully duplicated automation ${params.automation_id}`, + new_automation_id: newAutomation.automation_id, + }; + } + } + } catch (error) { + return { + success: false, + message: + error instanceof Error ? error.message : "Unknown error occurred", + }; + } + }, +}; diff --git a/src/tools/automation.tool.ts b/src/tools/automation.tool.ts index 0e43f0c..08e75c8 100644 --- a/src/tools/automation.tool.ts +++ b/src/tools/automation.tool.ts @@ -1,73 +1,97 @@ -import { z } from 'zod'; -import { Tool, AutomationParams, HassState, AutomationResponse } from '../types/index.js'; -import { APP_CONFIG } from '../config/app.config.js'; +import { z } from "zod"; +import { + Tool, + AutomationParams, + HassState, + AutomationResponse, +} from "../types/index.js"; +import { APP_CONFIG } from "../config/app.config.js"; export const automationTool: Tool = { - name: 'automation', - description: 'Manage Home Assistant automations', - parameters: z.object({ - action: z.enum(['list', 'toggle', 'trigger']).describe('Action to perform with automation'), - automation_id: z.string().optional().describe('Automation ID (required for toggle and trigger actions)'), - }), - execute: async (params: AutomationParams) => { - try { - if (params.action === 'list') { - const response = await fetch(`${APP_CONFIG.HASS_HOST}/api/states`, { - headers: { - Authorization: `Bearer ${APP_CONFIG.HASS_TOKEN}`, - 'Content-Type': 'application/json', - }, - }); + name: "automation", + description: "Manage Home Assistant automations", + parameters: z.object({ + action: z + .enum(["list", "toggle", "trigger"]) + .describe("Action to perform with automation"), + automation_id: z + .string() + .optional() + .describe("Automation ID (required for toggle and trigger actions)"), + }), + execute: async (params: AutomationParams) => { + try { + if (params.action === "list") { + const response = await fetch(`${APP_CONFIG.HASS_HOST}/api/states`, { + headers: { + Authorization: `Bearer ${APP_CONFIG.HASS_TOKEN}`, + "Content-Type": "application/json", + }, + }); - if (!response.ok) { - throw new Error(`Failed to fetch automations: ${response.statusText}`); - } - - const states = (await response.json()) as HassState[]; - const automations = states.filter((state) => state.entity_id.startsWith('automation.')); - - return { - success: true, - automations: automations.map((automation) => ({ - entity_id: automation.entity_id, - name: automation.attributes.friendly_name || automation.entity_id.split('.')[1], - state: automation.state, - last_triggered: automation.attributes.last_triggered, - })), - }; - } else { - if (!params.automation_id) { - throw new Error('Automation ID is required for toggle and trigger actions'); - } - - const service = params.action === 'toggle' ? 'toggle' : 'trigger'; - const response = await fetch(`${APP_CONFIG.HASS_HOST}/api/services/automation/${service}`, { - method: 'POST', - headers: { - Authorization: `Bearer ${APP_CONFIG.HASS_TOKEN}`, - 'Content-Type': 'application/json', - }, - body: JSON.stringify({ - entity_id: params.automation_id, - }), - }); - - if (!response.ok) { - throw new Error(`Failed to ${service} automation: ${response.statusText}`); - } - - const responseData = await response.json() as AutomationResponse; - return { - success: true, - message: `Successfully ${service}d automation ${params.automation_id}`, - automation_id: responseData.automation_id, - }; - } - } catch (error) { - return { - success: false, - message: error instanceof Error ? error.message : 'Unknown error occurred', - }; + if (!response.ok) { + throw new Error( + `Failed to fetch automations: ${response.statusText}`, + ); } - }, -}; \ No newline at end of file + + const states = (await response.json()) as HassState[]; + const automations = states.filter((state) => + state.entity_id.startsWith("automation."), + ); + + return { + success: true, + automations: automations.map((automation) => ({ + entity_id: automation.entity_id, + name: + automation.attributes.friendly_name || + automation.entity_id.split(".")[1], + state: automation.state, + last_triggered: automation.attributes.last_triggered, + })), + }; + } else { + if (!params.automation_id) { + throw new Error( + "Automation ID is required for toggle and trigger actions", + ); + } + + const service = params.action === "toggle" ? "toggle" : "trigger"; + const response = await fetch( + `${APP_CONFIG.HASS_HOST}/api/services/automation/${service}`, + { + method: "POST", + headers: { + Authorization: `Bearer ${APP_CONFIG.HASS_TOKEN}`, + "Content-Type": "application/json", + }, + body: JSON.stringify({ + entity_id: params.automation_id, + }), + }, + ); + + if (!response.ok) { + throw new Error( + `Failed to ${service} automation: ${response.statusText}`, + ); + } + + const responseData = (await response.json()) as AutomationResponse; + return { + success: true, + message: `Successfully ${service}d automation ${params.automation_id}`, + automation_id: responseData.automation_id, + }; + } + } catch (error) { + return { + success: false, + message: + error instanceof Error ? error.message : "Unknown error occurred", + }; + } + }, +}; diff --git a/src/tools/control.tool.ts b/src/tools/control.tool.ts index 01aae6d..2f4c5c5 100644 --- a/src/tools/control.tool.ts +++ b/src/tools/control.tool.ts @@ -1,139 +1,191 @@ -import { z } from 'zod'; -import { Tool, CommandParams } from '../types/index.js'; -import { APP_CONFIG } from '../config/app.config.js'; -import { DomainSchema } from '../schemas.js'; +import { z } from "zod"; +import { Tool, CommandParams } from "../types/index.js"; +import { APP_CONFIG } from "../config/app.config.js"; +import { DomainSchema } from "../schemas.js"; // Define command constants -const commonCommands = ['turn_on', 'turn_off', 'toggle'] as const; -const coverCommands = [...commonCommands, 'open', 'close', 'stop', 'set_position', 'set_tilt_position'] as const; -const climateCommands = [...commonCommands, 'set_temperature', 'set_hvac_mode', 'set_fan_mode', 'set_humidity'] as const; +const commonCommands = ["turn_on", "turn_off", "toggle"] as const; +const coverCommands = [ + ...commonCommands, + "open", + "close", + "stop", + "set_position", + "set_tilt_position", +] as const; +const climateCommands = [ + ...commonCommands, + "set_temperature", + "set_hvac_mode", + "set_fan_mode", + "set_humidity", +] as const; export const controlTool: Tool = { - name: 'control', - description: 'Control Home Assistant devices and services', - parameters: z.object({ - command: z.enum([...commonCommands, ...coverCommands, ...climateCommands]) - .describe('The command to execute'), - entity_id: z.string().describe('The entity ID to control'), - // Common parameters - state: z.string().optional().describe('The desired state for the entity'), - // Light parameters - brightness: z.number().min(0).max(255).optional() - .describe('Brightness level for lights (0-255)'), - color_temp: z.number().optional() - .describe('Color temperature for lights'), - rgb_color: z.tuple([z.number(), z.number(), z.number()]).optional() - .describe('RGB color values'), - // Cover parameters - position: z.number().min(0).max(100).optional() - .describe('Position for covers (0-100)'), - tilt_position: z.number().min(0).max(100).optional() - .describe('Tilt position for covers (0-100)'), - // Climate parameters - temperature: z.number().optional() - .describe('Target temperature for climate devices'), - target_temp_high: z.number().optional() - .describe('Target high temperature for climate devices'), - target_temp_low: z.number().optional() - .describe('Target low temperature for climate devices'), - hvac_mode: z.enum(['off', 'heat', 'cool', 'heat_cool', 'auto', 'dry', 'fan_only']).optional() - .describe('HVAC mode for climate devices'), - fan_mode: z.enum(['auto', 'low', 'medium', 'high']).optional() - .describe('Fan mode for climate devices'), - humidity: z.number().min(0).max(100).optional() - .describe('Target humidity for climate devices') - }), - execute: async (params: CommandParams) => { - try { - const domain = params.entity_id.split('.')[0] as keyof typeof DomainSchema.Values; + name: "control", + description: "Control Home Assistant devices and services", + parameters: z.object({ + command: z + .enum([...commonCommands, ...coverCommands, ...climateCommands]) + .describe("The command to execute"), + entity_id: z.string().describe("The entity ID to control"), + // Common parameters + state: z.string().optional().describe("The desired state for the entity"), + // Light parameters + brightness: z + .number() + .min(0) + .max(255) + .optional() + .describe("Brightness level for lights (0-255)"), + color_temp: z.number().optional().describe("Color temperature for lights"), + rgb_color: z + .tuple([z.number(), z.number(), z.number()]) + .optional() + .describe("RGB color values"), + // Cover parameters + position: z + .number() + .min(0) + .max(100) + .optional() + .describe("Position for covers (0-100)"), + tilt_position: z + .number() + .min(0) + .max(100) + .optional() + .describe("Tilt position for covers (0-100)"), + // Climate parameters + temperature: z + .number() + .optional() + .describe("Target temperature for climate devices"), + target_temp_high: z + .number() + .optional() + .describe("Target high temperature for climate devices"), + target_temp_low: z + .number() + .optional() + .describe("Target low temperature for climate devices"), + hvac_mode: z + .enum(["off", "heat", "cool", "heat_cool", "auto", "dry", "fan_only"]) + .optional() + .describe("HVAC mode for climate devices"), + fan_mode: z + .enum(["auto", "low", "medium", "high"]) + .optional() + .describe("Fan mode for climate devices"), + humidity: z + .number() + .min(0) + .max(100) + .optional() + .describe("Target humidity for climate devices"), + }), + execute: async (params: CommandParams) => { + try { + const domain = params.entity_id.split( + ".", + )[0] as keyof typeof DomainSchema.Values; - if (!Object.values(DomainSchema.Values).includes(domain)) { - throw new Error(`Unsupported domain: ${domain}`); + if (!Object.values(DomainSchema.Values).includes(domain)) { + throw new Error(`Unsupported domain: ${domain}`); + } + + const service = params.command; + const serviceData: Record = { + entity_id: params.entity_id, + }; + + // Handle domain-specific parameters + switch (domain) { + case "light": + if (params.brightness !== undefined) { + serviceData.brightness = params.brightness; + } + if (params.color_temp !== undefined) { + serviceData.color_temp = params.color_temp; + } + if (params.rgb_color !== undefined) { + serviceData.rgb_color = params.rgb_color; + } + break; + + case "cover": + if (service === "set_position" && params.position !== undefined) { + serviceData.position = params.position; + } + if ( + service === "set_tilt_position" && + params.tilt_position !== undefined + ) { + serviceData.tilt_position = params.tilt_position; + } + break; + + case "climate": + if (service === "set_temperature") { + if (params.temperature !== undefined) { + serviceData.temperature = params.temperature; } - - const service = params.command; - const serviceData: Record = { - entity_id: params.entity_id - }; - - // Handle domain-specific parameters - switch (domain) { - case 'light': - if (params.brightness !== undefined) { - serviceData.brightness = params.brightness; - } - if (params.color_temp !== undefined) { - serviceData.color_temp = params.color_temp; - } - if (params.rgb_color !== undefined) { - serviceData.rgb_color = params.rgb_color; - } - break; - - case 'cover': - if (service === 'set_position' && params.position !== undefined) { - serviceData.position = params.position; - } - if (service === 'set_tilt_position' && params.tilt_position !== undefined) { - serviceData.tilt_position = params.tilt_position; - } - break; - - case 'climate': - if (service === 'set_temperature') { - if (params.temperature !== undefined) { - serviceData.temperature = params.temperature; - } - if (params.target_temp_high !== undefined) { - serviceData.target_temp_high = params.target_temp_high; - } - if (params.target_temp_low !== undefined) { - serviceData.target_temp_low = params.target_temp_low; - } - } - if (service === 'set_hvac_mode' && params.hvac_mode !== undefined) { - serviceData.hvac_mode = params.hvac_mode; - } - if (service === 'set_fan_mode' && params.fan_mode !== undefined) { - serviceData.fan_mode = params.fan_mode; - } - if (service === 'set_humidity' && params.humidity !== undefined) { - serviceData.humidity = params.humidity; - } - break; - - case 'switch': - case 'contact': - // These domains only support basic operations (turn_on, turn_off, toggle) - break; - - default: - throw new Error(`Unsupported operation for domain: ${domain}`); + if (params.target_temp_high !== undefined) { + serviceData.target_temp_high = params.target_temp_high; } - - // Call Home Assistant service - const response = await fetch(`${APP_CONFIG.HASS_HOST}/api/services/${domain}/${service}`, { - method: 'POST', - headers: { - Authorization: `Bearer ${APP_CONFIG.HASS_TOKEN}`, - 'Content-Type': 'application/json', - }, - body: JSON.stringify(serviceData), - }); - - if (!response.ok) { - throw new Error(`Failed to execute ${service} for ${params.entity_id}: ${response.statusText}`); + if (params.target_temp_low !== undefined) { + serviceData.target_temp_low = params.target_temp_low; } + } + if (service === "set_hvac_mode" && params.hvac_mode !== undefined) { + serviceData.hvac_mode = params.hvac_mode; + } + if (service === "set_fan_mode" && params.fan_mode !== undefined) { + serviceData.fan_mode = params.fan_mode; + } + if (service === "set_humidity" && params.humidity !== undefined) { + serviceData.humidity = params.humidity; + } + break; - return { - success: true, - message: `Successfully executed ${service} for ${params.entity_id}` - }; - } catch (error) { - return { - success: false, - message: error instanceof Error ? error.message : 'Unknown error occurred' - }; - } + case "switch": + case "contact": + // These domains only support basic operations (turn_on, turn_off, toggle) + break; + + default: + throw new Error(`Unsupported operation for domain: ${domain}`); + } + + // Call Home Assistant service + const response = await fetch( + `${APP_CONFIG.HASS_HOST}/api/services/${domain}/${service}`, + { + method: "POST", + headers: { + Authorization: `Bearer ${APP_CONFIG.HASS_TOKEN}`, + "Content-Type": "application/json", + }, + body: JSON.stringify(serviceData), + }, + ); + + if (!response.ok) { + throw new Error( + `Failed to execute ${service} for ${params.entity_id}: ${response.statusText}`, + ); + } + + return { + success: true, + message: `Successfully executed ${service} for ${params.entity_id}`, + }; + } catch (error) { + return { + success: false, + message: + error instanceof Error ? error.message : "Unknown error occurred", + }; } -}; \ No newline at end of file + }, +}; diff --git a/src/tools/history.tool.ts b/src/tools/history.tool.ts index 9e13623..a3e7c0e 100644 --- a/src/tools/history.tool.ts +++ b/src/tools/history.tool.ts @@ -1,53 +1,71 @@ -import { z } from 'zod'; -import { Tool, HistoryParams } from '../types/index.js'; -import { APP_CONFIG } from '../config/app.config.js'; +import { z } from "zod"; +import { Tool, HistoryParams } from "../types/index.js"; +import { APP_CONFIG } from "../config/app.config.js"; export const historyTool: Tool = { - name: 'get_history', - description: 'Get state history for Home Assistant entities', - parameters: z.object({ - entity_id: z.string().describe('The entity ID to get history for'), - start_time: z.string().optional().describe('Start time in ISO format. Defaults to 24 hours ago'), - end_time: z.string().optional().describe('End time in ISO format. Defaults to now'), - minimal_response: z.boolean().optional().describe('Return minimal response to reduce data size'), - significant_changes_only: z.boolean().optional().describe('Only return significant state changes'), - }), - execute: async (params: HistoryParams) => { - try { - const now = new Date(); - const startTime = params.start_time ? new Date(params.start_time) : new Date(now.getTime() - 24 * 60 * 60 * 1000); - const endTime = params.end_time ? new Date(params.end_time) : now; + name: "get_history", + description: "Get state history for Home Assistant entities", + parameters: z.object({ + entity_id: z.string().describe("The entity ID to get history for"), + start_time: z + .string() + .optional() + .describe("Start time in ISO format. Defaults to 24 hours ago"), + end_time: z + .string() + .optional() + .describe("End time in ISO format. Defaults to now"), + minimal_response: z + .boolean() + .optional() + .describe("Return minimal response to reduce data size"), + significant_changes_only: z + .boolean() + .optional() + .describe("Only return significant state changes"), + }), + execute: async (params: HistoryParams) => { + try { + const now = new Date(); + const startTime = params.start_time + ? new Date(params.start_time) + : new Date(now.getTime() - 24 * 60 * 60 * 1000); + const endTime = params.end_time ? new Date(params.end_time) : now; - // Build query parameters - const queryParams = new URLSearchParams({ - filter_entity_id: params.entity_id, - minimal_response: String(!!params.minimal_response), - significant_changes_only: String(!!params.significant_changes_only), - start_time: startTime.toISOString(), - end_time: endTime.toISOString(), - }); + // Build query parameters + const queryParams = new URLSearchParams({ + filter_entity_id: params.entity_id, + minimal_response: String(!!params.minimal_response), + significant_changes_only: String(!!params.significant_changes_only), + start_time: startTime.toISOString(), + end_time: endTime.toISOString(), + }); - const response = await fetch(`${APP_CONFIG.HASS_HOST}/api/history/period/${startTime.toISOString()}?${queryParams.toString()}`, { - headers: { - Authorization: `Bearer ${APP_CONFIG.HASS_TOKEN}`, - 'Content-Type': 'application/json', - }, - }); + const response = await fetch( + `${APP_CONFIG.HASS_HOST}/api/history/period/${startTime.toISOString()}?${queryParams.toString()}`, + { + headers: { + Authorization: `Bearer ${APP_CONFIG.HASS_TOKEN}`, + "Content-Type": "application/json", + }, + }, + ); - if (!response.ok) { - throw new Error(`Failed to fetch history: ${response.statusText}`); - } + if (!response.ok) { + throw new Error(`Failed to fetch history: ${response.statusText}`); + } - const history = await response.json(); - return { - success: true, - history, - }; - } catch (error) { - return { - success: false, - message: error instanceof Error ? error.message : 'Unknown error occurred', - }; - } - }, -}; \ No newline at end of file + const history = await response.json(); + return { + success: true, + history, + }; + } catch (error) { + return { + success: false, + message: + error instanceof Error ? error.message : "Unknown error occurred", + }; + } + }, +}; diff --git a/src/tools/index.ts b/src/tools/index.ts index 6b4c75f..5008465 100644 --- a/src/tools/index.ts +++ b/src/tools/index.ts @@ -1,76 +1,76 @@ -import { Tool } from '../types/index.js'; -import { listDevicesTool } from './list-devices.tool.js'; -import { controlTool } from './control.tool.js'; -import { historyTool } from './history.tool.js'; -import { sceneTool } from './scene.tool.js'; -import { notifyTool } from './notify.tool.js'; -import { automationTool } from './automation.tool.js'; -import { addonTool } from './addon.tool.js'; -import { packageTool } from './package.tool.js'; -import { automationConfigTool } from './automation-config.tool.js'; -import { subscribeEventsTool } from './subscribe-events.tool.js'; -import { getSSEStatsTool } from './sse-stats.tool.js'; +import { Tool } from "../types/index.js"; +import { listDevicesTool } from "./list-devices.tool.js"; +import { controlTool } from "./control.tool.js"; +import { historyTool } from "./history.tool.js"; +import { sceneTool } from "./scene.tool.js"; +import { notifyTool } from "./notify.tool.js"; +import { automationTool } from "./automation.tool.js"; +import { addonTool } from "./addon.tool.js"; +import { packageTool } from "./package.tool.js"; +import { automationConfigTool } from "./automation-config.tool.js"; +import { subscribeEventsTool } from "./subscribe-events.tool.js"; +import { getSSEStatsTool } from "./sse-stats.tool.js"; // Tool category types export enum ToolCategory { - DEVICE = 'device', - SYSTEM = 'system', - AUTOMATION = 'automation' + DEVICE = "device", + SYSTEM = "system", + AUTOMATION = "automation", } // Tool priority levels export enum ToolPriority { - HIGH = 'high', - MEDIUM = 'medium', - LOW = 'low' + HIGH = "high", + MEDIUM = "medium", + LOW = "low", } interface ToolMetadata { - category: ToolCategory; - platform: string; - version: string; - caching?: { - enabled: boolean; - ttl: number; - }; + category: ToolCategory; + platform: string; + version: string; + caching?: { + enabled: boolean; + ttl: number; + }; } // Array to track all tools export const tools: Tool[] = [ - listDevicesTool, - controlTool, - historyTool, - sceneTool, - notifyTool, - automationTool, - addonTool, - packageTool, - automationConfigTool, - subscribeEventsTool, - getSSEStatsTool + listDevicesTool, + controlTool, + historyTool, + sceneTool, + notifyTool, + automationTool, + addonTool, + packageTool, + automationConfigTool, + subscribeEventsTool, + getSSEStatsTool, ]; // Function to get a tool by name export function getToolByName(name: string): Tool | undefined { - return tools.find(tool => tool.name === name); + return tools.find((tool) => tool.name === name); } // Function to get all tools export function getAllTools(): Tool[] { - return [...tools]; + return [...tools]; } // Export all tools individually export { - listDevicesTool, - controlTool, - historyTool, - sceneTool, - notifyTool, - automationTool, - addonTool, - packageTool, - automationConfigTool, - subscribeEventsTool, - getSSEStatsTool -}; \ No newline at end of file + listDevicesTool, + controlTool, + historyTool, + sceneTool, + notifyTool, + automationTool, + addonTool, + packageTool, + automationConfigTool, + subscribeEventsTool, + getSSEStatsTool, +}; diff --git a/src/tools/list-devices.tool.ts b/src/tools/list-devices.tool.ts index 74f7f21..640616c 100644 --- a/src/tools/list-devices.tool.ts +++ b/src/tools/list-devices.tool.ts @@ -1,46 +1,47 @@ -import { z } from 'zod'; -import { Tool } from '../types/index.js'; -import { APP_CONFIG } from '../config/app.config.js'; -import { HassState } from '../types/index.js'; +import { z } from "zod"; +import { Tool } from "../types/index.js"; +import { APP_CONFIG } from "../config/app.config.js"; +import { HassState } from "../types/index.js"; export const listDevicesTool: Tool = { - name: 'list_devices', - description: 'List all available Home Assistant devices', - parameters: z.object({}).describe('No parameters required'), - execute: async () => { - try { - const response = await fetch(`${APP_CONFIG.HASS_HOST}/api/states`, { - headers: { - Authorization: `Bearer ${APP_CONFIG.HASS_TOKEN}`, - 'Content-Type': 'application/json', - }, - }); + name: "list_devices", + description: "List all available Home Assistant devices", + parameters: z.object({}).describe("No parameters required"), + execute: async () => { + try { + const response = await fetch(`${APP_CONFIG.HASS_HOST}/api/states`, { + headers: { + Authorization: `Bearer ${APP_CONFIG.HASS_TOKEN}`, + "Content-Type": "application/json", + }, + }); - if (!response.ok) { - throw new Error(`Failed to fetch devices: ${response.statusText}`); - } + if (!response.ok) { + throw new Error(`Failed to fetch devices: ${response.statusText}`); + } - const states = await response.json() as HassState[]; - const devices: Record = {}; + const states = (await response.json()) as HassState[]; + const devices: Record = {}; - // Group devices by domain - states.forEach(state => { - const [domain] = state.entity_id.split('.'); - if (!devices[domain]) { - devices[domain] = []; - } - devices[domain].push(state); - }); - - return { - success: true, - devices - }; - } catch (error) { - return { - success: false, - message: error instanceof Error ? error.message : 'Unknown error occurred' - }; + // Group devices by domain + states.forEach((state) => { + const [domain] = state.entity_id.split("."); + if (!devices[domain]) { + devices[domain] = []; } + devices[domain].push(state); + }); + + return { + success: true, + devices, + }; + } catch (error) { + return { + success: false, + message: + error instanceof Error ? error.message : "Unknown error occurred", + }; } -}; \ No newline at end of file + }, +}; diff --git a/src/tools/notify.tool.ts b/src/tools/notify.tool.ts index 34be2b0..6bdb50b 100644 --- a/src/tools/notify.tool.ts +++ b/src/tools/notify.tool.ts @@ -1,47 +1,56 @@ -import { z } from 'zod'; -import { Tool, NotifyParams } from '../types/index.js'; -import { APP_CONFIG } from '../config/app.config.js'; +import { z } from "zod"; +import { Tool, NotifyParams } from "../types/index.js"; +import { APP_CONFIG } from "../config/app.config.js"; export const notifyTool: Tool = { - name: 'notify', - description: 'Send notifications through Home Assistant', - parameters: z.object({ - message: z.string().describe('The notification message'), - title: z.string().optional().describe('The notification title'), - target: z.string().optional().describe('Specific notification target (e.g., mobile_app_phone)'), - data: z.record(z.any()).optional().describe('Additional notification data'), - }), - execute: async (params: NotifyParams) => { - try { - const service = params.target ? `notify.${params.target}` : 'notify.notify'; - const [domain, service_name] = service.split('.'); + name: "notify", + description: "Send notifications through Home Assistant", + parameters: z.object({ + message: z.string().describe("The notification message"), + title: z.string().optional().describe("The notification title"), + target: z + .string() + .optional() + .describe("Specific notification target (e.g., mobile_app_phone)"), + data: z.record(z.any()).optional().describe("Additional notification data"), + }), + execute: async (params: NotifyParams) => { + try { + const service = params.target + ? `notify.${params.target}` + : "notify.notify"; + const [domain, service_name] = service.split("."); - const response = await fetch(`${APP_CONFIG.HASS_HOST}/api/services/${domain}/${service_name}`, { - method: 'POST', - headers: { - Authorization: `Bearer ${APP_CONFIG.HASS_TOKEN}`, - 'Content-Type': 'application/json', - }, - body: JSON.stringify({ - message: params.message, - title: params.title, - data: params.data, - }), - }); + const response = await fetch( + `${APP_CONFIG.HASS_HOST}/api/services/${domain}/${service_name}`, + { + method: "POST", + headers: { + Authorization: `Bearer ${APP_CONFIG.HASS_TOKEN}`, + "Content-Type": "application/json", + }, + body: JSON.stringify({ + message: params.message, + title: params.title, + data: params.data, + }), + }, + ); - if (!response.ok) { - throw new Error(`Failed to send notification: ${response.statusText}`); - } + if (!response.ok) { + throw new Error(`Failed to send notification: ${response.statusText}`); + } - return { - success: true, - message: 'Notification sent successfully', - }; - } catch (error) { - return { - success: false, - message: error instanceof Error ? error.message : 'Unknown error occurred', - }; - } - }, -}; \ No newline at end of file + return { + success: true, + message: "Notification sent successfully", + }; + } catch (error) { + return { + success: false, + message: + error instanceof Error ? error.message : "Unknown error occurred", + }; + } + }, +}; diff --git a/src/tools/package.tool.ts b/src/tools/package.tool.ts index 322fcc0..b94386f 100644 --- a/src/tools/package.tool.ts +++ b/src/tools/package.tool.ts @@ -1,88 +1,106 @@ -import { z } from 'zod'; -import { Tool, PackageParams, HacsResponse } from '../types/index.js'; -import { APP_CONFIG } from '../config/app.config.js'; +import { z } from "zod"; +import { Tool, PackageParams, HacsResponse } from "../types/index.js"; +import { APP_CONFIG } from "../config/app.config.js"; export const packageTool: Tool = { - name: 'package', - description: 'Manage HACS packages and custom components', - parameters: z.object({ - action: z.enum(['list', 'install', 'uninstall', 'update']) - .describe('Action to perform with package'), - category: z.enum(['integration', 'plugin', 'theme', 'python_script', 'appdaemon', 'netdaemon']) - .describe('Package category'), - repository: z.string().optional().describe('Repository URL or name (required for install)'), - version: z.string().optional().describe('Version to install'), - }), - execute: async (params: PackageParams) => { - try { - const hacsBase = `${APP_CONFIG.HASS_HOST}/api/hacs`; + name: "package", + description: "Manage HACS packages and custom components", + parameters: z.object({ + action: z + .enum(["list", "install", "uninstall", "update"]) + .describe("Action to perform with package"), + category: z + .enum([ + "integration", + "plugin", + "theme", + "python_script", + "appdaemon", + "netdaemon", + ]) + .describe("Package category"), + repository: z + .string() + .optional() + .describe("Repository URL or name (required for install)"), + version: z.string().optional().describe("Version to install"), + }), + execute: async (params: PackageParams) => { + try { + const hacsBase = `${APP_CONFIG.HASS_HOST}/api/hacs`; - if (params.action === 'list') { - const response = await fetch(`${hacsBase}/repositories?category=${params.category}`, { - headers: { - Authorization: `Bearer ${APP_CONFIG.HASS_TOKEN}`, - 'Content-Type': 'application/json', - }, - }); + if (params.action === "list") { + const response = await fetch( + `${hacsBase}/repositories?category=${params.category}`, + { + headers: { + Authorization: `Bearer ${APP_CONFIG.HASS_TOKEN}`, + "Content-Type": "application/json", + }, + }, + ); - if (!response.ok) { - throw new Error(`Failed to fetch packages: ${response.statusText}`); - } - - const data = await response.json() as HacsResponse; - return { - success: true, - packages: data.repositories, - }; - } else { - if (!params.repository) { - throw new Error('Repository is required for this action'); - } - - let endpoint = ''; - const body: Record = { - category: params.category, - repository: params.repository, - }; - - switch (params.action) { - case 'install': - endpoint = '/repository/install'; - if (params.version) { - body.version = params.version; - } - break; - case 'uninstall': - endpoint = '/repository/uninstall'; - break; - case 'update': - endpoint = '/repository/update'; - break; - } - - const response = await fetch(`${hacsBase}${endpoint}`, { - method: 'POST', - headers: { - Authorization: `Bearer ${APP_CONFIG.HASS_TOKEN}`, - 'Content-Type': 'application/json', - }, - body: JSON.stringify(body), - }); - - if (!response.ok) { - throw new Error(`Failed to ${params.action} package: ${response.statusText}`); - } - - return { - success: true, - message: `Successfully ${params.action}ed package ${params.repository}`, - }; - } - } catch (error) { - return { - success: false, - message: error instanceof Error ? error.message : 'Unknown error occurred', - }; + if (!response.ok) { + throw new Error(`Failed to fetch packages: ${response.statusText}`); } - }, -}; \ No newline at end of file + + const data = (await response.json()) as HacsResponse; + return { + success: true, + packages: data.repositories, + }; + } else { + if (!params.repository) { + throw new Error("Repository is required for this action"); + } + + let endpoint = ""; + const body: Record = { + category: params.category, + repository: params.repository, + }; + + switch (params.action) { + case "install": + endpoint = "/repository/install"; + if (params.version) { + body.version = params.version; + } + break; + case "uninstall": + endpoint = "/repository/uninstall"; + break; + case "update": + endpoint = "/repository/update"; + break; + } + + const response = await fetch(`${hacsBase}${endpoint}`, { + method: "POST", + headers: { + Authorization: `Bearer ${APP_CONFIG.HASS_TOKEN}`, + "Content-Type": "application/json", + }, + body: JSON.stringify(body), + }); + + if (!response.ok) { + throw new Error( + `Failed to ${params.action} package: ${response.statusText}`, + ); + } + + return { + success: true, + message: `Successfully ${params.action}ed package ${params.repository}`, + }; + } + } catch (error) { + return { + success: false, + message: + error instanceof Error ? error.message : "Unknown error occurred", + }; + } + }, +}; diff --git a/src/tools/scene.tool.ts b/src/tools/scene.tool.ts index f3d50d0..4b2b094 100644 --- a/src/tools/scene.tool.ts +++ b/src/tools/scene.tool.ts @@ -1,71 +1,83 @@ -import { z } from 'zod'; -import { Tool, SceneParams, HassState } from '../types/index.js'; -import { APP_CONFIG } from '../config/app.config.js'; +import { z } from "zod"; +import { Tool, SceneParams, HassState } from "../types/index.js"; +import { APP_CONFIG } from "../config/app.config.js"; export const sceneTool: Tool = { - name: 'scene', - description: 'Manage and activate Home Assistant scenes', - parameters: z.object({ - action: z.enum(['list', 'activate']).describe('Action to perform with scenes'), - scene_id: z.string().optional().describe('Scene ID to activate (required for activate action)'), - }), - execute: async (params: SceneParams) => { - try { - if (params.action === 'list') { - const response = await fetch(`${APP_CONFIG.HASS_HOST}/api/states`, { - headers: { - Authorization: `Bearer ${APP_CONFIG.HASS_TOKEN}`, - 'Content-Type': 'application/json', - }, - }); + name: "scene", + description: "Manage and activate Home Assistant scenes", + parameters: z.object({ + action: z + .enum(["list", "activate"]) + .describe("Action to perform with scenes"), + scene_id: z + .string() + .optional() + .describe("Scene ID to activate (required for activate action)"), + }), + execute: async (params: SceneParams) => { + try { + if (params.action === "list") { + const response = await fetch(`${APP_CONFIG.HASS_HOST}/api/states`, { + headers: { + Authorization: `Bearer ${APP_CONFIG.HASS_TOKEN}`, + "Content-Type": "application/json", + }, + }); - if (!response.ok) { - throw new Error(`Failed to fetch scenes: ${response.statusText}`); - } - - const states = (await response.json()) as HassState[]; - const scenes = states.filter((state) => state.entity_id.startsWith('scene.')); - - return { - success: true, - scenes: scenes.map((scene) => ({ - entity_id: scene.entity_id, - name: scene.attributes.friendly_name || scene.entity_id.split('.')[1], - description: scene.attributes.description, - })), - }; - } else if (params.action === 'activate') { - if (!params.scene_id) { - throw new Error('Scene ID is required for activate action'); - } - - const response = await fetch(`${APP_CONFIG.HASS_HOST}/api/services/scene/turn_on`, { - method: 'POST', - headers: { - Authorization: `Bearer ${APP_CONFIG.HASS_TOKEN}`, - 'Content-Type': 'application/json', - }, - body: JSON.stringify({ - entity_id: params.scene_id, - }), - }); - - if (!response.ok) { - throw new Error(`Failed to activate scene: ${response.statusText}`); - } - - return { - success: true, - message: `Successfully activated scene ${params.scene_id}`, - }; - } - - throw new Error('Invalid action specified'); - } catch (error) { - return { - success: false, - message: error instanceof Error ? error.message : 'Unknown error occurred', - }; + if (!response.ok) { + throw new Error(`Failed to fetch scenes: ${response.statusText}`); } - }, -}; \ No newline at end of file + + const states = (await response.json()) as HassState[]; + const scenes = states.filter((state) => + state.entity_id.startsWith("scene."), + ); + + return { + success: true, + scenes: scenes.map((scene) => ({ + entity_id: scene.entity_id, + name: + scene.attributes.friendly_name || scene.entity_id.split(".")[1], + description: scene.attributes.description, + })), + }; + } else if (params.action === "activate") { + if (!params.scene_id) { + throw new Error("Scene ID is required for activate action"); + } + + const response = await fetch( + `${APP_CONFIG.HASS_HOST}/api/services/scene/turn_on`, + { + method: "POST", + headers: { + Authorization: `Bearer ${APP_CONFIG.HASS_TOKEN}`, + "Content-Type": "application/json", + }, + body: JSON.stringify({ + entity_id: params.scene_id, + }), + }, + ); + + if (!response.ok) { + throw new Error(`Failed to activate scene: ${response.statusText}`); + } + + return { + success: true, + message: `Successfully activated scene ${params.scene_id}`, + }; + } + + throw new Error("Invalid action specified"); + } catch (error) { + return { + success: false, + message: + error instanceof Error ? error.message : "Unknown error occurred", + }; + } + }, +}; diff --git a/src/tools/sse-stats.tool.ts b/src/tools/sse-stats.tool.ts index 92a9083..2339b65 100644 --- a/src/tools/sse-stats.tool.ts +++ b/src/tools/sse-stats.tool.ts @@ -1,33 +1,34 @@ -import { z } from 'zod'; -import { Tool } from '../types/index.js'; -import { APP_CONFIG } from '../config/app.config.js'; -import { sseManager } from '../sse/index.js'; +import { z } from "zod"; +import { Tool } from "../types/index.js"; +import { APP_CONFIG } from "../config/app.config.js"; +import { sseManager } from "../sse/index.js"; export const getSSEStatsTool: Tool = { - name: 'get_sse_stats', - description: 'Get SSE connection statistics', - parameters: z.object({ - token: z.string().describe('Authentication token (required)') - }), - execute: async (params: { token: string }) => { - try { - if (params.token !== APP_CONFIG.HASS_TOKEN) { - return { - success: false, - message: 'Authentication failed' - }; - } + name: "get_sse_stats", + description: "Get SSE connection statistics", + parameters: z.object({ + token: z.string().describe("Authentication token (required)"), + }), + execute: async (params: { token: string }) => { + try { + if (params.token !== APP_CONFIG.HASS_TOKEN) { + return { + success: false, + message: "Authentication failed", + }; + } - const stats = await sseManager.getStatistics(); - return { - success: true, - statistics: stats - }; - } catch (error) { - return { - success: false, - message: error instanceof Error ? error.message : 'Unknown error occurred' - }; - } + const stats = await sseManager.getStatistics(); + return { + success: true, + statistics: stats, + }; + } catch (error) { + return { + success: false, + message: + error instanceof Error ? error.message : "Unknown error occurred", + }; } -}; \ No newline at end of file + }, +}; diff --git a/src/tools/subscribe-events.tool.ts b/src/tools/subscribe-events.tool.ts index 8a3fdbe..247241e 100644 --- a/src/tools/subscribe-events.tool.ts +++ b/src/tools/subscribe-events.tool.ts @@ -1,84 +1,99 @@ -import { z } from 'zod'; -import { v4 as uuidv4 } from 'uuid'; -import { Tool, SSEParams } from '../types/index.js'; -import { sseManager } from '../sse/index.js'; +import { z } from "zod"; +import { v4 as uuidv4 } from "uuid"; +import { Tool, SSEParams } from "../types/index.js"; +import { sseManager } from "../sse/index.js"; export const subscribeEventsTool: Tool = { - name: 'subscribe_events', - description: 'Subscribe to Home Assistant events via Server-Sent Events (SSE)', - parameters: z.object({ - token: z.string().describe('Authentication token (required)'), - events: z.array(z.string()).optional().describe('List of event types to subscribe to'), - entity_id: z.string().optional().describe('Specific entity ID to monitor for state changes'), - domain: z.string().optional().describe('Domain to monitor (e.g., "light", "switch", etc.)'), - }), - execute: async (params: SSEParams) => { - const clientId = uuidv4(); + name: "subscribe_events", + description: + "Subscribe to Home Assistant events via Server-Sent Events (SSE)", + parameters: z.object({ + token: z.string().describe("Authentication token (required)"), + events: z + .array(z.string()) + .optional() + .describe("List of event types to subscribe to"), + entity_id: z + .string() + .optional() + .describe("Specific entity ID to monitor for state changes"), + domain: z + .string() + .optional() + .describe('Domain to monitor (e.g., "light", "switch", etc.)'), + }), + execute: async (params: SSEParams) => { + const clientId = uuidv4(); - // Set up SSE headers - const responseHeaders = { - 'Content-Type': 'text/event-stream', - 'Cache-Control': 'no-cache', - 'Connection': 'keep-alive', - }; - - // Create SSE client - const client = { - id: clientId, - send: (data: string) => { - return { - headers: responseHeaders, - body: `data: ${data}\n\n`, - keepAlive: true - }; - } - }; - - // Add client to SSE manager with authentication - const sseClient = sseManager.addClient(client, params.token); - - if (!sseClient || !sseClient.authenticated) { - return { - success: false, - message: sseClient ? 'Authentication failed' : 'Maximum client limit reached' - }; - } - - // Subscribe to specific events if provided - if (params.events?.length) { - console.log(`Client ${clientId} subscribing to events:`, params.events); - for (const eventType of params.events) { - sseManager.subscribeToEvent(clientId, eventType); - } - } - - // Subscribe to specific entity if provided - if (params.entity_id) { - console.log(`Client ${clientId} subscribing to entity:`, params.entity_id); - sseManager.subscribeToEntity(clientId, params.entity_id); - } - - // Subscribe to domain if provided - if (params.domain) { - console.log(`Client ${clientId} subscribing to domain:`, params.domain); - sseManager.subscribeToDomain(clientId, params.domain); - } + // Set up SSE headers + const responseHeaders = { + "Content-Type": "text/event-stream", + "Cache-Control": "no-cache", + Connection: "keep-alive", + }; + // Create SSE client + const client = { + id: clientId, + send: (data: string) => { return { - headers: responseHeaders, - body: `data: ${JSON.stringify({ - type: 'connection', - status: 'connected', - id: clientId, - authenticated: true, - subscriptions: { - events: params.events || [], - entities: params.entity_id ? [params.entity_id] : [], - domains: params.domain ? [params.domain] : [] - }, - timestamp: new Date().toISOString() - })}\n\n`, - keepAlive: true + headers: responseHeaders, + body: `data: ${data}\n\n`, + keepAlive: true, }; + }, + }; + + // Add client to SSE manager with authentication + const sseClient = sseManager.addClient(client, params.token); + + if (!sseClient || !sseClient.authenticated) { + return { + success: false, + message: sseClient + ? "Authentication failed" + : "Maximum client limit reached", + }; } -}; \ No newline at end of file + + // Subscribe to specific events if provided + if (params.events?.length) { + console.log(`Client ${clientId} subscribing to events:`, params.events); + for (const eventType of params.events) { + sseManager.subscribeToEvent(clientId, eventType); + } + } + + // Subscribe to specific entity if provided + if (params.entity_id) { + console.log( + `Client ${clientId} subscribing to entity:`, + params.entity_id, + ); + sseManager.subscribeToEntity(clientId, params.entity_id); + } + + // Subscribe to domain if provided + if (params.domain) { + console.log(`Client ${clientId} subscribing to domain:`, params.domain); + sseManager.subscribeToDomain(clientId, params.domain); + } + + return { + headers: responseHeaders, + body: `data: ${JSON.stringify({ + type: "connection", + status: "connected", + id: clientId, + authenticated: true, + subscriptions: { + events: params.events || [], + entities: params.entity_id ? [params.entity_id] : [], + domains: params.domain ? [params.domain] : [], + }, + timestamp: new Date().toISOString(), + })}\n\n`, + keepAlive: true, + }; + }, +}; diff --git a/src/types/bun.d.ts b/src/types/bun.d.ts index ae469cd..6b1158d 100644 --- a/src/types/bun.d.ts +++ b/src/types/bun.d.ts @@ -1,50 +1,50 @@ -declare module 'bun:test' { - export interface Mock any> { - (...args: Parameters): ReturnType; - mock: { - calls: Array<{ args: Parameters; returned: ReturnType }>; - results: Array<{ type: 'return' | 'throw'; value: any }>; - instances: any[]; - lastCall: { args: Parameters; returned: ReturnType } | undefined; - }; - mockImplementation(fn: T): this; - mockReturnValue(value: ReturnType): this; - mockResolvedValue(value: U): Mock<() => Promise>; - mockRejectedValue(value: any): Mock<() => Promise>; - mockReset(): void; - } - - export function mock any>( - implementation?: T - ): Mock; - - export function describe(name: string, fn: () => void): void; - export function it(name: string, fn: () => void | Promise): void; - export function test(name: string, fn: () => void | Promise): void; - export function expect(actual: any): { - toBe(expected: any): void; - toEqual(expected: any): void; - toBeDefined(): void; - toBeUndefined(): void; - toBeNull(): void; - toBeTruthy(): void; - toBeFalsy(): void; - toBeGreaterThan(expected: number): void; - toBeLessThan(expected: number): void; - toContain(expected: any): void; - toHaveLength(expected: number): void; - toHaveBeenCalled(): void; - toHaveBeenCalledTimes(expected: number): void; - toHaveBeenCalledWith(...args: any[]): void; - toThrow(expected?: string | RegExp): void; - resolves: any; - rejects: any; +declare module "bun:test" { + export interface Mock any> { + (...args: Parameters): ReturnType; + mock: { + calls: Array<{ args: Parameters; returned: ReturnType }>; + results: Array<{ type: "return" | "throw"; value: any }>; + instances: any[]; + lastCall: { args: Parameters; returned: ReturnType } | undefined; }; - export function beforeAll(fn: () => void | Promise): void; - export function afterAll(fn: () => void | Promise): void; - export function beforeEach(fn: () => void | Promise): void; - export function afterEach(fn: () => void | Promise): void; - export const mock: { - resetAll(): void; - }; -} \ No newline at end of file + mockImplementation(fn: T): this; + mockReturnValue(value: ReturnType): this; + mockResolvedValue(value: U): Mock<() => Promise>; + mockRejectedValue(value: any): Mock<() => Promise>; + mockReset(): void; + } + + export function mock any>( + implementation?: T, + ): Mock; + + export function describe(name: string, fn: () => void): void; + export function it(name: string, fn: () => void | Promise): void; + export function test(name: string, fn: () => void | Promise): void; + export function expect(actual: any): { + toBe(expected: any): void; + toEqual(expected: any): void; + toBeDefined(): void; + toBeUndefined(): void; + toBeNull(): void; + toBeTruthy(): void; + toBeFalsy(): void; + toBeGreaterThan(expected: number): void; + toBeLessThan(expected: number): void; + toContain(expected: any): void; + toHaveLength(expected: number): void; + toHaveBeenCalled(): void; + toHaveBeenCalledTimes(expected: number): void; + toHaveBeenCalledWith(...args: any[]): void; + toThrow(expected?: string | RegExp): void; + resolves: any; + rejects: any; + }; + export function beforeAll(fn: () => void | Promise): void; + export function afterAll(fn: () => void | Promise): void; + export function beforeEach(fn: () => void | Promise): void; + export function afterEach(fn: () => void | Promise): void; + export const mock: { + resetAll(): void; + }; +} diff --git a/src/types/hass.d.ts b/src/types/hass.d.ts index 599f418..052c383 100644 --- a/src/types/hass.d.ts +++ b/src/types/hass.d.ts @@ -1,81 +1,81 @@ declare namespace HomeAssistant { - interface Entity { - entity_id: string; - state: string; - attributes: Record; - last_changed: string; - last_updated: string; - context: { - id: string; - parent_id?: string; - user_id?: string; - }; - } + interface Entity { + entity_id: string; + state: string; + attributes: Record; + last_changed: string; + last_updated: string; + context: { + id: string; + parent_id?: string; + user_id?: string; + }; + } - interface Service { - domain: string; - service: string; - target?: { - entity_id?: string | string[]; - device_id?: string | string[]; - area_id?: string | string[]; - }; - service_data?: Record; - } + interface Service { + domain: string; + service: string; + target?: { + entity_id?: string | string[]; + device_id?: string | string[]; + area_id?: string | string[]; + }; + service_data?: Record; + } - interface WebsocketMessage { - type: string; - id?: number; - [key: string]: any; - } + interface WebsocketMessage { + type: string; + id?: number; + [key: string]: any; + } - interface AuthMessage extends WebsocketMessage { - type: 'auth'; - access_token: string; - } + interface AuthMessage extends WebsocketMessage { + type: "auth"; + access_token: string; + } - interface SubscribeEventsMessage extends WebsocketMessage { - type: 'subscribe_events'; - event_type?: string; - } + interface SubscribeEventsMessage extends WebsocketMessage { + type: "subscribe_events"; + event_type?: string; + } - interface StateChangedEvent { - event_type: 'state_changed'; - data: { - entity_id: string; - new_state: Entity | null; - old_state: Entity | null; - }; - origin: string; - time_fired: string; - context: { - id: string; - parent_id?: string; - user_id?: string; - }; - } + interface StateChangedEvent { + event_type: "state_changed"; + data: { + entity_id: string; + new_state: Entity | null; + old_state: Entity | null; + }; + origin: string; + time_fired: string; + context: { + id: string; + parent_id?: string; + user_id?: string; + }; + } - interface Config { - latitude: number; - longitude: number; - elevation: number; - unit_system: { - length: string; - mass: string; - temperature: string; - volume: string; - }; - location_name: string; - time_zone: string; - components: string[]; - version: string; - } + interface Config { + latitude: number; + longitude: number; + elevation: number; + unit_system: { + length: string; + mass: string; + temperature: string; + volume: string; + }; + location_name: string; + time_zone: string; + components: string[]; + version: string; + } - interface ApiError { - code: string; - message: string; - details?: Record; - } + interface ApiError { + code: string; + message: string; + details?: Record; + } } -export = HomeAssistant; \ No newline at end of file +export = HomeAssistant; diff --git a/src/types/hass.ts b/src/types/hass.ts index 8f78459..429db7a 100644 --- a/src/types/hass.ts +++ b/src/types/hass.ts @@ -1,86 +1,85 @@ export interface AuthMessage { - type: 'auth'; - access_token: string; + type: "auth"; + access_token: string; } export interface ResultMessage { - id: number; - type: 'result'; - success: boolean; - result?: any; + id: number; + type: "result"; + success: boolean; + result?: any; } export interface WebSocketError { - code: string; - message: string; + code: string; + message: string; } export interface Event { - event_type: string; - data: any; - origin: string; - time_fired: string; - context: { - id: string; - parent_id: string | null; - user_id: string | null; - }; + event_type: string; + data: any; + origin: string; + time_fired: string; + context: { + id: string; + parent_id: string | null; + user_id: string | null; + }; } export interface Entity { - entity_id: string; - state: string; - attributes: Record; - last_changed: string; - last_updated: string; - context: { - id: string; - parent_id: string | null; - user_id: string | null; - }; + entity_id: string; + state: string; + attributes: Record; + last_changed: string; + last_updated: string; + context: { + id: string; + parent_id: string | null; + user_id: string | null; + }; } export interface StateChangedEvent extends Event { - event_type: 'state_changed'; - data: { - entity_id: string; - new_state: Entity | null; - old_state: Entity | null; - }; + event_type: "state_changed"; + data: { + entity_id: string; + new_state: Entity | null; + old_state: Entity | null; + }; } export interface HassEntity { - entity_id: string; - state: string; - attributes: Record; - last_changed?: string; - last_updated?: string; - context?: { - id: string; - parent_id?: string; - user_id?: string; - }; + entity_id: string; + state: string; + attributes: Record; + last_changed?: string; + last_updated?: string; + context?: { + id: string; + parent_id?: string; + user_id?: string; + }; } export interface HassState { - entity_id: string; - state: string; - attributes: { - friendly_name?: string; - description?: string; - [key: string]: any; - }; + entity_id: string; + state: string; + attributes: { + friendly_name?: string; + description?: string; + [key: string]: any; + }; } export interface HassEvent { - event_type: string; - data: any; - origin: string; - time_fired: string; - context: { - id: string; - parent_id?: string; - user_id?: string; - }; + event_type: string; + data: any; + origin: string; + time_fired: string; + context: { + id: string; + parent_id?: string; + user_id?: string; + }; } - diff --git a/src/types/index.ts b/src/types/index.ts index 1d1bc73..70fad9b 100644 --- a/src/types/index.ts +++ b/src/types/index.ts @@ -1,18 +1,18 @@ -import { z } from 'zod'; +import { z } from "zod"; /** * Interface for a tool that can be executed by the MCP * @interface Tool */ export interface Tool { - /** Unique name identifier for the tool */ - name: string; - /** Description of what the tool does */ - description: string; - /** Zod schema for validating tool parameters */ - parameters: z.ZodType; - /** Function to execute the tool with the given parameters */ - execute: (params: any) => Promise; + /** Unique name identifier for the tool */ + name: string; + /** Description of what the tool does */ + description: string; + /** Zod schema for validating tool parameters */ + parameters: z.ZodType; + /** Function to execute the tool with the given parameters */ + execute: (params: any) => Promise; } /** @@ -20,26 +20,26 @@ export interface Tool { * @interface CommandParams */ export interface CommandParams { - /** Command to execute (e.g., turn_on, turn_off) */ - command: string; - /** Entity ID to control */ - entity_id: string; - /** Common parameters */ - state?: string; - /** Light parameters */ - brightness?: number; - color_temp?: number; - rgb_color?: [number, number, number]; - /** Cover parameters */ - position?: number; - tilt_position?: number; - /** Climate parameters */ - temperature?: number; - target_temp_high?: number; - target_temp_low?: number; - hvac_mode?: string; - fan_mode?: string; - humidity?: number; + /** Command to execute (e.g., turn_on, turn_off) */ + command: string; + /** Entity ID to control */ + entity_id: string; + /** Common parameters */ + state?: string; + /** Light parameters */ + brightness?: number; + color_temp?: number; + rgb_color?: [number, number, number]; + /** Cover parameters */ + position?: number; + tilt_position?: number; + /** Climate parameters */ + temperature?: number; + target_temp_high?: number; + target_temp_low?: number; + hvac_mode?: string; + fan_mode?: string; + humidity?: number; } /** @@ -47,22 +47,22 @@ export interface CommandParams { * @interface HassEntity */ export interface HassEntity { - /** Entity ID in format domain.name */ - entity_id: string; - /** Current state of the entity */ - state: string; - /** Entity attributes */ - attributes: Record; - /** Last state change timestamp */ - last_changed?: string; - /** Last update timestamp */ - last_updated?: string; - /** Context information */ - context?: { - id: string; - parent_id?: string; - user_id?: string; - }; + /** Entity ID in format domain.name */ + entity_id: string; + /** Current state of the entity */ + state: string; + /** Entity attributes */ + attributes: Record; + /** Last state change timestamp */ + last_changed?: string; + /** Last update timestamp */ + last_updated?: string; + /** Context information */ + context?: { + id: string; + parent_id?: string; + user_id?: string; + }; } /** @@ -70,19 +70,19 @@ export interface HassEntity { * @interface HassState */ export interface HassState { - /** Entity ID in format domain.name */ - entity_id: string; - /** Current state of the entity */ - state: string; - /** Entity attributes */ - attributes: { - /** Human-readable name */ - friendly_name?: string; - /** Entity description */ - description?: string; - /** Additional attributes */ - [key: string]: any; - }; + /** Entity ID in format domain.name */ + entity_id: string; + /** Current state of the entity */ + state: string; + /** Entity attributes */ + attributes: { + /** Human-readable name */ + friendly_name?: string; + /** Entity description */ + description?: string; + /** Additional attributes */ + [key: string]: any; + }; } /** @@ -90,6 +90,41 @@ export interface HassState { * @interface HassAddon */ export interface HassAddon { + /** Add-on name */ + name: string; + /** Add-on slug identifier */ + slug: string; + /** Add-on description */ + description: string; + /** Add-on version */ + version: string; + /** Whether the add-on is installed */ + installed: boolean; + /** Whether the add-on is available */ + available: boolean; + /** Current state of the add-on */ + state: string; +} + +/** + * Response from Home Assistant add-on API + * @interface HassAddonResponse + */ +export interface HassAddonResponse { + /** Response data */ + data: { + /** List of add-ons */ + addons: HassAddon[]; + }; +} + +/** + * Response from Home Assistant add-on info API + * @interface HassAddonInfoResponse + */ +export interface HassAddonInfoResponse { + /** Response data */ + data: { /** Add-on name */ name: string; /** Add-on slug identifier */ @@ -98,50 +133,15 @@ export interface HassAddon { description: string; /** Add-on version */ version: string; - /** Whether the add-on is installed */ - installed: boolean; - /** Whether the add-on is available */ - available: boolean; - /** Current state of the add-on */ + /** Current state */ state: string; -} - -/** - * Response from Home Assistant add-on API - * @interface HassAddonResponse - */ -export interface HassAddonResponse { - /** Response data */ - data: { - /** List of add-ons */ - addons: HassAddon[]; - }; -} - -/** - * Response from Home Assistant add-on info API - * @interface HassAddonInfoResponse - */ -export interface HassAddonInfoResponse { - /** Response data */ - data: { - /** Add-on name */ - name: string; - /** Add-on slug identifier */ - slug: string; - /** Add-on description */ - description: string; - /** Add-on version */ - version: string; - /** Current state */ - state: string; - /** Status information */ - status: string; - /** Add-on options */ - options: Record; - /** Additional properties */ - [key: string]: any; - }; + /** Status information */ + status: string; + /** Add-on options */ + options: Record; + /** Additional properties */ + [key: string]: any; + }; } /** @@ -149,22 +149,22 @@ export interface HassAddonInfoResponse { * @interface HacsRepository */ export interface HacsRepository { - /** Repository name */ - name: string; - /** Repository description */ - description: string; - /** Repository category */ - category: string; - /** Whether the repository is installed */ - installed: boolean; - /** Installed version */ - version_installed: string; - /** Available version */ - available_version: string; - /** Repository authors */ - authors: string[]; - /** Repository domain */ - domain: string; + /** Repository name */ + name: string; + /** Repository description */ + description: string; + /** Repository category */ + category: string; + /** Whether the repository is installed */ + installed: boolean; + /** Installed version */ + version_installed: string; + /** Available version */ + available_version: string; + /** Repository authors */ + authors: string[]; + /** Repository domain */ + domain: string; } /** @@ -172,8 +172,8 @@ export interface HacsRepository { * @interface HacsResponse */ export interface HacsResponse { - /** List of repositories */ - repositories: HacsRepository[]; + /** List of repositories */ + repositories: HacsRepository[]; } /** @@ -181,18 +181,18 @@ export interface HacsResponse { * @interface AutomationConfig */ export interface AutomationConfig { - /** Automation name */ - alias: string; - /** Automation description */ - description?: string; - /** How multiple triggers are handled */ - mode?: 'single' | 'parallel' | 'queued' | 'restart'; - /** List of triggers */ - trigger: any[]; - /** List of conditions */ - condition?: any[]; - /** List of actions */ - action: any[]; + /** Automation name */ + alias: string; + /** Automation description */ + description?: string; + /** How multiple triggers are handled */ + mode?: "single" | "parallel" | "queued" | "restart"; + /** List of triggers */ + trigger: any[]; + /** List of conditions */ + condition?: any[]; + /** List of actions */ + action: any[]; } /** @@ -200,8 +200,8 @@ export interface AutomationConfig { * @interface AutomationResponse */ export interface AutomationResponse { - /** Created/updated automation ID */ - automation_id: string; + /** Created/updated automation ID */ + automation_id: string; } /** @@ -209,8 +209,8 @@ export interface AutomationResponse { * @interface SSEHeaders */ export interface SSEHeaders { - /** Callback for connection abort */ - onAbort?: () => void; + /** Callback for connection abort */ + onAbort?: () => void; } /** @@ -218,14 +218,14 @@ export interface SSEHeaders { * @interface SSEParams */ export interface SSEParams { - /** Authentication token */ - token: string; - /** Event types to subscribe to */ - events?: string[]; - /** Entity ID to monitor */ - entity_id?: string; - /** Domain to monitor */ - domain?: string; + /** Authentication token */ + token: string; + /** Event types to subscribe to */ + events?: string[]; + /** Entity ID to monitor */ + entity_id?: string; + /** Domain to monitor */ + domain?: string; } /** @@ -233,16 +233,16 @@ export interface SSEParams { * @interface HistoryParams */ export interface HistoryParams { - /** Entity ID to get history for */ - entity_id: string; - /** Start time in ISO format */ - start_time?: string; - /** End time in ISO format */ - end_time?: string; - /** Whether to return minimal response */ - minimal_response?: boolean; - /** Whether to only return significant changes */ - significant_changes_only?: boolean; + /** Entity ID to get history for */ + entity_id: string; + /** Start time in ISO format */ + start_time?: string; + /** End time in ISO format */ + end_time?: string; + /** Whether to return minimal response */ + minimal_response?: boolean; + /** Whether to only return significant changes */ + significant_changes_only?: boolean; } /** @@ -250,10 +250,10 @@ export interface HistoryParams { * @interface SceneParams */ export interface SceneParams { - /** Action to perform */ - action: 'list' | 'activate'; - /** Scene ID for activation */ - scene_id?: string; + /** Action to perform */ + action: "list" | "activate"; + /** Scene ID for activation */ + scene_id?: string; } /** @@ -261,14 +261,14 @@ export interface SceneParams { * @interface NotifyParams */ export interface NotifyParams { - /** Notification message */ - message: string; - /** Notification title */ - title?: string; - /** Notification target */ - target?: string; - /** Additional notification data */ - data?: Record; + /** Notification message */ + message: string; + /** Notification title */ + title?: string; + /** Notification target */ + target?: string; + /** Additional notification data */ + data?: Record; } /** @@ -276,10 +276,10 @@ export interface NotifyParams { * @interface AutomationParams */ export interface AutomationParams { - /** Action to perform */ - action: 'list' | 'toggle' | 'trigger'; - /** Automation ID */ - automation_id?: string; + /** Action to perform */ + action: "list" | "toggle" | "trigger"; + /** Automation ID */ + automation_id?: string; } /** @@ -287,12 +287,19 @@ export interface AutomationParams { * @interface AddonParams */ export interface AddonParams { - /** Action to perform */ - action: 'list' | 'info' | 'install' | 'uninstall' | 'start' | 'stop' | 'restart'; - /** Add-on slug */ - slug?: string; - /** Version to install */ - version?: string; + /** Action to perform */ + action: + | "list" + | "info" + | "install" + | "uninstall" + | "start" + | "stop" + | "restart"; + /** Add-on slug */ + slug?: string; + /** Version to install */ + version?: string; } /** @@ -300,14 +307,20 @@ export interface AddonParams { * @interface PackageParams */ export interface PackageParams { - /** Action to perform */ - action: 'list' | 'install' | 'uninstall' | 'update'; - /** Package category */ - category: 'integration' | 'plugin' | 'theme' | 'python_script' | 'appdaemon' | 'netdaemon'; - /** Repository URL or name */ - repository?: string; - /** Version to install */ - version?: string; + /** Action to perform */ + action: "list" | "install" | "uninstall" | "update"; + /** Package category */ + category: + | "integration" + | "plugin" + | "theme" + | "python_script" + | "appdaemon" + | "netdaemon"; + /** Repository URL or name */ + repository?: string; + /** Version to install */ + version?: string; } /** @@ -315,23 +328,23 @@ export interface PackageParams { * @interface AutomationConfigParams */ export interface AutomationConfigParams { - /** Action to perform */ - action: 'create' | 'update' | 'delete' | 'duplicate'; - /** Automation ID */ - automation_id?: string; - /** Automation configuration */ - config?: { - /** Automation name */ - alias: string; - /** Automation description */ - description?: string; - /** How multiple triggers are handled */ - mode?: 'single' | 'parallel' | 'queued' | 'restart'; - /** List of triggers */ - trigger: any[]; - /** List of conditions */ - condition?: any[]; - /** List of actions */ - action: any[]; - }; -} \ No newline at end of file + /** Action to perform */ + action: "create" | "update" | "delete" | "duplicate"; + /** Automation ID */ + automation_id?: string; + /** Automation configuration */ + config?: { + /** Automation name */ + alias: string; + /** Automation description */ + description?: string; + /** How multiple triggers are handled */ + mode?: "single" | "parallel" | "queued" | "restart"; + /** List of triggers */ + trigger: any[]; + /** List of conditions */ + condition?: any[]; + /** List of actions */ + action: any[]; + }; +} diff --git a/src/utils/log-rotation.ts b/src/utils/log-rotation.ts index 781ae45..51a1f25 100644 --- a/src/utils/log-rotation.ts +++ b/src/utils/log-rotation.ts @@ -1,20 +1,20 @@ /** * Log Rotation Utility - * + * * This module provides functionality for managing log file rotation and cleanup. * It handles log file archiving, compression, and deletion based on configuration. - * + * * @module log-rotation */ -import fs from 'fs/promises'; -import path from 'path'; -import { glob } from 'glob'; -import { logger } from './logger.js'; -import { APP_CONFIG } from '../config/app.config.js'; -import { unlink } from 'fs/promises'; -import { join } from 'path'; -import { promisify } from 'util'; +import fs from "fs/promises"; +import path from "path"; +import { glob } from "glob"; +import { logger } from "./logger.js"; +import { APP_CONFIG } from "../config/app.config.js"; +import { unlink } from "fs/promises"; +import { join } from "path"; +import { promisify } from "util"; const globPromise = promisify(glob); @@ -22,10 +22,10 @@ const globPromise = promisify(glob); * Interface for log file information */ interface LogFileInfo { - path: string; - filename: string; - date: Date; - size: number; + path: string; + filename: string; + date: Date; + size: number; } /** @@ -34,18 +34,18 @@ interface LogFileInfo { * @returns Size in bytes */ const parseSize = (size: string): number => { - const units = { - b: 1, - k: 1024, - m: 1024 * 1024, - g: 1024 * 1024 * 1024, - }; - const match = size.toLowerCase().match(/^(\d+)([bkmg])$/); - if (!match) { - throw new Error(`Invalid size format: ${size}`); - } - const [, value, unit] = match; - return parseInt(value) * units[unit as keyof typeof units]; + const units = { + b: 1, + k: 1024, + m: 1024 * 1024, + g: 1024 * 1024 * 1024, + }; + const match = size.toLowerCase().match(/^(\d+)([bkmg])$/); + if (!match) { + throw new Error(`Invalid size format: ${size}`); + } + const [, value, unit] = match; + return parseInt(value) * units[unit as keyof typeof units]; }; /** @@ -54,17 +54,17 @@ const parseSize = (size: string): number => { * @returns Duration in days */ const parseDuration = (duration: string): number => { - const units = { - d: 1, - w: 7, - m: 30, - }; - const match = duration.toLowerCase().match(/^(\d+)([dwm])$/); - if (!match) { - throw new Error(`Invalid duration format: ${duration}`); - } - const [, value, unit] = match; - return parseInt(value) * units[unit as keyof typeof units]; + const units = { + d: 1, + w: 7, + m: 30, + }; + const match = duration.toLowerCase().match(/^(\d+)([dwm])$/); + if (!match) { + throw new Error(`Invalid duration format: ${duration}`); + } + const [, value, unit] = match; + return parseInt(value) * units[unit as keyof typeof units]; }; /** @@ -72,72 +72,75 @@ const parseDuration = (duration: string): number => { * @returns Array of log file information */ const getLogFiles = async (): Promise => { - const logDir = APP_CONFIG.LOGGING.DIR; - const files: string[] = await glob('*.log*', { cwd: logDir }); + const logDir = APP_CONFIG.LOGGING.DIR; + const files: string[] = await glob("*.log*", { cwd: logDir }); - const fileInfos: LogFileInfo[] = []; - for (const file of files) { - const filePath = path.join(logDir, file); - const stats = await fs.stat(filePath); - const dateMatch = file.match(/\d{4}-\d{2}-\d{2}/); + const fileInfos: LogFileInfo[] = []; + for (const file of files) { + const filePath = path.join(logDir, file); + const stats = await fs.stat(filePath); + const dateMatch = file.match(/\d{4}-\d{2}-\d{2}/); - if (dateMatch) { - fileInfos.push({ - path: filePath, - filename: file, - date: new Date(dateMatch[0]), - size: stats.size, - }); - } + if (dateMatch) { + fileInfos.push({ + path: filePath, + filename: file, + date: new Date(dateMatch[0]), + size: stats.size, + }); } + } - return fileInfos; + return fileInfos; }; /** * Clean up old log files */ -export async function cleanupOldLogs(logDir: string, maxDays: number): Promise { - try { - const files: string[] = await glob('*.log*', { cwd: logDir }); +export async function cleanupOldLogs( + logDir: string, + maxDays: number, +): Promise { + try { + const files: string[] = await glob("*.log*", { cwd: logDir }); - const now = Date.now(); - const maxAge = maxDays * 24 * 60 * 60 * 1000; + const now = Date.now(); + const maxAge = maxDays * 24 * 60 * 60 * 1000; - for (const file of files) { - const filePath = join(logDir, file); - const stats = await fs.stat(filePath); - const dateMatch = file.match(/\d{4}-\d{2}-\d{2}/); + for (const file of files) { + const filePath = join(logDir, file); + const stats = await fs.stat(filePath); + const dateMatch = file.match(/\d{4}-\d{2}-\d{2}/); - if (dateMatch && stats.ctimeMs < now - maxAge) { - await unlink(filePath); - logger.debug(`Deleted old log file: ${file}`); - } - } - } catch (error) { - logger.error('Error cleaning up old logs:', error); + if (dateMatch && stats.ctimeMs < now - maxAge) { + await unlink(filePath); + logger.debug(`Deleted old log file: ${file}`); + } } + } catch (error) { + logger.error("Error cleaning up old logs:", error); + } } /** * Check and rotate log files based on size */ const checkLogSize = async (): Promise => { - try { - const maxSize = parseSize(APP_CONFIG.LOGGING.MAX_SIZE); - const files = await getLogFiles(); + try { + const maxSize = parseSize(APP_CONFIG.LOGGING.MAX_SIZE); + const files = await getLogFiles(); - for (const file of files) { - if (file.size > maxSize && !file.filename.endsWith('.gz')) { - // Current log file is handled by winston-daily-rotate-file - if (!file.filename.includes(new Date().toISOString().split('T')[0])) { - logger.debug(`Log file exceeds max size: ${file.filename}`); - } - } + for (const file of files) { + if (file.size > maxSize && !file.filename.endsWith(".gz")) { + // Current log file is handled by winston-daily-rotate-file + if (!file.filename.includes(new Date().toISOString().split("T")[0])) { + logger.debug(`Log file exceeds max size: ${file.filename}`); } - } catch (error) { - logger.error('Error checking log sizes:', error); + } } + } catch (error) { + logger.error("Error checking log sizes:", error); + } }; /** @@ -145,31 +148,41 @@ const checkLogSize = async (): Promise => { * Sets up periodic checks for log rotation and cleanup */ export const initLogRotation = (): void => { - // Check log sizes every hour - setInterval(() => { - checkLogSize().catch(error => { - logger.error('Error checking log sizes:', error); - }); - }, 60 * 60 * 1000); + // Check log sizes every hour + setInterval( + () => { + checkLogSize().catch((error) => { + logger.error("Error checking log sizes:", error); + }); + }, + 60 * 60 * 1000, + ); - // Clean up old logs daily - setInterval(() => { - cleanupOldLogs(APP_CONFIG.LOGGING.DIR, parseDuration(APP_CONFIG.LOGGING.MAX_DAYS)) - .catch(error => { - logger.error('Error cleaning up old logs:', error); - }); - }, 24 * 60 * 60 * 1000); + // Clean up old logs daily + setInterval( + () => { + cleanupOldLogs( + APP_CONFIG.LOGGING.DIR, + parseDuration(APP_CONFIG.LOGGING.MAX_DAYS), + ).catch((error) => { + logger.error("Error cleaning up old logs:", error); + }); + }, + 24 * 60 * 60 * 1000, + ); - // Initial check - checkLogSize().catch(error => { - logger.error('Error in initial log size check:', error); - }); + // Initial check + checkLogSize().catch((error) => { + logger.error("Error in initial log size check:", error); + }); - // Initial cleanup - cleanupOldLogs(APP_CONFIG.LOGGING.DIR, parseDuration(APP_CONFIG.LOGGING.MAX_DAYS)) - .catch(error => { - logger.error('Error in initial log cleanup:', error); - }); + // Initial cleanup + cleanupOldLogs( + APP_CONFIG.LOGGING.DIR, + parseDuration(APP_CONFIG.LOGGING.MAX_DAYS), + ).catch((error) => { + logger.error("Error in initial log cleanup:", error); + }); - logger.info('Log rotation initialized'); -}; \ No newline at end of file + logger.info("Log rotation initialized"); +}; diff --git a/src/utils/logger.ts b/src/utils/logger.ts index 155e974..5c8d7e7 100644 --- a/src/utils/logger.ts +++ b/src/utils/logger.ts @@ -1,26 +1,26 @@ /** * Logging Module - * + * * This module provides logging functionality with rotation support. * It uses winston for logging and winston-daily-rotate-file for rotation. - * + * * @module logger */ -import winston from 'winston'; -import DailyRotateFile from 'winston-daily-rotate-file'; -import { APP_CONFIG } from '../config/app.config.js'; +import winston from "winston"; +import DailyRotateFile from "winston-daily-rotate-file"; +import { APP_CONFIG } from "../config/app.config.js"; /** * Log levels configuration * Defines the severity levels for logging */ const levels = { - error: 0, - warn: 1, - info: 2, - http: 3, - debug: 4, + error: 0, + warn: 1, + info: 2, + http: 3, + debug: 4, }; /** @@ -28,11 +28,11 @@ const levels = { * Defines colors for different log levels */ const colors = { - error: 'red', - warn: 'yellow', - info: 'green', - http: 'magenta', - debug: 'white', + error: "red", + warn: "yellow", + info: "green", + http: "magenta", + debug: "white", }; /** @@ -45,11 +45,11 @@ winston.addColors(colors); * Defines how log messages are formatted */ const format = winston.format.combine( - winston.format.timestamp({ format: 'YYYY-MM-DD HH:mm:ss:ms' }), - winston.format.colorize({ all: true }), - winston.format.printf( - (info) => `${info.timestamp} ${info.level}: ${info.message}`, - ), + winston.format.timestamp({ format: "YYYY-MM-DD HH:mm:ss:ms" }), + winston.format.colorize({ all: true }), + winston.format.printf( + (info) => `${info.timestamp} ${info.level}: ${info.message}`, + ), ); /** @@ -57,16 +57,16 @@ const format = winston.format.combine( * Configures how logs are rotated and stored */ const dailyRotateFileTransport = new DailyRotateFile({ - filename: 'logs/%DATE%.log', - datePattern: 'YYYY-MM-DD', - zippedArchive: true, - maxSize: '20m', - maxFiles: '14d', - format: winston.format.combine( - winston.format.uncolorize(), - winston.format.timestamp(), - winston.format.json() - ) + filename: "logs/%DATE%.log", + datePattern: "YYYY-MM-DD", + zippedArchive: true, + maxSize: "20m", + maxFiles: "14d", + format: winston.format.combine( + winston.format.uncolorize(), + winston.format.timestamp(), + winston.format.json(), + ), }); /** @@ -74,39 +74,39 @@ const dailyRotateFileTransport = new DailyRotateFile({ * Stores error logs in a separate file */ const errorFileTransport = new DailyRotateFile({ - filename: 'logs/error-%DATE%.log', - datePattern: 'YYYY-MM-DD', - level: 'error', - zippedArchive: true, - maxSize: '20m', - maxFiles: '14d', - format: winston.format.combine( - winston.format.uncolorize(), - winston.format.timestamp(), - winston.format.json() - ) + filename: "logs/error-%DATE%.log", + datePattern: "YYYY-MM-DD", + level: "error", + zippedArchive: true, + maxSize: "20m", + maxFiles: "14d", + format: winston.format.combine( + winston.format.uncolorize(), + winston.format.timestamp(), + winston.format.json(), + ), }); /** * Create the logger instance */ const logger = winston.createLogger({ - level: APP_CONFIG.NODE_ENV === 'development' ? 'debug' : 'info', - levels, - format, - transports: [ - new winston.transports.Console({ - format: winston.format.combine( - winston.format.colorize(), - winston.format.simple() - ) - }), - dailyRotateFileTransport, - errorFileTransport - ], + level: APP_CONFIG.NODE_ENV === "development" ? "debug" : "info", + levels, + format, + transports: [ + new winston.transports.Console({ + format: winston.format.combine( + winston.format.colorize(), + winston.format.simple(), + ), + }), + dailyRotateFileTransport, + errorFileTransport, + ], }); /** * Export the logger instance */ -export { logger }; \ No newline at end of file +export { logger }; diff --git a/src/websocket/client.ts b/src/websocket/client.ts index aeae663..94b53ea 100644 --- a/src/websocket/client.ts +++ b/src/websocket/client.ts @@ -1,174 +1,183 @@ -import WebSocket from 'ws'; -import { EventEmitter } from 'events'; +import WebSocket from "ws"; +import { EventEmitter } from "events"; export class HassWebSocketClient extends EventEmitter { - private ws: WebSocket | null = null; - private messageId = 1; - private authenticated = false; - private reconnectAttempts = 0; - private maxReconnectAttempts = 5; - private reconnectDelay = 1000; - private subscriptions = new Map void>(); + private ws: WebSocket | null = null; + private messageId = 1; + private authenticated = false; + private reconnectAttempts = 0; + private maxReconnectAttempts = 5; + private reconnectDelay = 1000; + private subscriptions = new Map void>(); - constructor( - private url: string, - private token: string, - private options: { - autoReconnect?: boolean; - maxReconnectAttempts?: number; - reconnectDelay?: number; - } = {} + constructor( + private url: string, + private token: string, + private options: { + autoReconnect?: boolean; + maxReconnectAttempts?: number; + reconnectDelay?: number; + } = {}, + ) { + super(); + this.maxReconnectAttempts = options.maxReconnectAttempts || 5; + this.reconnectDelay = options.reconnectDelay || 1000; + } + + public async connect(): Promise { + return new Promise((resolve, reject) => { + try { + this.ws = new WebSocket(this.url); + + this.ws.on("open", () => { + this.authenticate(); + }); + + this.ws.on("message", (data: string) => { + const message = JSON.parse(data); + this.handleMessage(message); + }); + + this.ws.on("close", () => { + this.handleDisconnect(); + }); + + this.ws.on("error", (error) => { + this.emit("error", error); + reject(error); + }); + + this.once("auth_ok", () => { + this.authenticated = true; + this.reconnectAttempts = 0; + resolve(); + }); + + this.once("auth_invalid", () => { + reject(new Error("Authentication failed")); + }); + } catch (error) { + reject(error); + } + }); + } + + private authenticate(): void { + this.send({ + type: "auth", + access_token: this.token, + }); + } + + private handleMessage(message: any): void { + switch (message.type) { + case "auth_required": + this.authenticate(); + break; + case "auth_ok": + this.emit("auth_ok"); + break; + case "auth_invalid": + this.emit("auth_invalid"); + break; + case "event": + this.handleEvent(message); + break; + case "result": + this.emit(`result_${message.id}`, message); + break; + } + } + + private handleEvent(message: any): void { + const subscription = this.subscriptions.get(message.event.event_type); + if (subscription) { + subscription(message.event.data); + } + this.emit("event", message.event); + } + + private handleDisconnect(): void { + this.authenticated = false; + this.emit("disconnected"); + + if ( + this.options.autoReconnect && + this.reconnectAttempts < this.maxReconnectAttempts ) { - super(); - this.maxReconnectAttempts = options.maxReconnectAttempts || 5; - this.reconnectDelay = options.reconnectDelay || 1000; + setTimeout( + () => { + this.reconnectAttempts++; + this.connect().catch((error) => { + this.emit("error", error); + }); + }, + this.reconnectDelay * Math.pow(2, this.reconnectAttempts), + ); + } + } + + public async subscribeEvents( + eventType: string, + callback: (data: any) => void, + ): Promise { + if (!this.authenticated) { + throw new Error("Not authenticated"); } - public async connect(): Promise { - return new Promise((resolve, reject) => { - try { - this.ws = new WebSocket(this.url); + const id = this.messageId++; + this.subscriptions.set(eventType, callback); - this.ws.on('open', () => { - this.authenticate(); - }); + return new Promise((resolve, reject) => { + this.send({ + id, + type: "subscribe_events", + event_type: eventType, + }); - this.ws.on('message', (data: string) => { - const message = JSON.parse(data); - this.handleMessage(message); - }); - - this.ws.on('close', () => { - this.handleDisconnect(); - }); - - this.ws.on('error', (error) => { - this.emit('error', error); - reject(error); - }); - - this.once('auth_ok', () => { - this.authenticated = true; - this.reconnectAttempts = 0; - resolve(); - }); - - this.once('auth_invalid', () => { - reject(new Error('Authentication failed')); - }); - } catch (error) { - reject(error); - } - }); - } - - private authenticate(): void { - this.send({ - type: 'auth', - access_token: this.token - }); - } - - private handleMessage(message: any): void { - switch (message.type) { - case 'auth_required': - this.authenticate(); - break; - case 'auth_ok': - this.emit('auth_ok'); - break; - case 'auth_invalid': - this.emit('auth_invalid'); - break; - case 'event': - this.handleEvent(message); - break; - case 'result': - this.emit(`result_${message.id}`, message); - break; + this.once(`result_${id}`, (message) => { + if (message.success) { + resolve(id); + } else { + reject(new Error(message.error?.message || "Subscription failed")); } + }); + }); + } + + public async unsubscribeEvents(subscription: number): Promise { + if (!this.authenticated) { + throw new Error("Not authenticated"); } - private handleEvent(message: any): void { - const subscription = this.subscriptions.get(message.event.event_type); - if (subscription) { - subscription(message.event.data); + const id = this.messageId++; + return new Promise((resolve, reject) => { + this.send({ + id, + type: "unsubscribe_events", + subscription, + }); + + this.once(`result_${id}`, (message) => { + if (message.success) { + resolve(); + } else { + reject(new Error(message.error?.message || "Unsubscribe failed")); } - this.emit('event', message.event); + }); + }); + } + + private send(message: any): void { + if (this.ws?.readyState === WebSocket.OPEN) { + this.ws.send(JSON.stringify(message)); } + } - private handleDisconnect(): void { - this.authenticated = false; - this.emit('disconnected'); - - if (this.options.autoReconnect && this.reconnectAttempts < this.maxReconnectAttempts) { - setTimeout(() => { - this.reconnectAttempts++; - this.connect().catch((error) => { - this.emit('error', error); - }); - }, this.reconnectDelay * Math.pow(2, this.reconnectAttempts)); - } + public disconnect(): void { + if (this.ws) { + this.ws.close(); + this.ws = null; } - - public async subscribeEvents(eventType: string, callback: (data: any) => void): Promise { - if (!this.authenticated) { - throw new Error('Not authenticated'); - } - - const id = this.messageId++; - this.subscriptions.set(eventType, callback); - - return new Promise((resolve, reject) => { - this.send({ - id, - type: 'subscribe_events', - event_type: eventType - }); - - this.once(`result_${id}`, (message) => { - if (message.success) { - resolve(id); - } else { - reject(new Error(message.error?.message || 'Subscription failed')); - } - }); - }); - } - - public async unsubscribeEvents(subscription: number): Promise { - if (!this.authenticated) { - throw new Error('Not authenticated'); - } - - const id = this.messageId++; - return new Promise((resolve, reject) => { - this.send({ - id, - type: 'unsubscribe_events', - subscription - }); - - this.once(`result_${id}`, (message) => { - if (message.success) { - resolve(); - } else { - reject(new Error(message.error?.message || 'Unsubscribe failed')); - } - }); - }); - } - - private send(message: any): void { - if (this.ws?.readyState === WebSocket.OPEN) { - this.ws.send(JSON.stringify(message)); - } - } - - public disconnect(): void { - if (this.ws) { - this.ws.close(); - this.ws = null; - } - } -} \ No newline at end of file + } +} diff --git a/tsconfig.json b/tsconfig.json index 33d711a..3f7c712 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -1,9 +1,9 @@ { "compilerOptions": { "target": "ES2022", - "module": "ESNext", - "moduleResolution": "node", - "outDir": "./dist", + "module": "NodeNext", + "moduleResolution": "NodeNext", + "outDir": "dist", "rootDir": ".", "strict": true, "esModuleInterop": true, @@ -16,8 +16,6 @@ "experimentalDecorators": true, "emitDecoratorMetadata": true, "types": [ - "node", - "jest", "bun-types" ], "typeRoots": [ @@ -28,11 +26,8 @@ ], "baseUrl": ".", "paths": { - "@src/*": [ - "src/*" - ], - "@tests/*": [ - "__tests__/*" + "*": [ + "node_modules/*" ] } },