@switchbot/openapi-cli 3.1.1 → 3.2.0

package/dist/commands/expand.js

@@ -1,130 +0,0 @@
-import { intArg, stringArg } from '../utils/arg-parsers.js';
-import { handleError, isJsonMode, printJson, UsageError, exitWithError } from '../utils/output.js';
-import { getCachedDevice } from '../devices/cache.js';
-import { executeCommand, isDestructiveCommand, getDestructiveReason } from '../lib/devices.js';
-import { isDryRun } from '../utils/flags.js';
-import { resolveDeviceId } from '../utils/name-resolver.js';
-import { DryRunSignal } from '../api/client.js';
-import { buildAcSetAll, buildCurtainSetPosition, buildBlindTiltSetPosition, buildRelaySetMode, } from '../devices/param-validator.js';
-// ---- Registration ----------------------------------------------------------
-export function registerExpandCommand(devices) {
-    devices
-        .command('expand')
-        .description('Send a command with semantic flags instead of raw positional parameters')
-        .argument('[deviceId]', 'Target device ID from "devices list" (or use --name)')
-        .argument('[command]', 'Command name: setAll (AC), setPosition (Curtain/Blind Tilt), setMode (Relay Switch 2)')
-        .option('--name <query>', 'Resolve device by fuzzy name instead of deviceId', stringArg('--name'))
-        .option('--temp <celsius>', 'AC setAll: temperature in Celsius (16-30)', intArg('--temp', { min: 16, max: 30 }))
-        .option('--mode <mode>', 'AC: auto|cool|dry|fan|heat  Curtain: default|performance|silent  Relay: toggle|edge|detached|momentary', stringArg('--mode'))
-        .option('--fan <speed>', 'AC setAll: fan speed auto|low|mid|high', stringArg('--fan'))
-        .option('--power <state>', 'AC setAll: on|off', stringArg('--power'))
-        .option('--position <percent>', 'Curtain setPosition: 0-100 (0=open, 100=closed)', intArg('--position', { min: 0, max: 100 }))
-        .option('--direction <dir>', 'Blind Tilt setPosition: up|down', stringArg('--direction'))
-        .option('--angle <percent>', 'Blind Tilt setPosition: 0-100 (0=closed, 100=open)', intArg('--angle', { min: 0, max: 100 }))
-        .option('--channel <n>', 'Relay Switch 2 setMode: channel 1 or 2', intArg('--channel', { min: 1, max: 2 }))
-        .option('--yes', 'Confirm destructive commands')
-        .addHelpText('after', `
-Translates semantic flags into the wire parameter format, then sends the command.
-
-Supported expansions:
-
-  Air Conditioner — setAll
-    --temp 26 --mode cool --fan low --power on  →  "26,2,2,on"
-    --mode values: auto | cool | dry | fan | heat
-    --fan values:  auto | low | mid | high
-
-  Curtain / Curtain 3 — setPosition
-    --position 50 [--mode silent]  →  "0,1,50"
-    --mode values: default (ff) | performance (0) | silent (1)
-
-  Blind Tilt — setPosition
-    --direction up --angle 50  →  "up;50"
-
-  Relay Switch 2PM — setMode
-    --channel 1 --mode edge  →  "1;1"
-    --mode values: toggle (0) | edge (1) | detached (2) | momentary (3)
-
-Examples:
-  $ switchbot devices expand <acId>      setAll       --temp 26 --mode cool --fan low --power on
-  $ switchbot devices expand <curtainId> setPosition  --position 50 --mode silent
-  $ switchbot devices expand <blindId>   setPosition  --direction up --angle 50
-  $ switchbot devices expand <relayId>   setMode      --channel 1 --mode edge
-  $ switchbot devices expand <acId>      setAll       --temp 22 --mode heat --fan auto --power on --dry-run
-  $ switchbot devices expand --name "Living Room AC" setAll --temp 26 --mode cool --fan low --power on
-`)
-        .action(async (deviceIdArg, commandArg, options) => {
-        let deviceId = '';
-        let command = '';
-        try {
-            // When --name is provided, Commander assigns the first positional to deviceIdArg
-            // and leaves commandArg undefined. Detect and shift.
-            let effectiveDeviceIdArg = deviceIdArg;
-            let effectiveCommand = commandArg;
-            if (options.name && deviceIdArg && !commandArg) {
-                effectiveCommand = deviceIdArg;
-                effectiveDeviceIdArg = undefined;
-            }
-            deviceId = resolveDeviceId(effectiveDeviceIdArg, options.name);
-            if (!effectiveCommand)
-                throw new UsageError('A command argument is required (setAll, setPosition, setMode).');
-            command = effectiveCommand;
-            const cached = getCachedDevice(deviceId);
-            const deviceType = cached?.type ?? '';
-            let parameter;
-            if (command === 'setAll') {
-                parameter = buildAcSetAll(options);
-            }
-            else if (command === 'setPosition') {
-                if (!cached) {
-                    throw new UsageError(`Device ${deviceId} is not in the local cache — run 'switchbot devices list' first so 'expand' knows whether this is a Curtain or a Blind Tilt.`);
-                }
-                const isBlind = deviceType.startsWith('Blind Tilt');
-                parameter = isBlind
-                    ? buildBlindTiltSetPosition(options)
-                    : buildCurtainSetPosition(options);
-            }
-            else if (command === 'setMode' && deviceType.startsWith('Relay Switch')) {
-                parameter = buildRelaySetMode(options);
-            }
-            else {
-                throw new UsageError(`'expand' does not support "${command}" for device type "${deviceType || 'unknown'}". ` +
-                    `Use 'switchbot devices command' to send raw parameters instead.`);
-            }
-            if (!options.yes && !isDryRun() && isDestructiveCommand(deviceType, command, 'command')) {
-                const reason = getDestructiveReason(deviceType, command, 'command');
-                exitWithError({
-                    code: 2,
-                    kind: 'guard',
-                    message: `"${command}" on ${deviceType || 'device'} is destructive and requires --yes.`,
-                    hint: reason ? `Re-run with --yes. Reason: ${reason}` : 'Re-run with --yes to confirm.',
-                });
-            }
-            const body = await executeCommand(deviceId, command, parameter, 'command');
-            const isIr = cached?.category === 'ir';
-            if (isJsonMode()) {
-                const result = { ok: true, command, deviceId, parameter };
-                if (isIr)
-                    result.subKind = 'ir-no-feedback';
-                if (body && typeof body === 'object' && Object.keys(body).length > 0)
-                    result.response = body;
-                printJson(result);
-                return;
-            }
-            console.log(`✓ Command sent: ${command} (${parameter})`);
-            if (isIr)
-                console.log('  Note: IR command sent — no device confirmation (fire-and-forget).');
-        }
-        catch (error) {
-            if (error instanceof DryRunSignal) {
-                if (isJsonMode()) {
-                    printJson({ ok: true, dryRun: true, command, deviceId });
-                }
-                else {
-                    console.log(`◦ dry-run: ${command} would be sent to ${deviceId}`);
-                }
-                return;
-            }
-            handleError(error);
-        }
-    });
-}

package/dist/commands/explain.js

@@ -1,139 +0,0 @@
-import { printJson, isJsonMode, handleError } from '../utils/output.js';
-import { describeDevice, fetchDeviceList, } from '../lib/devices.js';
-function deviceName(d) {
-    return d.deviceName;
-}
-export function registerExplainCommand(devices) {
-    devices
-        .command('explain')
-        .description('One-shot device summary: metadata + capabilities + live status + children (for Hubs)')
-        .argument('<deviceId>', 'Device ID to explain')
-        .option('--no-live', 'Skip the live status API call (catalog-only output)')
-        .addHelpText('after', `
-'explain' is the agent-friendly sibling of 'describe'. It combines:
-  - metadata (id, name, type, category, role)
-  - live status (unless --no-live)
-  - commands with idempotent/destructive flags
-  - children (for Hub devices: IR remotes bound to this hub)
-  - suggested actions (pre-baked common usages)
-  - warnings (deprecated types, missing cloud service, etc.)
-
-Examples:
-  $ switchbot devices explain <id>
-  $ switchbot --json devices explain <id> | jq '.commands[] | select(.destructive)'
-  $ switchbot devices explain <id> --no-live
-`)
-        .action(async (deviceId, options) => {
-        try {
-            const wantLive = options.live !== false;
-            const desc = await describeDevice(deviceId, { live: wantLive });
-            const warnings = [];
-            if (desc.isPhysical && !desc.device.enableCloudService) {
-                warnings.push('Cloud service disabled on this device — commands will fail.');
-            }
-            if (!desc.catalog) {
-                warnings.push(`No catalog entry for type "${desc.typeName}". Commands cannot be validated offline.`);
-            }
-            let children = [];
-            if (desc.catalog?.role === 'hub') {
-                const body = await fetchDeviceList();
-                children = body.infraredRemoteList
-                    .filter((ir) => ir.hubDeviceId === deviceId)
-                    .map((ir) => ({ deviceId: ir.deviceId, name: ir.deviceName, type: ir.remoteType }));
-            }
-            const caps = desc.capabilities;
-            const commands = caps && 'commands' in caps
-                ? caps.commands.map((c) => {
-                    const tier = c.safetyTier;
-                    return {
-                        command: c.command,
-                        parameter: c.parameter,
-                        idempotent: c.idempotent,
-                        ...(tier ? { safetyTier: tier } : {}),
-                    };
-                })
-                : [];
-            const statusFields = caps && 'statusFields' in caps ? caps.statusFields : [];
-            const liveStatus = caps && 'liveStatus' in caps ? caps.liveStatus : undefined;
-            const location = desc.isPhysical
-                ? {
-                    family: desc.device.familyName,
-                    room: desc.device.roomName ?? undefined,
-                }
-                : desc.inheritedLocation
-                    ? { family: desc.inheritedLocation.family, room: desc.inheritedLocation.room }
-                    : undefined;
-            const result = {
-                deviceId,
-                type: desc.typeName,
-                category: desc.isPhysical ? 'physical' : 'ir',
-                name: deviceName(desc.device),
-                role: desc.catalog?.role ?? null,
-                readOnly: desc.catalog?.readOnly ?? false,
-                location,
-                liveStatus,
-                commands,
-                statusFields,
-                children,
-                suggestedActions: desc.suggestedActions,
-                warnings,
-            };
-            if (isJsonMode()) {
-                printJson(result);
-                return;
-            }
-            printHuman(result);
-        }
-        catch (err) {
-            handleError(err);
-        }
-    });
-}
-function printHuman(r) {
-    console.log(`# ${r.name} (${r.deviceId})`);
-    console.log(`type:     ${r.type} [${r.category}${r.role ? ', ' + r.role : ''}${r.readOnly ? ', read-only' : ''}]`);
-    if (r.location?.family || r.location?.room) {
-        const loc = [r.location?.family, r.location?.room].filter(Boolean).join(' / ');
-        console.log(`location: ${loc}`);
-    }
-    if (r.warnings.length) {
-        console.log('warnings:');
-        for (const w of r.warnings)
-            console.log(`  ! ${w}`);
-    }
-    if (r.liveStatus && !('error' in r.liveStatus)) {
-        console.log('live status:');
-        for (const [k, v] of Object.entries(r.liveStatus)) {
-            console.log(`  ${k}: ${JSON.stringify(v)}`);
-        }
-    }
-    else if (r.liveStatus && 'error' in r.liveStatus) {
-        console.log(`live status: error — ${r.liveStatus.error}`);
-    }
-    if (r.commands.length) {
-        console.log('commands:');
-        for (const c of r.commands) {
-            const flags = [c.idempotent && 'idempotent', c.safetyTier === 'destructive' && 'destructive']
-                .filter(Boolean)
-                .join(', ');
-            const suffix = flags ? `  [${flags}]` : '';
-            console.log(`  ${c.command}${c.parameter !== '—' ? ` <${c.parameter}>` : ''}${suffix}`);
-        }
-    }
-    if (r.statusFields.length) {
-        console.log(`status fields: ${r.statusFields.join(', ')}`);
-    }
-    if (r.children.length) {
-        console.log(`children (${r.children.length}):`);
-        for (const c of r.children) {
-            console.log(`  ${c.deviceId}  ${c.name}  [${c.type}]`);
-        }
-    }
-    if (r.suggestedActions.length) {
-        console.log('suggested:');
-        for (const s of r.suggestedActions) {
-            const param = s.parameter ? ` ${s.parameter}` : '';
-            console.log(`  ${s.description}: ${s.command}${param}`);
-        }
-    }
-}

package/dist/commands/health.js

@@ -1,113 +0,0 @@
-import http from 'node:http';
-import { printJson, isJsonMode, printTable, handleError } from '../utils/output.js';
-import { getHealthReport, toPrometheusText } from '../utils/health.js';
-import { intArg } from '../utils/arg-parsers.js';
-const HEALTHZ_SCHEMA_VERSION = '1.1';
-/**
- * Create an HTTP request handler for the health endpoints. Exposed separately
- * so integration tests can call it directly without binding a port.
- */
-export function createHealthHandler(auditLogPath) {
-    return (req, res) => {
-        const url = (req.url ?? '/').split('?')[0];
-        if (url === '/healthz') {
-            const report = getHealthReport(auditLogPath);
-            const statusCode = report.overall === 'down' ? 503 : 200;
-            res.writeHead(statusCode, { 'Content-Type': 'application/json' });
-            res.end(JSON.stringify({ schemaVersion: HEALTHZ_SCHEMA_VERSION, data: report }));
-        }
-        else if (url === '/metrics') {
-            const report = getHealthReport(auditLogPath);
-            res.writeHead(200, { 'Content-Type': 'text/plain; version=0.0.4; charset=utf-8' });
-            res.end(toPrometheusText(report));
-        }
-        else {
-            res.writeHead(404, { 'Content-Type': 'application/json' });
-            res.end(JSON.stringify({ error: 'Not found', paths: ['/healthz', '/metrics'] }));
-        }
-    };
-}
-export function registerHealthCommand(program) {
-    const health = program
-        .command('health')
-        .description('Report process health: quota, audit error rate, circuit breaker state.');
-    health
-        .command('check')
-        .description('Print a one-shot health report.')
-        .option('--prometheus', 'Emit Prometheus text format.')
-        .option('--audit-log <path>', 'Audit log path (default: ~/.switchbot/audit.log).')
-        .action((opts) => {
-        const report = getHealthReport(opts.auditLog);
-        if (opts.prometheus) {
-            process.stdout.write(toPrometheusText(report));
-            return;
-        }
-        if (isJsonMode()) {
-            printJson(report);
-            return;
-        }
-        const statusEmoji = report.overall === 'ok' ? '✓' : report.overall === 'degraded' ? '⚠' : '✗';
-        console.log(`${statusEmoji} overall: ${report.overall}  (${report.generatedAt})`);
-        console.log('');
-        printTable(['Component', 'Status', 'Detail'], [
-            ['quota', report.quota.status,
-                `${report.quota.used}/${report.quota.limit} (${report.quota.percentUsed}% used, ${report.quota.remaining} remaining)`],
-            ['audit', report.audit.status,
-                report.audit.present
-                    ? `${report.audit.recentErrors}/${report.audit.recentTotal} errors in 24h (${report.audit.errorRatePercent}%)`
-                    : 'log not present'],
-            ['circuit', report.circuit.status,
-                `${report.circuit.name}: ${report.circuit.state} (failures: ${report.circuit.failures})`],
-            ['process', 'ok',
-                `pid ${report.process.pid} · uptime ${report.process.uptimeSeconds}s · mem ${report.process.memoryMb}MB`],
-        ]);
-        if (report.overall !== 'ok')
-            process.exit(1);
-    });
-    // switchbot health serve [--port <n>]
-    health
-        .command('serve')
-        .description('Start an HTTP server exposing /healthz (JSON) and /metrics (Prometheus).')
-        .option('--port <n>', 'Port to listen on.', intArg('--port'), '3100')
-        .option('--host <host>', 'Bind address.', '127.0.0.1')
-        .option('--audit-log <path>', 'Audit log path.')
-        .addHelpText('after', `
-Endpoints:
-  GET /healthz   JSON health report (HTTP 200 ok/degraded, 503 when circuit is open).
-  GET /metrics   Prometheus text metrics.
-
-Example:
-  $ switchbot health serve --port 3100
-  $ curl http://127.0.0.1:3100/healthz
-`)
-        .action((opts) => {
-        const port = parseInt(opts.port, 10);
-        const handler = createHealthHandler(opts.auditLog);
-        const server = http.createServer(handler);
-        server.on('error', (err) => {
-            if (err.code === 'EADDRINUSE') {
-                handleError(Object.assign(new Error(`Port ${port} is already in use. Choose a different port with --port.`), { code: err.code }));
-            }
-            else {
-                handleError(err);
-            }
-        });
-        server.listen(port, opts.host, () => {
-            const addr = server.address();
-            const boundPort = typeof addr === 'object' && addr !== null ? addr.port : port;
-            if (isJsonMode()) {
-                printJson({ status: 'listening', host: opts.host, port: boundPort, endpoints: ['/healthz', '/metrics'] });
-            }
-            else {
-                console.log(`health server listening on ${opts.host}:${boundPort}`);
-                console.log('  GET /healthz  — JSON health report');
-                console.log('  GET /metrics  — Prometheus text metrics');
-            }
-        });
-        function shutdown() {
-            server.close(() => process.exit(0));
-        }
-        process.on('SIGTERM', shutdown);
-        process.on('SIGINT', shutdown);
-    });
-}