@camstack/types 1.2.203 → 1.2.205

package/dist/index.js

@@ -9442,7 +9442,23 @@ var PickStreamRequirementsSchema = zod.z.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: zod.z.boolean().optional()
+	allowTranscode: zod.z.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: zod.z.boolean().optional()
 }).readonly();
 var PickStreamPreferencesSchema = zod.z.object({
 	/**
@@ -9483,7 +9499,43 @@ var PickedCamStreamSchema = zod.z.object({
 	*/
 	transcodes: zod.z.boolean(),
 	/** One-line explanation of why this stream won — for logs / debug UI. */
-	reason: zod.z.string()
+	reason: zod.z.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: require_sleep.CamProfileSchema.optional(),
+	/** The broker id of that slot, for logs that must name what was dialled. */
+	brokerId: zod.z.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: zod.z.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: zod.z.number().positive().optional(),
+	fpsSource: zod.z.enum(["published", "measured"]).optional()
 });
 /**
 * Camera streams — device-scoped facade over the system `stream-broker`.
@@ -11561,6 +11613,93 @@ function resolveLocationIcon(value) {
 	const parsed = LocationIconIdSchema.safeParse(value);
 	return parsed.success ? parsed.data : LOCATION_ICON_FALLBACK;
 }
+/**
+* How long a location description may be.
+*
+* It is given to a vision model alongside the pictures, so it competes for the
+* same attention the pictures need. A cap of one short paragraph is what keeps
+* it a PLACE description rather than a second prompt — an operator who needs
+* more than this is describing events, which change, instead of the ground,
+* which does not.
+*/
+var LOCATION_DESCRIPTION_MAX = 400;
+/**
+* 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 = zod.z.object({
+	locationKey: zod.z.string(),
+	description: zod.z.string()
+});
+//#endregion
+//#region src/device/site-zone.ts
+/**
+* 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 = zod.z.object({
+	zoneKey: zod.z.string(),
+	label: zod.z.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: zod.z.array(zod.z.string())
+});
+/**
+* The join key for a zone label: trimmed, lower-cased.
+*
+* Deliberately a separate export from `locationIconKey` even though the
+* derivation is identical — they key different maps, and a future change to one
+* must not silently re-key the other. Their agreement is a fact about today,
+* not a dependency.
+*/
+function siteZoneKey(label) {
+	return label.trim().toLowerCase();
+}
 //#endregion
 //#region src/capabilities/device-provider.cap.ts
 var ProviderStatusSchema = zod.z.object({
@@ -12365,6 +12504,94 @@ var deviceManagerCapability = {
 			kind: "mutation",
 			auth: "admin"
 		}),
+		/** Every location that carries a DESCRIPTION — what the place LOOKS like,
+		*  in plain words, given to the vision model alongside the pictures so it
+		*  knows what it is looking at. A driveway of cobbles between a brick wall
+		*  and three parking spaces reads very differently from a back garden.
+		*
+		*  Same additive shape and same join key as `listLocationIcons`, and that
+		*  is the point of it being here at all: this lived in the post-analysis
+		*  addon's own settings, keyed by a hand-typed label matched exactly and
+		*  case-sensitively, while the icon hung off the location itself. A rename
+		*  carried the icon and silently orphaned the description. One location,
+		*  one authority, one key.
+		*
+		*  Absent means nobody wrote one — the digest then tells the model only the
+		*  location NAME, exactly as it did before descriptions existed. */
+		listLocationDescriptions: require_sleep.method(zod.z.void(), zod.z.array(LocationDescriptionAssignmentSchema)),
+		/** Set (or clear) a location's description. `description: null`, or a
+		*  blank string, removes it — an empty description and no description are
+		*  the same thing to every reader, and storing the first would send an
+		*  empty line to the model.
+		*
+		*  Like `setLocationIcon`, the label need NOT be registered, and an
+		*  empty / whitespace-only LABEL throws. */
+		setLocationDescription: require_sleep.method(zod.z.object({
+			location: zod.z.string(),
+			description: zod.z.string().max(400).nullable()
+		}), zod.z.void(), {
+			kind: "mutation",
+			auth: "admin"
+		}),
+		/** Every SITE ZONE — a named part of the property that groups locations
+		*  ("Zona notte" holds the bedrooms). One call answers the whole picture:
+		*  key, the label as typed, the icon, and the locations inside.
+		*
+		*  Together, because a surface that asked for membership separately could
+		*  draw a zone whose rooms it has not fetched — and the strip that renders
+		*  these puts zones BEFORE locations, so a half-known zone is the first
+		*  thing an operator sees.
+		*
+		*  Nothing here touches a device: a camera's zone is derived from its
+		*  location, never stored on the row. Grouping rooms must not rewrite the
+		*  fleet. */
+		listSiteZones: require_sleep.method(zod.z.void(), zod.z.array(SiteZoneSchema)),
+		/** Create a zone, or set the icon of one that exists. `icon: null` clears
+		*  the icon and KEEPS the zone — a zone with no icon is a normal zone, and
+		*  conflating "no icon" with "no zone" would delete membership on a
+		*  mis-click.
+		*
+		*  Idempotent, and the label is stored as typed: the key is folded, so
+		*  re-running this with different casing re-labels rather than duplicating. */
+		setSiteZone: require_sleep.method(zod.z.object({
+			name: zod.z.string(),
+			icon: LocationIconIdSchema.nullable().optional()
+		}), zod.z.void(), {
+			kind: "mutation",
+			auth: "admin"
+		}),
+		/** Delete a zone. Its LOCATIONS survive — they simply stop belonging to
+		*  anything. Deleting a grouping must never delete what was grouped. */
+		removeSiteZone: require_sleep.method(zod.z.object({ name: zod.z.string() }), zod.z.void(), {
+			kind: "mutation",
+			auth: "admin"
+		}),
+		/** Rename a zone, carrying its icon AND its membership.
+		*
+		*  It exists so that renaming is not delete-then-recreate, which would drop
+		*  both — the exact orphaning that lost a location's description when the
+		*  two hung off different keys. Renaming onto an existing zone MERGES into
+		*  it and the target keeps its own icon. */
+		renameSiteZone: require_sleep.method(zod.z.object({
+			from: zod.z.string(),
+			to: zod.z.string()
+		}), zod.z.void(), {
+			kind: "mutation",
+			auth: "admin"
+		}),
+		/** Put a location in a zone, or take it out with `zone: null`.
+		*
+		*  At most one zone per location, by construction: this writes one key, so
+		*  there is no state in which a room is in two places at once. The zone
+		*  need not exist yet — it is created empty-labelled from this call, the
+		*  same way `setLocationIcon` does not require a registered location. */
+		setLocationZone: require_sleep.method(zod.z.object({
+			location: zod.z.string(),
+			zone: zod.z.string().nullable()
+		}), zod.z.void(), {
+			kind: "mutation",
+			auth: "admin"
+		}),
 		/** Soft-disable / re-enable the device. Drivers consult
 		*  `BaseDevice.disabled` to gate lifecycle hooks. */
 		setDisabled: require_sleep.method(zod.z.object({
@@ -44999,6 +45226,12 @@ var METHOD_ACCESS_MAP = Object.freeze({
 		addonId: null,
 		access: "view"
 	},
+	"deviceManager.listLocationDescriptions": {
+		capName: "device-manager",
+		capScope: "system",
+		addonId: null,
+		access: "view"
+	},
 	"deviceManager.listLocationIcons": {
 		capName: "device-manager",
 		capScope: "system",
@@ -45017,6 +45250,12 @@ var METHOD_ACCESS_MAP = Object.freeze({
 		addonId: null,
 		access: "view"
 	},
+	"deviceManager.listSiteZones": {
+		capName: "device-manager",
+		capScope: "system",
+		addonId: null,
+		access: "view"
+	},
 	"deviceManager.listWrappersForCap": {
 		capName: "device-manager",
 		capScope: "system",
@@ -45101,12 +45340,24 @@ var METHOD_ACCESS_MAP = 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",
@@ -45149,12 +45400,24 @@ var METHOD_ACCESS_MAP = 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",
@@ -45185,6 +45448,12 @@ var METHOD_ACCESS_MAP = Object.freeze({
 		addonId: null,
 		access: "create"
 	},
+	"deviceManager.setSiteZone": {
+		capName: "device-manager",
+		capScope: "system",
+		addonId: null,
+		access: "create"
+	},
 	"deviceManager.setStreamProfileMap": {
 		capName: "device-manager",
 		capScope: "system",
@@ -52775,6 +53044,13 @@ function createSystemProxy(api) {
 			renameLocation: (input) => dispatch("deviceManager", "renameLocation", "mutation", input),
 			listLocationIcons: (input) => dispatch("deviceManager", "listLocationIcons", "query", input),
 			setLocationIcon: (input) => dispatch("deviceManager", "setLocationIcon", "mutation", input),
+			listLocationDescriptions: (input) => dispatch("deviceManager", "listLocationDescriptions", "query", input),
+			setLocationDescription: (input) => dispatch("deviceManager", "setLocationDescription", "mutation", input),
+			listSiteZones: (input) => dispatch("deviceManager", "listSiteZones", "query", input),
+			setSiteZone: (input) => dispatch("deviceManager", "setSiteZone", "mutation", input),
+			removeSiteZone: (input) => dispatch("deviceManager", "removeSiteZone", "mutation", input),
+			renameSiteZone: (input) => dispatch("deviceManager", "renameSiteZone", "mutation", input),
+			setLocationZone: (input) => dispatch("deviceManager", "setLocationZone", "mutation", input),
 			listPersistedByAddon: (input) => dispatch("deviceManager", "listPersistedByAddon", "query", input),
 			listAll: (input) => dispatch("deviceManager", "listAll", "query", input),
 			getChildren: (input) => dispatch("deviceManager", "getChildren", "query", input),
@@ -57752,6 +58028,7 @@ exports.KeyEventSchema = KeyEventSchema;
 exports.LEGACY_READ_ONLY_CONFIG_KEY = LEGACY_READ_ONLY_CONFIG_KEY;
 exports.LOAD_CONTRIBUTION_ATTRIBUTIONS = LOAD_CONTRIBUTION_ATTRIBUTIONS;
 exports.LOAD_CONTRIBUTION_ROLES = LOAD_CONTRIBUTION_ROLES;
+exports.LOCATION_DESCRIPTION_MAX = LOCATION_DESCRIPTION_MAX;
 exports.LOCATION_ICON_FALLBACK = LOCATION_ICON_FALLBACK;
 exports.LOCATION_ICON_IDS = LOCATION_ICON_IDS;
 exports.LOG_CHANNEL_TICK_MS = LOG_CHANNEL_TICK_MS;
@@ -57794,6 +58071,7 @@ exports.LlmUsageRollupSchema = LlmUsageRollupSchema;
 exports.LlmUsageSchema = LlmUsageSchema;
 exports.LoadContributionSchema = LoadContributionSchema;
 exports.LocateSegmentResultSchema = LocateSegmentResultSchema;
+exports.LocationDescriptionAssignmentSchema = LocationDescriptionAssignmentSchema;
 exports.LocationIconAssignmentSchema = LocationIconAssignmentSchema;
 exports.LocationIconIdSchema = LocationIconIdSchema;
 exports.LocationStatSchema = LocationStatSchema;
@@ -58271,6 +58549,7 @@ exports.ShmRingStatsSchema = ShmRingStatsSchema;
 exports.SiteLocationSchema = SiteLocationSchema;
 exports.SiteLocationSourceSchema = SiteLocationSourceSchema;
 exports.SiteLocationStatusSchema = SiteLocationStatusSchema;
+exports.SiteZoneSchema = SiteZoneSchema;
 exports.SmokeStatusSchema = SmokeStatusSchema;
 exports.SmtpStatusSchema = SmtpStatusSchema;
 exports.SnapshotImageSchema = SnapshotImageSchema;
@@ -58855,6 +59134,7 @@ exports.setByPath = setByPath;
 exports.settingsStoreCapability = settingsStoreCapability;
 exports.signalPercentFromBars = signalPercentFromBars;
 exports.signalPercentFromRssi = signalPercentFromRssi;
+exports.siteZoneKey = siteZoneKey;
 exports.sleep = require_sleep.sleep;
 exports.sleepCancellable = require_sleep.sleepCancellable;
 exports.sliceActiveValue = sliceActiveValue;