@deadair/sdk 0.87.0 → 0.87.1

package/dist/stream/stream.client.d.ts

@@ -1,4 +1,5 @@
 import type { SdkFetch } from '../sdk-options.js';
+import type { StreamListeners } from './types/stream.listeners.types.js';
 import type { FetcherAuthorization, FetcherAuthorizationFinished, FetcherAuthorizationInput, FetcherAuthorizationStart } from './types/stream.types.js';
 import { StreamArchiveClient } from './stream.archive.client.js';
 export declare class StreamClient {
@@ -40,5 +41,10 @@ export declare class StreamClient {
      * @description Finishes an authorization from the address the operator's browser ended up at
      */
     finishFetcherAuthorization(body: FetcherAuthorizationInput): Promise<FetcherAuthorizationFinished>;
+    /**
+     * @name List stream listeners
+     * @description Who is connected to the station's stream right now, over Icecast and over HLS
+     */
+    listStreamListeners(): Promise<StreamListeners>;
 }
 //# sourceMappingURL=stream.client.d.ts.map

package/dist/stream/stream.client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"stream.client.d.ts","sourceRoot":"","sources":["../../src/stream/stream.client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAElD,OAAO,KAAK,EACR,oBAAoB,EACpB,4BAA4B,EAC5B,yBAAyB,EACzB,yBAAyB,EAC5B,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AAEjE,qBAAa,YAAY;IAGT,OAAO,CAAC,KAAK;IAFzB,QAAQ,CAAC,OAAO,EAAE,mBAAmB,CAAC;gBAElB,KAAK,EAAE,QAAQ;IAInC;;;OAGG;IACG,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,IAAI,EAAE,IAAI,CAAC;QAAC,OAAO,EAAE;YAAE,YAAY,CAAC,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE,CAAC;IAM/F;;;OAGG;IACG,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;IAKnC;;;OAGG;IACG,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;IAKnC;;;OAGG;IACG,wBAAwB,IAAI,OAAO,CAAC,oBAAoB,CAAC;IAK/D;;;OAGG;IACG,yBAAyB,IAAI,OAAO,CAAC,yBAAyB,CAAC;IAKrE;;;OAGG;IACG,0BAA0B,CAAC,IAAI,EAAE,yBAAyB,GAAG,OAAO,CAAC,4BAA4B,CAAC;CAQ3G"}
+{"version":3,"file":"stream.client.d.ts","sourceRoot":"","sources":["../../src/stream/stream.client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAElD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mCAAmC,CAAC;AAEzE,OAAO,KAAK,EACR,oBAAoB,EACpB,4BAA4B,EAC5B,yBAAyB,EACzB,yBAAyB,EAC5B,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AAEjE,qBAAa,YAAY;IAGT,OAAO,CAAC,KAAK;IAFzB,QAAQ,CAAC,OAAO,EAAE,mBAAmB,CAAC;gBAElB,KAAK,EAAE,QAAQ;IAInC;;;OAGG;IACG,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,IAAI,EAAE,IAAI,CAAC;QAAC,OAAO,EAAE;YAAE,YAAY,CAAC,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE,CAAC;IAM/F;;;OAGG;IACG,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;IAKnC;;;OAGG;IACG,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;IAKnC;;;OAGG;IACG,wBAAwB,IAAI,OAAO,CAAC,oBAAoB,CAAC;IAK/D;;;OAGG;IACG,yBAAyB,IAAI,OAAO,CAAC,yBAAyB,CAAC;IAKrE;;;OAGG;IACG,0BAA0B,CAAC,IAAI,EAAE,yBAAyB,GAAG,OAAO,CAAC,4BAA4B,CAAC;IASxG;;;OAGG;IACG,mBAAmB,IAAI,OAAO,CAAC,eAAe,CAAC;CAIxD"}

package/dist/stream/types/index.d.ts

@@ -1,3 +1,4 @@
 export * from './stream.archive.types.js';
+export * from './stream.listeners.types.js';
 export * from './stream.types.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/stream/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/stream/types/index.ts"],"names":[],"mappings":"AACA,cAAc,2BAA2B,CAAC;AAC1C,cAAc,mBAAmB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/stream/types/index.ts"],"names":[],"mappings":"AACA,cAAc,2BAA2B,CAAC;AAC1C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,mBAAmB,CAAC"}

package/dist/stream/types/stream.listeners.types.d.ts

@@ -0,0 +1,43 @@
+import { DateTime } from 'luxon';
+/**
+ * One connection to the station's stream, as it stands at the moment of reading
+ * generated from [ListenerConnection](../../../../../apps/api/data/contracts/stream/stream.listeners.types.ck)
+ */
+export interface ListenerConnection {
+    /** `icecast` is a player holding a connection open on a mount. `hls` is a player re-fetching a playlist, counted while it keeps asking */
+    via: 'icecast' | 'hls';
+    /** The Icecast mount it is on, such as `/live.mp3`. Absent over HLS, whose players are counted across every playlist together */
+    mount?: string;
+    /** The address the station recorded. A listener's own only where the edge in front of the station is trusted to say so; behind a tunnel without `REAL_IP_FROM` it is the tunnel's */
+    address: string;
+    /** What the player said it was, cut to 512 characters. Absent when it sent nothing */
+    agent?: string;
+    /** How long it has been connected, to the second. Over HLS, since the first playlist fetch of this stretch of listening */
+    connectedMs: number;
+}
+/**
+ * An Icecast mount whose connections could not be read, so its listeners are missing from the list
+ * generated from [UnreadableMount](../../../../../apps/api/data/contracts/stream/stream.listeners.types.ck)
+ */
+export interface UnreadableMount {
+    mount: string;
+    /** `unresolved`: the station has not yet found an Icecast 2.5 it can ask. `refused`: Icecast answered 401 or 403. `unanswered`: a timeout, a failed connection, or a reply that was not a client list */
+    reason: 'unresolved' | 'refused' | 'unanswered';
+}
+/**
+ * Who is connected to the station's stream right now. Read on request and never stored
+ * generated from [StreamListeners](../../../../../apps/api/data/contracts/stream/stream.listeners.types.ck)
+ */
+export interface StreamListeners {
+    /** When this was read */
+    readAt: DateTime;
+    /** The audience count the station is acting on, the same figure as the console's tally. It can differ from the number of connections: it is kept by a separate reading, and one HLS entry can stand for two players with the same address and agent */
+    total: number;
+    /** Every connection that could be read, Icecast mounts first in the station's mount order, then HLS, each longest-connected first */
+    connections: ListenerConnection[];
+    /** The mounts that could not be read. Empty when every one was. A mount listed here is not an empty mount */
+    unreadable: UnreadableMount[];
+}
+/** Rehydrates every wire-encoded scalar in a StreamListeners into its runtime type. Mutates and returns `raw`. */
+export declare function reviveStreamListeners(raw: StreamListeners): StreamListeners;
+//# sourceMappingURL=stream.listeners.types.d.ts.map

package/dist/stream/types/stream.listeners.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stream.listeners.types.d.ts","sourceRoot":"","sources":["../../../src/stream/types/stream.listeners.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAUjC;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IAC/B,0IAA0I;IAC1I,GAAG,EAAE,SAAS,GAAG,KAAK,CAAC;IACvB,iIAAiI;IACjI,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,qLAAqL;IACrL,OAAO,EAAE,MAAM,CAAC;IAChB,sFAAsF;IACtF,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,2HAA2H;IAC3H,WAAW,EAAE,MAAM,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,yMAAyM;IACzM,MAAM,EAAE,YAAY,GAAG,SAAS,GAAG,YAAY,CAAC;CACnD;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC5B,yBAAyB;IACzB,MAAM,EAAE,QAAQ,CAAC;IACjB,uPAAuP;IACvP,KAAK,EAAE,MAAM,CAAC;IACd,qIAAqI;IACrI,WAAW,EAAE,kBAAkB,EAAE,CAAC;IAClC,6GAA6G;IAC7G,UAAU,EAAE,eAAe,EAAE,CAAC;CACjC;AAED,kHAAkH;AAClH,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,eAAe,GAAG,eAAe,CAI3E"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@deadair/sdk",
-  "version": "0.87.0",
+  "version": "0.87.1",
   "description": "A typed client for the deadair station's HTTP API, generated from the same contracts the station serves.",
   "keywords": [
     "deadair",