trane-thermostat-api 1.0.0 → 1.0.2

package/dist/types/interfaces.d.ts

@@ -1,20 +1,20 @@
 import { BrandType, OperationMode, PresetMode, AirCleanerMode, TemperatureUnit, SensorType } from './constants';
 import { TemperatureOptions, HumidityOptions, FanOptions, HoldOptions, UpdateOptions, SensorSelectionOptions, DeviceCapabilities, SystemStatusSummary, ZoneStatusSummary } from './api';
-export interface INexiaClient {
+export interface ITraneClient {
     login(): Promise<void>;
     logout(): Promise<void>;
     isAuthenticated(): boolean;
-    getThermostats(): Promise<INexiaThermostat[]>;
-    getAutomations(): Promise<INexiaAutomation[]>;
-    getThermostatById(id: string): INexiaThermostat | undefined;
-    getAutomationById(id: string): INexiaAutomation | undefined;
+    getThermostats(): Promise<ITraneThermostat[]>;
+    getAutomations(): Promise<ITraneAutomation[]>;
+    getThermostatById(id: string): ITraneThermostat | undefined;
+    getAutomationById(id: string): ITraneAutomation | undefined;
     update(options?: UpdateOptions): Promise<void>;
     readonly brand: BrandType;
     readonly username: string;
     getHouseId(): number | undefined;
     readonly lastUpdate: Date | null;
 }
-export interface INexiaThermostat {
+export interface ITraneThermostat {
     readonly id: string;
     readonly name: string;
     readonly model: string;
@@ -66,12 +66,12 @@ export interface INexiaThermostat {
     setAirCleanerMode(mode: AirCleanerMode): Promise<void>;
     setEmergencyHeat(enabled: boolean): Promise<void>;
     setFollowSchedule(follow: boolean): Promise<void>;
-    readonly zones: INexiaZone[];
+    readonly zones: ITraneZone[];
     readonly zoneIds: string[];
-    getZoneById(zoneId: string): INexiaZone | undefined;
+    getZoneById(zoneId: string): ITraneZone | undefined;
     refresh(): Promise<void>;
 }
-export interface INexiaZone {
+export interface ITraneZone {
     readonly id: string;
     readonly name: string;
     readonly isNativeZone: boolean;
@@ -94,16 +94,16 @@ export interface INexiaZone {
     readonly availablePresets: PresetMode[];
     readonly currentPreset: PresetMode | null;
     setPreset(preset: PresetMode): Promise<void>;
-    readonly sensors: INexiaSensor[];
+    readonly sensors: ITraneSensor[];
     readonly activeSensorIds: Set<number>;
     readonly sensorIds: number[];
-    getSensorById(sensorId: number): INexiaSensor | undefined;
+    getSensorById(sensorId: number): ITraneSensor | undefined;
     selectActiveSensors(options: SensorSelectionOptions): Promise<void>;
-    readonly thermostat: INexiaThermostat;
+    readonly thermostat: ITraneThermostat;
     validateTemperatureSetpoints(heatTemp: number, coolTemp: number): boolean;
     roundTemperature(temperature: number): number;
 }
-export interface INexiaSensor {
+export interface ITraneSensor {
     readonly id: number;
     readonly name: string;
     readonly type: SensorType;
@@ -123,7 +123,7 @@ export interface INexiaSensor {
     readonly hasOnlineStatus: boolean;
     isDataValid(): boolean;
 }
-export interface INexiaAutomation {
+export interface ITraneAutomation {
     readonly id: string;
     readonly name: string;
     readonly description: string;
@@ -131,7 +131,7 @@ export interface INexiaAutomation {
     setEnabled(enabled: boolean): Promise<void>;
     activate(): Promise<void>;
 }
-export interface NexiaConfig {
+export interface TraneConfig {
     username: string;
     password: string;
     brand?: BrandType;
@@ -141,13 +141,13 @@ export interface NexiaConfig {
     timeout?: number;
     retryAttempts?: number;
 }
-export interface NexiaEvent {
+export interface TraneEvent {
     type: 'update' | 'error' | 'connected' | 'disconnected';
     timestamp: Date;
     data?: any;
     error?: Error;
 }
-export interface INexiaEventListener {
+export interface ITraneEventListener {
     onUpdate?(data: any): void;
     onError?(error: Error): void;
     onConnected?(): void;
@@ -195,15 +195,15 @@ export interface IHomebridgePlatform {
 export interface IHomebridgeAccessory {
     readonly platform: IHomebridgePlatform;
     readonly accessory: any;
-    readonly device: INexiaThermostat | INexiaZone | INexiaSensor;
+    readonly device: ITraneThermostat | ITraneZone | ITraneSensor;
     setupServices(): void;
     updateCharacteristics(): void;
 }
-export interface INexiaTypeGuards {
-    isThermostat(device: any): device is INexiaThermostat;
-    isZone(device: any): device is INexiaZone;
-    isSensor(device: any): device is INexiaSensor;
-    isAutomation(device: any): device is INexiaAutomation;
+export interface ITraneTypeGuards {
+    isThermostat(device: any): device is ITraneThermostat;
+    isZone(device: any): device is ITraneZone;
+    isSensor(device: any): device is ITraneSensor;
+    isAutomation(device: any): device is ITraneAutomation;
     isValidTemperature(value: any, unit: TemperatureUnit): boolean;
     isValidHumidity(value: any): boolean;
     isValidFanSpeed(value: any): boolean;

package/dist/utils/errors.d.ts

@@ -1,9 +1,9 @@
-export declare class NexiaError extends Error {
+export declare class TraneError extends Error {
     code: string;
     readonly timestamp: Date;
     constructor(message: string, code?: string);
 }
-export declare class AuthenticationError extends NexiaError {
+export declare class AuthenticationError extends TraneError {
     constructor(message?: string);
 }
 export declare class RateLimitError extends AuthenticationError {
@@ -13,7 +13,7 @@ export declare class RateLimitError extends AuthenticationError {
 export declare class SessionExpiredError extends AuthenticationError {
     constructor(message?: string);
 }
-export declare class ValidationError extends NexiaError {
+export declare class ValidationError extends TraneError {
     readonly field?: string;
     readonly value?: unknown;
     constructor(message: string, field?: string, value?: unknown);
@@ -35,7 +35,7 @@ export declare class DeadbandValidationError extends ValidationError {
     readonly coolTemp: number;
     constructor(message: string, deadband: number, heatTemp: number, coolTemp: number);
 }
-export declare class ApiError extends NexiaError {
+export declare class ApiError extends TraneError {
     readonly statusCode?: number;
     readonly response?: unknown;
     constructor(message: string, statusCode?: number, response?: unknown);
@@ -43,7 +43,7 @@ export declare class ApiError extends NexiaError {
 export declare class HttpError extends ApiError {
     constructor(message: string, statusCode: number, response?: unknown);
 }
-export declare class NetworkError extends NexiaError {
+export declare class NetworkError extends TraneError {
     readonly originalError?: Error;
     constructor(message: string, originalError?: Error);
 }
@@ -51,26 +51,26 @@ export declare class TimeoutError extends NetworkError {
     readonly timeout: number;
     constructor(message: string, timeout: number);
 }
-export declare class DeviceNotFoundError extends NexiaError {
+export declare class DeviceNotFoundError extends TraneError {
     readonly deviceId: string;
     readonly deviceType: string;
     constructor(message: string, deviceId: string, deviceType?: string);
 }
-export declare class FeatureNotSupportedError extends NexiaError {
+export declare class FeatureNotSupportedError extends TraneError {
     readonly feature: string;
     readonly deviceModel?: string;
     constructor(feature: string, deviceModel?: string);
 }
-export declare class OperationNotAllowedError extends NexiaError {
+export declare class OperationNotAllowedError extends TraneError {
     readonly operation: string;
     readonly reason?: string;
     constructor(operation: string, reason?: string);
 }
-export declare class ConfigurationError extends NexiaError {
+export declare class ConfigurationError extends TraneError {
     readonly configField?: string;
     constructor(message: string, configField?: string);
 }
-export declare class ParseError extends NexiaError {
+export declare class ParseError extends TraneError {
     readonly data?: unknown;
     constructor(message: string, data?: unknown);
 }
@@ -81,14 +81,14 @@ export declare class ErrorFactory {
     static createDeadbandError(heatTemp: number, coolTemp: number, deadband: number, unit: string): DeadbandValidationError;
     private static getHttpStatusMessage;
 }
-export declare function isNexiaError(error: unknown): error is NexiaError;
+export declare function isTraneError(error: unknown): error is TraneError;
 export declare function isAuthenticationError(error: unknown): error is AuthenticationError;
 export declare function isValidationError(error: unknown): error is ValidationError;
 export declare function isApiError(error: unknown): error is ApiError;
 export declare function isNetworkError(error: unknown): error is NetworkError;
 export declare class ErrorHandler {
-    static handle(error: unknown): NexiaError;
-    static isRetryable(error: NexiaError): boolean;
+    static handle(error: unknown): TraneError;
+    static isRetryable(error: TraneError): boolean;
     static getRetryDelay(attempt: number, baseDelay?: number): number;
 }
 //# sourceMappingURL=errors.d.ts.map

package/dist/utils/errors.js

@@ -1,24 +1,24 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ErrorHandler = exports.ErrorFactory = exports.ParseError = exports.ConfigurationError = exports.OperationNotAllowedError = exports.FeatureNotSupportedError = exports.DeviceNotFoundError = exports.TimeoutError = exports.NetworkError = exports.HttpError = exports.ApiError = exports.DeadbandValidationError = exports.TemperatureValidationError = exports.ValidationError = exports.SessionExpiredError = exports.RateLimitError = exports.AuthenticationError = exports.NexiaError = void 0;
-exports.isNexiaError = isNexiaError;
+exports.ErrorHandler = exports.ErrorFactory = exports.ParseError = exports.ConfigurationError = exports.OperationNotAllowedError = exports.FeatureNotSupportedError = exports.DeviceNotFoundError = exports.TimeoutError = exports.NetworkError = exports.HttpError = exports.ApiError = exports.DeadbandValidationError = exports.TemperatureValidationError = exports.ValidationError = exports.SessionExpiredError = exports.RateLimitError = exports.AuthenticationError = exports.TraneError = void 0;
+exports.isTraneError = isTraneError;
 exports.isAuthenticationError = isAuthenticationError;
 exports.isValidationError = isValidationError;
 exports.isApiError = isApiError;
 exports.isNetworkError = isNetworkError;
-class NexiaError extends Error {
+class TraneError extends Error {
     constructor(message, code = 'UNKNOWN_ERROR') {
         super(message);
-        this.name = 'NexiaError';
+        this.name = 'TraneError';
         this.code = code;
         this.timestamp = new Date();
         if (Error.captureStackTrace) {
-            Error.captureStackTrace(this, NexiaError);
+            Error.captureStackTrace(this, TraneError);
         }
     }
 }
-exports.NexiaError = NexiaError;
-class AuthenticationError extends NexiaError {
+exports.TraneError = TraneError;
+class AuthenticationError extends TraneError {
     constructor(message = 'Authentication failed') {
         super(message, 'AUTH_ERROR');
         this.name = 'AuthenticationError';
@@ -42,7 +42,7 @@ class SessionExpiredError extends AuthenticationError {
     }
 }
 exports.SessionExpiredError = SessionExpiredError;
-class ValidationError extends NexiaError {
+class ValidationError extends TraneError {
     constructor(message, field, value) {
         super(message, 'VALIDATION_ERROR');
         this.name = 'ValidationError';
@@ -72,7 +72,7 @@ class DeadbandValidationError extends ValidationError {
     }
 }
 exports.DeadbandValidationError = DeadbandValidationError;
-class ApiError extends NexiaError {
+class ApiError extends TraneError {
     constructor(message, statusCode, response) {
         super(message, 'API_ERROR');
         this.name = 'ApiError';
@@ -89,7 +89,7 @@ class HttpError extends ApiError {
     }
 }
 exports.HttpError = HttpError;
-class NetworkError extends NexiaError {
+class NetworkError extends TraneError {
     constructor(message, originalError) {
         super(message, 'NETWORK_ERROR');
         this.name = 'NetworkError';
@@ -106,7 +106,7 @@ class TimeoutError extends NetworkError {
     }
 }
 exports.TimeoutError = TimeoutError;
-class DeviceNotFoundError extends NexiaError {
+class DeviceNotFoundError extends TraneError {
     constructor(message, deviceId, deviceType = 'device') {
         super(message, 'DEVICE_NOT_FOUND');
         this.name = 'DeviceNotFoundError';
@@ -115,7 +115,7 @@ class DeviceNotFoundError extends NexiaError {
     }
 }
 exports.DeviceNotFoundError = DeviceNotFoundError;
-class FeatureNotSupportedError extends NexiaError {
+class FeatureNotSupportedError extends TraneError {
     constructor(feature, deviceModel) {
         const message = deviceModel
             ? `Feature '${feature}' is not supported on device model '${deviceModel}'`
@@ -127,7 +127,7 @@ class FeatureNotSupportedError extends NexiaError {
     }
 }
 exports.FeatureNotSupportedError = FeatureNotSupportedError;
-class OperationNotAllowedError extends NexiaError {
+class OperationNotAllowedError extends TraneError {
     constructor(operation, reason) {
         const message = reason
             ? `Operation '${operation}' is not allowed: ${reason}`
@@ -139,7 +139,7 @@ class OperationNotAllowedError extends NexiaError {
     }
 }
 exports.OperationNotAllowedError = OperationNotAllowedError;
-class ConfigurationError extends NexiaError {
+class ConfigurationError extends TraneError {
     constructor(message, configField) {
         super(message, 'CONFIG_ERROR');
         this.name = 'ConfigurationError';
@@ -147,7 +147,7 @@ class ConfigurationError extends NexiaError {
     }
 }
 exports.ConfigurationError = ConfigurationError;
-class ParseError extends NexiaError {
+class ParseError extends TraneError {
     constructor(message, data) {
         super(message, 'PARSE_ERROR');
         this.name = 'ParseError';
@@ -189,8 +189,8 @@ class ErrorFactory {
     }
 }
 exports.ErrorFactory = ErrorFactory;
-function isNexiaError(error) {
-    return error instanceof NexiaError;
+function isTraneError(error) {
+    return error instanceof TraneError;
 }
 function isAuthenticationError(error) {
     return error instanceof AuthenticationError;
@@ -206,16 +206,16 @@ function isNetworkError(error) {
 }
 class ErrorHandler {
     static handle(error) {
-        if (isNexiaError(error)) {
+        if (isTraneError(error)) {
             return error;
         }
         if (error instanceof Error) {
-            return new NexiaError(error.message, 'UNKNOWN_ERROR');
+            return new TraneError(error.message, 'UNKNOWN_ERROR');
         }
         if (typeof error === 'string') {
-            return new NexiaError(error, 'UNKNOWN_ERROR');
+            return new TraneError(error, 'UNKNOWN_ERROR');
         }
-        return new NexiaError('An unknown error occurred', 'UNKNOWN_ERROR');
+        return new TraneError('An unknown error occurred', 'UNKNOWN_ERROR');
     }
     static isRetryable(error) {
         return (isNetworkError(error) ||

package/dist/utils/validation.d.ts

@@ -32,7 +32,7 @@ export declare class GeneralValidator {
     static validateDate(value: any, fieldName: string): Date;
     static validateRequiredProperties<T extends Record<string, any>>(obj: any, requiredProps: (keyof T)[], objectName: string): void;
 }
-export declare class NexiaValidator {
+export declare class TraneValidator {
     static validateTemperatureConfig(config: {
         heatTemp?: number;
         coolTemp?: number;

package/dist/utils/validation.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NexiaValidator = exports.GeneralValidator = exports.FanSpeedValidator = exports.HumidityValidator = exports.TemperatureValidator = void 0;
+exports.TraneValidator = exports.GeneralValidator = exports.FanSpeedValidator = exports.HumidityValidator = exports.TemperatureValidator = void 0;
 const constants_1 = require("../types/constants");
 const errors_1 = require("./errors");
 class TemperatureValidator {
@@ -214,7 +214,7 @@ class GeneralValidator {
     }
 }
 exports.GeneralValidator = GeneralValidator;
-class NexiaValidator {
+class TraneValidator {
     static validateTemperatureConfig(config) {
         const { heatTemp, coolTemp, deadband, unit, setTemp } = config;
         if (setTemp !== undefined) {
@@ -268,5 +268,5 @@ class NexiaValidator {
         }
     }
 }
-exports.NexiaValidator = NexiaValidator;
+exports.TraneValidator = TraneValidator;
 //# sourceMappingURL=validation.js.map

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "trane-thermostat-api",
-  "version": "1.0.0",
-  "description": "Node.js TypeScript library for controlling Trane/Nexia/American Standard thermostats",
+  "version": "1.0.2",
+  "description": "Node.js TypeScript library for controlling Trane thermostats",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
@@ -10,20 +10,16 @@
     "test": "jest",
     "test:watch": "jest --watch",
     "test:coverage": "jest --coverage",
-    "lint": "eslint src --ext .ts",
-    "lint:fix": "eslint src --ext .ts --fix",
+    "lint": "eslint src --ext .ts --fix",
     "prepublishOnly": "npm run build",
     "type-check": "tsc --noEmit"
   },
   "keywords": [
     "trane",
-    "nexia",
-    "american-standard",
     "thermostat",
-    "typescript",
     "hvac"
   ],
-  "author": "Spencer S",
+  "author": "sbs44",
   "license": "MIT",
   "dependencies": {
     "axios": "^1.13.4",