balena-sdk/es2017/types/device-type-json.d.ts

The Balena JavaScript SDK

import type { Dictionary } from '../../typings/utils';
export interface DeviceType {
    slug: string;
    name: string;
    aliases: string[];
    arch: string;
    state?: string;
    community?: boolean;
    private?: boolean;
    isDependent?: boolean;
    imageDownloadAlerts?: DeviceTypeDownloadAlert[];
    gettingStartedLink?: string | DeviceTypeGettingStartedLink;
    stateInstructions?: {
        [key: string]: string[];
    };
    options?: DeviceTypeOptions[];
    initialization?: {
        options?: DeviceInitializationOptions[];
        operations: Array<{
            command: string;
        }>;
    };
    yocto: {
        fstype?: string;
        deployArtifact: string;
        machine?: string;
        image?: string;
        version?: string;
        deployFlasherArtifact?: string;
        deployRawArtifact?: string;
        compressed?: boolean;
        archive?: boolean;
    };
    /** Holds the latest balenaOS version */
    buildId?: string;
}
export interface DeviceTypeDownloadAlert {
    type: string;
    message: string;
}
export interface DeviceTypeInstructions {
    linux: string[];
    osx: string[];
    windows: string[];
}
export interface DeviceTypeGettingStartedLink {
    linux: string;
    osx: string;
    windows: string;
    [key: string]: string;
}
export interface DeviceTypeOptions {
    options: DeviceTypeOptionsGroup[];
    collapsed: boolean;
    isCollapsible: boolean;
    isGroup: boolean;
    message: string;
    name: string;
}
export interface DeviceInitializationOptions {
    message: string;
    type: string;
    name: string;
}
export interface DeviceTypeOptionsGroup {
    default: number | string;
    message: string;
    name: string;
    type: string;
    min?: number;
    max?: number;
    hidden?: boolean;
    when?: Dictionary<number | string | boolean>;
    choices?: string[] | number[];
    choicesLabels?: Dictionary<string>;
}