@camstack/types 1.2.284 → 1.2.286

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

@@ -0,0 +1,58 @@
+/**
+ * Alarm settings, as pure functions (D697). Inheritance of per-mode delays, application of a
+ * patch's per-field edits and single-membership edit, and the "did my patch land" check.
+ *
+ * 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';
+export type NcAlarmDelayField = 'exitDelaySec' | 'entryDelaySec' | 'triggeredDurationSec';
+export declare const NC_ALARM_DELAY_FIELDS: readonly NcAlarmDelayField[];
+export type NcAlarmDelaySource = 'mode' | 'default';
+export interface NcAlarmResolvedDelays {
+    readonly exitDelaySec: number;
+    readonly entryDelaySec: number;
+    readonly triggeredDurationSec: number;
+    readonly source: Readonly<Record<NcAlarmDelayField, NcAlarmDelaySource>>;
+}
+/**
+ * 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'> & {
+    readonly modeDelays?: readonly NcAlarmModeDelays[];
+    /** Absent on a hub older than D636: read as "no lists". */
+    readonly nonBlocking?: readonly NcAlarmNonBlocking[];
+};
+export type NcAlarmDelaySettings = Pick<NcAlarmSettingsAnswer, NcAlarmDelayField | 'modeDelays'>;
+/** What `mode` actually runs on: its own overrides, the global value for every other field. */
+export declare function resolveModeDelays(settings: NcAlarmDelaySettings, mode: AlarmArmMode): NcAlarmResolvedDelays;
+/**
+ * Apply per-field edits to the stored overrides. Returns new arrays, never mutates the input;
+ * 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 = {
+    readonly kind: 'applied';
+    readonly lists: NcAlarmNonBlocking[];
+    readonly changed: boolean;
+} | {
+    readonly kind: 'refused';
+    readonly reason: 'list-full';
+    readonly mode: AlarmArmMode;
+    readonly max: number;
+};
+/**
+ * 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.
+ */
+export declare function applyNonBlockingEdit(lists: readonly NcAlarmNonBlocking[], edit: NcAlarmNonBlockingEdit): NcAlarmNonBlockingEditResult;
+/**
+ * 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
+ * and dropped". `announceArm` is ignored (parsed, never read). A `null` clear "lands" on a host
+ * that stripped the key (it lacks the field) — harmless, because such a host stores no overrides.
+ * A whole-list `nonBlocking` naming a mode the panel does not offer reads as "not landed" (the host
+ * drops it); only older clients and the prune send whole lists, and they do not call this.
+ */
+export declare function alarmPatchLanded(patch: NcAlarmSettingsPatch, returned: NcAlarmSettingsAnswer): boolean;

package/package.json

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