fix: rename clear_binds API endpoint

Author: Nerivec

lib/extension/bind.ts

@@ -184,7 +184,7 @@ interface ParsedMQTTMessage {
 }
 
 export default class Bind extends Extension {
-    #topicRegex = new RegExp(`^${settings.get().mqtt.base_topic}/bridge/request/device/(bind|unbind|clear_binds)`);
+    #topicRegex = new RegExp(`^${settings.get().mqtt.base_topic}/bridge/request/device/(bind|unbind|binds/clear)`);
     private pollDebouncers: {[s: string]: () => void} = {};
 
     // biome-ignore lint/suspicious/useAwait: API
@@ -276,18 +276,18 @@ export default class Bind extends Extension {
     }
 
     @bind private async onMQTTMessage(data: eventdata.MQTTMessage): Promise<void> {
-        if (data.topic.endsWith("clear_binds")) {
-            const message = JSON.parse(data.message) as Zigbee2MQTTAPI["bridge/request/device/clear_binds"];
+        if (data.topic.endsWith("binds/clear")) {
+            const message = JSON.parse(data.message) as Zigbee2MQTTAPI["bridge/request/device/binds/clear"];
 
             if (typeof message !== "object" || typeof message.target !== "string") {
-                await this.publishResponse("clear_binds", message, {}, "Invalid payload");
+                await this.publishResponse("binds/clear", message, {}, "Invalid payload");
                 return;
             }
 
             const target = this.zigbee.resolveEntity(message.target);
 
             if (!(target instanceof Device)) {
-                await this.publishResponse("clear_binds", message, {}, "Invalid target");
+                await this.publishResponse("binds/clear", message, {}, "Invalid target");
                 return;
             }
 
@@ -296,12 +296,12 @@ export default class Bind extends Extension {
 
             await target.zh.clearAllBindings(eui64List);
 
-            const responseData: Zigbee2MQTTAPI["bridge/response/device/clear_binds"] = {
+            const responseData: Zigbee2MQTTAPI["bridge/response/device/binds/clear"] = {
                 target: message.target,
                 ieeeList: eui64List,
             };
 
-            await this.publishResponse("clear_binds", message, responseData);
+            await this.publishResponse("binds/clear", message, responseData);
             this.eventBus.emitDevicesChanged();
             return;
         }
@@ -419,7 +419,7 @@ export default class Bind extends Extension {
     }
 
     private async publishResponse<T extends Zigbee2MQTTResponseEndpoints>(
-        type: ParsedMQTTMessage["type"] | "clear_binds",
+        type: ParsedMQTTMessage["type"] | "binds/clear",
         request: KeyValue,
         data: Zigbee2MQTTAPI[T],
         error?: string,

lib/types/api.ts

@@ -563,12 +563,12 @@ export interface Zigbee2MQTTAPI {
         failed: string[];
     };
 
-    "bridge/request/device/clear_binds": {
+    "bridge/request/device/binds/clear": {
         target: string;
         ieeeList?: Eui64[];
     };
 
-    "bridge/response/device/clear_binds": {
+    "bridge/response/device/binds/clear": {
         target: string;
         ieeeList?: Eui64[];
     };
@@ -914,7 +914,7 @@ export type Zigbee2MQTTRequestEndpoints =
     | "bridge/request/options"
     | "bridge/request/device/bind"
     | "bridge/request/device/unbind"
-    | "bridge/request/device/clear_binds"
+    | "bridge/request/device/binds/clear"
     | "bridge/request/device/configure"
     | "bridge/request/device/remove"
     | "bridge/request/device/ota_update/check"
@@ -964,7 +964,7 @@ export type Zigbee2MQTTResponseEndpoints =
     | "bridge/response/options"
     | "bridge/response/device/bind"
     | "bridge/response/device/unbind"
-    | "bridge/response/device/clear_binds"
+    | "bridge/response/device/binds/clear"
     | "bridge/response/device/configure"
     | "bridge/response/device/remove"
     | "bridge/response/device/ota_update/check"

test/extensions/bind.test.ts

@@ -800,12 +800,12 @@ describe("Extension: Bind", () => {
         const device = devices.remote;
 
         device.mockClear();
-        mockMQTTEvents.message("zigbee2mqtt/bridge/request/device/clear_binds", stringify({transaction: "1234", target: "remote"}));
+        mockMQTTEvents.message("zigbee2mqtt/bridge/request/device/binds/clear", stringify({transaction: "1234", target: "remote"}));
         await flushPromises();
 
         expect(device.clearAllBindings).toHaveBeenCalledTimes(1);
         expect(mockMQTTPublishAsync).toHaveBeenCalledWith(
-            "zigbee2mqtt/bridge/response/device/clear_binds",
+            "zigbee2mqtt/bridge/response/device/binds/clear",
             stringify({
                 transaction: "1234",
                 data: {
@@ -825,14 +825,14 @@ describe("Extension: Bind", () => {
 
         device.mockClear();
         mockMQTTEvents.message(
-            "zigbee2mqtt/bridge/request/device/clear_binds",
+            "zigbee2mqtt/bridge/request/device/binds/clear",
             stringify({transaction: "1234", target: "remote", ieeeList: [target.ieeeAddr]}),
         );
         await flushPromises();
 
         expect(device.clearAllBindings).toHaveBeenCalledTimes(1);
         expect(mockMQTTPublishAsync).toHaveBeenCalledWith(
-            "zigbee2mqtt/bridge/response/device/clear_binds",
+            "zigbee2mqtt/bridge/response/device/binds/clear",
             stringify({
                 transaction: "1234",
                 data: {
@@ -850,12 +850,12 @@ describe("Extension: Bind", () => {
         const device = devices.remote;
 
         device.mockClear();
-        mockMQTTEvents.message("zigbee2mqtt/bridge/request/device/clear_binds", stringify({targetz: "remote"}));
+        mockMQTTEvents.message("zigbee2mqtt/bridge/request/device/binds/clear", stringify({targetz: "remote"}));
         await flushPromises();
 
         expect(device.clearAllBindings).toHaveBeenCalledTimes(0);
         expect(mockMQTTPublishAsync).toHaveBeenCalledWith(
-            "zigbee2mqtt/bridge/response/device/clear_binds",
+            "zigbee2mqtt/bridge/response/device/binds/clear",
             stringify({data: {}, status: "error", error: "Invalid payload"}),
             {},
         );
@@ -865,12 +865,12 @@ describe("Extension: Bind", () => {
         const device = devices.remote;
 
         device.mockClear();
-        mockMQTTEvents.message("zigbee2mqtt/bridge/request/device/clear_binds", stringify({target: "remotez"}));
+        mockMQTTEvents.message("zigbee2mqtt/bridge/request/device/binds/clear", stringify({target: "remotez"}));
         await flushPromises();
 
         expect(device.clearAllBindings).toHaveBeenCalledTimes(0);
         expect(mockMQTTPublishAsync).toHaveBeenCalledWith(
-            "zigbee2mqtt/bridge/response/device/clear_binds",
+            "zigbee2mqtt/bridge/response/device/binds/clear",
             stringify({data: {}, status: "error", error: "Invalid target"}),
             {},
         );