@criticalmanufacturing/node-package-bundler/src/models/template.d.ts

Connect IoT Package Bundler

/** Possible action to perform on a template file */
export declare enum TemplateType {
    /** Index file */
    Index = "Index",
    /** Template */
    Template = "Template"
}
/** Files to use to build the templates entry in the Package.json file */
export interface Template {
    /** Template Type */
    type: TemplateType;
    /** Source file */
    source: string;
}
export interface JsonTemplateProperty {
    Name: string;
    Description?: string;
    DevicePropertyId?: string;
    DataType: string;
    IsWritable?: boolean;
    IsReadable?: boolean;
    AutomationProtocolDataType: string;
    ExtendedData?: any;
}
export declare const JsonTemplatePropertyDefaults: JsonTemplateProperty;
export interface JsonTemplateEventProperty {
    Property: string;
    Order?: number;
    ExtendedData?: any;
}
export declare const JsonTemplateEventPropertyDefaults: JsonTemplateEventProperty;
export interface JsonTemplateEvent {
    Name: string;
    Description?: string;
    DeviceEventId?: string;
    IsEnabled?: boolean;
    ExtendedData?: any;
    EventProperties?: JsonTemplateEventProperty[];
}
export declare const JsonTemplateEventDefaults: JsonTemplateEvent;
export interface JsonTemplateCommand {
    Name: string;
    Description?: string;
    DeviceCommandId?: string;
    ExtendedData?: any;
    CommandParameters?: JsonTemplateCommandParameter[];
}
export declare const JsonTemplateCommandDefaults: JsonTemplateCommand;
export interface JsonTemplateCommandParameter {
    Name: string;
    Description?: string;
    Order?: number;
    DataType: string;
    AutomationProtocolDataType: string;
    DefaultValue?: string;
    IsMandatory?: boolean;
    ExtendedData?: any;
}
export declare const JsonTemplateCommandParameterDefaults: JsonTemplateCommandParameter;
export interface JsonTemplate {
    property?: JsonTemplateProperty[];
    event?: JsonTemplateEvent[];
    command?: JsonTemplateCommand[];
}
export interface JsonDatatype {
    name: string;
    description?: string;
}