registry: describe an Alexa interface as data
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>
This commit is contained in:
parent
128ca35c2a
commit
aa0ffd64ea
93 changed files with 4058 additions and 490 deletions
166
dist/cjs/AlexaInterface.js
vendored
166
dist/cjs/AlexaInterface.js
vendored
|
|
@ -1,6 +1,7 @@
|
|||
"use strict";
|
||||
Object.defineProperty(exports, "__esModule", { value: true });
|
||||
exports.AlexaInterface = exports.AlexaInterfaceType = void 0;
|
||||
const index_js_1 = require("./registry/index.js");
|
||||
var AlexaInterfaceType;
|
||||
(function (AlexaInterfaceType) {
|
||||
AlexaInterfaceType["APPLICATION_STATE_REPORTER"] = "Alexa.ApplicationStateReporter";
|
||||
|
|
@ -103,170 +104,13 @@ class AlexaInterface {
|
|||
getTypeString() {
|
||||
return this.type;
|
||||
}
|
||||
/** The version of the interface, from its descriptor. "UNKNOWN" for a name the registry does not have. */
|
||||
getVersion() {
|
||||
switch (this.type) {
|
||||
case AlexaInterfaceType.APPLICATION_STATE_REPORTER:
|
||||
case AlexaInterfaceType.AUDIO_PLAY_QUEUE:
|
||||
case AlexaInterfaceType.AUTHORIZATION_CONTROLLER:
|
||||
case AlexaInterfaceType.AUTOMATION_MANAGEMENT:
|
||||
case AlexaInterfaceType.AUTOMOTIVE_VEHICLE_DATA:
|
||||
case AlexaInterfaceType.COMMISSIONABLE:
|
||||
case AlexaInterfaceType.CONSENT_MANAGEMENT_CONSENT_REQUIRED_REPORTER:
|
||||
case AlexaInterfaceType.COOKING:
|
||||
case AlexaInterfaceType.COOKING_FOOD_TEMPERATURE_CONTROLLER:
|
||||
case AlexaInterfaceType.COOKING_FOOD_TEMPERATURE_SENSOR:
|
||||
case AlexaInterfaceType.COOKING_PRESET_CONTROLLER:
|
||||
case AlexaInterfaceType.COOKING_TEMPERATURE_CONTROLLER:
|
||||
case AlexaInterfaceType.COOKING_TEMPERATURE_SENSOR:
|
||||
case AlexaInterfaceType.COOKING_TIME_CONTROLLER:
|
||||
case AlexaInterfaceType.DATA_CONTROLLER:
|
||||
case AlexaInterfaceType.DEVICE_USAGE_ESTIMATION:
|
||||
case AlexaInterfaceType.DEVICE_USAGE_METER:
|
||||
case AlexaInterfaceType.EQUALIZER_CONTROLLER:
|
||||
case AlexaInterfaceType.INVENTORY_LEVEL_SENSOR:
|
||||
case AlexaInterfaceType.INVENTORY_LEVEL_USAGE_SENSOR:
|
||||
case AlexaInterfaceType.INVENTORY_USAGE_SENSOR:
|
||||
case AlexaInterfaceType.KEYPAD_CONTROLLER:
|
||||
case AlexaInterfaceType.MEDIA_PLAYBACK:
|
||||
case AlexaInterfaceType.MEDIA_PLAY_QUEUE:
|
||||
case AlexaInterfaceType.MEDIA_SEARCH:
|
||||
case AlexaInterfaceType.PLAYBACK_STATE_REPORTER:
|
||||
case AlexaInterfaceType.PROACTIVE_NOTIFICATION_SOURCE:
|
||||
case AlexaInterfaceType.REMOTE_VIDEO_PLAYER:
|
||||
case AlexaInterfaceType.RTC_SESSION_CONTROLLER:
|
||||
case AlexaInterfaceType.SECURITY_PANEL_CONTROLLER:
|
||||
case AlexaInterfaceType.SECURITY_PANEL_CONTROLLER_ALERT:
|
||||
case AlexaInterfaceType.SIMPLE_EVENT_SOURCE:
|
||||
case AlexaInterfaceType.SMART_VISION_OBJECT_DETECTION_SENSOR:
|
||||
case AlexaInterfaceType.SMART_VISION_SNAPSHOT_PROVIDER:
|
||||
case AlexaInterfaceType.SPEAKER:
|
||||
case AlexaInterfaceType.STEP_SPEAKER:
|
||||
case AlexaInterfaceType.THERMOSTAT_CONTROLLER_CONFIGURATION:
|
||||
case AlexaInterfaceType.THERMOSTAT_CONTROLLER_HVAC_COMPONENTS:
|
||||
case AlexaInterfaceType.THERMOSTAT_CONTROLLER_SCHEDULE:
|
||||
case AlexaInterfaceType.UI_CONTROLLER:
|
||||
case AlexaInterfaceType.USER_PREFERENCE:
|
||||
case AlexaInterfaceType.VIDEO_RECORDER:
|
||||
case AlexaInterfaceType.WAKE_ON_LAN_CONTROLLER:
|
||||
return "1";
|
||||
case AlexaInterfaceType.BRIGHTNESS_CONTROLLER:
|
||||
case AlexaInterfaceType.CAMERA_STREAM_CONTROLLER:
|
||||
case AlexaInterfaceType.CHANNEL_CONTROLLER:
|
||||
case AlexaInterfaceType.COLOR_CONTROLLER:
|
||||
case AlexaInterfaceType.COLOR_TEMPERATURE_CONTROLLER:
|
||||
case AlexaInterfaceType.CONTACT_SENSOR:
|
||||
case AlexaInterfaceType.DOORBELL_EVENT_SOURCE:
|
||||
case AlexaInterfaceType.INPUT_CONTROLLER:
|
||||
case AlexaInterfaceType.LOCK_CONTROLLER:
|
||||
case AlexaInterfaceType.MODE_CONTROLLER:
|
||||
case AlexaInterfaceType.MOTION_SENSOR:
|
||||
case AlexaInterfaceType.PERCENTAGE_CONTROLLER:
|
||||
case AlexaInterfaceType.PLAYBACK_CONTROLLER:
|
||||
case AlexaInterfaceType.POWER_CONTROLLER:
|
||||
case AlexaInterfaceType.POWER_LEVEL_CONTROLLER:
|
||||
case AlexaInterfaceType.RANGE_CONTROLLER:
|
||||
case AlexaInterfaceType.RECORD_CONTROLLER:
|
||||
case AlexaInterfaceType.SCENE_CONTROLLER:
|
||||
case AlexaInterfaceType.SEEK_CONTROLLER:
|
||||
case AlexaInterfaceType.TEMPERATURE_SENSOR:
|
||||
case AlexaInterfaceType.TOGGLE_CONTROLLER:
|
||||
return "3";
|
||||
case AlexaInterfaceType.LAUNCHER:
|
||||
return "1.1";
|
||||
case AlexaInterfaceType.THERMOSTAT_CONTROLLER:
|
||||
return "3.2";
|
||||
case AlexaInterfaceType.ENDPOINT_HEALTH:
|
||||
return "3.3";
|
||||
default:
|
||||
return "UNKNOWN";
|
||||
}
|
||||
return index_js_1.registry.has(this.type) ? index_js_1.registry.get(this.type).version : "UNKNOWN";
|
||||
}
|
||||
/** The names of the properties the interface reports, from its descriptor. */
|
||||
getProps() {
|
||||
switch (this.type) {
|
||||
case AlexaInterfaceType.AUTOMATION_MANAGEMENT:
|
||||
return ["automationStatuses"];
|
||||
case AlexaInterfaceType.BRIGHTNESS_CONTROLLER:
|
||||
return ["brightness"];
|
||||
case AlexaInterfaceType.CHANNEL_CONTROLLER:
|
||||
return ["channel"];
|
||||
case AlexaInterfaceType.COLOR_CONTROLLER:
|
||||
return ["color"];
|
||||
case AlexaInterfaceType.COLOR_TEMPERATURE_CONTROLLER:
|
||||
return ["colorTemperatureInKelvin"];
|
||||
case AlexaInterfaceType.CONTACT_SENSOR:
|
||||
return ["detectionState"];
|
||||
case AlexaInterfaceType.POWER_CONTROLLER:
|
||||
return ["powerState"];
|
||||
case AlexaInterfaceType.ENDPOINT_HEALTH:
|
||||
return ["connectivity"];
|
||||
case AlexaInterfaceType.TOGGLE_CONTROLLER:
|
||||
return ["toggleState"];
|
||||
case AlexaInterfaceType.MODE_CONTROLLER:
|
||||
return ["mode"];
|
||||
case AlexaInterfaceType.TEMPERATURE_SENSOR:
|
||||
return ["temperature"];
|
||||
case AlexaInterfaceType.THERMOSTAT_CONTROLLER:
|
||||
return [
|
||||
"targetSetpoint",
|
||||
"lowerSetpoint",
|
||||
"upperSetpoint",
|
||||
"thermostatMode",
|
||||
];
|
||||
case AlexaInterfaceType.APPLICATION_STATE_REPORTER:
|
||||
case AlexaInterfaceType.AUDIO_PLAY_QUEUE:
|
||||
case AlexaInterfaceType.AUTHORIZATION_CONTROLLER:
|
||||
case AlexaInterfaceType.AUTOMOTIVE_VEHICLE_DATA:
|
||||
case AlexaInterfaceType.CAMERA_LIVE_VIEW_CONTROLLER:
|
||||
case AlexaInterfaceType.CAMERA_STREAM_CONTROLLER:
|
||||
case AlexaInterfaceType.COMMISSIONABLE:
|
||||
case AlexaInterfaceType.CONSENT_MANAGEMENT_CONSENT_REQUIRED_REPORTER:
|
||||
case AlexaInterfaceType.COOKING:
|
||||
case AlexaInterfaceType.DATA_CONTROLLER:
|
||||
case AlexaInterfaceType.DEVICE_USAGE_ESTIMATION:
|
||||
case AlexaInterfaceType.DEVICE_USAGE_METER:
|
||||
case AlexaInterfaceType.DOORBELL_EVENT_SOURCE:
|
||||
case AlexaInterfaceType.EQUALIZER_CONTROLLER:
|
||||
case AlexaInterfaceType.INPUT_CONTROLLER:
|
||||
case AlexaInterfaceType.INVENTORY_LEVEL_SENSOR:
|
||||
case AlexaInterfaceType.INVENTORY_LEVEL_USAGE_SENSOR:
|
||||
case AlexaInterfaceType.INVENTORY_USAGE_SENSOR:
|
||||
case AlexaInterfaceType.KEYPAD_CONTROLLER:
|
||||
case AlexaInterfaceType.LAUNCHER:
|
||||
case AlexaInterfaceType.LOCK_CONTROLLER:
|
||||
case AlexaInterfaceType.MEDIA_PLAYBACK:
|
||||
case AlexaInterfaceType.MEDIA_SEARCH:
|
||||
case AlexaInterfaceType.MOTION_SENSOR:
|
||||
case AlexaInterfaceType.PERCENTAGE_CONTROLLER:
|
||||
case AlexaInterfaceType.PLAYBACK_CONTROLLER:
|
||||
case AlexaInterfaceType.PLAYBACK_STATE_REPORTER:
|
||||
case AlexaInterfaceType.PROACTIVE_NOTIFICATION_SOURCE:
|
||||
case AlexaInterfaceType.RANGE_CONTROLLER:
|
||||
case AlexaInterfaceType.RECORD_CONTROLLER:
|
||||
case AlexaInterfaceType.REMOTE_VIDEO_PLAYER:
|
||||
case AlexaInterfaceType.RTC_SESSION_CONTROLLER:
|
||||
case AlexaInterfaceType.SCENE_CONTROLLER:
|
||||
return []; // scenes have no reportable properties: Activate/Deactivate answer with ActivationStarted (Device.sendSceneResponse)
|
||||
case AlexaInterfaceType.SECURITY_PANEL_CONTROLLER:
|
||||
case AlexaInterfaceType.SEEK_CONTROLLER:
|
||||
case AlexaInterfaceType.SIMPLE_EVENT_SOURCE:
|
||||
case AlexaInterfaceType.SMART_VISION_OBJECT_DETECTION_SENSOR:
|
||||
case AlexaInterfaceType.SMART_VISION_SNAPSHOT_PROVIDER:
|
||||
case AlexaInterfaceType.SPEAKER:
|
||||
case AlexaInterfaceType.STEP_SPEAKER:
|
||||
case AlexaInterfaceType.THERMOSTAT_CONTROLLER_CONFIGURATION:
|
||||
case AlexaInterfaceType.THERMOSTAT_CONTROLLER_HVAC_COMPONENTS:
|
||||
case AlexaInterfaceType.THERMOSTAT_CONTROLLER_SCHEDULE:
|
||||
case AlexaInterfaceType.TIME_HOLD_CONTROLLER:
|
||||
case AlexaInterfaceType.UI_CONTROLLER:
|
||||
case AlexaInterfaceType.USER_PREFERENCE:
|
||||
case AlexaInterfaceType.VIDEO_RECORDER:
|
||||
case AlexaInterfaceType.WAKE_ON_LAN_CONTROLLER:
|
||||
// no property list known for these: discovery lists the capability with an empty "supported" (the bridge notes
|
||||
// it through its log hook; 1.5.1 wrote "UNSUPORTED INTERFACE TYPE" to stderr on every discovery)
|
||||
return [];
|
||||
default:
|
||||
return [];
|
||||
}
|
||||
return index_js_1.registry.has(this.type) ? Object.keys(index_js_1.registry.get(this.type).properties) : [];
|
||||
}
|
||||
getJSON() {
|
||||
const doc = {
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue