registry: Speaker, StepSpeaker, EqualizerController, PlaybackController, PlaybackStateReporter, InputController, ChannelController

Seven descriptors written from their pages replace seven stubs. All are version 3; 1.5.2 announced Speaker,
StepSpeaker, EqualizerController and PlaybackStateReporter as version 1, and all but ChannelController without
a property. StepSpeaker has no properties object in discovery and PlaybackController one without fields, next
to supportedOperations; a directive for an operation the device did not list is answered with
INVALID_DIRECTIVE. The equalizer declares bands, modes or both under "configurations", a TV its inputs from
the 61 names of the page.

Not described: the lineup of ChannelController, whose discovery example the page folds away. The discovery
examples of InputController spell one key "friendNames"; the fixtures have friendlyNames, as its table does.
62 examples of the six pages are saved as fixtures. 241 tests pass, 215 before.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>

dist/cjs/registry/interfaces/ChannelController.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChannelController = void 0;
+const schema_js_1 = require("../schema.js");
+const types_js_1 = require("../types.js");
+// None of the fields is required, a channel has one of them at least
+const channel = schema_js_1.s.object({
+    /** "256", "13.1" */
+    number: schema_js_1.s.optional(schema_js_1.s.string()),
+    callSign: schema_js_1.s.optional(schema_js_1.s.string()),
+    affiliateCallSign: schema_js_1.s.optional(schema_js_1.s.string()),
+    uri: schema_js_1.s.optional(schema_js_1.s.string()),
+});
+/**
+ * The channel of a TV. ChangeChannel names the channel by one or more of number, callSign, affiliateCallSign and
+ * uri, or by channelMetadata.name alone. The lineup of a TV provider is not described: the page folds the discovery
+ * example that has one.
+ */
+exports.ChannelController = (0, types_js_1.defineInterface)({
+    namespace: "Alexa.ChannelController",
+    version: "3",
+    doc: "https://developer.amazon.com/docs/alexaplus/device-apis/alexa-channelcontroller.html",
+    kind: "controller",
+    tier: 2,
+    instanced: false,
+    properties: {
+        channel: { name: "channel", value: channel },
+    },
+    directives: {
+        ChangeChannel: {
+            name: "ChangeChannel",
+            payload: schema_js_1.s.object({
+                channel: schema_js_1.s.optional(channel),
+                channelMetadata: schema_js_1.s.optional(schema_js_1.s.object({ name: schema_js_1.s.optional(schema_js_1.s.string()), image: schema_js_1.s.optional(schema_js_1.s.string()) })),
+            }),
+        },
+        SkipChannels: {
+            name: "SkipChannels",
+            payload: schema_js_1.s.object({ channelCount: schema_js_1.s.number({ integer: true }) }),
+            note: "above 0 up, below 0 down",
+        },
+    },
+});

dist/cjs/registry/interfaces/EqualizerController.js

@@ -0,0 +1,72 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EqualizerController = void 0;
+const schema_js_1 = require("../schema.js");
+const types_js_1 = require("../types.js");
+const BANDS = ["BASS", "MIDRANGE", "TREBLE"];
+const MODES = ["MOVIE", "MUSIC", "NIGHT", "SPORT", "TV"];
+const band = schema_js_1.s.enum(...BANDS);
+const level = schema_js_1.s.number({ integer: true });
+/**
+ * The bands of an equalizer, its modes, or both. Discovery lists bands for a device declared with bands and mode
+ * for one declared with modes. A band or a mode the device does not have is answered with INVALID_VALUE.
+ */
+exports.EqualizerController = (0, types_js_1.defineInterface)({
+    namespace: "Alexa.EqualizerController",
+    version: "3",
+    doc: "https://developer.amazon.com/docs/alexaplus/device-apis/alexa-equalizercontroller.html",
+    kind: "controller",
+    tier: 2,
+    instanced: false,
+    properties: {
+        bands: { name: "bands", value: schema_js_1.s.array(schema_js_1.s.object({ name: band, value: level })) },
+        mode: { name: "mode", value: schema_js_1.s.enum(...MODES) },
+    },
+    directives: {
+        SetMode: { name: "SetMode", payload: schema_js_1.s.object({ mode: schema_js_1.s.enum(...MODES) }) },
+        SetBands: { name: "SetBands", payload: schema_js_1.s.object({ bands: schema_js_1.s.array(schema_js_1.s.object({ name: band, value: level }), { min: 1 }) }) },
+        AdjustBands: {
+            name: "AdjustBands",
+            payload: schema_js_1.s.object({
+                bands: schema_js_1.s.array(schema_js_1.s.object({ name: band, levelDelta: schema_js_1.s.optional(level), levelDirection: schema_js_1.s.enum("UP", "DOWN") }), { min: 1 }),
+            }),
+            note: "without levelDelta the band moves by the step the device has for it",
+        },
+        ResetBands: { name: "ResetBands", payload: schema_js_1.s.object({ bands: schema_js_1.s.array(schema_js_1.s.object({ name: band }), { min: 1 }) }) },
+    },
+    options: schema_js_1.s.object({
+        /** The bands of the device and the levels they take. Left out for a device that has modes only. */
+        bands: schema_js_1.s.optional(schema_js_1.s.object({
+            supported: schema_js_1.s.array(band, { min: 1 }),
+            range: schema_js_1.s.object({ minimum: level, maximum: level }, { unknownKeys: "reject" }),
+        }, { unknownKeys: "reject" })),
+        /** Left out for a device that has bands only. */
+        modes: schema_js_1.s.optional(schema_js_1.s.array(schema_js_1.s.enum(...MODES), { min: 1 })),
+    }, { unknownKeys: "reject" }),
+    // A capability declared the 1.x way has neither; check() says so, discovery lists both properties
+    discovery({ options: { bands, modes } }) {
+        if (!bands && !modes)
+            return {};
+        return {
+            supported: [...(bands ? ["bands"] : []), ...(modes ? ["mode"] : [])],
+            configurations: {
+                ...(bands && { bands: { supported: bands.supported.map((name) => ({ name })), range: bands.range } }),
+                ...(modes && { modes: { supported: modes.map((name) => ({ name })) } }),
+            },
+        };
+    },
+    validate(capability) {
+        const { bands, modes = [] } = capability.options;
+        if (!bands && modes.length === 0)
+            throw new types_js_1.DeclarationError(capability, "needs bands, modes or both: declare what the equalizer has");
+        if (bands && bands.range.maximum <= bands.range.minimum) {
+            throw new types_js_1.DeclarationError(capability, `bands.range.maximum ${bands.range.maximum} is not above bands.range.minimum ${bands.range.minimum}`);
+        }
+        const lists = [bands?.supported ?? [], modes];
+        for (const list of lists) {
+            const twice = list.find((entry, i) => list.indexOf(entry) !== i);
+            if (twice)
+                throw new types_js_1.DeclarationError(capability, `${twice} is listed twice`);
+        }
+    },
+});

dist/cjs/registry/interfaces/InputController.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InputController = exports.INPUTS = void 0;
+const schema_js_1 = require("../schema.js");
+const types_js_1 = require("../types.js");
+/** alexa-inputcontroller.html, "Input property values". */
+exports.INPUTS = [
+    "AUX 1", "AUX 2", "AUX 3", "AUX 4", "AUX 5", "AUX 6", "AUX 7", "BLURAY", "CABLE", "CD", "COAX 1", "COAX 2",
+    "COMPOSITE 1", "DVD", "GAME", "HD RADIO", "HDMI 1", "HDMI 2", "HDMI 3", "HDMI 4", "HDMI 5", "HDMI 6", "HDMI 7",
+    "HDMI 8", "HDMI 9", "HDMI 10", "HDMI ARC", "INPUT 1", "INPUT 2", "INPUT 3", "INPUT 4", "INPUT 5", "INPUT 6",
+    "INPUT 7", "INPUT 8", "INPUT 9", "INPUT 10", "IPOD", "LINE 1", "LINE 2", "LINE 3", "LINE 4", "LINE 5", "LINE 6",
+    "LINE 7", "MEDIA PLAYER", "OPTICAL 1", "OPTICAL 2", "PHONO", "PLAYSTATION", "PLAYSTATION 3", "PLAYSTATION 4",
+    "SATELLITE", "SMARTCAST", "TUNER", "TV", "USB DAC", "VIDEO 1", "VIDEO 2", "VIDEO 3", "XBOX",
+];
+const input = schema_js_1.s.oneOf(exports.INPUTS, "an input like HDMI 1");
+/**
+ * The input a TV or a receiver shows. The inputs of the device are on the capability itself, as the discovery
+ * example of the page has them; its table calls them a configuration object.
+ */
+exports.InputController = (0, types_js_1.defineInterface)({
+    namespace: "Alexa.InputController",
+    version: "3",
+    doc: "https://developer.amazon.com/docs/alexaplus/device-apis/alexa-inputcontroller.html",
+    kind: "controller",
+    tier: 2,
+    instanced: false,
+    properties: {
+        input: { name: "input", value: input },
+    },
+    directives: {
+        SelectInput: { name: "SelectInput", payload: schema_js_1.s.object({ input }) },
+    },
+    options: schema_js_1.s.object({
+        /** friendlyNames: what the user calls the input, "Cable" for HDMI 2. */
+        inputs: schema_js_1.s.array(schema_js_1.s.object({ name: input, friendlyNames: schema_js_1.s.optional(schema_js_1.s.array(schema_js_1.s.string({ min: 1 }))) }, { unknownKeys: "reject" }), { min: 1 }),
+    }, { unknownKeys: "reject" }),
+    // A capability declared the 1.x way has no inputs; check() says so
+    discovery: ({ options: { inputs } }) => (inputs ? { topLevel: { inputs } } : {}),
+    validate(capability) {
+        const names = capability.options.inputs.map(({ name }) => name);
+        const called = capability.options.inputs.flatMap(({ friendlyNames = [] }) => friendlyNames);
+        const lists = [names, called];
+        for (const list of lists) {
+            const twice = list.find((entry, i) => list.indexOf(entry) !== i);
+            if (twice)
+                throw new types_js_1.DeclarationError(capability, `${twice} is listed twice, a name stands for one input`);
+        }
+    },
+});

dist/cjs/registry/interfaces/PlaybackController.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PlaybackController = void 0;
+const schema_js_1 = require("../schema.js");
+const types_js_1 = require("../types.js");
+// In the order of the discovery example
+const OPERATIONS = ["Play", "Pause", "Stop", "Next", "Previous", "FastForward", "Rewind", "StartOver"];
+// Alexa sends the operations the capability lists
+const operation = (name) => ({
+    name,
+    payload: schema_js_1.s.object({}),
+    when: ({ options }) => (options.supportedOperations ?? OPERATIONS).includes(name),
+});
+/**
+ * Play, pause and the other buttons of a player. The interface reports nothing: what plays is the playbackState of
+ * Alexa.PlaybackStateReporter, which a Response to these directives has in its context. Errors of a video device go
+ * under Alexa.Video, the others under Alexa.
+ */
+exports.PlaybackController = (0, types_js_1.defineInterface)({
+    namespace: "Alexa.PlaybackController",
+    version: "3",
+    doc: "https://developer.amazon.com/docs/alexaplus/device-apis/alexa-playbackcontroller.html",
+    kind: "controller",
+    tier: 2,
+    instanced: false,
+    properties: {},
+    directives: {
+        Play: operation("Play"),
+        Pause: operation("Pause"),
+        Stop: operation("Stop"),
+        Next: operation("Next"),
+        Previous: operation("Previous"),
+        FastForward: operation("FastForward"),
+        Rewind: operation("Rewind"),
+        StartOver: operation("StartOver"),
+    },
+    options: schema_js_1.s.object({
+        /** Default: all eight. */
+        supportedOperations: schema_js_1.s.optional(schema_js_1.s.array(schema_js_1.s.enum(...OPERATIONS), { min: 1 })),
+    }, { unknownKeys: "reject" }),
+    // The example has a properties object without fields, which topLevel puts where properties: false left none
+    discovery: ({ options: { supportedOperations = [...OPERATIONS] } }) => ({
+        properties: false,
+        topLevel: { properties: {}, supportedOperations },
+    }),
+});

dist/cjs/registry/interfaces/PlaybackStateReporter.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PlaybackStateReporter = void 0;
+const schema_js_1 = require("../schema.js");
+const types_js_1 = require("../types.js");
+/** What a player is doing, for an endpoint with Alexa.PlaybackController. Documented on the page of that interface. */
+exports.PlaybackStateReporter = (0, types_js_1.defineInterface)({
+    namespace: "Alexa.PlaybackStateReporter",
+    version: "3",
+    doc: "https://developer.amazon.com/docs/alexaplus/device-apis/alexa-playbackcontroller.html",
+    kind: "sensor",
+    tier: 2,
+    instanced: false,
+    properties: {
+        playbackState: { name: "playbackState", value: schema_js_1.s.object({ state: schema_js_1.s.enum("PLAYING", "PAUSED", "STOPPED") }) },
+    },
+    directives: {},
+});

dist/cjs/registry/interfaces/Speaker.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Speaker = void 0;
+const schema_js_1 = require("../schema.js");
+const types_js_1 = require("../types.js");
+/** A speaker that can be set to a volume from 0 to 100. One that only takes steps is an Alexa.StepSpeaker. */
+exports.Speaker = (0, types_js_1.defineInterface)({
+    namespace: "Alexa.Speaker",
+    version: "3",
+    doc: "https://developer.amazon.com/docs/alexaplus/device-apis/alexa-speaker.html",
+    kind: "controller",
+    tier: 2,
+    instanced: false,
+    properties: {
+        volume: { name: "volume", value: schema_js_1.s.number({ min: 0, max: 100, integer: true }) },
+        muted: { name: "muted", value: schema_js_1.s.boolean() },
+    },
+    directives: {
+        SetVolume: { name: "SetVolume", payload: schema_js_1.s.object({ volume: schema_js_1.s.number({ min: 0, max: 100, integer: true }) }) },
+        AdjustVolume: {
+            name: "AdjustVolume",
+            payload: schema_js_1.s.object({ volume: schema_js_1.s.number({ min: -100, max: 100, integer: true }), volumeDefault: schema_js_1.s.boolean() }),
+            note: "volume is the change. volumeDefault is true when the user named no amount",
+        },
+        SetMute: { name: "SetMute", payload: schema_js_1.s.object({ mute: schema_js_1.s.boolean() }) },
+    },
+});

dist/cjs/registry/interfaces/StepSpeaker.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StepSpeaker = void 0;
+const schema_js_1 = require("../schema.js");
+const types_js_1 = require("../types.js");
+/**
+ * A speaker that is turned up and down by steps and does not know its volume. It reports nothing: the capability
+ * has no properties object in discovery.
+ */
+exports.StepSpeaker = (0, types_js_1.defineInterface)({
+    namespace: "Alexa.StepSpeaker",
+    version: "3",
+    doc: "https://developer.amazon.com/docs/alexaplus/device-apis/alexa-stepspeaker.html",
+    kind: "controller",
+    tier: 2,
+    instanced: false,
+    properties: {},
+    directives: {
+        AdjustVolume: {
+            name: "AdjustVolume",
+            payload: schema_js_1.s.object({ volumeSteps: schema_js_1.s.number({ min: -100, max: 100, integer: true }) }),
+            note: "above 0 louder, below 0 quieter",
+        },
+        SetMute: { name: "SetMute", payload: schema_js_1.s.object({ mute: schema_js_1.s.boolean() }) },
+    },
+    discovery: () => ({ properties: false }),
+});

dist/cjs/registry/interfaces/stubs.js

@@ -4,7 +4,7 @@ exports.STUBS = void 0;
 // Interfaces without a descriptor of their own. A stub names the interface with the version and the properties
 // alex2node 1.5.2 put in discovery, so an endpoint that declares one is announced as before. Nothing about it is
 // checked, and the version is the one 1.5.2 sent, which is not always the one on the page of the interface
-// (Alexa.Speaker is "3" there). A row leaves this table when a descriptor is written from that page.
+// (Alexa.Cooking is "3" there). A row leaves this table when a descriptor is written from that page.
 const schema_js_1 = require("../schema.js");
 const DEVICE_APIS = "https://developer.amazon.com/docs/alexaplus/device-apis";
 const LIST_OF_INTERFACES = `${DEVICE_APIS}/list-of-interfaces.html`;
@@ -20,7 +20,6 @@ const TABLE = [
     // 1.5.2 announced the version "UNKNOWN"; 1.7 is what the list of interfaces gives
     ["Alexa.Camera.LiveViewController", "1.7", [], LIST_OF_INTERFACES],
     ["Alexa.CameraStreamController", "3", [], "alexa-camerastreamcontroller.html"],
-    ["Alexa.ChannelController", "3", ["channel"], "alexa-channelcontroller.html"],
     ["Alexa.Commissionable", "1", [], "alexa-commissionable.html"],
     ["Alexa.ConsentManagement.ConsentRequiredReporter", "1", [], "alexa-consentrequiredreporter.html"],
     ["Alexa.Cooking", "1", [], "alexa-cooking.html"],
@@ -34,8 +33,6 @@ const TABLE = [
     ["Alexa.DeviceUsage.Estimation", "1", [], "alexa-deviceusage-estimation.html"],
     ["Alexa.DeviceUsage.Meter", "1", [], "alexa-deviceusage-meter.html"],
     ["Alexa.DoorbellEventSource", "3", [], "alexa-doorbelleventsource.html"],
-    ["Alexa.EqualizerController", "1", [], "alexa-equalizercontroller.html"],
-    ["Alexa.InputController", "3", [], "alexa-inputcontroller.html"],
     ["Alexa.InventoryLevelSensor", "1", [], "alexa-inventorylevelsensor.html"],
     ["Alexa.InventoryLevelUsageSensor", "1", [], "alexa-inventorylevelusagesensor.html"],
     ["Alexa.InventoryUsageSensor", "1", [], "alexa-inventoryusagesensor.html"],
@@ -44,8 +41,6 @@ const TABLE = [
     ["Alexa.Media.PlayQueue", "1", [], "alexa-media-playqueue.html"],
     ["Alexa.Media.Playback", "1", [], "alexa-media-playback.html"],
     ["Alexa.Media.Search", "1", [], "alexa-media-search.html"],
-    ["Alexa.PlaybackController", "3", [], "alexa-playbackcontroller.html"],
-    ["Alexa.PlaybackStateReporter", "1", [], "alexa-playbackcontroller.html"],
     ["Alexa.ProactiveNotificationSource", "1", [], "alexa-proactivenotificationsource.html"],
     ["Alexa.RTCSessionController", "1", [], "alexa-rtcsessioncontroller.html"],
     ["Alexa.RecordController", "3", [], "alexa-recordcontroller.html"],
@@ -56,8 +51,6 @@ const TABLE = [
     ["Alexa.SimpleEventSource", "1", [], "alexa-simpleeventsource.html"],
     ["Alexa.SmartVision.ObjectDetectionSensor", "1", [], "alexa-smartvision-objectdetectionsensor.html"],
     ["Alexa.SmartVision.SnapshotProvider", "1", [], "alexa-smartvision-snapshotprovider.html"],
-    ["Alexa.Speaker", "1", [], "alexa-speaker.html"],
-    ["Alexa.StepSpeaker", "1", [], "alexa-stepspeaker.html"],
     ["Alexa.ThermostatController.Configuration", "1", [], "alexa-thermostatcontroller-configuration.html"],
     ["Alexa.ThermostatController.HVAC.Components", "1", [], "alexa-thermostatcontroller-hvac-components.html"],
     // "UNKNOWN" in 1.5.2 as well; the page is titled "Interface 3"