@camstack/addon-mqtt-broker 1.2.107 → 1.2.108

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -12341,7 +12341,23 @@ var PickStreamRequirementsSchema = object({
12341
12341
  * This is what lets one picker serve both the bypass and the full source
12342
12342
  * choice, instead of a consumer scoring privately when the bypass misses.
12343
12343
  */
12344
- allowTranscode: boolean().optional()
12344
+ allowTranscode: boolean().optional(),
12345
+ /**
12346
+ * Consider ONLY streams the broker has bound to a profile slot.
12347
+ *
12348
+ * A consumer that dials the broker — which is every exporter, since none
12349
+ * of them may open the camera's own URL — can do nothing with a source
12350
+ * that has no slot: there is no restream to dial. Without this the picker
12351
+ * can name such a stream, and each consumer discovers the dead end for
12352
+ * itself: Alexa's `profileForCamStream` returns `null` and it quietly
12353
+ * falls back, and HomeKit would have had to grow the same function again.
12354
+ *
12355
+ * Default `false`, and deliberately so: the BROKER itself picks through
12356
+ * here when it decides which source to BIND to a slot
12357
+ * (`computeInitialAssignment`), and it must see the unbound ones or it
12358
+ * could never bind them.
12359
+ */
12360
+ requireProfileBound: boolean().optional()
12345
12361
  }).readonly();
12346
12362
  var PickStreamPreferencesSchema = object({
12347
12363
  /**
@@ -12382,7 +12398,43 @@ var PickedCamStreamSchema = object({
12382
12398
  */
12383
12399
  transcodes: boolean(),
12384
12400
  /** One-line explanation of why this stream won — for logs / debug UI. */
12385
- reason: string()
12401
+ reason: string(),
12402
+ /**
12403
+ * The broker profile slot this source is bound to, when it is bound.
12404
+ *
12405
+ * Answered HERE because every consumer needs it and none of them can get it
12406
+ * from the `camStreamId` alone. Alexa wrote `profileForCamStream` for it —
12407
+ * a second cap read plus a `null` branch — and HomeKit was about to write
12408
+ * the same function a second time.
12409
+ *
12410
+ * Absent when the source has no slot, which a caller passing
12411
+ * `requireProfileBound` can never see.
12412
+ */
12413
+ profile: CamProfileSchema.optional(),
12414
+ /** The broker id of that slot, for logs that must name what was dialled. */
12415
+ brokerId: string().optional(),
12416
+ /**
12417
+ * The broker restream URL to dial for this stream.
12418
+ *
12419
+ * An exporter must never open the camera's own URL — the broker is the one
12420
+ * that dials the camera, and every consumer goes through its restream. So
12421
+ * the picker answers with the thing a consumer may actually use, instead of
12422
+ * naming a source and leaving each caller to look the URL up.
12423
+ */
12424
+ url: string().optional(),
12425
+ /**
12426
+ * Frames per second this stream really delivers, and where the number came
12427
+ * from.
12428
+ *
12429
+ * It is here because getting it wrong is expensive and silent: a HomeKit
12430
+ * accessory advertised 720p at 24 fps while the slot serving it ran at 9,
12431
+ * and the controller rendered nothing at all. The source is carried with the
12432
+ * value for the same reason the bitrate evidence is: `published` is what the
12433
+ * publisher declares and `measured` is what the broker observed, and they
12434
+ * are not interchangeable.
12435
+ */
12436
+ fps: number().positive().optional(),
12437
+ fpsSource: _enum(["published", "measured"]).optional()
12386
12438
  });
12387
12439
  DeviceType.Camera, method(object({ deviceId: number().int().nonnegative() }), array(CameraStreamSchema).readonly()), method(object({ deviceId: number().int().nonnegative() }), array(ProfileSlotSchema).readonly()), method(object({
12388
12440
  deviceId: number().int().nonnegative(),
@@ -12336,7 +12336,23 @@ var PickStreamRequirementsSchema = object({
12336
12336
  * This is what lets one picker serve both the bypass and the full source
12337
12337
  * choice, instead of a consumer scoring privately when the bypass misses.
12338
12338
  */
12339
- allowTranscode: boolean().optional()
12339
+ allowTranscode: boolean().optional(),
12340
+ /**
12341
+ * Consider ONLY streams the broker has bound to a profile slot.
12342
+ *
12343
+ * A consumer that dials the broker — which is every exporter, since none
12344
+ * of them may open the camera's own URL — can do nothing with a source
12345
+ * that has no slot: there is no restream to dial. Without this the picker
12346
+ * can name such a stream, and each consumer discovers the dead end for
12347
+ * itself: Alexa's `profileForCamStream` returns `null` and it quietly
12348
+ * falls back, and HomeKit would have had to grow the same function again.
12349
+ *
12350
+ * Default `false`, and deliberately so: the BROKER itself picks through
12351
+ * here when it decides which source to BIND to a slot
12352
+ * (`computeInitialAssignment`), and it must see the unbound ones or it
12353
+ * could never bind them.
12354
+ */
12355
+ requireProfileBound: boolean().optional()
12340
12356
  }).readonly();
12341
12357
  var PickStreamPreferencesSchema = object({
12342
12358
  /**
@@ -12377,7 +12393,43 @@ var PickedCamStreamSchema = object({
12377
12393
  */
12378
12394
  transcodes: boolean(),
12379
12395
  /** One-line explanation of why this stream won — for logs / debug UI. */
12380
- reason: string()
12396
+ reason: string(),
12397
+ /**
12398
+ * The broker profile slot this source is bound to, when it is bound.
12399
+ *
12400
+ * Answered HERE because every consumer needs it and none of them can get it
12401
+ * from the `camStreamId` alone. Alexa wrote `profileForCamStream` for it —
12402
+ * a second cap read plus a `null` branch — and HomeKit was about to write
12403
+ * the same function a second time.
12404
+ *
12405
+ * Absent when the source has no slot, which a caller passing
12406
+ * `requireProfileBound` can never see.
12407
+ */
12408
+ profile: CamProfileSchema.optional(),
12409
+ /** The broker id of that slot, for logs that must name what was dialled. */
12410
+ brokerId: string().optional(),
12411
+ /**
12412
+ * The broker restream URL to dial for this stream.
12413
+ *
12414
+ * An exporter must never open the camera's own URL — the broker is the one
12415
+ * that dials the camera, and every consumer goes through its restream. So
12416
+ * the picker answers with the thing a consumer may actually use, instead of
12417
+ * naming a source and leaving each caller to look the URL up.
12418
+ */
12419
+ url: string().optional(),
12420
+ /**
12421
+ * Frames per second this stream really delivers, and where the number came
12422
+ * from.
12423
+ *
12424
+ * It is here because getting it wrong is expensive and silent: a HomeKit
12425
+ * accessory advertised 720p at 24 fps while the slot serving it ran at 9,
12426
+ * and the controller rendered nothing at all. The source is carried with the
12427
+ * value for the same reason the bitrate evidence is: `published` is what the
12428
+ * publisher declares and `measured` is what the broker observed, and they
12429
+ * are not interchangeable.
12430
+ */
12431
+ fps: number().positive().optional(),
12432
+ fpsSource: _enum(["published", "measured"]).optional()
12381
12433
  });
12382
12434
  DeviceType.Camera, method(object({ deviceId: number().int().nonnegative() }), array(CameraStreamSchema).readonly()), method(object({ deviceId: number().int().nonnegative() }), array(ProfileSlotSchema).readonly()), method(object({
12383
12435
  deviceId: number().int().nonnegative(),
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@camstack/addon-mqtt-broker",
3
- "version": "1.2.107",
3
+ "version": "1.2.108",
4
4
  "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.",
5
5
  "keywords": [
6
6
  "camstack",