import type { DirectiveHandler } from "../dispatcher.js"; import { s } from "../registry/schema.js"; import type { Infer } from "../registry/schema.js"; import { DeclarationError } from "../registry/types.js"; import type { Declared, Directives, InterfaceDescriptor, Label, Properties, Semantics, } from "../registry/types.js"; /** What a declaration can set for any interface. */ export interface CommonOptions { /** The name of the instance of a generic controller: "Blind.Lift", "Fan.Speed". */ instance?: string; /** What the user calls the instance; the first name is the one the Alexa app shows. */ friendlyNames?: Label[]; /** The properties are in the answer to ReportState. Default: true. */ retrievable?: boolean; /** A change of the properties is sent to Alexa as a ChangeReport. Default: false. */ proactivelyReported?: boolean; /** The user can ask for the properties and cannot set them. Left out of discovery when not given. */ nonControllable?: boolean; } /** The same as a schema. The friendly names are checked with the instance, by the rules of the interface. */ export const commonOptions = s.object({ instance: s.optional(s.string()), friendlyNames: s.optional(s.array(s.unknown())), retrievable: s.optional(s.boolean()), proactivelyReported: s.optional(s.boolean()), nonControllable: s.optional(s.boolean()), }); type Naming = I extends true ? { instance: string; friendlyNames: Label[] } : { instance?: string; friendlyNames?: Label[] }; /** The options of device.add() for one interface: its own, and the ones every interface has. */ export type Declaration = O & Omit & Naming; /** A capability object of a discovery answer (alexa-discovery-objects.html, "Capability object"). */ export interface CapabilityJson { type: "AlexaInterface"; interface: string; instance?: string; version: string; properties?: { supported: Array<{ name: string }>; proactivelyReported: boolean; retrievable: boolean; nonControllable?: boolean; }; capabilityResources?: { friendlyNames: Label[] }; configuration?: Record; configurations?: Record; semantics?: Semantics; [field: string]: unknown; } /** One interface as an endpoint declares it: the descriptor, and what the declaration says about this endpoint. */ export class Capability

implements Declared { /** The endpoint the capability is declared on; the device sets it. */ endpointId = ""; /** "" for an interface without instances. */ instance: string; friendlyNames: Label[]; retrievable: boolean; proactivelyReported: boolean; nonControllable?: boolean; /** The options of the interface: a range, the supported modes, the semantics. */ options: O; /** What the bridge logs about the declaration, once, when it answers a discovery. */ readonly notes: string[] = []; private readonly handlers = new Map>(); constructor(readonly descriptor: InterfaceDescriptor, declared: CommonOptions & { options: O }) { this.instance = declared.instance ?? ""; this.friendlyNames = declared.friendlyNames ?? []; this.retrievable = declared.retrievable ?? true; this.proactivelyReported = declared.proactivelyReported ?? false; this.nonControllable = declared.nonControllable; this.options = declared.options; } get namespace(): string { return this.descriptor.namespace; } /** * What the device does on a directive of the interface: * * lift.on("SetRangeValue", async (ctx) => { await motor.moveTo(ctx.payload.rangeValue); return ctx.respond(); }); * * "*" is the handler of every directive that has none of its own. A handler that throws answers the directive * with an ErrorResponse: the AlexaError it threw, INTERNAL_ERROR for anything else. Throws a DeclarationError * for a name that is not a directive of the interface. */ on(name: K, handler: DirectiveHandler>): this; on(name: "*", handler: DirectiveHandler): this; on(name: string, handler: DirectiveHandler): this { const names = Object.keys(this.descriptor.directives); // An interface the library only names (tier 3) describes no directive: any name is taken if (name !== "*" && this.descriptor.tier !== 3 && !names.includes(name)) { throw new DeclarationError(this, `${name} is not a directive of the interface, which has ${names.join(", ") || "none"}`); } if (typeof handler !== "function") throw new DeclarationError(this, `the handler of ${name} is a function`); this.handlers.set(name, handler); return this; } /** The handler on(name) registered, or the one of "*". */ handlerFor(name: string): DirectiveHandler | undefined { return this.handlers.get(name) ?? this.handlers.get("*"); } /** Mappings of "open", "close", "raise", "lower" and of states, when the declaration has any. */ get semantics(): Semantics | undefined { const { semantics } = this.options as { semantics?: Semantics }; const mapped = (semantics?.actionMappings?.length ?? 0) + (semantics?.stateMappings?.length ?? 0); return mapped > 0 ? semantics : undefined; } /** The capability object for discovery, its fields in the order of the example on alexa-discovery-objects.html. */ toJSON(): CapabilityJson { const { descriptor, semantics } = this; const extras = descriptor.discovery ? descriptor.discovery(this) : {}; const json: CapabilityJson = { type: "AlexaInterface", interface: descriptor.namespace, ...(this.instance ? { instance: this.instance } : {}), version: descriptor.version, }; if (extras.properties !== false) { json.properties = { supported: Object.keys(descriptor.properties).map((name) => ({ name })), proactivelyReported: this.proactivelyReported, retrievable: this.retrievable, }; if (this.nonControllable !== undefined) json.properties.nonControllable = this.nonControllable; } if (this.friendlyNames.length > 0) json.capabilityResources = { friendlyNames: this.friendlyNames }; if (extras.configuration) json.configuration = extras.configuration; if (extras.configurations) json.configurations = extras.configurations; if (semantics) json.semantics = semantics; return { ...json, ...extras.topLevel }; } } export type AnyCapability = Capability;