@camstack/types 1.2.434 → 1.2.436

package/dist/composition/helpers/appliance.d.ts

@@ -24,5 +24,5 @@ export interface ApplianceDefaults {
 export declare const APPLIANCE_DEFAULTS: Readonly<Record<ApplianceKind, ApplianceDefaults>>;
 export declare function applianceDeviceType(kind: ApplianceKind): DeviceType;
 export declare function isApplianceKind(value: string): value is ApplianceKind;
-/** The member step: one watts reading, from a sensor or from the plug itself. */
+/** The member step: one power reading, from a sensor or from the plug itself. */
 export declare function sourcePickForAppliance(): SourcePickRequest;

package/dist/composition/helpers/index.d.ts

@@ -10,5 +10,5 @@ export { KWH_PER_WATT_MS, wattMillisecondsToKwh } from './energy.js';
 export { type HistoryValue, type IntegralScale, type SeriesBefore, type SeriesKind, type SeriesPoint, type SeriesRead, STATISTIC_STATS, SERIES_KINDS, evaluateDerivative, evaluateStatistic, integrateReading, } from './history-math.js';
 export { type CalendarPeriod, type CalendarWindow, type HistoryRetention, type HistoryTier, type HistoryTierPlan, type OpenRange, type ResetPeriod, type RollingSpan, type RollingWindow, type StatisticWindow, CALENDAR_PERIODS, CalendarWindowSchema, DAY_MS, DEFAULT_HISTORY_RETENTION, HISTORY_FAST_MS, HISTORY_SLOW_MS, HISTORY_TIERS, HOUR_MS, MINUTE_MS, MIN_CUSTOM_MINUTES, RESET_PERIODS, ROLLING_SPANS, RollingWindowSchema, StatisticWindowSchema, integralCadenceMs, maxDurationMs, nextLocalMidnight, openReset, openStatistic, planResetTier, planStatisticTier, rollingDurationMs, statisticCadenceMs, } from './history-window.js';
 export { type HelperMemberFact, helperSaveProblems, } from './save.js';
-export { type SourcePick, type SourcePickAccept, type SourcePickHistory, type SourcePickRequest, type MathSourceKind, sourcePickForHistory, sourcePickForMath, sourcePickForTemplate, } from './source-pick.js';
+export { type SourcePick, type SourcePickAccept, type SourcePickFieldChoice, type SourcePickHistory, type SourcePickRequest, type MathSourceKind, sourcePickForHistory, sourcePickForMath, sourcePickForTemplate, } from './source-pick.js';
 export { ACTIVE_CRITERIA, AGGREGATE_REDUCERS, ActiveCriterionSchema, AggregateReducerSchema, BINARY_AGGREGATES, GROUP_TEMPLATE_IDS, ApplianceHelperSpecSchema, ARITHMETIC_OPS, ArithmeticHelperSpecSchema, DERIVATIVE_UNITS, DerivativeHelperSpecSchema, EXPRESSION_OUTPUTS, ExpressionHelperSpecSchema, ThresholdHelperSpecSchema, GroupHelperSpecSchema, GroupTemplateIdSchema, HelperMemberSchema, HelperSpecSchema, INTEGRAL_OUTPUTS, IntegralHelperSpecSchema, MAX_HELPER_MEMBERS, helperMembers, isHistoryHelper, NUMERIC_AGGREGATES, StatisticHelperSpecSchema, type ActiveCriterion, type AggregateReducer, type BinaryAggregate, type ApplianceHelperSpec, type ArithmeticHelperSpec, type ArithmeticOp, type DerivativeHelperSpec, type DerivativeUnit, type ExpressionHelperSpec, type ExpressionInput, type ExpressionOutput, type ThresholdHelperSpec, type GroupHelperSpec, type GroupTemplateId, type HelperMember, type HelperSpec, type HistoryHelperSpec, type IntegralHelperSpec, type IntegralOutput, type NumericAggregate, type StatisticHelperSpec, type StatisticStat, } from './spec.js';

package/dist/composition/helpers/source-pick.d.ts

@@ -15,7 +15,14 @@ export interface SourcePickHistory {
     readonly required: boolean;
     readonly minRetentionMs: number | null;
 }
+/**
+ * How a device that satisfies several accept entries gets its field. `first-match`
+ * takes the first listed entry the device has (the dedicated sensor before a
+ * climate reading); `operator` waits for the operator to pick (occupancy).
+ */
+export type SourcePickFieldChoice = 'first-match' | 'operator';
 export interface SourcePickRequest {
+    readonly fieldChoice: SourcePickFieldChoice;
     readonly purpose: 'member' | 'reading' | 'historised';
     readonly multiple: boolean;
     readonly max: number;

package/dist/{composition-Bb8iwHEJ.mjs → composition-DwA0uVW5.mjs}

@@ -2263,16 +2263,17 @@ function applianceDeviceType(kind) {
 function isApplianceKind(value) {
 	return APPLIANCE_KINDS.some((kind) => kind === value);
 }
-/** The member step: one watts reading, from a sensor or from the plug itself. */
+/** The member step: one power reading, from a sensor or from the plug itself. */
 function sourcePickForAppliance() {
 	return {
+		fieldChoice: "operator",
 		purpose: "reading",
 		multiple: false,
 		max: 1,
 		deviceTypes: [DeviceType.Sensor, DeviceType.Switch],
 		accept: [{
 			cap: "power-meter",
-			fieldPath: "watts",
+			fieldPath: "power",
 			valueKind: "number"
 		}],
 		history: {

package/dist/{composition-CpAc0YfQ.js → composition-WNkEpwkF.js}

@@ -2263,16 +2263,17 @@ function applianceDeviceType(kind) {
 function isApplianceKind(value) {
 	return APPLIANCE_KINDS.some((kind) => kind === value);
 }
-/** The member step: one watts reading, from a sensor or from the plug itself. */
+/** The member step: one power reading, from a sensor or from the plug itself. */
 function sourcePickForAppliance() {
 	return {
+		fieldChoice: "operator",
 		purpose: "reading",
 		multiple: false,
 		max: 1,
 		deviceTypes: [require_err_msg.DeviceType.Sensor, require_err_msg.DeviceType.Switch],
 		accept: [{
 			cap: "power-meter",
-			fieldPath: "watts",
+			fieldPath: "power",
 			valueKind: "number"
 		}],
 		history: {

package/dist/device/base-device.d.ts

@@ -31,7 +31,7 @@ export declare abstract class BaseDevice<T extends z.ZodObject<z.core.$ZodLooseS
      * `device-local-state.ts`. Drivers access via:
      *
      *   `this.state.battery.sleeping = true`        // patches the battery slice
-     *   `const pct = this.state.battery.percentage` // reads the battery slice
+     *   `const pct = this.state.battery.level` // reads the battery slice
      *   `this.state.deviceStatus.online = true`     // mirrors `markOnline(true)`
      *
      * Adding a new cap with `runtimeState:` automatically extends this
@@ -56,7 +56,7 @@ export declare abstract class BaseDevice<T extends z.ZodObject<z.core.$ZodLooseS
      * shape; drivers don't redeclare it, they just write through.
      *
      * Read: `this.runtimeState.getCapState('battery')` →
-     *   `{percentage, charging, sleeping, lastUpdated}` for any
+     *   `{level, charging, sleeping, lastUpdated}` for any
      *   provider that registers `batteryCapability`.
      * Write: `this.runtimeState.setCapState('battery', { … })`.
      *

package/dist/device/device-runtime-state.d.ts

@@ -40,7 +40,7 @@ export interface IDeviceRuntimeState {
     getCapState<K extends keyof import('../generated/device-local-state.js').CapNameToRuntimeStateMap>(capName: K): Readonly<import('../generated/device-local-state.js').CapNameToRuntimeStateMap[K]> | undefined;
     getCapState<T extends Record<string, unknown> = Record<string, unknown>>(capName: string): Readonly<T> | undefined;
     /** Read a single key inside a slice. Convenience for the common
-     *  case of reading a primitive (`battery.percentage`). */
+     *  case of reading a primitive (`battery.level`). */
     getCapField(capName: string, key: string): unknown;
     /**
      * Replace the slice for `capName`. The schema bound to `capName`

package/dist/device/device-state-handle.d.ts

@@ -182,7 +182,7 @@ export declare function createMirrorSource(mirror: ReadonlyMap<number, ReadonlyM
  *
  *   const dev = createDeviceProxy(api, binding)
  *   dev.state.battery.value           // BatteryStatus | undefined
- *   dev.state.battery.value?.percentage
+ *   dev.state.battery.value?.level
  *
  * Two-arg form (deprecated path, kept for spec compatibility):
  * passes the api directly, builds a per-handle lazy source. New

package/dist/device/system-mirror.d.ts

@@ -33,7 +33,7 @@
  *   await dev?.snapshot?.getSnapshot({...})    // method dispatch via cap-router
  *
  *   sm.query({ addonId: 'reolink', online: true })
- *   sm.whereState('battery', s => s.percentage < 20)
+ *   sm.whereState('battery', s => s.level < 20)
  *   sm.listenCap('motion', (id, slice) => …)
  *   await sm.waitForState(8, 'battery', s => !s.sleeping, 30_000)
  *

package/dist/generated/addon-cap-facts.d.ts

@@ -5,7 +5,7 @@
  * `ALL_CAPABILITY_DEFINITIONS` (the whole Zod schema graph, ~+100 MB heap per
  * runner). See docs/decisions/adr-0028.md.
  *
- * Coverage: 1 advance-derived caps, 77 caps with 356 state leaves.
+ * Coverage: 1 advance-derived caps, 77 caps with 355 state leaves.
  */
 /** A bindable scalar in a capability's runtime state. */
 export interface CapStateLeaf {

package/dist/generated/customize-catalog.d.ts

@@ -7,12 +7,12 @@ export declare const CAP_CUSTOMIZE_CATALOG: {
     readonly battery: {
         readonly version: 1;
         readonly targets: readonly [{
-            readonly id: 'percentage';
+            readonly id: 'level';
             readonly cardinality: 'scalar';
             readonly deviceTypes: readonly [DeviceType.Camera, DeviceType.Sensor, DeviceType.Button, DeviceType.Switch, DeviceType.PetFeeder, DeviceType.Container, DeviceType.Thermostat, DeviceType.EventEmitter];
             readonly apply: 'add';
             readonly vocabularyCap: 'battery';
-            readonly vocabularyStateField: 'percentage';
+            readonly vocabularyStateField: 'level';
             readonly sources: readonly [{
                 readonly kind: 'field';
                 readonly valueKinds: readonly ["number", "string"];
@@ -31,7 +31,7 @@ export declare const CAP_CUSTOMIZE_CATALOG: {
                 readonly status: 'assignment-status';
             };
             readonly advancedExpression: true;
-            readonly path: 'percentage';
+            readonly path: 'level';
             readonly valueKind: 'number';
             readonly nullable: true;
             readonly companions: readonly [{
@@ -209,12 +209,12 @@ export declare const CAP_CUSTOMIZE_CATALOG: {
     readonly 'power-meter': {
         readonly version: 1;
         readonly targets: readonly [{
-            readonly id: 'watts';
+            readonly id: 'power';
             readonly cardinality: 'scalar';
             readonly deviceTypes: readonly [DeviceType.Switch, DeviceType.Light, DeviceType.Fan, DeviceType.Climate, DeviceType.Thermostat, DeviceType.Humidifier, DeviceType.WaterHeater, DeviceType.MediaPlayer, DeviceType.Washer, DeviceType.Dryer, DeviceType.Dishwasher, DeviceType.Vacuum, DeviceType.LawnMower, DeviceType.PetFeeder];
             readonly apply: 'add';
             readonly vocabularyCap: 'power-meter';
-            readonly vocabularyStateField: 'watts';
+            readonly vocabularyStateField: 'power';
             readonly sources: readonly [{
                 readonly kind: 'numeric';
                 readonly requiredUnit: 'W';
@@ -227,7 +227,7 @@ export declare const CAP_CUSTOMIZE_CATALOG: {
                 readonly status: 'assignment-status';
             };
             readonly advancedExpression: true;
-            readonly path: 'watts';
+            readonly path: 'power';
             readonly valueKind: 'number';
             readonly nullable: false;
             readonly companions: readonly [{
@@ -236,12 +236,12 @@ export declare const CAP_CUSTOMIZE_CATALOG: {
                 readonly when: 'always';
             }];
         }, {
-            readonly id: 'kwhTotal';
+            readonly id: 'energy';
             readonly cardinality: 'scalar';
             readonly deviceTypes: readonly [DeviceType.Switch, DeviceType.Light, DeviceType.Fan, DeviceType.Climate, DeviceType.Thermostat, DeviceType.Humidifier, DeviceType.WaterHeater, DeviceType.MediaPlayer, DeviceType.Washer, DeviceType.Dryer, DeviceType.Dishwasher, DeviceType.Vacuum, DeviceType.LawnMower, DeviceType.PetFeeder];
             readonly apply: 'add';
             readonly vocabularyCap: 'power-meter';
-            readonly vocabularyStateField: 'kwhTotal';
+            readonly vocabularyStateField: 'energy';
             readonly sources: readonly [{
                 readonly kind: 'numeric';
                 readonly requiredUnit: 'kWh';
@@ -254,7 +254,7 @@ export declare const CAP_CUSTOMIZE_CATALOG: {
                 readonly status: 'assignment-status';
             };
             readonly advancedExpression: true;
-            readonly path: 'kwhTotal';
+            readonly path: 'energy';
             readonly valueKind: 'number';
             readonly nullable: false;
             readonly companions: readonly [{
@@ -263,12 +263,12 @@ export declare const CAP_CUSTOMIZE_CATALOG: {
                 readonly when: 'always';
             }];
         }, {
-            readonly id: 'volts';
+            readonly id: 'voltage';
             readonly cardinality: 'scalar';
             readonly deviceTypes: readonly [DeviceType.Switch, DeviceType.Light, DeviceType.Fan, DeviceType.Climate, DeviceType.Thermostat, DeviceType.Humidifier, DeviceType.WaterHeater, DeviceType.MediaPlayer, DeviceType.Washer, DeviceType.Dryer, DeviceType.Dishwasher, DeviceType.Vacuum, DeviceType.LawnMower, DeviceType.PetFeeder];
             readonly apply: 'add';
             readonly vocabularyCap: 'power-meter';
-            readonly vocabularyStateField: 'volts';
+            readonly vocabularyStateField: 'voltage';
             readonly sources: readonly [{
                 readonly kind: 'numeric';
                 readonly requiredUnit: 'V';
@@ -281,7 +281,7 @@ export declare const CAP_CUSTOMIZE_CATALOG: {
                 readonly status: 'assignment-status';
             };
             readonly advancedExpression: true;
-            readonly path: 'volts';
+            readonly path: 'voltage';
             readonly valueKind: 'number';
             readonly nullable: false;
             readonly companions: readonly [{
@@ -290,12 +290,12 @@ export declare const CAP_CUSTOMIZE_CATALOG: {
                 readonly when: 'always';
             }];
         }, {
-            readonly id: 'amps';
+            readonly id: 'current';
             readonly cardinality: 'scalar';
             readonly deviceTypes: readonly [DeviceType.Switch, DeviceType.Light, DeviceType.Fan, DeviceType.Climate, DeviceType.Thermostat, DeviceType.Humidifier, DeviceType.WaterHeater, DeviceType.MediaPlayer, DeviceType.Washer, DeviceType.Dryer, DeviceType.Dishwasher, DeviceType.Vacuum, DeviceType.LawnMower, DeviceType.PetFeeder];
             readonly apply: 'add';
             readonly vocabularyCap: 'power-meter';
-            readonly vocabularyStateField: 'amps';
+            readonly vocabularyStateField: 'current';
             readonly sources: readonly [{
                 readonly kind: 'numeric';
                 readonly requiredUnit: 'A';
@@ -308,7 +308,7 @@ export declare const CAP_CUSTOMIZE_CATALOG: {
                 readonly status: 'assignment-status';
             };
             readonly advancedExpression: true;
-            readonly path: 'amps';
+            readonly path: 'current';
             readonly valueKind: 'number';
             readonly nullable: false;
             readonly companions: readonly [{

package/dist/generated/history-catalog.d.ts

@@ -1,7 +1,7 @@
 import type { CapabilityHistoryField, CapabilityHistoryItems } from '../capabilities/capability-definition.js';
 /**
  * Cap history catalog, projected from every `*.cap.ts` `history` block.
- * 42 caps with series (77 series), 33 caps answered `'none'`.
+ * 41 caps with series (76 series), 34 caps answered `'none'`.
  * Field keys are `runtimeState` paths (`a.b` into fixed objects only).
  */
 export declare const HISTORY_CATALOG: Readonly<Record<string, Readonly<Record<string, CapabilityHistoryField>>>>;

package/dist/index.d.ts

@@ -293,6 +293,7 @@ export { AUDIO_SCALE_EPOCH_ISO, AUDIO_SCALE_EPOCH_MS, type AudioScaleEra, audioS
 export { audioIsFailClosed, audioKindId, audioLabelChoices, audioModeOf, audioOrDefaults, isAudioLabelSelected, NC_AUDIO_CONFIRM_HITS_DEFAULT, NC_AUDIO_CONFIRM_HITS_MAX, NC_AUDIO_CONFIRM_HITS_MIN, NC_AUDIO_CONFIRM_WINDOW_MAX_SEC, NC_AUDIO_CONFIRM_WINDOW_MIN_SEC, NC_AUDIO_CONFIRM_WINDOW_SEC_DEFAULT, NC_AUDIO_DB_MAX, NC_AUDIO_DB_MIN, NC_AUDIO_DB_OFFERED, NC_AUDIO_DB_STEP, NC_AUDIO_DEFAULTS, NC_AUDIO_HIT_PERCENT_MAX, NC_AUDIO_HIT_PERCENT_MIN, NC_AUDIO_SAMPLING_MAX_SEC, NC_AUDIO_SAMPLING_MIN_SEC, type NcAudioLabelChoice, type NcAudioMode, type NcAudioPatch, normalizeAudioLabel, patchAudio, toggleAudioLabel, } from './notification/audio-condition.js';
 export { isAudioClassName, isBaseConditionKey, knownValues, NC_BASE_CONDITION_KEYS, type NcBaseConditionKey, pickerForCondition, pickerForRuleClasses, type TaxonomyGroup, type TaxonomyOption, type TaxonomyPicker, } from './notification/condition-taxonomy.js';
 export { type PreparedAction, type PreparedAttachment, type PreparedNotification, prepareNotification, type ResolvedLevel, } from './notification/degrade-engine.js';
+export { deliveryParamsDeclaredBy, resolveDeliveryParams } from './notification/delivery-params.js';
 export { htmlToText, markdownToHtmlLite, markdownToText, type NotificationFormat as NotificationBodyFormat, resolveFormat, textToHtml, transcodeBody, } from './notification/format-transcode.js';
 export { conditionExclusionReason, conditionVisibleForKind, defaultDeliveryForSection, droppedConditionsForKind, isAudioRule, isOccupancyRule, isSystemDelivery, isSystemRuleKind, kindsForDiscriminator, NC_AUDIO_SEED, NC_CAMERA_SCOPE_CAP_NAME, NC_OCCUPANCY_DEFAULTS, NC_RULE_EDITOR_SECTION_ORDER, NC_RULE_KIND_SPECS, NC_RULE_SECTIONS, NC_SYSTEM_DELIVERY, NC_SYSTEM_RULE_KINDS, type NcDroppedCondition, type NcKindVisibilitySubject, type NcRuleEditorSection, type NcRuleEditorSectionKey, type NcRuleKind, type NcRuleKindSpec, type NcRuleOwningSectionKey, type NcRuleSection, type NcRuleSectionKey, type NcRuleConditionsSubject, type NcRuleSectionSubject, type NcRuleSeed, parseRuleSection, ruleDeviceCompatCapNames, ruleDeviceCompatCapQueries, ruleEditorSectionsForKind, ruleGroupingApplies, ruleKindOf, ruleKindSpec, ruleMatchesSection, ruleSection, ruleSectionOf, ruleSeedForSection, systemFamilyOfKind, systemRuleKindOf, } from './notification/rule-kinds.js';
 export { imageModesForKind, legacyImageMode, NC_MEDIA_IMAGE_MODES, type NcMediaRuleSubject, ncMediaPolicyError, normalizeNcMediaPolicy, resolveNcMediaImage, ruleTriggerZoneIds, subjectHasPath, } from './notification/media-image.js';