@zwave-js/cc 15.27.1 → 15.29.0

package/build/esm/cc/UserCredentialCC.js

@@ -4,7 +4,7 @@ const { validateArgs_UserCredentialCCAPI_setUser, validateArgs_UserCredentialCCA
 import { CommandClasses, MessagePriority, ZWaveError, ZWaveErrorCodes, encodeBitMask, parseBitMask, validatePayload, } from "@zwave-js/core";
 import { Bytes, getEnumMemberName, pick, stringToUint8ArrayUTF16BE, uint8ArrayToStringUTF16BE, } from "@zwave-js/shared";
 import { CCAPI, PhysicalCCAPI } from "../lib/API.js";
-import { CommandClass, } from "../lib/CommandClass.js";
+import { CommandClass, getEffectiveCCVersion, } from "../lib/CommandClass.js";
 import { API, CCCommand, ccValueProperty, ccValues, commandClass, expectedCCResponse, implementedVersion, useSupervision, } from "../lib/CommandClassDecorators.js";
 import { UserCredentialAdminCodeOperationResult, UserCredentialCommand, UserCredentialCredentialReportType, UserCredentialKeyLockerEntryType, UserCredentialLearnStatus, UserCredentialModifierType, UserCredentialNameEncoding, UserCredentialOperationType, UserCredentialRule, UserCredentialType, UserCredentialUserReportType, UserCredentialUserType, } from "../lib/_Types.js";
 function credentialToLogString(credential) {
@@ -141,8 +141,7 @@ let UserCredentialCCAPI = (() => {
                 }
                 case UserCredentialCommand.CredentialChecksumGet:
                 case UserCredentialCommand.CredentialChecksumReport: {
-                    return this.tryGetValueDB()?.getValue(UserCredentialCCValues.supportsCredentialChecksum
-                        .endpoint(this.endpoint.index));
+                    return this.tryGetValueDB()?.getValue(UserCredentialCCValues.supportsCredentialChecksum.endpoint(this.endpoint.index));
                 }
                 case UserCredentialCommand.AdminPinCodeSet:
                 case UserCredentialCommand.AdminPinCodeGet:
@@ -375,11 +374,7 @@ let UserCredentialCCAPI = (() => {
             });
             const response = await this.host.sendCommand(cc, this.commandOptions);
             if (response) {
-                return pick(response, [
-                    "occupied",
-                    "entryType",
-                    "entrySlot",
-                ]);
+                return pick(response, ["occupied", "entryType", "entrySlot"]);
             }
         }
         async sendUserCapabilitiesReport(options) {
@@ -730,7 +725,8 @@ let UserCredentialCC = (() => {
                     break; // No credential found, stop iterating
                 nextCredType = cred.nextCredentialType ?? UserCredentialType.None;
                 nextCredSlot = cred.nextCredentialSlot ?? 0;
-            } while (nextCredType !== UserCredentialType.None || nextCredSlot !== 0);
+            } while (nextCredType !== UserCredentialType.None
+                || nextCredSlot !== 0);
         }
         static getSupportedUsersCached(ctx, endpoint) {
             return ctx
@@ -984,7 +980,9 @@ let UserCredentialCCCredentialCapabilitiesReport = (() => {
         persistValues(ctx) {
             if (!super.persistValues(ctx))
                 return false;
-            this.setValue(ctx, UserCredentialCCValues.supportedCredentialTypes, [...this.credentialTypes.keys()]);
+            this.setValue(ctx, UserCredentialCCValues.supportedCredentialTypes, [
+                ...this.credentialTypes.keys(),
+            ]);
             for (const [credentialType, capability] of this.credentialTypes) {
                 this.setValue(ctx, UserCredentialCCValues.credentialCapabilities(credentialType), capability);
             }
@@ -993,9 +991,10 @@ let UserCredentialCCCredentialCapabilitiesReport = (() => {
         serialize(ctx) {
             const n = this.credentialTypes.size;
             this.payload = Bytes.alloc(2 + n * 9);
-            this.payload[0] = (this.supportsCredentialChecksum ? 0x80 : 0)
-                | (this.supportsAdminCode ? 0x40 : 0)
-                | (this.supportsAdminCodeDeactivation ? 0x20 : 0);
+            this.payload[0] =
+                (this.supportsCredentialChecksum ? 0x80 : 0)
+                    | (this.supportsAdminCode ? 0x40 : 0)
+                    | (this.supportsAdminCodeDeactivation ? 0x20 : 0);
             this.payload[1] = n;
             const credTypeOff = 2;
             const clSupportOff = credTypeOff + n;
@@ -1029,7 +1028,8 @@ let UserCredentialCCCredentialCapabilitiesReport = (() => {
                 "admin code deactivation support": this.supportsAdminCodeDeactivation,
             };
             for (const [credentialType, ct] of this.credentialTypes) {
-                message[`credential type ${getEnumMemberName(UserCredentialType, credentialType)}`] = `slots: ${ct.numberOfCredentialSlots}, length: ${ct.minCredentialLength}-${ct.maxCredentialLength}`;
+                message[`credential type ${getEnumMemberName(UserCredentialType, credentialType)}`] =
+                    `slots: ${ct.numberOfCredentialSlots}, length: ${ct.minCredentialLength}-${ct.maxCredentialLength}`;
             }
             return {
                 ...super.toLogEntry(ctx),
@@ -1109,6 +1109,9 @@ let UserCredentialCCKeyLockerCapabilitiesReport = (() => {
         persistValues(ctx) {
             if (!super.persistValues(ctx))
                 return false;
+            // This command only exists in V2. Ignore it if the device advertises a lower version.
+            if (getEffectiveCCVersion(ctx, this) < 2)
+                return true;
             this.setValue(ctx, UserCredentialCCValues.supportedKeyLockerEntryTypes, [...this.keyLockerCapabilities.keys()]);
             for (const [entryType, capability] of this.keyLockerCapabilities) {
                 this.setValue(ctx, UserCredentialCCValues.keyLockerCapabilities(entryType), capability);
@@ -1136,7 +1139,8 @@ let UserCredentialCCKeyLockerCapabilitiesReport = (() => {
         toLogEntry(ctx) {
             const message = {};
             for (const [entryType, capability] of this.keyLockerCapabilities) {
-                message[`entry type ${getEnumMemberName(UserCredentialKeyLockerEntryType, entryType)}`] = `slots: ${capability.numberOfEntrySlots}, length: ${capability.minEntryDataLength}-${capability.maxEntryDataLength}`;
+                message[`entry type ${getEnumMemberName(UserCredentialKeyLockerEntryType, entryType)}`] =
+                    `slots: ${capability.numberOfEntrySlots}, length: ${capability.minEntryDataLength}-${capability.maxEntryDataLength}`;
             }
             return {
                 ...super.toLogEntry(ctx),
@@ -1213,8 +1217,7 @@ let UserCredentialCCUserSet = (() => {
         userName;
         static from(raw, ctx) {
             validatePayload(raw.payload.length >= 3);
-            const operationType = raw.payload[0]
-                & 0b11;
+            const operationType = raw.payload[0] & 0b11;
             const userId = raw.payload.readUInt16BE(1);
             if (operationType === UserCredentialOperationType.Delete) {
                 return new this({
@@ -1299,8 +1302,7 @@ let UserCredentialCCUserSet = (() => {
                 expiringTimeoutMinutes = 0;
             }
             // Name encoding defaults to ASCII
-            const nameEncoding = this.nameEncoding
-                ?? UserCredentialNameEncoding.ASCII;
+            const nameEncoding = this.nameEncoding ?? UserCredentialNameEncoding.ASCII;
             // User name defaults to empty string
             const userName = this.userName ?? "";
             let nameBuffer;
@@ -1396,8 +1398,7 @@ let UserCredentialCCUserReport = (() => {
             const credentialRule = raw.payload[10];
             const expiringTimeoutMinutes = raw.payload.readUInt16BE(11);
             validatePayload(raw.payload.length >= 15);
-            const nameEncoding = raw.payload[13]
-                & 0b111;
+            const nameEncoding = raw.payload[13] & 0b111;
             const nameLength = raw.payload[14];
             validatePayload(raw.payload.length >= 15 + nameLength);
             let userName;
@@ -1480,8 +1481,7 @@ let UserCredentialCCUserReport = (() => {
                             || UserCredentialCCValues.credential.is(vid)
                             || UserCredentialCCValues.credentialOwner.is(vid)
                             || UserCredentialCCValues.credentialModifierType.is(vid)
-                            || UserCredentialCCValues
-                                .credentialModifierNodeId.is(vid)));
+                            || UserCredentialCCValues.credentialModifierNodeId.is(vid)));
                     for (const value of cachedUsersAndCredentials) {
                         valueDB.removeValue(value);
                     }
@@ -1491,8 +1491,7 @@ let UserCredentialCCUserReport = (() => {
             }
             // A UserModifyRejectedLocationEmpty report means we have a stale cache
             // entry for a user that no longer exists on the device.
-            if (this.reportType
-                === UserCredentialUserReportType.UserDeleted
+            if (this.reportType === UserCredentialUserReportType.UserDeleted
                 || this.reportType
                     === UserCredentialUserReportType.UserModifyRejectedLocationEmpty) {
                 // Remove all values for this user
@@ -1529,12 +1528,9 @@ let UserCredentialCCUserReport = (() => {
             }
             // A UserAddRejectedLocationOccupied report contains the data for the
             // existing user, so we can update our cache with the actual state.
-            if (this.reportType
-                !== UserCredentialUserReportType.ResponseToGet
-                && this.reportType
-                    !== UserCredentialUserReportType.UserAdded
-                && this.reportType
-                    !== UserCredentialUserReportType.UserModified
+            if (this.reportType !== UserCredentialUserReportType.ResponseToGet
+                && this.reportType !== UserCredentialUserReportType.UserAdded
+                && this.reportType !== UserCredentialUserReportType.UserModified
                 && this.reportType
                     !== UserCredentialUserReportType.UserAddRejectedLocationOccupied) {
                 return true;
@@ -1577,8 +1573,7 @@ let UserCredentialCCUserReport = (() => {
 })();
 export { UserCredentialCCUserReport };
 function testResponseForUserCredentialUserGet(sent, received) {
-    return (received.reportType
-        === UserCredentialUserReportType.ResponseToGet);
+    return received.reportType === UserCredentialUserReportType.ResponseToGet;
 }
 let UserCredentialCCUserGet = (() => {
     let _classDecorators = [CCCommand(UserCredentialCommand.UserGet), expectedCCResponse(UserCredentialCCUserReport, testResponseForUserCredentialUserGet)];
@@ -1632,8 +1627,7 @@ function testResponseForUserCredentialCredentialSet(sent, received) {
     // as the primary correlation. DuplicateCredential and DuplicateAdminPINCode
     // reports reference the EXISTING duplicate's (userId, slot) rather than
     // the requested location, so we cannot correlate them on slot.
-    if (received.reportType
-        === UserCredentialCredentialReportType.ResponseToGet) {
+    if (received.reportType === UserCredentialCredentialReportType.ResponseToGet) {
         return false;
     }
     if (received.credentialType !== sent.credentialType) {
@@ -1682,8 +1676,7 @@ let UserCredentialCCCredentialSet = (() => {
             const userId = raw.payload.readUInt16BE(0);
             const credentialType = raw.payload[2];
             const credentialSlot = raw.payload.readUInt16BE(3);
-            const operationType = raw.payload[5]
-                & 0b11;
+            const operationType = raw.payload[5] & 0b11;
             if (operationType === UserCredentialOperationType.Delete) {
                 return new this({
                     nodeId: ctx.sourceNodeId,
@@ -1847,8 +1840,8 @@ let UserCredentialCCCredentialReport = (() => {
             const offset = 8 + credentialData.length;
             this.payload[offset] = this.modifierType;
             this.payload.writeUInt16BE(this.modifierNodeId, offset + 1);
-            this.payload[offset + 3] = this.nextCredentialType
-                ?? UserCredentialType.None;
+            this.payload[offset + 3] =
+                this.nextCredentialType ?? UserCredentialType.None;
             this.payload.writeUInt16BE(this.nextCredentialSlot ?? 0, offset + 4);
             return super.serialize(ctx);
         }
@@ -1862,8 +1855,7 @@ let UserCredentialCCCredentialReport = (() => {
             if (this.reportType
                 === UserCredentialCredentialReportType.CredentialDeleted
                 || this.reportType
-                    === UserCredentialCredentialReportType
-                        .CredentialModifyRejectedLocationEmpty) {
+                    === UserCredentialCredentialReportType.CredentialModifyRejectedLocationEmpty) {
                 if (this.credentialType !== UserCredentialType.None
                     && this.credentialSlot !== 0) {
                     // Single credential. The (type, slot) tuple uniquely identifies
@@ -1879,7 +1871,7 @@ let UserCredentialCCCredentialReport = (() => {
                     const valueDB = this.getValueDB(ctx);
                     const credentialOwners = valueDB.findValues((vid) => UserCredentialCCValues.credentialOwner.is(vid)
                         && vid.endpoint === this.endpointIndex);
-                    for (const { endpoint, propertyKey, value } of credentialOwners) {
+                    for (const { endpoint, propertyKey, value, } of credentialOwners) {
                         // If a user ID is given, only delete credentials owned by that user
                         if (this.userId !== 0 && value !== this.userId)
                             continue;
@@ -1891,10 +1883,8 @@ let UserCredentialCCCredentialReport = (() => {
                             && cType !== this.credentialType) {
                             continue;
                         }
-                        valueDB.removeValue(UserCredentialCCValues.credential(cType, cSlot)
-                            .endpoint(endpoint));
-                        valueDB.removeValue(UserCredentialCCValues.credentialOwner(cType, cSlot)
-                            .endpoint(endpoint));
+                        valueDB.removeValue(UserCredentialCCValues.credential(cType, cSlot).endpoint(endpoint));
+                        valueDB.removeValue(UserCredentialCCValues.credentialOwner(cType, cSlot).endpoint(endpoint));
                         valueDB.removeValue(UserCredentialCCValues.credentialModifierType(cType, cSlot).endpoint(endpoint));
                         valueDB.removeValue(UserCredentialCCValues.credentialModifierNodeId(cType, cSlot).endpoint(endpoint));
                     }
@@ -1912,11 +1902,9 @@ let UserCredentialCCCredentialReport = (() => {
             // credential data in the read-back field when the device chooses to
             // reveal it, so we can update our cache with the real state.
             const isRejectionWithReadback = this.reportType
-                === UserCredentialCredentialReportType
-                    .CredentialAddRejectedLocationOccupied
+                === UserCredentialCredentialReportType.CredentialAddRejectedLocationOccupied
                 && this.credentialReadBack;
-            if (this.reportType
-                !== UserCredentialCredentialReportType.ResponseToGet
+            if (this.reportType !== UserCredentialCredentialReportType.ResponseToGet
                 && this.reportType
                     !== UserCredentialCredentialReportType.CredentialAdded
                 && this.reportType
@@ -1959,8 +1947,7 @@ let UserCredentialCCCredentialReport = (() => {
 })();
 export { UserCredentialCCCredentialReport };
 function testResponseForUserCredentialCredentialGet(_sent, received) {
-    return (received.reportType
-        === UserCredentialCredentialReportType.ResponseToGet);
+    return (received.reportType === UserCredentialCredentialReportType.ResponseToGet);
 }
 let UserCredentialCCCredentialGet = (() => {
     let _classDecorators = [CCCommand(UserCredentialCommand.CredentialGet), expectedCCResponse(UserCredentialCCCredentialReport, testResponseForUserCredentialCredentialGet)];
@@ -2052,8 +2039,7 @@ let UserCredentialCCCredentialLearnStart = (() => {
             const userId = raw.payload.readUInt16BE(0);
             const credentialType = raw.payload[2];
             const credentialSlot = raw.payload.readUInt16BE(3);
-            const operationType = raw.payload[5]
-                & 0b11;
+            const operationType = raw.payload[5] & 0b11;
             const learnTimeout = raw.payload[6];
             return new this({
                 nodeId: ctx.sourceNodeId,
@@ -2663,8 +2649,9 @@ let UserCredentialCCAdminPinCodeReport = (() => {
         serialize(ctx) {
             const pinBuffer = Bytes.from(this.pinCode, "ascii");
             this.payload = Bytes.alloc(1 + pinBuffer.length);
-            this.payload[0] = ((this.operationResult & 0b1111) << 4)
-                | (pinBuffer.length & 0b1111);
+            this.payload[0] =
+                ((this.operationResult & 0b1111) << 4)
+                    | (pinBuffer.length & 0b1111);
             if (pinBuffer.length > 0) {
                 this.payload.set(pinBuffer, 1);
             }
@@ -2749,8 +2736,7 @@ let UserCredentialCCKeyLockerEntrySet = (() => {
             validatePayload(raw.payload.length >= 4);
             const entryType = raw.payload[0];
             const entrySlot = raw.payload.readUInt16BE(1);
-            const operationType = raw.payload[3]
-                & 0b11;
+            const operationType = raw.payload[3] & 0b11;
             if (operationType === UserCredentialOperationType.Delete) {
                 return new this({
                     nodeId: ctx.sourceNodeId,
@@ -2856,6 +2842,9 @@ let UserCredentialCCKeyLockerEntryReport = (() => {
         persistValues(ctx) {
             if (!super.persistValues(ctx))
                 return false;
+            // This command only exists in V2. Ignore it if the device advertises a lower version.
+            if (getEffectiveCCVersion(ctx, this) < 2)
+                return true;
             this.setValue(ctx, UserCredentialCCValues.keyLockerEntry(this.entryType, this.entrySlot), this.occupied);
             return true;
         }
@@ -2874,8 +2863,8 @@ let UserCredentialCCKeyLockerEntryReport = (() => {
 })();
 export { UserCredentialCCKeyLockerEntryReport };
 function testResponseForUserCredentialKeyLockerEntryGet(sent, received) {
-    return received.entryType === sent.entryType
-        && received.entrySlot === sent.entrySlot;
+    return (received.entryType === sent.entryType
+        && received.entrySlot === sent.entrySlot);
 }
 let UserCredentialCCKeyLockerEntryGet = (() => {
     let _classDecorators = [CCCommand(UserCredentialCommand.KeyLockerEntryGet), expectedCCResponse(UserCredentialCCKeyLockerEntryReport, testResponseForUserCredentialKeyLockerEntryGet)];