@camstack/addon-provider-homeassistant 1.2.648 → 1.2.650

package/dist/ha-export/ha-export.addon.mjs

@@ -1,4 +1,4 @@
-import { B as consumableKindOf, Bt as BaseAddon, Dt as sendToExportedTarget, Ht as baseUnitOf, Jt as isReadingQuantity, K as deviceExportCapability, Wt as defineAddonMigrations, Yt as nodePin, Zt as array, _ as PLUG_APPLIANCE_TYPES, _t as pruneDeletedEntities, c as COCO_TO_MACRO, d as ConsumableItemSchema, f as ConsumableStatusSchema, fn as EventCategory, g as MediaPlayerRepeatSchema, h as HvacModeSchema, i as AlarmArmModeSchema, in as string, j as buildAddonRouteProvider, l as CameraSwitchIdSchema, m as FanDirectionSchema, nn as object, on as unknown, pt as preconditionOf, r as listHomeAssistantBrokers, s as CAMERA_SWITCH_ORDER, u as ConsumableFormSchema, ut as oauthIntegrationCapability, x as addonRoutesCapability, xt as runExportedAction, z as consumableFormOf } from "../ha-broker-source-iLA_DsW8.mjs";
+import { B as consumableKindOf, Bt as BaseAddon, Dt as sendToExportedTarget, Ht as baseUnitOf, Jt as isReadingQuantity, K as deviceExportCapability, Wt as defineAddonMigrations, Yt as nodePin, Zt as array, _ as PLUG_APPLIANCE_TYPES, _t as pruneDeletedEntities, c as COCO_TO_MACRO, d as ConsumableItemSchema, f as ConsumableStatusSchema, fn as EventCategory, g as MediaPlayerRepeatSchema, h as HvacModeSchema, i as AlarmArmModeSchema, in as string, j as buildAddonRouteProvider, l as CameraSwitchIdSchema, m as FanDirectionSchema, nn as object, on as unknown, pt as preconditionOf, r as listHomeAssistantBrokers, s as CAMERA_SWITCH_ORDER, u as ConsumableFormSchema, ut as oauthIntegrationCapability, x as addonRoutesCapability, xt as runExportedAction, z as consumableFormOf } from "../ha-broker-source-B2v2dnPe.mjs";
 import { createHmac, timingSafeEqual } from "node:crypto";
 import "node:zlib";
 import "node:fs";
@@ -940,19 +940,22 @@ var NATIVE_CAP_PLATFORMS = {
 	*/
 	cover: {
 		platform: "cover",
+		availableWhenOnline: true,
 		primary: { from: null },
 		controls: {
 			position: {
 				from: "position",
 				min: 0,
 				max: 100,
-				step: 1
+				step: 1,
+				requiresFeature: "cover-positionable"
 			},
 			tilt: {
 				from: "tilt",
 				min: 0,
 				max: 100,
-				step: 1
+				step: 1,
+				requiresFeature: "cover-tilt"
 			},
 			open: {
 				from: "open",
@@ -964,7 +967,8 @@ var NATIVE_CAP_PLATFORMS = {
 			},
 			stop: {
 				from: "stop",
-				commandOnly: true
+				commandOnly: true,
+				requiresFeature: "cover-stoppable"
 			}
 		}
 	},
@@ -1353,9 +1357,11 @@ function buildNativeComponent(input) {
 	if (native === void 0) return null;
 	const primary = resolveBinding(input, native.primary);
 	if (primary === null) return null;
+	const features = input.features ?? [];
 	const absorbed = new Set([derivedEntityId(input.capName), ...primary.entities]);
 	const controls = {};
 	for (const [name, binding] of Object.entries(native.controls ?? {})) {
+		if (binding.requiresFeature !== void 0 && !features.includes(binding.requiresFeature)) continue;
 		const resolved = resolveBinding(input, binding);
 		if (resolved === null) continue;
 		controls[name] = resolved.control;
@@ -1374,6 +1380,11 @@ function buildNativeComponent(input) {
 			...primary.control,
 			...native.deviceClass !== void 0 ? { device_class: native.deviceClass } : {},
 			...native.icon !== void 0 ? { icon: native.icon } : {},
+			...native.availableWhenOnline === true ? {
+				availability_topic: stateTopic(input.deviceKey, "online"),
+				payload_available: "true",
+				payload_not_available: "false"
+			} : {},
 			...Object.keys(controls).length > 0 ? { controls } : {},
 			...native.constants,
 			...flags
@@ -2308,7 +2319,8 @@ var CAP_ENTITY_MAP = {
 				unit: "%",
 				icon: "mdi:arrow-up-down",
 				writable: true,
-				range: PERCENT_RANGE
+				range: PERCENT_RANGE,
+				requiresFeature: "cover-positionable"
 			},
 			tilt: {
 				platform: "number",
@@ -2318,7 +2330,8 @@ var CAP_ENTITY_MAP = {
 				icon: "mdi:angle-acute",
 				writable: true,
 				range: PERCENT_RANGE,
-				enabledByDefault: false
+				enabledByDefault: false,
+				requiresFeature: "cover-tilt"
 			}
 		},
 		commands: {
@@ -2333,7 +2346,8 @@ var CAP_ENTITY_MAP = {
 			stop: {
 				label: "Stop",
 				icon: "mdi:stop",
-				enabledByDefault: false
+				enabledByDefault: false,
+				requiresFeature: "cover-stoppable"
 			}
 		}
 	},
@@ -3340,7 +3354,8 @@ function capEntities(capName) {
 	for (const [suffix, extra] of Object.entries(mapping.extras ?? {})) refs.push({
 		entity: derivedExtraEntityId(capName, suffix),
 		label: extra.label,
-		descriptor: extra
+		descriptor: extra,
+		...extra.requiresFeature !== void 0 ? { requiresFeature: extra.requiresFeature } : {}
 	});
 	return refs;
 }
@@ -3359,8 +3374,9 @@ function deriveCapValue(derivation, raw) {
 	return derivation.kind === "equals" ? raw === derivation.value : raw !== derivation.value;
 }
 /** A capability's entities as the catalog builders consume them. */
-function capEntitySpecs(capName) {
-	const specs = capEntities(capName).map((ref) => ({
+function capEntitySpecs(capName, features = []) {
+	const declared = (required) => required === void 0 || features.includes(required);
+	const specs = capEntities(capName).filter((ref) => declared(ref.requiresFeature)).map((ref) => ({
 		entity: ref.entity,
 		platform: ref.descriptor.platform,
 		label: ref.label,
@@ -3373,15 +3389,18 @@ function capEntitySpecs(capName) {
 		...ref.descriptor.entityCategory !== void 0 ? { entityCategory: ref.descriptor.entityCategory } : {},
 		...ref.descriptor.writable === true ? { writable: true } : {}
 	}));
-	for (const ref of capCommandEntities(capName)) specs.push({
-		entity: ref.entity,
-		platform: "button",
-		label: ref.label,
-		enabledByDefault: ref.command.enabledByDefault ?? true,
-		writable: true,
-		...ref.command.icon !== void 0 ? { icon: ref.command.icon } : {},
-		...ref.command.entityCategory !== void 0 ? { entityCategory: ref.command.entityCategory } : {}
-	});
+	for (const ref of capCommandEntities(capName)) {
+		if (!declared(ref.command.requiresFeature)) continue;
+		specs.push({
+			entity: ref.entity,
+			platform: "button",
+			label: ref.label,
+			enabledByDefault: ref.command.enabledByDefault ?? true,
+			writable: true,
+			...ref.command.icon !== void 0 ? { icon: ref.command.icon } : {},
+			...ref.command.entityCategory !== void 0 ? { entityCategory: ref.command.entityCategory } : {}
+		});
+	}
 	return specs;
 }
 function readControlOptions(slice) {
@@ -3759,11 +3778,12 @@ function buildDerivedPlan(device, options = UNNEGOTIATED_PLAN_OPTIONS) {
 			deviceId: device.id,
 			capName: cap,
 			label: humanise(cap),
+			features: device.features,
 			slice: device.capSlices?.[cap],
 			mapping
 		});
 		if (plan === null) {
-			specs.push(...capEntitySpecs(cap).map((spec) => degradeUnsupported(spec, options)));
+			specs.push(...capEntitySpecs(cap, device.features).map((spec) => degradeUnsupported(spec, options)));
 			continue;
 		}
 		native[toComponentKey(plan.component.platform, derivedEntityId(cap))] = plan.component;
@@ -3774,7 +3794,7 @@ function buildDerivedPlan(device, options = UNNEGOTIATED_PLAN_OPTIONS) {
 		* to make the device look tidy would be a silent loss of a value an
 		* operator already automates on.
 		*/
-		specs.push(...capEntitySpecs(cap).filter((spec) => !plan.absorbed.has(spec.entity)));
+		specs.push(...capEntitySpecs(cap, device.features).filter((spec) => !plan.absorbed.has(spec.entity)));
 	}
 	const assembled = assemble(device, specs);
 	return {
@@ -4636,6 +4656,15 @@ function isCameraCommand(command) {
 function isCapCommand(command) {
 	return !isCameraCommand(command);
 }
+var APPLIED = { ok: true };
+/** The 422 body of a command that was not applied: the reason travels with it. */
+function commandNotAppliedBody(refusal) {
+	return {
+		error: "command not applied",
+		reason: refusal.reason,
+		...refusal.message !== void 0 ? { message: refusal.message } : {}
+	};
+}
 /**
 * Make the call the command names.
 *
@@ -4915,18 +4944,29 @@ async function call(slice, capName, make) {
 *
 * Idempotent: a store without the key yields an empty plan, which writes nothing.
 */
-/** The settings scope of this addon (`<addonId>:addon-settings`). */
-var HA_EXPORT_SETTINGS_SCOPE = "homeassistant-export:addon-settings";
+/** The addon id, the prefix of its rows in the canonical settings table. */
+var HA_EXPORT_ADDON_ID = "homeassistant-export";
+/**
+* Where the addon's global settings live: the canonical `addon-settings` table, one row per
+* key, id `<addonId>.<key>`, data `{ addonId, key, value }` (never a per-addon scoped table,
+* which exists only when something lazily declared it).
+*/
+var ADDON_SETTINGS_TABLE = "addon-settings";
 var RETIRED_URL_KEYS = ["publicBaseUrl"];
 async function planDropPublicBaseUrl(ports) {
 	const stored = await ports.readStored();
 	const present = RETIRED_URL_KEYS.filter((key) => key in stored);
 	if (present.length === 0) return { edits: [] };
+	const rowId = (key) => `${HA_EXPORT_ADDON_ID}.${key}`;
 	return { edits: [{
 		op: "deleteKeys",
-		scope: HA_EXPORT_SETTINGS_SCOPE,
-		keys: [...present],
-		precondition: preconditionOf(Object.fromEntries(present.map((key) => [key, stored[key]])))
+		scope: ADDON_SETTINGS_TABLE,
+		keys: present.map(rowId),
+		precondition: preconditionOf(Object.fromEntries(present.map((key) => [rowId(key), {
+			addonId: HA_EXPORT_ADDON_ID,
+			key,
+			value: stored[key]
+		}])))
 	}] };
 }
 //#endregion
@@ -9122,9 +9162,23 @@ var HaExportAddon = class extends BaseAddon {
 			reply.send({ error: `unroutable command (${resolution.reason})` });
 			return;
 		}
-		const applied = await this.dispatch(resolution.command);
-		reply.status(applied ? 200 : 422);
-		reply.send(applied ? {} : { error: "command not applied" });
+		const outcome = await this.dispatch(resolution.command);
+		if (outcome.ok) {
+			reply.status(200);
+			reply.send({});
+			return;
+		}
+		this.ctx.logger.warn("ha-export: command answered 422", {
+			tags: { deviceId: exported.deviceId },
+			meta: {
+				topic,
+				entity: parsed.entity,
+				reason: outcome.reason,
+				message: outcome.message
+			}
+		});
+		reply.status(422);
+		reply.send(commandNotAppliedBody(outcome));
 	}
 	async dispatch(command) {
 		try {
@@ -9138,7 +9192,7 @@ var HaExportAddon = class extends BaseAddon {
 			*/
 			if (isCapCommand(command)) {
 				const outcome = await applyCapCommand(await this.ctx.fetchDevice(command.deviceId), command);
-				if (outcome.ok) return true;
+				if (outcome.ok) return APPLIED;
 				if (outcome.reason === "no-provider") return this.noProvider(command.deviceId, outcome.capName);
 				this.ctx.logger.warn("ha-export: the device refused the command", {
 					tags: { deviceId: command.deviceId },
@@ -9148,7 +9202,11 @@ var HaExportAddon = class extends BaseAddon {
 						...outcome.error !== void 0 ? { error: outcome.error } : {}
 					}
 				});
-				return false;
+				return {
+					ok: false,
+					reason: outcome.reason,
+					...outcome.error !== void 0 ? { message: outcome.error } : {}
+				};
 			}
 			switch (command.kind) {
 				case "camera-function": {
@@ -9158,7 +9216,11 @@ var HaExportAddon = class extends BaseAddon {
 							tags: { deviceId: command.deviceId },
 							meta: { switchId: command.switchId }
 						});
-						return false;
+						return {
+							ok: false,
+							reason: "unknown-function",
+							message: "the switch id is not a camera function"
+						};
 					}
 					/**
 					* A FRESH read for this one device — the pass-level caches are up to
@@ -9168,7 +9230,11 @@ var HaExportAddon = class extends BaseAddon {
 					const device = await this.ctx.api.deviceManager.getDevice.query({ deviceId: command.deviceId });
 					if (device === null) {
 						this.ctx.logger.warn("ha-export: dropping a camera-function command, the device is not in the registry", { tags: { deviceId: command.deviceId } });
-						return false;
+						return {
+							ok: false,
+							reason: "device-not-found",
+							message: "the device is not in the registry"
+						};
 					}
 					const privacySlice = await this.ctx.api.deviceState.getCapSlice.query({
 						deviceId: command.deviceId,
@@ -9204,22 +9270,26 @@ var HaExportAddon = class extends BaseAddon {
 							tags: { deviceId: command.deviceId },
 							meta: { switchId: parsed.data }
 						});
-						return false;
+						return {
+							ok: false,
+							reason: "function-unavailable",
+							message: "the camera function is not available"
+						};
 					}
 					await applyCameraFunctionWrite(this.ctx.api, command.deviceId, write, sourceNodeId);
-					return true;
+					return APPLIED;
 				}
 				case "reboot": {
 					const device = await this.ctx.fetchDevice(command.deviceId);
 					if (device.reboot === void 0) return this.noProvider(command.deviceId, "reboot");
 					await device.reboot.reboot({});
-					return true;
+					return APPLIED;
 				}
 				case "ptz-move": {
 					const device = await this.ctx.fetchDevice(command.deviceId);
 					if (device.ptz === void 0) return this.noProvider(command.deviceId, "ptz");
 					await device.ptz.move(PTZ_MOVE_BY_DIRECTION[command.direction] ?? {});
-					return true;
+					return APPLIED;
 				}
 				case "ptz-preset": {
 					const device = await this.ctx.fetchDevice(command.deviceId);
@@ -9230,10 +9300,14 @@ var HaExportAddon = class extends BaseAddon {
 							tags: { deviceId: command.deviceId },
 							meta: { preset: command.preset }
 						});
-						return false;
+						return {
+							ok: false,
+							reason: "no-such-preset",
+							message: "no preset by that name"
+						};
 					}
 					await device.ptz.goToPreset({ presetId: preset.id });
-					return true;
+					return APPLIED;
 				}
 			}
 		} catch (err) {
@@ -9249,7 +9323,11 @@ var HaExportAddon = class extends BaseAddon {
 					error: errMsg(err)
 				}
 			});
-			return false;
+			return {
+				ok: false,
+				reason: "error",
+				message: errMsg(err)
+			};
 		}
 	}
 	/** A cap the device does not provide. Refused, and never silently. */
@@ -9258,7 +9336,11 @@ var HaExportAddon = class extends BaseAddon {
 			tags: { deviceId },
 			meta: { capName }
 		});
-		return false;
+		return {
+			ok: false,
+			reason: "no-provider",
+			message: `the device has no provider for ${capName}`
+		};
 	}
 	/**
 	* A public, signed, expiring route Home Assistant can fetch bytes from.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@camstack/addon-provider-homeassistant",
-  "version": "1.2.648",
+  "version": "1.2.650",
   "description": "Home Assistant device provider addon for CamStack",
   "keywords": [
     "camstack",
@@ -127,7 +127,7 @@
       "description": "Device provider (import) + native entity export (push). Two addons, one bundle, separate processes."
     },
     "requires": {
-      "server": ">=1.2.733"
+      "server": ">=1.2.740"
     }
   },
   "files": [