@crewdle/web-sdk-types 1.0.3 → 1.0.5

package/dist/core/cluster/ClusterEvents.d.ts

@@ -49,6 +49,10 @@ export interface IClusterEvents {
      * @param payload The node event payload.
      */
     'cluster-disconnect': (payload: INodeEventPayload) => void;
+    /**
+     * @event cluster-leave - Event fired when the current node leaves the cluster.
+     */
+    'cluster-leave': () => void;
     /**
      * @event local-media-stream-track-fail - Event fired when a local media stream track fails.
      * @param payload The local media stream track fail event payload.

package/dist/core/connection/PeerConnectionConnector.d.ts

@@ -2,7 +2,7 @@ import { MediaStreamPriority } from '../../media-stream';
 import { IPeerConnectionDataChannelConnector, IPeerConnectionDataChannelEvent, IPeerConnectionHandshakeCandidate, IPeerConnectionHandshakeCandidateEvent, IPeerConnectionOfferOptions, IPeerConnectionSender, IPeerConnectionSenderMap, IPeerConnectionSessionDescription, IPeerConnectionTrackEvent, PeerConnectionStatsReport } from '.';
 /**
  * The peer connection connector interface - used to establish a connection between two peers.
- * @category Core
+ * @category Connector
  */
 export interface IPeerConnectionConnector {
     /**

package/dist/core/connection/PeerConnectionDataChannelConnector.d.ts

@@ -1,6 +1,6 @@
 /**
  * The peer connection data channel connector interface.
- * @category Core
+ * @category Connector
  */
 export interface IPeerConnectionDataChannelConnector {
     /**

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

@@ -3,6 +3,10 @@
  * @category Core
  */
 export interface IAgentCredentials {
+    /**
+     * The agent ID.
+     */
+    id: string;
     /**
      * The agent group ID.
      */

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

@@ -1,7 +1,7 @@
 import { LoggingConnectorEvent } from '.';
 /**
  * The logging connector interface.
- * @category Core
+ * @category Connector
  */
 export interface ILoggingConnector {
     /**

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

@@ -6,6 +6,10 @@ import { IAuthUser, IUserCredentials } from '../node/user';
  * @category Core
  */
 export interface ISDK {
+    /**
+     * Close the SDK.
+     */
+    close(): Promise<void>;
     /**
      * Authenticate a user.
      * @param credentials The credentials to authenticate the user with.
@@ -14,7 +18,7 @@ export interface ISDK {
     authenticateUser(credentials: IUserCredentials): Promise<IAuthUser>;
     /**
      * Authenticate an agent.
-     * @param agentGroupId The ID of the agent group to authenticate the agent with.
+     * @param credentials The credentials to authenticate the agent with.
      * @returns A promise that resolves with the authenticated agent.
      */
     authenticateAgent(credentials: IAgentCredentials): Promise<IAuthAgent>;

package/dist/key-value-database/KeyValueDatabaseConnector.d.ts

@@ -1,7 +1,7 @@
 import { IValueType, IKeyValueDatabaseTableConnector } from '.';
 /**
  * The key-value database connector interface.
- * @category Key-Value Database
+ * @category Connector
  */
 export interface IKeyValueDatabaseConnector {
     /**

package/dist/key-value-database/KeyValueDatabaseTableConnector.d.ts

@@ -1,7 +1,7 @@
 import { IDatabaseTableQuery, IValueType, ValueTypeOmitId } from '.';
 /**
  * The key-value database table connector interface.
- * @category Key-Value Database
+ * @category Connector
  */
 export interface IKeyValueDatabaseTableConnector<T extends IValueType> {
     /**
@@ -13,12 +13,12 @@ export interface IKeyValueDatabaseTableConnector<T extends IValueType> {
     /**
      * Set the value for a key.
      * @param key The key to set the value for.
-     * @param value The value to set for the key. It must be a {@link SupportedIndexTypes}.
+     * @param value The value to set for the key. It must be a {@link SupportedIndexType}.
      */
     set(key: string, value: ValueTypeOmitId<T>): Promise<T>;
     /**
      * Add a value to the database.
-     * @param value  The value to add. It must be a {@link SupportedIndexTypes}.
+     * @param value  The value to add. It must be a {@link SupportedIndexType}.
      * @returns A promise that resolves with the value added.
      */
     add(value: ValueTypeOmitId<T>): Promise<T>;

package/dist/object-storage/ObjectStoreConnector.d.ts

@@ -1,7 +1,7 @@
 import { ObjectDescriptor, ObjectKind } from '.';
 /**
  * The object store connector interface.
- * @category Object Storage
+ * @category Connector
  */
 export interface IObjectStoreConnector {
     /**

package/package.json

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