@camstack/addon-provider-onvif 1.2.31 → 1.2.32

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.
package/dist/addon.js CHANGED
@@ -26312,17 +26312,60 @@ var SetSiteLocationInputSchema = object({
26312
26312
  longitude: number().min(-180).max(180)
26313
26313
  }).nullable();
26314
26314
  /**
26315
- * One `(procedure, user-agent, ip, principal)` tuple of the HTTP request
26315
+ * The TRANSPORT a call arrived on.
26316
+ *
26317
+ * Every counted call carries exactly one of these, and `unknown` is a PLANE
26318
+ * rather than a gap: a plane that cannot attribute a call declares it here, so
26319
+ * the call lands in a named bucket instead of vanishing. `planes` summing to
26320
+ * `procedureCalls` is what makes "the sum of the planes explains the total"
26321
+ * checkable rather than asserted.
26322
+ *
26323
+ * - `http` — the Fastify tRPC plugin (`/trpc/*`), one context per request.
26324
+ * - `ws` — `applyWSSHandler`, counted per OPERATION rather than per
26325
+ * connection; the viewer talks to the hub over `wsLink`
26326
+ * exclusively, so this is the plane the HTTP census could not see.
26327
+ * - `mesh` — the in-process `$core-caps` bridge (`createCaller`), which
26328
+ * never touches a socket and therefore never touched a census.
26329
+ * - `unknown` — counted, plane undecidable. No hook produces it today, and
26330
+ * that is exactly what its `0` asserts: every plane the hub has can name
26331
+ * itself. It is an output bucket, never a knob — a call that arrives on a
26332
+ * plane nobody instrumented lands here instead of vanishing from the total.
26333
+ */
26334
+ var TransportPlaneSchema = _enum([
26335
+ "http",
26336
+ "ws",
26337
+ "mesh",
26338
+ "unknown"
26339
+ ]);
26340
+ /**
26341
+ * Calls per plane. Every key is always present, `0` included — an absent plane
26342
+ * reads as "not instrumented", which is the one thing this census must never
26343
+ * make an operator wonder about.
26344
+ */
26345
+ var TransportPlaneCountsSchema = object({
26346
+ http: number(),
26347
+ ws: number(),
26348
+ mesh: number(),
26349
+ unknown: number()
26350
+ });
26351
+ /**
26352
+ * One `(plane, procedure, user-agent, ip, principal)` tuple of the transport
26316
26353
  * census. `principal` is the DERIVED identity (`apocaliss92 (admin)`,
26317
26354
  * `scoped:1a2b3c4d (scoped-token)`, `anonymous`) that the tRPC error log
26318
26355
  * already prints - never a token, never an `Authorization` header.
26356
+ *
26357
+ * `subscriptions` is counted APART from `calls`: a subscription is opened once
26358
+ * and lives for hours, so folding it into a call count makes one long-lived
26359
+ * stream look like a storm.
26319
26360
  */
26320
26361
  var RequestCensusGroupSchema = object({
26362
+ plane: TransportPlaneSchema,
26321
26363
  procedure: string(),
26322
26364
  userAgent: string(),
26323
26365
  ip: string(),
26324
26366
  principal: string(),
26325
26367
  calls: number(),
26368
+ subscriptions: number(),
26326
26369
  perMin: number()
26327
26370
  });
26328
26371
  /**
@@ -26335,6 +26378,14 @@ var RequestCensusGroupSchema = object({
26335
26378
  var RequestCensusProcedureSchema = object({
26336
26379
  procedure: string(),
26337
26380
  calls: number(),
26381
+ /**
26382
+ * The same total, split by transport. THIS is the row that answers the
26383
+ * question the census exists for: one look at `deviceManager.listAll` says
26384
+ * which plane carried the 4 960, without joining two log lines by eye.
26385
+ */
26386
+ planes: TransportPlaneCountsSchema,
26387
+ /** Subscription STARTS on this procedure. Never folded into `calls`. */
26388
+ subscriptions: number(),
26338
26389
  perMin: number()
26339
26390
  });
26340
26391
  /**
@@ -26362,14 +26413,45 @@ var RequestCensusStatusSchema = object({
26362
26413
  */
26363
26414
  procedureCalls: number(),
26364
26415
  /**
26416
+ * `procedureCalls` split by transport. The four keys sum to
26417
+ * `procedureCalls` by construction - {@link RequestCensusSnapshotSchema}'s
26418
+ * `planesExplainTotal` is that identity, checked rather than assumed.
26419
+ */
26420
+ planes: TransportPlaneCountsSchema,
26421
+ /**
26422
+ * True iff `planes` sums to `procedureCalls`. False means a call was counted
26423
+ * on no plane at all - which is a RESULT (a plane is missing from the
26424
+ * instrument), not a failure, and it has to be visible to be read as one.
26425
+ */
26426
+ planesExplainTotal: boolean(),
26427
+ /**
26365
26428
  * tRPC WebSocket connections opened during the window. NOT calls - the WS
26366
- * transport resolves one context per connection - but the number that says
26367
- * whether a plane this census cannot see was busy while HTTP was quiet.
26429
+ * adapter resolves one context per connection - kept because a plane's call
26430
+ * count of zero against 37 open connections says something different from a
26431
+ * plane with no connections at all.
26368
26432
  */
26369
26433
  wsConnections: number(),
26434
+ /**
26435
+ * Client frames the WS plane looked at. `wsMessages` far above
26436
+ * `planes.ws + subscriptions` means most traffic is not operations
26437
+ * (keepalives, connection params) - which is itself an answer.
26438
+ */
26439
+ wsMessages: number(),
26440
+ /**
26441
+ * Subscription STARTS across every plane, excluded from `procedureCalls` on
26442
+ * purpose: one live-events stream opened at boot and held for six hours is
26443
+ * one subscription, and counting it as a call would let a quiet plane
26444
+ * masquerade as the storm.
26445
+ */
26446
+ subscriptions: number(),
26447
+ /** `subscription.stop` frames. Starts minus stops is what is still open. */
26448
+ subscriptionStops: number(),
26370
26449
  distinctGroups: number(),
26371
- /** Calls counted in the totals whose group attribution was shed at the
26372
- * cardinality bound. */
26450
+ /**
26451
+ * Operations counted in the totals whose CALLER attribution was shed at the
26452
+ * cardinality bound. Unrelated to the `unknown` PLANE: these calls know
26453
+ * which transport they arrived on, they just lost their group row.
26454
+ */
26373
26455
  unattributedCalls: number(),
26374
26456
  procedures: array(RequestCensusProcedureSchema).readonly(),
26375
26457
  groups: array(RequestCensusGroupSchema).readonly()
package/dist/addon.mjs CHANGED
@@ -26313,17 +26313,60 @@ var SetSiteLocationInputSchema = object({
26313
26313
  longitude: number().min(-180).max(180)
26314
26314
  }).nullable();
26315
26315
  /**
26316
- * One `(procedure, user-agent, ip, principal)` tuple of the HTTP request
26316
+ * The TRANSPORT a call arrived on.
26317
+ *
26318
+ * Every counted call carries exactly one of these, and `unknown` is a PLANE
26319
+ * rather than a gap: a plane that cannot attribute a call declares it here, so
26320
+ * the call lands in a named bucket instead of vanishing. `planes` summing to
26321
+ * `procedureCalls` is what makes "the sum of the planes explains the total"
26322
+ * checkable rather than asserted.
26323
+ *
26324
+ * - `http` — the Fastify tRPC plugin (`/trpc/*`), one context per request.
26325
+ * - `ws` — `applyWSSHandler`, counted per OPERATION rather than per
26326
+ * connection; the viewer talks to the hub over `wsLink`
26327
+ * exclusively, so this is the plane the HTTP census could not see.
26328
+ * - `mesh` — the in-process `$core-caps` bridge (`createCaller`), which
26329
+ * never touches a socket and therefore never touched a census.
26330
+ * - `unknown` — counted, plane undecidable. No hook produces it today, and
26331
+ * that is exactly what its `0` asserts: every plane the hub has can name
26332
+ * itself. It is an output bucket, never a knob — a call that arrives on a
26333
+ * plane nobody instrumented lands here instead of vanishing from the total.
26334
+ */
26335
+ var TransportPlaneSchema = _enum([
26336
+ "http",
26337
+ "ws",
26338
+ "mesh",
26339
+ "unknown"
26340
+ ]);
26341
+ /**
26342
+ * Calls per plane. Every key is always present, `0` included — an absent plane
26343
+ * reads as "not instrumented", which is the one thing this census must never
26344
+ * make an operator wonder about.
26345
+ */
26346
+ var TransportPlaneCountsSchema = object({
26347
+ http: number(),
26348
+ ws: number(),
26349
+ mesh: number(),
26350
+ unknown: number()
26351
+ });
26352
+ /**
26353
+ * One `(plane, procedure, user-agent, ip, principal)` tuple of the transport
26317
26354
  * census. `principal` is the DERIVED identity (`apocaliss92 (admin)`,
26318
26355
  * `scoped:1a2b3c4d (scoped-token)`, `anonymous`) that the tRPC error log
26319
26356
  * already prints - never a token, never an `Authorization` header.
26357
+ *
26358
+ * `subscriptions` is counted APART from `calls`: a subscription is opened once
26359
+ * and lives for hours, so folding it into a call count makes one long-lived
26360
+ * stream look like a storm.
26320
26361
  */
26321
26362
  var RequestCensusGroupSchema = object({
26363
+ plane: TransportPlaneSchema,
26322
26364
  procedure: string(),
26323
26365
  userAgent: string(),
26324
26366
  ip: string(),
26325
26367
  principal: string(),
26326
26368
  calls: number(),
26369
+ subscriptions: number(),
26327
26370
  perMin: number()
26328
26371
  });
26329
26372
  /**
@@ -26336,6 +26379,14 @@ var RequestCensusGroupSchema = object({
26336
26379
  var RequestCensusProcedureSchema = object({
26337
26380
  procedure: string(),
26338
26381
  calls: number(),
26382
+ /**
26383
+ * The same total, split by transport. THIS is the row that answers the
26384
+ * question the census exists for: one look at `deviceManager.listAll` says
26385
+ * which plane carried the 4 960, without joining two log lines by eye.
26386
+ */
26387
+ planes: TransportPlaneCountsSchema,
26388
+ /** Subscription STARTS on this procedure. Never folded into `calls`. */
26389
+ subscriptions: number(),
26339
26390
  perMin: number()
26340
26391
  });
26341
26392
  /**
@@ -26363,14 +26414,45 @@ var RequestCensusStatusSchema = object({
26363
26414
  */
26364
26415
  procedureCalls: number(),
26365
26416
  /**
26417
+ * `procedureCalls` split by transport. The four keys sum to
26418
+ * `procedureCalls` by construction - {@link RequestCensusSnapshotSchema}'s
26419
+ * `planesExplainTotal` is that identity, checked rather than assumed.
26420
+ */
26421
+ planes: TransportPlaneCountsSchema,
26422
+ /**
26423
+ * True iff `planes` sums to `procedureCalls`. False means a call was counted
26424
+ * on no plane at all - which is a RESULT (a plane is missing from the
26425
+ * instrument), not a failure, and it has to be visible to be read as one.
26426
+ */
26427
+ planesExplainTotal: boolean(),
26428
+ /**
26366
26429
  * tRPC WebSocket connections opened during the window. NOT calls - the WS
26367
- * transport resolves one context per connection - but the number that says
26368
- * whether a plane this census cannot see was busy while HTTP was quiet.
26430
+ * adapter resolves one context per connection - kept because a plane's call
26431
+ * count of zero against 37 open connections says something different from a
26432
+ * plane with no connections at all.
26369
26433
  */
26370
26434
  wsConnections: number(),
26435
+ /**
26436
+ * Client frames the WS plane looked at. `wsMessages` far above
26437
+ * `planes.ws + subscriptions` means most traffic is not operations
26438
+ * (keepalives, connection params) - which is itself an answer.
26439
+ */
26440
+ wsMessages: number(),
26441
+ /**
26442
+ * Subscription STARTS across every plane, excluded from `procedureCalls` on
26443
+ * purpose: one live-events stream opened at boot and held for six hours is
26444
+ * one subscription, and counting it as a call would let a quiet plane
26445
+ * masquerade as the storm.
26446
+ */
26447
+ subscriptions: number(),
26448
+ /** `subscription.stop` frames. Starts minus stops is what is still open. */
26449
+ subscriptionStops: number(),
26371
26450
  distinctGroups: number(),
26372
- /** Calls counted in the totals whose group attribution was shed at the
26373
- * cardinality bound. */
26451
+ /**
26452
+ * Operations counted in the totals whose CALLER attribution was shed at the
26453
+ * cardinality bound. Unrelated to the `unknown` PLANE: these calls know
26454
+ * which transport they arrived on, they just lost their group row.
26455
+ */
26374
26456
  unattributedCalls: number(),
26375
26457
  procedures: array(RequestCensusProcedureSchema).readonly(),
26376
26458
  groups: array(RequestCensusGroupSchema).readonly()
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@camstack/addon-provider-onvif",
3
- "version": "1.2.31",
3
+ "version": "1.2.32",
4
4
  "description": "ONVIF camera device provider addon for CamStack",
5
5
  "keywords": [
6
6
  "camstack",