@camstack/types 1.2.295 → 1.2.297

package/dist/notification/alarm-controllable.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Controllable openings on the alarm: defaults for the two switches, and the
+ * actuation each cap gets when "secure on arm" fires.
+ *
+ * Controllable = cover / lock-control / switch. Contacts stay passive: they
+ * block by default and have no secure switch.
+ */
+import { type NcAlarmControllableCap } from './alarm-membership.js';
+export interface AlarmDeviceBlocksInput {
+    readonly controllable: boolean;
+    readonly deviceId: number;
+    /** Contact opt-out list (existing). */
+    readonly nonBlocking: readonly number[];
+    /** Controllable opt-IN list (default empty = do not block). */
+    readonly blocking: readonly number[];
+}
+/** Whether this device refuses the arm when open. */
+export declare function alarmDeviceBlocksArming(input: AlarmDeviceBlocksInput): boolean;
+export interface AlarmDeviceSecureOnArmInput {
+    readonly controllable: boolean;
+    readonly deviceId: number;
+    /** Controllable opt-OUT list (default empty = secure ON). */
+    readonly secureOnArmOff: readonly number[];
+}
+/** Whether this controllable should be closed/locked/turned off on arm. */
+export declare function alarmDeviceSecureOnArm(input: AlarmDeviceSecureOnArmInput): boolean;
+export interface NcAlarmSecureActuation {
+    readonly cap: NcAlarmControllableCap;
+    readonly method: string;
+    readonly args: Readonly<Record<string, unknown>>;
+}
+/** The one secure command for a controllable opening cap, or null for contacts. */
+export declare function secureActuationFor(cap: string): NcAlarmSecureActuation | null;

package/dist/notification/alarm-membership.d.ts

@@ -19,8 +19,15 @@ import type { NcConditions, NcRuleActionSequence } from '../capabilities/notific
  * engine's opening table (`alarm-openings.ts`, which is checked against this
  * list with `satisfies`). Only these carry an opening edge the alarm refuses.
  */
-export declare const NC_ALARM_OPENING_EVENT_KINDS: readonly ["contact", "cover", "lock"];
+export declare const NC_ALARM_OPENING_EVENT_KINDS: readonly ["contact", "cover", "lock", "switch"];
 export type NcAlarmOpeningEventKind = (typeof NC_ALARM_OPENING_EVENT_KINDS)[number];
+/**
+ * Opening caps that can be ACTUATED to a secure state on arm (close / lock /
+ * off). Contacts are openings but not controllable — they only block.
+ */
+export declare const NC_ALARM_CONTROLLABLE_CAPS: readonly ["cover", "lock-control", "switch"];
+export type NcAlarmControllableCap = (typeof NC_ALARM_CONTROLLABLE_CAPS)[number];
+export declare function isAlarmControllableCap(cap: string): cap is NcAlarmControllableCap;
 /** What the alarm-membership question reads off a rule. */
 export interface NcAlarmMembershipSubject {
     readonly conditions: Pick<NcConditions, 'deviceState' | 'sensorKinds' | 'sensorTransition'>;

package/dist/notification/alarm-settings.d.ts

@@ -5,7 +5,7 @@
  * The engine and both clients call these; nobody re-implements them. No I/O, no clock.
  */
 import type { AlarmArmMode } from '../capabilities/alarm-panel.cap.js';
-import { type NcAlarmModeDelays, type NcAlarmModeDelaysEdit, type NcAlarmNonBlocking, type NcAlarmNonBlockingEdit, type NcAlarmSettings, type NcAlarmSettingsPatch } from '../capabilities/notification-rules.cap.js';
+import { type NcAlarmBlocking, type NcAlarmBlockingEdit, type NcAlarmModeDelays, type NcAlarmModeDelaysEdit, type NcAlarmModeDeviceList, type NcAlarmNonBlocking, type NcAlarmNonBlockingEdit, type NcAlarmSecureOnArmEdit, type NcAlarmSecureOnArmOff, type NcAlarmSettings, type NcAlarmSettingsPatch } from '../capabilities/notification-rules.cap.js';
 export type NcAlarmDelayField = 'exitDelaySec' | 'entryDelaySec' | 'triggeredDurationSec';
 export declare const NC_ALARM_DELAY_FIELDS: readonly NcAlarmDelayField[];
 export type NcAlarmDelaySource = 'mode' | 'default';
@@ -19,10 +19,13 @@ export interface NcAlarmResolvedDelays {
  * A settings answer as it travels on the wire. Clients do not parse answers, so a hub older
  * than D697 sends no `modeDelays` (nor, before D636, `nonBlocking`); every reader here treats an absent key as "no overrides".
  */
-export type NcAlarmSettingsAnswer = Omit<NcAlarmSettings, 'modeDelays' | 'nonBlocking'> & {
+export type NcAlarmSettingsAnswer = Omit<NcAlarmSettings, 'modeDelays' | 'nonBlocking' | 'blocking' | 'secureOnArmOff'> & {
     readonly modeDelays?: readonly NcAlarmModeDelays[];
     /** Absent on a hub older than D636: read as "no lists". */
     readonly nonBlocking?: readonly NcAlarmNonBlocking[];
+    /** Absent on a hub older than secure-on-arm: read as "no lists". */
+    readonly blocking?: readonly NcAlarmBlocking[];
+    readonly secureOnArmOff?: readonly NcAlarmSecureOnArmOff[];
 };
 export type NcAlarmDelaySettings = Pick<NcAlarmSettingsAnswer, NcAlarmDelayField | 'modeDelays'>;
 /** What `mode` actually runs on: its own overrides, the global value for every other field. */
@@ -32,9 +35,9 @@ export declare function resolveModeDelays(settings: NcAlarmDelaySettings, mode:
  * an entry with no field left is dropped (the mode inherits everything again).
  */
 export declare function applyModeDelaysEdits(current: readonly NcAlarmModeDelays[], edits: readonly NcAlarmModeDelaysEdit[]): NcAlarmModeDelays[];
-export type NcAlarmNonBlockingEditResult = {
+export type NcAlarmModeDeviceListEditResult = {
     readonly kind: 'applied';
-    readonly lists: NcAlarmNonBlocking[];
+    readonly lists: NcAlarmModeDeviceList[];
     readonly changed: boolean;
 } | {
     readonly kind: 'refused';
@@ -42,11 +45,29 @@ export type NcAlarmNonBlockingEditResult = {
     readonly mode: AlarmArmMode;
     readonly max: number;
 };
+/** Alias kept for callers that name the non-blocking edit result. */
+export type NcAlarmNonBlockingEditResult = NcAlarmModeDeviceListEditResult;
 /**
- * Put ONE device on, or take it off, ONE mode's list. A no-op answers `changed: false`; an add
- * to a full list is REFUSED by reason (never silently dropped); an emptied list drops its entry.
+ * Put ONE device on, or take it off, ONE mode's device-id list. A no-op answers
+ * `changed: false`; an add to a full list is REFUSED by reason (never silently
+ * dropped); an emptied list drops its entry.
+ */
+export declare function applyModeDeviceListEdit(lists: readonly NcAlarmModeDeviceList[], edit: {
+    readonly mode: AlarmArmMode;
+    readonly deviceId: number;
+    readonly present: boolean;
+}): NcAlarmModeDeviceListEditResult;
+/**
+ * Put ONE device on, or take it off, ONE mode's non-blocking list.
  */
 export declare function applyNonBlockingEdit(lists: readonly NcAlarmNonBlocking[], edit: NcAlarmNonBlockingEdit): NcAlarmNonBlockingEditResult;
+/** Controllable opt-in to blocking. */
+export declare function applyBlockingEdit(lists: readonly NcAlarmBlocking[], edit: NcAlarmBlockingEdit): NcAlarmModeDeviceListEditResult;
+/**
+ * Controllable secure-on-arm: `secureOnArm: true` removes from the opt-out list;
+ * `false` adds to it.
+ */
+export declare function applySecureOnArmEdit(lists: readonly NcAlarmSecureOnArmOff[], edit: NcAlarmSecureOnArmEdit): NcAlarmModeDeviceListEditResult;
 /**
  * True iff every key the patch sent is reflected in what the host returned. A host older than
  * this build strips the keys it does not know; this is how a client tells "saved" from "parsed

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@camstack/types",
-  "version": "1.2.295",
+  "version": "1.2.297",
   "description": "Shared types, interfaces, and model catalogs for the CamStack detection ecosystem",
   "keywords": [
     "camstack",