@ajclarkson/homerun 0.0.1-edge.0131fc6

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Adam Clarkson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,276 @@
+# Homerun
+
+**Typed, testable Home Assistant automations in TypeScript.**
+
+> **Status: early development.** The framework is not yet published to npm and the API is not stable. This README documents the intended design; some parts are still being built.
+
+Homerun is a framework that replaces HA automations and Node-RED flows with pure functions. Every automation is a context builder and a reducer — no side effects, no hidden state, no YAML. The pipeline handles observability, error isolation, and action execution.
+
+---
+
+## The problem
+
+Home Assistant automations are YAML. Node-RED flows are JSON blobs. Both are hard to test, hard to review, and impossible to type-check. A bad deploy silently breaks your lights at 2am.
+
+Homerun brings the same discipline you'd apply to application code: pure functions, typed inputs, and a test suite that runs in milliseconds.
+
+---
+
+## How it works
+
+Every automation follows the same pipeline:
+
+```
+Event → context() → reduce() → actions[]
+```
+
+**`context()`** reads from the HA state cache and returns a typed snapshot — or aborts early if the guard condition isn't met. It is the only place that touches external state.
+
+**`reduce()`** is a pure function. It receives the context and returns a decision with a list of declarative actions. No async, no side effects, no HA calls.
+
+**The pipeline** handles everything else: correlation IDs, observability snapshots, error isolation, and action execution.
+
+---
+
+## Example
+
+```typescript
+import { defineAutomation, abort } from './src/types/automation.js';
+
+export const kitchenLights = defineAutomation({
+  id: 'kitchen:lighting',
+  location: 'kitchen',
+  subsystem: 'lighting',
+
+  triggers: [
+    { type: 'state_changed', entity: 'binary_sensor.kitchen_motion' },
+    { type: 'state_changed', entity: 'binary_sensor.kitchen_door' },
+    { type: 'on_start' },
+  ],
+
+  context(state, ha) {
+    const enabled = state('input_boolean.kitchen_automation_lights_enabled');
+    if (enabled?.state !== 'on') return abort('automation_disabled');
+
+    return {
+      motion: state('binary_sensor.kitchen_motion')?.state === 'on',
+      lux: Number(state('sensor.kitchen_sensor_lux')?.state ?? 0),
+      luxThreshold: Number(state('input_number.kitchen_automation_lux_threshold_dark')?.state ?? 40),
+    };
+  },
+
+  reduce(ctx) {
+    const shouldLight = ctx.motion && ctx.lux < ctx.luxThreshold;
+
+    return {
+      decision: shouldLight ? 'lights_on' : 'lights_off',
+      inputs: ctx,
+      actions: [
+        {
+          type: 'ha.call_service',
+          domain: 'light',
+          service: shouldLight ? 'turn_on' : 'turn_off',
+          target: { entity_id: 'light.kitchen_light_ceiling' },
+        },
+      ],
+    };
+  },
+});
+```
+
+---
+
+## Testing
+
+Because `reduce()` is a pure function, tests are just function calls:
+
+```typescript
+import { describe, it, expect } from 'vitest';
+import { kitchenLights } from './kitchen-lights';
+
+describe('kitchenLights reducer', () => {
+  it('turns lights on when motion is detected below lux threshold', () => {
+    const result = kitchenLights.reduce({ motion: true, lux: 20, luxThreshold: 40 });
+    expect(result.decision).toBe('lights_on');
+    expect(result.actions[0]).toMatchObject({ service: 'turn_on' });
+  });
+
+  it('turns lights off when lux is already high', () => {
+    const result = kitchenLights.reduce({ motion: true, lux: 80, luxThreshold: 40 });
+    expect(result.decision).toBe('lights_off');
+  });
+
+  it('turns lights off when motion clears', () => {
+    const result = kitchenLights.reduce({ motion: false, lux: 10, luxThreshold: 40 });
+    expect(result.decision).toBe('lights_off');
+  });
+});
+```
+
+No mocking, no HA connection, no async. The context builder can be tested separately with a plain function as the state accessor:
+
+```typescript
+const mockState = (entity: string) => ({
+  'input_boolean.kitchen_automation_lights_enabled': { state: 'on' },
+  'binary_sensor.kitchen_motion': { state: 'on' },
+  'sensor.kitchen_sensor_lux': { state: '20' },
+  'input_number.kitchen_automation_lux_threshold_dark': { state: '40' },
+})[entity] as any;
+
+const ctx = kitchenLights.context(mockState, mockHAContext);
+```
+
+---
+
+## Trigger types
+
+| Trigger | Fires when |
+|---------|-----------|
+| `state_changed` | An entity's state or attributes change. Accepts a string or `RegExp` for the entity ID. |
+| `schedule` | A cron expression fires. |
+| `on_start` | The system is ready and the state cache is fully populated. |
+| `timer_expired` | A named timer set by a previous `timer.start` action expires. |
+| `button` | A Zigbee button entity emits a `single_press`, `double_press`, or `hold` gesture. |
+| `mqtt_in` | A message arrives on a subscribed MQTT topic. |
+
+```typescript
+triggers: [
+  { type: 'state_changed', entity: 'binary_sensor.parlour_motion' },
+  { type: 'state_changed', entity: /^binary_sensor\..+_motion$/ },
+  { type: 'schedule', cron: '0 22 * * *' },
+  { type: 'on_start' },
+  { type: 'timer_expired', timerKey: 'kitchen:lights:off-delay' },
+  { type: 'button', entity: 'sensor.hallway_button', gesture: 'double_press' },
+]
+```
+
+---
+
+## Action types
+
+Actions are returned from `reduce()` as a plain array. The runtime executes them after the observability snapshot is published.
+
+| Action | Effect |
+|--------|--------|
+| `ha.call_service` | Calls a Home Assistant service |
+| `mqtt.publish` | Publishes to an MQTT topic |
+| `timer.start` | Starts (or restarts) a named timer |
+| `timer.cancel` | Cancels a named timer |
+
+```typescript
+actions: [
+  {
+    type: 'ha.call_service',
+    domain: 'climate',
+    service: 'set_temperature',
+    target: { entity_id: 'climate.bedroom_trv' },
+    data: { temperature: 20 },
+  },
+  {
+    type: 'timer.start',
+    timerKey: 'kitchen:lights:off-delay',
+    delayMs: 120_000,
+  },
+  {
+    type: 'mqtt.publish',
+    topic: 'homerun/decisions/kitchen',
+    payload: JSON.stringify({ decision: 'lights_on' }),
+    retain: false,
+  },
+]
+```
+
+---
+
+## Observability
+
+Every pipeline run publishes a decision snapshot to MQTT — whether it completed, aborted, or threw. Each snapshot carries a `correlation_id` minted at the event source, so you can trace a HA state change through to the TRV setpoint that resulted from it.
+
+```json
+{
+  "schema": "home.events.v1",
+  "correlation_id": "b3d2f1a0-...",
+  "automation_id": "kitchen:lighting",
+  "location": "kitchen",
+  "subsystem": "lighting",
+  "event_type": "decision",
+  "decision": "lights_on",
+  "inputs": { "motion": true, "lux": 20, "luxThreshold": 40 },
+  "actions": [{ "type": "ha.call_service", "domain": "light", "service": "turn_on" }],
+  "timestamp": "2026-06-23T18:00:00.000Z"
+}
+```
+
+---
+
+## Environment variables
+
+| Variable | Purpose |
+|----------|---------|
+| `HA_URL` | Home Assistant base URL (e.g. `http://homeassistant.local:8123`) |
+| `HA_TOKEN` | Long-lived access token |
+| `MQTT_URL` | MQTT broker URL (e.g. `mqtt://localhost:1883`) |
+| `AUTOMATIONS_DIR` | Directory of automation files (hot-reloaded on change) |
+| `DRY_RUN` | Set to `true` to log actions without executing them |
+
+---
+
+## Running
+
+> Homerun is not yet published to npm. Clone the repository and run directly from source.
+
+```bash
+# Development — hot-reloads automations on file change
+npm run dev
+
+# Run tests
+npm test
+```
+
+Set `DRY_RUN=true` to run the full pipeline — context, reduce, observability — without making any HA service calls. This is the default for local development.
+
+---
+
+## API
+
+The server exposes an HTTP API on port `7070` by default.
+
+| Method | Path | Description |
+|--------|------|-------------|
+| `GET` | `/health/live` | Always returns `200 { status: "live" }` — used for liveness probes. |
+| `GET` | `/health/ready` | Returns `200` when the HA state cache is populated and automations are loaded, `503` while starting. Response includes `entities`, `automations` counts, and `dry_run: true` if running in dry-run mode. |
+| `GET` | `/automations` | Lists all registered automations with their `id`, `location`, `subsystem`, and trigger types. |
+| `POST` | `/automations/:id/trigger` | Manually fires an `on_start` event for the given automation. |
+| `POST` | `/reload` | Rescans the automations directory and hot-reloads changed files. |
+| `GET` | `/events` | Server-sent event stream of all pipeline decisions and action events in real time. |
+
+---
+
+## Architecture
+
+```
+HAClient ──────────────────────────────────────┐
+  └─ state_changed (per entity, with corr. ID) │
+                                               ▼
+Scheduler (cron / on_start) ──────► TriggerEngine.dispatch()
+TimerManager (setTimeout)  ──────►        │
+                                          ▼
+                                   matchAndFire()
+                                          │
+                              ┌───────────▼──────────┐
+                              │    Pipeline Runner    │
+                              │  context → reduce     │
+                              │  → validate → fanout  │
+                              └──────────┬────────────┘
+                                         │
+                          ┌──────────────┴──────────────┐
+                          ▼                             ▼
+                   Observability                  ActionRuntime
+                 (MQTT snapshot)         (HA calls / timers / MQTT)
+```
+
+---
+
+## License
+
+MIT

package/dist/scripts/generate-ha-services.d.ts

@@ -0,0 +1,16 @@
+#!/usr/bin/env node
+export interface HAServicePayload {
+    domain: string;
+    services: Record<string, HAServiceDef>;
+}
+export interface HAServiceDef {
+    fields: Record<string, HAServiceField>;
+    target?: unknown;
+}
+export interface HAServiceField {
+    required?: boolean;
+    selector?: Record<string, unknown>;
+    advanced?: boolean;
+}
+export declare function inferFieldType(field: HAServiceField): string;
+export declare function generateFileContent(services: HAServicePayload[], domains?: string[]): string;

package/dist/scripts/generate-ha-services.js

@@ -0,0 +1,111 @@
+#!/usr/bin/env node
+import { writeFile, mkdir } from 'node:fs/promises';
+import path from 'node:path';
+// ---------- Type inference ----------
+export function inferFieldType(field) {
+    const selector = field.selector;
+    if (!selector)
+        return 'unknown';
+    const key = Object.keys(selector)[0];
+    if (!key)
+        return 'unknown';
+    switch (key) {
+        case 'number':
+        case 'color_temp':
+            return 'number';
+        case 'boolean':
+            return 'boolean';
+        case 'color_rgb':
+            return '[number, number, number]';
+        case 'duration':
+            return '{ hours?: number; minutes?: number; seconds?: number }';
+        case 'object':
+            return 'Record<string, unknown>';
+        default:
+            return 'string';
+    }
+}
+// ---------- Service builder generation ----------
+function generateServiceBuilder(domain, service, def) {
+    const hasTarget = !!def.target;
+    const fieldEntries = Object.entries(def.fields ?? {});
+    const hasFields = fieldEntries.length > 0;
+    const params = [];
+    if (hasTarget)
+        params.push('target: { entity_id: string }');
+    let anyRequired = false;
+    if (hasFields) {
+        anyRequired = fieldEntries.some(([, f]) => f.required);
+        const fieldDefs = fieldEntries
+            .map(([name, field]) => `${name}${field.required ? '' : '?'}: ${inferFieldType(field)}`)
+            .join('; ');
+        params.push(`data${anyRequired ? '' : '?'}: { ${fieldDefs} }`);
+    }
+    const bodyParts = [
+        `type: 'ha.call_service'`,
+        `domain: '${domain}'`,
+        `service: '${service}'`,
+    ];
+    if (hasTarget)
+        bodyParts.push('target');
+    if (hasFields) {
+        bodyParts.push(`data: data as Record<string, unknown>${anyRequired ? '' : ' | undefined'}`);
+    }
+    return `    ${service}: (${params.join(', ')}): Action => ({ ${bodyParts.join(', ')} })`;
+}
+// ---------- File generation ----------
+export function generateFileContent(services, domains) {
+    const filtered = domains
+        ? services.filter(({ domain }) => domains.includes(domain))
+        : services;
+    const domainBlocks = filtered.map(({ domain, services: svcMap }) => {
+        const builders = Object.entries(svcMap)
+            .map(([service, def]) => generateServiceBuilder(domain, service, def))
+            .join(',\n');
+        return `  ${domain}: {\n${builders},\n  }`;
+    });
+    const domainsNote = domains ? `\n// domains: ${domains.join(', ')}` : '';
+    const blockStr = domainBlocks.length > 0 ? `\n${domainBlocks.join(',\n')},\n` : '';
+    return `// generated — do not edit — run: npm run generate:ha-services${domainsNote}
+import type { Action } from '@ajclarkson/homerun';
+
+export const Services = {${blockStr}};
+`;
+}
+// ---------- CLI ----------
+async function main() {
+    const url = process.env.HA_URL;
+    const token = process.env.HA_TOKEN;
+    if (!url || !token) {
+        console.error('Error: HA_URL and HA_TOKEN must be set');
+        process.exit(1);
+    }
+    const domainsArg = process.argv.find((a) => a.startsWith('--domains='));
+    const domains = domainsArg ? domainsArg.slice('--domains='.length).split(',') : undefined;
+    const res = await fetch(`${url}/api/services`, {
+        headers: { Authorization: `Bearer ${token}` },
+    });
+    if (!res.ok) {
+        console.error(`Error: HA API returned ${res.status} ${res.statusText}`);
+        process.exit(1);
+    }
+    const allServices = (await res.json());
+    const content = generateFileContent(allServices, domains);
+    const outPath = path.join(process.cwd(), 'types', 'ha-services.ts');
+    await mkdir(path.dirname(outPath), { recursive: true });
+    await writeFile(outPath, content, 'utf8');
+    const filtered = domains
+        ? allServices.filter(({ domain }) => domains.includes(domain))
+        : allServices;
+    const serviceCount = filtered.reduce((n, { services: s }) => n + Object.keys(s).length, 0);
+    const domainLabel = domains ? `${domains.length} selected` : `all ${allServices.length}`;
+    console.log(`Written ${serviceCount} services across ${domainLabel} domains to ${outPath}`);
+}
+if (process.argv[1]?.endsWith('generate-ha-services.ts') ||
+    process.argv[1]?.endsWith('generate-ha-services.js') ||
+    process.argv[1]?.endsWith('homerun-generate-ha-services')) {
+    main().catch((err) => {
+        console.error('Fatal:', err);
+        process.exit(1);
+    });
+}

package/dist/scripts/generate-ha-types.d.ts

@@ -0,0 +1,8 @@
+#!/usr/bin/env node
+export interface HAStatePayload {
+    entity_id: string;
+    state: string;
+    attributes: Record<string, unknown>;
+}
+export declare function inferStateType(entity: HAStatePayload, allObservedStates?: string[]): string;
+export declare function generateFileContent(states: HAStatePayload[]): string;

package/dist/scripts/generate-ha-types.js

@@ -0,0 +1,75 @@
+#!/usr/bin/env node
+import { writeFile, mkdir } from 'node:fs/promises';
+import path from 'node:path';
+// ---------- Inference ----------
+export function inferStateType(entity, allObservedStates) {
+    const domain = entity.entity_id.split('.')[0];
+    switch (domain) {
+        case 'binary_sensor':
+        case 'input_boolean':
+        case 'switch':
+            return "'on' | 'off' | 'unavailable' | 'unknown'";
+        case 'input_select': {
+            const options = entity.attributes.options;
+            if (Array.isArray(options) && options.length > 0) {
+                return options.map((o) => `'${o}'`).join(' | ') + " | 'unavailable' | 'unknown'";
+            }
+            return 'string';
+        }
+        default:
+            return 'string';
+    }
+}
+// ---------- File generation ----------
+export function generateFileContent(states) {
+    const personStates = new Map();
+    for (const s of states) {
+        if (s.entity_id.startsWith('person.')) {
+            const existing = personStates.get(s.entity_id) ?? [];
+            existing.push(s.state);
+            personStates.set(s.entity_id, existing);
+        }
+    }
+    const entries = states
+        .map((s) => {
+        const stateType = inferStateType(s, personStates.get(s.entity_id));
+        return `    '${s.entity_id}': { state: ${stateType} };`;
+    })
+        .join('\n');
+    return `// generated — do not edit — run: npm run generate:ha-types
+declare global {
+  interface HAEntities {
+${entries}
+  }
+}
+export {};
+`;
+}
+// ---------- CLI ----------
+async function main() {
+    const url = process.env.HA_URL;
+    const token = process.env.HA_TOKEN;
+    if (!url || !token) {
+        console.error('Error: HA_URL and HA_TOKEN must be set');
+        process.exit(1);
+    }
+    const res = await fetch(`${url}/api/states`, {
+        headers: { Authorization: `Bearer ${token}` },
+    });
+    if (!res.ok) {
+        console.error(`Error: HA API returned ${res.status} ${res.statusText}`);
+        process.exit(1);
+    }
+    const states = (await res.json());
+    const content = generateFileContent(states);
+    const outPath = path.join(process.cwd(), 'types', 'ha-entities.ts');
+    await mkdir(path.dirname(outPath), { recursive: true });
+    await writeFile(outPath, content, 'utf8');
+    console.log(`Written ${states.length} entities to ${outPath}`);
+}
+if (process.argv[1]?.endsWith('generate-ha-types.ts') || process.argv[1]?.endsWith('generate-ha-types.js') || process.argv[1]?.endsWith('homerun-generate-ha-types')) {
+    main().catch((err) => {
+        console.error('Fatal:', err);
+        process.exit(1);
+    });
+}

package/dist/src/framework/action-runtime.d.ts

@@ -0,0 +1,39 @@
+import type { MqttClient } from 'mqtt';
+import type { Action } from '../types/actions.js';
+import type { HAClient } from './ha-client.js';
+import type { TimerManager } from './timer-manager.js';
+import type { EventPublisher } from './event-publisher.js';
+import type { MetricsBackend } from './metrics.js';
+export interface ExecutionContext {
+    correlationId: string;
+    automationId: string;
+    location: string;
+    subsystem: string;
+    rootCorrelationId?: string;
+    parentCorrelationId?: string;
+    parentAutomationId?: string;
+}
+interface Deps {
+    haClient: HAClient;
+    mqttClient: MqttClient;
+    timerManager: TimerManager;
+    eventPublisher: EventPublisher;
+    dryRun: boolean;
+    metrics?: MetricsBackend;
+    commandAck?: {
+        enabled: boolean;
+        timeoutMs: number;
+    };
+}
+export declare class ActionRuntime {
+    private readonly deps;
+    constructor(deps: Deps);
+    private handleAckTimeout;
+    execute(actions: Action[], ctx: ExecutionContext): Promise<void>;
+    private runAction;
+    private dispatch;
+    private baseFields;
+    private makeStartedEvent;
+    private makeResultEvent;
+}
+export {};