edilkamin 1.6.1 → 1.6.2

package/src/types.ts

@@ -1,3 +1,12 @@
+/**
+ * Represents a Node.js Buffer object serialized to JSON.
+ * This format is used by the Edilkamin API for gzip-compressed fields.
+ */
+interface BufferEncodedType {
+  type: "Buffer";
+  data: number[];
+}
+
 interface CommandsType {
   power: boolean;
 }
@@ -27,9 +36,60 @@ interface DeviceInfoType {
   };
 }
 
+/**
+ * Raw device info response that may contain Buffer-encoded compressed fields.
+ * Used internally before processing; external callers receive DeviceInfoType.
+ */
+interface DeviceInfoRawType {
+  status: StatusType | BufferEncodedType;
+  nvm:
+    | {
+        user_parameters: UserParametersType;
+      }
+    | BufferEncodedType;
+  component_info?: BufferEncodedType | Record<string, unknown>;
+}
+
+/**
+ * Request body for registering a device with a user account.
+ * All fields are required by the API.
+ */
+interface DeviceAssociationBody {
+  macAddress: string;
+  deviceName: string;
+  deviceRoom: string;
+  serialNumber: string;
+}
+
+/**
+ * Request body for editing a device's name and room.
+ * MAC address is specified in the URL path, not the body.
+ * Serial number cannot be changed after registration.
+ */
+interface EditDeviceAssociationBody {
+  deviceName: string;
+  deviceRoom: string;
+}
+
+/**
+ * Response from device registration endpoint.
+ * Structure based on Android app behavior - may need adjustment after testing.
+ */
+interface DeviceAssociationResponse {
+  macAddress: string;
+  deviceName: string;
+  deviceRoom: string;
+  serialNumber: string;
+}
+
 export type {
+  BufferEncodedType,
   CommandsType,
+  DeviceAssociationBody,
+  DeviceAssociationResponse,
+  DeviceInfoRawType,
   DeviceInfoType,
+  EditDeviceAssociationBody,
   StatusType,
   TemperaturesType,
   UserParametersType,