@huddle01/observer-client-sdk - npm Package Compare versions

Comparing version 0.11.1-d6dde97.0 to 0.11.1-e596399.0

lib/index.d.ts

@@ -1,2 +0,2 @@
-export { ObserverClient, ObserverClientConfig, ObserverClientEventMap, } from './ObserverClient';
+export { ObserverDashboardClient, ObserverDashboardClientConfig, ObserverDashboardClientEventMap, } from './ObserverDashboardClient';
 export { WebSocketConnector, WebSocketConnectorConfig, WebSocketConnectorEventMap, WebSocketConnectorState, } from './WebSocketConnector';
@@ -6,3 +6,3 @@ export { CallEventReport, CallMetaReport, ClientDataChannelReport, ClientExtensionReport, IceCandidatePairReport, InboundAudioTrackReport, InboundVideoTrackReport, OutboundAudioTrackReport, OutboundVideoTrackReport, PeerConnectionTransportReport, } from './protocols/ReportTypes';
 export { DataFrame, DataFrameConfig, DataFrameEvents, } from './datastreams/DataFrame';
-export { ObserverAdminClient } from './ObserverAdminClient';
+export { ObserverDashboardAdminClient } from './ObserverDashboardAdminClient';
 export * as DashboardProtocol from './protocols/DashboardMessageProtocol';
@@ -9,0 +9,0 @@ export * as CallSnapshotSchema from './protocols/CallSnapshotSchema';

lib/index.js

@@ -26,5 +26,5 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CallSnapshotSchema = exports.DashboardProtocol = exports.ObserverAdminClient = exports.DataFrame = exports.WebSocketConnector = exports.ObserverClient = void 0;
-var ObserverClient_1 = require("./ObserverClient");
-Object.defineProperty(exports, "ObserverClient", { enumerable: true, get: function () { return ObserverClient_1.ObserverClient; } });
+exports.CallSnapshotSchema = exports.DashboardProtocol = exports.ObserverDashboardAdminClient = exports.DataFrame = exports.WebSocketConnector = exports.ObserverDashboardClient = void 0;
+var ObserverDashboardClient_1 = require("./ObserverDashboardClient");
+Object.defineProperty(exports, "ObserverDashboardClient", { enumerable: true, get: function () { return ObserverDashboardClient_1.ObserverDashboardClient; } });
 var WebSocketConnector_1 = require("./WebSocketConnector");
@@ -34,5 +34,5 @@ Object.defineProperty(exports, "WebSocketConnector", { enumerable: true, get: function () { return WebSocketConnector_1.WebSocketConnector; } });
 Object.defineProperty(exports, "DataFrame", { enumerable: true, get: function () { return DataFrame_1.DataFrame; } });
-var ObserverAdminClient_1 = require("./ObserverAdminClient");
-Object.defineProperty(exports, "ObserverAdminClient", { enumerable: true, get: function () { return ObserverAdminClient_1.ObserverAdminClient; } });
+var ObserverDashboardAdminClient_1 = require("./ObserverDashboardAdminClient");
+Object.defineProperty(exports, "ObserverDashboardAdminClient", { enumerable: true, get: function () { return ObserverDashboardAdminClient_1.ObserverDashboardAdminClient; } });
 exports.DashboardProtocol = __importStar(require("./protocols/DashboardMessageProtocol"));
 exports.CallSnapshotSchema = __importStar(require("./protocols/CallSnapshotSchema"));

lib/protocols/DashboardMessageProtocol.d.ts

@@ -48,8 +48,25 @@ import { CallSnapshot } from "./CallSnapshotSchema";
     uptimeInSec: number;
-    ongoingCallIds: string[];
-    ongoingJobIds: string[];
-    consumerGroupId: string;
-    maxParallelJobs: number;
-    jobRouterDescription: string;
-    consumers: string[];
+    observedCalls: {
+        callId: string;
+        clientIds: string[];
+    }[];
+    dataStreams: {
+        streamType: string;
+        streamId: string;
+        instanceType: 'dataCollector' | 'dataSource';
+        collectedBytes: number;
+    }[];
+    jobRouter: {
+        createdAt: number;
+        maxParallelJobs: number;
+        ongoingJobs: Record<string, unknown>[];
+        consumers: Record<string, unknown>[];
+        description?: string;
+    };
+    stats: {
+        consumedSamples: number;
+        numberOfClientSamplesCollector: number;
+        numberOfCallSnapshotsCollector: number;
+        numberOfClientSnapshotsCollector: number;
+    };
 };
@@ -64,2 +81,7 @@ export type ObserverServerState = {
     activeDashboardClientIds: string[];
+    stats: {
+        dashboardClientConnections: number;
+        observedClientConnections: number;
+        producedSamples: number;
+    };
 };
@@ -66,0 +88,0 @@ export type DashboardClientConnectionContext = {

package.json

 {
   "name": "@huddle01/observer-client-sdk",
-  "version": "0.11.1-d6dde97.0",
-  "description": "ObserverClient SDK",
+  "version": "0.11.1-e596399.0",
+  "description": "ObserverDashboardClient SDK",
   "main": "lib/index.js",
@@ -6,0 +6,0 @@ "types": "lib/index.d.ts",

README.md

@@ -22,5 +22,5 @@ Observer Client SDK
 ```javascript
-import { ObserverClient } from '@huddle01/observer-client-sdk';
+import { ObserverDashboardClient } from '@huddle01/observer-client-sdk';
 
-const observerClient = new ObserverClient({
+const dashboardClient = new ObserverClient({
 	// configuration options for connection
@@ -38,8 +38,8 @@ connection: {
 
-observerClient.connect();
+dashboardClient.connect();
 ```
 
-### ObserverClient
+### ObserverDashboardClient
 
-The `ObserverClient` API provides an interface for interacting with data streams and real-time data updates via WebSocket connections. This client enables users to access call data, ongoing call information, client snapshots, and other related data through the following methods and events:
+The `ObserverDashboardClient` API provides an interface for interacting with data streams and real-time data updates via WebSocket connections. This client enables users to access call data, ongoing call information, client snapshots, and other related data through the following methods and events:
 
@@ -50,3 +50,3 @@ #### Events
 #### Configuration
-- **ObserverClientConfig**: Configuration object used to initialize the `ObserverClient`.
+- **ObserverDashboardClientConfig**: Configuration object used to initialize the `ObserverDashboardClient`.
   - `connection`: Configuration for the WebSocket connection, using `WebSocketConnectorConfig`.
@@ -53,0 +53,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

174964

increased by1%

Lines of code

3612

increased by0.61%

No dependency changes