import { ESPCDFAPIResponse, ESPCDFAPIDataResponse } from "../../types"; import { ESPCDFAttributeInterface, ESPCDFTransportConfig } from "./common"; import { ESPCDFDeviceInterface } from "./device"; import { ESPCDFServiceInterface } from "./service"; /** * Operation types that can trigger callbacks for nodes */ export type ESPCDFNodeOperationType = "setMultipleParams" | "delete" | "updateMetadata" | "checkOTAUpdate" | "pushOTAUpdate" | "getOTAStatus" | "addAutomation" | "setTimeZone"; export interface ESPCDFOTAUpdateResponse { status: string; otaAvailable: boolean; description: string; fwVersion: string; otaJobId: string; fileSize: number; url?: string; fileMD5?: string; streamId?: string; metadata?: Record; } export interface ESPCDFOTAUpdateStatusResponse { nodeId: string; status: string; additionalInfo: string; timestamp: number; } export interface ESPCDFNodeOperation { setMultipleParams(params: Record): Promise; delete(): Promise; checkOTAUpdate?(): Promise>; pushOTAUpdate?(params: any): Promise; getOTAUpdateStatus?(otaJobId: string): Promise>; addAutomation?(automationDetails: Record): Promise; setTimeZone(timeZone: string): Promise; updateMetadata(metadata: Record): Promise; createCmdRespRequest?(params: T): Promise; getCmdRespRequestById?(requestId: string): Promise; getCmdRespRequestList?(params?: T): Promise; cancelCmdRespRequest?(params: T): Promise; } /** * Fixed event types for node property changes * Using fixed types instead of property strings provides better type safety and maintainability */ export type ESPCDFNodePropertyChangeEventType = "deviceParamChanged" | "serviceParamChanged" | "metadataChanged" | "availableTransportsChanged" | "connectivityStatusChanged" | "tagsChanged" | "roleChanged"; /** * Event data for device parameter changes */ export interface ESPCDFDeviceParamChangedEvent { type: "deviceParamChanged"; deviceName: string; paramName: string; value: any; oldValue?: any; entity: ESPCDFNodeInterface; } /** * Event data for service parameter changes */ export interface ESPCDFServiceParamChangedEvent { type: "serviceParamChanged"; serviceName: string; paramName: string; value: any; oldValue?: any; entity: ESPCDFNodeInterface; } /** * Event data for metadata changes */ export interface ESPCDFMetadataChangedEvent { type: "metadataChanged"; metadata: Record; oldMetadata?: Record; entity: ESPCDFNodeInterface; } /** * Event data for available transports changes */ export interface ESPCDFAvailableTransportsChangedEvent { type: "availableTransportsChanged"; availableTransports: Partial>; oldAvailableTransports?: Partial>; entity: ESPCDFNodeInterface; } /** * Event data for connectivity status changes */ export interface ESPCDFConnectivityStatusChangedEvent { type: "connectivityStatusChanged"; connectivityStatus: ESPCDFConnectivityStatusInterface; oldConnectivityStatus?: ESPCDFConnectivityStatusInterface; entity: ESPCDFNodeInterface; } /** * Event data for tags changes */ export interface ESPCDFTagsChangedEvent { type: "tagsChanged"; tags: string[]; oldTags?: string[]; entity: ESPCDFNodeInterface; } /** * Event data for role changes */ export interface ESPCDFRoleChangedEvent { type: "roleChanged"; role: string; oldRole?: string; entity: ESPCDFNodeInterface; } /** * Discriminated union of all property change events * This provides type safety - each event type has its own data structure */ export type ESPCDFPropertyChangeEvent = ESPCDFDeviceParamChangedEvent | ESPCDFServiceParamChangedEvent | ESPCDFMetadataChangedEvent | ESPCDFAvailableTransportsChangedEvent | ESPCDFConnectivityStatusChangedEvent | ESPCDFTagsChangedEvent | ESPCDFRoleChangedEvent; /** * Callback type for property change events * This allows adaptors to listen to property changes and sync to _raw */ export type ESPCDFPropertyChangeCallback = (event: ESPCDFPropertyChangeEvent) => void; /** * Represents the connectivity status of a node. */ export interface ESPCDFConnectivityStatusInterface { isConnected: boolean; lastConnectionTimestamp: number; } /** * Represents the configuration of a node. */ export interface ESPCDFNodeConfigInterface { configVersion: string; attributes?: ESPCDFAttributeInterface[]; info?: ESPCDFNodeInfoInterface; } /** * Represents the information about a node. */ export interface ESPCDFNodeInfoInterface { name: string; type: string; model: string; firmwareVersion: string; readme?: string; [key: string]: any; } export declare enum ESPCDFNodeTransport { LOCAL = "local", CLOUD = "cloud" } export type ESPCDFNodeTransportType = ESPCDFNodeTransport | string; export interface ESPCDFNodeInterface { identifier: string; id: string; type?: string; isPrimaryUser?: boolean; connectivityStatus?: ESPCDFConnectivityStatusInterface; nodeConfig?: ESPCDFNodeConfigInterface; devices?: ESPCDFDeviceInterface[]; services?: ESPCDFServiceInterface[]; metadata?: Record; tags?: string[]; role?: string; /** Transport order - priority queue of transport modes */ transportOrder?: string[]; /** Available transports with their configurations */ availableTransports?: Partial>; operations: ESPCDFNodeOperation; _raw: any; [key: string]: any; }