@zwave-js/cc 15.20.1 → 15.21.0

package/build/cjs/cc/ConfigurationCC.d.ts

@@ -1,71 +1,18 @@
-import type { CCEncodingContext, CCParsingContext } from "@zwave-js/cc";
 import type { GetDeviceConfig, ParamInfoMap } from "@zwave-js/config";
-import { CommandClasses, ConfigValueFormat, type ConfigurationMetadata, type ControlsCC, type EndpointId, type GetEndpoint, type GetNode, type GetSupportedCCVersion, type GetValueDB, type MaybeNotKnown, type MessageOrCCLogEntry, type NodeId, type SupervisionResult, type SupportsCC, type ValueID, type WithAddress, ZWaveError, ZWaveErrorCodes } from "@zwave-js/core";
+import { ConfigValueFormat, type ConfigurationMetadata, type ControlsCC, type EndpointId, type GetEndpoint, type GetNode, type GetSupportedCCVersion, type GetValueDB, type MaybeNotKnown, type MessageOrCCLogEntry, type NodeId, type SupervisionResult, type SupportsCC, type ValueID, type WithAddress, ZWaveError, ZWaveErrorCodes } from "@zwave-js/core";
 import { Bytes } from "@zwave-js/shared";
 import { CCAPI, POLL_VALUE, type PollValueImplementation, SET_VALUE, type SetValueImplementation } from "../lib/API.js";
 import { type CCRaw, CommandClass, type InterviewContext, type PersistValuesContext, type RefreshValuesContext } from "../lib/CommandClass.js";
 import { type ConfigValue, ConfigurationCommand } from "../lib/_Types.js";
+import type { CCEncodingContext, CCParsingContext } from "../lib/traits.js";
 export declare class ConfigurationCCError extends ZWaveError {
     readonly message: string;
     readonly code: ZWaveErrorCodes;
     readonly argument: number;
     constructor(message: string, code: ZWaveErrorCodes, argument: number);
 }
-export declare const ConfigurationCCValues: Readonly<{
-    isParamInformationFromConfig: {
-        id: {
-            readonly commandClass: CommandClasses.Configuration;
-            readonly property: "isParamInformationFromConfig";
-        };
-        endpoint: (_endpoint?: number) => {
-            readonly commandClass: CommandClasses.Configuration;
-            readonly endpoint: 0;
-            readonly property: "isParamInformationFromConfig";
-        };
-        is: (valueId: ValueID) => boolean;
-        readonly meta: Readonly<{
-            readonly type: "any";
-            readonly readable: true;
-            readonly writeable: true;
-        }>;
-        options: {
-            readonly internal: true;
-            readonly minVersion: 1;
-            readonly secret: false;
-            readonly stateful: true;
-            readonly supportsEndpoints: false;
-            readonly autoCreate: true;
-        };
-    };
-    paramInformation: ((parameter: number, bitMask?: number) => {
-        id: {
-            readonly commandClass: CommandClasses.Configuration;
-            readonly property: number;
-            readonly propertyKey: number | undefined;
-        };
-        endpoint: (endpoint?: number) => {
-            readonly commandClass: CommandClasses.Configuration;
-            readonly endpoint: number;
-            readonly property: number;
-            readonly propertyKey: number | undefined;
-        };
-        readonly meta: Readonly<{
-            readonly type: "any";
-            readonly readable: true;
-            readonly writeable: true;
-        }>;
-    }) & {
-        is: (valueId: ValueID) => boolean;
-        options: {
-            readonly internal: false;
-            readonly minVersion: 1;
-            readonly secret: false;
-            readonly stateful: true;
-            readonly supportsEndpoints: true;
-            readonly autoCreate: true;
-        };
-    };
-}>;
+import { ConfigurationCCValues } from "./_CCValues.generated.js";
+export { ConfigurationCCValues };
 /** @publicAPI */
 export type ConfigurationCCAPISetOptions = {
     parameter: number;
@@ -82,9 +29,11 @@ export type ConfigurationCCAPISetOptions = {
     value: number;
 });
 /**
- * Updates the stored metadata labels and descriptions from the device config file.
+ * Refreshes all stored configuration parameter metadata from the device config file.
+ * This handles updates to existing params, addition of new params,
+ * and removal/hiding of old params.
  */
-export declare function refreshMetadataStringsFromConfigFile(ctx: GetValueDB & GetDeviceConfig, nodeId: number, endpointIndex: number): void;
+export declare function refreshConfigParamMetadataFromConfigFile(ctx: GetValueDB & GetDeviceConfig, nodeId: number, endpointIndex: number): void;
 export declare class ConfigurationCCAPI extends CCAPI {
     supportsCommand(cmd: ConfigurationCommand): MaybeNotKnown<boolean>;
     protected get [SET_VALUE](): SetValueImplementation;
@@ -133,7 +82,7 @@ export declare class ConfigurationCCAPI extends CCAPI {
     resetBulk(parameters: number[]): Promise<SupervisionResult | undefined>;
     /** Resets all configuration parameters to their default value */
     resetAll(): Promise<void>;
-    getProperties(parameter: number): Promise<Pick<ConfigurationCCPropertiesReport, "valueSize" | "isAdvanced" | "valueFormat" | "minValue" | "maxValue" | "defaultValue" | "nextParameter" | "altersCapabilities" | "isReadonly" | "noBulkSupport"> | undefined>;
+    getProperties(parameter: number): Promise<Pick<ConfigurationCCPropertiesReport, "minValue" | "maxValue" | "valueSize" | "valueFormat" | "defaultValue" | "nextParameter" | "altersCapabilities" | "isReadonly" | "isAdvanced" | "noBulkSupport"> | undefined>;
     /** Requests the name of a configuration parameter from the node */
     getName(parameter: number): Promise<MaybeNotKnown<string>>;
     /** Requests usage info for a configuration parameter from the node */

package/build/cjs/cc/ConfigurationCC.js

@@ -46,7 +46,7 @@ __export(ConfigurationCC_exports, {
   ConfigurationCCReport: () => ConfigurationCCReport,
   ConfigurationCCSet: () => ConfigurationCCSet,
   ConfigurationCCValues: () => import_CCValues_generated.ConfigurationCCValues,
-  refreshMetadataStringsFromConfigFile: () => refreshMetadataStringsFromConfigFile
+  refreshConfigParamMetadataFromConfigFile: () => refreshConfigParamMetadataFromConfigFile
 });
 module.exports = __toCommonJS(ConfigurationCC_exports);
 var __validateArgs = __toESM(require("./ConfigurationCC._validateArgs.js"), 1);
@@ -56,7 +56,6 @@ var import_arrays = require("alcalzone-shared/arrays");
 var import_API = require("../lib/API.js");
 var import_CommandClass = require("../lib/CommandClass.js");
 var import_CommandClassDecorators = require("../lib/CommandClassDecorators.js");
-var import_Values = require("../lib/Values.js");
 var import_Types = require("../lib/_Types.js");
 var import_CCValues_generated = require("./_CCValues.generated.js");
 var __runInitializers = function(thisArg, initializers, value) {
@@ -207,44 +206,79 @@ function getParamInformationFromConfigFile(ctx, nodeId, endpointIndex) {
   }
 }
 __name(getParamInformationFromConfigFile, "getParamInformationFromConfigFile");
-function refreshMetadataStringsFromConfigFile(ctx, nodeId, endpointIndex) {
+function configParamInfoToMetadata(info) {
+  return (0, import_core.stripUndefined)({
+    // TODO: Make this smarter! (0...1 ==> boolean)
+    type: "number",
+    valueSize: info.valueSize,
+    min: info.minValue,
+    max: info.maxValue,
+    allowed: info.allowed,
+    default: info.defaultValue,
+    recommended: info.recommendedValue,
+    unit: info.unit,
+    format: info.unsigned ? import_core.ConfigValueFormat.UnsignedInteger : import_core.ConfigValueFormat.SignedInteger,
+    readable: !info.writeOnly,
+    writeable: !info.readOnly,
+    allowManualEntry: info.allowManualEntry,
+    states: info.options.length > 0 ? Object.fromEntries(info.options.map(({ label, value }) => [
+      value.toString(),
+      label
+    ])) : void 0,
+    label: info.label,
+    description: info.description,
+    isFromConfig: true,
+    destructive: info.destructive,
+    purpose: info.purpose
+  });
+}
+__name(configParamInfoToMetadata, "configParamInfoToMetadata");
+function refreshConfigParamMetadataFromConfigFile(ctx, nodeId, endpointIndex) {
   const paramInfo = getParamInformationFromConfigFile(ctx, nodeId, endpointIndex);
-  if (!paramInfo)
-    return;
   const valueDB = ctx.getValueDB(nodeId);
-  for (const [param, info] of paramInfo.entries()) {
-    const valueId = import_CCValues_generated.ConfigurationCCValues.paramInformation(param.parameter, param.valueBitMask).endpoint(endpointIndex);
-    const existing = valueDB.getMetadata(valueId);
-    if (!existing)
+  const configParamKeys = /* @__PURE__ */ new Set();
+  if (paramInfo) {
+    for (const [param, info] of paramInfo.entries()) {
+      const paramKey = `${param.parameter}:${param.valueBitMask ?? ""}`;
+      configParamKeys.add(paramKey);
+      const valueId = import_CCValues_generated.ConfigurationCCValues.paramInformation(param.parameter, param.valueBitMask).endpoint(endpointIndex);
+      const existing = valueDB.getMetadata(valueId);
+      if (info.hidden) {
+        if (existing) {
+          valueDB.setMetadata(valueId, void 0);
+          valueDB.removeValue(valueId);
+        }
+        continue;
+      }
+      const newMeta = configParamInfoToMetadata(info);
+      if (!existing || existing.isFromConfig) {
+        valueDB.setMetadata(valueId, newMeta);
+      } else {
+        const merged = {
+          ...existing,
+          ...newMeta,
+          valueSize: existing.valueSize,
+          format: existing.format
+        };
+        valueDB.setMetadata(valueId, merged);
+      }
+    }
+  }
+  for (const meta of valueDB.getAllMetadata(import_core.CommandClasses.Configuration)) {
+    if (typeof meta.property !== "number" || (meta.endpoint ?? 0) !== endpointIndex) {
       continue;
+    }
+    const existing = meta.metadata;
     if (!existing.isFromConfig)
       continue;
-    let didChange = false;
-    if (info.label !== existing.label) {
-      existing.label = info.label;
-      didChange = true;
-    }
-    if (info.description !== existing.description) {
-      existing.description = info.description;
-      didChange = true;
-    }
-    if (info.recommendedValue !== existing.recommended) {
-      existing.recommended = info.recommendedValue;
-      didChange = true;
-    }
-    if (existing.states) {
-      for (const option of info.options) {
-        if (option.value in existing.states && existing.states[option.value] !== option.label) {
-          existing.states[option.value] = option.label;
-          didChange = true;
-        }
-      }
+    const paramKey = `${meta.property}:${meta.propertyKey ?? ""}`;
+    if (!configParamKeys.has(paramKey)) {
+      valueDB.setMetadata(meta, void 0);
+      valueDB.removeValue(meta);
     }
-    if (didChange)
-      valueDB.setMetadata(valueId, existing);
   }
 }
-__name(refreshMetadataStringsFromConfigFile, "refreshMetadataStringsFromConfigFile");
+__name(refreshConfigParamMetadataFromConfigFile, "refreshConfigParamMetadataFromConfigFile");
 let ConfigurationCCAPI = (() => {
   let _classDecorators = [(0, import_CommandClassDecorators.API)(import_core.CommandClasses.Configuration)];
   let _classDescriptor;
@@ -272,8 +306,8 @@ let ConfigurationCCAPI = (() => {
       const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(_classSuper[Symbol.metadata] ?? null) : void 0;
       _get_decorators = [validateArgs_ConfigurationCCAPI_get()];
       _getBulk_decorators = [validateArgs_ConfigurationCCAPI_getBulk()];
-      _set_decorators = [validateArgs_ConfigurationCCAPI_set({ strictEnums: true })];
-      _setBulk_decorators = [validateArgs_ConfigurationCCAPI_setBulk({ strictEnums: true })];
+      _set_decorators = [validateArgs_ConfigurationCCAPI_set()];
+      _setBulk_decorators = [validateArgs_ConfigurationCCAPI_setBulk()];
       _reset_decorators = [validateArgs_ConfigurationCCAPI_reset()];
       _resetBulk_decorators = [validateArgs_ConfigurationCCAPI_resetBulk()];
       _getProperties_decorators = [validateArgs_ConfigurationCCAPI_getProperties()];
@@ -994,7 +1028,7 @@ alters capabilities: ${!!properties.altersCapabilities}`;
      */
     getParamInformation(ctx, parameter, valueBitMask) {
       return this.getMetadata(ctx, import_CCValues_generated.ConfigurationCCValues.paramInformation(parameter, valueBitMask)) ?? {
-        ...import_core.ValueMetadata.Any
+        ...import_core.ValueMetadata.Number
       };
     }
     /**
@@ -1056,29 +1090,7 @@ alters capabilities: ${!!properties.altersCapabilities}`;
         if (info.hidden) {
           continue;
         }
-        const paramInfo = (0, import_core.stripUndefined)({
-          // TODO: Make this smarter! (0...1 ==> boolean)
-          type: "number",
-          valueSize: info.valueSize,
-          min: info.minValue,
-          max: info.maxValue,
-          allowed: info.allowed,
-          default: info.defaultValue,
-          recommended: info.recommendedValue,
-          unit: info.unit,
-          format: info.unsigned ? import_core.ConfigValueFormat.UnsignedInteger : import_core.ConfigValueFormat.SignedInteger,
-          readable: !info.writeOnly,
-          writeable: !info.readOnly,
-          allowManualEntry: info.allowManualEntry,
-          states: info.options.length > 0 ? Object.fromEntries(info.options.map(({ label, value }) => [
-            value.toString(),
-            label
-          ])) : void 0,
-          label: info.label,
-          description: info.description,
-          isFromConfig: true,
-          destructive: info.destructive
-        });
+        const paramInfo = configParamInfoToMetadata(info);
         this.extendParamInformation(ctx, param.parameter, param.valueBitMask, paramInfo);
       }
       this.setValue(ctx, import_CCValues_generated.ConfigurationCCValues.isParamInformationFromConfig, true);
@@ -2263,6 +2275,6 @@ __name(serializeValue, "serializeValue");
   ConfigurationCCReport,
   ConfigurationCCSet,
   ConfigurationCCValues,
-  refreshMetadataStringsFromConfigFile
+  refreshConfigParamMetadataFromConfigFile
 });
 //# sourceMappingURL=ConfigurationCC.js.map