discovery: generate capability JSON from the registry
A capability is a descriptor plus what the endpoint declares (device/Capability.ts), and its discovery object is
generated from the two. The new API is bridge.addDevice({ endpointId, name, categories, ... }) and
device.add(PowerController, options): both throw a DeclarationError that names the endpoint, the interface and
the instance (device/validate.ts), and leave the bridge and the device as they were. AlexaInterface is the same
Capability with the 1.x methods on it; it, ActionMapping and the enums moved to src/compat/, Device to src/device/.
What a 1.x caller can observe:
- every endpoint ends with { type: "AlexaInterface", interface: "Alexa", version: "3" } (alexa-interface.html);
new Alex2MQTT(..., { alexaInterface: false }) leaves it out
- the fields of a capability object come in the order of Amazon's examples; their content is unchanged
- addCapability() with a name that is not an interface throws (1.5.2 announced it with the version "UNKNOWN")
- ActionMapping takes the payload as an object; a JSON string is parsed (1.5.2 sent the string), any other throws
- what Alexa would reject in a 1.x declaration is not refused: device.check() lists it and the bridge logs each
line once, as "warning: ..." through the log hook, when it answers a discovery
- a device whose JSON cannot be built is left out of the answer and reported as an error event
- PowerController and EndpointHealth are the descriptors and keep ON/OFF and OK/UNREACHABLE; PowerState is new
Tests: six zoo devices declared the 1.x way give the JSON that Alexa accepted from 1.5.2 on 2026-09-28, plus the
Alexa capability. npm test: 85 pass (was 57) in 10-12 s, also on Node 18.20.8 and 20.20.2.
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
This commit is contained in:
parent
aa0ffd64ea
commit
c492ef74d1
90 changed files with 5539 additions and 1760 deletions
15
dist/cjs/registry/interfaces/stubs.js
vendored
15
dist/cjs/registry/interfaces/stubs.js
vendored
|
|
@ -80,6 +80,20 @@ const TABLE = [
|
|||
["Alexa.VideoRecorder", "1", [], "alexa-videorecorder.html"],
|
||||
["Alexa.WakeOnLANController", "1", [], "alexa-wakeonlancontroller.html"],
|
||||
];
|
||||
// What 1.5.2 added to the capability object of three of them
|
||||
const EXTRAS = {
|
||||
// No properties object; supportsDeactivation and proactivelyReported on the capability itself
|
||||
"Alexa.SceneController": ({ proactivelyReported }) => ({
|
||||
properties: false,
|
||||
topLevel: { supportsDeactivation: true, proactivelyReported },
|
||||
}),
|
||||
"Alexa.ThermostatController": () => ({
|
||||
configuration: { supportedModes: ["HEAT", "COOL", "AUTO", "OFF"], supportsScheduling: false },
|
||||
}),
|
||||
"Alexa.ModeController": ({ options }) => (options.supportedModes?.length > 0
|
||||
? { configuration: { ordered: true, supportedModes: options.supportedModes } }
|
||||
: {}),
|
||||
};
|
||||
function kindOf(namespace) {
|
||||
if (namespace.endsWith("Sensor"))
|
||||
return "sensor";
|
||||
|
|
@ -97,6 +111,7 @@ function stub([namespace, version, properties, page]) {
|
|||
instanced: false,
|
||||
properties: Object.fromEntries(properties.map((name) => [name, { name, value: schema_js_1.s.unknown() }])),
|
||||
directives: {},
|
||||
discovery: EXTRAS[namespace],
|
||||
};
|
||||
}
|
||||
exports.STUBS = TABLE.map(stub);
|
||||
|
|
|
|||
45
dist/cjs/registry/resources.js
vendored
Normal file
45
dist/cjs/registry/resources.js
vendored
Normal file
|
|
@ -0,0 +1,45 @@
|
|||
"use strict";
|
||||
Object.defineProperty(exports, "__esModule", { value: true });
|
||||
exports.labels = exports.label = void 0;
|
||||
exports.text = text;
|
||||
exports.asset = asset;
|
||||
exports.shownAs = shownAs;
|
||||
// Friendly names: what the user calls an instance, a mode or a preset (resources-and-assets.html).
|
||||
const catalog_js_1 = require("./catalog.js");
|
||||
const schema_js_1 = require("./schema.js");
|
||||
/** A friendly name as text, in one locale. */
|
||||
function text(name, locale = "en-US") {
|
||||
return { "@type": "text", value: { text: name, locale } };
|
||||
}
|
||||
/** A friendly name from the global Alexa catalog: one id, several names, every language Alexa speaks. */
|
||||
function asset(assetId) {
|
||||
return { "@type": "asset", value: { assetId } };
|
||||
}
|
||||
const LOCALE = /^[a-z]{2}-[A-Z]{2}$/;
|
||||
const textValue = schema_js_1.s.object({
|
||||
text: schema_js_1.s.string({ min: 1 }),
|
||||
locale: schema_js_1.s.string({ pattern: LOCALE, expects: "a locale like en-US" }),
|
||||
});
|
||||
const assetValue = schema_js_1.s.object({ assetId: schema_js_1.s.oneOf(catalog_js_1.ASSETS, "an id of the global Alexa catalog, like Alexa.Setting.Opening") });
|
||||
const typed = schema_js_1.s.object({ "@type": schema_js_1.s.enum("text", "asset"), value: schema_js_1.s.unknown() });
|
||||
const reserved = catalog_js_1.RESERVED_WORDS;
|
||||
/** One friendly name. An asset has to be in the catalog, a text must not be a word Alexa keeps for itself. */
|
||||
exports.label = {
|
||||
expects: "a friendly name, from text() or asset()",
|
||||
parse(input, path = "") {
|
||||
const { "@type": type, value } = typed.parse(input, path);
|
||||
if (type === "asset")
|
||||
return { "@type": type, value: assetValue.parse(value, (0, schema_js_1.at)(path, "value")) };
|
||||
const named = textValue.parse(value, (0, schema_js_1.at)(path, "value"));
|
||||
if (reserved.includes(named.text.trim().toLowerCase())) {
|
||||
throw new schema_js_1.SchemaError((0, schema_js_1.at)(path, "value.text"), `${JSON.stringify(named.text)} is a reserved word, not to be used as a friendly name`);
|
||||
}
|
||||
return { "@type": type, value: named };
|
||||
},
|
||||
};
|
||||
/** The friendly names of an instance, a mode or a preset: at least one. */
|
||||
exports.labels = schema_js_1.s.array(exports.label, { min: 1 });
|
||||
/** What the user is shown for a friendly name: the text, or the id of the asset. */
|
||||
function shownAs(name) {
|
||||
return name["@type"] === "text" ? name.value.text : name.value.assetId;
|
||||
}
|
||||
17
dist/cjs/registry/schema.js
vendored
17
dist/cjs/registry/schema.js
vendored
|
|
@ -3,7 +3,8 @@
|
|||
// and declaration options with these; parse() returns the value or throws a SchemaError that names where it went
|
||||
// wrong. Written here rather than taken from a package: mqtt stays the only runtime dependency.
|
||||
Object.defineProperty(exports, "__esModule", { value: true });
|
||||
exports.s = exports.SchemaError = void 0;
|
||||
exports.s = exports.at = exports.SchemaError = void 0;
|
||||
exports.mismatch = mismatch;
|
||||
/** A value that does not fit its schema: path is where ("payload.targetSetpoint.scale"), problem is what. */
|
||||
class SchemaError extends Error {
|
||||
constructor(path, problem) {
|
||||
|
|
@ -23,10 +24,13 @@ function shown(input) {
|
|||
const text = JSON.stringify(input) ?? String(input);
|
||||
return text.length > 60 ? `${text.slice(0, 57)}...` : text;
|
||||
}
|
||||
/** The error of a value that is not what a schema expects. */
|
||||
function mismatch(path, expects, input) {
|
||||
return new SchemaError(path, `expected ${expects}, got ${shown(input)}`);
|
||||
}
|
||||
/** The path of a key of the object at path. */
|
||||
const at = (path, key) => (path ? `${path}.${key}` : key);
|
||||
exports.at = at;
|
||||
function isRecord(input) {
|
||||
return typeof input === "object" && input !== null && !Array.isArray(input);
|
||||
}
|
||||
|
|
@ -69,7 +73,11 @@ function literal(value) {
|
|||
return schema(JSON.stringify(value), (input) => input === value);
|
||||
}
|
||||
function enumeration(...values) {
|
||||
return { ...schema(values.join(" | "), (input) => values.includes(input)), values };
|
||||
return oneOf(values, values.join(" | "));
|
||||
}
|
||||
/** One of a list too long to print in an error message: expects says what the list is. */
|
||||
function oneOf(values, expects) {
|
||||
return { ...schema(expects, (input) => values.includes(input)), values };
|
||||
}
|
||||
function unknown() {
|
||||
return schema("any value", () => true);
|
||||
|
|
@ -127,11 +135,11 @@ function object(shape, rules = {}) {
|
|||
throw mismatch(path, expects, input);
|
||||
const others = Object.keys(input).filter((key) => !known.includes(key));
|
||||
if (others.length > 0 && rules.unknownKeys === "reject") {
|
||||
throw new SchemaError(at(path, others[0]), `unknown key, the known ones are ${known.join(", ") || "none"}`);
|
||||
throw new SchemaError((0, exports.at)(path, others[0]), `unknown key, the known ones are ${known.join(", ") || "none"}`);
|
||||
}
|
||||
const parsed = {};
|
||||
for (const key of known) {
|
||||
const value = shape[key].parse(input[key], at(path, key));
|
||||
const value = shape[key].parse(input[key], (0, exports.at)(path, key));
|
||||
if (value !== undefined)
|
||||
parsed[key] = value;
|
||||
}
|
||||
|
|
@ -178,6 +186,7 @@ exports.s = {
|
|||
boolean,
|
||||
literal,
|
||||
enum: enumeration,
|
||||
oneOf,
|
||||
unknown,
|
||||
optional,
|
||||
nullable,
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue