@switchbot/openapi-cli 2.6.1 → 2.6.3

package/README.md

@@ -184,7 +184,10 @@ switchbot devices command --help
 
 Intercepts every non-GET request: the CLI prints the URL/body it would have
 sent, then exits `0` without contacting the API. `GET` requests (list, status,
-query) are still executed so you can preview the state involved.
+query) are still executed so you can preview the state involved. Dry-run also
+validates command names against the device catalog and rejects unknown commands
+(exit 2) when the device type has a known catalog entry. Commands sent to
+read-only sensors (e.g. Meter) are likewise rejected.
 
 ```bash
 switchbot devices command ABC123 turnOn --dry-run
@@ -305,7 +308,7 @@ Generic parameter shapes (which one applies is decided by the device — see the
 
 Parameters for `setAll` (Air Conditioner), `setPosition` (Curtain / Blind Tilt), `setMode` (Relay Switch), `setBrightness` (dimmable lights), and `setColor` (Color Bulb / Strip Light / Ceiling Light) are validated client-side before the request — malformed shapes, out-of-range values, and JSON for CSV fields all fail fast with exit 2. `setColor` accepts `R:G:B`, `R,G,B`, `#RRGGBB`, `#RGB`, and CSS named colors (`red`, `blue`, …); all normalize to `R:G:B` before hitting the API. Pass `--skip-param-validation` to bypass (escape hatch — prefer fixing the argument). Command names are also case-normalized against the catalog (e.g. `turnon` is auto-corrected to `turnOn` with a stderr warning); unknown names still exit 2 with the supported-commands list.
 
-Unknown deviceIds (not in the local cache) exit 2 by default so `--dry-run` is a reliable pre-flight gate. Run `switchbot devices list` first, or pass `--allow-unknown-device` for scripted pass-through.
+Unknown deviceIds (not in the local cache) exit 2 by default so `--dry-run` is a reliable pre-flight gate. Unknown command names and commands on read-only sensors are also rejected during dry-run when the device type has a catalog entry. Run `switchbot devices list` first, or pass `--allow-unknown-device` for scripted pass-through.
 
 Negative numeric parameters (e.g. `setBrightness -1` for a probe) are passed through to the command validator instead of being swallowed by the flag parser as an unknown option.
 
@@ -717,7 +720,7 @@ switchbot cache clear --key status
 
 | Code | Meaning                                                                                                                   |
 | ---- | ------------------------------------------------------------------------------------------------------------------------- |
-| `0`  | Success (including `--dry-run` intercept)                                                                                 |
+| `0`  | Success (including `--dry-run` intercept when validation passes)                                                           |
 | `1`  | Runtime error — API error, network failure, missing credentials                                                           |
 | `2`  | Usage error — bad flag, missing/invalid argument, unknown subcommand, unknown device type, invalid URL, conflicting flags |
 

package/dist/commands/mcp.js

@@ -305,6 +305,35 @@ API docs: https://github.com/OpenWonderLabs/SwitchBotAPI`,
                     effectiveParameter = pv.normalized;
                 }
             }
+            // Bug #55: validateCommand is lenient by design (passes unknown device
+            // types, ambiguous catalog matches). For dry-run we need stricter
+            // checking — query the catalog directly and reject unknown commands
+            // when the catalog has a definitive match.
+            if (effectiveType !== 'customize') {
+                const catalogMatch = findCatalogEntry(cached.type);
+                if (catalogMatch && !Array.isArray(catalogMatch)) {
+                    const builtinCmds = catalogMatch.commands.filter((c) => c.commandType !== 'customize');
+                    if (builtinCmds.length > 0) {
+                        const exactMatch = builtinCmds.find((c) => c.command === command);
+                        const caseMatch = !exactMatch
+                            ? builtinCmds.find((c) => c.command.toLowerCase() === command.toLowerCase())
+                            : null;
+                        if (!exactMatch && !caseMatch) {
+                            const supported = [...new Set(builtinCmds.map((c) => c.command))].join(', ');
+                            return mcpError('usage', 2, `"${command}" is not a supported command for ${cached.name} (${cached.type}).`, {
+                                hint: `Supported commands: ${supported}`,
+                                context: { validationKind: 'unknown-command', deviceType: cached.type, command },
+                            });
+                        }
+                    }
+                    else if (catalogMatch.readOnly) {
+                        return mcpError('usage', 2, `${cached.name} (${cached.type}) is a read-only sensor — it has no control commands.`, {
+                            hint: "Use 'get_device_status' to read this device instead.",
+                            context: { validationKind: 'read-only-device', deviceType: cached.type, command },
+                        });
+                    }
+                }
+            }
             const wouldSend = {
                 deviceId,
                 command,
@@ -426,7 +455,22 @@ API docs: https://github.com/OpenWonderLabs/SwitchBotAPI`,
         },
     }, async ({ sceneId, dryRun }) => {
         if (dryRun) {
-            const wouldSend = { sceneId };
+            let scenes = [];
+            try {
+                scenes = await fetchScenes();
+            }
+            catch {
+                // network failure — degrade gracefully, skip validation
+            }
+            const found = scenes.find((s) => s.sceneId === sceneId);
+            if (scenes.length > 0 && !found) {
+                return mcpError('usage', 2, `Scene not found: ${sceneId}`, {
+                    subKind: 'scene-not-found',
+                    hint: "Check the sceneId with 'list_scenes' (IDs are case-sensitive).",
+                    context: { sceneId, candidates: scenes.map((s) => ({ sceneId: s.sceneId, sceneName: s.sceneName })).slice(0, 5) },
+                });
+            }
+            const wouldSend = { sceneId, sceneName: found?.sceneName ?? null };
             const structured = { ok: true, dryRun: true, wouldSend };
             return {
                 content: [{ type: 'text', text: JSON.stringify(structured, null, 2) }],

package/dist/commands/scenes.js

@@ -1,6 +1,7 @@
 import { printJson, isJsonMode, handleError, StructuredUsageError } from '../utils/output.js';
 import { resolveFormat, resolveFields, renderRows } from '../utils/format.js';
 import { fetchScenes, executeScene } from '../lib/scenes.js';
+import { isDryRun } from '../utils/flags.js';
 export function registerScenesCommand(program) {
     const scenes = program
         .command('scenes')
@@ -56,6 +57,16 @@ Example:
                     candidates: sceneList.map((s) => ({ sceneId: s.sceneId, sceneName: s.sceneName })),
                 });
             }
+            if (isDryRun()) {
+                const wouldSend = { method: 'POST', url: `/v1.1/scenes/${sceneId}/execute`, sceneId, sceneName: found.sceneName };
+                if (isJsonMode()) {
+                    printJson({ dryRun: true, wouldSend });
+                }
+                else {
+                    console.log(`[dry-run] Would POST /v1.1/scenes/${sceneId}/execute (${found.sceneName})`);
+                }
+                return;
+            }
             await executeScene(sceneId);
             if (isJsonMode()) {
                 printJson({ ok: true, sceneId });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@switchbot/openapi-cli",
-  "version": "2.6.1",
+  "version": "2.6.3",
   "description": "SwitchBot smart home CLI — control devices, run scenes, stream real-time events, and integrate AI agents via MCP. Full API v1.1 coverage.",
   "keywords": [
     "switchbot",