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>
47 lines
2.3 KiB
JavaScript
47 lines
2.3 KiB
JavaScript
"use strict";
|
|
// The JSON examples of Amazon's interface pages. test/fixtures/alexa-docs/<page>/ holds the examples of
|
|
// https://developer.amazon.com/docs/alexaplus/device-apis/<page>.html as the page printed them on 2026-09-28, one
|
|
// file per example, named after the heading it stands under.
|
|
const fs = require("node:fs");
|
|
const path = require("node:path");
|
|
|
|
const DOCS = path.join(__dirname, "..", "fixtures", "alexa-docs");
|
|
|
|
/** One example: doc("alexa-powercontroller", "TurnOn.directive"). */
|
|
function doc(page, name) {
|
|
return JSON.parse(fs.readFileSync(path.join(DOCS, page, `${name}.json`), "utf8"));
|
|
}
|
|
|
|
/** The names of the examples of a page that end in suffix: examples("alexa-powercontroller", ".directive"). */
|
|
function examples(page, suffix = "") {
|
|
return fs.readdirSync(path.join(DOCS, page))
|
|
.filter((file) => file.endsWith(`${suffix}.json`))
|
|
.map((file) => file.slice(0, -".json".length))
|
|
.sort();
|
|
}
|
|
|
|
/** The capability objects of one interface in a discovery example, in the order of the example. */
|
|
function capabilities(page, namespace, name = "discovery") {
|
|
const [endpoint] = doc(page, name).event.payload.endpoints;
|
|
return endpoint.capabilities.filter((capability) => capability.interface === namespace);
|
|
}
|
|
|
|
/**
|
|
* Every value of a property of one interface that the examples of a page show, as { example, property }: what the
|
|
* Response, StateReport and ChangeReport examples report, and the property examples of the page itself.
|
|
*/
|
|
function reported(page, namespace) {
|
|
const found = [];
|
|
for (const example of examples(page)) {
|
|
const { event, context, ...property } = doc(page, example);
|
|
if (example.endsWith(".property")) found.push({ example, property: { namespace, ...property } });
|
|
if (!event) continue;
|
|
const change = event.payload && event.payload.change;
|
|
// Several ChangeReport examples print the context as one property instead of { properties: [...] }
|
|
const contextProperties = context && (context.properties || (context.namespace ? [context] : []));
|
|
found.push(...[...(change ? change.properties : []), ...(contextProperties || [])].map((each) => ({ example, property: each })));
|
|
}
|
|
return found.filter(({ property }) => property.namespace === namespace);
|
|
}
|
|
|
|
module.exports = { doc, examples, capabilities, reported };
|