mediasfu-angular 1.0.0 → 1.0.2

package/dist/lib/sockets/socket-manager.service.d.ts

@@ -16,6 +16,46 @@ export interface DisconnectSocketOptions {
 }
 export type ConnectSocketType = (options: ConnectSocketOptions) => Promise<Socket>;
 export type DisconnectSocketType = (options: DisconnectSocketOptions) => Promise<boolean>;
+/**
+ * Manages connections to a media socket, allowing users to connect or disconnect based on API credentials.
+ *
+ * @class
+ * @name SocketManager
+ * @description Provides methods to connect and disconnect from a media socket using a provided API key or token.
+ *
+ * @method
+ * validateApiKeyToken - Validates the API key or token for correct format.
+ * connectSocket - Establishes a connection to the media socket using either the API key or token.
+ * disconnectSocket - Disconnects an active socket connection.
+ *
+ * @example
+ * ```typescript
+ * const socketManager = new SocketManager();
+ *
+ * // Example of connecting to the socket
+ * const socketConnection = await socketManager.connectSocket({
+ *   apiUserName: 'user123',
+ *   apiKey: 'validApiKeyOf64Characters',
+ *   link: 'https://socketserver.example.com'
+ * });
+ *
+ * // Example of disconnecting the socket
+ * const isDisconnected = await socketManager.disconnectSocket({
+ *   socket: socketConnection
+ * });
+ * ```
+ *
+ * @typedef {Object} ConnectSocketOptions
+ * @property {string} apiUserName - Username for the API.
+ * @property {string} [apiKey] - The API key for authentication.
+ * @property {string} [apiToken] - The API token for authentication.
+ * @property {string} link - The socket server link.
+ *
+ * @typedef {Object} DisconnectSocketOptions
+ * @property {Socket} socket - The socket instance to disconnect.
+ *
+ * @returns {Promise<Socket | boolean>} The active socket instance on connection, or a boolean indicating disconnection success.
+ */
 export declare class SocketManager {
     private socket;
     validateApiKeyToken(value: string): Promise<boolean>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mediasfu-angular",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "author": "MediaSFU",
   "license": "MIT",
   "description": "MediaSFU Prebuilt Angular SDK",
@@ -84,6 +84,15 @@
     "cloud recording",
     "meeting",
     "conference",
-    "web"
+    "web",
+    "mediasfu-angular",
+    "angular sdk",
+    "mediasfu angular",
+    "mediasfu angular sdk",
+    "mediasfu angular component",
+    "angular-sdk",
+    "mediasfu-angular",
+    "mediasfu-angular-sdk",
+    "mediasfu-angular-component"
   ]
 }