@crewdle/web-sdk-types 1.0.8 → 1.0.10

package/dist/core/node/agent/AgentCapacity.d.ts

@@ -1,19 +1,65 @@
+/**
+ * The agent capacity interface used for reporting the agent's capacity.
+ */
 export interface IAgentCapacity {
+    /**
+     * The agent version.
+     */
+    version: string;
+    /**
+     * The agent's MAC address.
+     */
     macAddress: string;
+    /**
+     * The agent's CPU capacity.
+     */
     cpu: {
+        /**
+         * The number of CPU cores.
+         */
         cores: number;
+        /**
+         * The current CPU load.
+         */
         load: number;
     };
+    /**
+     * The agent's GPU capacity.
+     */
     gpu: {
+        /**
+         * The number of GPU cores.
+         */
         cores: number;
+        /**
+         * The current GPU load.
+         */
         load: number;
     };
+    /**
+     * The agent's memory capacity.
+     */
     memory: {
+        /**
+         * The total memory available.
+         */
         total: number;
+        /**
+         * The available memory.
+         */
         available: number;
     };
+    /**
+     * The agent's storage capacity.
+     */
     storage: {
+        /**
+         * The total storage available.
+         */
         total: number;
+        /**
+         * The available storage.
+         */
         available: number;
     };
 }

package/dist/core/node/agent/AuthAgent.d.ts

@@ -1,4 +1,6 @@
+import { IAgentCapacity } from '.';
 import { IAuthNode, NodeType } from '..';
+import { Unsubscribe } from '../..';
 /**
  * The authenticated agent interface.
  * @category Core
@@ -8,4 +10,16 @@ export interface IAuthAgent extends IAuthNode {
      * The type of the node.
      */
     type: NodeType.Agent;
+    /**
+     * Subscribe to when the agent configuration changes.
+     * @param callback The callback to invoke when the agent configuration changes.
+     * @returns The unsubscribe function.
+     */
+    onConfigurationChange(callback: () => Promise<void>): Unsubscribe;
+    /**
+     * Set the report capacity callback.
+     * @param reportCapacity The report capacity callback.
+     * @returns The unsubscribe function.
+     */
+    setReportCapacity(reportCapacity: () => Promise<IAgentCapacity>): Unsubscribe;
 }

package/dist/core/sdk/SDK.d.ts

@@ -1,5 +1,5 @@
 import { ICluster } from '../cluster';
-import { IAgentCredentials, IAuthAgent, IAgentCapacity } from '../node/agent';
+import { IAgentCredentials, IAuthAgent } from '../node/agent';
 import { IAuthUser, IUserCredentials } from '../node/user';
 /**
  * The SDK interface.
@@ -19,10 +19,9 @@ export interface ISDK {
     /**
      * Authenticate an agent.
      * @param credentials The credentials to authenticate the agent with.
-     * @param reportCapacity A callback to report the agent capacity.
      * @returns A promise that resolves with the authenticated agent.
      */
-    authenticateAgent(credentials: IAgentCredentials, reportCapacity?: () => Promise<IAgentCapacity>): Promise<IAuthAgent>;
+    authenticateAgent(credentials: IAgentCredentials): Promise<IAuthAgent>;
     /**
      * Join a cluster.
      * @param clusterId The ID of the cluster to join.

package/dist/core/sdk/Unsubscribe.d.ts

@@ -0,0 +1,5 @@
+/**
+ * The unsubscribe callback.
+ * @category Core
+ */
+export type Unsubscribe = () => void;

package/dist/core/sdk/Unsubscribe.js

@@ -0,0 +1 @@
+export {};

package/dist/core/sdk/index.d.ts

@@ -2,3 +2,4 @@ export { ILoggingConnector } from './LoggingConnector';
 export { LoggingConnectorEvent } from './LoggingConnectorEvent';
 export { ISDK } from './SDK';
 export { ISDKOptions } from './SDKOptions';
+export { Unsubscribe } from './Unsubscribe';

package/dist/media-stream/RemoteMediaStream.d.ts

@@ -1,9 +1,5 @@
+import { Unsubscribe } from '../core';
 import { IMediaStream, MediaTrackKind, MediaSubscriptionParams } from '.';
-/**
- * The unsubscribe callback.
- * @category Media Stream
- */
-export type Unsubscribe = () => void;
 /**
  * The remote media stream interface.
  * @category Media Stream
@@ -36,5 +32,5 @@ export interface IRemoteMediaStream extends IMediaStream {
      * Subscribe to when the provider of the stream changes.
      * @param callback The callback to invoke when the provider changes.
      */
-    onProviderChanged(callback: (providerId: string | undefined) => void): Unsubscribe;
+    onProviderChange(callback: (providerId: string | undefined) => void): Unsubscribe;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crewdle/web-sdk-types",
-  "version": "1.0.8",
+  "version": "1.0.10",
   "description": "The Crewdle Mist Web SDK public types and interfaces",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",