Z-Wave: use add_user service to add users with credentials

Author: AlCalzone

src/data/zwave_js-credentials.ts

@@ -126,6 +126,20 @@ export interface SetZwaveUserResult {
   user_id: number;
 }
 
+export interface AddZwaveUserParams {
+  user_name?: string | null;
+  user_type?: string;
+  credential_rule?: string;
+  active?: boolean;
+  credential_type: ZwaveCredentialType;
+  credential_data: string;
+}
+
+export interface AddZwaveUserResult {
+  user_id: number;
+  credential_slot: number;
+}
+
 export interface SetZwaveCredentialParams {
   user_id: number;
   credential_type: ZwaveCredentialType;
@@ -216,6 +230,23 @@ export const setZwaveUser = async (
   return unwrapEntityResponse(hass, result.response, entity_id);
 };
 
+export const addZwaveUser = async (
+  hass: HomeAssistant,
+  entity_id: string,
+  params: AddZwaveUserParams
+): Promise<AddZwaveUserResult> => {
+  // notifyOnError=false — caller surfaces errors in-dialog instead.
+  const result = await hass.callService<Record<string, AddZwaveUserResult>>(
+    "zwave_js",
+    "add_user",
+    params,
+    { entity_id },
+    false,
+    true
+  );
+  return unwrapEntityResponse(hass, result.response, entity_id);
+};
+
 export const deleteZwaveUser = (
   hass: HomeAssistant,
   entity_id: string,

src/panels/config/integrations/integration-panels/zwave_js/dialog-zwave_js-credential-user-edit.ts

@@ -18,8 +18,8 @@ import {
   DEFAULT_CREDENTIAL_MAX_LENGTH,
   DEFAULT_CREDENTIAL_MIN_LENGTH,
   ENTERABLE_ZWAVE_CREDENTIAL_TYPES,
+  addZwaveUser,
   deleteZwaveCredential,
-  deleteZwaveUser,
   enterableCredentialTypes,
   getCredentialError,
   compatibleUserTypes,
@@ -508,27 +508,19 @@ class DialogZwaveCredentialUserEdit extends LitElement {
     credentialType: ZwaveCredentialType
   ): Promise<void> {
     const params = this._params!;
-    const { user_id } = await setZwaveUser(this.hass, params.entity_id, {
-      user_name: this._supportsUserNames ? this._userName.trim() : undefined,
-      user_type: this._userType,
-      active: true,
-    });
-
+    // Create the user and write the credential in a single call. This is the
+    // only way to add a user on User Code CC locks, where the user and code
+    // share a slot. If the credential write fails, the service rolls the user
+    // back so the lock is never left with a credential-less user.
     try {
-      await setZwaveCredential(this.hass, params.entity_id, {
-        user_id,
+      await addZwaveUser(this.hass, params.entity_id, {
+        user_name: this._supportsUserNames ? this._userName.trim() : undefined,
+        user_type: this._userType,
+        active: true,
         credential_type: credentialType,
         credential_data: this._credentialData,
       });
     } catch (err: unknown) {
-      // Roll back the user so the lock returns to its prior state. We
-      // ignore rollback errors — the credential error is the actionable
-      // one to surface; a stranded user will reappear on next refresh.
-      try {
-        await deleteZwaveUser(this.hass, params.entity_id, user_id);
-      } catch {
-        // Ignore.
-      }
       this._error = this.hass.localize(
         "ui.panel.config.zwave_js.credentials.errors.add_user_failed",
         {

test/data/zwave_js-credentials.test.ts

@@ -3,6 +3,7 @@ import {
   getZwaveCredentialCapabilities,
   getZwaveUsers,
   setZwaveUser,
+  addZwaveUser,
   deleteZwaveUser,
   deleteZwaveAllUsers,
   setZwaveCredential,
@@ -171,6 +172,56 @@ describe("zwave_js-credentials", () => {
     });
   });
 
+  describe("addZwaveUser", () => {
+    const addUserResponse = (inner: unknown) =>
+      ({
+        callService: vi
+          .fn()
+          .mockResolvedValue({ response: { [ENTITY_ID]: inner } }),
+      }) as unknown as HomeAssistant;
+
+    it("calls add_user with user and credential, returning the slot", async () => {
+      const hass = addUserResponse({ user_id: 1, credential_slot: 1 });
+
+      const result = await addZwaveUser(hass, ENTITY_ID, {
+        user_name: "Alice",
+        user_type: "general",
+        active: true,
+        credential_type: "pin_code",
+        credential_data: "1234",
+      });
+
+      expect(hass.callService).toHaveBeenCalledWith(
+        "zwave_js",
+        "add_user",
+        {
+          user_name: "Alice",
+          user_type: "general",
+          active: true,
+          credential_type: "pin_code",
+          credential_data: "1234",
+        },
+        { entity_id: ENTITY_ID },
+        false,
+        true
+      );
+      expect(result).toEqual({ user_id: 1, credential_slot: 1 });
+    });
+
+    it("propagates errors from callService", async () => {
+      const hass = {
+        callService: vi.fn().mockRejectedValue(new Error("No slots")),
+      } as unknown as HomeAssistant;
+
+      await expect(
+        addZwaveUser(hass, ENTITY_ID, {
+          credential_type: "pin_code",
+          credential_data: "1234",
+        })
+      ).rejects.toThrow("No slots");
+    });
+  });
+
   describe("deleteZwaveUser", () => {
     it("calls the correct service with user_id and entity_id target", async () => {
       const hass = mockHass();