Alex2Node/dist/cjs/registry/interfaces/ModeController.js

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.ModeController = void 0;
const resources_js_1 = require("../resources.js");
const schema_js_1 = require("../schema.js");
const semantics_js_1 = require("../semantics.js");
const types_js_1 = require("../types.js");
const directives = {
    SetMode: { name: "SetMode", payload: schema_js_1.s.object({ mode: schema_js_1.s.string({ min: 1 }) }) },
    AdjustMode: {
        name: "AdjustMode",
        payload: schema_js_1.s.object({ modeDelta: schema_js_1.s.optional(schema_js_1.s.number({ integer: true })) }),
        // alexa-modecontroller.html, "Capabilities object": "Modes that have an order support the AdjustMode directive."
        when: ({ options }) => options.ordered === true,
        note: "modeDelta is the number of modes to move by, 1 when it is left out",
    },
};
// A mode is declared as { value, friendlyNames }. The object of discovery and of 1.x, { value, modeResources:
// { friendlyNames } }, is taken as well.
const eitherForm = schema_js_1.s.object({
    value: schema_js_1.s.string({ min: 1 }),
    friendlyNames: schema_js_1.s.optional(schema_js_1.s.unknown()),
    modeResources: schema_js_1.s.optional(schema_js_1.s.object({ friendlyNames: schema_js_1.s.unknown() })),
}, { unknownKeys: "reject" });
const mode = {
    expects: "a mode { value, friendlyNames }",
    parse(input, path = "") {
        if (typeof input !== "object" || input === null)
            throw (0, schema_js_1.mismatch)(path, mode.expects, input);
        const { value, friendlyNames, modeResources } = eitherForm.parse(input, path);
        const named = friendlyNames === undefined && modeResources ? "modeResources.friendlyNames" : "friendlyNames";
        return { value, friendlyNames: resources_js_1.labels.parse(friendlyNames ?? modeResources?.friendlyNames, (0, schema_js_1.at)(path, named)) };
    },
};
/**
 * One of a list of values, under an instance name: the wash cycle of a washer, the position of a garage door. Amazon
 * certifies a garage door only with this interface and the display category GARAGE_DOOR.
 */
exports.ModeController = (0, types_js_1.defineInterface)({
    namespace: "Alexa.ModeController",
    version: "3",
    doc: "https://developer.amazon.com/docs/alexaplus/device-apis/alexa-modecontroller.html",
    kind: "controller",
    tier: 1,
    instanced: true,
    properties: {
        mode: { name: "mode", value: schema_js_1.s.nullable(schema_js_1.s.string({ min: 1 })), note: "null when no mode is set, as when the device is off" },
    },
    directives,
    options: schema_js_1.s.object({
        /** At least two. When the modes have an order, in increasing order. */
        supportedModes: schema_js_1.s.array(mode, { min: 2 }),
        /** The modes have an order, cold to hot, and the user can say "increase": Alexa sends AdjustMode. Default: false. */
        ordered: schema_js_1.s.optional(schema_js_1.s.boolean()),
        semantics: schema_js_1.s.optional((0, semantics_js_1.semanticsOf)({ directives, stateValue: schema_js_1.s.string({ min: 1 }) })),
    }, { unknownKeys: "reject" }),
    // A capability declared the 1.x way may be without modes, or have modes without names
    discovery({ options: { supportedModes = [], ordered = false } }) {
        if (supportedModes.length === 0)
            return {};
        const modes = supportedModes.map(({ value, friendlyNames = [] }) => (friendlyNames.length > 0 ? { value, modeResources: { friendlyNames } } : { value }));
        return { configuration: { ordered, supportedModes: modes } };
    },
    validate(capability) {
        const { supportedModes, ordered = false, semantics } = capability.options;
        const values = supportedModes.map(({ value }) => value);
        const twice = values.find((value, i) => values.indexOf(value) !== i);
        if (twice !== undefined)
            throw new types_js_1.DeclarationError(capability, `the mode ${twice} is listed twice`);
        const isMode = (value) => values.includes(value);
        for (const { directive } of semantics?.actionMappings ?? []) {
            if (directive.name === "AdjustMode" && !ordered) {
                throw new types_js_1.DeclarationError(capability, "an action is mapped to AdjustMode, which needs ordered: true");
            }
            if (directive.name === "SetMode" && !isMode(directive.payload?.mode)) {
                throw new types_js_1.DeclarationError(capability, `an action is mapped to SetMode ${directive.payload?.mode}, the modes are ${values.join(", ")}`);
            }
        }
        for (const mapping of semantics?.stateMappings ?? []) {
            if (mapping["@type"] === "StatesToValue" && !isMode(mapping.value)) {
                throw new types_js_1.DeclarationError(capability, `a state is mapped to ${mapping.value}, the modes are ${values.join(", ")}`);
            }
        }
    },
    errorNamespace: "Alexa.Safety",
    errorTypes: ["OBSTACLE_DETECTED", "SAFETY_BEAM_BREACHED"],
});