Compare commits

..

45 Commits
bun ... v0.1.3

Author SHA1 Message Date
jango-blockchained
905339fb67 refactor(docker): switch to Node.js base image and optimize Bun installation
- Replace Bun base image with Node.js slim image
- Install Bun globally using npm in both builder and runner stages
- Simplify Docker build process and dependency management
- Remove unnecessary environment variables and build flags
- Update docker-build.sh to use BuildKit and remove lockfile before build
2025-02-04 20:18:46 +01:00
jango-blockchained
849b080aba chore: update project dependencies and build configuration
- Remove bun.lockb from version control
- Add comprehensive docker-build.sh script for optimized Docker builds
- Update Dockerfile with multi-stage build and improved resource management
- Add winston logging dependencies to package.json
- Enhance Docker image build process with resource constraints and caching
2025-02-04 20:14:13 +01:00
jango-blockchained
f8bbe4af6f refactor(docker): optimize Dockerfiles for multi-stage builds and production deployment
- Implement multi-stage builds for main and speech Dockerfiles
- Reduce image size by using slim base images
- Improve dependency installation with frozen lockfile and production flags
- Add resource constraints and healthcheck to speech service Dockerfile
- Enhance build caching and separation of build/runtime dependencies
2025-02-04 19:41:23 +01:00
jango-blockchained
3a6f79c9a8 feat(speech): enhance speech configuration and example integration
- Add comprehensive speech configuration in .env.example and app config
- Update Docker speech Dockerfile for more flexible model handling
- Create detailed README for speech-to-text examples
- Implement example script demonstrating speech features
- Improve speech service initialization and configuration management
2025-02-04 19:35:50 +01:00
jango-blockchained
60f18f8e71 feat(speech): add speech-to-text and wake word detection modules
- Implement SpeechToText class with Docker-based transcription capabilities
- Add wake word detection using OpenWakeWord and fast-whisper models
- Create Dockerfile for speech processing container
- Develop comprehensive test suite for speech recognition functionality
- Include audio processing and event-driven transcription features
2025-02-04 19:08:01 +01:00
jango-blockchained
47f11b3d95 docs: update README.md 2025-02-04 18:35:17 +01:00
jango-blockchained
f24be8ff53 docs: remove outdated support and rate limiting sections from README 2025-02-04 18:31:39 +01:00
jango-blockchained
dfff432321 docs: update Jekyll configuration for GitHub Pages and dependencies
- Add repository settings and GitHub metadata plugin
- Update baseurl to match repository name
- Include additional Jekyll and Ruby dependencies in Gemfile
- Simplify configuration by removing redundant sections
2025-02-04 18:00:59 +01:00
jango-blockchained
d59bf02d08 docs: enhance Jekyll configuration with comprehensive site settings
- Add base URL and site configuration for GitHub Pages
- Include remote theme and additional Jekyll plugins
- Configure navigation structure and page layouts
- Set up collections for tools and development sections
- Optimize Gemfile with additional dependencies
2025-02-04 17:58:10 +01:00
jango-blockchained
345a5888d9 docs: update Jekyll configuration for enhanced documentation structure
- Add new documentation pages to header navigation
- Configure collections for tools and development sections
- Set default layouts for pages, tools, and development collections
- Improve documentation site organization and navigation
2025-02-04 17:51:04 +01:00
jango-blockchained
d6a5771e01 docs: enhance project documentation with comprehensive updates
- Revamp README.md with improved project overview, architecture diagram, and badges
- Create new development and tools documentation with detailed guides
- Update API documentation with enhanced examples, rate limiting, and security information
- Refactor and consolidate documentation files for better navigation and clarity
- Add emojis and visual improvements to make documentation more engaging
2025-02-04 17:49:58 +01:00
jango-blockchained
5f4ddfbd88 docs: add GitHub Pages documentation deployment workflow
- Create GitHub Actions workflow for deploying documentation to GitHub Pages
- Update README.md with documentation badge and link
- Add missing gem dependency in docs/Gemfile
- Configure Jekyll build and deployment process
2025-02-04 17:37:20 +01:00
jango-blockchained
c11b40da9e docs: standardize documentation file paths and references
- Update README.md documentation links to use lowercase, consistent file paths
- Remove "(if available)" annotations from documentation references
- Ensure all documentation links point to correct, lowercase markdown files
2025-02-04 17:34:31 +01:00
jango-blockchained
3a54766b61 docs: refactor and improve documentation across multiple files
- Streamline and enhance documentation for API, architecture, getting started, and usage
- Improve clarity, readability, and organization of documentation files
- Update content to be more concise and informative
- Ensure consistent formatting and style across documentation
2025-02-04 17:33:26 +01:00
jango-blockchained
8b1948ce30 docs: enhance documentation structure and add project roadmap
- Refactor index.md with improved navigation and comprehensive documentation sections
- Update README.md to streamline documentation navigation
- Create new roadmap.md with detailed project goals and vision
- Add testing.md with comprehensive testing guidelines and best practices
- Improve overall documentation clarity and user experience
2025-02-04 17:25:32 +01:00
jango-blockchained
38ee5368d1 docs: update acronym
- Rename MCP acronym in documentation and package files
- Update site name, package description, and documentation references
- Ensure consistent terminology across project files
2025-02-04 17:19:58 +01:00
jango-blockchained
b0ad1cf0ad docs: add comprehensive documentation for MCP project
- Create comprehensive documentation structure using MkDocs
- Add markdown files for API reference, architecture, getting started, and troubleshooting
- Configure GitHub Pages deployment workflow
- Include custom Jekyll and MkDocs configurations
- Add custom styling and layout for documentation site
2025-02-04 17:14:39 +01:00
jango-blockchained
d6bb83685d chore: upgrade GitHub Actions Docker workflow dependencies
- Update GitHub Actions workflow to use latest versions of checkout, login, metadata, and build-push actions
- Bump action versions from v2/v3/v4 to v3/v4/v5 for improved compatibility and features
2025-02-04 15:11:36 +01:00
jango-blockchained
54112c9059 chore: manage bun.lockb in Docker and project configuration
- Update .dockerignore to exclude bun.lockb
- Modify .gitignore to track bun.lockb
- Update Dockerfile to remove bun.lockb copy step
- Add bun.lockb binary lockfile to the repository
2025-02-04 15:08:15 +01:00
jango-blockchained
1f79feeccc chore: update GitHub Actions workflow permissions
- Expand workflow permissions to include write access for contents and pull requests
- Ensure comprehensive access for automated CI/CD processes
2025-02-04 15:02:39 +01:00
jango-blockchained
63fd21053c chore: update GitHub Actions workflow for automated versioning and release management
- Replace manual version detection with GitHub Tag Action
- Implement automatic version bumping and tagging
- Add GitHub Release creation with changelog generation
- Simplify Docker image tagging using new version workflow
2025-02-04 15:00:40 +01:00
jango-blockchained
5f078ff227 docs: update environment variable naming from NODE_ENV to BUN_ENV 2025-02-04 14:56:22 +01:00
jango-blockchained
5d0c2f54a2 chore: remove bun.lockb from .dockerignore 2025-02-04 14:23:12 +01:00
jango-blockchained
02284c787b docs: add contributing guidelines and project roadmap
- Create CONTRIBUTING.md with comprehensive guidelines for community contributions
- Develop ROADMAP.md outlining near-term, mid-term, and long-term project goals
- Provide clear instructions for code style, testing, and community engagement
- Define project vision and future enhancement strategies
2025-02-04 04:28:26 +01:00
jango-blockchained
3e97357561 docs: update documentation to use Bun commands and scripts
- Replace npm commands with equivalent Bun commands in GETTING_STARTED.md
- Update TESTING.md to reflect Bun-specific test and development scripts
- Simplify installation, development, and testing instructions
2025-02-04 04:17:58 +01:00
jango-blockchained
cb897d4cf6 docs: add comprehensive architecture documentation for MCP Server
- Create ARCHITECTURE.md with detailed system design overview
- Describe key architectural components including Bun runtime, SSE communication, and modular design
- Highlight security, performance, and scalability features
- Outline future enhancement roadmap
- Provide insights into system design principles and technology choices
2025-02-04 04:14:43 +01:00
jango-blockchained
08e408d68d test: enhance security module with comprehensive token validation and rate limiting tests
- Expanded TokenManager test suite with advanced token encryption and decryption scenarios
- Added detailed rate limiting tests with IP-based tracking and window-based expiration
- Improved test coverage for token validation, tampering detection, and error handling
- Implemented mock configurations for faster test execution
- Enhanced security test scenarios with unique IP addresses and edge case handling
2025-02-04 04:09:40 +01:00
jango-blockchained
1e3bf07547 chore: update TypeScript configuration for enhanced type support and Bun compatibility
- Switch moduleResolution to "bundler" for improved module handling
- Add type definitions for Node.js, WebSocket, JWT, and sanitize-html
- Enable experimental decorators and decorator metadata
- Expand include paths to support additional type definition files
- Maintain existing project structure and path aliases
2025-02-04 03:33:08 +01:00
jango-blockchained
e503da1dfd chore: optimize Bun and TypeScript configuration for improved development workflow
- Update bunfig.toml with environment-specific settings and performance optimizations
- Enhance package.json scripts with additional development and maintenance commands
- Refactor tsconfig.json for better Bun and TypeScript compatibility
- Add hot reloading, profiling, and type checking configurations
- Improve build and development scripts with minification and frozen lockfile options
2025-02-04 03:25:46 +01:00
jango-blockchained
790a37e49f refactor: migrate to Elysia and enhance security middleware
- Replaced Express with Elysia for improved performance and type safety
- Integrated Elysia middleware for rate limiting, security headers, and request validation
- Refactored security utilities to work with Elysia's context and request handling
- Updated token management and validation logic
- Added comprehensive security headers and input sanitization
- Simplified server initialization and error handling
- Updated documentation with new setup and configuration details
2025-02-04 03:09:35 +01:00
jango-blockchained
bc1dc8278a refactor: optimize configuration and tool implementations
- Standardized error handling across tool implementations
- Improved return type consistency for tool execution results
- Simplified configuration parsing and type definitions
- Enhanced type safety for various configuration schemas
- Cleaned up and normalized tool response structures
- Updated SSE and event subscription tool implementations
2025-02-04 00:56:45 +01:00
jango-blockchained
9a02bdaf11 feat: add Bun polyfills and refactor LiteMCP implementation
- Introduced polyfills for Node.js compatibility in Bun runtime
- Moved LiteMCP implementation to a dedicated module
- Updated package.json to include @digital-alchemy/hass dependency
- Refactored import for LiteMCP to use local module path
2025-02-03 22:55:36 +01:00
jango-blockchained
04123a5740 test: enhance security middleware and token validation tests
- Refactored security middleware tests with improved type safety and mock configurations
- Updated token validation tests with more precise token generation and expiration scenarios
- Improved input sanitization and request validation test coverage
- Added comprehensive test cases for error handling and security header configurations
- Enhanced test setup with better environment and secret management
2025-02-03 22:52:18 +01:00
jango-blockchained
e688c94718 chore: remove .cursor directory from git tracking 2025-02-03 22:51:39 +01:00
jango-blockchained
481dc5b1a8 chore: add Bun types and update TypeScript configuration for Bun runtime
- Added `bun-types` to package.json dev dependencies
- Updated tsconfig.json to include Bun types and test directory
- Updated README.md with correct author attribution
- Enhanced test configurations to support Bun testing environment
2025-02-03 22:41:22 +01:00
jango-blockchained
c519d250a1 chore: add .bun/ to .gitignore for Bun runtime configuration 2025-02-03 22:40:48 +01:00
jango-blockchained
10bf5919e4 refactor: enhance middleware and security with advanced protection mechanisms
- Upgraded rate limiter configuration with more granular control and detailed headers
- Improved authentication middleware with enhanced token validation and error responses
- Implemented advanced input sanitization using sanitize-html with comprehensive XSS protection
- Replaced manual security headers with helmet for robust web security configuration
- Enhanced error handling middleware with more detailed logging and specific error type handling
- Updated SSE rate limiting with burst and window-based restrictions
- Improved token validation with more precise signature and claim verification
2025-02-03 22:29:41 +01:00
jango-blockchained
89f2278c25 refactor: improve SSE types and testing utilities
- Enhanced SSE event type definitions with more precise typing
- Added type guard and safe type assertion functions for mock objects
- Updated security test suite to use new type utilities
- Improved type safety for token validation and mock function handling
- Refined event data type to support more flexible event structures
2025-02-03 22:22:26 +01:00
jango-blockchained
a53cec7b28 chore: migrate project to Bun testing framework and update configuration
- Replace Jest with Bun's native testing framework
- Update test configuration and utilities to support Bun test environment
- Add mock implementations for SSE and security testing
- Refactor test setup to use Bun's testing utilities
- Update package dependencies and scripts to align with Bun testing
- Enhance type definitions for Bun test mocking
2025-02-03 22:19:43 +01:00
jango-blockchained
b7856e9d05 Updated .gitignore 2025-02-03 22:10:24 +01:00
jango-blockchained
7891115ebe test: add comprehensive test suite for security and SSE components
- Implemented detailed Jest test configurations for project
- Added test configuration with robust environment setup
- Created comprehensive test suites for:
  * Security middleware
  * Token management
  * SSE security features
- Configured test utilities with mock request/response objects
- Implemented extensive test scenarios covering authentication, rate limiting, and error handling
2025-02-03 22:08:16 +01:00
jango-blockchained
a814c427e9 feat: enhance security configuration and SSE management with robust token validation and client tracking
- Refactored `.env.example` with comprehensive security and configuration parameters
- Added new `security.config.ts` for centralized security configuration management
- Improved middleware with enhanced authentication, request validation, and error handling
- Updated SSE routes and manager with advanced client tracking, rate limiting, and connection management
- Implemented more granular token validation with IP-based rate limiting and connection tracking
- Added detailed error responses and improved logging for security-related events
2025-02-03 22:02:12 +01:00
jango-blockchained
840927998e docs: enhance README with comprehensive project status and Bun runtime details
- Updated project status section with current achievements and upcoming features
- Added detailed performance benefits and optimization sections
- Expanded development workflow and testing instructions
- Included version history and advanced feature descriptions
- Refined Bun runtime documentation and performance highlights
- Improved overall readability and project presentation
2025-02-03 19:32:38 +01:00
jango-blockchained
cf7fb2422e Migrate from BUN_ENV to NODE_ENV and update Home Assistant implementation 2025-02-03 19:18:52 +01:00
jango-blockchained
d46a19c698 docs: update README with Bun runtime migration and comprehensive workflow details
- Replaced Node.js and npm references with Bun runtime configuration
- Updated badges to reflect Bun version
- Added new sections on Bun performance benefits and development workflow
- Expanded troubleshooting and performance optimization guidelines
- Simplified installation, build, and testing instructions
- Included Bun-specific commands for development and testing
2025-02-03 19:07:31 +01:00
114 changed files with 12160 additions and 7130 deletions

View File

@@ -7,7 +7,6 @@ yarn-error.log*
package-lock.json
yarn.lock
pnpm-lock.yaml
bun.lockb
# Build output
dist/
@@ -74,3 +73,6 @@ temp/
.cloud/
*.db
*.db-*
.cursor/
.cursor*
.cursorconfig

View File

@@ -36,26 +36,50 @@ RATE_LIMIT_REGULAR=100
# Requests per minute per IP for WebSocket connections
RATE_LIMIT_WEBSOCKET=1000
# Security
# JWT secret for token generation (change this in production!)
JWT_SECRET=your_jwt_secret_key
# CORS configuration (comma-separated list of allowed origins)
CORS_ORIGINS=http://localhost:3000,http://localhost:8123
# Test Configuration
# Only needed if running tests
TEST_HASS_HOST=http://localhost:8123
TEST_HASS_TOKEN=test_token
TEST_HASS_SOCKET_URL=ws://localhost:8123/api/websocket
TEST_PORT=3001
# Security Configuration
JWT_SECRET=your-secret-key
# JWT Configuration
JWT_SECRET=your_jwt_secret_key_min_32_chars
JWT_EXPIRY=86400000
JWT_MAX_AGE=2592000000
JWT_ALGORITHM=HS256
# Rate Limiting
RATE_LIMIT_WINDOW_MS=900000 # 15 minutes
RATE_LIMIT_MAX=100
RATE_LIMIT_WINDOW=900000
RATE_LIMIT_MAX_REQUESTS=100
# Token Security
TOKEN_MIN_LENGTH=32
MAX_FAILED_ATTEMPTS=5
LOCKOUT_DURATION=900000
# CORS Configuration
CORS_ORIGINS=http://localhost:3000,http://localhost:8123
CORS_METHODS=GET,POST,PUT,DELETE,OPTIONS
CORS_ALLOWED_HEADERS=Content-Type,Authorization,X-Requested-With
CORS_EXPOSED_HEADERS=
CORS_CREDENTIALS=true
CORS_MAX_AGE=86400
# Content Security Policy
CSP_ENABLED=true
CSP_REPORT_ONLY=false
CSP_REPORT_URI=
# SSL/TLS Configuration
REQUIRE_HTTPS=true
HSTS_MAX_AGE=31536000
HSTS_INCLUDE_SUBDOMAINS=true
HSTS_PRELOAD=true
# Cookie Security
COOKIE_SECRET=your_cookie_secret_key_min_32_chars
COOKIE_SECURE=true
COOKIE_HTTP_ONLY=true
COOKIE_SAME_SITE=Strict
# Request Limits
MAX_REQUEST_SIZE=1048576
MAX_REQUEST_FIELDS=1000
# SSE Configuration
SSE_MAX_CLIENTS=1000
@@ -71,3 +95,17 @@ LOG_REQUESTS=true
# Version
VERSION=0.1.0
# Test Configuration
# Only needed if running tests
TEST_HASS_HOST=http://localhost:8123
TEST_HASS_TOKEN=test_token
TEST_HASS_SOCKET_URL=ws://localhost:8123/api/websocket
TEST_PORT=3001
# Speech Features Configuration
ENABLE_SPEECH_FEATURES=false
ENABLE_WAKE_WORD=true
ENABLE_SPEECH_TO_TEXT=true
WHISPER_MODEL_PATH=/models
WHISPER_MODEL_TYPE=base

64
.github/workflows/deploy-docs.yml vendored Normal file
View File

@@ -0,0 +1,64 @@
name: Deploy Documentation to GitHub Pages
on:
push:
branches:
- main
paths:
- 'docs/**'
- '.github/workflows/deploy-docs.yml'
permissions:
contents: read
pages: write
id-token: write
# Allow only one concurrent deployment
concurrency:
group: "pages"
cancel-in-progress: true
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Ruby
uses: ruby/setup-ruby@v1
with:
ruby-version: '3.2'
bundler-cache: true
cache-version: 0
- name: Setup Pages
uses: actions/configure-pages@v4
- name: Install dependencies
run: |
cd docs
bundle install
- name: Build site
run: |
cd docs
bundle exec jekyll build
env:
JEKYLL_ENV: production
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: docs/_site
deploy:
needs: build
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4

65
.github/workflows/docker-build-push.yml vendored Normal file
View File

@@ -0,0 +1,65 @@
name: Docker Build and Push
on:
push:
branches: [ "main" ]
tags:
- 'v*.*.*' # Triggers on version tags like v1.0.0
env:
REGISTRY: ghcr.io
IMAGE_NAME: ${{ github.repository }}
jobs:
build-and-push:
runs-on: ubuntu-latest
permissions:
contents: write
packages: write
pull-requests: write
steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
fetch-depth: 0 # Required for version detection
- name: Bump version and push tag
id: tag_version
uses: mathieudutour/github-tag-action@v6.1
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
default_bump: patch
- name: Create Release
uses: actions/create-release@v1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
tag_name: ${{ steps.tag_version.outputs.new_tag }}
release_name: Release ${{ steps.tag_version.outputs.new_tag }}
body: ${{ steps.tag_version.outputs.changelog }}
- name: Log in to the Container registry
uses: docker/login-action@v3
with:
registry: ${{ env.REGISTRY }}
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
- name: Extract metadata (tags, labels) for Docker
id: meta
uses: docker/metadata-action@v5
with:
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
tags: |
type=raw,value=${{ steps.tag_version.outputs.new_tag }}
type=raw,value=latest
- name: Build and push Docker image
uses: docker/build-push-action@v5
with:
context: .
push: true
tags: ${{ steps.meta.outputs.tags }}
labels: ${{ steps.meta.outputs.labels }}

32
.github/workflows/docs-deploy.yml vendored Normal file
View File

@@ -0,0 +1,32 @@
name: Deploy Documentation
on:
push:
branches:
- main
paths:
- 'docs/**'
- 'mkdocs.yml'
permissions:
contents: write
jobs:
deploy-docs:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: 3.x
- name: Install dependencies
run: |
pip install mkdocs-material
pip install mkdocs
- name: Deploy documentation
run: mkdocs gh-deploy --force

17
.gitignore vendored
View File

@@ -65,7 +65,6 @@ home-assistant_v2.db-*
package-lock.json
yarn.lock
pnpm-lock.yaml
bun.lockb
coverage/*
coverage/
@@ -73,3 +72,19 @@ coverage/
.env
.env.*
!.env.*.template
.cursor/
.cursor/*
.bun/
.cursorconfig
bun.lockb
# MkDocs
site/
.site/
# Python
__pycache__/
*.py[cod]
*$py.class

View File

@@ -1,20 +1,65 @@
# Use Bun as the base image
FROM oven/bun:1.0.26
# Use Node.js as base for building
FROM node:20-slim as builder
# Set working directory
WORKDIR /app
# Copy source code
COPY . .
# Install bun
RUN npm install -g bun@1.0.25
# Install dependencies
RUN bun install
# Install only the minimal dependencies needed and clean up in the same layer
RUN apt-get update && apt-get install -y --no-install-recommends \
ca-certificates \
curl \
&& rm -rf /var/lib/apt/lists/* \
&& apt-get clean \
&& rm -rf /var/cache/apt/*
# Build TypeScript
RUN bun run build
# Set build-time environment variables
ENV NODE_ENV=production \
NODE_OPTIONS="--max-old-space-size=2048"
# Expose the port the app runs on
EXPOSE 3000
# Copy only package files first
COPY package.json ./
# Start the application
CMD ["bun", "run", "start"]
# Install dependencies without lockfile
RUN bun install --no-cache
# Copy source files and build
COPY src ./src
COPY tsconfig*.json ./
RUN bun build ./src/index.ts --target=bun --minify --outdir=./dist
# Create a smaller production image
FROM node:20-slim as runner
# Install bun in production image
RUN npm install -g bun@1.0.25
# Set production environment variables
ENV NODE_ENV=production \
NODE_OPTIONS="--max-old-space-size=1024"
# Create a non-root user
RUN addgroup --system --gid 1001 nodejs && \
adduser --system --uid 1001 bunjs
WORKDIR /app
# Copy only the necessary files from builder
COPY --from=builder --chown=bunjs:nodejs /app/dist ./dist
COPY --from=builder --chown=bunjs:nodejs /app/node_modules ./node_modules
COPY --chown=bunjs:nodejs package.json ./
# Switch to non-root user
USER bunjs
# Health check
HEALTHCHECK --interval=30s --timeout=10s --start-period=5s --retries=3 \
CMD curl -f http://localhost:4000/health || exit 1
# Expose port
EXPOSE 4000
# Start the application with optimized flags
CMD ["bun", "--smol", "run", "start"]

590
README.md
View File

@@ -1,400 +1,288 @@
# Model Context Protocol Server for Home Assistant
# 🚀 MCP Server for Home Assistant - Bringing AI-Powered Smart Homes to Life!
The server uses the MCP protocol to share access to a local Home Assistant instance with an LLM application.
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
[![Bun](https://img.shields.io/badge/bun-%3E%3D1.0.26-black)](https://bun.sh)
[![TypeScript](https://img.shields.io/badge/typescript-%5E5.0.0-blue.svg)](https://www.typescriptlang.org)
[![Test Coverage](https://img.shields.io/badge/coverage-95%25-brightgreen.svg)](#)
[![Documentation](https://img.shields.io/badge/docs-github.io-blue.svg)](https://jango-blockchained.github.io/homeassistant-mcp/)
[![Docker](https://img.shields.io/badge/docker-%3E%3D20.10.8-blue)](https://www.docker.com)
A powerful bridge between your Home Assistant instance and Language Learning Models (LLMs), enabling natural language control and monitoring of your smart home devices through the Model Context Protocol (MCP). This server provides a comprehensive API for managing your entire Home Assistant ecosystem, from device control to system administration.
---
![License](https://img.shields.io/badge/license-MIT-blue.svg)
![Node.js](https://img.shields.io/badge/node-%3E%3D20.10.0-green.svg)
![Docker Compose](https://img.shields.io/badge/docker-compose-%3E%3D1.27.0-blue.svg)
![NPM](https://img.shields.io/badge/npm-%3E%3D7.0.0-orange.svg)
![TypeScript](https://img.shields.io/badge/typescript-%5E5.0.0-blue.svg)
![Test Coverage](https://img.shields.io/badge/coverage-95%25-brightgreen.svg)
## Overview 🌐
## Features
Welcome to the **Model Context Protocol (MCP) Server for Home Assistant**! This robust platform bridges Home Assistant with cutting-edge Language Learning Models (LLMs), enabling natural language interactions and real-time automation of your smart devices. Imagine entering your home, saying:
- 🎮 **Device Control**: Control any Home Assistant device through natural language
- 🔄 **Real-time Updates**: Get instant updates through Server-Sent Events (SSE)
- 🤖 **Automation Management**: Create, update, and manage automations
- 📊 **State Monitoring**: Track and query device states
- 🔐 **Secure**: Token-based authentication and rate limiting
- 📱 **Mobile Ready**: Works with any HTTP-capable client
> “Hey MCP, dim the lights and start my evening playlist,”
## Real-time Updates with SSE
and watching your home transform instantly—that's the magic that MCP Server delivers!
The server includes a powerful Server-Sent Events (SSE) system that provides real-time updates from your Home Assistant instance. This allows you to:
---
- 🔄 Get instant state changes for any device
- 📡 Monitor automation triggers and executions
- 🎯 Subscribe to specific domains or entities
- 📊 Track service calls and script executions
## Key Benefits ✨
### Quick SSE Example
### 🎮 Device Control & Monitoring
- **Voice-Controlled Automation:**
Use simple commands like "Turn on the kitchen lights" or "Set the thermostat to 22°C" without touching a switch.
**Real-World Example:**
In the morning, say "Good morning! Open the blinds and start the coffee machine" to kickstart your day automatically.
- **Real-Time Communication:**
Experience sub-100ms latency updates via Server-Sent Events (SSE) or WebSocket connections, ensuring your dashboard is always current.
**Real-World Example:**
Monitor energy usage instantly during peak hours and adjust remotely for efficient consumption.
- **Seamless Automation:**
Create scene-based rules to synchronize multiple devices effortlessly.
**Real-World Example:**
For movie nights, have MCP dim the lights, adjust the sound system, and launch your favorite streaming app with just one command.
### 🤖 AI-Powered Enhancements
- **Natural Language Processing (NLP):**
Convert everyday speech into actionable commands—just say, "Prepare the house for dinner," and MCP will adjust lighting, temperature, and even play soft background music.
- **Predictive Automation & Suggestions:**
Receive proactive recommendations based on usage habits and environmental trends.
**Real-World Example:**
When home temperature fluctuates unexpectedly, MCP suggests an optimal setting and notifies you immediately.
- **Anomaly Detection:**
Continuously monitor device activity and alert you to unusual behavior, helping prevent malfunctions or potential security breaches.
---
## Architectural Overview 🏗
Our architecture is engineered for performance, scalability, and security. The following Mermaid diagram illustrates the data flow and component interactions:
```mermaid
graph TD
subgraph Client
A[Client Application<br/>(Web / Mobile / Voice)]
end
subgraph CDN
B[CDN / Cache]
end
subgraph Server
C[Bun Native Server]
E[NLP Engine<br/>& Language Processing Module]
end
subgraph Integration
D[Home Assistant<br/>(Devices, Lights, Thermostats)]
end
A -->|HTTP Request| B
B -- Cache Miss --> C
C -->|Interpret Command| E
E -->|Determine Action| D
D -->|Return State/Action| C
C -->|Response| B
B -->|Cached/Processed Response| A
```
Learn more about our architecture in the [Architecture Documentation](docs/architecture.md).
---
## Technical Stack 🔧
Our solution is built on a modern, high-performance stack that powers every feature:
- **Bun:**
A next-generation JavaScript runtime offering rapid startup times, native TypeScript support, and high performance.
👉 [Learn about Bun](https://bun.sh)
- **Bun Native Server:**
Utilizes Bun's built-in HTTP server to efficiently process API requests with sub-100ms response times.
👉 See the [Installation Guide](docs/getting-started/installation.md) for details.
- **Natural Language Processing (NLP) & LLM Integration:**
Processes and interprets natural language commands using state-of-the-art LLMs and custom NLP modules.
👉 Find API usage details in the [API Documentation](docs/api.md).
- **Home Assistant Integration:**
Provides seamless connectivity with Home Assistant, ensuring flawless communication with your smart devices.
👉 Refer to the [Usage Guide](docs/usage.md) for more information.
- **Redis Cache:**
Enables rapid data retrieval and session persistence essential for real-time updates.
- **TypeScript:**
Enhances type safety and developer productivity across the entire codebase.
- **JWT & Security Middleware:**
Protects your ecosystem with JWT-based authentication, request sanitization, rate-limiting, and encryption.
- **Containerization with Docker:**
Enables scalable, isolated deployments for production environments.
For further technical details, check out our [Documentation Index](docs/index.md).
---
## Installation 🛠
### 🐳 Docker Setup (Recommended)
For a hassle-free, containerized deployment:
```bash
# 1. Clone the repository (using a shallow copy for efficiency)
git clone --depth 1 https://github.com/jango-blockchained/homeassistant-mcp.git
# 2. Configure your environment: copy the example file and edit it with your Home Assistant credentials
cp .env.example .env # Modify .env with your Home Assistant host, tokens, etc.
# 3. Build and run the Docker containers
docker compose up -d --build
# 4. View real-time logs (last 50 log entries)
docker compose logs -f --tail=50
```
👉 Refer to our [Installation Guide](docs/getting-started/installation.md) for full details.
### 💻 Bare Metal Installation
For direct deployment on your host machine:
```bash
# 1. Install Bun (if not already installed)
curl -fsSL https://bun.sh/install | bash
# 2. Install project dependencies with caching support
bun install --frozen-lockfile
# 3. Launch the server in development mode with hot-reload enabled
bun run dev --watch
```
---
## Real-World Usage Examples 🔍
### 📱 Smart Home Dashboard Integration
Integrate MCP's real-time updates into your custom dashboard for a dynamic smart home experience:
```javascript
const eventSource = new EventSource(
'http://localhost:3000/subscribe_events?token=YOUR_TOKEN&domain=light'
);
const eventSource = new EventSource('http://localhost:3000/subscribe_events?token=YOUR_TOKEN&domain=light');
eventSource.onmessage = (event) => {
const data = JSON.parse(event.data);
console.log('Update received:', data);
const data = JSON.parse(event.data);
console.log('Real-time update:', data);
// Update your UI dashboard, e.g., refresh a light intensity indicator.
};
```
See [SSE_API.md](docs/SSE_API.md) for complete documentation of the SSE system.
### 🏠 Voice-Activated Control
Utilize voice commands to trigger actions with minimal effort:
## Table of Contents
```javascript
// Establish a WebSocket connection for real-time command processing
const ws = new WebSocket('wss://mcp.yourha.com/ws');
- [Key Features](#key-features)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Basic Setup](#basic-setup)
- [Docker Setup (Recommended)](#docker-setup-recommended)
- [Configuration](#configuration)
- [Development](#development)
- [API Reference](#api-reference)
- [OpenAI Integration](#openai-integration)
- [Natural Language Integration](#natural-language-integration)
- [Troubleshooting](#troubleshooting)
- [Project Status](#project-status)
- [Contributing](#contributing)
- [Resources](#resources)
- [License](#license)
ws.onmessage = ({ data }) => {
const update = JSON.parse(data);
if (update.entity_id === 'light.living_room') {
console.log('Adjusting living room lighting based on voice command...');
// Additional logic to update your UI or trigger further actions can go here.
}
};
## Key Features
// Simulate processing a voice command
function simulateVoiceCommand(command) {
console.log("Processing voice command:", command);
// Integrate with your actual voice-to-text system as needed.
}
### Core Functionality 🎮
- **Smart Device Control**
- 💡 **Lights**: Brightness, color temperature, RGB color
- 🌡️ **Climate**: Temperature, HVAC modes, fan modes, humidity
- 🚪 **Covers**: Position and tilt control
- 🔌 **Switches**: On/off control
- 🚨 **Sensors & Contacts**: State monitoring
- 🎵 **Media Players**: Playback control, volume, source selection
- 🌪️ **Fans**: Speed, oscillation, direction
- 🔒 **Locks**: Lock/unlock control
- 🧹 **Vacuums**: Start, stop, return to base
- 📹 **Cameras**: Motion detection, snapshots
simulateVoiceCommand("Turn off all the lights for bedtime");
```
### System Management 🛠️
- **Add-on Management**
- Browse available add-ons
- Install/uninstall add-ons
- Start/stop/restart add-ons
- Version management
- Configuration access
👉 Learn more in our [Usage Guide](docs/usage.md).
- **Package Management (HACS)**
- Integration with Home Assistant Community Store
- Multiple package types support:
- Custom integrations
- Frontend themes
- Python scripts
- AppDaemon apps
- NetDaemon apps
- Version control and updates
- Repository management
---
- **Automation Management**
- Create and edit automations
- Advanced configuration options:
- Multiple trigger types
- Complex conditions
- Action sequences
- Execution modes
- Duplicate and modify existing automations
- Enable/disable automation rules
- Trigger automation manually
## Update Strategy 🔄
### Architecture Features 🏗️
- **Intelligent Organization**
- Area and floor-based device grouping
- State monitoring and querying
- Smart context awareness
- Historical data access
- **Robust Architecture**
- Comprehensive error handling
- State validation
- Secure API integration
- TypeScript type safety
- Extensive test coverage
## Prerequisites
- **Node.js** 20.10.0 or higher
- **NPM** package manager
- **Docker Compose** for containerization
- Running **Home Assistant** instance
- Home Assistant long-lived access token ([How to get token](https://community.home-assistant.io/t/how-to-get-long-lived-access-token/162159))
- **HACS** installed for package management features
- **Supervisor** access for add-on management
## Installation
### Basic Setup
Maintain a seamless operation with zero downtime updates:
```bash
# Clone the repository
git clone https://github.com/jango-blockchained/homeassistant-mcp.git
cd homeassistant-mcp
# 1. Pull the latest Docker images
docker compose pull
# Install dependencies
npm install
# 2. Rebuild and restart containers smoothly
docker compose up -d --build
# Build the project
npm run build
# 3. Clean up unused Docker images to free up space
docker system prune -f
```
### Docker Setup (Recommended)
For more details, review our [Troubleshooting & Updates](docs/troubleshooting.md).
The project includes Docker support for easy deployment and consistent environments across different platforms.
---
1. **Clone the repository:**
## Security Features 🔐
We prioritize the security of your smart home with multiple layers of defense:
- **JWT Authentication 🔑:** Secure, token-based API access to prevent unauthorized usage.
- **Request Sanitization 🧼:** Automatic filtering and validation of API requests to combat injection attacks.
- **Rate Limiting & Fail2Ban 🚫:** Monitors requests to prevent brute force and DDoS attacks.
- **End-to-End Encryption 🔒:** Ensures that your commands and data remain private during transmission.
---
## Contributing 🤝
We value community contributions! Here's how you can help improve MCP Server:
1. **Fork the Repository 🍴**
Create your own copy of the project.
2. **Create a Feature Branch 🌿**
```bash
git clone https://github.com/jango-blockchained/homeassistant-mcp.git
cd homeassistant-mcp
git checkout -b feature/your-feature-name
```
2. **Configure environment:**
3. **Install Dependencies & Run Tests 🧪**
```bash
cp .env.example .env
bun install
bun test --coverage
```
Edit the `.env` file with your Home Assistant configuration:
```env
# Home Assistant Configuration
HASS_HOST=http://homeassistant.local:8123
HASS_TOKEN=your_home_assistant_token
HASS_SOCKET_URL=ws://homeassistant.local:8123/api/websocket
4. **Make Your Changes & Commit 📝**
Follow the [Conventional Commits](https://www.conventionalcommits.org) guidelines.
5. **Open a Pull Request 🔀**
Submit your changes for review.
# Server Configuration
PORT=3000
NODE_ENV=production
DEBUG=false
```
Read more in our [Contribution Guidelines](docs/contributing.md).
3. **Build and run with Docker Compose:**
```bash
# Build and start the containers
docker compose up -d
---
# View logs
docker compose logs -f
## Roadmap & Future Enhancements 🔮
# Stop the service
docker compose down
```
We're continuously evolving MCP Server. Upcoming features include:
- **AI Assistant Integration (Q4 2024):**
Smarter, context-aware voice commands and personalized automation.
- **Predictive Automation (Q1 2025):**
Enhanced scheduling capabilities powered by advanced AI.
- **Enhanced Security (Q2 2024):**
Introduction of multi-factor authentication, advanced monitoring, and rigorous encryption methods.
- **Performance Optimizations (Q3 2024):**
Reducing latency further, optimizing caching, and improving load balancing.
4. **Verify the installation:**
The server should now be running at `http://localhost:3000`. You can check the health endpoint at `http://localhost:3000/health`.
For more details, see our [Roadmap](docs/roadmap.md).
5. **Update the application:**
```bash
# Pull the latest changes
git pull
---
# Rebuild and restart the containers
docker compose up -d --build
```
## Community & Support 🌍
#### Docker Configuration
Your feedback and collaboration are vital! Join our community:
- **GitHub Issues:** Report bugs or request features via our [Issues Page](https://github.com/jango-blockchained/homeassistant-mcp/issues).
- **Discord & Slack:** Connect with fellow users and developers in real-time.
- **Documentation:** Find comprehensive guides on the [MCP Documentation Website](https://jango-blockchained.github.io/homeassistant-mcp/).
The Docker setup includes:
- Multi-stage build for optimal image size
- Health checks for container monitoring
- Volume mounting for environment configuration
- Automatic container restart on failure
- Exposed port 3000 for API access
---
#### Docker Compose Environment Variables
## License 📜
All environment variables can be configured in the `.env` file. The following variables are supported:
- `HASS_HOST`: Your Home Assistant instance URL
- `HASS_TOKEN`: Long-lived access token for Home Assistant
- `HASS_SOCKET_URL`: WebSocket URL for Home Assistant
- `PORT`: Server port (default: 3000)
- `NODE_ENV`: Environment (production/development)
- `DEBUG`: Enable debug mode (true/false)
This project is licensed under the MIT License. See [LICENSE](LICENSE) for full details.
## Configuration
---
### Environment Variables
```env
# Home Assistant Configuration
HASS_HOST=http://homeassistant.local:8123 # Your Home Assistant instance URL
HASS_TOKEN=your_home_assistant_token # Long-lived access token
HASS_SOCKET_URL=ws://homeassistant.local:8123/api/websocket # WebSocket URL
# Server Configuration
PORT=3000 # Server port (default: 3000)
NODE_ENV=production # Environment (production/development)
DEBUG=false # Enable debug mode
# Test Configuration
TEST_HASS_HOST=http://localhost:8123 # Test instance URL
TEST_HASS_TOKEN=test_token # Test token
```
### Configuration Files
1. **Development**: Copy `.env.example` to `.env.development`
2. **Production**: Copy `.env.example` to `.env.production`
3. **Testing**: Copy `.env.example` to `.env.test`
## Development
```bash
# Development mode with hot reload
npm run dev
# Build project
npm run build
# Production mode
npm run start
# Run tests
npx jest --config=jest.config.cjs
# Run tests with coverage
npx jest --coverage
# Lint code
npm run lint
# Format code
npm run format
```
## API Reference
For detailed API documentation, please refer to:
- [API Documentation](docs/API.md) - Complete API reference
- [SSE API Documentation](docs/SSE_API.md) - Server-Sent Events documentation
## OpenAI Integration
The server includes powerful AI analysis capabilities powered by OpenAI's GPT-4 model. This feature provides intelligent analysis of your Home Assistant setup through two main modes:
### 1. Standard Analysis
Performs a comprehensive system analysis including:
- System Overview
- Performance Analysis
- Security Assessment
- Optimization Recommendations
- Maintenance Tasks
```bash
# Run standard analysis
npm run test:openai
# Select option 1 when prompted
```
### 2. Custom Prompt Analysis
Allows you to ask specific questions about your Home Assistant setup. The analysis can include:
- Device States
- Configuration Details
- Active Devices
- Device Attributes (brightness, temperature, etc.)
```bash
# Run custom analysis
npm run test:openai
# Select option 2 when prompted
```
### Configuration
To use the OpenAI integration, you need to set up your OpenAI API key in the `.env` file:
```env
OPENAI_API_KEY=your_openai_api_key
```
## Troubleshooting
### Common Issues
1. **Node.js Version (`toSorted is not a function`)**
- **Solution:** Update to Node.js 20.10.0+
```bash
nvm install 20.10.0
nvm use 20.10.0
```
2. **Connection Issues**
- Verify Home Assistant is running
- Check `HASS_HOST` accessibility
- Validate token permissions
- Ensure WebSocket connection for real-time updates
3. **Add-on Management Issues**
- Verify Supervisor access
- Check add-on compatibility
- Validate system resources
4. **HACS Integration Issues**
- Verify HACS installation
- Check HACS integration status
- Validate repository access
5. **Automation Issues**
- Verify entity availability
- Check trigger conditions
- Validate service calls
- Monitor execution logs
## Project Status
**Complete**
- Entity, Floor, and Area access
- Device control (Lights, Climate, Covers, Switches, Contacts)
- Add-on management system
- Package management through HACS
- Advanced automation configuration
- Basic state management
- Error handling and validation
- Docker containerization
- Jest testing setup
- TypeScript integration
- Environment variable management
- Home Assistant API integration
- Project documentation
🚧 **In Progress**
- WebSocket implementation for real-time updates
- Enhanced security features
- Tool organization optimization
- Performance optimization
- Resource context integration
- API documentation generation
- Multi-platform desktop integration
- Advanced error recovery
- Custom prompt testing
- Enhanced macOS integration
- Type safety improvements
- Testing coverage expansion
## Contributing
1. Fork the repository
2. Create a feature branch
3. Implement your changes
4. Add tests for new functionality
5. Ensure all tests pass
6. Submit a pull request
## Resources
- [MCP Documentation](https://modelcontextprotocol.io/introduction)
- [Home Assistant Docs](https://www.home-assistant.io)
- [HA REST API](https://developers.home-assistant.io/docs/api/rest)
- [HACS Documentation](https://hacs.xyz)
- [TypeScript Documentation](https://www.typescriptlang.org/docs)
## License
MIT License - See [LICENSE](LICENSE) file
🔋 Batteries included.

View File

@@ -1,140 +1,209 @@
import { TokenManager, validateRequest, sanitizeInput, errorHandler } from '../../src/security/index.js';
import { Request, Response } from 'express';
import { TokenManager, validateRequest, sanitizeInput, errorHandler, rateLimiter, securityHeaders } from '../../src/security/index.js';
import { mock, describe, it, expect, beforeEach, afterEach } from 'bun:test';
import jwt from 'jsonwebtoken';
const TEST_SECRET = 'test-secret-that-is-long-enough-for-testing-purposes';
describe('Security Module', () => {
beforeEach(() => {
process.env.JWT_SECRET = TEST_SECRET;
});
afterEach(() => {
delete process.env.JWT_SECRET;
});
describe('TokenManager', () => {
const testToken = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiZXhwIjoxNzE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c';
const encryptionKey = 'test_encryption_key';
const testToken = 'test-token';
const encryptionKey = 'test-encryption-key-that-is-long-enough';
it('should encrypt and decrypt tokens', () => {
const encrypted = TokenManager.encryptToken(testToken, encryptionKey);
const decrypted = TokenManager.decryptToken(encrypted, encryptionKey);
expect(encrypted).toContain('aes-256-gcm:');
const decrypted = TokenManager.decryptToken(encrypted, encryptionKey);
expect(decrypted).toBe(testToken);
});
it('should validate tokens correctly', () => {
expect(TokenManager.validateToken(testToken)).toBe(true);
expect(TokenManager.validateToken('invalid_token')).toBe(false);
expect(TokenManager.validateToken('')).toBe(false);
const validToken = jwt.sign({ data: 'test' }, TEST_SECRET, { expiresIn: '1h' });
const result = TokenManager.validateToken(validToken);
expect(result.valid).toBe(true);
expect(result.error).toBeUndefined();
});
it('should handle empty tokens', () => {
const result = TokenManager.validateToken('');
expect(result.valid).toBe(false);
expect(result.error).toBe('Invalid token format');
});
it('should handle expired tokens', () => {
const expiredToken = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiZXhwIjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c';
expect(TokenManager.validateToken(expiredToken)).toBe(false);
const now = Math.floor(Date.now() / 1000);
const payload = {
data: 'test',
iat: now - 7200, // 2 hours ago
exp: now - 3600 // expired 1 hour ago
};
const token = jwt.sign(payload, TEST_SECRET);
const result = TokenManager.validateToken(token);
expect(result.valid).toBe(false);
expect(result.error).toBe('Token has expired');
});
it('should handle invalid token format', () => {
const result = TokenManager.validateToken('invalid-token');
expect(result.valid).toBe(false);
expect(result.error).toBe('Invalid token format');
});
it('should handle missing JWT secret', () => {
delete process.env.JWT_SECRET;
const payload = { data: 'test' };
const token = jwt.sign(payload, 'some-secret');
const result = TokenManager.validateToken(token);
expect(result.valid).toBe(false);
expect(result.error).toBe('JWT secret not configured');
});
it('should handle rate limiting for failed attempts', () => {
const invalidToken = 'x'.repeat(64);
const testIp = '127.0.0.1';
// First attempt
const firstResult = TokenManager.validateToken(invalidToken, testIp);
expect(firstResult.valid).toBe(false);
// Multiple failed attempts
for (let i = 0; i < 4; i++) {
TokenManager.validateToken(invalidToken, testIp);
}
// Next attempt should be rate limited
const limitedResult = TokenManager.validateToken(invalidToken, testIp);
expect(limitedResult.valid).toBe(false);
expect(limitedResult.error).toBe('Too many failed attempts. Please try again later.');
});
});
describe('Request Validation', () => {
let mockRequest: Partial<Request>;
let mockResponse: Partial<Response>;
let mockNext: jest.Mock;
let mockRequest: any;
let mockResponse: any;
let mockNext: any;
beforeEach(() => {
mockRequest = {
method: 'POST',
headers: {
'content-type': 'application/json',
authorization: 'Bearer validToken'
'content-type': 'application/json'
},
is: jest.fn().mockReturnValue(true),
body: { test: 'data' }
body: {},
ip: '127.0.0.1'
};
mockResponse = {
status: jest.fn().mockReturnThis(),
json: jest.fn()
status: mock(() => mockResponse),
json: mock(() => mockResponse),
setHeader: mock(() => mockResponse),
removeHeader: mock(() => mockResponse)
};
mockNext = jest.fn();
mockNext = mock(() => { });
});
it('should pass valid requests', () => {
validateRequest(
mockRequest as Request,
mockResponse as Response,
mockNext
);
if (mockRequest.headers) {
mockRequest.headers.authorization = 'Bearer valid-token';
}
const validateTokenSpy = mock(() => ({ valid: true }));
TokenManager.validateToken = validateTokenSpy;
validateRequest(mockRequest, mockResponse, mockNext);
expect(mockNext).toHaveBeenCalled();
expect(mockResponse.status).not.toHaveBeenCalled();
});
it('should reject invalid content type', () => {
mockRequest.is = jest.fn().mockReturnValue(false);
if (mockRequest.headers) {
mockRequest.headers['content-type'] = 'text/plain';
}
validateRequest(
mockRequest as Request,
mockResponse as Response,
mockNext
);
validateRequest(mockRequest, mockResponse, mockNext);
expect(mockResponse.status).toHaveBeenCalledWith(415);
expect(mockResponse.json).toHaveBeenCalledWith({
error: 'Unsupported Media Type - Content-Type must be application/json'
success: false,
message: 'Unsupported Media Type',
error: 'Content-Type must be application/json',
timestamp: expect.any(String)
});
});
it('should reject missing token', () => {
mockRequest.headers = {};
if (mockRequest.headers) {
delete mockRequest.headers.authorization;
}
validateRequest(
mockRequest as Request,
mockResponse as Response,
mockNext
);
validateRequest(mockRequest, mockResponse, mockNext);
expect(mockResponse.status).toHaveBeenCalledWith(401);
expect(mockResponse.json).toHaveBeenCalledWith({
error: 'Invalid or expired token'
success: false,
message: 'Unauthorized',
error: 'Missing or invalid authorization header',
timestamp: expect.any(String)
});
});
it('should reject invalid request body', () => {
mockRequest.body = null;
validateRequest(
mockRequest as Request,
mockResponse as Response,
mockNext
);
validateRequest(mockRequest, mockResponse, mockNext);
expect(mockResponse.status).toHaveBeenCalledWith(400);
expect(mockResponse.json).toHaveBeenCalledWith({
error: 'Invalid request body'
success: false,
message: 'Bad Request',
error: 'Invalid request body structure',
timestamp: expect.any(String)
});
});
});
describe('Input Sanitization', () => {
let mockRequest: Partial<Request>;
let mockResponse: Partial<Response>;
let mockNext: jest.Mock;
let mockRequest: any;
let mockResponse: any;
let mockNext: any;
beforeEach(() => {
mockRequest = {
body: {}
};
mockResponse = {};
mockNext = jest.fn();
});
it('should sanitize HTML tags from request body', () => {
mockRequest.body = {
text: 'Test <script>alert("xss")</script>',
nested: {
html: '<img src="x" onerror="alert(1)">'
method: 'POST',
headers: {
'content-type': 'application/json'
},
body: {
text: 'Test alert("xss")',
nested: {
html: 'img src="x" onerror="alert(1)"'
}
}
};
sanitizeInput(
mockRequest as Request,
mockResponse as Response,
mockNext
);
mockResponse = {
status: mock(() => mockResponse),
json: mock(() => mockResponse)
};
mockNext = mock(() => { });
});
it('should sanitize HTML tags from request body', () => {
sanitizeInput(mockRequest, mockResponse, mockNext);
expect(mockRequest.body).toEqual({
text: 'Test alert("xss")',
text: 'Test',
nested: {
html: 'img src="x" onerror="alert(1)"'
html: ''
}
});
expect(mockNext).toHaveBeenCalled();
@@ -142,71 +211,104 @@ describe('Security Module', () => {
it('should handle non-object body', () => {
mockRequest.body = 'string body';
sanitizeInput(
mockRequest as Request,
mockResponse as Response,
mockNext
);
expect(mockRequest.body).toBe('string body');
sanitizeInput(mockRequest, mockResponse, mockNext);
expect(mockNext).toHaveBeenCalled();
});
});
describe('Error Handler', () => {
let mockRequest: Partial<Request>;
let mockResponse: Partial<Response>;
let mockNext: jest.Mock;
const originalEnv = process.env.NODE_ENV;
let mockRequest: any;
let mockResponse: any;
let mockNext: any;
beforeEach(() => {
mockRequest = {};
mockResponse = {
status: jest.fn().mockReturnThis(),
json: jest.fn()
mockRequest = {
method: 'POST',
ip: '127.0.0.1'
};
mockNext = jest.fn();
});
afterAll(() => {
process.env.NODE_ENV = originalEnv;
mockResponse = {
status: mock(() => mockResponse),
json: mock(() => mockResponse)
};
mockNext = mock(() => { });
});
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,
mockNext
);
errorHandler(error, mockRequest, mockResponse, mockNext);
expect(mockResponse.status).toHaveBeenCalledWith(500);
expect(mockResponse.json).toHaveBeenCalledWith({
error: 'Internal Server Error',
message: undefined
success: false,
message: 'Internal Server Error',
timestamp: expect.any(String)
});
});
it('should include error message in development mode', () => {
process.env.NODE_ENV = 'development';
const error = new Error('Test error');
errorHandler(
error,
mockRequest as Request,
mockResponse as Response,
mockNext
);
errorHandler(error, mockRequest, mockResponse, mockNext);
expect(mockResponse.status).toHaveBeenCalledWith(500);
expect(mockResponse.json).toHaveBeenCalledWith({
error: 'Internal Server Error',
message: 'Test error'
success: false,
message: 'Internal Server Error',
error: 'Test error',
stack: expect.any(String),
timestamp: expect.any(String)
});
});
});
describe('Rate Limiter', () => {
it('should limit requests after threshold', async () => {
const mockContext = {
request: new Request('http://localhost', {
headers: new Headers({
'x-forwarded-for': '127.0.0.1'
})
}),
set: mock(() => { })
};
// Test multiple requests
for (let i = 0; i < 100; i++) {
await rateLimiter.derive(mockContext);
}
// The next request should throw
try {
await rateLimiter.derive(mockContext);
expect(false).toBe(true); // Should not reach here
} catch (error) {
expect(error instanceof Error).toBe(true);
expect(error.message).toBe('Too many requests from this IP, please try again later');
}
});
});
describe('Security Headers', () => {
it('should set security headers', async () => {
const mockHeaders = new Headers();
const mockContext = {
request: new Request('http://localhost', {
headers: mockHeaders
}),
set: mock(() => { })
};
await securityHeaders.derive(mockContext);
// Verify that security headers were set
const headers = mockContext.request.headers;
expect(headers.has('content-security-policy')).toBe(true);
expect(headers.has('x-frame-options')).toBe(true);
expect(headers.has('x-content-type-options')).toBe(true);
expect(headers.has('referrer-policy')).toBe(true);
});
});
});

View File

@@ -1,177 +1,156 @@
import { jest, describe, it, expect, beforeEach } from '@jest/globals';
import { Request, Response, NextFunction } from 'express';
import { describe, it, expect } from 'bun:test';
import {
validateRequest,
sanitizeInput,
errorHandler,
rateLimiter,
securityHeaders
checkRateLimit,
validateRequestHeaders,
sanitizeValue,
applySecurityHeaders,
handleError
} from '../../src/security/index.js';
type MockRequest = {
headers: {
'content-type'?: string;
authorization?: string;
};
body?: any;
is: jest.MockInstance<string | false | null, [type: string | string[]]>;
};
describe('Security Middleware Utilities', () => {
describe('Rate Limiter', () => {
it('should allow requests under threshold', () => {
const ip = '127.0.0.1';
expect(() => checkRateLimit(ip, 10)).not.toThrow();
});
type MockResponse = {
status: jest.MockInstance<MockResponse, [code: number]>;
json: jest.MockInstance<MockResponse, [body: any]>;
setHeader: jest.MockInstance<MockResponse, [name: string, value: string]>;
};
it('should throw when requests exceed threshold', () => {
const ip = '127.0.0.2';
describe('Security Middleware', () => {
let mockRequest: MockRequest;
let mockResponse: MockResponse;
let nextFunction: jest.Mock;
// Simulate multiple requests
for (let i = 0; i < 11; i++) {
if (i < 10) {
expect(() => checkRateLimit(ip, 10)).not.toThrow();
} else {
expect(() => checkRateLimit(ip, 10)).toThrow('Too many requests from this IP, please try again later');
}
}
});
beforeEach(() => {
mockRequest = {
headers: {},
body: {},
is: jest.fn<string | false | null, [string | string[]]>().mockReturnValue('json')
};
it('should reset rate limit after window expires', async () => {
const ip = '127.0.0.3';
mockResponse = {
status: jest.fn<MockResponse, [number]>().mockReturnThis(),
json: jest.fn<MockResponse, [any]>().mockReturnThis(),
setHeader: jest.fn<MockResponse, [string, string]>().mockReturnThis()
};
// Simulate multiple requests
for (let i = 0; i < 11; i++) {
if (i < 10) {
expect(() => checkRateLimit(ip, 10, 50)).not.toThrow();
}
}
nextFunction = jest.fn();
// Wait for rate limit window to expire
await new Promise(resolve => setTimeout(resolve, 100));
// Should be able to make requests again
expect(() => checkRateLimit(ip, 10, 50)).not.toThrow();
});
});
describe('Request Validation', () => {
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 validate content type', () => {
const mockRequest = new Request('http://localhost', {
method: 'POST',
headers: {
'content-type': 'application/json'
}
});
expect(() => validateRequestHeaders(mockRequest)).not.toThrow();
});
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 invalid content type', () => {
const mockRequest = new Request('http://localhost', {
method: 'POST',
headers: {
'content-type': 'text/plain'
}
});
expect(() => validateRequestHeaders(mockRequest)).toThrow('Content-Type must be application/json');
});
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 large request bodies', () => {
const mockRequest = new Request('http://localhost', {
method: 'POST',
headers: {
'content-type': 'application/json',
'content-length': '2000000'
}
});
expect(() => validateRequestHeaders(mockRequest)).toThrow('Request body too large');
});
});
describe('Input Sanitization', () => {
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 tags', () => {
const input = '<script>alert("xss")</script>Hello';
const sanitized = sanitizeValue(input);
expect(sanitized).toBe('&lt;script&gt;alert(&quot;xss&quot;)&lt;/script&gt;Hello');
});
it('should sanitize HTML in request body', () => {
mockRequest.body = {
it('should sanitize nested objects', () => {
const input = {
text: '<script>alert("xss")</script>Hello',
nested: {
html: '<img src="x" onerror="alert(1)">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 = '<p>text</p>';
sanitizeInput(mockRequest as unknown as Request, mockResponse as unknown as Response, nextFunction);
expect(mockRequest.body).toBe('text');
expect(nextFunction).toHaveBeenCalled();
const sanitized = sanitizeValue(input);
expect(sanitized).toEqual({
text: '&lt;script&gt;alert(&quot;xss&quot;)&lt;/script&gt;Hello',
nested: {
html: '&lt;img src=&quot;x&quot; onerror=&quot;alert(1)&quot;&gt;World'
}
});
});
it('should preserve non-string values', () => {
mockRequest.body = {
number: 42,
const input = {
number: 123,
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();
});
});
describe('Error Handler', () => {
const originalEnv = process.env.NODE_ENV;
afterAll(() => {
process.env.NODE_ENV = originalEnv;
});
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({
error: 'Internal Server Error'
});
});
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({
error: 'Test error',
stack: expect.any(String)
});
});
it('should handle non-Error objects', () => {
const error = 'String error message';
errorHandler(
error as any,
mockRequest as Request,
mockResponse as Response,
nextFunction
);
expect(mockResponse.status).toHaveBeenCalledWith(500);
});
});
describe('Rate Limiter', () => {
it('should be configured with correct options', () => {
expect(rateLimiter).toBeDefined();
const middleware = rateLimiter as any;
expect(middleware.windowMs).toBeDefined();
expect(middleware.max).toBeDefined();
const sanitized = sanitizeValue(input);
expect(sanitized).toEqual(input);
});
});
describe('Security Headers', () => {
it('should set appropriate security headers', () => {
securityHeaders(mockRequest as Request, mockResponse as Response, nextFunction);
expect(mockResponse.setHeader).toHaveBeenCalledWith('X-Content-Type-Options', 'nosniff');
expect(mockResponse.setHeader).toHaveBeenCalledWith('X-Frame-Options', 'DENY');
expect(mockResponse.setHeader).toHaveBeenCalledWith('X-XSS-Protection', '1; mode=block');
expect(nextFunction).toHaveBeenCalled();
it('should apply security headers', () => {
const mockRequest = new Request('http://localhost');
const headers = applySecurityHeaders(mockRequest);
expect(headers).toBeDefined();
expect(headers['content-security-policy']).toBeDefined();
expect(headers['x-frame-options']).toBeDefined();
expect(headers['x-content-type-options']).toBeDefined();
expect(headers['referrer-policy']).toBeDefined();
});
});
describe('Error Handling', () => {
it('should handle errors in production mode', () => {
const error = new Error('Test error');
const result = handleError(error, 'production');
expect(result).toEqual({
error: true,
message: 'Internal server error',
timestamp: expect.any(String)
});
});
it('should include error details in development mode', () => {
const error = new Error('Test error');
const result = handleError(error, 'development');
expect(result).toEqual({
error: true,
message: 'Internal server error',
timestamp: expect.any(String),
error: 'Test error',
stack: expect.any(String)
});
});
});
});

View File

@@ -1,6 +1,17 @@
import { TokenManager } from '../../src/security/index.js';
import jwt from 'jsonwebtoken';
const TEST_SECRET = 'test-secret-that-is-long-enough-for-testing-purposes';
describe('TokenManager', () => {
beforeAll(() => {
process.env.JWT_SECRET = TEST_SECRET;
});
afterAll(() => {
delete process.env.JWT_SECRET;
});
const encryptionKey = 'test-encryption-key-32-chars-long!!';
const validToken = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiZXhwIjoxNjE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c';
@@ -35,27 +46,51 @@ describe('TokenManager', () => {
describe('Token Validation', () => {
it('should validate correct tokens', () => {
const validJwt = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiZXhwIjoxNjcyNTI3OTk5fQ.Q6cm_sZS6uqfGqO3LQ-0VqNXhqXR6mFh6IP7s0NPnSQ';
expect(TokenManager.validateToken(validJwt)).toBe(true);
const payload = { sub: '123', name: 'Test User', iat: Math.floor(Date.now() / 1000), exp: Math.floor(Date.now() / 1000) + 3600 };
const token = jwt.sign(payload, TEST_SECRET);
const result = TokenManager.validateToken(token);
expect(result.valid).toBe(true);
expect(result.error).toBeUndefined();
});
it('should reject expired tokens', () => {
const expiredToken = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiZXhwIjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c';
expect(TokenManager.validateToken(expiredToken)).toBe(false);
const payload = { sub: '123', name: 'Test User', iat: Math.floor(Date.now() / 1000) - 7200, exp: Math.floor(Date.now() / 1000) - 3600 };
const token = jwt.sign(payload, TEST_SECRET);
const result = TokenManager.validateToken(token);
expect(result.valid).toBe(false);
expect(result.error).toBe('Token has expired');
});
it('should reject malformed tokens', () => {
expect(TokenManager.validateToken('invalid-token')).toBe(false);
const result = TokenManager.validateToken('invalid-token');
expect(result.valid).toBe(false);
expect(result.error).toBe('Token length below minimum requirement');
});
it('should reject tokens with invalid signature', () => {
const tamperedToken = validToken.slice(0, -5) + 'xxxxx';
expect(TokenManager.validateToken(tamperedToken)).toBe(false);
const payload = { sub: '123', name: 'Test User', iat: Math.floor(Date.now() / 1000), exp: Math.floor(Date.now() / 1000) + 3600 };
const token = jwt.sign(payload, 'different-secret');
const result = TokenManager.validateToken(token);
expect(result.valid).toBe(false);
expect(result.error).toBe('Invalid token signature');
});
it('should handle tokens with missing expiration', () => {
const noExpToken = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIn0.Q6cm_sZS6uqfGqO3LQ-0VqNXhqXR6mFh6IP7s0NPnSQ';
expect(TokenManager.validateToken(noExpToken)).toBe(false);
const payload = { sub: '123', name: 'Test User' };
const token = jwt.sign(payload, TEST_SECRET);
const result = TokenManager.validateToken(token);
expect(result.valid).toBe(false);
expect(result.error).toBe('Token missing required claims');
});
it('should handle undefined and null inputs', () => {
const undefinedResult = TokenManager.validateToken(undefined);
expect(undefinedResult.valid).toBe(false);
expect(undefinedResult.error).toBe('Invalid token format');
const nullResult = TokenManager.validateToken(null);
expect(nullResult.valid).toBe(false);
expect(nullResult.error).toBe('Invalid token format');
});
});
@@ -103,10 +138,5 @@ describe('TokenManager', () => {
it('should handle invalid base64 input', () => {
expect(() => TokenManager.decryptToken('not-base64!@#$%^', encryptionKey)).toThrow();
});
it('should handle undefined and null inputs', () => {
expect(TokenManager.validateToken(undefined as any)).toBe(false);
expect(TokenManager.validateToken(null as any)).toBe(false);
});
});
});

527
bun.lock Normal file
View File

@@ -0,0 +1,527 @@
{
"lockfileVersion": 1,
"workspaces": {
"": {
"name": "homeassistant-mcp",
"dependencies": {
"@elysiajs/cors": "^1.2.0",
"@elysiajs/swagger": "^1.2.0",
"@types/jsonwebtoken": "^9.0.5",
"@types/node": "^20.11.24",
"@types/sanitize-html": "^2.9.5",
"@types/ws": "^8.5.10",
"dotenv": "^16.4.5",
"elysia": "^1.2.11",
"helmet": "^7.1.0",
"jsonwebtoken": "^9.0.2",
"node-fetch": "^3.3.2",
"sanitize-html": "^2.11.0",
"typescript": "^5.3.3",
"ws": "^8.16.0",
"zod": "^3.22.4",
},
"devDependencies": {
"@types/uuid": "^10.0.0",
"@typescript-eslint/eslint-plugin": "^7.1.0",
"@typescript-eslint/parser": "^7.1.0",
"bun-types": "^1.2.2",
"eslint": "^8.57.0",
"eslint-config-prettier": "^9.1.0",
"eslint-plugin-prettier": "^5.1.3",
"husky": "^9.0.11",
"prettier": "^3.2.5",
"supertest": "^6.3.3",
"uuid": "^11.0.5",
},
},
},
"packages": {
"@elysiajs/cors": ["@elysiajs/cors@1.2.0", "", { "peerDependencies": { "elysia": ">= 1.2.0" } }, "sha512-qsJwDAg6WfdQRMfj6uSMcDPSpXvm/zQFeAX1uuJXhIgazH8itSfcDxcH9pMuXVRX1yQNi2pPwNQLJmAcw5mzvw=="],
"@elysiajs/swagger": ["@elysiajs/swagger@1.2.0", "", { "dependencies": { "@scalar/themes": "^0.9.52", "@scalar/types": "^0.0.12", "openapi-types": "^12.1.3", "pathe": "^1.1.2" }, "peerDependencies": { "elysia": ">= 1.2.0" } }, "sha512-OPx93DP6rM2VHjA3D44Xiz5MYm9AYlO2NGWPsnSsdyvaOCiL9wJj529583h7arX4iIEYE5LiLB0/A45unqbopw=="],
"@eslint-community/eslint-utils": ["@eslint-community/eslint-utils@4.4.1", "", { "dependencies": { "eslint-visitor-keys": "^3.4.3" }, "peerDependencies": { "eslint": "^6.0.0 || ^7.0.0 || >=8.0.0" } }, "sha512-s3O3waFUrMV8P/XaF/+ZTp1X9XBZW1a4B97ZnjQF2KYWaFD2A8KyFBsrsfSjEmjn3RGWAIuvlneuZm3CUK3jbA=="],
"@eslint-community/regexpp": ["@eslint-community/regexpp@4.12.1", "", {}, "sha512-CCZCDJuduB9OUkFkY2IgppNZMi2lBQgD2qzwXkEia16cge2pijY/aXi96CJMquDMn3nJdlPV1A5KrJEXwfLNzQ=="],
"@eslint/eslintrc": ["@eslint/eslintrc@2.1.4", "", { "dependencies": { "ajv": "^6.12.4", "debug": "^4.3.2", "espree": "^9.6.0", "globals": "^13.19.0", "ignore": "^5.2.0", "import-fresh": "^3.2.1", "js-yaml": "^4.1.0", "minimatch": "^3.1.2", "strip-json-comments": "^3.1.1" } }, "sha512-269Z39MS6wVJtsoUl10L60WdkhJVdPG24Q4eZTH3nnF6lpvSShEK3wQjDX9JRWAUPvPh7COouPpU9IrqaZFvtQ=="],
"@eslint/js": ["@eslint/js@8.57.1", "", {}, "sha512-d9zaMRSTIKDLhctzH12MtXvJKSSUhaHcjV+2Z+GK+EEY7XKpP5yR4x+N3TAcHTcu963nIr+TMcCb4DBCYX1z6Q=="],
"@humanwhocodes/config-array": ["@humanwhocodes/config-array@0.13.0", "", { "dependencies": { "@humanwhocodes/object-schema": "^2.0.3", "debug": "^4.3.1", "minimatch": "^3.0.5" } }, "sha512-DZLEEqFWQFiyK6h5YIeynKx7JlvCYWL0cImfSRXZ9l4Sg2efkFGTuFf6vzXjK1cq6IYkU+Eg/JizXw+TD2vRNw=="],
"@humanwhocodes/module-importer": ["@humanwhocodes/module-importer@1.0.1", "", {}, "sha512-bxveV4V8v5Yb4ncFTT3rPSgZBOpCkjfK0y4oVVVJwIuDVBRMDXrPyXRL988i5ap9m9bnyEEjWfm5WkBmtffLfA=="],
"@humanwhocodes/object-schema": ["@humanwhocodes/object-schema@2.0.3", "", {}, "sha512-93zYdMES/c1D69yZiKDBj0V24vqNzB/koF26KPaagAfd3P/4gUlh3Dys5ogAK+Exi9QyzlD8x/08Zt7wIKcDcA=="],
"@nodelib/fs.scandir": ["@nodelib/fs.scandir@2.1.5", "", { "dependencies": { "@nodelib/fs.stat": "2.0.5", "run-parallel": "^1.1.9" } }, "sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g=="],
"@nodelib/fs.stat": ["@nodelib/fs.stat@2.0.5", "", {}, "sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A=="],
"@nodelib/fs.walk": ["@nodelib/fs.walk@1.2.8", "", { "dependencies": { "@nodelib/fs.scandir": "2.1.5", "fastq": "^1.6.0" } }, "sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg=="],
"@pkgr/core": ["@pkgr/core@0.1.1", "", {}, "sha512-cq8o4cWH0ibXh9VGi5P20Tu9XF/0fFXl9EUinr9QfTM7a7p0oTA4iJRCQWppXR1Pg8dSM0UCItCkPwsk9qWWYA=="],
"@scalar/openapi-types": ["@scalar/openapi-types@0.1.1", "", {}, "sha512-NMy3QNk6ytcCoPUGJH0t4NNr36OWXgZhA3ormr3TvhX1NDgoF95wFyodGVH8xiHeUyn2/FxtETm8UBLbB5xEmg=="],
"@scalar/themes": ["@scalar/themes@0.9.64", "", { "dependencies": { "@scalar/types": "0.0.30" } }, "sha512-hr9bCTdH9M/N8w31Td+IJVtbH+v0Ej31myW8QWhUfwYZe5qS815Tl1mp+qWFaObstOw5VX3zOtiZuuhF1zMIyw=="],
"@scalar/types": ["@scalar/types@0.0.12", "", { "dependencies": { "@scalar/openapi-types": "0.1.1", "@unhead/schema": "^1.9.5" } }, "sha512-XYZ36lSEx87i4gDqopQlGCOkdIITHHEvgkuJFrXFATQs9zHARop0PN0g4RZYWj+ZpCUclOcaOjbCt8JGe22mnQ=="],
"@sinclair/typebox": ["@sinclair/typebox@0.34.15", "", {}, "sha512-xeIzl3h1Znn9w/LTITqpiwag0gXjA+ldi2ZkXIBxGEppGCW211Tza+eL6D4pKqs10bj5z2umBWk5WL6spQ2OCQ=="],
"@types/jsonwebtoken": ["@types/jsonwebtoken@9.0.8", "", { "dependencies": { "@types/ms": "*", "@types/node": "*" } }, ""],
"@types/ms": ["@types/ms@2.1.0", "", {}, ""],
"@types/node": ["@types/node@20.17.16", "", { "dependencies": { "undici-types": "~6.19.2" } }, ""],
"@types/sanitize-html": ["@types/sanitize-html@2.13.0", "", { "dependencies": { "htmlparser2": "^8.0.0" } }, "sha512-X31WxbvW9TjIhZZNyNBZ/p5ax4ti7qsNDBDEnH4zAgmEh35YnFD1UiS6z9Cd34kKm0LslFW0KPmTQzu/oGtsqQ=="],
"@types/uuid": ["@types/uuid@10.0.0", "", {}, "sha512-7gqG38EyHgyP1S+7+xomFtL+ZNHcKv6DwNaCZmJmo1vgMugyF3TCnXVg4t1uk89mLNwnLtnY3TpOpCOyp1/xHQ=="],
"@types/ws": ["@types/ws@8.5.14", "", { "dependencies": { "@types/node": "*" } }, ""],
"@typescript-eslint/eslint-plugin": ["@typescript-eslint/eslint-plugin@7.18.0", "", { "dependencies": { "@eslint-community/regexpp": "^4.10.0", "@typescript-eslint/scope-manager": "7.18.0", "@typescript-eslint/type-utils": "7.18.0", "@typescript-eslint/utils": "7.18.0", "@typescript-eslint/visitor-keys": "7.18.0", "graphemer": "^1.4.0", "ignore": "^5.3.1", "natural-compare": "^1.4.0", "ts-api-utils": "^1.3.0" }, "peerDependencies": { "@typescript-eslint/parser": "^7.0.0", "eslint": "^8.56.0" } }, "sha512-94EQTWZ40mzBc42ATNIBimBEDltSJ9RQHCC8vc/PDbxi4k8dVwUAv4o98dk50M1zB+JGFxp43FP7f8+FP8R6Sw=="],
"@typescript-eslint/parser": ["@typescript-eslint/parser@7.18.0", "", { "dependencies": { "@typescript-eslint/scope-manager": "7.18.0", "@typescript-eslint/types": "7.18.0", "@typescript-eslint/typescript-estree": "7.18.0", "@typescript-eslint/visitor-keys": "7.18.0", "debug": "^4.3.4" }, "peerDependencies": { "eslint": "^8.56.0" } }, "sha512-4Z+L8I2OqhZV8qA132M4wNL30ypZGYOQVBfMgxDH/K5UX0PNqTu1c6za9ST5r9+tavvHiTWmBnKzpCJ/GlVFtg=="],
"@typescript-eslint/scope-manager": ["@typescript-eslint/scope-manager@7.18.0", "", { "dependencies": { "@typescript-eslint/types": "7.18.0", "@typescript-eslint/visitor-keys": "7.18.0" } }, "sha512-jjhdIE/FPF2B7Z1uzc6i3oWKbGcHb87Qw7AWj6jmEqNOfDFbJWtjt/XfwCpvNkpGWlcJaog5vTR+VV8+w9JflA=="],
"@typescript-eslint/type-utils": ["@typescript-eslint/type-utils@7.18.0", "", { "dependencies": { "@typescript-eslint/typescript-estree": "7.18.0", "@typescript-eslint/utils": "7.18.0", "debug": "^4.3.4", "ts-api-utils": "^1.3.0" }, "peerDependencies": { "eslint": "^8.56.0" } }, "sha512-XL0FJXuCLaDuX2sYqZUUSOJ2sG5/i1AAze+axqmLnSkNEVMVYLF+cbwlB2w8D1tinFuSikHmFta+P+HOofrLeA=="],
"@typescript-eslint/types": ["@typescript-eslint/types@7.18.0", "", {}, "sha512-iZqi+Ds1y4EDYUtlOOC+aUmxnE9xS/yCigkjA7XpTKV6nCBd3Hp/PRGGmdwnfkV2ThMyYldP1wRpm/id99spTQ=="],
"@typescript-eslint/typescript-estree": ["@typescript-eslint/typescript-estree@7.18.0", "", { "dependencies": { "@typescript-eslint/types": "7.18.0", "@typescript-eslint/visitor-keys": "7.18.0", "debug": "^4.3.4", "globby": "^11.1.0", "is-glob": "^4.0.3", "minimatch": "^9.0.4", "semver": "^7.6.0", "ts-api-utils": "^1.3.0" } }, "sha512-aP1v/BSPnnyhMHts8cf1qQ6Q1IFwwRvAQGRvBFkWlo3/lH29OXA3Pts+c10nxRxIBrDnoMqzhgdwVe5f2D6OzA=="],
"@typescript-eslint/utils": ["@typescript-eslint/utils@7.18.0", "", { "dependencies": { "@eslint-community/eslint-utils": "^4.4.0", "@typescript-eslint/scope-manager": "7.18.0", "@typescript-eslint/types": "7.18.0", "@typescript-eslint/typescript-estree": "7.18.0" }, "peerDependencies": { "eslint": "^8.56.0" } }, "sha512-kK0/rNa2j74XuHVcoCZxdFBMF+aq/vH83CXAOHieC+2Gis4mF8jJXT5eAfyD3K0sAxtPuwxaIOIOvhwzVDt/kw=="],
"@typescript-eslint/visitor-keys": ["@typescript-eslint/visitor-keys@7.18.0", "", { "dependencies": { "@typescript-eslint/types": "7.18.0", "eslint-visitor-keys": "^3.4.3" } }, "sha512-cDF0/Gf81QpY3xYyJKDV14Zwdmid5+uuENhjH2EqFaF0ni+yAyq/LzMaIJdhNJXZI7uLzwIlA+V7oWoyn6Curg=="],
"@ungap/structured-clone": ["@ungap/structured-clone@1.3.0", "", {}, "sha512-WmoN8qaIAo7WTYWbAZuG8PYEhn5fkz7dZrqTBZ7dtt//lL2Gwms1IcnQ5yHqjDfX8Ft5j4YzDM23f87zBfDe9g=="],
"@unhead/schema": ["@unhead/schema@1.11.18", "", { "dependencies": { "hookable": "^5.5.3", "zhead": "^2.2.4" } }, "sha512-a3TA/OJCRdfbFhcA3Hq24k1ZU1o9szicESrw8DZcGyQFacHnh84mVgnyqSkMnwgCmfN4kvjSiTBlLEHS6+wATw=="],
"acorn": ["acorn@8.14.0", "", { "bin": "bin/acorn" }, "sha512-cl669nCJTZBsL97OF4kUQm5g5hC2uihk0NxY3WENAC0TYdILVkAyHymAntgxGkl7K+t0cXIrH5siy5S4XkFycA=="],
"acorn-jsx": ["acorn-jsx@5.3.2", "", { "peerDependencies": { "acorn": "^6.0.0 || ^7.0.0 || ^8.0.0" } }, "sha512-rq9s+JNhf0IChjtDXxllJ7g41oZk5SlXtp0LHwyA5cejwn7vKmKp4pPri6YEePv2PU65sAsegbXtIinmDFDXgQ=="],
"ajv": ["ajv@6.12.6", "", { "dependencies": { "fast-deep-equal": "^3.1.1", "fast-json-stable-stringify": "^2.0.0", "json-schema-traverse": "^0.4.1", "uri-js": "^4.2.2" } }, "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g=="],
"ansi-regex": ["ansi-regex@5.0.1", "", {}, ""],
"ansi-styles": ["ansi-styles@4.3.0", "", { "dependencies": { "color-convert": "^2.0.1" } }, "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg=="],
"argparse": ["argparse@2.0.1", "", {}, ""],
"array-union": ["array-union@2.1.0", "", {}, "sha512-HGyxoOTYUyCM6stUe6EJgnd4EoewAI7zMdfqO+kGjnlZmBDz/cR5pf8r/cR4Wq60sL/p0IkcjUEEPwS3GFrIyw=="],
"asap": ["asap@2.0.6", "", {}, ""],
"asynckit": ["asynckit@0.4.0", "", {}, ""],
"balanced-match": ["balanced-match@1.0.2", "", {}, ""],
"brace-expansion": ["brace-expansion@1.1.11", "", { "dependencies": { "balanced-match": "^1.0.0", "concat-map": "0.0.1" } }, "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA=="],
"braces": ["braces@3.0.3", "", { "dependencies": { "fill-range": "^7.1.1" } }, ""],
"buffer-equal-constant-time": ["buffer-equal-constant-time@1.0.1", "", {}, ""],
"bun-types": ["bun-types@1.2.2", "", { "dependencies": { "@types/node": "*", "@types/ws": "~8.5.10" } }, "sha512-RCbMH5elr9gjgDGDhkTTugA21XtJAy/9jkKe/G3WR2q17VPGhcquf9Sir6uay9iW+7P/BV0CAHA1XlHXMAVKHg=="],
"call-bind-apply-helpers": ["call-bind-apply-helpers@1.0.1", "", { "dependencies": { "es-errors": "^1.3.0", "function-bind": "^1.1.2" } }, ""],
"call-bound": ["call-bound@1.0.3", "", { "dependencies": { "call-bind-apply-helpers": "^1.0.1", "get-intrinsic": "^1.2.6" } }, ""],
"callsites": ["callsites@3.1.0", "", {}, ""],
"chalk": ["chalk@4.1.2", "", { "dependencies": { "ansi-styles": "^4.1.0", "supports-color": "^7.1.0" } }, "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA=="],
"color-convert": ["color-convert@2.0.1", "", { "dependencies": { "color-name": "~1.1.4" } }, ""],
"color-name": ["color-name@1.1.4", "", {}, ""],
"combined-stream": ["combined-stream@1.0.8", "", { "dependencies": { "delayed-stream": "~1.0.0" } }, ""],
"component-emitter": ["component-emitter@1.3.1", "", {}, ""],
"concat-map": ["concat-map@0.0.1", "", {}, ""],
"cookie": ["cookie@1.0.2", "", {}, "sha512-9Kr/j4O16ISv8zBBhJoi4bXOYNTkFLOqSL3UDB0njXxCXNezjeyVrJyGOWtgfs/q2km1gwBcfH8q1yEGoMYunA=="],
"cookiejar": ["cookiejar@2.1.4", "", {}, ""],
"cross-spawn": ["cross-spawn@7.0.6", "", { "dependencies": { "path-key": "^3.1.0", "shebang-command": "^2.0.0", "which": "^2.0.1" } }, ""],
"data-uri-to-buffer": ["data-uri-to-buffer@4.0.1", "", {}, "sha512-0R9ikRb668HB7QDxT1vkpuUBtqc53YyAwMwGeUFKRojY/NWKvdZ+9UYtRfGmhqNbRkTSVpMbmyhXipFFv2cb/A=="],
"debug": ["debug@4.4.0", "", { "dependencies": { "ms": "^2.1.3" } }, "sha512-6WTZ/IxCY/T6BALoZHaE4ctp9xm+Z5kY/pzYaCHRFeyVhojxlrm+46y68HA6hr0TcwEssoxNiDEUJQjfPZ/RYA=="],
"deep-is": ["deep-is@0.1.4", "", {}, "sha512-oIPzksmTg4/MriiaYGO+okXDT7ztn/w3Eptv/+gSIdMdKsJo0u4CfYNFJPy+4SKMuCqGw2wxnA+URMg3t8a/bQ=="],
"deepmerge": ["deepmerge@4.3.1", "", {}, ""],
"delayed-stream": ["delayed-stream@1.0.0", "", {}, ""],
"dezalgo": ["dezalgo@1.0.4", "", { "dependencies": { "asap": "^2.0.0", "wrappy": "1" } }, ""],
"dir-glob": ["dir-glob@3.0.1", "", { "dependencies": { "path-type": "^4.0.0" } }, "sha512-WkrWp9GR4KXfKGYzOLmTuGVi1UWFfws377n9cc55/tb6DuqyF6pcQ5AbiHEshaDpY9v6oaSr2XCDidGmMwdzIA=="],
"doctrine": ["doctrine@3.0.0", "", { "dependencies": { "esutils": "^2.0.2" } }, "sha512-yS+Q5i3hBf7GBkd4KG8a7eBNNWNGLTaEwwYWUijIYM7zrlYDM0BFXHjjPWlWZ1Rg7UaddZeIDmi9jF3HmqiQ2w=="],
"dom-serializer": ["dom-serializer@2.0.0", "", { "dependencies": { "domelementtype": "^2.3.0", "domhandler": "^5.0.2", "entities": "^4.2.0" } }, "sha512-wIkAryiqt/nV5EQKqQpo3SToSOV9J0DnbJqwK7Wv/Trc92zIAYZ4FlMu+JPFW1DfGFt81ZTCGgDEabffXeLyJg=="],
"domelementtype": ["domelementtype@2.3.0", "", {}, "sha512-OLETBj6w0OsagBwdXnPdN0cnMfF9opN69co+7ZrbfPGrdpPVNBUj02spi6B1N7wChLQiPn4CSH/zJvXw56gmHw=="],
"domhandler": ["domhandler@5.0.3", "", { "dependencies": { "domelementtype": "^2.3.0" } }, "sha512-cgwlv/1iFQiFnU96XXgROh8xTeetsnJiDsTc7TYCLFd9+/WNkIqPTxiM/8pSd8VIrhXGTf1Ny1q1hquVqDJB5w=="],
"domutils": ["domutils@3.2.2", "", { "dependencies": { "dom-serializer": "^2.0.0", "domelementtype": "^2.3.0", "domhandler": "^5.0.3" } }, "sha512-6kZKyUajlDuqlHKVX1w7gyslj9MPIXzIFiz/rGu35uC1wMi+kMhQwGhl4lt9unC9Vb9INnY9Z3/ZA3+FhASLaw=="],
"dotenv": ["dotenv@16.4.7", "", {}, ""],
"dunder-proto": ["dunder-proto@1.0.1", "", { "dependencies": { "call-bind-apply-helpers": "^1.0.1", "es-errors": "^1.3.0", "gopd": "^1.2.0" } }, ""],
"ecdsa-sig-formatter": ["ecdsa-sig-formatter@1.0.11", "", { "dependencies": { "safe-buffer": "^5.0.1" } }, ""],
"elysia": ["elysia@1.2.12", "", { "dependencies": { "@sinclair/typebox": "^0.34.15", "cookie": "^1.0.2", "memoirist": "^0.3.0", "openapi-types": "^12.1.3" }, "peerDependencies": { "typescript": ">= 5.0.0" }, "optionalPeers": ["typescript"] }, "sha512-X1bZo09qe8/Poa/5tz08Y+sE/77B/wLwnA5xDDENU3FCrsUtYJuBVcy6BPXGRCgnJ1fPQpc0Ov2ZU5MYJXluTg=="],
"entities": ["entities@4.5.0", "", {}, "sha512-V0hjH4dGPh9Ao5p0MoRY6BVqtwCjhz6vI5LT8AJ55H+4g9/4vbHx1I54fS0XuclLhDHArPQCiMjDxjaL8fPxhw=="],
"es-define-property": ["es-define-property@1.0.1", "", {}, ""],
"es-errors": ["es-errors@1.3.0", "", {}, ""],
"es-object-atoms": ["es-object-atoms@1.1.1", "", { "dependencies": { "es-errors": "^1.3.0" } }, ""],
"escape-string-regexp": ["escape-string-regexp@4.0.0", "", {}, "sha512-TtpcNJ3XAzx3Gq8sWRzJaVajRs0uVxA2YAkdb1jm2YkPz4G6egUFAyA3n5vtEIZefPk5Wa4UXbKuS5fKkJWdgA=="],
"eslint": ["eslint@8.57.1", "", { "dependencies": { "@eslint-community/eslint-utils": "^4.2.0", "@eslint-community/regexpp": "^4.6.1", "@eslint/eslintrc": "^2.1.4", "@eslint/js": "8.57.1", "@humanwhocodes/config-array": "^0.13.0", "@humanwhocodes/module-importer": "^1.0.1", "@nodelib/fs.walk": "^1.2.8", "@ungap/structured-clone": "^1.2.0", "ajv": "^6.12.4", "chalk": "^4.0.0", "cross-spawn": "^7.0.2", "debug": "^4.3.2", "doctrine": "^3.0.0", "escape-string-regexp": "^4.0.0", "eslint-scope": "^7.2.2", "eslint-visitor-keys": "^3.4.3", "espree": "^9.6.1", "esquery": "^1.4.2", "esutils": "^2.0.2", "fast-deep-equal": "^3.1.3", "file-entry-cache": "^6.0.1", "find-up": "^5.0.0", "glob-parent": "^6.0.2", "globals": "^13.19.0", "graphemer": "^1.4.0", "ignore": "^5.2.0", "imurmurhash": "^0.1.4", "is-glob": "^4.0.0", "is-path-inside": "^3.0.3", "js-yaml": "^4.1.0", "json-stable-stringify-without-jsonify": "^1.0.1", "levn": "^0.4.1", "lodash.merge": "^4.6.2", "minimatch": "^3.1.2", "natural-compare": "^1.4.0", "optionator": "^0.9.3", "strip-ansi": "^6.0.1", "text-table": "^0.2.0" }, "bin": "bin/eslint.js" }, "sha512-ypowyDxpVSYpkXr9WPv2PAZCtNip1Mv5KTW0SCurXv/9iOpcrH9PaqUElksqEB6pChqHGDRCFTyrZlGhnLNGiA=="],
"eslint-config-prettier": ["eslint-config-prettier@9.1.0", "", { "peerDependencies": { "eslint": ">=7.0.0" }, "bin": "bin/cli.js" }, "sha512-NSWl5BFQWEPi1j4TjVNItzYV7dZXZ+wP6I6ZhrBGpChQhZRUaElihE9uRRkcbRnNb76UMKDF3r+WTmNcGPKsqw=="],
"eslint-plugin-prettier": ["eslint-plugin-prettier@5.2.3", "", { "dependencies": { "prettier-linter-helpers": "^1.0.0", "synckit": "^0.9.1" }, "peerDependencies": { "@types/eslint": ">=8.0.0", "eslint": ">=8.0.0", "eslint-config-prettier": "*", "prettier": ">=3.0.0" }, "optionalPeers": ["@types/eslint"] }, "sha512-qJ+y0FfCp/mQYQ/vWQ3s7eUlFEL4PyKfAJxsnYTJ4YT73nsJBWqmEpFryxV9OeUiqmsTsYJ5Y+KDNaeP31wrRw=="],
"eslint-scope": ["eslint-scope@7.2.2", "", { "dependencies": { "esrecurse": "^4.3.0", "estraverse": "^5.2.0" } }, "sha512-dOt21O7lTMhDM+X9mB4GX+DZrZtCUJPL/wlcTqxyrx5IvO0IYtILdtrQGQp+8n5S0gwSVmOf9NQrjMOgfQZlIg=="],
"eslint-visitor-keys": ["eslint-visitor-keys@3.4.3", "", {}, "sha512-wpc+LXeiyiisxPlEkUzU6svyS1frIO3Mgxj1fdy7Pm8Ygzguax2N3Fa/D/ag1WqbOprdI+uY6wMUl8/a2G+iag=="],
"espree": ["espree@9.6.1", "", { "dependencies": { "acorn": "^8.9.0", "acorn-jsx": "^5.3.2", "eslint-visitor-keys": "^3.4.1" } }, "sha512-oruZaFkjorTpF32kDSI5/75ViwGeZginGGy2NoOSg3Q9bnwlnmDm4HLnkl0RE3n+njDXR037aY1+x58Z/zFdwQ=="],
"esquery": ["esquery@1.6.0", "", { "dependencies": { "estraverse": "^5.1.0" } }, "sha512-ca9pw9fomFcKPvFLXhBKUK90ZvGibiGOvRJNbjljY7s7uq/5YO4BOzcYtJqExdx99rF6aAcnRxHmcUHcz6sQsg=="],
"esrecurse": ["esrecurse@4.3.0", "", { "dependencies": { "estraverse": "^5.2.0" } }, "sha512-KmfKL3b6G+RXvP8N1vr3Tq1kL/oCFgn2NYXEtqP8/L3pKapUA4G8cFVaoF3SU323CD4XypR/ffioHmkti6/Tag=="],
"estraverse": ["estraverse@5.3.0", "", {}, "sha512-MMdARuVEQziNTeJD8DgMqmhwR11BRQ/cBP+pLtYdSTnf3MIO8fFeiINEbX36ZdNlfU/7A9f3gUw49B3oQsvwBA=="],
"esutils": ["esutils@2.0.3", "", {}, "sha512-kVscqXk4OCp68SZ0dkgEKVi6/8ij300KBWTJq32P/dYeWTSwK41WyTxalN1eRmA5Z9UU/LX9D7FWSmV9SAYx6g=="],
"fast-deep-equal": ["fast-deep-equal@3.1.3", "", {}, ""],
"fast-diff": ["fast-diff@1.3.0", "", {}, "sha512-VxPP4NqbUjj6MaAOafWeUn2cXWLcCtljklUtZf0Ind4XQ+QPtmA0b18zZy0jIQx+ExRVCR/ZQpBmik5lXshNsw=="],
"fast-glob": ["fast-glob@3.3.3", "", { "dependencies": { "@nodelib/fs.stat": "^2.0.2", "@nodelib/fs.walk": "^1.2.3", "glob-parent": "^5.1.2", "merge2": "^1.3.0", "micromatch": "^4.0.8" } }, "sha512-7MptL8U0cqcFdzIzwOTHoilX9x5BrNqye7Z/LuC7kCMRio1EMSyqRK3BEAUD7sXRq4iT4AzTVuZdhgQ2TCvYLg=="],
"fast-json-stable-stringify": ["fast-json-stable-stringify@2.1.0", "", {}, ""],
"fast-levenshtein": ["fast-levenshtein@2.0.6", "", {}, "sha512-DCXu6Ifhqcks7TZKY3Hxp3y6qphY5SJZmrWMDrKcERSOXWQdMhU9Ig/PYrzyw/ul9jOIyh0N4M0tbC5hodg8dw=="],
"fast-safe-stringify": ["fast-safe-stringify@2.1.1", "", {}, ""],
"fastq": ["fastq@1.19.0", "", { "dependencies": { "reusify": "^1.0.4" } }, "sha512-7SFSRCNjBQIZH/xZR3iy5iQYR8aGBE0h3VG6/cwlbrpdciNYBMotQav8c1XI3HjHH+NikUpP53nPdlZSdWmFzA=="],
"fetch-blob": ["fetch-blob@3.2.0", "", { "dependencies": { "node-domexception": "^1.0.0", "web-streams-polyfill": "^3.0.3" } }, "sha512-7yAQpD2UMJzLi1Dqv7qFYnPbaPx7ZfFK6PiIxQ4PfkGPyNyl2Ugx+a/umUonmKqjhM4DnfbMvdX6otXq83soQQ=="],
"file-entry-cache": ["file-entry-cache@6.0.1", "", { "dependencies": { "flat-cache": "^3.0.4" } }, "sha512-7Gps/XWymbLk2QLYK4NzpMOrYjMhdIxXuIvy2QBsLE6ljuodKvdkWs/cpyJJ3CVIVpH0Oi1Hvg1ovbMzLdFBBg=="],
"fill-range": ["fill-range@7.1.1", "", { "dependencies": { "to-regex-range": "^5.0.1" } }, ""],
"find-up": ["find-up@5.0.0", "", { "dependencies": { "locate-path": "^6.0.0", "path-exists": "^4.0.0" } }, "sha512-78/PXT1wlLLDgTzDs7sjq9hzz0vXD+zn+7wypEe4fXQxCmdmqfGsEPQxmiCSQI3ajFV91bVSsvNtrJRiW6nGng=="],
"flat-cache": ["flat-cache@3.2.0", "", { "dependencies": { "flatted": "^3.2.9", "keyv": "^4.5.3", "rimraf": "^3.0.2" } }, "sha512-CYcENa+FtcUKLmhhqyctpclsq7QF38pKjZHsGNiSQF5r4FtoKDWabFDl3hzaEQMvT1LHEysw5twgLvpYYb4vbw=="],
"flatted": ["flatted@3.3.2", "", {}, "sha512-AiwGJM8YcNOaobumgtng+6NHuOqC3A7MixFeDafM3X9cIUM+xUXoS5Vfgf+OihAYe20fxqNM9yPBXJzRtZ/4eA=="],
"form-data": ["form-data@4.0.1", "", { "dependencies": { "asynckit": "^0.4.0", "combined-stream": "^1.0.8", "mime-types": "^2.1.12" } }, ""],
"formdata-polyfill": ["formdata-polyfill@4.0.10", "", { "dependencies": { "fetch-blob": "^3.1.2" } }, "sha512-buewHzMvYL29jdeQTVILecSaZKnt/RJWjoZCF5OW60Z67/GmSLBkOFM7qh1PI3zFNtJbaZL5eQu1vLfazOwj4g=="],
"formidable": ["formidable@2.1.2", "", { "dependencies": { "dezalgo": "^1.0.4", "hexoid": "^1.0.0", "once": "^1.4.0", "qs": "^6.11.0" } }, ""],
"fs.realpath": ["fs.realpath@1.0.0", "", {}, ""],
"function-bind": ["function-bind@1.1.2", "", {}, ""],
"get-intrinsic": ["get-intrinsic@1.2.7", "", { "dependencies": { "call-bind-apply-helpers": "^1.0.1", "es-define-property": "^1.0.1", "es-errors": "^1.3.0", "es-object-atoms": "^1.0.0", "function-bind": "^1.1.2", "get-proto": "^1.0.0", "gopd": "^1.2.0", "has-symbols": "^1.1.0", "hasown": "^2.0.2", "math-intrinsics": "^1.1.0" } }, ""],
"get-proto": ["get-proto@1.0.1", "", { "dependencies": { "dunder-proto": "^1.0.1", "es-object-atoms": "^1.0.0" } }, ""],
"glob": ["glob@7.2.3", "", { "dependencies": { "fs.realpath": "^1.0.0", "inflight": "^1.0.4", "inherits": "2", "minimatch": "^3.1.1", "once": "^1.3.0", "path-is-absolute": "^1.0.0" } }, "sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q=="],
"glob-parent": ["glob-parent@6.0.2", "", { "dependencies": { "is-glob": "^4.0.3" } }, "sha512-XxwI8EOhVQgWp6iDL+3b0r86f4d6AX6zSU55HfB4ydCEuXLXc5FcYeOu+nnGftS4TEju/11rt4KJPTMgbfmv4A=="],
"globals": ["globals@13.24.0", "", { "dependencies": { "type-fest": "^0.20.2" } }, "sha512-AhO5QUcj8llrbG09iWhPU2B204J1xnPeL8kQmVorSsy+Sjj1sk8gIyh6cUocGmH4L0UuhAJy+hJMRA4mgA4mFQ=="],
"globby": ["globby@11.1.0", "", { "dependencies": { "array-union": "^2.1.0", "dir-glob": "^3.0.1", "fast-glob": "^3.2.9", "ignore": "^5.2.0", "merge2": "^1.4.1", "slash": "^3.0.0" } }, "sha512-jhIXaOzy1sb8IyocaruWSn1TjmnBVs8Ayhcy83rmxNJ8q2uWKCAj3CnJY+KpGSXCueAPc0i05kVvVKtP1t9S3g=="],
"gopd": ["gopd@1.2.0", "", {}, ""],
"graphemer": ["graphemer@1.4.0", "", {}, "sha512-EtKwoO6kxCL9WO5xipiHTZlSzBm7WLT627TqC/uVRd0HKmq8NXyebnNYxDoBi7wt8eTWrUrKXCOVaFq9x1kgag=="],
"has-flag": ["has-flag@4.0.0", "", {}, ""],
"has-symbols": ["has-symbols@1.1.0", "", {}, ""],
"hasown": ["hasown@2.0.2", "", { "dependencies": { "function-bind": "^1.1.2" } }, ""],
"helmet": ["helmet@7.2.0", "", {}, ""],
"hexoid": ["hexoid@1.0.0", "", {}, ""],
"hookable": ["hookable@5.5.3", "", {}, "sha512-Yc+BQe8SvoXH1643Qez1zqLRmbA5rCL+sSmk6TVos0LWVfNIB7PGncdlId77WzLGSIB5KaWgTaNTs2lNVEI6VQ=="],
"htmlparser2": ["htmlparser2@8.0.2", "", { "dependencies": { "domelementtype": "^2.3.0", "domhandler": "^5.0.3", "domutils": "^3.0.1", "entities": "^4.4.0" } }, "sha512-GYdjWKDkbRLkZ5geuHs5NY1puJ+PXwP7+fHPRz06Eirsb9ugf6d8kkXav6ADhcODhFFPMIXyxkxSuMf3D6NCFA=="],
"husky": ["husky@9.1.7", "", { "bin": "bin.js" }, "sha512-5gs5ytaNjBrh5Ow3zrvdUUY+0VxIuWVL4i9irt6friV+BqdCfmV11CQTWMiBYWHbXhco+J1kHfTOUkePhCDvMA=="],
"ignore": ["ignore@5.3.2", "", {}, "sha512-hsBTNUqQTDwkWtcdYI2i06Y/nUBEsNEDJKjWdigLvegy8kDuJAS8uRlpkkcQpyEXL0Z/pjDy5HBmMjRCJ2gq+g=="],
"import-fresh": ["import-fresh@3.3.1", "", { "dependencies": { "parent-module": "^1.0.0", "resolve-from": "^4.0.0" } }, "sha512-TR3KfrTZTYLPB6jUjfx6MF9WcWrHL9su5TObK4ZkYgBdWKPOFoSoQIdEuTuR82pmtxH2spWG9h6etwfr1pLBqQ=="],
"imurmurhash": ["imurmurhash@0.1.4", "", {}, ""],
"inflight": ["inflight@1.0.6", "", { "dependencies": { "once": "^1.3.0", "wrappy": "1" } }, ""],
"inherits": ["inherits@2.0.4", "", {}, ""],
"is-extglob": ["is-extglob@2.1.1", "", {}, "sha512-SbKbANkN603Vi4jEZv49LeVJMn4yGwsbzZworEoyEiutsN3nJYdbO36zfhGJ6QEDpOZIFkDtnq5JRxmvl3jsoQ=="],
"is-glob": ["is-glob@4.0.3", "", { "dependencies": { "is-extglob": "^2.1.1" } }, "sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg=="],
"is-number": ["is-number@7.0.0", "", {}, ""],
"is-path-inside": ["is-path-inside@3.0.3", "", {}, "sha512-Fd4gABb+ycGAmKou8eMftCupSir5lRxqf4aD/vd0cD2qc4HL07OjCeuHMr8Ro4CoMaeCKDB0/ECBOVWjTwUvPQ=="],
"is-plain-object": ["is-plain-object@5.0.0", "", {}, "sha512-VRSzKkbMm5jMDoKLbltAkFQ5Qr7VDiTFGXxYFXXowVj387GeGNOCsOH6Msy00SGZ3Fp84b1Naa1psqgcCIEP5Q=="],
"isexe": ["isexe@2.0.0", "", {}, ""],
"js-yaml": ["js-yaml@4.1.0", "", { "dependencies": { "argparse": "^2.0.1" }, "bin": "bin/js-yaml.js" }, ""],
"json-buffer": ["json-buffer@3.0.1", "", {}, "sha512-4bV5BfR2mqfQTJm+V5tPPdf+ZpuhiIvTuAB5g8kcrXOZpTT/QwwVRWBywX1ozr6lEuPdbHxwaJlm9G6mI2sfSQ=="],
"json-schema-traverse": ["json-schema-traverse@0.4.1", "", {}, "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg=="],
"json-stable-stringify-without-jsonify": ["json-stable-stringify-without-jsonify@1.0.1", "", {}, "sha512-Bdboy+l7tA3OGW6FjyFHWkP5LuByj1Tk33Ljyq0axyzdk9//JSi2u3fP1QSmd1KNwq6VOKYGlAu87CisVir6Pw=="],
"jsonwebtoken": ["jsonwebtoken@9.0.2", "", { "dependencies": { "jws": "^3.2.2", "lodash.includes": "^4.3.0", "lodash.isboolean": "^3.0.3", "lodash.isinteger": "^4.0.4", "lodash.isnumber": "^3.0.3", "lodash.isplainobject": "^4.0.6", "lodash.isstring": "^4.0.1", "lodash.once": "^4.0.0", "ms": "^2.1.1", "semver": "^7.5.4" } }, ""],
"jwa": ["jwa@1.4.1", "", { "dependencies": { "buffer-equal-constant-time": "1.0.1", "ecdsa-sig-formatter": "1.0.11", "safe-buffer": "^5.0.1" } }, ""],
"jws": ["jws@3.2.2", "", { "dependencies": { "jwa": "^1.4.1", "safe-buffer": "^5.0.1" } }, ""],
"keyv": ["keyv@4.5.4", "", { "dependencies": { "json-buffer": "3.0.1" } }, "sha512-oxVHkHR/EJf2CNXnWxRLW6mg7JyCCUcG0DtEGmL2ctUo1PNTin1PUil+r/+4r5MpVgC/fn1kjsx7mjSujKqIpw=="],
"levn": ["levn@0.4.1", "", { "dependencies": { "prelude-ls": "^1.2.1", "type-check": "~0.4.0" } }, "sha512-+bT2uH4E5LGE7h/n3evcS/sQlJXCpIp6ym8OWJ5eV6+67Dsql/LaaT7qJBAt2rzfoa/5QBGBhxDix1dMt2kQKQ=="],
"locate-path": ["locate-path@6.0.0", "", { "dependencies": { "p-locate": "^5.0.0" } }, "sha512-iPZK6eYjbxRu3uB4/WZ3EsEIMJFMqAoopl3R+zuq0UjcAm/MO6KCweDgPfP3elTztoKP3KtnVHxTn2NHBSDVUw=="],
"lodash.includes": ["lodash.includes@4.3.0", "", {}, ""],
"lodash.isboolean": ["lodash.isboolean@3.0.3", "", {}, ""],
"lodash.isinteger": ["lodash.isinteger@4.0.4", "", {}, ""],
"lodash.isnumber": ["lodash.isnumber@3.0.3", "", {}, ""],
"lodash.isplainobject": ["lodash.isplainobject@4.0.6", "", {}, ""],
"lodash.isstring": ["lodash.isstring@4.0.1", "", {}, ""],
"lodash.merge": ["lodash.merge@4.6.2", "", {}, "sha512-0KpjqXRVvrYyCsX1swR/XTK0va6VQkQM6MNo7PqW77ByjAhoARA8EfrP1N4+KlKj8YS0ZUCtRT/YUuhyYDujIQ=="],
"lodash.once": ["lodash.once@4.1.1", "", {}, ""],
"math-intrinsics": ["math-intrinsics@1.1.0", "", {}, ""],
"memoirist": ["memoirist@0.3.0", "", {}, "sha512-wR+4chMgVPq+T6OOsk40u9Wlpw1Pjx66NMNiYxCQQ4EUJ7jDs3D9kTCeKdBOkvAiqXlHLVJlvYL01PvIJ1MPNg=="],
"merge2": ["merge2@1.4.1", "", {}, "sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg=="],
"methods": ["methods@1.1.2", "", {}, ""],
"micromatch": ["micromatch@4.0.8", "", { "dependencies": { "braces": "^3.0.3", "picomatch": "^2.3.1" } }, ""],
"mime": ["mime@2.6.0", "", { "bin": "cli.js" }, ""],
"mime-db": ["mime-db@1.52.0", "", {}, ""],
"mime-types": ["mime-types@2.1.35", "", { "dependencies": { "mime-db": "1.52.0" } }, ""],
"minimatch": ["minimatch@3.1.2", "", { "dependencies": { "brace-expansion": "^1.1.7" } }, "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw=="],
"ms": ["ms@2.1.3", "", {}, ""],
"nanoid": ["nanoid@3.3.8", "", { "bin": "bin/nanoid.cjs" }, "sha512-WNLf5Sd8oZxOm+TzppcYk8gVOgP+l58xNy58D0nbUnOxOWRWvlcCV4kUF7ltmI6PsrLl/BgKEyS4mqsGChFN0w=="],
"natural-compare": ["natural-compare@1.4.0", "", {}, ""],
"node-domexception": ["node-domexception@1.0.0", "", {}, "sha512-/jKZoMpw0F8GRwl4/eLROPA3cfcXtLApP0QzLmUT/HuPCZWyB7IY9ZrMeKw2O/nFIqPQB3PVM9aYm0F312AXDQ=="],
"node-fetch": ["node-fetch@3.3.2", "", { "dependencies": { "data-uri-to-buffer": "^4.0.0", "fetch-blob": "^3.1.4", "formdata-polyfill": "^4.0.10" } }, "sha512-dRB78srN/l6gqWulah9SrxeYnxeddIG30+GOqK/9OlLVyLg3HPnr6SqOWTWOXKRwC2eGYCkZ59NNuSgvSrpgOA=="],
"object-inspect": ["object-inspect@1.13.3", "", {}, ""],
"once": ["once@1.4.0", "", { "dependencies": { "wrappy": "1" } }, ""],
"openapi-types": ["openapi-types@12.1.3", "", {}, "sha512-N4YtSYJqghVu4iek2ZUvcN/0aqH1kRDuNqzcycDxhOUpg7GdvLa2F3DgS6yBNhInhv2r/6I0Flkn7CqL8+nIcw=="],
"optionator": ["optionator@0.9.4", "", { "dependencies": { "deep-is": "^0.1.3", "fast-levenshtein": "^2.0.6", "levn": "^0.4.1", "prelude-ls": "^1.2.1", "type-check": "^0.4.0", "word-wrap": "^1.2.5" } }, "sha512-6IpQ7mKUxRcZNLIObR0hz7lxsapSSIYNZJwXPGeF0mTVqGKFIXj1DQcMoT22S3ROcLyY/rz0PWaWZ9ayWmad9g=="],
"p-limit": ["p-limit@3.1.0", "", { "dependencies": { "yocto-queue": "^0.1.0" } }, ""],
"p-locate": ["p-locate@5.0.0", "", { "dependencies": { "p-limit": "^3.0.2" } }, "sha512-LaNjtRWUBY++zB5nE/NwcaoMylSPk+S+ZHNB1TzdbMJMny6dynpAGt7X/tl/QYq3TIeE6nxHppbo2LGymrG5Pw=="],
"parent-module": ["parent-module@1.0.1", "", { "dependencies": { "callsites": "^3.0.0" } }, "sha512-GQ2EWRpQV8/o+Aw8YqtfZZPfNRWZYkbidE9k5rpl/hC3vtHHBfGm2Ifi6qWV+coDGkrUKZAxE3Lot5kcsRlh+g=="],
"parse-srcset": ["parse-srcset@1.0.2", "", {}, "sha512-/2qh0lav6CmI15FzA3i/2Bzk2zCgQhGMkvhOhKNcBVQ1ldgpbfiNTVslmooUmWJcADi1f1kIeynbDRVzNlfR6Q=="],
"path-exists": ["path-exists@4.0.0", "", {}, ""],
"path-is-absolute": ["path-is-absolute@1.0.1", "", {}, ""],
"path-key": ["path-key@3.1.1", "", {}, ""],
"path-type": ["path-type@4.0.0", "", {}, "sha512-gDKb8aZMDeD/tZWs9P6+q0J9Mwkdl6xMV8TjnGP3qJVJ06bdMgkbBlLU8IdfOsIsFz2BW1rNVT3XuNEl8zPAvw=="],
"pathe": ["pathe@1.1.2", "", {}, "sha512-whLdWMYL2TwI08hn8/ZqAbrVemu0LNaNNJZX73O6qaIdCTfXutsLhMkjdENX0qhsQ9uIimo4/aQOmXkoon2nDQ=="],
"picocolors": ["picocolors@1.1.1", "", {}, ""],
"picomatch": ["picomatch@2.3.1", "", {}, ""],
"postcss": ["postcss@8.5.1", "", { "dependencies": { "nanoid": "^3.3.8", "picocolors": "^1.1.1", "source-map-js": "^1.2.1" } }, "sha512-6oz2beyjc5VMn/KV1pPw8fliQkhBXrVn1Z3TVyqZxU8kZpzEKhBdmCFqI6ZbmGtamQvQGuU1sgPTk8ZrXDD7jQ=="],
"prelude-ls": ["prelude-ls@1.2.1", "", {}, "sha512-vkcDPrRZo1QZLbn5RLGPpg/WmIQ65qoWWhcGKf/b5eplkkarX0m9z8ppCat4mlOqUsWpyNuYgO3VRyrYHSzX5g=="],
"prettier": ["prettier@3.4.2", "", { "bin": "bin/prettier.cjs" }, "sha512-e9MewbtFo+Fevyuxn/4rrcDAaq0IYxPGLvObpQjiZBMAzB9IGmzlnG9RZy3FFas+eBMu2vA0CszMeduow5dIuQ=="],
"prettier-linter-helpers": ["prettier-linter-helpers@1.0.0", "", { "dependencies": { "fast-diff": "^1.1.2" } }, "sha512-GbK2cP9nraSSUF9N2XwUwqfzlAFlMNYYl+ShE/V+H8a9uNl/oUqB1w2EL54Jh0OlyRSd8RfWYJ3coVS4TROP2w=="],
"punycode": ["punycode@2.3.1", "", {}, "sha512-vYt7UD1U9Wg6138shLtLOvdAu+8DsC/ilFtEVHcH+wydcSpNE20AfSOduf6MkRFahL5FY7X1oU7nKVZFtfq8Fg=="],
"qs": ["qs@6.13.0", "", { "dependencies": { "side-channel": "^1.0.6" } }, ""],
"queue-microtask": ["queue-microtask@1.2.3", "", {}, "sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A=="],
"resolve-from": ["resolve-from@4.0.0", "", {}, "sha512-pb/MYmXstAkysRFx8piNI1tGFNQIFA3vkE3Gq4EuA1dF6gHp/+vgZqsCGJapvy8N3Q+4o7FwvquPJcnZ7RYy4g=="],
"reusify": ["reusify@1.0.4", "", {}, "sha512-U9nH88a3fc/ekCF1l0/UP1IosiuIjyTh7hBvXVMHYgVcfGvt897Xguj2UOLDeI5BG2m7/uwyaLVT6fbtCwTyzw=="],
"rimraf": ["rimraf@3.0.2", "", { "dependencies": { "glob": "^7.1.3" }, "bin": "bin.js" }, "sha512-JZkJMZkAGFFPP2YqXZXPbMlMBgsxzE8ILs4lMIX/2o0L9UBw9O/Y3o6wFw/i9YLapcUJWwqbi3kdxIPdC62TIA=="],
"run-parallel": ["run-parallel@1.2.0", "", { "dependencies": { "queue-microtask": "^1.2.2" } }, "sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA=="],
"safe-buffer": ["safe-buffer@5.2.1", "", {}, ""],
"sanitize-html": ["sanitize-html@2.14.0", "", { "dependencies": { "deepmerge": "^4.2.2", "escape-string-regexp": "^4.0.0", "htmlparser2": "^8.0.0", "is-plain-object": "^5.0.0", "parse-srcset": "^1.0.2", "postcss": "^8.3.11" } }, "sha512-CafX+IUPxZshXqqRaG9ZClSlfPVjSxI0td7n07hk8QO2oO+9JDnlcL8iM8TWeOXOIBFgIOx6zioTzM53AOMn3g=="],
"semver": ["semver@7.7.0", "", { "bin": "bin/semver.js" }, "sha512-DrfFnPzblFmNrIZzg5RzHegbiRWg7KMR7btwi2yjHwx06zsUbO5g613sVwEV7FTwmzJu+Io0lJe2GJ3LxqpvBQ=="],
"shebang-command": ["shebang-command@2.0.0", "", { "dependencies": { "shebang-regex": "^3.0.0" } }, ""],
"shebang-regex": ["shebang-regex@3.0.0", "", {}, ""],
"side-channel": ["side-channel@1.1.0", "", { "dependencies": { "es-errors": "^1.3.0", "object-inspect": "^1.13.3", "side-channel-list": "^1.0.0", "side-channel-map": "^1.0.1", "side-channel-weakmap": "^1.0.2" } }, ""],
"side-channel-list": ["side-channel-list@1.0.0", "", { "dependencies": { "es-errors": "^1.3.0", "object-inspect": "^1.13.3" } }, ""],
"side-channel-map": ["side-channel-map@1.0.1", "", { "dependencies": { "call-bound": "^1.0.2", "es-errors": "^1.3.0", "get-intrinsic": "^1.2.5", "object-inspect": "^1.13.3" } }, ""],
"side-channel-weakmap": ["side-channel-weakmap@1.0.2", "", { "dependencies": { "call-bound": "^1.0.2", "es-errors": "^1.3.0", "get-intrinsic": "^1.2.5", "object-inspect": "^1.13.3", "side-channel-map": "^1.0.1" } }, ""],
"slash": ["slash@3.0.0", "", {}, ""],
"source-map-js": ["source-map-js@1.2.1", "", {}, "sha512-UXWMKhLOwVKb728IUtQPXxfYU+usdybtUrK/8uGE8CQMvrhOpwvzDBwj0QhSL7MQc7vIsISBG8VQ8+IDQxpfQA=="],
"strip-ansi": ["strip-ansi@6.0.1", "", { "dependencies": { "ansi-regex": "^5.0.1" } }, ""],
"strip-json-comments": ["strip-json-comments@3.1.1", "", {}, ""],
"superagent": ["superagent@8.1.2", "", { "dependencies": { "component-emitter": "^1.3.0", "cookiejar": "^2.1.4", "debug": "^4.3.4", "fast-safe-stringify": "^2.1.1", "form-data": "^4.0.0", "formidable": "^2.1.2", "methods": "^1.1.2", "mime": "2.6.0", "qs": "^6.11.0", "semver": "^7.3.8" } }, ""],
"supertest": ["supertest@6.3.4", "", { "dependencies": { "methods": "^1.1.2", "superagent": "^8.1.2" } }, ""],
"supports-color": ["supports-color@7.2.0", "", { "dependencies": { "has-flag": "^4.0.0" } }, ""],
"synckit": ["synckit@0.9.2", "", { "dependencies": { "@pkgr/core": "^0.1.0", "tslib": "^2.6.2" } }, "sha512-vrozgXDQwYO72vHjUb/HnFbQx1exDjoKzqx23aXEg2a9VIg2TSFZ8FmeZpTjUCFMYw7mpX4BE2SFu8wI7asYsw=="],
"text-table": ["text-table@0.2.0", "", {}, "sha512-N+8UisAXDGk8PFXP4HAzVR9nbfmVJ3zYLAWiTIoqC5v5isinhr+r5uaO8+7r3BMfuNIufIsA7RdpVgacC2cSpw=="],
"to-regex-range": ["to-regex-range@5.0.1", "", { "dependencies": { "is-number": "^7.0.0" } }, ""],
"ts-api-utils": ["ts-api-utils@1.4.3", "", { "peerDependencies": { "typescript": ">=4.2.0" } }, "sha512-i3eMG77UTMD0hZhgRS562pv83RC6ukSAC2GMNWc+9dieh/+jDM5u5YG+NHX6VNDRHQcHwmsTHctP9LhbC3WxVw=="],
"tslib": ["tslib@2.8.1", "", {}, "sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w=="],
"type-check": ["type-check@0.4.0", "", { "dependencies": { "prelude-ls": "^1.2.1" } }, "sha512-XleUoc9uwGXqjWwXaUTZAmzMcFZ5858QA2vvx1Ur5xIcixXIP+8LnFDgRplU30us6teqdlskFfu+ae4K79Ooew=="],
"type-fest": ["type-fest@0.20.2", "", {}, "sha512-Ne+eE4r0/iWnpAxD852z3A+N0Bt5RN//NjJwRd2VFHEmrywxf5vsZlh4R6lixl6B+wz/8d+maTSAkN1FIkI3LQ=="],
"typescript": ["typescript@5.7.3", "", { "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" } }, ""],
"undici-types": ["undici-types@6.19.8", "", {}, ""],
"uri-js": ["uri-js@4.4.1", "", { "dependencies": { "punycode": "^2.1.0" } }, "sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg=="],
"uuid": ["uuid@11.0.5", "", { "bin": "dist/esm/bin/uuid" }, "sha512-508e6IcKLrhxKdBbcA2b4KQZlLVp2+J5UwQ6F7Drckkc5N9ZJwFa4TgWtsww9UG8fGHbm6gbV19TdM5pQ4GaIA=="],
"web-streams-polyfill": ["web-streams-polyfill@3.3.3", "", {}, "sha512-d2JWLCivmZYTSIoge9MsgFCZrt571BikcWGYkjC1khllbTeDlGqZ2D8vD8E/lJa8WGWbb7Plm8/XJYV7IJHZZw=="],
"which": ["which@2.0.2", "", { "dependencies": { "isexe": "^2.0.0" }, "bin": { "node-which": "bin/node-which" } }, ""],
"word-wrap": ["word-wrap@1.2.5", "", {}, "sha512-BN22B5eaMMI9UMtjrGd5g5eCYPpCPDUy0FJXbYsaT5zYxjFOckS53SQDE3pWkVoWpHXVb3BrYcEN4Twa55B5cA=="],
"wrappy": ["wrappy@1.0.2", "", {}, ""],
"ws": ["ws@8.18.0", "", { "peerDependencies": { "bufferutil": "^4.0.1", "utf-8-validate": ">=5.0.2" }, "optionalPeers": ["bufferutil", "utf-8-validate"] }, ""],
"yocto-queue": ["yocto-queue@0.1.0", "", {}, ""],
"zhead": ["zhead@2.2.4", "", {}, "sha512-8F0OI5dpWIA5IGG5NHUg9staDwz/ZPxZtvGVf01j7vHqSyZ0raHY+78atOVxRqb73AotX22uV1pXt3gYSstGag=="],
"zod": ["zod@3.24.1", "", {}, ""],
"@eslint/eslintrc/ajv": ["ajv@6.12.6", "", { "dependencies": { "fast-deep-equal": "^3.1.1", "fast-json-stable-stringify": "^2.0.0", "json-schema-traverse": "^0.4.1", "uri-js": "^4.2.2" } }, "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g=="],
"@eslint/eslintrc/globals": ["globals@13.24.0", "", { "dependencies": { "type-fest": "^0.20.2" } }, "sha512-AhO5QUcj8llrbG09iWhPU2B204J1xnPeL8kQmVorSsy+Sjj1sk8gIyh6cUocGmH4L0UuhAJy+hJMRA4mgA4mFQ=="],
"@eslint/eslintrc/minimatch": ["minimatch@3.1.2", "", { "dependencies": { "brace-expansion": "^1.1.7" } }, "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw=="],
"@humanwhocodes/config-array/minimatch": ["minimatch@3.1.2", "", { "dependencies": { "brace-expansion": "^1.1.7" } }, "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw=="],
"@scalar/themes/@scalar/types": ["@scalar/types@0.0.30", "", { "dependencies": { "@scalar/openapi-types": "0.1.7", "@unhead/schema": "^1.11.11" } }, "sha512-rhgwovQb5f7PXuUB5bLUElpo90fdsiwcOgBXVWZ6n6dnFSKovNJ7GPXQimsZioMzTF6TdwfP94UpZVdZAK4aTw=="],
"@typescript-eslint/typescript-estree/minimatch": ["minimatch@9.0.5", "", { "dependencies": { "brace-expansion": "^2.0.1" } }, "sha512-G6T0ZX48xgozx7587koeX9Ys2NYy6Gmv//P89sEte9V9whIapMNF4idKxnW2QtCcLiTWlb/wfCabAtAFWhhBow=="],
"fast-glob/glob-parent": ["glob-parent@5.1.2", "", { "dependencies": { "is-glob": "^4.0.1" } }, "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow=="],
"glob/minimatch": ["minimatch@3.1.2", "", { "dependencies": { "brace-expansion": "^1.1.7" } }, "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw=="],
"sanitize-html/escape-string-regexp": ["escape-string-regexp@4.0.0", "", {}, "sha512-TtpcNJ3XAzx3Gq8sWRzJaVajRs0uVxA2YAkdb1jm2YkPz4G6egUFAyA3n5vtEIZefPk5Wa4UXbKuS5fKkJWdgA=="],
"@eslint/eslintrc/ajv/json-schema-traverse": ["json-schema-traverse@0.4.1", "", {}, "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg=="],
"@eslint/eslintrc/globals/type-fest": ["type-fest@0.20.2", "", {}, "sha512-Ne+eE4r0/iWnpAxD852z3A+N0Bt5RN//NjJwRd2VFHEmrywxf5vsZlh4R6lixl6B+wz/8d+maTSAkN1FIkI3LQ=="],
"@eslint/eslintrc/minimatch/brace-expansion": ["brace-expansion@1.1.11", "", { "dependencies": { "balanced-match": "^1.0.0", "concat-map": "0.0.1" } }, "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA=="],
"@humanwhocodes/config-array/minimatch/brace-expansion": ["brace-expansion@1.1.11", "", { "dependencies": { "balanced-match": "^1.0.0", "concat-map": "0.0.1" } }, "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA=="],
"@scalar/themes/@scalar/types/@scalar/openapi-types": ["@scalar/openapi-types@0.1.7", "", {}, "sha512-oOTG3JQifg55U3DhKB7WdNIxFnJzbPJe7rqdyWdio977l8IkxQTVmObftJhdNIMvhV2K+1f/bDoMQGu6yTaD0A=="],
"@typescript-eslint/typescript-estree/minimatch/brace-expansion": ["brace-expansion@2.0.1", "", { "dependencies": { "balanced-match": "^1.0.0" } }, "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA=="],
"glob/minimatch/brace-expansion": ["brace-expansion@1.1.11", "", { "dependencies": { "balanced-match": "^1.0.0", "concat-map": "0.0.1" } }, "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA=="],
}
}

50
bunfig.toml Normal file
View File

@@ -0,0 +1,50 @@
[test]
preload = ["./src/__tests__/setup.ts"]
coverage = true
coverageThreshold = {
statements = 80,
branches = 70,
functions = 80,
lines = 80
}
timeout = 30000
testMatch = ["**/__tests__/**/*.test.ts"]
testPathIgnorePatterns = ["/node_modules/", "/dist/"]
collectCoverageFrom = [
"src/**/*.{ts,tsx}",
"!src/**/*.d.ts",
"!src/**/*.test.ts",
"!src/types/**/*",
"!src/mocks/**/*"
]
[build]
target = "node"
outdir = "./dist"
minify = true
sourcemap = "external"
[install]
production = false
frozen = true
peer = false
[install.cache]
dir = ".bun"
disable = false
[debug]
port = 9229
[env]
# Environment-specific configurations
development.LOG_LEVEL = "debug"
production.LOG_LEVEL = "warn"
[hot]
restart = true
reload = true
[performance]
gc = true
optimize = true

64
docker-build.sh Executable file
View File

@@ -0,0 +1,64 @@
#!/bin/bash
# Enable error handling
set -euo pipefail
# Function to clean up on script exit
cleanup() {
echo "Cleaning up..."
docker builder prune -f --filter until=24h
docker image prune -f
}
trap cleanup EXIT
# Clean up Docker system
echo "Cleaning up Docker system..."
docker system prune -f --volumes
# Set build arguments for better performance
export DOCKER_BUILDKIT=1
export COMPOSE_DOCKER_CLI_BUILD=1
export BUILDKIT_PROGRESS=plain
# Calculate available memory and CPU
TOTAL_MEM=$(free -m | awk '/^Mem:/{print $2}')
BUILD_MEM=$(( TOTAL_MEM / 2 )) # Use half of available memory
CPU_COUNT=$(nproc)
CPU_QUOTA=$(( CPU_COUNT * 50000 )) # Allow 50% CPU usage per core
echo "Building with ${BUILD_MEM}MB memory limit and CPU quota ${CPU_QUOTA}"
# Remove any existing lockfile
rm -f bun.lockb
# Build with resource limits, optimizations, and timeout
echo "Building Docker image..."
DOCKER_BUILDKIT=1 docker build \
--memory="${BUILD_MEM}m" \
--memory-swap="${BUILD_MEM}m" \
--cpu-quota="${CPU_QUOTA}" \
--build-arg BUILDKIT_INLINE_CACHE=1 \
--build-arg DOCKER_BUILDKIT=1 \
--build-arg NODE_ENV=production \
--progress=plain \
--no-cache \
--compress \
-t homeassistant-mcp:latest \
-t homeassistant-mcp:$(date +%Y%m%d) \
.
# Check if build was successful
BUILD_EXIT_CODE=$?
if [ $BUILD_EXIT_CODE -eq 124 ]; then
echo "Build timed out after 15 minutes!"
exit 1
elif [ $BUILD_EXIT_CODE -ne 0 ]; then
echo "Build failed with exit code ${BUILD_EXIT_CODE}!"
exit 1
else
echo "Build completed successfully!"
# Show image size and layers
docker image ls homeassistant-mcp:latest --format "Image size: {{.Size}}"
echo "Layer count: $(docker history homeassistant-mcp:latest | wc -l)"
fi

58
docker/speech/Dockerfile Normal file
View File

@@ -0,0 +1,58 @@
# Use Python slim image as builder
FROM python:3.10-slim as builder
# Install build dependencies
RUN apt-get update && apt-get install -y \
git \
build-essential \
portaudio19-dev \
&& rm -rf /var/lib/apt/lists/*
# Create and activate virtual environment
RUN python -m venv /opt/venv
ENV PATH="/opt/venv/bin:$PATH"
# Install Python dependencies with specific versions and CPU-only variants
RUN pip install --no-cache-dir torch==2.1.2 torchaudio==2.1.2 --index-url https://download.pytorch.org/whl/cpu
RUN pip install --no-cache-dir faster-whisper==0.10.0 openwakeword==0.4.0 pyaudio==0.2.14 sounddevice==0.4.6
# Create final image
FROM python:3.10-slim
# Copy virtual environment from builder
COPY --from=builder /opt/venv /opt/venv
ENV PATH="/opt/venv/bin:$PATH"
# Install only runtime dependencies
RUN apt-get update && apt-get install -y \
portaudio19-dev \
python3-pyaudio \
&& rm -rf /var/lib/apt/lists/*
# Create necessary directories
RUN mkdir -p /models/wake_word /audio
# Set working directory
WORKDIR /app
# Copy the wake word detection script
COPY wake_word_detector.py .
# Set environment variables
ENV WHISPER_MODEL_PATH=/models \
WAKEWORD_MODEL_PATH=/models/wake_word \
PYTHONUNBUFFERED=1 \
ASR_MODEL=base.en \
ASR_MODEL_PATH=/models
# Add resource limits to Python
ENV PYTHONMALLOC=malloc \
MALLOC_TRIM_THRESHOLD_=100000 \
PYTHONDEVMODE=1
# Add healthcheck
HEALTHCHECK --interval=30s --timeout=10s --start-period=5s --retries=3 \
CMD ps aux | grep '[p]ython' || exit 1
# Run the wake word detection service with resource constraints
CMD ["python", "-X", "faulthandler", "wake_word_detector.py"]

View File

@@ -0,0 +1,173 @@
import os
import json
import queue
import threading
import numpy as np
import sounddevice as sd
from openwakeword import Model
from datetime import datetime
import wave
from faster_whisper import WhisperModel
# Configuration
SAMPLE_RATE = 16000
CHANNELS = 1
CHUNK_SIZE = 1024
BUFFER_DURATION = 30 # seconds to keep in buffer
DETECTION_THRESHOLD = 0.5
# Wake word models to use
WAKE_WORDS = ["hey_jarvis", "ok_google", "alexa"]
# Initialize the ASR model
asr_model = WhisperModel(
model_size_or_path=os.environ.get('ASR_MODEL', 'base.en'),
device="cpu",
compute_type="int8",
download_root=os.environ.get('ASR_MODEL_PATH', '/models')
)
class AudioProcessor:
def __init__(self):
# Initialize wake word detection model
self.wake_word_model = Model(
custom_model_paths=None, # Use default models
inference_framework="onnx" # Use ONNX for better performance
)
# Pre-load the wake word models
for wake_word in WAKE_WORDS:
self.wake_word_model.add_model(wake_word)
self.audio_buffer = queue.Queue()
self.recording = False
self.buffer = np.zeros(SAMPLE_RATE * BUFFER_DURATION)
self.buffer_lock = threading.Lock()
def audio_callback(self, indata, frames, time, status):
"""Callback for audio input"""
if status:
print(f"Audio callback status: {status}")
# Convert to mono if necessary
if CHANNELS > 1:
audio_data = np.mean(indata, axis=1)
else:
audio_data = indata.flatten()
# Update circular buffer
with self.buffer_lock:
self.buffer = np.roll(self.buffer, -len(audio_data))
self.buffer[-len(audio_data):] = audio_data
# Process for wake word detection
prediction = self.wake_word_model.predict(audio_data)
# Check if wake word detected
for wake_word in WAKE_WORDS:
if prediction[wake_word] > DETECTION_THRESHOLD:
print(f"Wake word detected: {wake_word} (confidence: {prediction[wake_word]:.2f})")
self.save_audio_segment(wake_word)
break
def save_audio_segment(self, wake_word):
"""Save the audio buffer when wake word is detected"""
timestamp = datetime.now().strftime("%Y%m%d_%H%M%S")
filename = f"/audio/wake_word_{wake_word}_{timestamp}.wav"
# Save the audio buffer to a WAV file
with wave.open(filename, 'wb') as wf:
wf.setnchannels(CHANNELS)
wf.setsampwidth(2) # 16-bit audio
wf.setframerate(SAMPLE_RATE)
# Convert float32 to int16
audio_data = (self.buffer * 32767).astype(np.int16)
wf.writeframes(audio_data.tobytes())
print(f"Saved audio segment to {filename}")
# Transcribe the audio
try:
segments, info = asr_model.transcribe(
filename,
language="en",
beam_size=5,
temperature=0
)
# Format the transcription result
result = {
"text": " ".join(segment.text for segment in segments),
"segments": [
{
"text": segment.text,
"start": segment.start,
"end": segment.end,
"confidence": segment.confidence
}
for segment in segments
]
}
# Save metadata and transcription
metadata = {
"timestamp": timestamp,
"wake_word": wake_word,
"wake_word_confidence": float(prediction[wake_word]),
"sample_rate": SAMPLE_RATE,
"channels": CHANNELS,
"duration": BUFFER_DURATION,
"transcription": result
}
with open(f"{filename}.json", 'w') as f:
json.dump(metadata, f, indent=2)
print("\nTranscription result:")
print(f"Text: {result['text']}")
print("\nSegments:")
for segment in result["segments"]:
print(f"[{segment['start']:.2f}s - {segment['end']:.2f}s] ({segment['confidence']:.2%})")
print(f'"{segment["text"]}"')
except Exception as e:
print(f"Error during transcription: {e}")
metadata = {
"timestamp": timestamp,
"wake_word": wake_word,
"wake_word_confidence": float(prediction[wake_word]),
"sample_rate": SAMPLE_RATE,
"channels": CHANNELS,
"duration": BUFFER_DURATION,
"error": str(e)
}
with open(f"{filename}.json", 'w') as f:
json.dump(metadata, f, indent=2)
def start(self):
"""Start audio processing"""
try:
print("Initializing wake word detection...")
print(f"Loaded wake words: {', '.join(WAKE_WORDS)}")
with sd.InputStream(
channels=CHANNELS,
samplerate=SAMPLE_RATE,
blocksize=CHUNK_SIZE,
callback=self.audio_callback
):
print("\nWake word detection started. Listening...")
print("Press Ctrl+C to stop")
while True:
sd.sleep(1000) # Sleep for 1 second
except KeyboardInterrupt:
print("\nStopping wake word detection...")
except Exception as e:
print(f"Error in audio processing: {e}")
if __name__ == "__main__":
processor = AudioProcessor()
processor.start()

View File

@@ -1,419 +0,0 @@
# API Reference
## MCP Schema Endpoint
The server exposes an MCP (Model Context Protocol) schema endpoint that describes all available tools and their parameters:
```http
GET /mcp
```
This endpoint returns a JSON schema describing all available tools, their parameters, and documentation resources. The schema follows the MCP specification and can be used by LLM clients to understand the server's capabilities.
Example response:
```json
{
"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", ...]
},
"area": { "type": "string" },
"floor": { "type": "string" }
}
}
},
// ... other tools
],
"prompts": [],
"resources": [
{
"name": "Home Assistant API",
"url": "https://developers.home-assistant.io/docs/api/rest/"
}
]
}
```
Note: The `/mcp` endpoint is publicly accessible and does not require authentication, as it only provides schema information.
## Device Control
### Common Entity Controls
```json
{
"tool": "control",
"command": "turn_on", // or "turn_off", "toggle"
"entity_id": "light.living_room"
}
```
### Light Control
```json
{
"tool": "control",
"command": "turn_on",
"entity_id": "light.living_room",
"brightness": 128,
"color_temp": 4000,
"rgb_color": [255, 0, 0]
}
```
## Add-on Management
### List Available Add-ons
```json
{
"tool": "addon",
"action": "list"
}
```
### Install Add-on
```json
{
"tool": "addon",
"action": "install",
"slug": "core_configurator",
"version": "5.6.0"
}
```
### Manage Add-on State
```json
{
"tool": "addon",
"action": "start", // or "stop", "restart"
"slug": "core_configurator"
}
```
## Package Management
### List HACS Packages
```json
{
"tool": "package",
"action": "list",
"category": "integration" // or "plugin", "theme", "python_script", "appdaemon", "netdaemon"
}
```
### Install Package
```json
{
"tool": "package",
"action": "install",
"category": "integration",
"repository": "hacs/integration",
"version": "1.32.0"
}
```
## Automation Management
### Create Automation
```json
{
"tool": "automation_config",
"action": "create",
"config": {
"alias": "Motion Light",
"description": "Turn on light when motion detected",
"mode": "single",
"trigger": [
{
"platform": "state",
"entity_id": "binary_sensor.motion",
"to": "on"
}
],
"action": [
{
"service": "light.turn_on",
"target": {
"entity_id": "light.living_room"
}
}
]
}
}
```
### Duplicate Automation
```json
{
"tool": "automation_config",
"action": "duplicate",
"automation_id": "automation.motion_light"
}
```
## Core Functions
### State Management
```http
GET /api/state
POST /api/state
```
Manages the current state of the system.
**Example Request:**
```json
POST /api/state
{
"context": "living_room",
"state": {
"lights": "on",
"temperature": 22
}
}
```
### Context Updates
```http
POST /api/context
```
Updates the current context with new information.
**Example Request:**
```json
POST /api/context
{
"user": "john",
"location": "kitchen",
"time": "morning",
"activity": "cooking"
}
```
## Action Endpoints
### Execute Action
```http
POST /api/action
```
Executes a specified action with given parameters.
**Example Request:**
```json
POST /api/action
{
"action": "turn_on_lights",
"parameters": {
"room": "living_room",
"brightness": 80
}
}
```
### Batch Actions
```http
POST /api/actions/batch
```
Executes multiple actions in sequence.
**Example Request:**
```json
POST /api/actions/batch
{
"actions": [
{
"action": "turn_on_lights",
"parameters": {
"room": "living_room"
}
},
{
"action": "set_temperature",
"parameters": {
"temperature": 22
}
}
]
}
```
## Query Functions
### Get Available Actions
```http
GET /api/actions
```
Returns a list of all available actions.
**Example Response:**
```json
{
"actions": [
{
"name": "turn_on_lights",
"parameters": ["room", "brightness"],
"description": "Turns on lights in specified room"
},
{
"name": "set_temperature",
"parameters": ["temperature"],
"description": "Sets temperature in current context"
}
]
}
```
### Context Query
```http
GET /api/context?type=current
```
Retrieves context information.
**Example Response:**
```json
{
"current_context": {
"user": "john",
"location": "kitchen",
"time": "morning",
"activity": "cooking"
}
}
```
## WebSocket Events
The server supports real-time updates via WebSocket connections.
```javascript
// Client-side connection example
const ws = new WebSocket('ws://localhost:3000/ws');
ws.onmessage = (event) => {
const data = JSON.parse(event.data);
console.log('Received update:', data);
};
```
### Supported Events
- `state_change`: Emitted when system state changes
- `context_update`: Emitted when context is updated
- `action_executed`: Emitted when an action is completed
- `error`: Emitted when an error occurs
**Example Event Data:**
```json
{
"event": "state_change",
"data": {
"previous_state": {
"lights": "off"
},
"current_state": {
"lights": "on"
},
"timestamp": "2024-03-20T10:30:00Z"
}
}
```
## Error Handling
All endpoints return standard HTTP status codes:
- 200: Success
- 400: Bad Request
- 401: Unauthorized
- 403: Forbidden
- 404: Not Found
- 500: Internal Server Error
**Error Response Format:**
```json
{
"error": {
"code": "INVALID_PARAMETERS",
"message": "Missing required parameter: room",
"details": {
"missing_fields": ["room"]
}
}
}
```
## Rate Limiting
The API implements rate limiting to prevent abuse:
- 100 requests per minute per IP for regular endpoints
- 1000 requests per minute per IP for WebSocket connections
When rate limit is exceeded, the server returns:
```json
{
"error": {
"code": "RATE_LIMIT_EXCEEDED",
"message": "Too many requests",
"reset_time": "2024-03-20T10:31:00Z"
}
}
```
## Example Usage
### Using curl
```bash
# Get current state
curl -X GET \
http://localhost:3000/api/state \
-H 'Authorization: ApiKey your_api_key_here'
# Execute action
curl -X POST \
http://localhost:3000/api/action \
-H 'Authorization: ApiKey your_api_key_here' \
-H 'Content-Type: application/json' \
-d '{
"action": "turn_on_lights",
"parameters": {
"room": "living_room",
"brightness": 80
}
}'
```
### Using JavaScript
```javascript
// Execute action
async function executeAction() {
const response = await fetch('http://localhost:3000/api/action', {
method: 'POST',
headers: {
'Authorization': 'ApiKey your_api_key_here',
'Content-Type': 'application/json'
},
body: JSON.stringify({
action: 'turn_on_lights',
parameters: {
room: 'living_room',
brightness: 80
}
})
});
const data = await response.json();
console.log('Action result:', data);
}
```

23
docs/Gemfile Normal file
View File

@@ -0,0 +1,23 @@
source "https://rubygems.org"
gem "github-pages", group: :jekyll_plugins
gem "jekyll-theme-minimal"
gem "jekyll-relative-links"
gem "jekyll-seo-tag"
gem "jekyll-remote-theme"
gem "jekyll-github-metadata"
gem "faraday-retry"
# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
# and associated library.
platforms :mingw, :x64_mingw, :mswin, :jruby do
gem "tzinfo", ">= 1"
gem "tzinfo-data"
end
# Lock `http_parser.rb` gem to `v0.6.x` on JRuby builds since newer versions of the gem
# do not have a Java counterpart.
gem "http_parser.rb", "~> 0.6.0", :platforms => [:jruby]
# Add webrick for Ruby 3.0+
gem "webrick", "~> 1.7"

View File

@@ -1,60 +0,0 @@
# Home Assistant MCP Documentation
Welcome to the Home Assistant MCP (Master Control Program) documentation. This documentation provides comprehensive information about setting up, configuring, and using the Home Assistant MCP.
## Table of Contents
1. [Getting Started](./getting-started.md)
- Installation
- Configuration
- First Steps
2. [API Reference](./API.md)
- REST API Endpoints
- Authentication
- Error Handling
3. [SSE (Server-Sent Events)](./SSE_API.md)
- Event Subscriptions
- Real-time Updates
- Connection Management
4. [Tools](./tools/README.md)
- Device Control
- Automation Management
- Add-on Management
- Package Management
5. [Configuration](./configuration/README.md)
- Environment Variables
- Security Settings
- Performance Tuning
6. [Development](./development/README.md)
- Project Structure
- Contributing Guidelines
- Testing
7. [Troubleshooting](./troubleshooting.md)
- Common Issues
- Debugging
- FAQ
## Quick Links
- [GitHub Repository](https://github.com/yourusername/homeassistant-mcp)
- [Issue Tracker](https://github.com/yourusername/homeassistant-mcp/issues)
- [Change Log](./CHANGELOG.md)
- [Security Policy](./SECURITY.md)
## Support
If you need help or have questions:
1. Check the [Troubleshooting Guide](./troubleshooting.md)
2. Search existing [Issues](https://github.com/yourusername/homeassistant-mcp/issues)
3. Create a new issue if your problem isn't already reported
## License
This project is licensed under the MIT License - see the [LICENSE](../LICENSE) file for details.

78
docs/_config.yml Normal file
View File

@@ -0,0 +1,78 @@
title: Model Context Protocol (MCP)
description: A bridge between Home Assistant and Language Learning Models
theme: jekyll-theme-minimal
markdown: kramdown
# Repository settings
repository: jango-blockchained/advanced-homeassistant-mcp
github: [metadata]
# Add base URL and URL settings
baseurl: "/advanced-homeassistant-mcp" # the subpath of your site
url: "https://jango-blockchained.github.io" # the base hostname & protocol
# Theme settings
logo: /assets/img/logo.png # path to logo (create this if you want a logo)
show_downloads: true # show download buttons for your repo
plugins:
- jekyll-relative-links
- jekyll-seo-tag
- jekyll-remote-theme
- jekyll-github-metadata
# Enable relative links
relative_links:
enabled: true
collections: true
# Navigation structure
header_pages:
- index.md
- getting-started.md
- api.md
- usage.md
- tools/tools.md
- development/development.md
- troubleshooting.md
- contributing.md
- roadmap.md
# Collections
collections:
tools:
output: true
permalink: /:collection/:name
development:
output: true
permalink: /:collection/:name
# Default layouts
defaults:
- scope:
path: ""
type: "pages"
values:
layout: "default"
- scope:
path: "tools"
type: "tools"
values:
layout: "default"
- scope:
path: "development"
type: "development"
values:
layout: "default"
# Exclude files from processing
exclude:
- Gemfile
- Gemfile.lock
- node_modules
- vendor
# Sass settings
sass:
style: compressed
sass_dir: _sass

View File

@@ -0,0 +1,52 @@
<!DOCTYPE html>
<html lang="{{ site.lang | default: " en-US" }}">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
{% seo %}
<link rel="stylesheet" href="{{ " /assets/css/style.css?v=" | append: site.github.build_revision | relative_url }}">
</head>
<body>
<div class="wrapper">
<header>
<h1><a href="{{ " /" | absolute_url }}">{{ site.title | default: site.github.repository_name }}</a></h1>
{% if site.logo %}
<img src="{{site.logo | relative_url}}" alt="Logo" />
{% endif %}
<p>{{ site.description | default: site.github.project_tagline }}</p>
<p class="view"><a href="{{ site.github.repository_url }}">View the Project on GitHub <small>{{
site.github.repository_nwo }}</small></a></p>
<nav class="main-nav">
<h3>Documentation</h3>
<ul>
<li><a href="{{ '/getting-started' | relative_url }}">Getting Started</a></li>
<li><a href="{{ '/api' | relative_url }}">API Reference</a></li>
<li><a href="{{ '/sse-api' | relative_url }}">SSE API</a></li>
<li><a href="{{ '/architecture' | relative_url }}">Architecture</a></li>
<li><a href="{{ '/contributing' | relative_url }}">Contributing</a></li>
<li><a href="{{ '/troubleshooting' | relative_url }}">Troubleshooting</a></li>
</ul>
</nav>
</header>
<section>
{{ content }}
</section>
<footer>
{% if site.github.is_project_page %}
<p>This project is maintained by <a href="{{ site.github.owner_url }}">{{ site.github.owner_name }}</a></p>
{% endif %}
<p><small>Hosted on GitHub Pages &mdash; Theme by <a
href="https://github.com/orderedlist">orderedlist</a></small></p>
</footer>
</div>
<script src="{{ " /assets/js/scale.fix.js" | relative_url }}"></script>
</body>
</html>

728
docs/api.md Normal file
View File

@@ -0,0 +1,728 @@
# 🚀 Home Assistant MCP API Documentation
![API Version](https://img.shields.io/badge/API-v2.1-blueviolet) ![Rate Limit](https://img.shields.io/badge/Rate%20Limit-100%2Fmin-brightgreen)
## 🌟 Quick Start
```bash
# Get API schema with caching
curl -X GET http://localhost:3000/mcp \
-H "Cache-Control: max-age=3600" # Cache for 1 hour
```
## 🔌 Core Functions ⚙️
### State Management (`/api/state`)
```http
GET /api/state?cache=true # Enable client-side caching
POST /api/state
```
**Example Request:**
```json
{
"context": "living_room",
"state": {
"lights": "on",
"temperature": 22
},
"_cache": { // Optional caching config
"ttl": 300, // 5 minutes
"tags": ["lights", "climate"]
}
}
```
## ⚡ Action Endpoints
### Execute Action with Cache Validation
```http
POST /api/action
If-None-Match: "etag_value" // Prevent duplicate actions
```
**Batch Processing:**
```json
{
"actions": [
{ "action": "🌞 Morning Routine", "params": { "brightness": 80 } },
{ "action": "❄️ AC Control", "params": { "temp": 21 } }
],
"_parallel": true // Execute actions concurrently
}
```
## 🔍 Query Functions
### Available Actions with ETag
```http
GET /api/actions
ETag: "a1b2c3d4" // Client-side cache validation
```
**Response Headers:**
```
Cache-Control: public, max-age=86400 // 24-hour cache
ETag: "a1b2c3d4"
```
## 🌐 WebSocket Events
```javascript
const ws = new WebSocket('wss://ha-mcp/ws');
ws.onmessage = ({ data }) => {
const event = JSON.parse(data);
if(event.type === 'STATE_UPDATE') {
updateUI(event.payload); // 🎨 Real-time UI sync
}
};
```
## 🗃️ Caching Strategies
### Client-Side Caching
```http
GET /api/devices
Cache-Control: max-age=300, stale-while-revalidate=60
```
### Server-Side Cache-Control
```typescript
// Example middleware configuration
app.use(
cacheMiddleware({
ttl: 60 * 5, // 5 minutes
paths: ['/api/devices', '/mcp'],
vary: ['Authorization'] // User-specific caching
})
);
```
## ❌ Error Handling
**429 Too Many Requests:**
```json
{
"error": {
"code": "RATE_LIMITED",
"message": "Slow down! 🐢",
"retry_after": 30,
"docs": "https://ha-mcp/docs/rate-limits"
}
}
```
## 🚦 Rate Limiting Tiers
| Tier | Requests/min | Features |
|---------------|--------------|------------------------|
| Guest | 10 | Basic read-only |
| User | 100 | Full access |
| Power User | 500 | Priority queue |
| Integration | 1000 | Bulk operations |
## 🛠️ Example Usage
### Smart Cache Refresh
```javascript
async function getDevices() {
const response = await fetch('/api/devices', {
headers: {
'If-None-Match': localStorage.getItem('devicesETag')
}
});
if(response.status === 304) { // Not Modified
return JSON.parse(localStorage.devicesCache);
}
const data = await response.json();
localStorage.setItem('devicesETag', response.headers.get('ETag'));
localStorage.setItem('devicesCache', JSON.stringify(data));
return data;
}
```
## 🔒 Security Middleware (Enhanced)
### Cache-Aware Rate Limiting
```typescript
app.use(
rateLimit({
windowMs: 15 * 60 * 1000, // 15 minutes
max: 100, // Limit each IP to 100 requests per window
cache: new RedisStore(), // Distributed cache
keyGenerator: (req) => {
return `${req.ip}-${req.headers.authorization}`;
}
})
);
```
### Security Headers
```http
Content-Security-Policy: default-src 'self';
Strict-Transport-Security: max-age=31536000;
X-Content-Type-Options: nosniff;
Cache-Control: public, max-age=600;
ETag: "abc123"
```
## 📘 Best Practices
1. **Cache Wisely:** Use `ETag` and `Cache-Control` headers for state data
2. **Batch Operations:** Combine requests using `/api/actions/batch`
3. **WebSocket First:** Prefer real-time updates over polling
4. **Error Recovery:** Implement exponential backoff with jitter
5. **Cache Invalidation:** Use tags for bulk invalidation
```mermaid
graph LR
A[Client] -->|Cached Request| B{CDN}
B -->|Cache Hit| C[Return 304]
B -->|Cache Miss| D[Origin Server]
D -->|Response| B
B -->|Response| A
```
> Pro Tip: Use `curl -I` to inspect cache headers! 🔍
## Device Control
### Common Entity Controls
```json
{
"tool": "control",
"command": "turn_on", // Options: "turn_on", "turn_off", "toggle"
"entity_id": "light.living_room"
}
```
### Light Control
```json
{
"tool": "control",
"command": "turn_on",
"entity_id": "light.living_room",
"brightness": 128,
"color_temp": 4000,
"rgb_color": [255, 0, 0]
}
```
## Add-on Management
### List Available Add-ons
```json
{
"tool": "addon",
"action": "list"
}
```
### Install Add-on
```json
{
"tool": "addon",
"action": "install",
"slug": "core_configurator",
"version": "5.6.0"
}
```
### Manage Add-on State
```json
{
"tool": "addon",
"action": "start", // Options: "start", "stop", "restart"
"slug": "core_configurator"
}
```
## Package Management
### List HACS Packages
```json
{
"tool": "package",
"action": "list",
"category": "integration" // Options: "integration", "plugin", "theme", "python_script", "appdaemon", "netdaemon"
}
```
### Install Package
```json
{
"tool": "package",
"action": "install",
"category": "integration",
"repository": "hacs/integration",
"version": "1.32.0"
}
```
## Automation Management
For automation management details and endpoints, please refer to the [Tools Documentation](tools/tools.md).
## Security Considerations
- Validate and sanitize all user inputs.
- Enforce rate limiting to prevent abuse.
- Apply proper security headers.
- Gracefully handle errors based on the environment.
## Troubleshooting
If you experience issues with the API:
- Verify the endpoint and request payload.
- Check authentication tokens and required headers.
- Consult the [Troubleshooting Guide](troubleshooting.md) for further guidance.
## MCP Schema Endpoint
The server exposes an MCP (Model Context Protocol) schema endpoint that describes all available tools and their parameters:
```http
GET /mcp
```
This endpoint returns a JSON schema describing all available tools, their parameters, and documentation resources. The schema follows the MCP specification and can be used by LLM clients to understand the server's capabilities.
Example response:
```json
{
"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", ...]
},
"area": { "type": "string" },
"floor": { "type": "string" }
}
}
},
// ... other tools
],
"prompts": [],
"resources": [
{
"name": "Home Assistant API",
"url": "https://developers.home-assistant.io/docs/api/rest/"
}
]
}
```
Note: The `/mcp` endpoint is publicly accessible and does not require authentication, as it only provides schema information.
## Core Functions
### State Management
```http
GET /api/state
POST /api/state
```
Manages the current state of the system.
**Example Request:**
```json
POST /api/state
{
"context": "living_room",
"state": {
"lights": "on",
"temperature": 22
}
}
```
### Context Updates
```http
POST /api/context
```
Updates the current context with new information.
**Example Request:**
```json
POST /api/context
{
"user": "john",
"location": "kitchen",
"time": "morning",
"activity": "cooking"
}
```
## Action Endpoints
### Execute Action
```http
POST /api/action
```
Executes a specified action with given parameters.
**Example Request:**
```json
POST /api/action
{
"action": "turn_on_lights",
"parameters": {
"room": "living_room",
"brightness": 80
}
}
```
### Batch Actions
```http
POST /api/actions/batch
```
Executes multiple actions in sequence.
**Example Request:**
```json
POST /api/actions/batch
{
"actions": [
{
"action": "turn_on_lights",
"parameters": {
"room": "living_room"
}
},
{
"action": "set_temperature",
"parameters": {
"temperature": 22
}
}
]
}
```
## Query Functions
### Get Available Actions
```http
GET /api/actions
```
Returns a list of all available actions.
**Example Response:**
```json
{
"actions": [
{
"name": "turn_on_lights",
"parameters": ["room", "brightness"],
"description": "Turns on lights in specified room"
},
{
"name": "set_temperature",
"parameters": ["temperature"],
"description": "Sets temperature in current context"
}
]
}
```
### Context Query
```http
GET /api/context?type=current
```
Retrieves context information.
**Example Response:**
```json
{
"current_context": {
"user": "john",
"location": "kitchen",
"time": "morning",
"activity": "cooking"
}
}
```
## WebSocket Events
The server supports real-time updates via WebSocket connections.
```javascript
// Client-side connection example
const ws = new WebSocket('ws://localhost:3000/ws');
ws.onmessage = (event) => {
const data = JSON.parse(event.data);
console.log('Received update:', data);
};
```
### Supported Events
- `state_change`: Emitted when system state changes
- `context_update`: Emitted when context is updated
- `action_executed`: Emitted when an action is completed
- `error`: Emitted when an error occurs
**Example Event Data:**
```json
{
"event": "state_change",
"data": {
"previous_state": {
"lights": "off"
},
"current_state": {
"lights": "on"
},
"timestamp": "2024-03-20T10:30:00Z"
}
}
```
## Error Handling
All endpoints return standard HTTP status codes:
- 200: Success
- 400: Bad Request
- 401: Unauthorized
- 403: Forbidden
- 404: Not Found
- 500: Internal Server Error
**Error Response Format:**
```json
{
"error": {
"code": "INVALID_PARAMETERS",
"message": "Missing required parameter: room",
"details": {
"missing_fields": ["room"]
}
}
}
```
## Rate Limiting
The API implements rate limiting to prevent abuse:
- 100 requests per minute per IP for regular endpoints
- 1000 requests per minute per IP for WebSocket connections
When rate limit is exceeded, the server returns:
```json
{
"error": {
"code": "RATE_LIMIT_EXCEEDED",
"message": "Too many requests",
"reset_time": "2024-03-20T10:31:00Z"
}
}
```
## Example Usage
### Using curl
```bash
# Get current state
curl -X GET \
http://localhost:3000/api/state \
-H 'Authorization: ApiKey your_api_key_here'
# Execute action
curl -X POST \
http://localhost:3000/api/action \
-H 'Authorization: ApiKey your_api_key_here' \
-H 'Content-Type: application/json' \
-d '{
"action": "turn_on_lights",
"parameters": {
"room": "living_room",
"brightness": 80
}
}'
```
### Using JavaScript
```javascript
// Execute action
async function executeAction() {
const response = await fetch('http://localhost:3000/api/action', {
method: 'POST',
headers: {
'Authorization': 'ApiKey your_api_key_here',
'Content-Type': 'application/json'
},
body: JSON.stringify({
action: 'turn_on_lights',
parameters: {
room: 'living_room',
brightness: 80
}
})
});
const data = await response.json();
console.log('Action result:', data);
}
```
## Security Middleware
### Overview
The security middleware provides a comprehensive set of utility functions to enhance the security of the Home Assistant MCP application. These functions cover various aspects of web security, including:
- Rate limiting
- Request validation
- Input sanitization
- Security headers
- Error handling
### Utility Functions
#### `checkRateLimit(ip: string, maxRequests?: number, windowMs?: number)`
Manages rate limiting for IP addresses to prevent abuse.
**Parameters**:
- `ip`: IP address to track
- `maxRequests`: Maximum number of requests allowed (default: 100)
- `windowMs`: Time window for rate limiting (default: 15 minutes)
**Returns**: `boolean` or throws an error if limit is exceeded
**Example**:
```typescript
try {
checkRateLimit('127.0.0.1'); // Checks rate limit with default settings
} catch (error) {
// Handle rate limit exceeded
}
```
#### `validateRequestHeaders(request: Request, requiredContentType?: string)`
Validates incoming HTTP request headers for security and compliance.
**Parameters**:
- `request`: The incoming HTTP request
- `requiredContentType`: Expected content type (default: 'application/json')
**Checks**:
- Content type
- Request body size
- Authorization header (optional)
**Example**:
```typescript
try {
validateRequestHeaders(request);
} catch (error) {
// Handle validation errors
}
```
#### `sanitizeValue(value: unknown)`
Sanitizes input values to prevent XSS attacks.
**Features**:
- Escapes HTML tags
- Handles nested objects and arrays
- Preserves non-string values
**Example**:
```typescript
const sanitized = sanitizeValue('<script>alert("xss")</script>');
// Returns: '&lt;script&gt;alert(&quot;xss&quot;)&lt;/script&gt;'
```
#### `applySecurityHeaders(request: Request, helmetConfig?: HelmetOptions)`
Applies security headers to HTTP requests using Helmet.
**Security Headers**:
- Content Security Policy
- X-Frame-Options
- X-Content-Type-Options
- Referrer Policy
- HSTS (in production)
**Example**:
```typescript
const headers = applySecurityHeaders(request);
```
#### `handleError(error: Error, env?: string)`
Handles error responses with environment-specific details.
**Modes**:
- Production: Generic error message
- Development: Detailed error with stack trace
**Example**:
```typescript
const errorResponse = handleError(error, process.env.NODE_ENV);
```
### Middleware Usage
These utility functions are integrated into Elysia middleware:
```typescript
const app = new Elysia()
.use(rateLimiter) // Rate limiting
.use(validateRequest) // Request validation
.use(sanitizeInput) // Input sanitization
.use(securityHeaders) // Security headers
.use(errorHandler) // Error handling
```
### Best Practices
1. Always validate and sanitize user inputs
2. Use rate limiting to prevent abuse
3. Apply security headers
4. Handle errors gracefully
5. Keep environment-specific error handling
### Security Considerations
- Configurable rate limits
- XSS protection
- Content security policies
- Token validation
- Error information exposure control
### Troubleshooting
- Ensure `JWT_SECRET` is set in environment
- Check content type in requests
- Monitor rate limit errors
- Review error handling in different environments

68
docs/architecture.md Normal file
View File

@@ -0,0 +1,68 @@
# Architecture Documentation for MCP Server
## Overview
The MCP Server is designed as a high-performance, secure, and scalable bridge between Home Assistant and Language Learning Models (LLMs). This document outlines the architectural design principles, core components, and deployment strategies that power the MCP Server.
## Key Architectural Components
### High-Performance Runtime with Bun
- **Fast Startup & Efficiency:** Powered by Bun, the MCP Server benefits from rapid startup times, efficient memory utilization, and native TypeScript support.
- **Optimized Build Process:** Bun's build tools allow for quick iteration and deployment, ensuring minimal downtime and swift performance enhancement.
### Real-time Communication using Server-Sent Events (SSE)
- **Continuous Updates:** The server leverages SSE to deliver real-time notifications and updates, ensuring that any changes in Home Assistant are immediately communicated to connected clients.
- **Scalable Connection Handling:** SSE provides an event-driven model that efficiently manages multiple simultaneous client connections.
### Modular & Extensible Design
- **Plugin Architecture:** Designed with modularity in mind, the MCP Server supports plugins, add-ons, and custom automation scripts, enabling seamless feature expansion without disrupting core functionality.
- **Separation of Concerns:** Different components, such as device management, automation control, and system monitoring, are clearly separated, allowing independent development, testing, and scaling.
### Secure API Integration
- **Token-Based Authentication:** Robust token-based authentication mechanisms restrict access to authorized users and systems.
- **Rate Limiting & Error Handling:** Integrated rate limiting combined with comprehensive error handling ensures system stability and prevents misuse.
- **Best Practices:** All API endpoints follow industry-standard security guidelines to protect data and maintain system integrity.
### Deployment & Scalability
- **Containerized Deployment with Docker:** The use of Docker Compose enables straightforward deployment, management, and scaling of the server and its dependencies.
- **Flexible Environment Configuration:** Environment variables and configuration files (.env) facilitate smooth transitions between development, testing, and production setups.
## Future Enhancements
- **Advanced Automation Logic:** Integration of more complex automation rules and conditional decision-making capabilities.
- **Enhanced Security Measures:** Additional layers of security, such as multi-factor authentication and improved encryption techniques, are on the roadmap.
- **Improved Monitoring & Analytics:** Future updates will introduce advanced performance metrics and real-time analytics to monitor system health and user interactions.
## Conclusion
The architecture of the MCP Server prioritizes performance, scalability, and security. By leveraging Bun's high-performance runtime, employing real-time communication through SSE, and maintaining a modular, secure design, the MCP Server provides a robust platform for integrating Home Assistant with modern LLM functionalities.
*This document is a living document and will be updated as the system evolves.*
## Key Components
- **API Module:** Handles RESTful endpoints, authentication, and error management.
- **SSE Module:** Provides real-time updates through Server-Sent Events.
- **Tools Module:** Offers various utilities for device control, automation, and data processing.
- **Security Module:** Implements token-based authentication and secure communications.
- **Integration Module:** Bridges data between Home Assistant and external systems.
## Data Flow
1. Requests enter via the API endpoints.
2. Security middleware validates and processes requests.
3. Core modules process data and execute the necessary business logic.
4. Real-time notifications are managed by the SSE module.
## Future Enhancements
- Expand modularity with potential microservices.
- Enhance security with multi-factor authentication.
- Improve scalability through distributed architectures.
*Further diagrams and detailed breakdowns will be added in future updates.*

View File

@@ -0,0 +1,54 @@
@import "{{ site.theme }}";
// Custom styles
.main-nav {
margin-top: 20px;
ul {
list-style: none;
padding: 0;
margin: 0;
}
li {
margin-bottom: 8px;
}
a {
color: #267CB9;
text-decoration: none;
&:hover {
text-decoration: underline;
}
}
}
h1,
h2,
h3 {
color: #333;
}
code {
background-color: #f8f8f8;
border: 1px solid #ddd;
border-radius: 3px;
padding: 2px 5px;
}
pre {
background-color: #f8f8f8;
border: 1px solid #ddd;
border-radius: 3px;
padding: 10px;
overflow-x: auto;
}
.wrapper {
max-width: 960px;
}
section {
max-width: 700px;
}

36
docs/contributing.md Normal file
View File

@@ -0,0 +1,36 @@
# Contributing to Home Assistant MCP
We welcome community contributions to improve the MCP Server. Please review the following guidelines before contributing.
## How to Contribute
1. **Fork the Repository:** Create your personal fork on GitHub.
2. **Create a Feature Branch:** Use a clear name (e.g., `feature/your-feature` or `bugfix/short-description`).
3. **Make Changes:** Develop your feature or fix bugs while following our coding standards.
4. **Write Tests:** Include tests for new features or bug fixes.
5. **Submit a Pull Request:** Once your changes are complete, submit a PR for review.
6. **Address Feedback:** Revise your PR based on maintainers' suggestions.
## Code Style Guidelines
- Follow the project's established coding style.
- Use Bun tooling for linting and formatting:
- `bun run lint`
- `bun run format`
## Documentation
- Update documentation alongside your code changes.
- Ensure tests pass and coverage remains high.
## Reporting Issues
- Use the GitHub Issues page to report bugs, request new features, or ask questions.
- Provide clear descriptions, replication steps, and any error logs.
## Community
- Join our real-time discussions on our chat platforms (Discord, Slack, etc.).
- Engage with other contributors to exchange ideas and solutions.
Thank you for helping improve the Home Assistant MCP project!

View File

@@ -7,6 +7,8 @@ This guide provides information for developers who want to contribute to or exte
```
homeassistant-mcp/
├── src/
│ ├── __tests__/ # Test files
│ ├── __mocks__/ # Mock files
│ ├── api/ # API endpoints and route handlers
│ ├── config/ # Configuration management
│ ├── hass/ # Home Assistant integration

View File

@@ -1,122 +1,30 @@
# Getting Started with Home Assistant MCP
# Getting Started
This guide will help you get started with the Home Assistant MCP (Master Control Program).
Begin your journey with the Home Assistant MCP Server by following these steps:
## Prerequisites
Before you begin, ensure you have:
1. Node.js (v16 or higher)
2. A running Home Assistant instance
3. A Home Assistant Long-Lived Access Token
## Installation
1. Clone the repository:
```bash
git clone https://github.com/yourusername/homeassistant-mcp.git
cd homeassistant-mcp
```
2. Install dependencies:
```bash
npm install
```
3. Copy the example environment file:
```bash
cp .env.example .env
```
4. Edit the `.env` file with your configuration:
```env
# Server Configuration
PORT=3000
NODE_ENV=development
# Home Assistant Configuration
HASS_HOST=http://your-hass-instance:8123
HASS_TOKEN=your-long-lived-access-token
# Security Configuration
JWT_SECRET=your-secret-key
```
## Configuration
### Environment Variables
- `PORT`: The port number for the MCP server (default: 3000)
- `NODE_ENV`: The environment mode (development, production, test)
- `HASS_HOST`: Your Home Assistant instance URL
- `HASS_TOKEN`: Your Home Assistant Long-Lived Access Token
- `JWT_SECRET`: Secret key for JWT token generation
### Development Mode
For development, you can use:
```bash
npm run dev
```
This will start the server in development mode with hot reloading.
### Production Mode
For production, build and start the server:
```bash
npm run build
npm start
```
## First Steps
1. Check the server is running:
```bash
curl http://localhost:3000/api/health
```
2. List available devices:
```bash
curl -H "Authorization: Bearer your-token" http://localhost:3000/api/tools/devices
```
3. Subscribe to events:
```bash
curl -H "Authorization: Bearer your-token" http://localhost:3000/api/sse/subscribe?events=state_changed
```
## Next Steps
- Read the [API Documentation](./API.md) for available endpoints
- Learn about [Server-Sent Events](./SSE_API.md) for real-time updates
- Explore available [Tools](./tools/README.md) for device control
- Check the [Configuration Guide](./configuration/README.md) for advanced settings
- **API Documentation:** Read the [API Documentation](api.md) for available endpoints.
- **Real-Time Updates:** Learn about [Server-Sent Events](sse-api.md) for live communication.
- **Tools:** Explore available [Tools](tools/tools.md) for device control and automation.
- **Configuration:** Refer to the [Configuration Guide](configuration.md) for setup and advanced settings.
## Troubleshooting
If you encounter issues:
1. Verify your Home Assistant instance is accessible
2. Check your environment variables are correctly set
3. Look for errors in the server logs
4. Consult the [Troubleshooting Guide](./troubleshooting.md)
If you encounter any issues:
1. Verify that your Home Assistant instance is accessible.
2. Ensure that all required environment variables are properly set.
3. Consult the [Troubleshooting Guide](troubleshooting.md) for additional solutions.
## Development
For development and contributing:
1. Fork the repository
2. Create a feature branch
3. Follow the [Development Guide](./development/README.md)
4. Submit a pull request
For contributors:
1. Fork the repository.
2. Create a feature branch.
3. Follow the [Development Guide](development/development.md) for contribution guidelines.
4. Submit a pull request with your enhancements.
## Support
Need help? Check out:
- [GitHub Issues](https://github.com/yourusername/homeassistant-mcp/issues)
- [Troubleshooting Guide](./troubleshooting.md)
- [FAQ](./troubleshooting.md#faq)
Need help?
- Visit our [GitHub Issues](https://github.com/jango-blockchained/homeassistant-mcp/issues).
- Review the [Troubleshooting Guide](troubleshooting.md).
- Check the [FAQ](troubleshooting.md#faq) for common questions.

View File

@@ -0,0 +1,5 @@
# Configuration
## Basic Configuration
## Advanced Settings

View File

@@ -0,0 +1,124 @@
# Installation Guide
## Prerequisites
### System Requirements
- **Operating System:** Linux, macOS, or Windows (Docker recommended)
- **Runtime:** Bun v1.0.26 or higher
- **Home Assistant:** v2023.11 or higher
- **Minimum Hardware:**
- 2 CPU cores
- 2GB RAM
- 10GB free disk space
### Software Dependencies
- Bun runtime
- Docker (optional, recommended for deployment)
- Git
- Node.js (for some development tasks)
## Installation Methods
### 1. Basic Setup
#### Install Bun
```bash
curl -fsSL https://bun.sh/install | bash
```
#### Clone Repository
```bash
git clone https://github.com/jango-blockchained/homeassistant-mcp.git
cd homeassistant-mcp
```
#### Install Dependencies
```bash
bun install
```
#### Configure Environment
1. Copy environment template
```bash
cp .env.example .env
```
2. Edit `.env` file with your Home Assistant configuration
- Set `HASS_HOST`
- Configure authentication tokens
- Adjust other settings as needed
#### Build and Start
```bash
bun run build
bun start
```
### 2. Docker Setup (Recommended)
#### Prerequisites
- Docker
- Docker Compose
#### Deployment Steps
```bash
# Clone repository
git clone https://github.com/jango-blockchained/homeassistant-mcp.git
cd homeassistant-mcp
# Configure environment
cp .env.example .env
# Edit .env file with your settings
# Deploy with Docker Compose
docker compose up -d
```
### 3. Home Assistant Add-on (Coming Soon)
We're working on a direct Home Assistant add-on for even easier installation.
## Verification
### Check Installation
- Web Interface: [http://localhost:3000](http://localhost:3000)
- Logs: `docker compose logs` or check `logs/` directory
### Troubleshooting
- Ensure all environment variables are correctly set
- Check network connectivity to Home Assistant
- Verify authentication tokens
## Updating
### Basic Setup
```bash
git pull
bun install
bun run build
bun start
```
### Docker
```bash
git pull
docker compose up -d --build
```
## Uninstallation
### Basic Setup
```bash
cd homeassistant-mcp
bun stop # Stop the application
rm -rf node_modules dist
```
### Docker
```bash
docker compose down
docker rmi homeassistant-mcp # Remove image
```
## Next Steps
- [Configuration Guide](configuration.md)
- [Usage Instructions](../usage.md)
- [Troubleshooting](../troubleshooting.md)

110
docs/index.md Normal file
View File

@@ -0,0 +1,110 @@
---
layout: default
title: Home
nav_order: 1
---
# 📚 Home Assistant MCP Documentation
Welcome to the documentation for the Home Assistant MCP (Model Context Protocol) Server.
## 📑 Documentation Index
- [Getting Started Guide](getting-started.md)
- [API Documentation](api.md)
- [Troubleshooting](troubleshooting.md)
- [Contributing Guide](contributing.md)
For project overview, installation, and general information, please see our [main README](../README.md).
## 🔗 Quick Links
- [GitHub Repository](https://github.com/jango-blockchained/homeassistant-mcp)
- [Issue Tracker](https://github.com/jango-blockchained/homeassistant-mcp/issues)
- [GitHub Discussions](https://github.com/jango-blockchained/homeassistant-mcp/discussions)
## 📝 License
This project is licensed under the MIT License. See [LICENSE](../LICENSE) for details.
# Model Context Protocol (MCP) Server
## Overview
The Model Context Protocol (MCP) Server is a cutting-edge bridge between Home Assistant and Language Learning Models (LLMs), designed to revolutionize smart home automation and control. This documentation provides comprehensive information about setting up, configuring, and using the Home Assistant MCP.
## Key Features
### 🏠 Smart Home Integration
- Natural language control of smart devices
- Real-time device state monitoring
- Advanced automation capabilities
### 🤖 LLM Powered Interactions
- Intuitive voice and text-based commands
- Context-aware device management
- Intelligent automation suggestions
### 🔒 Security & Performance
- Token-based authentication
- High-performance Bun runtime
- Secure, real-time communication protocols
## Documentation
### Core Documentation
1. [Getting Started](getting-started.md)
- Installation and basic setup
- Configuration
- First Steps
2. [API Reference](api.md)
- REST API Endpoints
- Authentication
- Error Handling
3. [SSE API](sse-api.md)
- Event Subscriptions
- Real-time Updates
- Connection Management
### Advanced Topics
4. [Architecture](architecture.md)
- System Design
- Components
- Data Flow
5. [Configuration](getting-started.md#configuration)
- Environment Variables
- Security Settings
- Performance Tuning
6. [Development Guide](development/development.md)
- Project Structure
- Contributing Guidelines
- Testing
7. [Troubleshooting](troubleshooting.md)
- Common Issues
- Debugging
- FAQ
## Quick Links
- [GitHub Repository](https://github.com/jango-blockchained/homeassistant-mcp)
- [Issue Tracker](https://github.com/jango-blockchained/homeassistant-mcp/issues)
- [Contributing Guide](contributing.md)
- [Roadmap](roadmap.md)
## Community and Support
If you need help or have questions:
1. Check the [Troubleshooting Guide](troubleshooting.md)
2. Search existing [Issues](https://github.com/jango-blockchained/homeassistant-mcp/issues)
3. Join our [GitHub Discussions](https://github.com/jango-blockchained/homeassistant-mcp/discussions)
4. Create a new issue if your problem isn't already reported
## License
This project is licensed under the MIT License. See [LICENSE](https://github.com/jango-blockchained/homeassistant-mcp/blob/main/LICENSE) for details.

51
docs/roadmap.md Normal file
View File

@@ -0,0 +1,51 @@
# Roadmap for MCP Server
The following roadmap outlines our planned enhancements and future directions for the Home Assistant MCP Server. This document is a living guide that will be updated as new features are planned and developed.
## Near-Term Goals
- **Advanced Automation Capabilities:**
- Integrate sophisticated automation rules with conditional logic and multi-step execution.
- Introduce a visual automation builder for simplified rule creation.
- **Enhanced Security Features:**
- Implement multi-factor authentication for critical actions.
- Strengthen encryption methods and data handling practices.
- Expand monitoring and alerting for potential security breaches.
- **Performance Optimizations:**
- Refine resource utilization to reduce latency.
- Optimize real-time data streaming via SSE.
- Introduce advanced caching mechanisms for frequently requested data.
## Mid-Term Goals
- **User Interface Improvements:**
- Develop an intuitive web-based dashboard for device management and monitoring.
- Provide real-time analytics and performance metrics.
- **Expanded Integrations:**
- Support a broader range of smart home devices and brands.
- Integrate with additional home automation platforms and third-party services.
- **Developer Experience Enhancements:**
- Improve documentation and developer tooling.
- Streamline contribution guidelines and testing setups.
## Long-Term Vision
- **Ecosystem Expansion:**
- Build a modular plugin system for community-driven extensions and integrations.
- Enable seamless integration with future technologies in smart home and AI domains.
- **Scalability and Resilience:**
- Architect the system to support large-scale deployments.
- Incorporate advanced load balancing and failover mechanisms.
## How to Follow the Roadmap
- **Community Involvement:** We welcome and encourage feedback.
- **Regular Updates:** This document is updated regularly with new goals and milestones.
- **Transparency:** Check our GitHub repository and issue tracker for ongoing discussions.
*This roadmap is intended as a guide and may evolve based on community needs, technological advancements, and strategic priorities.*

422
docs/testing.md Normal file
View File

@@ -0,0 +1,422 @@
# Testing Documentation
## Quick Reference
```bash
# Most Common Commands
bun test # Run all tests
bun test --watch # Run tests in watch mode
bun test --coverage # Run tests with coverage
bun test path/to/test.ts # Run a specific test file
# Additional Options
DEBUG=true bun test # Run with debug output
bun test --pattern "auth" # Run tests matching a pattern
bun test --timeout 60000 # Run with a custom timeout
```
## Overview
This document describes the testing setup and practices used in the Home Assistant MCP project. We use Bun's test runner for both unit and integration testing, ensuring comprehensive coverage across modules.
## Test Structure
Tests are organized in two main locations:
1. **Root Level Integration Tests** (`/__tests__/`):
```
__tests__/
├── ai/ # AI/ML component tests
├── api/ # API integration tests
├── context/ # Context management tests
├── hass/ # Home Assistant integration tests
├── schemas/ # Schema validation tests
├── security/ # Security integration tests
├── tools/ # Tools and utilities tests
├── websocket/ # WebSocket integration tests
├── helpers.test.ts # Helper function tests
├── index.test.ts # Main application tests
└── server.test.ts # Server integration tests
```
2. **Component Level Unit Tests** (`src/**/`):
```
src/
├── __tests__/ # Global test setup and utilities
│ └── setup.ts # Global test configuration
├── component/
│ ├── __tests__/ # Component-specific unit tests
│ └── component.ts
```
## Test Configuration
### Bun Test Configuration (`bunfig.toml`)
```toml
[test]
preload = ["./src/__tests__/setup.ts"] # Global test setup
coverage = true # Enable coverage by default
timeout = 30000 # Test timeout in milliseconds
testMatch = ["**/__tests__/**/*.test.ts"] # Test file patterns
```
### Bun Scripts
Available test commands in `package.json`:
```bash
# Run all tests
bun test
# Watch mode for development
bun test --watch
# Generate coverage report
bun test --coverage
# Run linting
bun run lint
# Format code
bun run format
```
## Test Setup
### Global Configuration
A global test setup file (`src/__tests__/setup.ts`) provides:
- Environment configuration
- Mock utilities
- Test helper functions
- Global lifecycle hooks
### Test Environment
- Environment variables are loaded from `.env.test`.
- Console output is minimized unless `DEBUG=true`.
- JWT secrets and tokens are preconfigured for testing.
- Rate limiting and security features are initialized appropriately.
## Running Tests
```bash
# Basic test run
bun test
# Run tests with coverage
bun test --coverage
# Run a specific test file
bun test path/to/test.test.ts
# Run tests in watch mode
bun test --watch
# Run tests with debug output
DEBUG=true bun test
# Run tests with increased timeout
bun test --timeout 60000
# Run tests matching a pattern
bun test --pattern "auth"
```
## Advanced Debugging
### Using Node Inspector
```bash
# Start tests with inspector
bun test --inspect
# Start tests with inspector and break on first line
bun test --inspect-brk
```
### Using VS Code
Create a launch configuration in `.vscode/launch.json`:
```json
{
"version": "0.2.0",
"configurations": [
{
"type": "bun",
"request": "launch",
"name": "Debug Tests",
"program": "${workspaceFolder}/node_modules/bun/bin/bun",
"args": ["test", "${file}"],
"cwd": "${workspaceFolder}",
"env": { "DEBUG": "true" }
}
]
}
```
### Test Isolation
To run a single test in isolation:
```typescript
describe.only("specific test suite", () => {
it.only("specific test case", () => {
// Only this test will run
});
});
```
## Writing Tests
### Test File Naming
- Place test files in a `__tests__` directory adjacent to the code being tested.
- Name files with the pattern `*.test.ts`.
- Mirror the structure of the source code in your test organization.
### Example Test Structure
```typescript
describe("Security Features", () => {
it("should validate tokens correctly", () => {
const payload = { userId: "123", role: "user" };
const token = jwt.sign(payload, validSecret, { expiresIn: "1h" });
const result = TokenManager.validateToken(token, testIp);
expect(result.valid).toBe(true);
});
});
```
## Coverage
The project maintains strict coverage:
- Overall coverage: at least 80%
- Critical paths: 90%+
- New features: ≥85% coverage
Generate a coverage report with:
```bash
bun test --coverage
```
## Security Middleware Testing
### Utility Function Testing
The security middleware now uses a utility-first approach, which allows for more granular and comprehensive testing. Each security function is now independently testable, improving code reliability and maintainability.
#### Key Utility Functions
1. **Rate Limiting (`checkRateLimit`)**
- Tests multiple scenarios:
- Requests under threshold
- Requests exceeding threshold
- Rate limit reset after window expiration
```typescript
// Example test
it('should throw when requests exceed threshold', () => {
const ip = '127.0.0.2';
for (let i = 0; i < 11; i++) {
if (i < 10) {
expect(() => checkRateLimit(ip, 10)).not.toThrow();
} else {
expect(() => checkRateLimit(ip, 10)).toThrow('Too many requests from this IP');
}
}
});
```
2. **Request Validation (`validateRequestHeaders`)**
- Tests content type validation
- Checks request size limits
- Validates authorization headers
```typescript
it('should reject invalid content type', () => {
const mockRequest = new Request('http://localhost', {
method: 'POST',
headers: { 'content-type': 'text/plain' }
});
expect(() => validateRequestHeaders(mockRequest)).toThrow('Content-Type must be application/json');
});
```
3. **Input Sanitization (`sanitizeValue`)**
- Sanitizes HTML tags
- Handles nested objects
- Preserves non-string values
```typescript
it('should sanitize HTML tags', () => {
const input = '<script>alert("xss")</script>Hello';
const sanitized = sanitizeValue(input);
expect(sanitized).toBe('&lt;script&gt;alert(&quot;xss&quot;)&lt;/script&gt;Hello');
});
```
4. **Security Headers (`applySecurityHeaders`)**
- Verifies correct security header application
- Checks CSP, frame options, and other security headers
```typescript
it('should apply security headers', () => {
const mockRequest = new Request('http://localhost');
const headers = applySecurityHeaders(mockRequest);
expect(headers['content-security-policy']).toBeDefined();
expect(headers['x-frame-options']).toBeDefined();
});
```
5. **Error Handling (`handleError`)**
- Tests error responses in production and development modes
- Verifies error message and stack trace inclusion
```typescript
it('should include error details in development mode', () => {
const error = new Error('Test error');
const result = handleError(error, 'development');
expect(result).toEqual({
error: true,
message: 'Internal server error',
error: 'Test error',
stack: expect.any(String)
});
});
```
### Testing Philosophy
- **Isolation**: Each utility function is tested independently
- **Comprehensive Coverage**: Multiple scenarios for each function
- **Predictable Behavior**: Clear expectations for input and output
- **Error Handling**: Robust testing of error conditions
### Best Practices
1. Use minimal, focused test cases
2. Test both successful and failure scenarios
3. Verify input sanitization and security measures
4. Mock external dependencies when necessary
### Running Security Tests
```bash
# Run all tests
bun test
# Run specific security tests
bun test __tests__/security/
```
### Continuous Improvement
- Regularly update test cases
- Add new test scenarios as security requirements evolve
- Perform periodic security audits
## Best Practices
1. **Isolation**: Each test should be independent and not rely on the state of other tests.
2. **Mocking**: Use the provided mock utilities for external dependencies.
3. **Cleanup**: Clean up any resources or state modifications in `afterEach` or `afterAll` hooks.
4. **Descriptive Names**: Use clear, descriptive test names that explain the expected behavior.
5. **Assertions**: Make specific, meaningful assertions rather than general ones.
6. **Setup**: Use `beforeEach` for common test setup to avoid repetition.
7. **Error Cases**: Test both success and error cases for complete coverage.
## Coverage
The project aims for high test coverage, particularly focusing on:
- Security-critical code paths
- API endpoints
- Data validation
- Error handling
- Event broadcasting
Run coverage reports using:
```bash
bun test --coverage
```
## Debugging Tests
To debug tests:
1. Set `DEBUG=true` to enable console output during tests
2. Use the `--watch` flag for development
3. Add `console.log()` statements (they're only shown when DEBUG is true)
4. Use the test utilities' debugging helpers
### Advanced Debugging
1. **Using Node Inspector**:
```bash
# Start tests with inspector
bun test --inspect
# Start tests with inspector and break on first line
bun test --inspect-brk
```
2. **Using VS Code**:
```jsonc
// .vscode/launch.json
{
"version": "0.2.0",
"configurations": [
{
"type": "bun",
"request": "launch",
"name": "Debug Tests",
"program": "${workspaceFolder}/node_modules/bun/bin/bun",
"args": ["test", "${file}"],
"cwd": "${workspaceFolder}",
"env": { "DEBUG": "true" }
}
]
}
```
3. **Test Isolation**:
To run a single test in isolation:
```typescript
describe.only("specific test suite", () => {
it.only("specific test case", () => {
// Only this test will run
});
});
```
## Contributing
When contributing new code:
1. Add tests for new features
2. Ensure existing tests pass
3. Maintain or improve coverage
4. Follow the existing test patterns and naming conventions
5. Document any new test utilities or patterns
## Coverage Requirements
The project maintains strict coverage requirements:
- Minimum overall coverage: 80%
- Critical paths (security, API, data validation): 90%
- New features must include tests with >= 85% coverage
Coverage reports are generated in multiple formats:
- Console summary
- HTML report (./coverage/index.html)
- LCOV report (./coverage/lcov.info)
To view detailed coverage:
```bash
# Generate and open coverage report
bun test --coverage && open coverage/index.html
```

View File

@@ -1,144 +1,135 @@
# Troubleshooting Guide
This guide helps you diagnose and fix common issues with the Home Assistant MCP.
This guide provides solutions to common issues encountered with the Home Assistant MCP Server.
## Common Issues
### Connection Issues
- **Server Not Starting:**
- Verify that all required environment variables are correctly set.
- Check for port conflicts or missing dependencies.
- Review the server logs for error details.
#### Cannot Connect to Home Assistant
- **Connection Problems:**
- Ensure your Home Assistant instance is reachable.
- Confirm that the authentication token is valid.
- Check network configurations and firewalls.
## Tool Issues
### Tool Not Found
**Symptoms:**
- Connection timeout errors
- "Failed to connect to Home Assistant" messages
- 401 Unauthorized errors
- "Tool not found" errors or 404 responses.
**Solutions:**
1. Verify Home Assistant is running
2. Check HASS_HOST environment variable
3. Validate HASS_TOKEN is correct
4. Ensure network connectivity
5. Check firewall settings
- Double-check the tool name spelling.
- Verify that the tool is correctly registered.
- Review tool imports and documentation.
#### SSE Connection Drops
### Tool Execution Failures
**Symptoms:**
- Frequent disconnections
- Missing events
- Connection reset errors
- Execution errors or timeouts.
**Solutions:**
1. Check network stability
2. Increase connection timeout
3. Implement reconnection logic
4. Monitor server resources
- Validate input parameters.
- Check and review error logs.
- Debug the tool implementation.
- Ensure proper permissions in Home Assistant.
### Authentication Issues
#### Invalid Token
**Symptoms:**
- 401 Unauthorized responses
- "Invalid token" messages
- Authentication failures
**Solutions:**
1. Generate new Long-Lived Access Token
2. Check token expiration
3. Verify token format
4. Update environment variables
#### Rate Limiting
**Symptoms:**
- 429 Too Many Requests
- "Rate limit exceeded" messages
**Solutions:**
1. Implement request throttling
2. Adjust rate limit settings
3. Cache responses
4. Optimize request patterns
### Tool Issues
#### Tool Not Found
**Symptoms:**
- "Tool not found" errors
- 404 Not Found responses
**Solutions:**
1. Check tool name spelling
2. Verify tool registration
3. Update tool imports
4. Check tool availability
#### Tool Execution Fails
**Symptoms:**
- Tool execution errors
- Unexpected responses
- Timeout issues
**Solutions:**
1. Validate input parameters
2. Check error logs
3. Debug tool implementation
4. Verify Home Assistant permissions
## Debugging
## Debugging Steps
### Server Logs
1. Enable debug logging:
1. Enable debug logging by setting:
```env
LOG_LEVEL=debug
```
2. Check logs:
```bash
npm run logs
```
3. Filter logs:
3. Filter errors:
```bash
npm run logs | grep "error"
```
### Network Debugging
1. Check API endpoints:
1. Test API endpoints:
```bash
curl -v http://localhost:3000/api/health
```
2. Monitor SSE connections:
```bash
curl -N http://localhost:3000/api/sse/stats
```
3. Test WebSocket:
3. Test WebSocket connectivity:
```bash
wscat -c ws://localhost:3000
```
### Performance Issues
1. Monitor memory usage:
```bash
npm run stats
```
- Monitor memory usage with:
```bash
npm run stats
```
2. Check response times:
```bash
curl -w "%{time_total}\n" -o /dev/null -s http://localhost:3000/api/health
```
## Security Middleware Troubleshooting
3. Profile code:
```bash
npm run profile
```
### Rate Limiting Problems
**Symptoms:** Receiving 429 (Too Many Requests) errors.
**Solutions:**
- Adjust and fine-tune rate limit settings.
- Consider different limits for critical versus non-critical endpoints.
### Request Validation Failures
**Symptoms:** 400 or 415 errors on valid requests.
**Solutions:**
- Verify that the `Content-Type` header is set correctly.
- Inspect request payload size and format.
### Input Sanitization Issues
**Symptoms:** Unexpected data transformation or loss.
**Solutions:**
- Test sanitization with various input types.
- Implement custom sanitization for complex data if needed.
### Security Header Configuration
**Symptoms:** Missing or improper security headers.
**Solutions:**
- Review and update security header configurations (e.g., Helmet settings).
- Ensure environment-specific header settings are in place.
### Error Handling and Logging
**Symptoms:** Inconsistent error responses.
**Solutions:**
- Enhance logging for detailed error tracking.
- Adjust error handlers for production and development differences.
## Additional Resources
- [OWASP Security Guidelines](https://owasp.org/www-project-top-ten/)
- [Helmet.js Documentation](https://helmetjs.github.io/)
- [JWT Security Best Practices](https://jwt.io/introduction)
## Getting Help
If issues persist:
1. Review detailed logs.
2. Verify your configuration and environment.
3. Consult the GitHub issue tracker or community forums.
## FAQ
@@ -167,7 +158,7 @@ A: Adjust SSE_MAX_CLIENTS in configuration or clean up stale connections.
1. Documentation
- [API Reference](./API.md)
- [Configuration Guide](./configuration/README.md)
- [Development Guide](./development/README.md)
- [Development Guide](./development/development.md)
2. Community
- GitHub Issues
@@ -191,3 +182,164 @@ A: Adjust SSE_MAX_CLIENTS in configuration or clean up stale connections.
- GitHub Issues
- Email Support
- Community Forums
## Security Middleware Troubleshooting
### Common Issues and Solutions
#### Rate Limiting Problems
**Symptom**: Unexpected 429 (Too Many Requests) errors
**Possible Causes**:
- Misconfigured rate limit settings
- Shared IP addresses (e.g., behind NAT)
- Aggressive client-side retry mechanisms
**Solutions**:
1. Adjust rate limit parameters
```typescript
// Customize rate limit for specific scenarios
checkRateLimit(ip, maxRequests = 200, windowMs = 30 * 60 * 1000)
```
2. Implement more granular rate limiting
- Use different limits for different endpoints
- Consider user authentication level
#### Request Validation Failures
**Symptom**: 400 or 415 status codes on valid requests
**Possible Causes**:
- Incorrect `Content-Type` header
- Large request payloads
- Malformed authorization headers
**Debugging Steps**:
1. Verify request headers
```typescript
// Check content type and size
validateRequestHeaders(request, 'application/json')
```
2. Log detailed validation errors
```typescript
try {
validateRequestHeaders(request);
} catch (error) {
console.error('Request validation failed:', error.message);
}
```
#### Input Sanitization Issues
**Symptom**: Unexpected data transformation or loss
**Possible Causes**:
- Complex nested objects
- Non-standard input formats
- Overly aggressive sanitization
**Troubleshooting**:
1. Test sanitization with various input types
```typescript
const input = {
text: '<script>alert("xss")</script>',
nested: { html: '<img src="x" onerror="alert(1)">World' }
};
const sanitized = sanitizeValue(input);
```
2. Custom sanitization for specific use cases
```typescript
function customSanitize(value) {
// Add custom sanitization logic
return sanitizeValue(value);
}
```
#### Security Header Configuration
**Symptom**: Missing or incorrect security headers
**Possible Causes**:
- Misconfigured Helmet options
- Environment-specific header requirements
**Solutions**:
1. Custom security header configuration
```typescript
const customHelmetConfig = {
contentSecurityPolicy: {
directives: {
defaultSrc: ["'self'"],
scriptSrc: ["'self'", 'trusted-cdn.com']
}
}
};
applySecurityHeaders(request, customHelmetConfig);
```
#### Error Handling and Logging
**Symptom**: Inconsistent error responses
**Possible Causes**:
- Incorrect environment configuration
- Unhandled error types
**Debugging Techniques**:
1. Verify environment settings
```typescript
const errorResponse = handleError(error, process.env.NODE_ENV);
```
2. Add custom error handling
```typescript
function enhancedErrorHandler(error, env) {
// Add custom logging or monitoring
console.error('Security error:', error);
return handleError(error, env);
}
```
### Performance and Security Monitoring
1. **Logging**
- Enable debug logging for security events
- Monitor rate limit and validation logs
2. **Metrics**
- Track rate limit hit rates
- Monitor request validation success/failure ratios
3. **Continuous Improvement**
- Regularly review and update security configurations
- Conduct periodic security audits
### Environment-Specific Considerations
#### Development
- More verbose error messages
- Relaxed rate limiting
- Detailed security logs
#### Production
- Minimal error details
- Strict rate limiting
- Comprehensive security headers
### External Resources
- [OWASP Security Guidelines](https://owasp.org/www-project-top-ten/)
- [Helmet.js Documentation](https://helmetjs.github.io/)
- [JWT Security Best Practices](https://jwt.io/introduction)
### Getting Help
If you encounter persistent issues:
1. Check application logs
2. Verify environment configurations
3. Consult the project's issue tracker
4. Reach out to the development team with detailed error information

34
docs/usage.md Normal file
View File

@@ -0,0 +1,34 @@
# Usage Guide
This guide explains how to use the Home Assistant MCP Server for smart home device management and integration with language learning systems.
## Basic Usage
1. **Starting the Server:**
- For development: run `npm run dev`.
- For production: run `npm run build` followed by `npm start`.
2. **Accessing the Web Interface:**
- Open [http://localhost:3000](http://localhost:3000) in your browser.
3. **Real-Time Updates:**
- Connect to the SSE endpoint at `/subscribe_events?token=YOUR_TOKEN&domain=light` to receive live updates.
## Advanced Features
1. **API Interactions:**
- Use the REST API for operations such as device control, automation, and add-on management.
- See [API Documentation](api.md) for details.
2. **Tool Integrations:**
- Multiple tools are available (see [Tools Documentation](tools/tools.md)), for tasks like automation management and notifications.
3. **Security Settings:**
- Configure token-based authentication and environment variables as per the [Configuration Guide](getting-started/configuration.md).
4. **Customization and Extensions:**
- Extend server functionality by developing new tools as outlined in the [Development Guide](development/development.md).
## Troubleshooting
If you experience issues, review the [Troubleshooting Guide](troubleshooting.md).

91
examples/README.md Normal file
View File

@@ -0,0 +1,91 @@
# Speech-to-Text Examples
This directory contains examples demonstrating how to use the speech-to-text integration with wake word detection.
## Prerequisites
1. Make sure you have Docker installed and running
2. Build and start the services:
```bash
docker-compose up -d
```
## Running the Example
1. Install dependencies:
```bash
npm install
```
2. Run the example:
```bash
npm run example:speech
```
Or using `ts-node` directly:
```bash
npx ts-node examples/speech-to-text-example.ts
```
## Features Demonstrated
1. **Wake Word Detection**
- Listens for wake words: "hey jarvis", "ok google", "alexa"
- Automatically saves audio when wake word is detected
- Transcribes the detected speech
2. **Manual Transcription**
- Example of how to transcribe audio files manually
- Supports different models and configurations
3. **Event Handling**
- Wake word detection events
- Transcription results
- Progress updates
- Error handling
## Example Output
When a wake word is detected, you'll see output like this:
```
🎤 Wake word detected!
Timestamp: 20240203_123456
Audio file: /path/to/audio/wake_word_20240203_123456.wav
Metadata file: /path/to/audio/wake_word_20240203_123456.wav.json
📝 Transcription result:
Full text: This is what was said after the wake word.
Segments:
1. [0.00s - 1.52s] (95.5% confidence)
"This is what was said"
2. [1.52s - 2.34s] (98.2% confidence)
"after the wake word."
```
## Customization
You can customize the behavior by:
1. Changing the wake word models in `docker/speech/Dockerfile`
2. Modifying transcription options in the example file
3. Adding your own event handlers
4. Implementing different audio processing logic
## Troubleshooting
1. **Docker Issues**
- Make sure Docker is running
- Check container logs: `docker-compose logs fast-whisper`
- Verify container is up: `docker ps`
2. **Audio Issues**
- Check audio device permissions
- Verify audio file format (WAV files recommended)
- Check audio file permissions
3. **Performance Issues**
- Try using a smaller model (tiny.en or base.en)
- Adjust beam size and patience parameters
- Consider using GPU acceleration if available

View File

@@ -0,0 +1,91 @@
import { SpeechToText, TranscriptionResult, WakeWordEvent } from '../src/speech/speechToText';
import path from 'path';
async function main() {
// Initialize the speech-to-text service
const speech = new SpeechToText('fast-whisper');
// Check if the service is available
const isHealthy = await speech.checkHealth();
if (!isHealthy) {
console.error('Speech service is not available. Make sure Docker is running and the fast-whisper container is up.');
console.error('Run: docker-compose up -d');
process.exit(1);
}
console.log('Speech service is ready!');
console.log('Listening for wake words: "hey jarvis", "ok google", "alexa"');
console.log('Press Ctrl+C to exit');
// Set up event handlers
speech.on('wake_word', (event: WakeWordEvent) => {
console.log('\n🎤 Wake word detected!');
console.log(' Timestamp:', event.timestamp);
console.log(' Audio file:', event.audioFile);
console.log(' Metadata file:', event.metadataFile);
});
speech.on('transcription', (event: { audioFile: string; result: TranscriptionResult }) => {
console.log('\n📝 Transcription result:');
console.log(' Full text:', event.result.text);
console.log('\n Segments:');
event.result.segments.forEach((segment, index) => {
console.log(` ${index + 1}. [${segment.start.toFixed(2)}s - ${segment.end.toFixed(2)}s] (${(segment.confidence * 100).toFixed(1)}% confidence)`);
console.log(` "${segment.text}"`);
});
});
speech.on('progress', (event: { type: string; data: string }) => {
if (event.type === 'stderr' && !event.data.includes('Loading model')) {
console.error('❌ Error:', event.data);
}
});
speech.on('error', (error: Error) => {
console.error('❌ Error:', error.message);
});
// Example of manual transcription
async function transcribeFile(filepath: string) {
try {
console.log(`\n🎯 Manually transcribing: ${filepath}`);
const result = await speech.transcribeAudio(filepath, {
model: 'base.en', // You can change this to tiny.en, small.en, medium.en, or large-v2
language: 'en',
temperature: 0,
beamSize: 5
});
console.log('\n📝 Transcription result:');
console.log(' Text:', result.text);
} catch (error) {
console.error('❌ Transcription failed:', error instanceof Error ? error.message : error);
}
}
// Create audio directory if it doesn't exist
const audioDir = path.join(__dirname, '..', 'audio');
if (!require('fs').existsSync(audioDir)) {
require('fs').mkdirSync(audioDir, { recursive: true });
}
// Start wake word detection
speech.startWakeWordDetection(audioDir);
// Example: You can also manually transcribe files
// Uncomment the following line and replace with your audio file:
// await transcribeFile('/path/to/your/audio.wav');
// Keep the process running
process.on('SIGINT', () => {
console.log('\nStopping speech service...');
speech.stopWakeWordDetection();
process.exit(0);
});
}
// Run the example
main().catch(error => {
console.error('Fatal error:', error);
process.exit(1);
});

View File

@@ -1,85 +0,0 @@
const path = require('path');
module.exports = (request, options) => {
// Handle chalk and related packages
if (request === 'chalk' || request === '#ansi-styles' || request === '#supports-color') {
return path.resolve(__dirname, 'node_modules', request.replace('#', ''));
}
// Handle source files with .js extension
if (request.endsWith('.js')) {
const tsRequest = request.replace(/\.js$/, '.ts');
try {
return options.defaultResolver(tsRequest, {
...options,
packageFilter: pkg => {
if (pkg.type === 'module') {
if (pkg.exports && pkg.exports.import) {
pkg.main = pkg.exports.import;
} else if (pkg.module) {
pkg.main = pkg.module;
}
}
return pkg;
}
});
} catch (e) {
// If the .ts file doesn't exist, try resolving without extension
try {
return options.defaultResolver(request.replace(/\.js$/, ''), options);
} catch (e2) {
// If that fails too, try resolving with .ts extension
try {
return options.defaultResolver(tsRequest, options);
} catch (e3) {
// If all attempts fail, try resolving the original request
return options.defaultResolver(request, options);
}
}
}
}
// Handle @digital-alchemy packages
if (request.startsWith('@digital-alchemy/')) {
try {
const packagePath = path.resolve(__dirname, 'node_modules', request);
return options.defaultResolver(packagePath, {
...options,
packageFilter: pkg => {
if (pkg.type === 'module') {
if (pkg.exports && pkg.exports.import) {
pkg.main = pkg.exports.import;
} else if (pkg.module) {
pkg.main = pkg.module;
}
}
return pkg;
}
});
} catch (e) {
// If resolution fails, continue with default resolver
}
}
// Call the default resolver with enhanced module resolution
return options.defaultResolver(request, {
...options,
// Handle ESM modules
packageFilter: pkg => {
if (pkg.type === 'module') {
if (pkg.exports) {
if (pkg.exports.import) {
pkg.main = pkg.exports.import;
} else if (typeof pkg.exports === 'string') {
pkg.main = pkg.exports;
}
} else if (pkg.module) {
pkg.main = pkg.module;
}
}
return pkg;
},
extensions: ['.ts', '.tsx', '.js', '.jsx', '.json'],
paths: [...(options.paths || []), path.resolve(__dirname, 'src')]
});
};

View File

@@ -1,17 +0,0 @@
/** @type {import('bun:test').BunTestConfig} */
module.exports = {
testEnvironment: 'node',
moduleFileExtensions: ['ts', 'js', 'json', 'node'],
testMatch: ['**/__tests__/**/*.test.ts'],
collectCoverage: true,
coverageDirectory: 'coverage',
coverageThreshold: {
global: {
statements: 50,
branches: 50,
functions: 50,
lines: 50
}
},
setupFilesAfterEnv: ['./jest.setup.ts']
};

View File

@@ -1,87 +0,0 @@
import { jest } from '@jest/globals';
import dotenv from 'dotenv';
import { TextEncoder, TextDecoder } from 'util';
// Load test environment variables
dotenv.config({ path: '.env.test' });
// Set test environment
process.env.NODE_ENV = 'test';
process.env.ENCRYPTION_KEY = 'test-encryption-key-32-bytes-long!!!';
process.env.JWT_SECRET = 'test-jwt-secret';
process.env.HASS_URL = 'http://localhost:8123';
process.env.HASS_TOKEN = 'test-token';
process.env.CLAUDE_API_KEY = 'test_api_key';
process.env.CLAUDE_MODEL = 'test_model';
// Add TextEncoder and TextDecoder to global scope
Object.defineProperty(global, 'TextEncoder', {
value: TextEncoder,
writable: true
});
Object.defineProperty(global, 'TextDecoder', {
value: TextDecoder,
writable: true
});
// Configure console for tests
const originalConsole = { ...console };
global.console = {
...console,
log: jest.fn(),
error: jest.fn(),
warn: jest.fn(),
info: jest.fn(),
debug: jest.fn(),
};
// Increase test timeout
jest.setTimeout(30000);
// Mock WebSocket
jest.mock('ws', () => {
return {
WebSocket: jest.fn().mockImplementation(() => ({
on: jest.fn(),
send: jest.fn(),
close: jest.fn(),
removeAllListeners: jest.fn()
}))
};
});
// Mock chalk
const createChalkMock = () => {
const handler = {
get(target: any, prop: string) {
if (prop === 'default') {
return createChalkMock();
}
return typeof prop === 'string' ? createChalkMock() : target[prop];
},
apply(target: any, thisArg: any, args: any[]) {
return args[0];
}
};
return new Proxy(() => { }, handler);
};
jest.mock('chalk', () => createChalkMock());
// Mock ansi-styles
jest.mock('ansi-styles', () => ({}), { virtual: true });
// Mock supports-color
jest.mock('supports-color', () => ({}), { virtual: true });
// Reset mocks between tests
beforeEach(() => {
jest.clearAllMocks();
});
// Cleanup after tests
afterEach(() => {
jest.clearAllTimers();
jest.clearAllMocks();
});

26
mkdocs.yml Normal file
View File

@@ -0,0 +1,26 @@
site_name: Home Assistant Model Context Protocol (MCP)
site_url: https://yourusername.github.io/your-repo-name/
repo_url: https://github.com/yourusername/your-repo-name
theme:
name: material
features:
- navigation.tabs
- navigation.sections
- toc.integrate
- search.suggest
- search.highlight
markdown_extensions:
- pymdownx.highlight
- pymdownx.superfences
- admonition
- pymdownx.details
nav:
- Home: index.md
- Getting Started:
- Installation: getting-started/installation.md
- Configuration: getting-started/configuration.md
- Usage: usage.md
- Contributing: contributing.md

View File

@@ -1,66 +1,62 @@
{
"name": "homeassistant-mcp",
"version": "0.1.0",
"description": "Model Context Protocol Server for Home Assistant",
"type": "module",
"version": "1.0.0",
"description": "Home Assistant Model Context Protocol",
"main": "dist/index.js",
"type": "module",
"scripts": {
"build": "bun run tsc",
"start": "bun run dist/src/index.js",
"dev": "bun --watch src/index.ts",
"start": "bun run dist/index.js",
"dev": "bun --hot --watch src/index.ts",
"build": "bun build ./src/index.ts --outdir ./dist --target node --minify",
"test": "bun test",
"test:coverage": "bun test --coverage",
"test:watch": "bun test --watch",
"test:openai": "bun run openai_test.ts",
"lint": "eslint src --ext .ts",
"lint:fix": "eslint src --ext .ts --fix",
"prepare": "bun run build",
"clean": "rimraf dist",
"types:check": "tsc --noEmit",
"types:install": "bun add -d @types/node @types/jest"
"test:coverage": "bun test --coverage",
"test:ci": "bun test --coverage --bail",
"test:update": "bun test --update-snapshots",
"test:clear": "bun test --clear-cache",
"test:staged": "bun test --findRelatedTests",
"lint": "eslint . --ext .ts",
"format": "prettier --write \"src/**/*.ts\"",
"prepare": "husky install",
"profile": "bun --inspect src/index.ts",
"clean": "rm -rf dist .bun coverage",
"typecheck": "bun x tsc --noEmit",
"preinstall": "bun install --frozen-lockfile",
"example:speech": "bun run examples/speech-to-text-example.ts"
},
"dependencies": {
"@digital-alchemy/core": "^24.11.4",
"@digital-alchemy/hass": "^24.11.4",
"@types/chalk": "^0.4.31",
"@types/jsonwebtoken": "^9.0.8",
"@types/xmldom": "^0.1.34",
"@xmldom/xmldom": "^0.9.7",
"ajv": "^8.12.0",
"chalk": "^5.4.1",
"dotenv": "^16.3.1",
"express": "^4.18.2",
"express-rate-limit": "^7.1.5",
"@elysiajs/cors": "^1.2.0",
"@elysiajs/swagger": "^1.2.0",
"@types/jsonwebtoken": "^9.0.5",
"@types/node": "^20.11.24",
"@types/sanitize-html": "^2.9.5",
"@types/ws": "^8.5.10",
"dotenv": "^16.4.5",
"elysia": "^1.2.11",
"helmet": "^7.1.0",
"jsonwebtoken": "^9.0.2",
"litemcp": "^0.7.0",
"uuid": "^9.0.1",
"node-fetch": "^3.3.2",
"sanitize-html": "^2.11.0",
"typescript": "^5.3.3",
"winston": "^3.11.0",
"winston-daily-rotate-file": "^5.0.0",
"ws": "^8.16.0",
"zod": "^3.22.4"
},
"devDependencies": {
"@types/ajv": "^1.0.0",
"@types/express": "^4.17.21",
"@types/express-rate-limit": "^6.0.0",
"@types/glob": "^8.1.0",
"@types/helmet": "^4.0.0",
"@types/jest": "^29.5.14",
"@types/node": "^20.17.16",
"@types/supertest": "^6.0.2",
"@types/uuid": "^9.0.8",
"@types/winston": "^2.4.4",
"@types/ws": "^8.5.10",
"jest": "^29.7.0",
"node-fetch": "^3.3.2",
"openai": "^4.82.0",
"rimraf": "^5.0.10",
"supertest": "^6.3.4",
"ts-jest": "^29.1.2",
"tsx": "^4.7.0",
"typescript": "^5.3.3"
"@types/uuid": "^10.0.0",
"@typescript-eslint/eslint-plugin": "^7.1.0",
"@typescript-eslint/parser": "^7.1.0",
"bun-types": "^1.2.2",
"eslint": "^8.57.0",
"eslint-config-prettier": "^9.1.0",
"eslint-plugin-prettier": "^5.1.3",
"husky": "^9.0.11",
"prettier": "^3.2.5",
"supertest": "^6.3.3",
"uuid": "^11.0.5"
},
"author": "Jango Blockchained",
"license": "MIT",
"packageManager": "bun@1.0.26"
"engines": {
"bun": ">=1.0.0"
}
}

View File

@@ -0,0 +1,77 @@
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",
},
},
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()),
},
},
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: {
"switch.tv": {
state: "off",
attributes: {
friendly_name: "TV",
},
},
},
},
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()),
},
};

61
src/__mocks__/litemcp.ts Normal file
View File

@@ -0,0 +1,61 @@
export class LiteMCP {
name: string;
version: string;
config: any;
constructor(config: any = {}) {
this.name = "home-assistant";
this.version = "1.0.0";
this.config = config;
}
async start() {
return Promise.resolve();
}
async stop() {
return Promise.resolve();
}
async connect() {
return Promise.resolve();
}
async disconnect() {
return Promise.resolve();
}
async callService(domain: string, service: string, data: any = {}) {
return Promise.resolve({ success: true });
}
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 setState(entityId: string, state: string, attributes: any = {}) {
return Promise.resolve({ success: true });
}
onStateChanged(callback: (event: any) => void) {
// Mock implementation
}
onEvent(eventType: string, callback: (event: any) => void) {
// Mock implementation
}
}
export const createMCP = (config: any = {}) => {
return new LiteMCP(config);
};

143
src/__tests__/setup.ts Normal file
View File

@@ -0,0 +1,143 @@
import { config } from "dotenv";
import path from "path";
import {
beforeAll,
afterAll,
beforeEach,
describe,
expect,
it,
mock,
test,
} from "bun:test";
// Type definitions for mocks
type MockFn = ReturnType<typeof mock>;
interface MockInstance {
mock: {
calls: unknown[][];
results: unknown[];
instances: unknown[];
lastCall?: unknown[];
};
}
// Test configuration
const TEST_CONFIG = {
TEST_JWT_SECRET: "test_jwt_secret_key_that_is_at_least_32_chars",
TEST_TOKEN: "test_token_that_is_at_least_32_chars_long",
TEST_CLIENT_IP: "127.0.0.1",
};
// Load test environment variables
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;
// Configure console output for tests
if (!process.env.DEBUG) {
console.error = mock(() => { });
console.warn = mock(() => { });
console.log = mock(() => { });
}
});
// Reset mocks between tests
beforeEach(() => {
// Clear all mock function calls
const mockFns = Object.values(mock).filter(
(value): value is MockFn => typeof value === "function" && "mock" in value,
);
mockFns.forEach((mockFn) => {
if (mockFn.mock) {
mockFn.mock.calls = [];
mockFn.mock.results = [];
mockFn.mock.instances = [];
mockFn.mock.lastCall = undefined;
}
});
});
// Custom test utilities
const testUtils = {
// Mock WebSocket for SSE tests
mockWebSocket: () => ({
on: mock(() => { }),
send: mock(() => { }),
close: mock(() => { }),
readyState: 1,
OPEN: 1,
removeAllListeners: mock(() => { }),
}),
// Mock HTTP response for API tests
mockResponse: () => {
const res = {
status: mock(() => res),
json: mock(() => res),
send: mock(() => res),
end: mock(() => res),
setHeader: mock(() => res),
writeHead: mock(() => res),
write: mock(() => true),
removeHeader: mock(() => res),
};
return res;
},
// Mock HTTP request for API tests
mockRequest: (overrides: Record<string, unknown> = {}) => ({
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 = "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 = "test_event", data: unknown = {}) => ({
event_type: type,
data,
origin: "test",
time_fired: new Date().toISOString(),
context: { id: "test" },
}),
// Create test entity for Home Assistant tests
createTestEntity: (entityId = "test.entity", state = "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)),
};
// Export test utilities and Bun test functions
export { beforeAll, afterAll, beforeEach, describe, expect, it, mock, test, testUtils };

View File

@@ -1,204 +1,231 @@
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

View File

@@ -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<string, any>;
confidence: number;
relevant_params: Record<string, any>;
}
interface ContextRule {
condition: (context: AIContext, intent: AIIntent) => boolean;
relevance: number;
params?: (context: AIContext) => Record<string, any>;
condition: (context: AIContext, intent: AIIntent) => boolean;
relevance: number;
params?: (context: AIContext) => Record<string, any>;
}
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<ContextAnalysis> {
let totalConfidence = 0;
let relevantParams: Record<string, any> = {};
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<ContextAnalysis> {
let totalConfidence = 0;
let relevantParams: Record<string, any> = {};
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<void> {
this.contextRules = [...this.contextRules, ...newRules];
}
async validateContext(context: AIContext): Promise<boolean> {
// 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<void> {
this.contextRules = [...this.contextRules, ...newRules];
// Validate previous actions array
if (!Array.isArray(context.previous_actions)) {
return false;
}
async validateContext(context: AIContext): Promise<boolean> {
// 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;
}
return true;
}
}

View File

@@ -1,103 +1,115 @@
import { AIContext } from '../types/index.js';
import { AIContext } from "../types/index.js";
interface ExtractedEntities {
primary_target: string;
parameters: Record<string, any>;
confidence: number;
primary_target: string;
parameters: Record<string, any>;
confidence: number;
}
export class EntityExtractor {
private deviceNameMap: Map<string, string>;
private parameterPatterns: Map<string, RegExp>;
private deviceNameMap: Map<string, string>;
private parameterPatterns: Map<string, RegExp>;
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<ExtractedEntities> {
const entities: ExtractedEntities = {
primary_target: '',
parameters: {},
confidence: 0
};
async extract(input: string): Promise<ExtractedEntities> {
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<string, string>): Promise<void> {
for (const [key, value] of Object.entries(devices)) {
this.deviceNameMap.set(key, value);
}
async updateDeviceMap(devices: Record<string, string>): Promise<void> {
for (const [key, value] of Object.entries(devices)) {
this.deviceNameMap.set(key, value);
}
}
}

View File

@@ -1,177 +1,180 @@
interface ClassifiedIntent {
action: string;
target: string;
confidence: number;
parameters: Record<string, any>;
raw_input: string;
action: string;
target: string;
confidence: number;
parameters: Record<string, any>;
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<string, any>; primary_target: string }
): Promise<ClassifiedIntent> {
let bestMatch: ClassifiedIntent = {
action: '',
target: '',
confidence: 0,
parameters: {},
raw_input: input
};
async classify(
input: string,
extractedEntities: {
parameters: Record<string, any>;
primary_target: string;
},
): Promise<ClassifiedIntent> {
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<string, any>; primary_target: string }
): Record<string, any> {
const parameters: Record<string, any> = {};
// 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<string, any>; 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
};
}
}
// 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<string, any>;
primary_target: string;
},
): Record<string, any> {
const parameters: Record<string, any> = {};
// 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<string, any>;
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,
};
}
}

View File

@@ -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<boolean> {
return (
confidence.overall >= threshold &&
confidence.intent >= threshold &&
confidence.entities >= threshold &&
confidence.context >= threshold
);
}
async suggestCorrections(input: string, error: AIError): Promise<string[]> {
// 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<boolean> {
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<string[]> {
// 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;
}
return suggestions;
}
}

View File

@@ -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<string, any>;
context?: Record<string, any>;
[key: string]: any;
device_name?: string;
location?: string;
action?: string;
parameters?: Record<string, any>;
context?: Record<string, any>;
[key: string]: any;
}
class PromptTemplates {
private templates: Record<AIModel, PromptTemplate>;
private templates: Record<AIModel, PromptTemplate>;
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();

View File

@@ -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<string, any>;
raw_input: string;
action: string;
target: string;
parameters: Record<string, any>;
raw_input: string;
}
// AI Context
export interface AIContext {
user_id: string;
session_id: string;
timestamp: string;
location: string;
previous_actions: AIIntent[];
environment_state: Record<string, any>;
user_id: string;
session_id: string;
timestamp: string;
location: string;
previous_actions: AIIntent[];
environment_state: Record<string, any>;
}
// AI Response
export interface AIResponse {
natural_language: string;
structured_data: {
success: boolean;
action_taken: string;
entities_affected: string[];
state_changes: Record<string, any>;
};
next_suggestions: string[];
confidence: AIConfidence;
context: AIContext;
natural_language: string;
structured_data: {
success: boolean;
action_taken: string;
entities_affected: string[];
state_changes: Record<string, any>;
};
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<AIModel, {
requests_per_minute: number;
requests_per_hour: number;
}>;
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()
}))
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(),
}),
),
});

View File

@@ -1,174 +1,185 @@
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",
});
}
});
/**
@@ -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;

27
src/commands.ts Normal file
View File

@@ -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;

View File

@@ -0,0 +1,162 @@
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),
// 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 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 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(),
},
{
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({
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,
},
},
{
domain: "switch",
service: "turn_off",
data: {
entity_id: "switch.test_switch",
},
},
]),
// 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,
},
]),
});
// 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",
),
};
return testConfigSchema.parse(config);
};
// Export the validated test configuration
export const TEST_CONFIG = parseTestConfig();
// Export types
export type TestConfig = z.infer<typeof testConfigSchema>;

View File

@@ -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,117 @@ 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
},
/** Speech Features Configuration */
SPEECH: z.object({
ENABLED: z.boolean().default(false),
WAKE_WORD_ENABLED: z.boolean().default(false),
SPEECH_TO_TEXT_ENABLED: z.boolean().default(false),
WHISPER_MODEL_PATH: z.string().default("/models"),
WHISPER_MODEL_TYPE: z.string().default("base"),
}).default({
ENABLED: false,
WAKE_WORD_ENABLED: false,
SPEECH_TO_TEXT_ENABLED: false,
WHISPER_MODEL_PATH: "/models",
WHISPER_MODEL_TYPE: "base",
}),
/** 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
},
/** 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
}),
/** 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',
},
/** 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
}),
/** Application Version */
VERSION: '0.1.0'
} as const;
/** 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: z.string().default("0.1.0"),
});
/** Type definition for the configuration object */
export type AppConfig = typeof APP_CONFIG;
export type AppConfig = z.infer<typeof AppConfigSchema>;
/** 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}`);
}
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",
SPEECH: {
ENABLED: process.env.ENABLE_SPEECH_FEATURES === "true",
WAKE_WORD_ENABLED: process.env.ENABLE_WAKE_WORD === "true",
SPEECH_TO_TEXT_ENABLED: process.env.ENABLE_SPEECH_TO_TEXT === "true",
WHISPER_MODEL_PATH: process.env.WHISPER_MODEL_PATH || "/models",
WHISPER_MODEL_TYPE: process.env.WHISPER_MODEL_TYPE || "base",
},
});

View File

@@ -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",
},
},
},
};

View File

@@ -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 || '',
// 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,
},
};

View File

@@ -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
HASS: HASS_CONFIG,
SERVER: SERVER_CONFIG,
AI: AI_CONFIG,
RATE_LIMIT: RATE_LIMIT_CONFIG,
SECURITY: SECURITY_CONFIG,
TEST: TEST_CONFIG,
MOCK: MOCK_CONFIG,
};

View File

@@ -0,0 +1,129 @@
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"),
// 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
// 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(),
// 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"),
// 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",
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"),
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,
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",
MAX_REQUEST_SIZE: parseInt(process.env.MAX_REQUEST_SIZE || "1048576"),
MAX_REQUEST_FIELDS: parseInt(process.env.MAX_REQUEST_FIELDS || "1000"),
};
return securityConfigSchema.parse(config);
};
// Export the validated configuration
export const SECURITY_CONFIG = parseEnvConfig();
// Export types
export type SecurityConfig = z.infer<typeof securityConfigSchema>;

View File

@@ -1,225 +1,238 @@
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<string, any>;
lastUpdated: number;
context?: Record<string, any>;
id: string;
type: ResourceType;
state: any;
attributes: Record<string, any>;
lastUpdated: number;
context?: Record<string, any>;
}
// 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<string, any>;
sourceId: string;
targetId: string;
type: RelationType;
metadata?: Record<string, any>;
}
// Context manager class
export class ContextManager extends EventEmitter {
private resources: Map<string, ResourceState> = new Map();
private relationships: ResourceRelationship[] = [];
private stateHistory: Map<string, ResourceState[]> = new Map();
private historyLimit = 100;
private resources: Map<string, ResourceState> = new Map();
private relationships: ResourceRelationship[] = [];
private stateHistory: Map<string, ResourceState[]> = 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<ResourceState>): 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<ResourceState>): 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<ResourceState>();
const visited = new Set<string>();
// 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<ResourceState>();
const visited = new Set<string>();
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

View File

@@ -1,687 +1,125 @@
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/index.js";
import WebSocket from 'ws';
import { EventEmitter } from 'events';
import * as HomeAssistant from '../types/hass.js';
import { HassEntity, HassEvent, HassService } from '../interfaces/hass.js';
import type { HassEntity } from "../interfaces/hass.js";
type Environments = "development" | "production" | "test";
class HomeAssistantAPI {
private baseUrl: string;
private token: string;
// Define the type for Home Assistant services
type HassServiceMethod = (data: Record<string, unknown>) => Promise<void>;
constructor() {
this.baseUrl = process.env.HASS_HOST || "http://localhost:8123";
this.token = process.env.HASS_TOKEN || "";
type HassServices = {
[K in keyof typeof DomainSchema.Values]: {
[service: string]: HassServiceMethod;
};
};
// Define the type for Home Assistant instance
interface HassInstance {
states: {
get: () => Promise<HassEntity[]>;
subscribe: (callback: (states: HassEntity[]) => void) => Promise<number>;
unsubscribe: (subscription: number) => void;
};
services: {
get: () => Promise<Record<string, Record<string, HassService>>>;
call: (domain: string, service: string, serviceData?: Record<string, any>) => Promise<void>;
};
connection: {
socket: WebSocket;
subscribeEvents: (callback: (event: HassEvent) => void, eventType?: string) => Promise<number>;
unsubscribeEvents: (subscription: number) => void;
};
subscribeEvents: (callback: (event: HassEvent) => void, eventType?: string) => Promise<number>;
unsubscribeEvents: (subscription: number) => void;
}
// Configuration type for application with more specific constraints
type ApplicationConfiguration = {
NODE_ENV: ServiceFunction<Environments>;
};
// 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<ApplicationConfiguration, {}>({
configuration: {
NODE_ENV: {
type: "string",
default: "development",
enum: ["development", "production", "test"],
description: "Code runner addon can set with it's own NODE_ENV",
},
},
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;
}
const CONFIG: Record<string, HassConfig> = {
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<number, (data: any) => void>();
private reconnectAttempts = 0;
private options: {
autoReconnect: boolean;
maxReconnectAttempts: number;
reconnectDelay: number;
};
constructor(
private url: string,
private token: string,
options: Partial<typeof HassWebSocketClient.prototype.options> = {}
) {
super();
this.options = {
autoReconnect: true,
maxReconnectAttempts: 3,
reconnectDelay: 1000,
...options
};
}
async connect(): Promise<void> {
if (this.ws && this.ws.readyState === WebSocket.OPEN) {
return;
if (!this.token || this.token === "your_hass_token_here") {
throw new Error("HASS_TOKEN is required but not set in environment variables");
}
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);
});
});
console.log(`Initializing Home Assistant API with base URL: ${this.baseUrl}`);
}
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<number> {
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<void> {
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;
}
}
}
export class HassInstanceImpl implements HassInstance {
public readonly baseUrl: string;
public readonly token: string;
public wsClient: HassWebSocketClient | undefined;
public readonly services: HassInstance['services'];
public readonly states: HassInstance['states'];
public readonly connection: HassInstance['connection'];
constructor(baseUrl: string, token: string) {
this.baseUrl = baseUrl;
this.token = token;
// Initialize services
this.services = {
get: async () => {
const response = await fetch(`${this.baseUrl}/api/services`, {
headers: {
Authorization: `Bearer ${this.token}`,
'Content-Type': 'application/json',
},
});
if (!response.ok) {
throw new Error(`Failed to fetch services: ${response.statusText}`);
}
return response.json();
},
call: async (domain: string, service: string, serviceData?: Record<string, any>) => {
const response = await fetch(`${this.baseUrl}/api/services/${domain}/${service}`, {
method: 'POST',
headers: {
Authorization: `Bearer ${this.token}`,
'Content-Type': 'application/json',
},
body: JSON.stringify(serviceData),
});
if (!response.ok) {
throw new Error(`Service call failed: ${response.statusText}`);
}
}
};
// Initialize states
this.states = {
get: async () => {
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}`);
}
return response.json();
},
subscribe: async (callback: (states: HassEntity[]) => void) => {
return this.subscribeEvents((event: HassEvent) => {
if (event.event_type === 'state_changed') {
this.states.get().then(callback);
}
}, 'state_changed');
},
unsubscribe: (subscription: number) => {
this.unsubscribeEvents(subscription);
}
};
// Initialize connection
this.connection = {
socket: new WebSocket(this.baseUrl.replace(/^http/, 'ws') + '/api/websocket'),
subscribeEvents: this.subscribeEvents.bind(this),
unsubscribeEvents: this.unsubscribeEvents.bind(this)
};
this.initialize();
}
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;
}>;
private initialize() {
// Initialize all required properties with proper type instantiation
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<any>;
}
async fetchStates(): Promise<HomeAssistant.Entity[]> {
const response = await fetch(`${this.baseUrl}/api/states`, {
private async fetchApi(endpoint: string, options: RequestInit = {}) {
const url = `${this.baseUrl}/api/${endpoint}`;
console.log(`Making request to: ${url}`);
console.log('Request options:', {
method: options.method || 'GET',
headers: {
Authorization: `Bearer ${this.token}`,
'Content-Type': 'application/json',
Authorization: 'Bearer [REDACTED]',
"Content-Type": "application/json",
...options.headers,
},
body: options.body ? JSON.parse(options.body as string) : undefined
});
if (!response.ok) {
throw new Error(`Failed to fetch states: ${response.statusText}`);
}
try {
const response = await fetch(url, {
...options,
headers: {
Authorization: `Bearer ${this.token}`,
"Content-Type": "application/json",
...options.headers,
},
});
const data = await response.json();
return data as HomeAssistant.Entity[];
if (!response.ok) {
const errorText = await response.text();
console.error('Home Assistant API error:', {
status: response.status,
statusText: response.statusText,
error: errorText
});
throw new Error(`Home Assistant API error: ${response.status} ${response.statusText} - ${errorText}`);
}
const data = await response.json();
console.log('Response data:', data);
return data;
} catch (error) {
console.error('Failed to make request:', error);
throw error;
}
}
async fetchState(entityId: string): Promise<HomeAssistant.Entity> {
const response = await fetch(`${this.baseUrl}/api/states/${entityId}`, {
headers: {
Authorization: `Bearer ${this.token}`,
'Content-Type': 'application/json',
},
});
async getStates(): Promise<HassEntity[]> {
return this.fetchApi("states");
}
if (!response.ok) {
throw new Error(`Failed to fetch state: ${response.statusText}`);
}
const data = await response.json();
return data as HomeAssistant.Entity;
async getState(entityId: string): Promise<HassEntity> {
return this.fetchApi(`states/${entityId}`);
}
async callService(domain: string, service: string, data: Record<string, any>): Promise<void> {
const response = await fetch(`${this.baseUrl}/api/services/${domain}/${service}`, {
method: 'POST',
headers: {
Authorization: `Bearer ${this.token}`,
'Content-Type': 'application/json',
},
await this.fetchApi(`services/${domain}/${service}`, {
method: "POST",
body: JSON.stringify(data),
});
if (!response.ok) {
throw new Error(`Service call failed: ${response.statusText}`);
}
}
async subscribeEvents(callback: (event: HassEvent) => void, eventType?: string): Promise<number> {
if (!this.wsClient) {
this.wsClient = new HassWebSocketClient(
this.baseUrl.replace(/^http/, 'ws') + '/api/websocket',
this.token
);
await this.wsClient.connect();
}
return this.wsClient.subscribeEvents((data: any) => {
const hassEvent: HassEvent = {
event_type: data.event_type,
data: data.data,
origin: data.origin,
time_fired: data.time_fired,
context: {
id: data.context.id,
parent_id: data.context.parent_id,
user_id: data.context.user_id
}
};
callback(hassEvent);
}, eventType);
}
async unsubscribeEvents(subscriptionId: number): Promise<void> {
if (this.wsClient) {
await this.wsClient.unsubscribeEvents(subscriptionId);
}
}
}
class HomeAssistantInstance implements HassInstance {
private messageId = 1;
private messageCallbacks = new Map<number, (result: any) => void>();
private eventCallbacks = new Map<number, (event: HassEvent) => void>();
private stateCallbacks = new Map<number, (states: HassEntity[]) => void>();
private _authenticated = false;
private socket: WebSocket;
private readonly _states: HassInstance['states'];
private readonly _services: HassInstance['services'];
private readonly _connection: HassInstance['connection'];
let instance: HomeAssistantAPI | null = null;
constructor() {
if (!HASS_CONFIG.TOKEN) {
throw new Error('Home Assistant token is required');
}
this.socket = new WebSocket(HASS_CONFIG.SOCKET_URL);
this._states = {
get: async (): Promise<HassEntity[]> => {
const message = {
type: 'get_states'
};
return this.sendMessage(message);
},
subscribe: async (callback: (states: HassEntity[]) => void): Promise<number> => {
const id = this.messageId++;
this.stateCallbacks.set(id, callback);
const message = {
type: 'subscribe_events',
event_type: 'state_changed'
};
await this.sendMessage(message);
return id;
},
unsubscribe: (subscription: number): void => {
this.stateCallbacks.delete(subscription);
}
};
this._services = {
get: async (): Promise<Record<string, Record<string, HassService>>> => {
const message = {
type: 'get_services'
};
return this.sendMessage(message);
},
call: async (domain: string, service: string, serviceData?: Record<string, any>): Promise<void> => {
const message = {
type: 'call_service',
domain,
service,
service_data: serviceData
};
await this.sendMessage(message);
}
};
this._connection = {
socket: this.socket,
subscribeEvents: this.subscribeEvents.bind(this),
unsubscribeEvents: this.unsubscribeEvents.bind(this)
};
this.setupWebSocket();
}
get authenticated(): boolean {
return this._authenticated;
}
get states(): HassInstance['states'] {
return this._states;
}
get services(): HassInstance['services'] {
return this._services;
}
get connection(): HassInstance['connection'] {
return this._connection;
}
private setupWebSocket() {
this.socket.on('open', () => {
this.authenticate();
});
this.socket.on('message', (data: WebSocket.Data) => {
if (typeof data === 'string') {
const message = JSON.parse(data);
this.handleMessage(message);
}
});
this.socket.on('close', () => {
console.log('WebSocket connection closed');
// Implement reconnection logic here
});
this.socket.on('error', (error) => {
console.error('WebSocket error:', error);
});
}
private authenticate() {
const auth = {
type: 'auth',
access_token: HASS_CONFIG.TOKEN
};
this.socket.send(JSON.stringify(auth));
}
private handleMessage(message: any) {
if (message.type === 'auth_ok') {
this._authenticated = true;
console.log('Authenticated with Home Assistant');
return;
}
if (message.type === 'auth_invalid') {
console.error('Authentication failed:', message.message);
return;
}
if (message.type === 'event') {
const callback = this.eventCallbacks.get(message.id);
if (callback) {
callback(message.event);
}
return;
}
if (message.type === 'result') {
const callback = this.messageCallbacks.get(message.id);
if (callback) {
callback(message.result);
this.messageCallbacks.delete(message.id);
}
return;
export async function get_hass() {
if (!instance) {
try {
instance = new HomeAssistantAPI();
// Verify connection by trying to get states
await instance.getStates();
console.log('Successfully connected to Home Assistant');
} catch (error) {
console.error('Failed to initialize Home Assistant connection:', error);
instance = null;
throw error;
}
}
private async sendMessage(message: any): Promise<any> {
if (!this._authenticated) {
throw new Error('Not authenticated with Home Assistant');
}
return new Promise((resolve, reject) => {
const id = this.messageId++;
message.id = id;
this.messageCallbacks.set(id, resolve);
this.socket.send(JSON.stringify(message));
// Add timeout
setTimeout(() => {
this.messageCallbacks.delete(id);
reject(new Error('Message timeout'));
}, 10000);
});
}
public async subscribeEvents(callback: (event: HassEvent) => void, eventType?: string): Promise<number> {
const id = this.messageId++;
this.eventCallbacks.set(id, callback);
const message = {
type: 'subscribe_events',
event_type: eventType
};
await this.sendMessage(message);
return id;
}
public unsubscribeEvents(subscription: number): void {
this.eventCallbacks.delete(subscription);
}
return instance;
}
let hassInstance: HomeAssistantInstance | null = null;
export async function get_hass(): Promise<HassInstance> {
if (!hassInstance) {
hassInstance = new HomeAssistantInstance();
// Wait for authentication
await new Promise<void>((resolve) => {
const checkAuth = () => {
if (hassInstance?.authenticated) {
resolve();
} else {
setTimeout(checkAuth, 100);
}
};
checkAuth();
});
}
return hassInstance;
// Helper function to call Home Assistant services
export async function call_service(
domain: string,
service: string,
data: Record<string, any>,
) {
const hass = await get_hass();
return hass.callService(domain, service, data);
}
// Helper function to list devices
export async function list_devices() {
const hass = await get_hass();
const states = await hass.getStates();
return states.map((state: HassEntity) => ({
entity_id: state.entity_id,
state: state.state,
attributes: state.attributes
}));
}
// Helper function to get entity states
export async function get_states() {
const hass = await get_hass();
return hass.getStates();
}
// Helper function to get a specific entity state
export async function get_state(entity_id: string) {
const hass = await get_hass();
return hass.getState(entity_id);
}

View File

@@ -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();

View File

@@ -1,73 +1,169 @@
/**
* Home Assistant MCP (Master Control Program)
* Main application entry point
*
* This file initializes the Express server and sets up necessary
* middleware and routes for the application when not in Claude mode.
*
* @module index
*/
import "./polyfills.js";
import { config } from "dotenv";
import { resolve } from "path";
import { Elysia } from "elysia";
import { cors } from "@elysiajs/cors";
import { swagger } from "@elysiajs/swagger";
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";
import { speechService } from "./speech/index.js";
import { APP_CONFIG } from "./config/app.config.js";
import express from 'express';
import { APP_CONFIG } from './config/app.config.js';
import { apiRoutes } from './routes/index.js';
import { securityHeaders, rateLimiter, validateRequest, sanitizeInput, errorHandler } from './security/index.js';
import { requestLogger, errorLogger } from './middleware/logging.middleware.js';
import { get_hass } from './hass/index.js';
import { LiteMCP } from 'litemcp';
import { logger } from './utils/logger.js';
import { initLogRotation } from './utils/log-rotation.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";
logger.info('Starting Home Assistant MCP...');
logger.info('Initializing Home Assistant connection...');
console.log(`Loading environment from ${envFile}`);
config({ path: resolve(process.cwd(), envFile) });
// Initialize log rotation
initLogRotation();
// Configuration
const HASS_TOKEN = process.env.HASS_TOKEN;
const PORT = parseInt(process.env.PORT || "4000", 10);
/**
* Initialize LiteMCP instance
* This provides the core MCP functionality
*/
const server = new LiteMCP('home-assistant', APP_CONFIG.VERSION);
console.log("Initializing Home Assistant connection...");
// Only start Express server when not in Claude mode
if (process.env.PROCESSOR_TYPE !== 'claude') {
/**
* Initialize Express application with security middleware
* and route handlers
*/
const app = express();
// Apply logging middleware first to catch all requests
app.use(requestLogger);
// Apply security middleware
app.use(securityHeaders);
app.use(rateLimiter);
app.use(express.json());
app.use(validateRequest);
app.use(sanitizeInput);
/**
* Mount API routes under /api
* All API endpoints are prefixed with /api
*/
app.use('/api', apiRoutes);
/**
* Apply error handling middleware
* This should be the last middleware in the chain
*/
app.use(errorLogger);
app.use(errorHandler);
/**
* Start the server and listen for incoming connections
* The port is configured in the environment variables
*/
app.listen(APP_CONFIG.PORT, () => {
logger.info(`Server is running on port ${APP_CONFIG.PORT}`);
});
} else {
logger.info('Running in Claude mode - Express server disabled');
// Define Tool interface
interface Tool {
name: string;
description: string;
parameters: z.ZodType<any>;
execute: (params: any) => Promise<any>;
}
// Array to store tools
const tools: Tool[] = [];
// 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:
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);
// Initialize Elysia app with middleware
const app = new Elysia()
.use(cors())
.use(swagger())
.use(rateLimiter)
.use(securityHeaders)
.use(validateRequest)
.use(sanitizeInput)
.use(errorHandler);
// Health check endpoint
app.get("/health", () => ({
status: "ok",
timestamp: new Date().toISOString(),
version: "0.1.0",
speech_enabled: APP_CONFIG.SPEECH.ENABLED,
wake_word_enabled: APP_CONFIG.SPEECH.WAKE_WORD_ENABLED,
speech_to_text_enabled: APP_CONFIG.SPEECH.SPEECH_TO_TEXT_ENABLED,
}));
// Initialize speech service if enabled
if (APP_CONFIG.SPEECH.ENABLED) {
console.log("Initializing speech service...");
speechService.initialize().catch((error) => {
console.error("Failed to initialize speech service:", error);
});
}
// Create API endpoints for each tool
tools.forEach((tool) => {
app.post(`/api/tools/${tool.name}`, async ({ body }: { body: Record<string, unknown> }) => {
const result = await tool.execute(body);
return result;
});
});
// Start the server
app.listen(PORT, () => {
console.log(`Server is running on port ${PORT}`);
});
// Handle server shutdown
process.on("SIGTERM", async () => {
console.log("Received SIGTERM. Shutting down gracefully...");
if (APP_CONFIG.SPEECH.ENABLED) {
await speechService.shutdown().catch((error) => {
console.error("Error shutting down speech service:", error);
});
}
process.exit(0);
});

View File

@@ -2,79 +2,92 @@
// Home Assistant entity types
export interface HassEntity {
entity_id: string;
state: string;
attributes: Record<string, any>;
last_changed?: string;
last_updated?: string;
context?: {
id: string;
parent_id?: string;
user_id?: string;
};
entity_id: string;
state: string;
attributes: Record<string, any>;
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<number>;
unsubscribeEvents: (subscription: number) => void;
states: HassStates;
services: HassServices;
connection: HassConnection;
subscribeEvents: (
callback: (event: HassEvent) => void,
eventType?: string,
) => Promise<number>;
unsubscribeEvents: (subscription: number) => void;
}
export interface HassStates {
get: () => Promise<HassEntity[]>;
subscribe: (callback: (states: HassEntity[]) => void) => Promise<number>;
unsubscribe: (subscription: number) => void;
get: () => Promise<HassEntity[]>;
subscribe: (callback: (states: HassEntity[]) => void) => Promise<number>;
unsubscribe: (subscription: number) => void;
}
export interface HassServices {
get: () => Promise<Record<string, Record<string, HassService>>>;
call: (domain: string, service: string, serviceData?: Record<string, any>) => Promise<void>;
get: () => Promise<Record<string, Record<string, HassService>>>;
call: (
domain: string,
service: string,
serviceData?: Record<string, any>,
) => Promise<void>;
}
export interface HassConnection {
socket: WebSocket;
subscribeEvents: (callback: (event: HassEvent) => void, eventType?: string) => Promise<number>;
unsubscribeEvents: (subscription: number) => void;
socket: WebSocket;
subscribeEvents: (
callback: (event: HassEvent) => void,
eventType?: string,
) => Promise<number>;
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<string, {
name: string;
description: string;
required?: boolean;
example?: any;
selector?: any;
}>;
};
fields: Record<
string,
{
name: string;
description: string;
required?: boolean;
example?: any;
selector?: any;
}
>;
}
export interface HassEvent {
event_type: string;
data: Record<string, any>;
origin: string;
time_fired: string;
context: {
id: string;
parent_id?: string;
user_id?: string;
};
event_type: string;
data: Record<string, any>;
origin: string;
time_fired: string;
context: {
id: string;
parent_id?: string;
user_id?: string;
};
}

View File

@@ -1,170 +1,183 @@
import { z } from 'zod';
import { z } from "zod";
// Tool interfaces
export interface Tool {
name: string;
description: string;
parameters: z.ZodType<any>;
execute: (params: any) => Promise<any>;
name: string;
description: string;
parameters: z.ZodType<any>;
execute: (params: any) => Promise<any>;
}
// 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<string, any>;
[key: string]: any;
};
status: string;
options: Record<string, any>;
[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<string, any>;
message: string;
title?: string;
target?: string;
data?: Record<string, any>;
}
// 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[];
};
action: "create" | "update" | "delete" | "duplicate";
automation_id?: string;
config?: {
alias: string;
description?: string;
mode?: "single" | "parallel" | "queued" | "restart";
trigger: any[];
condition?: any[];
action: any[];
};
}

67
src/mcp/litemcp.ts Normal file
View File

@@ -0,0 +1,67 @@
import { EventEmitter } from "events";
export class LiteMCP extends EventEmitter {
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 configure(config: Record<string, any>): void {
// Store configuration
this.config = {
...this.defaultConfig,
...config,
};
}
private config: Record<string, any> = {};
private defaultConfig = {
maxRetries: 3,
retryDelay: 1000,
timeout: 5000,
};
public async execute(
command: string,
params: Record<string, any> = {},
): Promise<any> {
try {
// Emit command execution event
this.emit("command", { command, params });
// Execute command logic here
const result = await this.processCommand(command, params);
// 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<string, any>,
): Promise<any> {
// Command processing logic
return { command, params, status: "processed" };
}
public async shutdown(): Promise<void> {
// Cleanup logic
this.removeAllListeners();
}
}

View File

@@ -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"
}
]
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",
},
],
};

View File

@@ -0,0 +1,203 @@
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";
describe("Security Middleware", () => {
let mockRequest: Partial<Request>;
let mockResponse: Partial<Response>;
let nextFunction: jest.Mock;
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();
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();
});
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),
});
});
});
describe("Input Sanitization", () => {
it("should sanitize HTML in request body", () => {
mockRequest.body = {
text: 'Test <script>alert("xss")</script>',
nested: {
html: '<img src="x" onerror="alert(1)">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 handle non-object bodies", () => {
mockRequest.body = "<p>text</p>";
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("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),
});
});
});
});

View File

@@ -1,139 +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 { 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
// Rate limiter middleware with enhanced configuration
export const rateLimiter = rateLimit({
windowMs: 60 * 1000, // 1 minute
max: RATE_LIMIT_CONFIG.REGULAR,
message: {
success: false,
message: 'Too many requests, please try again later.',
reset_time: new Date(Date.now() + 60 * 1000).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
// WebSocket rate limiter middleware with enhanced configuration
export const wsRateLimiter = rateLimit({
windowMs: 60 * 1000, // 1 minute
max: RATE_LIMIT_CONFIG.WEBSOCKET,
message: {
success: false,
message: 'Too many WebSocket connections, please try again later.',
reset_time: new Date(Date.now() + 60 * 1000).toISOString()
}
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",
});
// Security headers middleware
export const securityHeaders = (_req: Request, res: Response, next: NextFunction) => {
res.setHeader('X-Content-Type-Options', 'nosniff');
res.setHeader('X-Frame-Options', 'DENY');
res.setHeader('X-XSS-Protection', '1; mode=block');
res.setHeader('Strict-Transport-Security', 'max-age=31536000; includeSubDomains');
next();
};
// Request validation middleware
export const validateRequest = (req: Request, res: Response, next: NextFunction) => {
// Validate content type for POST/PUT/PATCH requests
if (['POST', 'PUT', 'PATCH'].includes(req.method) && !req.is('application/json')) {
return res.status(415).json({
success: false,
message: 'Content-Type must be application/json'
});
}
// Validate request body size
const contentLength = parseInt(req.headers['content-length'] || '0', 10);
if (contentLength > 1024 * 1024) { // 1MB limit
return res.status(413).json({
success: false,
message: 'Request body too large'
});
}
next();
};
// Input sanitization middleware
export const sanitizeInput = (req: Request, _res: Response, next: NextFunction) => {
if (req.body) {
// Recursively sanitize object
const sanitizeObject = (obj: any): any => {
if (typeof obj !== 'object' || obj === null) {
return obj;
}
if (Array.isArray(obj)) {
return obj.map(item => sanitizeObject(item));
}
const sanitized: any = {};
for (const [key, value] of Object.entries(obj)) {
// Remove any potentially dangerous characters from keys
const sanitizedKey = key.replace(/[<>]/g, '');
sanitized[sanitizedKey] = sanitizeObject(value);
}
return sanitized;
};
req.body = sanitizeObject(req.body);
}
next();
};
// Authentication middleware
export const authenticate = (req: Request, res: Response, next: NextFunction) => {
const token = req.headers.authorization?.replace('Bearer ', '');
if (!token || token !== HASS_CONFIG.TOKEN) {
return res.status(401).json({
success: false,
message: 'Unauthorized - Invalid token'
});
}
next();
};
// Error handling middleware
export const errorHandler = (err: Error, _req: Request, res: Response, _next: NextFunction) => {
console.error('Error:', err);
// Handle specific error types
if (err.name === 'ValidationError') {
return res.status(400).json({
success: false,
message: 'Validation error',
details: err.message
});
}
if (err.name === 'UnauthorizedError') {
return res.status(401).json({
success: false,
message: 'Unauthorized',
details: err.message
});
}
// Default error response
res.status(500).json({
success: false,
message: 'Internal server error',
details: process.env.NODE_ENV === 'development' ? err.message : undefined
// 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(),
});
}
const token = authHeader.replace("Bearer ", "");
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 || "Invalid token",
timestamp: new Date().toISOString(),
});
}
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'"],
},
},
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");
// 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",
);
}
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();
}
// 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 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();
};
/**
* 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\b[^<]*(?:(?!<\/script>)<[^<]*)*<\/script>/gi,
"",
);
// Remove style tags and their content
sanitized = sanitized.replace(
/<style\b[^<]*(?:(?!<\/style>)<[^<]*)*<\/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<string, unknown> = {};
Object.entries(value as Record<string, unknown>).forEach(
([key, val]) => {
result[key] = sanitizeValue(val);
},
);
return result;
}
return value;
};
req.body = sanitizeValue(req.body) as Record<string, unknown>;
}
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<string, unknown> = {
success: false,
message: "Internal Server Error",
timestamp: new Date().toISOString(),
};
if (isDevelopment) {
response.error = err.message;
response.stack = err.stack;
}
return res.status(500).json(response);
};
// Export all middleware
export const middleware = {
rateLimiter,
wsRateLimiter,
securityHeaders,
validateRequest,
sanitizeInput,
authenticate,
errorHandler
rateLimiter,
wsRateLimiter,
securityHeaders,
validateRequest,
sanitizeInput,
authenticate,
errorHandler,
};

View File

@@ -7,15 +7,15 @@
* @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);
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);
};

View File

@@ -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<void> {
await this.checkPermissions();
await this.registerSystemEvents();
}
async checkPermissions(): Promise<MacOSPermissions> {
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<void> {
if (!this.permissions.notifications) {
throw new Error("Notification permission not granted");
}
async initialize(): Promise<void> {
await this.checkPermissions();
await this.registerSystemEvents();
}
async checkPermissions(): Promise<MacOSPermissions> {
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<void> {
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<void> {
if (!this.permissions.automation) {
throw new Error("Automation permission not granted");
}
async registerSystemEvents(): Promise<void> {
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<string> {
if (!this.permissions.automation) {
throw new Error("Automation permission not granted");
}
async executeAutomation(script: string): Promise<string> {
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<Record<string, any>> {
const info: Record<string, any> = {};
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<string, any> {
const info: Record<string, any> = {};
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<Record<string, any>> {
const info: Record<string, any> = {};
return info;
}
try {
// Get macOS version
const { stdout: version } = await execAsync('sw_vers -productVersion');
info.os_version = version.trim();
private parsePowerInfo(output: string): Record<string, any> {
const info: Record<string, any> = {};
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<string, any> {
const info: Record<string, any> = {};
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<string, any> {
const info: Record<string, any> = {};
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<string, any> {
const info: Record<string, any> = {};
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<string, any> {
const info: Record<string, any> = {};
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;

9
src/polyfills.js Normal file
View File

@@ -0,0 +1,9 @@
// Add necessary polyfills for Node.js compatibility in Bun
import { webcrypto } from 'node:crypto';
// Polyfill for crypto.subtle in Bun
if (!globalThis.crypto?.subtle) {
globalThis.crypto = webcrypto;
}
// Add any other necessary polyfills here

View File

@@ -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 };

View File

@@ -8,11 +8,11 @@
* @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,10 +27,10 @@ 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

View File

@@ -7,10 +7,10 @@
* @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,8 +28,8 @@ 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);
});
/**
@@ -44,38 +44,39 @@ 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",
});
}
});
/**

View File

@@ -1,99 +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 { 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', (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 and validate
const token = req.query.token?.toString() || "";
const clientIp = req.ip || req.socket.remoteAddress || "";
const validationResult = TokenManager.validateToken(token, clientIp);
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 (!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 { router as sseRoutes };
export default router;

View File

@@ -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 };

View File

@@ -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),
cameras: z.array(CameraSchema),
});

View File

@@ -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<Record<string, any>> | null;
[key: string]: any;
condition: string;
conditions?: Array<Record<string, any>> | null;
[key: string]: any;
};
type ActionType = {
service: string;
target?: {
entity_id?: string | string[] | null;
[key: string]: any;
} | null;
data?: Record<string, any> | null;
service: string;
target?: {
entity_id?: string | string[] | null;
[key: string]: any;
} | null;
data?: Record<string, any> | 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<string, any> | null;
domain:
| "light"
| "switch"
| "climate"
| "cover"
| "fan"
| "scene"
| "script"
| "media_player";
command: string;
entity_id: string | string[];
parameters?: Record<string, any> | null;
};
// Define missing types
export interface Service {
name: string;
description: string;
target?: {
entity?: string[];
device?: string[];
area?: string[];
} | null;
fields: Record<string, any>;
name: string;
description: string;
target?: {
entity?: string[];
device?: string[];
area?: string[];
} | null;
fields: Record<string, any>;
}
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<DeviceControlType> = {
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
version: { type: "string" },
},
required: [
"components",
"config_dir",
"elevation",
"latitude",
"longitude",
"location_name",
"time_zone",
"unit_system",
"version",
],
additionalProperties: false,
} as const;

View File

@@ -0,0 +1,184 @@
import { describe, expect, it, beforeEach } from "bun:test";
import { TokenManager } from "../index";
import jwt from "jsonwebtoken";
const validSecret = "test_secret_that_is_at_least_32_chars_long";
const testIp = "127.0.0.1";
// Mock the rate limit window for faster tests
const MOCK_RATE_LIMIT_WINDOW = 100; // 100ms instead of 15 minutes
describe("Security Module", () => {
beforeEach(() => {
process.env.JWT_SECRET = validSecret;
// Reset failed attempts map
(TokenManager as any).failedAttempts = new Map();
// Mock the security config
(TokenManager as any).SECURITY_CONFIG = {
...(TokenManager as any).SECURITY_CONFIG,
LOCKOUT_DURATION: MOCK_RATE_LIMIT_WINDOW,
MAX_FAILED_ATTEMPTS: 5,
MAX_TOKEN_AGE: 30 * 24 * 60 * 60 * 1000 // 30 days
};
});
describe("TokenManager", () => {
it("should encrypt and decrypt tokens", () => {
const originalToken = "test-token";
const encryptedToken = TokenManager.encryptToken(originalToken, validSecret);
expect(encryptedToken).toBeDefined();
expect(encryptedToken.includes(originalToken)).toBe(false);
const decryptedToken = TokenManager.decryptToken(encryptedToken, validSecret);
expect(decryptedToken).toBeDefined();
expect(decryptedToken).toBe(originalToken);
});
it("should validate tokens correctly", () => {
const payload = { userId: "123", role: "user" };
const token = jwt.sign(payload, validSecret, { expiresIn: "1h" });
const result = TokenManager.validateToken(token, testIp);
expect(result.valid).toBe(true);
expect(result.error).toBeUndefined();
// Verify payload separately
const decoded = jwt.verify(token, validSecret) as typeof payload;
expect(decoded.userId).toBe(payload.userId);
expect(decoded.role).toBe(payload.role);
});
it("should handle empty tokens", () => {
const result = TokenManager.validateToken("", testIp);
expect(result.valid).toBe(false);
expect(result.error).toBe("Invalid token format");
});
it("should handle expired tokens", () => {
const now = Math.floor(Date.now() / 1000);
const payload = {
userId: "123",
role: "user",
iat: now - 3600, // issued 1 hour ago
exp: now - 1800 // expired 30 minutes 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 handle token tampering", () => {
// Use a different IP for this test to avoid rate limiting
const uniqueIp = "192.168.1.1";
const payload = { userId: "123", role: "user" };
const token = jwt.sign(payload, validSecret);
const tamperedToken = token.slice(0, -5) + "xxxxx"; // Tamper with signature
const result = TokenManager.validateToken(tamperedToken, uniqueIp);
expect(result.valid).toBe(false);
expect(result.error).toBe("Invalid token signature");
});
});
describe("Token Encryption", () => {
it("should use different IVs for same token", () => {
const token = "test-token";
const encrypted1 = TokenManager.encryptToken(token, validSecret);
const encrypted2 = TokenManager.encryptToken(token, validSecret);
expect(encrypted1).toBeDefined();
expect(encrypted2).toBeDefined();
expect(encrypted1 === encrypted2).toBe(false);
});
it("should handle large tokens", () => {
const largeToken = "x".repeat(1024);
const encrypted = TokenManager.encryptToken(largeToken, validSecret);
const decrypted = TokenManager.decryptToken(encrypted, validSecret);
expect(decrypted).toBe(largeToken);
});
it("should fail gracefully with invalid encrypted data", () => {
expect(() => TokenManager.decryptToken("invalid-encrypted-data", validSecret))
.toThrow("Invalid encrypted token");
});
});
describe("Rate Limiting", () => {
beforeEach(() => {
// Reset failed attempts before each test
(TokenManager as any).failedAttempts = new Map();
});
it("should track failed attempts by IP", () => {
const invalidToken = "x".repeat(64);
const ip1 = "1.1.1.1";
const ip2 = "2.2.2.2";
// Make a single failed attempt for each IP
TokenManager.validateToken(invalidToken, ip1);
TokenManager.validateToken(invalidToken, ip2);
const attempts = (TokenManager as any).failedAttempts;
expect(attempts.has(ip1)).toBe(true);
expect(attempts.has(ip2)).toBe(true);
expect(attempts.get(ip1).count).toBe(1);
expect(attempts.get(ip2).count).toBe(1);
expect(attempts.get(ip1).lastAttempt).toBeGreaterThan(0);
expect(attempts.get(ip2).lastAttempt).toBeGreaterThan(0);
});
it("should handle rate limiting for failed attempts", async () => {
const invalidToken = "x".repeat(64);
const uniqueIp = "10.0.0.1";
// Make multiple failed attempts
for (let i = 0; i < 5; i++) {
const result = TokenManager.validateToken(invalidToken, uniqueIp);
expect(result.valid).toBe(false);
if (i < 4) {
expect(result.error).toBe("Invalid token signature");
} else {
expect(result.error).toBe("Too many failed attempts. Please try again later.");
}
}
// Next attempt should be rate limited
const result = TokenManager.validateToken(invalidToken, uniqueIp);
expect(result.valid).toBe(false);
expect(result.error).toBe("Too many failed attempts. Please try again later.");
// Wait for rate limit window to expire
await new Promise(resolve => setTimeout(resolve, MOCK_RATE_LIMIT_WINDOW + 50));
// After window expires, should get normal error again
const finalResult = TokenManager.validateToken(invalidToken, uniqueIp);
expect(finalResult.valid).toBe(false);
expect(finalResult.error).toBe("Invalid token signature");
});
it("should reset rate limits after window expires", async () => {
const invalidToken = "x".repeat(64);
const uniqueIp = "172.16.0.1";
// Make some failed attempts
for (let i = 0; i < 3; i++) {
const result = TokenManager.validateToken(invalidToken, uniqueIp);
expect(result.valid).toBe(false);
expect(result.error).toBe("Invalid token signature");
}
// Wait for rate limit window to expire
await new Promise(resolve => setTimeout(resolve, MOCK_RATE_LIMIT_WINDOW + 50));
// After window expires, should get normal error
const result = TokenManager.validateToken(invalidToken, uniqueIp);
expect(result.valid).toBe(false);
expect(result.error).toBe("Invalid token signature");
// Should have one new attempt recorded
const attempts = (TokenManager as any).failedAttempts;
expect(attempts.has(uniqueIp)).toBe(true);
expect(attempts.get(uniqueIp).count).toBe(1);
});
});
});

View File

@@ -1,33 +1,64 @@
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 helmet from "helmet";
import { HelmetOptions } from "helmet";
import jwt from "jsonwebtoken";
import { Elysia, type Context } from "elysia";
// Security configuration
const RATE_LIMIT_WINDOW = 15 * 60 * 1000; // 15 minutes
const RATE_LIMIT_MAX = 100; // requests per window
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'
// Rate limiting state
const rateLimitStore = new Map<string, { count: number; resetTime: number }>();
interface RequestContext {
request: Request;
set: Context['set'];
}
// Extracted rate limiting logic
export function checkRateLimit(ip: string, maxRequests: number = RATE_LIMIT_MAX, windowMs: number = RATE_LIMIT_WINDOW) {
const now = Date.now();
const record = rateLimitStore.get(ip) || {
count: 0,
resetTime: now + windowMs,
};
if (now > record.resetTime) {
record.count = 0;
record.resetTime = now + windowMs;
}
record.count++;
rateLimitStore.set(ip, record);
if (record.count > maxRequests) {
throw new Error("Too many requests from this IP, please try again later");
}
return true;
}
// Rate limiting middleware for Elysia
export const rateLimiter = new Elysia().derive(({ request }: RequestContext) => {
const ip = request.headers.get("x-forwarded-for") || "unknown";
checkRateLimit(ip);
});
// Security configuration
const helmetConfig: HelmetOptions = {
// Extracted security headers logic
export function applySecurityHeaders(request: Request, helmetConfig?: HelmetOptions) {
const config: HelmetOptions = helmetConfig || {
contentSecurityPolicy: {
useDefaults: true,
directives: {
defaultSrc: ["'self'"],
scriptSrc: ["'self'", "'unsafe-inline'"],
styleSrc: ["'self'", "'unsafe-inline'"],
imgSrc: ["'self'", 'data:', 'https:'],
connectSrc: ["'self'", 'wss:', 'https:']
}
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,
@@ -36,185 +67,355 @@ const helmetConfig: HelmetOptions = {
ieNoOpen: true,
noSniff: true,
referrerPolicy: {
policy: ['no-referrer', 'strict-origin-when-cross-origin']
policy: ["no-referrer", "strict-origin-when-cross-origin"],
},
};
const headers = helmet(config);
// Apply helmet headers to the request
Object.entries(headers).forEach(([key, value]) => {
if (typeof value === 'string') {
request.headers.set(key, value);
}
};
});
// Security headers middleware
export const securityHeaders = helmet(helmetConfig);
return headers;
}
const ALGORITHM = 'aes-256-gcm';
// Security headers middleware for Elysia
export const securityHeaders = new Elysia().derive(({ request }: RequestContext) => {
applySecurityHeaders(request);
});
// Extracted request validation logic
export function validateRequestHeaders(request: Request, requiredContentType = 'application/json') {
// Validate content type for POST/PUT/PATCH requests
if (["POST", "PUT", "PATCH"].includes(request.method)) {
const contentType = request.headers.get("content-type");
if (!contentType?.includes(requiredContentType)) {
throw new Error(`Content-Type must be ${requiredContentType}`);
}
}
// Validate request size
const contentLength = request.headers.get("content-length");
if (contentLength && parseInt(contentLength) > 1024 * 1024) {
throw new Error("Request body too large");
}
// Validate authorization header if required
const authHeader = request.headers.get("authorization");
if (authHeader) {
const [type, token] = authHeader.split(" ");
if (type !== "Bearer" || !token) {
throw new Error("Invalid authorization header");
}
const ip = request.headers.get("x-forwarded-for");
const validation = TokenManager.validateToken(token, ip || undefined);
if (!validation.valid) {
throw new Error(validation.error || "Invalid token");
}
}
return true;
}
// Request validation middleware for Elysia
export const validateRequest = new Elysia().derive(({ request }: RequestContext) => {
validateRequestHeaders(request);
});
// Extracted input sanitization logic
export function sanitizeValue(value: unknown): unknown {
if (typeof value === "string") {
// Basic XSS protection
return value
.replace(/</g, "&lt;")
.replace(/>/g, "&gt;")
.replace(/"/g, "&quot;")
.replace(/'/g, "&#x27;")
.replace(/\//g, "&#x2F;");
}
if (Array.isArray(value)) {
return value.map(sanitizeValue);
}
if (typeof value === "object" && value !== null) {
return Object.fromEntries(
Object.entries(value).map(([k, v]) => [k, sanitizeValue(v)])
);
}
return value;
}
// Input sanitization middleware for Elysia
export const sanitizeInput = new Elysia().derive(async ({ request }: RequestContext) => {
if (["POST", "PUT", "PATCH"].includes(request.method)) {
const body = await request.json();
request.json = () => Promise.resolve(sanitizeValue(body));
}
});
// Extracted error handling logic
export function handleError(error: Error, env: string = process.env.NODE_ENV || 'production') {
console.error("Error:", error);
const baseResponse = {
error: true,
message: "Internal server error",
timestamp: new Date().toISOString(),
};
if (env === 'development') {
return {
...baseResponse,
error: error.message,
stack: error.stack,
};
}
return baseResponse;
}
// Error handling middleware for Elysia
export const errorHandler = new Elysia().onError(({ error, set }: { error: Error; set: Context['set'] }) => {
set.status = error instanceof jwt.JsonWebTokenError ? 401 : 500;
return handleError(error);
});
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
};
// Track failed authentication attempts
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
*/
static validateToken(token: string): boolean {
if (!token || typeof token !== 'string') {
return false;
}
try {
const [algorithm, ivBase64, tagBase64, encryptedBase64] =
encryptedToken.split(":");
try {
const decoded = jwt.decode(token);
if (!decoded || typeof decoded !== 'object') {
return false;
}
if (
algorithm !== ALGORITHM ||
!ivBase64 ||
!tagBase64 ||
!encryptedBase64
) {
throw new Error("Invalid encrypted token format");
}
// Check for expiration
if (!decoded.exp) {
return false;
}
const iv = Buffer.from(ivBase64, "base64");
const tag = Buffer.from(tagBase64, "base64");
const encrypted = Buffer.from(encryptedBase64, "base64");
const now = Math.floor(Date.now() / 1000);
if (decoded.exp <= now) {
return false;
}
const decipher = crypto.createDecipheriv(ALGORITHM, key.slice(0, 32), iv);
decipher.setAuthTag(tag);
// Verify signature using the secret from environment variable
const secret = process.env.JWT_SECRET;
if (!secret) {
return false;
}
try {
jwt.verify(token, secret);
return true;
} catch {
return false;
}
} catch {
return false;
}
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");
}
}
}
// Request validation middleware
export function validateRequest(req: Request, res: Response, next: NextFunction) {
// Skip validation for health and MCP schema endpoints
if (req.path === '/health' || req.path === '/mcp') {
return next();
/**
* 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" };
}
// Validate content type
if (req.method !== 'GET' && !req.is('application/json')) {
return res.status(415).json({
error: 'Unsupported Media Type - Content-Type must be application/json'
});
// 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" };
}
// Validate token
const token = req.headers.authorization?.replace('Bearer ', '');
if (!token || !TokenManager.validateToken(token)) {
return res.status(401).json({
error: 'Invalid or expired token'
});
// Check for rate limiting
if (ip && this.isRateLimited(ip)) {
return {
valid: false,
error: "Too many failed attempts. Please try again later.",
};
}
// Validate request body
if (req.method !== 'GET' && (!req.body || typeof req.body !== 'object')) {
return res.status(400).json({
error: 'Invalid request body'
});
// Get JWT secret
const secret = process.env.JWT_SECRET;
if (!secret) {
return { valid: false, error: "JWT secret not configured" };
}
next();
}
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;
// Input sanitization middleware
export function sanitizeInput(req: Request, res: Response, next: NextFunction) {
if (req.body && typeof req.body === 'object') {
const sanitized = JSON.parse(
JSON.stringify(req.body).replace(/[<>]/g, '')
);
req.body = sanitized;
// 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" };
}
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
/**
* 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, any>): 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",
});
}
}
// Export security middleware chain
export const securityMiddleware = [
helmet(helmetConfig),
rateLimit({
windowMs: 15 * 60 * 1000,
max: 100
}),
validateRequest,
sanitizeInput,
errorHandler
];

View File

@@ -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<string | false | null, [type: string | string[]]>;
headers: {
"content-type"?: string;
authorization?: string;
};
body?: any;
is: jest.MockInstance<string | false | null, [type: string | string[]]>;
};
type MockResponse = {
status: jest.MockInstance<MockResponse, [code: number]>;
json: jest.MockInstance<MockResponse, [body: any]>;
setHeader: jest.MockInstance<MockResponse, [name: string, value: string]>;
status: jest.MockInstance<MockResponse, [code: number]>;
json: jest.MockInstance<MockResponse, [body: any]>;
setHeader: jest.MockInstance<MockResponse, [name: string, value: string]>;
};
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<string | false | null, [string | string[]]>().mockReturnValue('json')
};
beforeEach(() => {
mockRequest = {
headers: {},
body: {},
is: jest
.fn<string | false | null, [string | string[]]>()
.mockReturnValue("json"),
};
mockResponse = {
status: jest.fn<MockResponse, [number]>().mockReturnThis(),
json: jest.fn<MockResponse, [any]>().mockReturnThis(),
setHeader: jest.fn<MockResponse, [string, string]>().mockReturnThis()
};
mockResponse = {
status: jest.fn<MockResponse, [number]>().mockReturnThis(),
json: jest.fn<MockResponse, [any]>().mockReturnThis(),
setHeader: jest.fn<MockResponse, [string, string]>().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: '<script>alert("xss")</script>Hello',
nested: {
html: '<img src="x" onerror="alert(1)">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 = '<p>text</p>';
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"),
}),
);
});
});
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: '<script>alert("xss")</script>Hello',
nested: {
html: '<img src="x" onerror="alert(1)">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 = "<p>text</p>";
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();
});
});
});

View File

View File

@@ -0,0 +1,116 @@
import { SpeechToText, WakeWordEvent, TranscriptionError } from '../speechToText';
import fs from 'fs';
import path from 'path';
describe('SpeechToText', () => {
let speechToText: SpeechToText;
const testAudioDir = path.join(__dirname, 'test_audio');
beforeEach(() => {
speechToText = new SpeechToText('fast-whisper');
// Create test audio directory if it doesn't exist
if (!fs.existsSync(testAudioDir)) {
fs.mkdirSync(testAudioDir, { recursive: true });
}
});
afterEach(() => {
speechToText.stopWakeWordDetection();
// Clean up test files
if (fs.existsSync(testAudioDir)) {
fs.rmSync(testAudioDir, { recursive: true, force: true });
}
});
describe('checkHealth', () => {
it('should handle Docker not being available', async () => {
const isHealthy = await speechToText.checkHealth();
expect(isHealthy).toBeDefined();
expect(isHealthy).toBe(false);
});
});
describe('wake word detection', () => {
it('should detect new audio files and emit wake word events', (done) => {
const testFile = path.join(testAudioDir, 'wake_word_test_123456.wav');
const testMetadata = `${testFile}.json`;
speechToText.startWakeWordDetection(testAudioDir);
speechToText.on('wake_word', (event: WakeWordEvent) => {
expect(event).toBeDefined();
expect(event.audioFile).toBe(testFile);
expect(event.metadataFile).toBe(testMetadata);
expect(event.timestamp).toBe('123456');
done();
});
// Create a test audio file to trigger the event
fs.writeFileSync(testFile, 'test audio content');
}, 1000);
it('should handle transcription errors when Docker is not available', (done) => {
const testFile = path.join(testAudioDir, 'wake_word_test_123456.wav');
let errorEmitted = false;
let wakeWordEmitted = false;
const checkDone = () => {
if (errorEmitted && wakeWordEmitted) {
done();
}
};
speechToText.on('error', (error) => {
expect(error).toBeDefined();
expect(error).toBeInstanceOf(TranscriptionError);
expect(error.message).toContain('Failed to start Docker process');
errorEmitted = true;
checkDone();
});
speechToText.on('wake_word', () => {
wakeWordEmitted = true;
checkDone();
});
speechToText.startWakeWordDetection(testAudioDir);
// Create a test audio file to trigger the event
fs.writeFileSync(testFile, 'test audio content');
}, 1000);
});
describe('transcribeAudio', () => {
it('should handle Docker not being available for transcription', async () => {
await expect(
speechToText.transcribeAudio('/audio/test.wav')
).rejects.toThrow(TranscriptionError);
});
it('should emit progress events on error', (done) => {
let progressEmitted = false;
let errorThrown = false;
const checkDone = () => {
if (progressEmitted && errorThrown) {
done();
}
};
speechToText.on('progress', (event: { type: string; data: string }) => {
expect(event.type).toBe('stderr');
expect(event.data).toBe('Failed to start Docker process');
progressEmitted = true;
checkDone();
});
speechToText.transcribeAudio('/audio/test.wav')
.catch((error) => {
expect(error).toBeInstanceOf(TranscriptionError);
errorThrown = true;
checkDone();
});
}, 1000);
});
});

110
src/speech/index.ts Normal file
View File

@@ -0,0 +1,110 @@
import { APP_CONFIG } from "../config/app.config.js";
import { logger } from "../utils/logger.js";
import type { IWakeWordDetector, ISpeechToText } from "./types.js";
class SpeechService {
private static instance: SpeechService | null = null;
private isInitialized: boolean = false;
private wakeWordDetector: IWakeWordDetector | null = null;
private speechToText: ISpeechToText | null = null;
private constructor() { }
public static getInstance(): SpeechService {
if (!SpeechService.instance) {
SpeechService.instance = new SpeechService();
}
return SpeechService.instance;
}
public async initialize(): Promise<void> {
if (this.isInitialized) {
return;
}
if (!APP_CONFIG.SPEECH.ENABLED) {
logger.info("Speech features are disabled. Skipping initialization.");
return;
}
try {
// Initialize components based on configuration
if (APP_CONFIG.SPEECH.WAKE_WORD_ENABLED) {
logger.info("Initializing wake word detection...");
// Dynamic import to avoid loading the module if not needed
const { WakeWordDetector } = await import("./wakeWordDetector.js");
this.wakeWordDetector = new WakeWordDetector() as IWakeWordDetector;
await this.wakeWordDetector.initialize();
}
if (APP_CONFIG.SPEECH.SPEECH_TO_TEXT_ENABLED) {
logger.info("Initializing speech-to-text...");
// Dynamic import to avoid loading the module if not needed
const { SpeechToText } = await import("./speechToText.js");
this.speechToText = new SpeechToText({
modelPath: APP_CONFIG.SPEECH.WHISPER_MODEL_PATH,
modelType: APP_CONFIG.SPEECH.WHISPER_MODEL_TYPE,
}) as ISpeechToText;
await this.speechToText.initialize();
}
this.isInitialized = true;
logger.info("Speech service initialized successfully");
} catch (error) {
logger.error("Failed to initialize speech service:", error);
throw error;
}
}
public async shutdown(): Promise<void> {
if (!this.isInitialized) {
return;
}
try {
if (this.wakeWordDetector) {
await this.wakeWordDetector.shutdown();
this.wakeWordDetector = null;
}
if (this.speechToText) {
await this.speechToText.shutdown();
this.speechToText = null;
}
this.isInitialized = false;
logger.info("Speech service shut down successfully");
} catch (error) {
logger.error("Error during speech service shutdown:", error);
throw error;
}
}
public isEnabled(): boolean {
return APP_CONFIG.SPEECH.ENABLED;
}
public isWakeWordEnabled(): boolean {
return APP_CONFIG.SPEECH.WAKE_WORD_ENABLED;
}
public isSpeechToTextEnabled(): boolean {
return APP_CONFIG.SPEECH.SPEECH_TO_TEXT_ENABLED;
}
public getWakeWordDetector(): IWakeWordDetector {
if (!this.isInitialized || !this.wakeWordDetector) {
throw new Error("Wake word detector is not initialized");
}
return this.wakeWordDetector;
}
public getSpeechToText(): ISpeechToText {
if (!this.isInitialized || !this.speechToText) {
throw new Error("Speech-to-text is not initialized");
}
return this.speechToText;
}
}
export const speechService = SpeechService.getInstance();

247
src/speech/speechToText.ts Normal file
View File

@@ -0,0 +1,247 @@
import { spawn } from 'child_process';
import { EventEmitter } from 'events';
import { watch } from 'fs';
import path from 'path';
import { ISpeechToText, SpeechToTextConfig } from "./types.js";
export interface TranscriptionOptions {
model?: 'tiny.en' | 'base.en' | 'small.en' | 'medium.en' | 'large-v2';
language?: string;
temperature?: number;
beamSize?: number;
patience?: number;
device?: 'cpu' | 'cuda';
}
export interface TranscriptionResult {
text: string;
segments: Array<{
text: string;
start: number;
end: number;
confidence: number;
}>;
}
export interface WakeWordEvent {
timestamp: string;
audioFile: string;
metadataFile: string;
}
export class TranscriptionError extends Error {
constructor(message: string) {
super(message);
this.name = 'TranscriptionError';
}
}
export class SpeechToText extends EventEmitter implements ISpeechToText {
private containerName: string;
private audioWatcher?: ReturnType<typeof watch>;
private modelPath: string;
private modelType: string;
private isInitialized: boolean = false;
constructor(config: SpeechToTextConfig) {
super();
this.containerName = config.containerName || 'fast-whisper';
this.modelPath = config.modelPath;
this.modelType = config.modelType;
}
public async initialize(): Promise<void> {
if (this.isInitialized) {
return;
}
try {
// Initialization logic will be implemented here
await this.setupContainer();
this.isInitialized = true;
this.emit('ready');
} catch (error) {
this.emit('error', error);
throw error;
}
}
public async shutdown(): Promise<void> {
if (!this.isInitialized) {
return;
}
try {
// Cleanup logic will be implemented here
await this.cleanupContainer();
this.isInitialized = false;
this.emit('shutdown');
} catch (error) {
this.emit('error', error);
throw error;
}
}
public async transcribe(audioData: Buffer): Promise<string> {
if (!this.isInitialized) {
throw new Error("Speech-to-text service is not initialized");
}
try {
// Transcription logic will be implemented here
this.emit('transcribing');
const result = await this.processAudio(audioData);
this.emit('transcribed', result);
return result;
} catch (error) {
this.emit('error', error);
throw error;
}
}
private async setupContainer(): Promise<void> {
// Container setup logic will be implemented here
await new Promise(resolve => setTimeout(resolve, 100)); // Placeholder
}
private async cleanupContainer(): Promise<void> {
// Container cleanup logic will be implemented here
await new Promise(resolve => setTimeout(resolve, 100)); // Placeholder
}
private async processAudio(audioData: Buffer): Promise<string> {
// Audio processing logic will be implemented here
await new Promise(resolve => setTimeout(resolve, 100)); // Placeholder
return "Transcription placeholder";
}
startWakeWordDetection(audioDir: string = './audio'): void {
// Watch for new audio files from wake word detection
this.audioWatcher = watch(audioDir, (eventType, filename) => {
if (eventType === 'rename' && filename && filename.startsWith('wake_word_') && filename.endsWith('.wav')) {
const audioFile = path.join(audioDir, filename);
const metadataFile = `${audioFile}.json`;
const parts = filename.split('_');
const timestamp = parts[parts.length - 1].split('.')[0];
// Emit wake word event
this.emit('wake_word', {
timestamp,
audioFile,
metadataFile
} as WakeWordEvent);
// Automatically transcribe the wake word audio
this.transcribeAudio(audioFile)
.then(result => {
this.emit('transcription', { audioFile, result });
})
.catch(error => {
this.emit('error', error);
});
}
});
}
stopWakeWordDetection(): void {
if (this.audioWatcher) {
this.audioWatcher.close();
this.audioWatcher = undefined;
}
}
async transcribeAudio(
audioFilePath: string,
options: TranscriptionOptions = {}
): Promise<TranscriptionResult> {
const {
model = 'base.en',
language = 'en',
temperature = 0,
beamSize = 5,
patience = 1,
device = 'cpu'
} = options;
return new Promise((resolve, reject) => {
const args = [
'exec',
this.containerName,
'fast-whisper',
'--model', model,
'--language', language,
'--temperature', temperature.toString(),
'--beam-size', beamSize.toString(),
'--patience', patience.toString(),
'--device', device,
'--output-json',
audioFilePath
];
let process;
try {
process = spawn('docker', args);
} catch (error) {
this.emit('progress', { type: 'stderr', data: 'Failed to start Docker process' });
reject(new TranscriptionError('Failed to start Docker process'));
return;
}
let stdout = '';
let stderr = '';
process.stdout?.on('data', (data: Buffer) => {
stdout += data.toString();
this.emit('progress', { type: 'stdout', data: data.toString() });
});
process.stderr?.on('data', (data: Buffer) => {
stderr += data.toString();
this.emit('progress', { type: 'stderr', data: data.toString() });
});
process.on('error', (error: Error) => {
this.emit('progress', { type: 'stderr', data: error.message });
reject(new TranscriptionError(`Failed to execute Docker command: ${error.message}`));
});
process.on('close', (code: number) => {
if (code !== 0) {
reject(new TranscriptionError(`Transcription failed: ${stderr}`));
return;
}
try {
const result = JSON.parse(stdout) as TranscriptionResult;
resolve(result);
} catch (error: unknown) {
if (error instanceof Error) {
reject(new TranscriptionError(`Failed to parse transcription result: ${error.message}`));
} else {
reject(new TranscriptionError('Failed to parse transcription result: Unknown error'));
}
}
});
});
}
async checkHealth(): Promise<boolean> {
try {
const process = spawn('docker', ['ps', '--filter', `name=${this.containerName}`, '--format', '{{.Status}}']);
return new Promise((resolve) => {
let output = '';
process.stdout?.on('data', (data: Buffer) => {
output += data.toString();
});
process.on('error', () => {
resolve(false);
});
process.on('close', (code: number) => {
resolve(code === 0 && output.toLowerCase().includes('up'));
});
});
} catch (error) {
return false;
}
}
}

20
src/speech/types.ts Normal file
View File

@@ -0,0 +1,20 @@
import { EventEmitter } from "events";
export interface IWakeWordDetector {
initialize(): Promise<void>;
shutdown(): Promise<void>;
startListening(): Promise<void>;
stopListening(): Promise<void>;
}
export interface ISpeechToText extends EventEmitter {
initialize(): Promise<void>;
shutdown(): Promise<void>;
transcribe(audioData: Buffer): Promise<string>;
}
export interface SpeechToTextConfig {
modelPath: string;
modelType: string;
containerName?: string;
}

View File

@@ -0,0 +1,64 @@
import { IWakeWordDetector } from "./types.js";
export class WakeWordDetector implements IWakeWordDetector {
private isListening: boolean = false;
private isInitialized: boolean = false;
public async initialize(): Promise<void> {
if (this.isInitialized) {
return;
}
// Initialization logic will be implemented here
await this.setupDetector();
this.isInitialized = true;
}
public async shutdown(): Promise<void> {
if (this.isListening) {
await this.stopListening();
}
if (this.isInitialized) {
await this.cleanupDetector();
this.isInitialized = false;
}
}
public async startListening(): Promise<void> {
if (!this.isInitialized) {
throw new Error("Wake word detector is not initialized");
}
if (this.isListening) {
return;
}
await this.startDetection();
this.isListening = true;
}
public async stopListening(): Promise<void> {
if (!this.isListening) {
return;
}
await this.stopDetection();
this.isListening = false;
}
private async setupDetector(): Promise<void> {
// Setup logic will be implemented here
await new Promise(resolve => setTimeout(resolve, 100)); // Placeholder
}
private async cleanupDetector(): Promise<void> {
// Cleanup logic will be implemented here
await new Promise(resolve => setTimeout(resolve, 100)); // Placeholder
}
private async startDetection(): Promise<void> {
// Start detection logic will be implemented here
await new Promise(resolve => setTimeout(resolve, 100)); // Placeholder
}
private async stopDetection(): Promise<void> {
// Stop detection logic will be implemented here
await new Promise(resolve => setTimeout(resolve, 100)); // Placeholder
}
}

View File

@@ -0,0 +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";
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;
});
afterEach(() => {
validateTokenMock.mockReset();
});
function createTestClient(
id: string,
): Omit<SSEClient, "authenticated" | "subscriptions" | "rateLimit"> {
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);
});
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();
});
});
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(1);
expect(stats.authenticatedClients).toBe(1);
});
it("should remove disconnected clients", () => {
const client = createTestClient("test-client");
sseManager.addClient(client, validToken);
sseManager.removeClient("test-client");
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);
});
});
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);
});
});
});

View File

@@ -1,390 +1,387 @@
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;
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
};
interface RateLimit {
count: number;
lastReset: number;
count: number;
lastReset: number;
burstCount: number;
lastBurstReset: number;
}
export interface SSEClient {
id: string;
send: (data: string) => void;
subscriptions: {
entities: Set<string>;
events: Set<string>;
domains: Set<string>;
};
authenticated: boolean;
rateLimit: RateLimit;
lastPing: number;
connectionTime: number;
id: string;
ip: string;
connectedAt: Date;
lastPingAt?: Date;
subscriptions: Set<string>;
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;
}
export class SSEManager extends EventEmitter {
private clients: Map<string, SSEClient> = new Map();
private static instance: SSEManager | null = null;
private entityStates: Map<string, HassEntity> = new Map();
private clients: Map<string, SSEClient> = new Map();
private static instance: SSEManager | null = null;
private entityStates: Map<string, HassEntity> = 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;
// Configuration
private readonly MAX_CLIENTS = 100;
private readonly RATE_LIMIT_WINDOW = 60000; // 1 minute
private readonly RATE_LIMIT_MAX_REQUESTS = 1000;
private readonly CLIENT_TIMEOUT = 300000; // 5 minutes
private readonly PING_INTERVAL = 30000; // 30 seconds
constructor(
options: {
maxClients?: number;
pingInterval?: number;
cleanupInterval?: number;
maxConnectionAge?: number;
rateLimit?: Partial<typeof DEFAULT_RATE_LIMIT>;
} = {},
) {
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 };
private constructor() {
super();
console.log('Initializing SSE Manager...');
this.startMaintenanceInterval();
}
console.log("Initializing SSE Manager...");
this.startMaintenanceTasks();
}
private startMaintenanceInterval() {
setInterval(() => {
this.performMaintenance();
}, 60000); // Run every minute
}
private performMaintenance() {
const now = Date.now();
// Check each client for timeouts and rate limits
for (const [clientId, client] of this.clients.entries()) {
// Remove inactive clients
if (now - client.lastPing > this.CLIENT_TIMEOUT) {
console.log(`Removing inactive client: ${clientId}`);
this.removeClient(clientId);
continue;
}
// Reset rate limits if window has passed
if (now - client.rateLimit.lastReset > this.RATE_LIMIT_WINDOW) {
client.rateLimit.count = 0;
client.rateLimit.lastReset = now;
}
}
// Log statistics
console.log(`Maintenance complete - Active clients: ${this.clients.size}`);
}
static getInstance(): SSEManager {
if (!SSEManager.instance) {
SSEManager.instance = new SSEManager();
}
return SSEManager.instance;
}
addClient(client: { id: string; send: (data: string) => void }, token?: string): SSEClient | null {
// Check maximum client limit
if (this.clients.size >= this.MAX_CLIENTS) {
console.warn('Maximum client limit reached, rejecting new connection');
return null;
}
const now = Date.now();
const sseClient: SSEClient = {
id: client.id,
send: client.send,
subscriptions: {
entities: new Set<string>(),
events: new Set<string>(),
domains: new Set<string>()
},
authenticated: this.validateToken(token),
rateLimit: {
count: 0,
lastReset: now
},
lastPing: now,
connectionTime: now
};
this.clients.set(client.id, sseClient);
console.log(`SSE client connected: ${client.id} (authenticated: ${sseClient.authenticated})`);
// Start ping interval for this client
this.startClientPing(client.id);
// Send initial connection success message
this.sendToClient(sseClient, {
type: 'connection',
status: 'connected',
id: client.id,
authenticated: sseClient.authenticated,
timestamp: new Date().toISOString()
});
return sseClient;
}
private startClientPing(clientId: string) {
const interval = setInterval(() => {
const client = this.clients.get(clientId);
if (!client) {
clearInterval(interval);
return;
}
this.sendToClient(client, {
type: 'ping',
timestamp: new Date().toISOString()
});
}, this.PING_INTERVAL);
}
removeClient(clientId: string) {
if (this.clients.has(clientId)) {
this.clients.delete(clientId);
console.log(`SSE client disconnected: ${clientId}`);
}
}
subscribeToEntity(clientId: string, entityId: string) {
const client = this.clients.get(clientId);
if (client?.authenticated) {
client.subscriptions.entities.add(entityId);
console.log(`Client ${clientId} subscribed to entity: ${entityId}`);
// Send current state if available
const currentState = this.entityStates.get(entityId);
if (currentState) {
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) {
const client = this.clients.get(clientId);
if (client?.authenticated) {
client.subscriptions.domains.add(domain);
console.log(`Client ${clientId} subscribed to domain: ${domain}`);
}
}
subscribeToEvent(clientId: string, eventType: string) {
const client = this.clients.get(clientId);
if (client?.authenticated) {
client.subscriptions.events.add(eventType);
console.log(`Client ${clientId} subscribed to event: ${eventType}`);
}
}
broadcastStateChange(entity: HassEntity) {
// 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
for (const client of this.clients.values()) {
if (!client.authenticated) continue;
if (
client.subscriptions.entities.has(entity.entity_id) ||
client.subscriptions.domains.has(domain) ||
client.subscriptions.events.has('state_changed')
) {
this.sendToClient(client, message);
}
}
}
broadcastEvent(event: HassEvent) {
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
for (const client of this.clients.values()) {
if (!client.authenticated) continue;
if (client.subscriptions.events.has(event.event_type)) {
this.sendToClient(client, message);
}
}
}
private sendToClient(client: SSEClient, data: any) {
try {
// Check rate limit
const now = Date.now();
if (now - client.rateLimit.lastReset > this.RATE_LIMIT_WINDOW) {
client.rateLimit.count = 0;
client.rateLimit.lastReset = now;
}
if (client.rateLimit.count >= this.RATE_LIMIT_MAX_REQUESTS) {
console.warn(`Rate limit exceeded for client ${client.id}`);
this.sendToClient(client, {
type: 'error',
error: 'rate_limit_exceeded',
message: 'Too many requests, please try again later',
timestamp: new Date().toISOString()
});
return;
}
client.rateLimit.count++;
client.lastPing = now;
client.send(JSON.stringify(data));
} catch (error) {
console.error(`Error sending 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);
private validateToken(token?: string): boolean {
if (!token) return false;
return TokenManager.validateToken(token);
}
// 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;
// Utility methods
getConnectedClients(): number {
return this.clients.size;
}
getClientSubscriptions(clientId: string) {
return this.clients.get(clientId)?.subscriptions;
}
getEntityState(entityId: string): HassEntity | undefined {
return this.entityStates.get(entityId);
}
// Add new event types
broadcastServiceCall(domain: string, service: string, data: any) {
const message = {
type: 'service_called',
data: {
domain,
service,
service_data: data
},
timestamp: new Date().toISOString()
};
this.broadcastToSubscribers('service_called', message);
}
broadcastAutomationTriggered(automationId: string, trigger: any) {
const message = {
type: 'automation_triggered',
data: {
automation_id: automationId,
trigger
},
timestamp: new Date().toISOString()
};
this.broadcastToSubscribers('automation_triggered', message);
}
broadcastScriptExecuted(scriptId: string, data: any) {
const message = {
type: 'script_executed',
data: {
script_id: scriptId,
execution_data: data
},
timestamp: new Date().toISOString()
};
this.broadcastToSubscribers('script_executed', message);
}
private broadcastToSubscribers(eventType: string, message: any) {
for (const client of this.clients.values()) {
if (!client.authenticated) continue;
if (client.subscriptions.events.has(eventType)) {
this.sendToClient(client, message);
}
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<SSEClient, "authenticated" | "subscriptions" | "rateLimit">,
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;
}
// Add statistics methods
getStatistics() {
const now = Date.now();
const stats = {
total_clients: this.clients.size,
authenticated_clients: 0,
total_subscriptions: 0,
clients_by_connection_time: {
less_than_1m: 0,
less_than_5m: 0,
less_than_1h: 0,
more_than_1h: 0
},
total_entities_tracked: this.entityStates.size,
subscriptions: {
entities: new Set<string>(),
events: new Set<string>(),
domains: new Set<string>()
}
};
for (const client of this.clients.values()) {
if (client.authenticated) stats.authenticated_clients++;
// Count subscriptions
stats.total_subscriptions +=
client.subscriptions.entities.size +
client.subscriptions.events.size +
client.subscriptions.domains.size;
// Add to subscription sets
client.subscriptions.entities.forEach(entity => stats.subscriptions.entities.add(entity));
client.subscriptions.events.forEach(event => stats.subscriptions.events.add(event));
client.subscriptions.domains.forEach(domain => stats.subscriptions.domains.add(domain));
// Calculate connection duration
const connectionDuration = now - client.connectionTime;
if (connectionDuration < 60000) stats.clients_by_connection_time.less_than_1m++;
else if (connectionDuration < 300000) stats.clients_by_connection_time.less_than_5m++;
else if (connectionDuration < 3600000) stats.clients_by_connection_time.less_than_1h++;
else stats.clients_by_connection_time.more_than_1h++;
}
// Convert Sets to Arrays for JSON serialization
return {
...stats,
subscriptions: {
entities: Array.from(stats.subscriptions.entities),
events: Array.from(stats.subscriptions.events),
domains: Array.from(stats.subscriptions.domains)
}
};
// 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();

67
src/sse/types.ts Normal file
View File

@@ -0,0 +1,67 @@
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;
}
export interface HassEventData {
[key: string]: unknown;
}
export interface SSEEvent {
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;
}
export interface SSEManagerConfig {
maxClients?: number;
pingInterval?: number;
cleanupInterval?: number;
maxConnectionAge?: number;
rateLimitWindow?: number;
maxRequestsPerWindow?: number;
}
export type MockSendFn = (data: string) => void;
export type MockSend = Mock<MockSendFn>;
export type ValidateTokenFn = (
token: string,
ip?: string,
) => { valid: boolean; error?: string };
export type MockValidateToken = Mock<ValidateTokenFn>;
// Type guard for mock functions
export function isMockFunction(value: unknown): value is Mock<unknown> {
return typeof value === "function" && "mock" in value;
}
// Safe type assertion for mock objects
export function asMockFunction<T extends (...args: any[]) => any>(
value: unknown,
): Mock<T> {
if (!isMockFunction(value)) {
throw new Error("Value is not a mock function");
}
return value as Mock<T>;
}

View File

@@ -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<string, any> = {};
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}`);
}
},
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<string, any> = {};
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",
};
}
},
};

View File

@@ -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,
};
}
},
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",
};
}
},
};

View File

@@ -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}`,
);
}
},
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",
};
}
},
};

View File

@@ -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<string, any> = {
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<string, any> = {
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",
};
}
},
};

View File

@@ -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',
};
}
},
const history = await response.json();
return {
success: true,
history,
};
} catch (error) {
return {
success: false,
message:
error instanceof Error ? error.message : "Unknown error occurred",
};
}
},
};

View File

@@ -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
listDevicesTool,
controlTool,
historyTool,
sceneTool,
notifyTool,
automationTool,
addonTool,
packageTool,
automationConfigTool,
subscribeEventsTool,
getSSEStatsTool,
};

Some files were not shown because too many files have changed in this diff Show More