@zwave-js/cc 14.3.10 → 15.0.0-beta.1

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

@@ -1,98 +1,105 @@
-import { type Notification, type NotificationState, type WithAddress } from "@zwave-js/core";
+import { type CCEncodingContext, type CCParsingContext } from "@zwave-js/cc";
+import { type GetDeviceConfig } from "@zwave-js/config";
+import { type GetNode, type GetSupportedCCVersion, type GetValueDB, type Notification, type NotificationState, type WithAddress } from "@zwave-js/core";
 import { CommandClasses, type ControlsCC, Duration, type EndpointId, type GetEndpoint, type MaybeNotKnown, type MessageOrCCLogEntry, type NodeId, type SinglecastCC, type SupervisionResult, type SupportsCC, type ValueID, type ValueMetadataNumeric } from "@zwave-js/core/safe";
-import type { CCEncodingContext, CCParsingContext, GetDeviceConfig, GetNode, GetSupportedCCVersion, GetValueDB } from "@zwave-js/host/safe";
 import { Bytes } from "@zwave-js/shared/safe";
 import { POLL_VALUE, PhysicalCCAPI, type PollValueImplementation } from "../lib/API.js";
 import { CCRaw, CommandClass, type InterviewContext, type PersistValuesContext, type RefreshValuesContext } from "../lib/CommandClass.js";
 import { NotificationCommand } from "../lib/_Types.js";
 export declare const NotificationCCValues: Readonly<{
-    notificationVariable: ((notificationName: string, variableName: string) => {
-        readonly meta: {
+    supportsV1Alarm: {
+        id: {
+            readonly commandClass: CommandClasses.Notification;
+            readonly property: "supportsV1Alarm";
+        };
+        endpoint: (_endpoint?: number) => {
+            readonly commandClass: CommandClasses.Notification;
+            readonly endpoint: 0;
+            readonly property: "supportsV1Alarm";
+        };
+        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;
         };
-        readonly id: {
-            commandClass: CommandClasses.Notification;
-            property: string;
-            propertyKey: string;
+    };
+    supportedNotificationTypes: {
+        id: {
+            readonly commandClass: CommandClasses.Notification;
+            readonly property: "supportedNotificationTypes";
         };
-        readonly endpoint: (endpoint?: number | undefined) => {
+        endpoint: (_endpoint?: number) => {
             readonly commandClass: CommandClasses.Notification;
-            readonly endpoint: number;
-            readonly property: string;
-            readonly propertyKey: string;
+            readonly endpoint: 0;
+            readonly property: "supportedNotificationTypes";
         };
-    }) & {
         is: (valueId: ValueID) => boolean;
-        readonly options: {
-            readonly internal: false;
+        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: true;
+            readonly supportsEndpoints: false;
             readonly autoCreate: true;
         };
     };
-    unknownNotificationVariable: ((notificationType: number, notificationName: string) => {
-        readonly meta: {
-            readonly label: `${string}: Unknown value`;
-            readonly ccSpecific: {
-                readonly notificationType: number;
-            };
-            readonly writeable: false;
-            readonly min: 0;
-            readonly max: 255;
-            readonly type: "number";
-            readonly readable: true;
-        };
-        readonly id: {
-            commandClass: CommandClasses.Notification;
-            property: string;
-            propertyKey: "unknown";
+    notificationMode: {
+        id: {
+            readonly commandClass: CommandClasses.Notification;
+            readonly property: "notificationMode";
         };
-        readonly endpoint: (endpoint?: number | undefined) => {
+        endpoint: (_endpoint?: number) => {
             readonly commandClass: CommandClasses.Notification;
-            readonly endpoint: number;
-            readonly property: string;
-            readonly propertyKey: "unknown";
+            readonly endpoint: 0;
+            readonly property: "notificationMode";
         };
-    }) & {
         is: (valueId: ValueID) => boolean;
-        readonly options: {
-            readonly internal: false;
+        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: true;
+            readonly supportsEndpoints: false;
             readonly autoCreate: true;
         };
     };
-    unknownNotificationType: ((notificationType: number) => {
-        readonly meta: {
-            readonly label: `Unknown notification (${string})`;
-            readonly ccSpecific: {
-                readonly notificationType: number;
-            };
-            readonly writeable: false;
-            readonly min: 0;
-            readonly max: 255;
-            readonly type: "number";
-            readonly readable: true;
-        };
-        readonly id: {
-            commandClass: CommandClasses.Notification;
-            property: string;
+    lastRefresh: {
+        id: {
+            readonly commandClass: CommandClasses.Notification;
+            readonly property: "lastRefresh";
         };
-        readonly endpoint: (endpoint?: number | undefined) => {
+        endpoint: (endpoint?: number) => {
             readonly commandClass: CommandClasses.Notification;
             readonly endpoint: number;
-            readonly property: string;
+            readonly property: "lastRefresh";
         };
-    }) & {
         is: (valueId: ValueID) => boolean;
-        readonly options: {
-            readonly internal: false;
+        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;
@@ -100,84 +107,75 @@ export declare const NotificationCCValues: Readonly<{
             readonly autoCreate: true;
         };
     };
-    supportedNotificationEvents: ((notificationType: number) => {
-        readonly meta: {
-            readonly type: "any";
-            readonly readable: true;
-            readonly writeable: true;
-        };
-        readonly id: {
-            commandClass: CommandClasses.Notification;
-            property: "supportedNotificationEvents";
-            propertyKey: number;
+    alarmType: {
+        id: {
+            readonly commandClass: CommandClasses.Notification;
+            readonly property: "alarmType";
         };
-        readonly endpoint: (endpoint?: number | undefined) => {
+        endpoint: (endpoint?: number) => {
             readonly commandClass: CommandClasses.Notification;
             readonly endpoint: number;
-            readonly property: "supportedNotificationEvents";
-            readonly propertyKey: number;
+            readonly property: "alarmType";
         };
-    }) & {
         is: (valueId: ValueID) => boolean;
-        readonly options: {
-            readonly stateful: true;
-            readonly secret: false;
+        readonly meta: {
+            readonly label: "Alarm Type";
+            readonly writeable: false;
+            readonly min: 0;
+            readonly max: 255;
+            readonly type: "number";
+            readonly readable: true;
+        };
+        options: {
+            readonly internal: false;
             readonly minVersion: 1;
+            readonly secret: false;
+            readonly stateful: true;
+            readonly supportsEndpoints: true;
             readonly autoCreate: true;
-            readonly internal: true;
-            readonly supportsEndpoints: false;
         };
     };
-    doorTiltState: {
-        readonly id: {
-            commandClass: CommandClasses.Notification;
-            property: "Access Control";
-            propertyKey: "Door tilt state";
+    alarmLevel: {
+        id: {
+            readonly commandClass: CommandClasses.Notification;
+            readonly property: "alarmLevel";
         };
-        readonly endpoint: (endpoint?: number | undefined) => {
+        endpoint: (endpoint?: number) => {
             readonly commandClass: CommandClasses.Notification;
             readonly endpoint: number;
-            readonly property: "Access Control";
-            readonly propertyKey: "Door tilt state";
+            readonly property: "alarmLevel";
         };
-        readonly is: (valueId: ValueID) => boolean;
+        is: (valueId: ValueID) => boolean;
         readonly meta: {
-            readonly label: "Door tilt state";
-            readonly states: {
-                readonly 0: "Window/door is not tilted";
-                readonly 1: "Window/door is tilted";
-            };
-            readonly ccSpecific: {
-                readonly notificationType: 6;
-            };
+            readonly label: "Alarm Level";
             readonly writeable: false;
             readonly min: 0;
             readonly max: 255;
             readonly type: "number";
             readonly readable: true;
         };
-        readonly options: {
-            readonly stateful: true;
-            readonly secret: false;
+        options: {
             readonly internal: false;
             readonly minVersion: 1;
+            readonly secret: false;
+            readonly stateful: true;
             readonly supportsEndpoints: true;
-            readonly autoCreate: false;
+            readonly autoCreate: true;
         };
     };
     doorStateSimple: {
-        readonly id: {
-            commandClass: CommandClasses.Notification;
-            property: "Access Control";
-            propertyKey: "Door state (simple)";
+        id: {
+            readonly commandClass: CommandClasses.Notification;
+            readonly property: "Access Control";
+            readonly propertyKey: "Door state (simple)";
         };
-        readonly endpoint: (endpoint?: number | undefined) => {
+        endpoint: (endpoint?: number) => {
             readonly commandClass: CommandClasses.Notification;
             readonly endpoint: number;
             readonly property: "Access Control";
             readonly propertyKey: "Door state (simple)";
         };
-        readonly is: (valueId: ValueID) => boolean;
+        is: (valueId: ValueID) => boolean;
         readonly meta: {
             readonly label: "Door state (simple)";
             readonly states: {
@@ -193,172 +191,176 @@ export declare const NotificationCCValues: Readonly<{
             readonly type: "number";
             readonly readable: true;
         };
-        readonly options: {
-            readonly stateful: true;
-            readonly secret: false;
+        options: {
             readonly internal: false;
             readonly minVersion: 1;
+            readonly secret: false;
+            readonly stateful: true;
             readonly supportsEndpoints: true;
             readonly autoCreate: (ctx: GetValueDB, endpoint: EndpointId) => boolean;
         };
     };
-    alarmLevel: {
-        readonly id: {
-            commandClass: CommandClasses.Notification;
-            property: "alarmLevel";
+    doorTiltState: {
+        id: {
+            readonly commandClass: CommandClasses.Notification;
+            readonly property: "Access Control";
+            readonly propertyKey: "Door tilt state";
         };
-        readonly endpoint: (endpoint?: number | undefined) => {
+        endpoint: (endpoint?: number) => {
             readonly commandClass: CommandClasses.Notification;
             readonly endpoint: number;
-            readonly property: "alarmLevel";
+            readonly property: "Access Control";
+            readonly propertyKey: "Door tilt state";
         };
-        readonly is: (valueId: ValueID) => boolean;
+        is: (valueId: ValueID) => boolean;
         readonly meta: {
-            readonly label: "Alarm Level";
+            readonly label: "Door tilt state";
+            readonly states: {
+                readonly 0: "Window/door is not tilted";
+                readonly 1: "Window/door is tilted";
+            };
+            readonly ccSpecific: {
+                readonly notificationType: 6;
+            };
             readonly writeable: false;
             readonly min: 0;
             readonly max: 255;
             readonly type: "number";
             readonly readable: true;
         };
-        readonly options: {
+        options: {
             readonly internal: false;
             readonly minVersion: 1;
             readonly secret: false;
             readonly stateful: true;
             readonly supportsEndpoints: true;
-            readonly autoCreate: true;
+            readonly autoCreate: false;
         };
     };
-    alarmType: {
-        readonly id: {
-            commandClass: CommandClasses.Notification;
-            property: "alarmType";
+    supportedNotificationEvents: ((notificationType: number) => {
+        id: {
+            readonly commandClass: CommandClasses.Notification;
+            readonly property: "supportedNotificationEvents";
+            readonly propertyKey: number;
         };
-        readonly endpoint: (endpoint?: number | undefined) => {
+        endpoint: (_endpoint?: number) => {
             readonly commandClass: CommandClasses.Notification;
-            readonly endpoint: number;
-            readonly property: "alarmType";
+            readonly endpoint: 0;
+            readonly property: "supportedNotificationEvents";
+            readonly propertyKey: number;
         };
-        readonly is: (valueId: ValueID) => boolean;
-        readonly meta: {
-            readonly label: "Alarm Type";
-            readonly writeable: false;
-            readonly min: 0;
-            readonly max: 255;
-            readonly type: "number";
+        readonly meta: Readonly<{
+            readonly type: "any";
             readonly readable: true;
-        };
-        readonly options: {
-            readonly internal: false;
+            readonly writeable: true;
+        }>;
+    }) & {
+        is: (valueId: ValueID) => boolean;
+        options: {
+            readonly internal: true;
             readonly minVersion: 1;
             readonly secret: false;
             readonly stateful: true;
-            readonly supportsEndpoints: true;
+            readonly supportsEndpoints: false;
             readonly autoCreate: true;
         };
     };
-    lastRefresh: {
-        readonly id: {
-            commandClass: CommandClasses.Notification;
-            property: "lastRefresh";
+    unknownNotificationType: ((notificationType: number) => {
+        id: {
+            readonly commandClass: CommandClasses.Notification;
+            readonly property: string;
         };
-        readonly endpoint: (endpoint?: number | undefined) => {
+        endpoint: (endpoint?: number) => {
             readonly commandClass: CommandClasses.Notification;
             readonly endpoint: number;
-            readonly property: "lastRefresh";
+            readonly property: string;
         };
-        readonly is: (valueId: ValueID) => boolean;
         readonly meta: {
-            readonly type: "any";
+            readonly label: `Unknown notification (${string})`;
+            readonly ccSpecific: {
+                readonly notificationType: number;
+            };
+            readonly writeable: false;
+            readonly min: 0;
+            readonly max: 255;
+            readonly type: "number";
             readonly readable: true;
-            readonly writeable: true;
         };
-        readonly options: {
-            readonly stateful: true;
-            readonly secret: false;
+    }) & {
+        is: (valueId: ValueID) => boolean;
+        options: {
+            readonly internal: false;
             readonly minVersion: 1;
+            readonly secret: false;
+            readonly stateful: true;
             readonly supportsEndpoints: true;
             readonly autoCreate: true;
-            readonly internal: true;
         };
     };
-    notificationMode: {
-        readonly id: {
-            commandClass: CommandClasses.Notification;
-            property: "notificationMode";
-        };
-        readonly endpoint: (endpoint?: number | undefined) => {
+    unknownNotificationVariable: ((notificationType: number, notificationName: string) => {
+        id: {
             readonly commandClass: CommandClasses.Notification;
-            readonly endpoint: number;
-            readonly property: "notificationMode";
-        };
-        readonly is: (valueId: ValueID) => boolean;
-        readonly meta: {
-            readonly type: "any";
-            readonly readable: true;
-            readonly writeable: true;
-        };
-        readonly options: {
-            readonly stateful: true;
-            readonly secret: false;
-            readonly minVersion: 1;
-            readonly autoCreate: true;
-            readonly internal: true;
-            readonly supportsEndpoints: false;
-        };
-    };
-    supportedNotificationTypes: {
-        readonly id: {
-            commandClass: CommandClasses.Notification;
-            property: "supportedNotificationTypes";
+            readonly property: string;
+            readonly propertyKey: "unknown";
         };
-        readonly endpoint: (endpoint?: number | undefined) => {
+        endpoint: (endpoint?: number) => {
             readonly commandClass: CommandClasses.Notification;
             readonly endpoint: number;
-            readonly property: "supportedNotificationTypes";
+            readonly property: string;
+            readonly propertyKey: "unknown";
         };
-        readonly is: (valueId: ValueID) => boolean;
         readonly meta: {
-            readonly type: "any";
+            readonly label: `${string}: Unknown value`;
+            readonly ccSpecific: {
+                readonly notificationType: number;
+            };
+            readonly writeable: false;
+            readonly min: 0;
+            readonly max: 255;
+            readonly type: "number";
             readonly readable: true;
-            readonly writeable: true;
         };
-        readonly options: {
-            readonly stateful: true;
-            readonly secret: false;
+    }) & {
+        is: (valueId: ValueID) => boolean;
+        options: {
+            readonly internal: false;
             readonly minVersion: 1;
+            readonly secret: false;
+            readonly stateful: true;
+            readonly supportsEndpoints: true;
             readonly autoCreate: true;
-            readonly internal: true;
-            readonly supportsEndpoints: false;
         };
     };
-    supportsV1Alarm: {
-        readonly id: {
-            commandClass: CommandClasses.Notification;
-            property: "supportsV1Alarm";
+    notificationVariable: ((notificationName: string, variableName: string) => {
+        id: {
+            readonly commandClass: CommandClasses.Notification;
+            readonly property: string;
+            readonly propertyKey: string;
         };
-        readonly endpoint: (endpoint?: number | undefined) => {
+        endpoint: (endpoint?: number) => {
             readonly commandClass: CommandClasses.Notification;
             readonly endpoint: number;
-            readonly property: "supportsV1Alarm";
+            readonly property: string;
+            readonly propertyKey: string;
         };
-        readonly is: (valueId: ValueID) => boolean;
-        readonly meta: {
+        readonly meta: Readonly<{
             readonly type: "any";
             readonly readable: true;
             readonly writeable: true;
-        };
-        readonly options: {
-            readonly stateful: true;
-            readonly secret: false;
+        }>;
+    }) & {
+        is: (valueId: ValueID) => boolean;
+        options: {
+            readonly internal: false;
             readonly minVersion: 1;
+            readonly secret: false;
+            readonly stateful: true;
+            readonly supportsEndpoints: true;
             readonly autoCreate: true;
-            readonly internal: true;
-            readonly supportsEndpoints: false;
         };
     };
 }>;
+export declare function shouldAutoCreateSimpleDoorSensorValue(ctx: GetValueDB, endpoint: EndpointId): boolean;
 export declare class NotificationCCAPI extends PhysicalCCAPI {
     supportsCommand(cmd: NotificationCommand): MaybeNotKnown<boolean>;
     protected get [POLL_VALUE](): PollValueImplementation;
@@ -395,7 +397,7 @@ export declare class NotificationCCSet extends NotificationCC {
     static from(raw: CCRaw, ctx: CCParsingContext): NotificationCCSet;
     notificationType: number;
     notificationStatus: boolean;
-    serialize(ctx: CCEncodingContext): Bytes;
+    serialize(ctx: CCEncodingContext): Promise<Bytes>;
     toLogEntry(ctx?: GetValueDB): MessageOrCCLogEntry;
 }
 export type NotificationCCReportOptions = {
@@ -420,7 +422,7 @@ export declare class NotificationCCReport extends NotificationCC {
     sequenceNumber: number | undefined;
     toLogEntry(ctx?: GetValueDB): MessageOrCCLogEntry;
     private parseEventParameters;
-    serialize(ctx: CCEncodingContext): Bytes;
+    serialize(ctx: CCEncodingContext): Promise<Bytes>;
 }
 export type NotificationCCGetOptions = {
     alarmType: number;
@@ -436,7 +438,7 @@ export declare class NotificationCCGet extends NotificationCC {
     /** Regulated V3+ notification type */
     notificationType: number | undefined;
     notificationEvent: number | undefined;
-    serialize(ctx: CCEncodingContext): Bytes;
+    serialize(ctx: CCEncodingContext): Promise<Bytes>;
     toLogEntry(ctx?: GetValueDB): MessageOrCCLogEntry;
 }
 export interface NotificationCCSupportedReportOptions {
@@ -448,7 +450,7 @@ export declare class NotificationCCSupportedReport extends NotificationCC {
     static from(raw: CCRaw, ctx: CCParsingContext): NotificationCCSupportedReport;
     supportsV1Alarm: boolean;
     supportedNotificationTypes: number[];
-    serialize(ctx: CCEncodingContext): Bytes;
+    serialize(ctx: CCEncodingContext): Promise<Bytes>;
     toLogEntry(ctx?: GetValueDB): MessageOrCCLogEntry;
 }
 export declare class NotificationCCSupportedGet extends NotificationCC {
@@ -463,7 +465,7 @@ export declare class NotificationCCEventSupportedReport extends NotificationCC {
     persistValues(ctx: PersistValuesContext): boolean;
     notificationType: number;
     supportedEvents: number[];
-    serialize(ctx: CCEncodingContext): Bytes;
+    serialize(ctx: CCEncodingContext): Promise<Bytes>;
     toLogEntry(ctx?: GetValueDB): MessageOrCCLogEntry;
 }
 export interface NotificationCCEventSupportedGetOptions {
@@ -473,7 +475,7 @@ export declare class NotificationCCEventSupportedGet extends NotificationCC {
     constructor(options: WithAddress<NotificationCCEventSupportedGetOptions>);
     static from(raw: CCRaw, ctx: CCParsingContext): NotificationCCEventSupportedGet;
     notificationType: number;
-    serialize(ctx: CCEncodingContext): Bytes;
+    serialize(ctx: CCEncodingContext): Promise<Bytes>;
     toLogEntry(ctx?: GetValueDB): MessageOrCCLogEntry;
 }
 //# sourceMappingURL=NotificationCC.d.ts.map