@jakobgoerke/ac-infinity-client 0.1.1 → 0.3.0

package/README.md

@@ -1 +1 @@
-# ac-infinity-client
+# ac-infinity-client

package/build/src/AcInfinityClient.d.ts

@@ -1,22 +1,36 @@
-import { Controller, User, DeviceModeSettings, DeviceSettings } from './types';
+import type { Controller, DeviceModeSettings, DeviceModeSettingsChanges, DeviceSettings, DeviceSettingsChanges, User } from './types';
 export declare enum Url {
     AUTH = "/user/appUserLogin",
-    CONTROLLERS = "/user/devInfoListAll",
-    DEVICE_SETTINGS = "/dev/getDevSetting",
-    DEVICE_MODE_SETTINGS = "/dev/getdevModeSettingList"
+    GET_CONTROLLERS = "/user/devInfoListAll",
+    GET_SHARED_CONTROLLERS = "/user/shareDevList",
+    GET_CONTROLLER = "/dev/getDeviceInfo",
+    GET_DEVICE_SETTINGS = "/dev/getDevSetting",
+    SET_DEVICE_SETTINGS = "/dev/updateAdvSetting",
+    GET_DEVICE_MODE_SETTINGS = "/dev/getdevModeSettingList",
+    SET_DEVICE_MODE_SETTINGS = "/dev/addDevMode"
 }
 export interface Response<T> {
     code: number;
+    msg?: string;
     data: T;
 }
 export interface AuthParams {
     email: string;
     password: string;
 }
-interface GetDeviceParams {
-    deviceId: string;
+export interface ControllerParams {
+    controllerId: string;
+}
+export interface GetDeviceParams extends ControllerParams {
+    /** 0 addresses the controller itself, 1..n the devices plugged into its ports */
     port: number;
 }
+export interface SetDeviceModeSettingsParams extends GetDeviceParams {
+    settings: DeviceModeSettingsChanges;
+}
+export interface SetDeviceSettingsParams extends GetDeviceParams {
+    settings: DeviceSettingsChanges;
+}
 declare class AcInfinityClient {
     constructor(args: AuthParams);
     private api;
@@ -24,11 +38,17 @@ declare class AcInfinityClient {
     private email;
     private password;
     authenticate(): Promise<User>;
+    private request;
     getControllers(): Promise<Controller[]>;
-    getDeviceSettings({ deviceId, port }: GetDeviceParams): Promise<DeviceSettings>;
-    getDeviceModeSettings({ deviceId, port }: GetDeviceParams): Promise<DeviceModeSettings>;
+    getSharedControllers(): Promise<Controller[]>;
+    getController({ controllerId }: ControllerParams): Promise<Controller>;
+    getDeviceSettings({ controllerId, port }: GetDeviceParams): Promise<DeviceSettings>;
+    setDeviceSettings({ controllerId, port, settings }: SetDeviceSettingsParams): Promise<void>;
+    private getDeviceName;
+    getDeviceModeSettings({ controllerId, port }: GetDeviceParams): Promise<DeviceModeSettings>;
+    setDeviceModeSettings({ controllerId, port, settings }: SetDeviceModeSettingsParams): Promise<void>;
     static build(args: AuthParams): Promise<AcInfinityClient>;
 }
+export type { Controller, DeviceModeSettings, DeviceModeSettingsChanges, DeviceSettings, DeviceSettingsChanges, User };
 export { AcInfinityClient };
-export type { Controller, User, DeviceModeSettings, DeviceSettings };
 //# sourceMappingURL=AcInfinityClient.d.ts.map

package/build/src/AcInfinityClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AcInfinityClient.d.ts","sourceRoot":"","sources":["../../src/AcInfinityClient.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,UAAU,EAEV,IAAI,EAGJ,kBAAkB,EAClB,cAAc,EAEf,MAAM,SAAS,CAAC;AAGjB,oBAAY,GAAG;IACb,IAAI,uBAAuB;IAC3B,WAAW,yBAAyB;IACpC,eAAe,uBAAuB;IACtC,oBAAoB,+BAA+B;CACpD;AAED,MAAM,WAAW,QAAQ,CAAC,CAAC;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,CAAC,CAAC;CACT;AAED,MAAM,WAAW,UAAU;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,UAAU,eAAe;IACvB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,cAAM,gBAAgB;gBACR,IAAI,EAAE,UAAU;IAiB5B,OAAO,CAAC,GAAG,CAAgB;IAC3B,OAAO,CAAC,KAAK,CAAS;IACtB,OAAO,CAAC,KAAK,CAAS;IACtB,OAAO,CAAC,QAAQ,CAAS;IAEZ,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;IAiB7B,cAAc,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;IAQvC,iBAAiB,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,eAAe,GAAG,OAAO,CAAC,cAAc,CAAC;IAS/E,qBAAqB,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,eAAe,GAAG,OAAO,CAAC,kBAAkB,CAAC;WASvF,KAAK,CAAC,IAAI,EAAE,UAAU;CAKpC;AAED,OAAO,EAAE,gBAAgB,EAAE,CAAC;AAC5B,YAAY,EAAE,UAAU,EAAE,IAAI,EAAE,kBAAkB,EAAE,cAAc,EAAE,CAAC"}
+{"version":3,"file":"AcInfinityClient.d.ts","sourceRoot":"","sources":["../../src/AcInfinityClient.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,UAAU,EAAE,kBAAkB,EAAE,yBAAyB,EAAE,cAAc,EAAE,qBAAqB,EAAE,IAAI,EAAE,MAAM,SAAS,CAAC;AAUtI,oBAAY,GAAG;IACb,IAAI,uBAAuB;IAC3B,eAAe,yBAAyB;IACxC,sBAAsB,uBAAuB;IAC7C,cAAc,uBAAuB;IACrC,mBAAmB,uBAAuB;IAC1C,mBAAmB,0BAA0B;IAC7C,wBAAwB,+BAA+B;IACvD,wBAAwB,oBAAoB;CAC7C;AAED,MAAM,WAAW,QAAQ,CAAC,CAAC;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,CAAC,CAAC;CACT;AAED,MAAM,WAAW,UAAU;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,gBAAgB;IAC/B,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,eAAgB,SAAQ,gBAAgB;IACvD,iFAAiF;IACjF,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,2BAA4B,SAAQ,eAAe;IAClE,QAAQ,EAAE,yBAAyB,CAAC;CACrC;AAED,MAAM,WAAW,uBAAwB,SAAQ,eAAe;IAC9D,QAAQ,EAAE,qBAAqB,CAAC;CACjC;AAqBD,cAAM,gBAAgB;gBACR,IAAI,EAAE,UAAU;IAiB5B,OAAO,CAAC,GAAG,CAAgB;IAC3B,OAAO,CAAC,KAAK,CAAS;IACtB,OAAO,CAAC,KAAK,CAAS;IACtB,OAAO,CAAC,QAAQ,CAAS;IAEZ,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;YAiB5B,OAAO;IAUR,cAAc,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;IAQvC,oBAAoB,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;IAQ7C,aAAa,CAAC,EAAE,YAAY,EAAE,EAAE,gBAAgB,GAAG,OAAO,CAAC,UAAU,CAAC;IAQtE,iBAAiB,CAAC,EAAE,YAAY,EAAE,IAAI,EAAE,EAAE,eAAe,GAAG,OAAO,CAAC,cAAc,CAAC;IASnF,iBAAiB,CAAC,EAAE,YAAY,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,uBAAuB,GAAG,OAAO,CAAC,IAAI,CAAC;YAe1F,aAAa;IAMd,qBAAqB,CAAC,EAAE,YAAY,EAAE,IAAI,EAAE,EAAE,eAAe,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAS3F,qBAAqB,CAAC,EAAE,YAAY,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,2BAA2B,GAAG,OAAO,CAAC,IAAI,CAAC;WAYnG,KAAK,CAAC,IAAI,EAAE,UAAU;CAKpC;AAED,YAAY,EAAE,UAAU,EAAE,kBAAkB,EAAE,yBAAyB,EAAE,cAAc,EAAE,qBAAqB,EAAE,IAAI,EAAE,CAAC;AACvH,OAAO,EAAE,gBAAgB,EAAE,CAAC"}

package/build/src/AcInfinityClient.js

@@ -5,15 +5,32 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AcInfinityClient = exports.Url = void 0;
 const axios_1 = __importDefault(require("axios"));
-const types_1 = require("./types");
 const errors_1 = require("./errors");
+const types_1 = require("./types");
 var Url;
 (function (Url) {
     Url["AUTH"] = "/user/appUserLogin";
-    Url["CONTROLLERS"] = "/user/devInfoListAll";
-    Url["DEVICE_SETTINGS"] = "/dev/getDevSetting";
-    Url["DEVICE_MODE_SETTINGS"] = "/dev/getdevModeSettingList";
+    Url["GET_CONTROLLERS"] = "/user/devInfoListAll";
+    Url["GET_SHARED_CONTROLLERS"] = "/user/shareDevList";
+    Url["GET_CONTROLLER"] = "/dev/getDeviceInfo";
+    Url["GET_DEVICE_SETTINGS"] = "/dev/getDevSetting";
+    Url["SET_DEVICE_SETTINGS"] = "/dev/updateAdvSetting";
+    Url["GET_DEVICE_MODE_SETTINGS"] = "/dev/getdevModeSettingList";
+    Url["SET_DEVICE_MODE_SETTINGS"] = "/dev/addDevMode";
 })(Url || (exports.Url = Url = {}));
+// fahrenheit values below freezing are raised to 32 before sending mode settings
+const FAHRENHEIT_FIELDS = ['devHtf', 'devLtf', 'targetTempF', 'waterTempHighValueF', 'waterTempLowValueF', 'waterTempTargetValueF'];
+// only send flat values: nested objects and empty fields are left out
+const toFormPayload = (values) => Object.fromEntries(Object.entries(values).filter(([, value]) => value !== null && value !== undefined && typeof value !== 'object'));
+const clampFahrenheit = (payload) => {
+    for (const field of FAHRENHEIT_FIELDS) {
+        const value = payload[field];
+        if (typeof value === 'number' && value < 32) {
+            payload[field] = 32;
+        }
+    }
+    return payload;
+};
 class AcInfinityClient {
     constructor(args) {
         const { email, password } = args;
@@ -41,29 +58,72 @@ class AcInfinityClient {
             throw new errors_1.AuthenticationError();
         }
         const user = types_1.UserSchema.parse(response.data.data);
-        this.token = user.appId;
-        this.api.defaults.headers.common['token'] = user.appId;
+        this.token = user.id;
+        this.api.defaults.headers.common.token = user.id;
         return user;
     }
+    async request(url, params) {
+        const response = await this.api.post(url, params);
+        if (response.data.code !== 200) {
+            throw new errors_1.ApiError(response.data.code, response.data.msg);
+        }
+        return response.data.data;
+    }
     async getControllers() {
-        const response = await this.api.post(Url.CONTROLLERS, {
+        const controllers = await this.request(Url.GET_CONTROLLERS, {
+            userId: this.token,
+        });
+        return controllers.map((device) => types_1.ControllerSchema.parse(device));
+    }
+    async getSharedControllers() {
+        const controllers = await this.request(Url.GET_SHARED_CONTROLLERS, {
             userId: this.token,
         });
-        return response.data.data.map((device) => types_1.ControllerSchema.parse(device));
+        return controllers.map((device) => types_1.ControllerSchema.parse(device));
+    }
+    async getController({ controllerId }) {
+        const controller = await this.request(Url.GET_CONTROLLER, {
+            devId: controllerId,
+        });
+        return types_1.ControllerSchema.parse(controller);
+    }
+    async getDeviceSettings({ controllerId, port }) {
+        const settings = await this.request(Url.GET_DEVICE_SETTINGS, {
+            devId: controllerId,
+            port,
+        });
+        return types_1.DeviceSettingsSchema.parse(settings);
+    }
+    async setDeviceSettings({ controllerId, port, settings }) {
+        const vendorChanges = (0, types_1.encodeDeviceSettings)(settings);
+        const currentSettings = await this.request(Url.GET_DEVICE_SETTINGS, {
+            devId: controllerId,
+            port,
+        });
+        // the name is required, but often not stored in the settings themselves
+        const devName = vendorChanges.devName ?? currentSettings.devName ?? (await this.getDeviceName({ controllerId, port }));
+        const payload = toFormPayload({ ...currentSettings, ...vendorChanges, devName });
+        await this.request(Url.SET_DEVICE_SETTINGS, payload);
+    }
+    async getDeviceName({ controllerId, port }) {
+        const controller = await this.getController({ controllerId });
+        return port === 0 ? controller.name : controller.deviceInfo.ports.find((p) => p.port === port)?.deviceName;
     }
-    async getDeviceSettings({ deviceId, port }) {
-        const response = await this.api.post(Url.DEVICE_SETTINGS, {
-            devId: deviceId,
+    async getDeviceModeSettings({ controllerId, port }) {
+        const settings = await this.request(Url.GET_DEVICE_MODE_SETTINGS, {
+            devId: controllerId,
             port,
         });
-        return types_1.DeviceSettingsSchema.parse(response.data.data);
+        return types_1.DeviceModeSettingsSchema.parse(settings);
     }
-    async getDeviceModeSettings({ deviceId, port }) {
-        const response = await this.api.post(Url.DEVICE_MODE_SETTINGS, {
-            devId: deviceId,
+    async setDeviceModeSettings({ controllerId, port, settings }) {
+        const vendorChanges = (0, types_1.encodeDeviceModeSettings)(settings);
+        const currentSettings = await this.request(Url.GET_DEVICE_MODE_SETTINGS, {
+            devId: controllerId,
             port,
         });
-        return types_1.DeviceModeSettingsSchema.parse(response.data.data);
+        const payload = clampFahrenheit(toFormPayload({ ...currentSettings, ...vendorChanges, onlyUpdateSpeed: 0 }));
+        await this.request(Url.SET_DEVICE_MODE_SETTINGS, payload);
     }
     static async build(args) {
         const instance = new AcInfinityClient(args);

package/build/src/errors/index.d.ts

@@ -1,5 +1,10 @@
 declare class AuthenticationError extends Error {
     constructor(message?: string);
 }
-export { AuthenticationError };
+declare class ApiError extends Error {
+    readonly code: number;
+    readonly msg?: string | undefined;
+    constructor(code: number, msg?: string | undefined);
+}
+export { ApiError, AuthenticationError };
 //# sourceMappingURL=index.d.ts.map

package/build/src/errors/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/errors/index.ts"],"names":[],"mappings":"AAAA,cAAM,mBAAoB,SAAQ,KAAK;gBACzB,OAAO,CAAC,EAAE,MAAM;CAQ7B;AAED,OAAO,EAAE,mBAAmB,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/errors/index.ts"],"names":[],"mappings":"AAAA,cAAM,mBAAoB,SAAQ,KAAK;gBACzB,OAAO,CAAC,EAAE,MAAM;CAQ7B;AAED,cAAM,QAAS,SAAQ,KAAK;aAER,IAAI,EAAE,MAAM;aACZ,GAAG,CAAC,EAAE,MAAM;gBADZ,IAAI,EAAE,MAAM,EACZ,GAAG,CAAC,EAAE,MAAM,YAAA;CAS/B;AAED,OAAO,EAAE,QAAQ,EAAE,mBAAmB,EAAE,CAAC"}

package/build/src/errors/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AuthenticationError = void 0;
+exports.AuthenticationError = exports.ApiError = void 0;
 class AuthenticationError extends Error {
     constructor(message) {
         super(message);
@@ -10,3 +10,16 @@ class AuthenticationError extends Error {
     }
 }
 exports.AuthenticationError = AuthenticationError;
+class ApiError extends Error {
+    code;
+    msg;
+    constructor(code, msg) {
+        super(`API request failed [code="${code}", msg="${msg}"]`);
+        this.code = code;
+        this.msg = msg;
+        this.name = this.constructor.name;
+        Error.captureStackTrace(this, this.constructor);
+        Object.setPrototypeOf(this, ApiError.prototype);
+    }
+}
+exports.ApiError = ApiError;

package/build/src/index.d.ts

@@ -1,2 +1,5 @@
 export * from './AcInfinityClient';
+export * from './errors';
+export type { ControllerDeviceInfo, ControllerPort, ControllerSensor } from './types';
+export { ControllerDeviceType, DeviceMode, DeviceType, SensorType, TemperatureUnit } from './types';
 //# sourceMappingURL=index.d.ts.map

package/build/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,UAAU,CAAC;AACzB,YAAY,EAAE,oBAAoB,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AACtF,OAAO,EAAE,oBAAoB,EAAE,UAAU,EAAE,UAAU,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC"}

package/build/src/index.js

@@ -14,4 +14,12 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.TemperatureUnit = exports.SensorType = exports.DeviceType = exports.DeviceMode = exports.ControllerDeviceType = void 0;
 __exportStar(require("./AcInfinityClient"), exports);
+__exportStar(require("./errors"), exports);
+var types_1 = require("./types");
+Object.defineProperty(exports, "ControllerDeviceType", { enumerable: true, get: function () { return types_1.ControllerDeviceType; } });
+Object.defineProperty(exports, "DeviceMode", { enumerable: true, get: function () { return types_1.DeviceMode; } });
+Object.defineProperty(exports, "DeviceType", { enumerable: true, get: function () { return types_1.DeviceType; } });
+Object.defineProperty(exports, "SensorType", { enumerable: true, get: function () { return types_1.SensorType; } });
+Object.defineProperty(exports, "TemperatureUnit", { enumerable: true, get: function () { return types_1.TemperatureUnit; } });