@camstack/addon-decoder-nodeav 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/index.js CHANGED
@@ -26242,17 +26242,60 @@ var SetSiteLocationInputSchema = object({
26242
26242
  longitude: number().min(-180).max(180)
26243
26243
  }).nullable();
26244
26244
  /**
26245
- * One `(procedure, user-agent, ip, principal)` tuple of the HTTP request
26245
+ * The TRANSPORT a call arrived on.
26246
+ *
26247
+ * Every counted call carries exactly one of these, and `unknown` is a PLANE
26248
+ * rather than a gap: a plane that cannot attribute a call declares it here, so
26249
+ * the call lands in a named bucket instead of vanishing. `planes` summing to
26250
+ * `procedureCalls` is what makes "the sum of the planes explains the total"
26251
+ * checkable rather than asserted.
26252
+ *
26253
+ * - `http` — the Fastify tRPC plugin (`/trpc/*`), one context per request.
26254
+ * - `ws` — `applyWSSHandler`, counted per OPERATION rather than per
26255
+ * connection; the viewer talks to the hub over `wsLink`
26256
+ * exclusively, so this is the plane the HTTP census could not see.
26257
+ * - `mesh` — the in-process `$core-caps` bridge (`createCaller`), which
26258
+ * never touches a socket and therefore never touched a census.
26259
+ * - `unknown` — counted, plane undecidable. No hook produces it today, and
26260
+ * that is exactly what its `0` asserts: every plane the hub has can name
26261
+ * itself. It is an output bucket, never a knob — a call that arrives on a
26262
+ * plane nobody instrumented lands here instead of vanishing from the total.
26263
+ */
26264
+ var TransportPlaneSchema = _enum([
26265
+ "http",
26266
+ "ws",
26267
+ "mesh",
26268
+ "unknown"
26269
+ ]);
26270
+ /**
26271
+ * Calls per plane. Every key is always present, `0` included — an absent plane
26272
+ * reads as "not instrumented", which is the one thing this census must never
26273
+ * make an operator wonder about.
26274
+ */
26275
+ var TransportPlaneCountsSchema = object({
26276
+ http: number(),
26277
+ ws: number(),
26278
+ mesh: number(),
26279
+ unknown: number()
26280
+ });
26281
+ /**
26282
+ * One `(plane, procedure, user-agent, ip, principal)` tuple of the transport
26246
26283
  * census. `principal` is the DERIVED identity (`apocaliss92 (admin)`,
26247
26284
  * `scoped:1a2b3c4d (scoped-token)`, `anonymous`) that the tRPC error log
26248
26285
  * already prints - never a token, never an `Authorization` header.
26286
+ *
26287
+ * `subscriptions` is counted APART from `calls`: a subscription is opened once
26288
+ * and lives for hours, so folding it into a call count makes one long-lived
26289
+ * stream look like a storm.
26249
26290
  */
26250
26291
  var RequestCensusGroupSchema = object({
26292
+ plane: TransportPlaneSchema,
26251
26293
  procedure: string(),
26252
26294
  userAgent: string(),
26253
26295
  ip: string(),
26254
26296
  principal: string(),
26255
26297
  calls: number(),
26298
+ subscriptions: number(),
26256
26299
  perMin: number()
26257
26300
  });
26258
26301
  /**
@@ -26265,6 +26308,14 @@ var RequestCensusGroupSchema = object({
26265
26308
  var RequestCensusProcedureSchema = object({
26266
26309
  procedure: string(),
26267
26310
  calls: number(),
26311
+ /**
26312
+ * The same total, split by transport. THIS is the row that answers the
26313
+ * question the census exists for: one look at `deviceManager.listAll` says
26314
+ * which plane carried the 4 960, without joining two log lines by eye.
26315
+ */
26316
+ planes: TransportPlaneCountsSchema,
26317
+ /** Subscription STARTS on this procedure. Never folded into `calls`. */
26318
+ subscriptions: number(),
26268
26319
  perMin: number()
26269
26320
  });
26270
26321
  /**
@@ -26292,14 +26343,45 @@ var RequestCensusStatusSchema = object({
26292
26343
  */
26293
26344
  procedureCalls: number(),
26294
26345
  /**
26346
+ * `procedureCalls` split by transport. The four keys sum to
26347
+ * `procedureCalls` by construction - {@link RequestCensusSnapshotSchema}'s
26348
+ * `planesExplainTotal` is that identity, checked rather than assumed.
26349
+ */
26350
+ planes: TransportPlaneCountsSchema,
26351
+ /**
26352
+ * True iff `planes` sums to `procedureCalls`. False means a call was counted
26353
+ * on no plane at all - which is a RESULT (a plane is missing from the
26354
+ * instrument), not a failure, and it has to be visible to be read as one.
26355
+ */
26356
+ planesExplainTotal: boolean(),
26357
+ /**
26295
26358
  * tRPC WebSocket connections opened during the window. NOT calls - the WS
26296
- * transport resolves one context per connection - but the number that says
26297
- * whether a plane this census cannot see was busy while HTTP was quiet.
26359
+ * adapter resolves one context per connection - kept because a plane's call
26360
+ * count of zero against 37 open connections says something different from a
26361
+ * plane with no connections at all.
26298
26362
  */
26299
26363
  wsConnections: number(),
26364
+ /**
26365
+ * Client frames the WS plane looked at. `wsMessages` far above
26366
+ * `planes.ws + subscriptions` means most traffic is not operations
26367
+ * (keepalives, connection params) - which is itself an answer.
26368
+ */
26369
+ wsMessages: number(),
26370
+ /**
26371
+ * Subscription STARTS across every plane, excluded from `procedureCalls` on
26372
+ * purpose: one live-events stream opened at boot and held for six hours is
26373
+ * one subscription, and counting it as a call would let a quiet plane
26374
+ * masquerade as the storm.
26375
+ */
26376
+ subscriptions: number(),
26377
+ /** `subscription.stop` frames. Starts minus stops is what is still open. */
26378
+ subscriptionStops: number(),
26300
26379
  distinctGroups: number(),
26301
- /** Calls counted in the totals whose group attribution was shed at the
26302
- * cardinality bound. */
26380
+ /**
26381
+ * Operations counted in the totals whose CALLER attribution was shed at the
26382
+ * cardinality bound. Unrelated to the `unknown` PLANE: these calls know
26383
+ * which transport they arrived on, they just lost their group row.
26384
+ */
26303
26385
  unattributedCalls: number(),
26304
26386
  procedures: array(RequestCensusProcedureSchema).readonly(),
26305
26387
  groups: array(RequestCensusGroupSchema).readonly()
package/dist/index.mjs CHANGED
@@ -26238,17 +26238,60 @@ var SetSiteLocationInputSchema = object({
26238
26238
  longitude: number().min(-180).max(180)
26239
26239
  }).nullable();
26240
26240
  /**
26241
- * One `(procedure, user-agent, ip, principal)` tuple of the HTTP request
26241
+ * The TRANSPORT a call arrived on.
26242
+ *
26243
+ * Every counted call carries exactly one of these, and `unknown` is a PLANE
26244
+ * rather than a gap: a plane that cannot attribute a call declares it here, so
26245
+ * the call lands in a named bucket instead of vanishing. `planes` summing to
26246
+ * `procedureCalls` is what makes "the sum of the planes explains the total"
26247
+ * checkable rather than asserted.
26248
+ *
26249
+ * - `http` — the Fastify tRPC plugin (`/trpc/*`), one context per request.
26250
+ * - `ws` — `applyWSSHandler`, counted per OPERATION rather than per
26251
+ * connection; the viewer talks to the hub over `wsLink`
26252
+ * exclusively, so this is the plane the HTTP census could not see.
26253
+ * - `mesh` — the in-process `$core-caps` bridge (`createCaller`), which
26254
+ * never touches a socket and therefore never touched a census.
26255
+ * - `unknown` — counted, plane undecidable. No hook produces it today, and
26256
+ * that is exactly what its `0` asserts: every plane the hub has can name
26257
+ * itself. It is an output bucket, never a knob — a call that arrives on a
26258
+ * plane nobody instrumented lands here instead of vanishing from the total.
26259
+ */
26260
+ var TransportPlaneSchema = _enum([
26261
+ "http",
26262
+ "ws",
26263
+ "mesh",
26264
+ "unknown"
26265
+ ]);
26266
+ /**
26267
+ * Calls per plane. Every key is always present, `0` included — an absent plane
26268
+ * reads as "not instrumented", which is the one thing this census must never
26269
+ * make an operator wonder about.
26270
+ */
26271
+ var TransportPlaneCountsSchema = object({
26272
+ http: number(),
26273
+ ws: number(),
26274
+ mesh: number(),
26275
+ unknown: number()
26276
+ });
26277
+ /**
26278
+ * One `(plane, procedure, user-agent, ip, principal)` tuple of the transport
26242
26279
  * census. `principal` is the DERIVED identity (`apocaliss92 (admin)`,
26243
26280
  * `scoped:1a2b3c4d (scoped-token)`, `anonymous`) that the tRPC error log
26244
26281
  * already prints - never a token, never an `Authorization` header.
26282
+ *
26283
+ * `subscriptions` is counted APART from `calls`: a subscription is opened once
26284
+ * and lives for hours, so folding it into a call count makes one long-lived
26285
+ * stream look like a storm.
26245
26286
  */
26246
26287
  var RequestCensusGroupSchema = object({
26288
+ plane: TransportPlaneSchema,
26247
26289
  procedure: string(),
26248
26290
  userAgent: string(),
26249
26291
  ip: string(),
26250
26292
  principal: string(),
26251
26293
  calls: number(),
26294
+ subscriptions: number(),
26252
26295
  perMin: number()
26253
26296
  });
26254
26297
  /**
@@ -26261,6 +26304,14 @@ var RequestCensusGroupSchema = object({
26261
26304
  var RequestCensusProcedureSchema = object({
26262
26305
  procedure: string(),
26263
26306
  calls: number(),
26307
+ /**
26308
+ * The same total, split by transport. THIS is the row that answers the
26309
+ * question the census exists for: one look at `deviceManager.listAll` says
26310
+ * which plane carried the 4 960, without joining two log lines by eye.
26311
+ */
26312
+ planes: TransportPlaneCountsSchema,
26313
+ /** Subscription STARTS on this procedure. Never folded into `calls`. */
26314
+ subscriptions: number(),
26264
26315
  perMin: number()
26265
26316
  });
26266
26317
  /**
@@ -26288,14 +26339,45 @@ var RequestCensusStatusSchema = object({
26288
26339
  */
26289
26340
  procedureCalls: number(),
26290
26341
  /**
26342
+ * `procedureCalls` split by transport. The four keys sum to
26343
+ * `procedureCalls` by construction - {@link RequestCensusSnapshotSchema}'s
26344
+ * `planesExplainTotal` is that identity, checked rather than assumed.
26345
+ */
26346
+ planes: TransportPlaneCountsSchema,
26347
+ /**
26348
+ * True iff `planes` sums to `procedureCalls`. False means a call was counted
26349
+ * on no plane at all - which is a RESULT (a plane is missing from the
26350
+ * instrument), not a failure, and it has to be visible to be read as one.
26351
+ */
26352
+ planesExplainTotal: boolean(),
26353
+ /**
26291
26354
  * tRPC WebSocket connections opened during the window. NOT calls - the WS
26292
- * transport resolves one context per connection - but the number that says
26293
- * whether a plane this census cannot see was busy while HTTP was quiet.
26355
+ * adapter resolves one context per connection - kept because a plane's call
26356
+ * count of zero against 37 open connections says something different from a
26357
+ * plane with no connections at all.
26294
26358
  */
26295
26359
  wsConnections: number(),
26360
+ /**
26361
+ * Client frames the WS plane looked at. `wsMessages` far above
26362
+ * `planes.ws + subscriptions` means most traffic is not operations
26363
+ * (keepalives, connection params) - which is itself an answer.
26364
+ */
26365
+ wsMessages: number(),
26366
+ /**
26367
+ * Subscription STARTS across every plane, excluded from `procedureCalls` on
26368
+ * purpose: one live-events stream opened at boot and held for six hours is
26369
+ * one subscription, and counting it as a call would let a quiet plane
26370
+ * masquerade as the storm.
26371
+ */
26372
+ subscriptions: number(),
26373
+ /** `subscription.stop` frames. Starts minus stops is what is still open. */
26374
+ subscriptionStops: number(),
26296
26375
  distinctGroups: number(),
26297
- /** Calls counted in the totals whose group attribution was shed at the
26298
- * cardinality bound. */
26376
+ /**
26377
+ * Operations counted in the totals whose CALLER attribution was shed at the
26378
+ * cardinality bound. Unrelated to the `unknown` PLANE: these calls know
26379
+ * which transport they arrived on, they just lost their group row.
26380
+ */
26299
26381
  unattributedCalls: number(),
26300
26382
  procedures: array(RequestCensusProcedureSchema).readonly(),
26301
26383
  groups: array(RequestCensusGroupSchema).readonly()
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@camstack/addon-decoder-nodeav",
3
- "version": "1.2.31",
3
+ "version": "1.2.32",
4
4
  "description": "Standalone in-process node-av decoder addon for CamStack",
5
5
  "keywords": [
6
6
  "camstack",