@camstack/addon-mqtt-broker 1.2.106 → 1.2.108

package/dist/mqtt-broker.addon.js

@@ -12341,7 +12341,23 @@ var PickStreamRequirementsSchema = object({
 	* This is what lets one picker serve both the bypass and the full source
 	* choice, instead of a consumer scoring privately when the bypass misses.
 	*/
-	allowTranscode: boolean().optional()
+	allowTranscode: boolean().optional(),
+	/**
+	* Consider ONLY streams the broker has bound to a profile slot.
+	*
+	* A consumer that dials the broker — which is every exporter, since none
+	* of them may open the camera's own URL — can do nothing with a source
+	* that has no slot: there is no restream to dial. Without this the picker
+	* can name such a stream, and each consumer discovers the dead end for
+	* itself: Alexa's `profileForCamStream` returns `null` and it quietly
+	* falls back, and HomeKit would have had to grow the same function again.
+	*
+	* Default `false`, and deliberately so: the BROKER itself picks through
+	* here when it decides which source to BIND to a slot
+	* (`computeInitialAssignment`), and it must see the unbound ones or it
+	* could never bind them.
+	*/
+	requireProfileBound: boolean().optional()
 }).readonly();
 var PickStreamPreferencesSchema = object({
 	/**
@@ -12382,7 +12398,43 @@ var PickedCamStreamSchema = object({
 	*/
 	transcodes: boolean(),
 	/** One-line explanation of why this stream won — for logs / debug UI. */
-	reason: string()
+	reason: string(),
+	/**
+	* The broker profile slot this source is bound to, when it is bound.
+	*
+	* Answered HERE because every consumer needs it and none of them can get it
+	* from the `camStreamId` alone. Alexa wrote `profileForCamStream` for it —
+	* a second cap read plus a `null` branch — and HomeKit was about to write
+	* the same function a second time.
+	*
+	* Absent when the source has no slot, which a caller passing
+	* `requireProfileBound` can never see.
+	*/
+	profile: CamProfileSchema.optional(),
+	/** The broker id of that slot, for logs that must name what was dialled. */
+	brokerId: string().optional(),
+	/**
+	* The broker restream URL to dial for this stream.
+	*
+	* An exporter must never open the camera's own URL — the broker is the one
+	* that dials the camera, and every consumer goes through its restream. So
+	* the picker answers with the thing a consumer may actually use, instead of
+	* naming a source and leaving each caller to look the URL up.
+	*/
+	url: string().optional(),
+	/**
+	* Frames per second this stream really delivers, and where the number came
+	* from.
+	*
+	* It is here because getting it wrong is expensive and silent: a HomeKit
+	* accessory advertised 720p at 24 fps while the slot serving it ran at 9,
+	* and the controller rendered nothing at all. The source is carried with the
+	* value for the same reason the bitrate evidence is: `published` is what the
+	* publisher declares and `measured` is what the broker observed, and they
+	* are not interchangeable.
+	*/
+	fps: number().positive().optional(),
+	fpsSource: _enum(["published", "measured"]).optional()
 });
 DeviceType.Camera, method(object({ deviceId: number().int().nonnegative() }), array(CameraStreamSchema).readonly()), method(object({ deviceId: number().int().nonnegative() }), array(ProfileSlotSchema).readonly()), method(object({
 	deviceId: number().int().nonnegative(),
@@ -13356,6 +13408,70 @@ var LocationIconAssignmentSchema = object({
 	locationKey: string(),
 	icon: LocationIconIdSchema
 });
+/**
+* One (location, description) assignment as it travels.
+*
+* Same key discipline as {@link LocationIconAssignmentSchema}, and for the same
+* reason: this lived for a while in the post-analysis addon's own settings,
+* keyed by a HAND-TYPED label matched exactly and case-sensitively. A rename in
+* the Locations page carried the icon and silently orphaned the description —
+* two authorities for one thing, joined by two different rules. Now both hang
+* off the location itself, on `locationIconKey`.
+*/
+var LocationDescriptionAssignmentSchema = object({
+	locationKey: string(),
+	description: string()
+});
+/**
+* A SITE ZONE — a named part of the property that several locations belong to.
+*
+* "Zona notte" holds every bedroom; "Zona giorno" the living room and the
+* kitchen. A camera belongs to exactly one location, and a location to at most
+* one zone, so a camera's zone is derived and never stored on the device: the
+* whole point of this entity is that grouping rooms touches no device row.
+*
+* ## Why not `zone`
+*
+* Because `zone` is already the most loaded word in this product: 612 source
+* files and 24 Italian strings where it means a DETECTION zone drawn on a
+* camera. The two are unrelated — one is a polygon in a frame, the other is a
+* set of rooms — and a reader who confuses them will look for a camera's
+* bedrooms. So the code says `siteZone` everywhere, and the UI frees the plain
+* word by calling the drawn one what it actually is: a detection zone.
+*
+* ## The key
+*
+* `siteZoneKey(label)` — trimmed, lower-cased, the SAME derivation locations
+* use (`locationIconKey`). Membership and the icon both hang off it, so a
+* case-only rename keeps them, which is exactly the orphaning that cost us a
+* silently-dropped location description.
+*
+* The icon vocabulary is the location one, unchanged: a zone is drawn on the
+* same two surfaces by the same glyph map, so a second vocabulary would be a
+* second thing to keep drawable (`scripts/check-location-icons-drawable.ts`).
+*/
+/**
+* One zone as it travels: its key, the label the operator typed, its icon and
+* the locations inside it.
+*
+* The LABEL is carried alongside the key because the key is lossy on purpose —
+* a surface must show "Zona notte", not "zona notte". Locations are carried
+* here, rather than left to a second call, because every consumer wants both
+* at once and a viewer that asked twice could render a zone whose membership
+* it has not fetched yet.
+*
+* `icon: null` means nobody chose one, which is NOT the fallback pin: only one
+* of those two is a choice, and a picker has to draw them differently.
+*/
+var SiteZoneSchema = object({
+	zoneKey: string(),
+	label: string(),
+	icon: LocationIconIdSchema.nullable(),
+	/** Folded location keys, sorted. A location listed here need not be
+	*  REGISTERED — devices carry labels nobody registered, and those rooms are
+	*  the ones that most want grouping. */
+	locationKeys: array(string())
+});
 var ProviderStatusSchema = object({
 	connected: boolean(),
 	deviceCount: number(),
@@ -13873,6 +13989,33 @@ method(object({
 }), _void(), {
 	kind: "mutation",
 	auth: "admin"
+}), method(_void(), array(LocationDescriptionAssignmentSchema)), method(object({
+	location: string(),
+	description: string().max(400).nullable()
+}), _void(), {
+	kind: "mutation",
+	auth: "admin"
+}), method(_void(), array(SiteZoneSchema)), method(object({
+	name: string(),
+	icon: LocationIconIdSchema.nullable().optional()
+}), _void(), {
+	kind: "mutation",
+	auth: "admin"
+}), method(object({ name: string() }), _void(), {
+	kind: "mutation",
+	auth: "admin"
+}), method(object({
+	from: string(),
+	to: string()
+}), _void(), {
+	kind: "mutation",
+	auth: "admin"
+}), method(object({
+	location: string(),
+	zone: string().nullable()
+}), _void(), {
+	kind: "mutation",
+	auth: "admin"
 }), method(object({
 	deviceId: number(),
 	disabled: boolean()
@@ -32715,6 +32858,12 @@ Object.freeze({
 		addonId: null,
 		access: "view"
 	},
+	"deviceManager.listLocationDescriptions": {
+		capName: "device-manager",
+		capScope: "system",
+		addonId: null,
+		access: "view"
+	},
 	"deviceManager.listLocationIcons": {
 		capName: "device-manager",
 		capScope: "system",
@@ -32733,6 +32882,12 @@ Object.freeze({
 		addonId: null,
 		access: "view"
 	},
+	"deviceManager.listSiteZones": {
+		capName: "device-manager",
+		capScope: "system",
+		addonId: null,
+		access: "view"
+	},
 	"deviceManager.listWrappersForCap": {
 		capName: "device-manager",
 		capScope: "system",
@@ -32817,12 +32972,24 @@ Object.freeze({
 		addonId: null,
 		access: "delete"
 	},
+	"deviceManager.removeSiteZone": {
+		capName: "device-manager",
+		capScope: "system",
+		addonId: null,
+		access: "delete"
+	},
 	"deviceManager.renameLocation": {
 		capName: "device-manager",
 		capScope: "system",
 		addonId: null,
 		access: "create"
 	},
+	"deviceManager.renameSiteZone": {
+		capName: "device-manager",
+		capScope: "system",
+		addonId: null,
+		access: "create"
+	},
 	"deviceManager.runDeviceAction": {
 		capName: "device-manager",
 		capScope: "system",
@@ -32865,12 +33032,24 @@ Object.freeze({
 		addonId: null,
 		access: "create"
 	},
+	"deviceManager.setLocationDescription": {
+		capName: "device-manager",
+		capScope: "system",
+		addonId: null,
+		access: "create"
+	},
 	"deviceManager.setLocationIcon": {
 		capName: "device-manager",
 		capScope: "system",
 		addonId: null,
 		access: "create"
 	},
+	"deviceManager.setLocationZone": {
+		capName: "device-manager",
+		capScope: "system",
+		addonId: null,
+		access: "create"
+	},
 	"deviceManager.setMetadata": {
 		capName: "device-manager",
 		capScope: "system",
@@ -32901,6 +33080,12 @@ Object.freeze({
 		addonId: null,
 		access: "create"
 	},
+	"deviceManager.setSiteZone": {
+		capName: "device-manager",
+		capScope: "system",
+		addonId: null,
+		access: "create"
+	},
 	"deviceManager.setStreamProfileMap": {
 		capName: "device-manager",
 		capScope: "system",

package/dist/mqtt-broker.addon.mjs

@@ -12336,7 +12336,23 @@ var PickStreamRequirementsSchema = object({
 	* This is what lets one picker serve both the bypass and the full source
 	* choice, instead of a consumer scoring privately when the bypass misses.
 	*/
-	allowTranscode: boolean().optional()
+	allowTranscode: boolean().optional(),
+	/**
+	* Consider ONLY streams the broker has bound to a profile slot.
+	*
+	* A consumer that dials the broker — which is every exporter, since none
+	* of them may open the camera's own URL — can do nothing with a source
+	* that has no slot: there is no restream to dial. Without this the picker
+	* can name such a stream, and each consumer discovers the dead end for
+	* itself: Alexa's `profileForCamStream` returns `null` and it quietly
+	* falls back, and HomeKit would have had to grow the same function again.
+	*
+	* Default `false`, and deliberately so: the BROKER itself picks through
+	* here when it decides which source to BIND to a slot
+	* (`computeInitialAssignment`), and it must see the unbound ones or it
+	* could never bind them.
+	*/
+	requireProfileBound: boolean().optional()
 }).readonly();
 var PickStreamPreferencesSchema = object({
 	/**
@@ -12377,7 +12393,43 @@ var PickedCamStreamSchema = object({
 	*/
 	transcodes: boolean(),
 	/** One-line explanation of why this stream won — for logs / debug UI. */
-	reason: string()
+	reason: string(),
+	/**
+	* The broker profile slot this source is bound to, when it is bound.
+	*
+	* Answered HERE because every consumer needs it and none of them can get it
+	* from the `camStreamId` alone. Alexa wrote `profileForCamStream` for it —
+	* a second cap read plus a `null` branch — and HomeKit was about to write
+	* the same function a second time.
+	*
+	* Absent when the source has no slot, which a caller passing
+	* `requireProfileBound` can never see.
+	*/
+	profile: CamProfileSchema.optional(),
+	/** The broker id of that slot, for logs that must name what was dialled. */
+	brokerId: string().optional(),
+	/**
+	* The broker restream URL to dial for this stream.
+	*
+	* An exporter must never open the camera's own URL — the broker is the one
+	* that dials the camera, and every consumer goes through its restream. So
+	* the picker answers with the thing a consumer may actually use, instead of
+	* naming a source and leaving each caller to look the URL up.
+	*/
+	url: string().optional(),
+	/**
+	* Frames per second this stream really delivers, and where the number came
+	* from.
+	*
+	* It is here because getting it wrong is expensive and silent: a HomeKit
+	* accessory advertised 720p at 24 fps while the slot serving it ran at 9,
+	* and the controller rendered nothing at all. The source is carried with the
+	* value for the same reason the bitrate evidence is: `published` is what the
+	* publisher declares and `measured` is what the broker observed, and they
+	* are not interchangeable.
+	*/
+	fps: number().positive().optional(),
+	fpsSource: _enum(["published", "measured"]).optional()
 });
 DeviceType.Camera, method(object({ deviceId: number().int().nonnegative() }), array(CameraStreamSchema).readonly()), method(object({ deviceId: number().int().nonnegative() }), array(ProfileSlotSchema).readonly()), method(object({
 	deviceId: number().int().nonnegative(),
@@ -13351,6 +13403,70 @@ var LocationIconAssignmentSchema = object({
 	locationKey: string(),
 	icon: LocationIconIdSchema
 });
+/**
+* One (location, description) assignment as it travels.
+*
+* Same key discipline as {@link LocationIconAssignmentSchema}, and for the same
+* reason: this lived for a while in the post-analysis addon's own settings,
+* keyed by a HAND-TYPED label matched exactly and case-sensitively. A rename in
+* the Locations page carried the icon and silently orphaned the description —
+* two authorities for one thing, joined by two different rules. Now both hang
+* off the location itself, on `locationIconKey`.
+*/
+var LocationDescriptionAssignmentSchema = object({
+	locationKey: string(),
+	description: string()
+});
+/**
+* A SITE ZONE — a named part of the property that several locations belong to.
+*
+* "Zona notte" holds every bedroom; "Zona giorno" the living room and the
+* kitchen. A camera belongs to exactly one location, and a location to at most
+* one zone, so a camera's zone is derived and never stored on the device: the
+* whole point of this entity is that grouping rooms touches no device row.
+*
+* ## Why not `zone`
+*
+* Because `zone` is already the most loaded word in this product: 612 source
+* files and 24 Italian strings where it means a DETECTION zone drawn on a
+* camera. The two are unrelated — one is a polygon in a frame, the other is a
+* set of rooms — and a reader who confuses them will look for a camera's
+* bedrooms. So the code says `siteZone` everywhere, and the UI frees the plain
+* word by calling the drawn one what it actually is: a detection zone.
+*
+* ## The key
+*
+* `siteZoneKey(label)` — trimmed, lower-cased, the SAME derivation locations
+* use (`locationIconKey`). Membership and the icon both hang off it, so a
+* case-only rename keeps them, which is exactly the orphaning that cost us a
+* silently-dropped location description.
+*
+* The icon vocabulary is the location one, unchanged: a zone is drawn on the
+* same two surfaces by the same glyph map, so a second vocabulary would be a
+* second thing to keep drawable (`scripts/check-location-icons-drawable.ts`).
+*/
+/**
+* One zone as it travels: its key, the label the operator typed, its icon and
+* the locations inside it.
+*
+* The LABEL is carried alongside the key because the key is lossy on purpose —
+* a surface must show "Zona notte", not "zona notte". Locations are carried
+* here, rather than left to a second call, because every consumer wants both
+* at once and a viewer that asked twice could render a zone whose membership
+* it has not fetched yet.
+*
+* `icon: null` means nobody chose one, which is NOT the fallback pin: only one
+* of those two is a choice, and a picker has to draw them differently.
+*/
+var SiteZoneSchema = object({
+	zoneKey: string(),
+	label: string(),
+	icon: LocationIconIdSchema.nullable(),
+	/** Folded location keys, sorted. A location listed here need not be
+	*  REGISTERED — devices carry labels nobody registered, and those rooms are
+	*  the ones that most want grouping. */
+	locationKeys: array(string())
+});
 var ProviderStatusSchema = object({
 	connected: boolean(),
 	deviceCount: number(),
@@ -13868,6 +13984,33 @@ method(object({
 }), _void(), {
 	kind: "mutation",
 	auth: "admin"
+}), method(_void(), array(LocationDescriptionAssignmentSchema)), method(object({
+	location: string(),
+	description: string().max(400).nullable()
+}), _void(), {
+	kind: "mutation",
+	auth: "admin"
+}), method(_void(), array(SiteZoneSchema)), method(object({
+	name: string(),
+	icon: LocationIconIdSchema.nullable().optional()
+}), _void(), {
+	kind: "mutation",
+	auth: "admin"
+}), method(object({ name: string() }), _void(), {
+	kind: "mutation",
+	auth: "admin"
+}), method(object({
+	from: string(),
+	to: string()
+}), _void(), {
+	kind: "mutation",
+	auth: "admin"
+}), method(object({
+	location: string(),
+	zone: string().nullable()
+}), _void(), {
+	kind: "mutation",
+	auth: "admin"
 }), method(object({
 	deviceId: number(),
 	disabled: boolean()
@@ -32710,6 +32853,12 @@ Object.freeze({
 		addonId: null,
 		access: "view"
 	},
+	"deviceManager.listLocationDescriptions": {
+		capName: "device-manager",
+		capScope: "system",
+		addonId: null,
+		access: "view"
+	},
 	"deviceManager.listLocationIcons": {
 		capName: "device-manager",
 		capScope: "system",
@@ -32728,6 +32877,12 @@ Object.freeze({
 		addonId: null,
 		access: "view"
 	},
+	"deviceManager.listSiteZones": {
+		capName: "device-manager",
+		capScope: "system",
+		addonId: null,
+		access: "view"
+	},
 	"deviceManager.listWrappersForCap": {
 		capName: "device-manager",
 		capScope: "system",
@@ -32812,12 +32967,24 @@ Object.freeze({
 		addonId: null,
 		access: "delete"
 	},
+	"deviceManager.removeSiteZone": {
+		capName: "device-manager",
+		capScope: "system",
+		addonId: null,
+		access: "delete"
+	},
 	"deviceManager.renameLocation": {
 		capName: "device-manager",
 		capScope: "system",
 		addonId: null,
 		access: "create"
 	},
+	"deviceManager.renameSiteZone": {
+		capName: "device-manager",
+		capScope: "system",
+		addonId: null,
+		access: "create"
+	},
 	"deviceManager.runDeviceAction": {
 		capName: "device-manager",
 		capScope: "system",
@@ -32860,12 +33027,24 @@ Object.freeze({
 		addonId: null,
 		access: "create"
 	},
+	"deviceManager.setLocationDescription": {
+		capName: "device-manager",
+		capScope: "system",
+		addonId: null,
+		access: "create"
+	},
 	"deviceManager.setLocationIcon": {
 		capName: "device-manager",
 		capScope: "system",
 		addonId: null,
 		access: "create"
 	},
+	"deviceManager.setLocationZone": {
+		capName: "device-manager",
+		capScope: "system",
+		addonId: null,
+		access: "create"
+	},
 	"deviceManager.setMetadata": {
 		capName: "device-manager",
 		capScope: "system",
@@ -32896,6 +33075,12 @@ Object.freeze({
 		addonId: null,
 		access: "create"
 	},
+	"deviceManager.setSiteZone": {
+		capName: "device-manager",
+		capScope: "system",
+		addonId: null,
+		access: "create"
+	},
 	"deviceManager.setStreamProfileMap": {
 		capName: "device-manager",
 		capScope: "system",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@camstack/addon-mqtt-broker",
-  "version": "1.2.106",
+  "version": "1.2.108",
   "description": "MQTT broker registry addon for CamStack — manages external broker entries + an optional embedded aedes broker. Consumers spin up their own `mqtt.js` clients via the `mqtt-broker` cap.",
   "keywords": [
     "camstack",