// Friendly names: what the user calls an instance, a mode or a preset (resources-and-assets.html).
import { ASSETS, RESERVED_WORDS } from "./catalog.js";
import { at, mismatch, s, SchemaError } from "./schema.js";
/** A friendly name as text, in one locale. */
export 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. */
export function asset(assetId) {
    return { "@type": "asset", value: { assetId } };
}
const LOCALE = /^[a-z]{2}-[A-Z]{2}$/;
const textValue = s.object({
    text: s.string({ min: 1 }),
    locale: s.string({ pattern: LOCALE, expects: "a locale like en-US" }),
});
const assetValue = s.object({ assetId: s.oneOf(ASSETS, "an id of the global Alexa catalog, like Alexa.Setting.Opening") });
const typed = s.object({ "@type": s.enum("text", "asset"), value: s.unknown() });
const reserved = RESERVED_WORDS;
/** One friendly name. An asset has to be in the catalog, a text must not be a word Alexa keeps for itself. */
export const label = {
    expects: "a friendly name, from text() or asset()",
    parse(input, path = "") {
        if (typeof input !== "object" || input === null)
            throw mismatch(path, label.expects, input);
        const { "@type": type, value } = typed.parse(input, path);
        if (type === "asset")
            return { "@type": type, value: assetValue.parse(value, at(path, "value")) };
        const named = textValue.parse(value, at(path, "value"));
        if (reserved.includes(named.text.trim().toLowerCase())) {
            throw new SchemaError(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. */
export const labels = s.array(label, { min: 1 });
/** What the user is shown for a friendly name: the text, or the id of the asset. */
export function shownAs(name) {
    return name["@type"] === "text" ? name.value.text : name.value.assetId;
}