David
aa0ffd64ea
src/registry/ holds what the library knows about an interface: namespace, version, the page it was read from, properties with their value schemas and directives with their payload schemas. Five interfaces are described (Alexa, PowerController, BrightnessController, TemperatureSensor, EndpointHealth); the other 65 names of AlexaInterfaceType are stubs with the version and property names of 1.5.2. schema.ts is the run-time check behind it (241 lines, no new dependency), catalog.ts the vocabularies of the pages: 103 assets (23 units), 6 actions, 9 states, 56 display categories, 22 reserved words, 73 error types under 11 namespaces. AlexaInterface.getVersion() and getProps() read the registry; the two switch statements are gone (-167 lines). On the wire: Alexa.EndpointHealth is announced at 3.1 (was 3.3; the page is titled 3.1 and no page mentions 3.3), and TimeHoldController and Camera.LiveViewController at 3 and 1.7 (1.5.2 sent the string "UNKNOWN"). DisplayCategory gains VACUUM. New exports: registry, DeclarationError, SchemaError, Assets, Units, Actions, States, DisplayCategories and the descriptor types. Tests: 20 JSON examples of the five pages under test/fixtures/alexa-docs; every directive payload and property value in them parses with its descriptor. npm test: 57 pass (was 30) in 10.8 s, also on Node 18.20.8 and 20.20.2. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
28 lines
1.2 KiB
JavaScript
28 lines
1.2 KiB
JavaScript
import { s } from "../schema.js";
|
|
import { defineInterface } from "../types.js";
|
|
export const PowerController = defineInterface({
|
|
namespace: "Alexa.PowerController",
|
|
version: "3",
|
|
doc: "https://developer.amazon.com/docs/alexaplus/device-apis/alexa-powercontroller.html",
|
|
kind: "controller",
|
|
tier: 1,
|
|
instanced: false,
|
|
properties: {
|
|
powerState: { name: "powerState", value: s.enum("ON", "OFF") },
|
|
},
|
|
directives: {
|
|
TurnOn: { name: "TurnOn", payload: s.object({}) },
|
|
TurnOff: { name: "TurnOff", payload: s.object({}) },
|
|
},
|
|
options: s.object({
|
|
// The directives Alexa asks the user to confirm before it sends them. Amazon supports this for devices in Japan
|
|
// only (alexa-discovery-objects.html, "VerificationsRequired object").
|
|
verificationsRequired: s.optional(s.array(s.enum("TurnOn", "TurnOff"), { min: 1 })),
|
|
}, { unknownKeys: "reject" }),
|
|
discovery({ options }) {
|
|
if (!options.verificationsRequired)
|
|
return {};
|
|
const confirmed = options.verificationsRequired.map((directive) => ({ directive, methods: [{ "@type": "Confirmation" }] }));
|
|
return { topLevel: { verificationsRequired: confirmed } };
|
|
},
|
|
});
|