custom-card-helpers/dist/types.d.ts

Set of helpful functions and types for Custom Card creators

import { HassEntities, HassConfig, Auth, Connection, MessageBase, HassServices, HassServiceTarget } from "home-assistant-js-websocket";
import { HapticType } from "./haptic";
import { HASSDomEvent } from "./fire-event";
export interface ToggleMenuActionConfig extends BaseActionConfig {
    action: "toggle-menu";
}
export interface ToggleActionConfig extends BaseActionConfig {
    action: "toggle";
}
export interface CallServiceActionConfig extends BaseActionConfig {
    action: "call-service";
    service: string;
    service_data?: {
        entity_id?: string | [string];
        [key: string]: any;
    };
    target?: HassServiceTarget;
    repeat?: number;
    haptic?: HapticType;
}
export interface NavigateActionConfig extends BaseActionConfig {
    action: "navigate";
    navigation_path: string;
}
export interface UrlActionConfig extends BaseActionConfig {
    action: "url";
    url_path: string;
}
export interface MoreInfoActionConfig extends BaseActionConfig {
    action: "more-info";
    entity?: string;
}
export interface NoActionConfig extends BaseActionConfig {
    action: "none";
}
export interface CustomActionConfig extends BaseActionConfig {
    action: "fire-dom-event";
}
/**
 * `repeat` and `haptic` are specifically for use in custom cards like the Button-Card
 */
export interface BaseActionConfig {
    confirmation?: ConfirmationRestrictionConfig;
    repeat?: number;
    haptic?: HapticType;
}
export interface ConfirmationRestrictionConfig {
    text?: string;
    exemptions?: RestrictionConfig[];
}
export interface RestrictionConfig {
    user: string;
}
export declare type ActionConfig = ToggleActionConfig | CallServiceActionConfig | NavigateActionConfig | UrlActionConfig | MoreInfoActionConfig | NoActionConfig | CustomActionConfig | ToggleMenuActionConfig;
export interface Window {
    customPanelJS: string;
    ShadyCSS: {
        nativeCss: boolean;
        nativeShadow: boolean;
        prepareTemplate(templateElement: any, elementName: any, elementExtension: any): any;
        styleElement(element: any): any;
        styleSubtree(element: any, overrideProperties: any): any;
        styleDocument(overrideProperties: any): any;
        getComputedStyleValue(element: any, propertyName: any): any;
    };
}
declare global {
    interface HASSDomEvents {
        "value-changed": {
            value: unknown;
        };
        "config-changed": {
            config: any;
        };
        "hass-more-info": {
            entityId: string | undefined;
        };
        "ll-rebuild": {};
        "ll-custom": {};
        "location-changed": {
            replace: boolean;
        };
        "show-dialog": {};
        undefined: any;
        action: {
            action: string;
        };
    }
}
export declare type LocalizeFunc = (key: string, ...args: any[]) => string;
export interface Credential {
    auth_provider_type: string;
    auth_provider_id: string;
}
export interface MFAModule {
    id: string;
    name: string;
    enabled: boolean;
}
export interface CurrentUser {
    id: string;
    is_owner: boolean;
    is_admin: boolean;
    name: string;
    credentials: Credential[];
    mfa_modules: MFAModule[];
}
export interface Theme {
    "primary-color": string;
    "text-primary-color": string;
    "accent-color": string;
}
export interface Themes {
    default_theme: string;
    themes: {
        [key: string]: Theme;
    };
}
export interface Panel {
    component_name: string;
    config: {
        [key: string]: any;
    } | null;
    icon: string | null;
    title: string | null;
    url_path: string;
}
export interface Panels {
    [name: string]: Panel;
}
export interface Resources {
    [language: string]: {
        [key: string]: string;
    };
}
export interface Translation {
    nativeName: string;
    isRTL: boolean;
    fingerprints: {
        [fragment: string]: string;
    };
}
export interface ServiceCallRequest {
    domain: string;
    service: string;
    serviceData?: Record<string, any>;
    target?: HassServiceTarget;
}
export interface HomeAssistant {
    auth: Auth;
    connection: Connection;
    connected: boolean;
    states: HassEntities;
    services: HassServices;
    config: HassConfig;
    themes: Themes;
    selectedTheme?: string | null;
    panels: Panels;
    panelUrl: string;
    language: string;
    locale: FrontendLocaleData;
    selectedLanguage: string | null;
    resources: Resources;
    localize: LocalizeFunc;
    translationMetadata: {
        fragments: string[];
        translations: {
            [lang: string]: Translation;
        };
    };
    dockedSidebar: boolean;
    moreInfoEntityId: string;
    user: CurrentUser;
    callService: (domain: ServiceCallRequest["domain"], service: ServiceCallRequest["service"], serviceData?: ServiceCallRequest["serviceData"], target?: ServiceCallRequest["target"]) => Promise<void>;
    callApi: <T>(method: "GET" | "POST" | "PUT" | "DELETE", path: string, parameters?: {
        [key: string]: any;
    }) => Promise<T>;
    fetchWithAuth: (path: string, init?: {
        [key: string]: any;
    }) => Promise<Response>;
    sendWS: (msg: MessageBase) => Promise<void>;
    callWS: <T>(msg: MessageBase) => Promise<T>;
}
export declare enum NumberFormat {
    language = "language",
    system = "system",
    comma_decimal = "comma_decimal",
    decimal_comma = "decimal_comma",
    space_comma = "space_comma",
    none = "none"
}
export declare enum TimeFormat {
    language = "language",
    system = "system",
    am_pm = "12",
    twenty_four = "24"
}
export interface FrontendLocaleData {
    language: string;
    number_format: NumberFormat;
    time_format: TimeFormat;
}
export interface LovelaceCardConfig {
    index?: number;
    view_index?: number;
    type: string;
    [key: string]: any;
}
export interface LovelaceCard extends HTMLElement {
    hass?: HomeAssistant;
    isPanel?: boolean;
    editMode?: boolean;
    getCardSize(): number | Promise<number>;
    setConfig(config: LovelaceCardConfig): void;
}
export interface LovelaceCardEditor extends HTMLElement {
    hass?: HomeAssistant;
    lovelace?: LovelaceConfig;
    setConfig(config: LovelaceCardConfig): void;
}
export interface LovelaceConfig {
    title?: string;
    views: LovelaceViewConfig[];
    background?: string;
}
export interface LovelaceViewConfig {
    index?: number;
    title?: string;
    badges?: Array<string | LovelaceBadgeConfig>;
    cards?: LovelaceCardConfig[];
    path?: string;
    icon?: string;
    theme?: string;
    panel?: boolean;
    background?: string;
    visible?: boolean | ShowViewConfig[];
}
export interface ShowViewConfig {
    user?: string;
}
export interface LovelaceBadgeConfig {
    type?: string;
    [key: string]: any;
}
export interface ActionHandlerDetail {
    action: string;
}
export declare type ActionHandlerEvent = HASSDomEvent<ActionHandlerDetail>;
export interface ActionHandlerOptions {
    hasHold?: boolean;
    hasDoubleClick?: boolean;
}
export interface EntitiesCardEntityConfig extends EntityConfig {
    type?: string;
    secondary_info?: "entity-id" | "last-changed" | "last-triggered" | "last-updated" | "position" | "tilt-position" | "brightness";
    action_name?: string;
    service?: string;
    service_data?: Record<string, unknown>;
    url?: string;
    tap_action?: ActionConfig;
    hold_action?: ActionConfig;
    double_tap_action?: ActionConfig;
    state_color?: boolean;
    show_name?: boolean;
    show_icon?: boolean;
}
export interface EntityConfig {
    entity: string;
    type?: string;
    name?: string;
    icon?: string;
    image?: string;
}
export interface LovelaceElementConfigBase {
    type: string;
    style: Record<string, string>;
}