@rtsee/core 0.0.93 → 0.0.94

package/dist/interfaces/Peer.d.ts

@@ -13,5 +13,11 @@ export interface IPeer<T = any> extends IPeerInfo<T> {
     isAnonymous?: boolean;
     language?: RTSeeLanguage;
 }
+/**
+ * Checks whether the peer has the given permission.
+ * @param peer - Peer with optional permissions array
+ * @param permission - Permission to check
+ * @returns True if peer has the permission
+ */
 export declare function hasPermission(peer: IPeer, permission: RTSeePeerPermissions): boolean;
 //# sourceMappingURL=Peer.d.ts.map

package/dist/interfaces/Peer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Peer.d.ts","sourceRoot":"","sources":["../../src/interfaces/Peer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAElE,MAAM,WAAW,SAAS,CAAC,CAAC,GAAG,GAAG;IAChC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,CAAC,CAAC;CACV;AAED,MAAM,WAAW,KAAK,CAAC,CAAC,GAAG,GAAG,CAAE,SAAQ,SAAS,CAAC,CAAC,CAAC;IAClD,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,oBAAoB,EAAE,CAAC;IACrC,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,QAAQ,CAAC,EAAE,aAAa,CAAC;CAC1B;AAED,wBAAgB,aAAa,CAC3B,IAAI,EAAE,KAAK,EACX,UAAU,EAAE,oBAAoB,GAC/B,OAAO,CAGT"}
+{"version":3,"file":"Peer.d.ts","sourceRoot":"","sources":["../../src/interfaces/Peer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAElE,MAAM,WAAW,SAAS,CAAC,CAAC,GAAG,GAAG;IAChC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,CAAC,CAAC;CACV;AAED,MAAM,WAAW,KAAK,CAAC,CAAC,GAAG,GAAG,CAAE,SAAQ,SAAS,CAAC,CAAC,CAAC;IAClD,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,oBAAoB,EAAE,CAAC;IACrC,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,QAAQ,CAAC,EAAE,aAAa,CAAC;CAC1B;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAC3B,IAAI,EAAE,KAAK,EACX,UAAU,EAAE,oBAAoB,GAC/B,OAAO,CAGT"}

package/dist/interfaces/Peer.js

@@ -1,6 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.hasPermission = hasPermission;
+/**
+ * Checks whether the peer has the given permission.
+ * @param peer - Peer with optional permissions array
+ * @param permission - Permission to check
+ * @returns True if peer has the permission
+ */
 function hasPermission(peer, permission) {
     if (!permission) {
         return false;

package/dist/interfaces/Peer.js.map

@@ -1 +1 @@
-{"version":3,"file":"Peer.js","sourceRoot":"","sources":["../../src/interfaces/Peer.ts"],"names":[],"mappings":";;AAkBA,sCAMC;AAND,SAAgB,aAAa,CAC3B,IAAW,EACX,UAAgC;IAEhC,IAAI,CAAC,UAAU,EAAE,CAAC;QAAC,OAAO,KAAK,CAAC;IAAC,CAAC;IAClC,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,UAAC,CAAC,IAAK,OAAA,CAAC,KAAK,UAAU,EAAhB,CAAgB,CAAC,CAAC;AACxD,CAAC"}
+{"version":3,"file":"Peer.js","sourceRoot":"","sources":["../../src/interfaces/Peer.ts"],"names":[],"mappings":";;AAwBA,sCAMC;AAZD;;;;;GAKG;AACH,SAAgB,aAAa,CAC3B,IAAW,EACX,UAAgC;IAEhC,IAAI,CAAC,UAAU,EAAE,CAAC;QAAC,OAAO,KAAK,CAAC;IAAC,CAAC;IAClC,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,UAAC,CAAC,IAAK,OAAA,CAAC,KAAK,UAAU,EAAhB,CAAgB,CAAC,CAAC;AACxD,CAAC"}

package/dist/interfaces/RTSeeClientSocketConnection.d.ts

@@ -1,5 +1,12 @@
 import { IPeer, WSMessageInterface } from "@rtsee/core";
+/**
+ * Client socket connection interface: emit messages and access peer promise.
+ */
 export interface IRTSeeClientSocketConnection {
+    /**
+     * Sends a message (event name and optional data) over the connection.
+     * @param options - Message name and optional data
+     */
     emitMessage(options: WSMessageInterface): void;
     myPeerPromise?: Promise<IPeer>;
 }

package/dist/interfaces/RTSeeClientSocketConnection.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RTSeeClientSocketConnection.d.ts","sourceRoot":"","sources":["../../src/interfaces/RTSeeClientSocketConnection.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAExD,MAAM,WAAW,4BAA4B;IAC3C,WAAW,CAAC,OAAO,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAC/C,aAAa,CAAC,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;CAChC"}
+{"version":3,"file":"RTSeeClientSocketConnection.d.ts","sourceRoot":"","sources":["../../src/interfaces/RTSeeClientSocketConnection.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAExD;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;;OAGG;IACH,WAAW,CAAC,OAAO,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAC/C,aAAa,CAAC,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;CAChC"}

package/dist/interfaces/RTSeeSignalingClientBase.d.ts

@@ -1,5 +1,8 @@
 import EventEmitter from "events";
 import { IPeer, IRTSeeClientSocketConnection, IRTSeeElements, WSMessageInterface } from "@rtsee/core";
+/**
+ * Base interface for RTSEE signaling clients: connection, peer access, connect and emitEvent.
+ */
 export interface IRTSeeSignalingClientBase extends EventEmitter {
     getMyPeer: () => IPeer | null;
     getMyPeerId: () => string | null;

package/dist/interfaces/RTSeeSignalingClientBase.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RTSeeSignalingClientBase.d.ts","sourceRoot":"","sources":["../../src/interfaces/RTSeeSignalingClientBase.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,QAAQ,CAAC;AAClC,OAAO,EACL,KAAK,EACL,4BAA4B,EAC5B,cAAc,EACd,kBAAkB,EACnB,MAAM,aAAa,CAAC;AAErB,MAAM,WAAW,yBAA0B,SAAQ,YAAY;IAC7D,SAAS,EAAE,MAAM,KAAK,GAAG,IAAI,CAAC;IAC9B,WAAW,EAAE,MAAM,MAAM,GAAG,IAAI,CAAC;IACjC,OAAO,EAAE,CAAC,OAAO,EAAE,cAAc,KAAK,IAAI,CAAC;IAC3C,aAAa,CAAC,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;IAC/B,oBAAoB,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,GAAG,WAAW,CAAC,KAAK,CAAC,KAAK,IAAI,CAAC;IACnE,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,kBAAkB,KAAK,IAAI,CAAC;IAClD,UAAU,EAAE,4BAA4B,CAAC;CAC1C"}
+{"version":3,"file":"RTSeeSignalingClientBase.d.ts","sourceRoot":"","sources":["../../src/interfaces/RTSeeSignalingClientBase.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,QAAQ,CAAC;AAClC,OAAO,EACL,KAAK,EACL,4BAA4B,EAC5B,cAAc,EACd,kBAAkB,EACnB,MAAM,aAAa,CAAC;AAErB;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,YAAY;IAC7D,SAAS,EAAE,MAAM,KAAK,GAAG,IAAI,CAAC;IAC9B,WAAW,EAAE,MAAM,MAAM,GAAG,IAAI,CAAC;IACjC,OAAO,EAAE,CAAC,OAAO,EAAE,cAAc,KAAK,IAAI,CAAC;IAC3C,aAAa,CAAC,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;IAC/B,oBAAoB,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,GAAG,WAAW,CAAC,KAAK,CAAC,KAAK,IAAI,CAAC;IACnE,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,kBAAkB,KAAK,IAAI,CAAC;IAClD,UAAU,EAAE,4BAA4B,CAAC;CAC1C"}

package/dist/interfaces/RTSeeTransport.d.ts

@@ -1,7 +1,17 @@
 import { IPeer, IRTSeeChatPeers, ISocketPeer } from "@rtsee/core";
+/**
+ * Transport object carrying peer and optional peers list for signaling/live storage.
+ */
 export interface IRTSeeTransport {
     peer: IPeer;
     peers?: IRTSeeChatPeers;
 }
+/**
+ * Converts a socket peer to a transport object for use in handlers and storage.
+ * @param socketPeer - Socket peer with rtseePeer set
+ * @param peers - Optional chat peers to attach
+ * @returns Transport with peer (and optional peers)
+ * @throws Error if socketPeer or socketPeer.rtseePeer is missing
+ */
 export declare function socketPeerToTransport(socketPeer: ISocketPeer, peers?: IRTSeeChatPeers): IRTSeeTransport;
 //# sourceMappingURL=RTSeeTransport.d.ts.map

package/dist/interfaces/RTSeeTransport.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RTSeeTransport.d.ts","sourceRoot":"","sources":["../../src/interfaces/RTSeeTransport.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,KAAK,EAAE,eAAe,EAAE,WAAW,EAAC,MAAM,aAAa,CAAC;AAEhE,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,KAAK,CAAC;IACZ,KAAK,CAAC,EAAE,eAAe,CAAC;CACzB;AAED,wBAAgB,qBAAqB,CACnC,UAAU,EAAE,WAAW,EACvB,KAAK,CAAC,EAAE,eAAe,GACtB,eAAe,CAGjB"}
+{"version":3,"file":"RTSeeTransport.d.ts","sourceRoot":"","sources":["../../src/interfaces/RTSeeTransport.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,KAAK,EAAE,eAAe,EAAE,WAAW,EAAC,MAAM,aAAa,CAAC;AAEhE;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,KAAK,CAAC;IACZ,KAAK,CAAC,EAAE,eAAe,CAAC;CACzB;AAED;;;;;;GAMG;AACH,wBAAgB,qBAAqB,CACnC,UAAU,EAAE,WAAW,EACvB,KAAK,CAAC,EAAE,eAAe,GACtB,eAAe,CAGjB"}

package/dist/interfaces/RTSeeTransport.js

@@ -1,6 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.socketPeerToTransport = socketPeerToTransport;
+/**
+ * Converts a socket peer to a transport object for use in handlers and storage.
+ * @param socketPeer - Socket peer with rtseePeer set
+ * @param peers - Optional chat peers to attach
+ * @returns Transport with peer (and optional peers)
+ * @throws Error if socketPeer or socketPeer.rtseePeer is missing
+ */
 function socketPeerToTransport(socketPeer, peers) {
     if (!socketPeer || !socketPeer.rtseePeer) {
         throw new Error("No peer!");

package/dist/interfaces/RTSeeTransport.js.map

@@ -1 +1 @@
-{"version":3,"file":"RTSeeTransport.js","sourceRoot":"","sources":["../../src/interfaces/RTSeeTransport.ts"],"names":[],"mappings":";;AAOA,sDAMC;AAND,SAAgB,qBAAqB,CACnC,UAAuB,EACvB,KAAuB;IAEvB,IAAI,CAAC,UAAU,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE,CAAC;QAAC,MAAM,IAAI,KAAK,CAAC,UAAU,CAAC,CAAC;IAAC,CAAC;IAC1E,OAAO,EAAE,IAAI,EAAE,UAAU,CAAC,SAAS,EAAE,KAAK,OAAA,EAAE,CAAC;AAC/C,CAAC"}
+{"version":3,"file":"RTSeeTransport.js","sourceRoot":"","sources":["../../src/interfaces/RTSeeTransport.ts"],"names":[],"mappings":";;AAiBA,sDAMC;AAbD;;;;;;GAMG;AACH,SAAgB,qBAAqB,CACnC,UAAuB,EACvB,KAAuB;IAEvB,IAAI,CAAC,UAAU,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE,CAAC;QAAC,MAAM,IAAI,KAAK,CAAC,UAAU,CAAC,CAAC;IAAC,CAAC;IAC1E,OAAO,EAAE,IAAI,EAAE,UAAU,CAAC,SAAS,EAAE,KAAK,OAAA,EAAE,CAAC;AAC/C,CAAC"}

package/dist/interfaces/SignalingError.d.ts

@@ -1,8 +1,16 @@
+/**
+ * Error shape for signaling failures.
+ * @typeParam T - Optional payload type attached to the error
+ */
 export interface IRTSeeSignalingError<T = any> extends Error {
     code: string;
     friendlyMessage: string;
     data?: T;
 }
+/**
+ * Signaling error with code, friendly message and optional data.
+ * @typeParam T - Optional payload type attached to the error
+ */
 export declare class RTSeeSignalingError<T = any> {
     code: string;
     friendlyMessage: string;

package/dist/interfaces/SignalingError.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SignalingError.d.ts","sourceRoot":"","sources":["../../src/interfaces/SignalingError.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,oBAAoB,CAAC,CAAC,GAAG,GAAG,CAAE,SAAQ,KAAK;IAC1D,IAAI,EAAE,MAAM,CAAC;IACb,eAAe,EAAE,MAAM,CAAC;IACxB,IAAI,CAAC,EAAE,CAAC,CAAC;CACV;AAED,qBAAa,mBAAmB,CAAC,CAAC,GAAG,GAAG;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,eAAe,EAAE,MAAM,CAAC;IACxB,IAAI,CAAC,EAAE,CAAC,CAAC;CACV"}
+{"version":3,"file":"SignalingError.d.ts","sourceRoot":"","sources":["../../src/interfaces/SignalingError.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,oBAAoB,CAAC,CAAC,GAAG,GAAG,CAAE,SAAQ,KAAK;IAC1D,IAAI,EAAE,MAAM,CAAC;IACb,eAAe,EAAE,MAAM,CAAC;IACxB,IAAI,CAAC,EAAE,CAAC,CAAC;CACV;AAED;;;GAGG;AACH,qBAAa,mBAAmB,CAAC,CAAC,GAAG,GAAG;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,eAAe,EAAE,MAAM,CAAC;IACxB,IAAI,CAAC,EAAE,CAAC,CAAC;CACV"}

package/dist/interfaces/SignalingError.js

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RTSeeSignalingError = void 0;
+/**
+ * Signaling error with code, friendly message and optional data.
+ * @typeParam T - Optional payload type attached to the error
+ */
 var RTSeeSignalingError = /** @class */ (function () {
     function RTSeeSignalingError() {
     }

package/dist/interfaces/SignalingError.js.map

@@ -1 +1 @@
-{"version":3,"file":"SignalingError.js","sourceRoot":"","sources":["../../src/interfaces/SignalingError.ts"],"names":[],"mappings":";;;AAMA;IAAA;IAIA,CAAC;IAAD,0BAAC;AAAD,CAAC,AAJD,IAIC;AAJY,kDAAmB"}
+{"version":3,"file":"SignalingError.js","sourceRoot":"","sources":["../../src/interfaces/SignalingError.ts"],"names":[],"mappings":";;;AAUA;;;GAGG;AACH;IAAA;IAIA,CAAC;IAAD,0BAAC;AAAD,CAAC,AAJD,IAIC;AAJY,kDAAmB"}

package/dist/models/RTSeeCore.d.ts

@@ -1,5 +1,9 @@
 import { EventEmitter } from "events";
 import { IPeer, IRTSeeCoreOptions, IRTSeeLanguageOption, IRTSeeSignalingClientBase, RTSeeLanguage, RTSeeTextLabelKeys } from "@rtsee/core";
+/**
+ * Base abstract class for RTSEE client applications. Manages signaling connection,
+ * peer identity, language and labels.
+ */
 export declare abstract class RTSeeCore extends EventEmitter {
     clientId: string;
     myPeer: IPeer;
@@ -11,15 +15,46 @@ export declare abstract class RTSeeCore extends EventEmitter {
     };
     currentLanguage: RTSeeLanguage;
     protected constructor(options: IRTSeeCoreOptions);
+    /**
+     * Registers an additional language option for the UI labels.
+     * @param option - Language option with key and labels map
+     */
     addLanguage(option: IRTSeeLanguageOption): void;
+    /**
+     * Updates the current peer's profile (name, imageUrl).
+     * @param profileInfo - New profile data
+     * @param silent - If true, does not emit 'peerChanged'
+     */
     setPeerUpdates(profileInfo: IPeer, silent?: boolean): void;
+    /**
+     * Sets the active UI language and updates peer language.
+     * @param languageKey - Language key (e.g. 'eng', 'ua')
+     * @param silent - If true, does not emit 'languageChanged'
+     * @throws Error if languageKey is not in languageOptions
+     */
     setLanguage(languageKey: RTSeeLanguage, silent?: boolean): void;
+    /**
+     * Overwrites specific UI labels with custom strings.
+     * @param overwriteLabels - Partial map of label keys to custom strings
+     */
     overwriteLabels(overwriteLabels: {
         [key in RTSeeTextLabelKeys]?: string;
     }): void;
+    /**
+     * Called when the signaling client has resolved the peer. Override in subclasses.
+     * @param peer - The resolved peer for this client
+     */
     abstract onReady(peer: IPeer): void;
+    /**
+     * Attaches the given signaling client to this core and starts connection.
+     * @param options - Core options containing signalingClient and connection config
+     */
     attachSignalingClient(options: IRTSeeCoreOptions): void;
     private onPeerResolve;
+    /**
+     * Generates a new UUID v4 string.
+     * @returns A new UUID string
+     */
     static uuidv4(): string;
 }
 //# sourceMappingURL=RTSeeCore.d.ts.map

package/dist/models/RTSeeCore.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RTSeeCore.d.ts","sourceRoot":"","sources":["../../src/models/RTSeeCore.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AACtC,OAAO,EAEL,KAAK,EACL,iBAAiB,EACjB,oBAAoB,EACpB,yBAAyB,EAEzB,aAAa,EACb,kBAAkB,EACnB,MAAM,aAAa,CAAC;AAGrB,8BAAsB,SAAU,SAAQ,YAAY;IAClD,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,KAAK,CAAC;IACd,eAAe,EAAE,yBAAyB,CAAC;IAC3C,OAAO,EAAE,OAAO,CAAS;IACzB,eAAe,EAAE,oBAAoB,EAAE,CAAuB;IAC9D,MAAM,EAAE;SAAG,GAAG,IAAI,kBAAkB,GAAG,MAAM;KAAE,CAAiB;IAChE,eAAe,EAAE,aAAa,CAAS;IAEvC,SAAS,aAAa,OAAO,EAAE,iBAAiB;IAMhD,WAAW,CAAC,MAAM,EAAE,oBAAoB,GAAG,IAAI;IAI/C,cAAc,CACZ,WAAW,EAAE,KAAK,EAClB,MAAM,GAAE,OAAe,GACtB,IAAI;IASP,WAAW,CACT,WAAW,EAAE,aAAa,EAC1B,MAAM,GAAE,OAAe,GACtB,IAAI;IAiBP,eAAe,CACb,eAAe,EAAE;SAAG,GAAG,IAAI,kBAAkB,CAAC,CAAC,EAAE,MAAM;KAAE,GACxD,IAAI;IAMP,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,GAAG,IAAI;IAEnC,qBAAqB,CAAC,OAAO,EAAE,iBAAiB;IAWhD,OAAO,CAAC,aAAa;IAWrB,MAAM,CAAC,MAAM,IAAI,MAAM;CAIxB"}
+{"version":3,"file":"RTSeeCore.d.ts","sourceRoot":"","sources":["../../src/models/RTSeeCore.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AACtC,OAAO,EAEL,KAAK,EACL,iBAAiB,EACjB,oBAAoB,EACpB,yBAAyB,EAEzB,aAAa,EACb,kBAAkB,EACnB,MAAM,aAAa,CAAC;AAGrB;;;GAGG;AACH,8BAAsB,SAAU,SAAQ,YAAY;IAClD,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,KAAK,CAAC;IACd,eAAe,EAAE,yBAAyB,CAAC;IAC3C,OAAO,EAAE,OAAO,CAAS;IACzB,eAAe,EAAE,oBAAoB,EAAE,CAAuB;IAC9D,MAAM,EAAE;SAAG,GAAG,IAAI,kBAAkB,GAAG,MAAM;KAAE,CAAiB;IAChE,eAAe,EAAE,aAAa,CAAS;IAEvC,SAAS,aAAa,OAAO,EAAE,iBAAiB;IAMhD;;;OAGG;IACH,WAAW,CAAC,MAAM,EAAE,oBAAoB,GAAG,IAAI;IAI/C;;;;OAIG;IACH,cAAc,CACZ,WAAW,EAAE,KAAK,EAClB,MAAM,GAAE,OAAe,GACtB,IAAI;IASP;;;;;OAKG;IACH,WAAW,CACT,WAAW,EAAE,aAAa,EAC1B,MAAM,GAAE,OAAe,GACtB,IAAI;IAiBP;;;OAGG;IACH,eAAe,CACb,eAAe,EAAE;SAAG,GAAG,IAAI,kBAAkB,CAAC,CAAC,EAAE,MAAM;KAAE,GACxD,IAAI;IAMP;;;OAGG;IACH,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,GAAG,IAAI;IAEnC;;;OAGG;IACH,qBAAqB,CAAC,OAAO,EAAE,iBAAiB;IAWhD,OAAO,CAAC,aAAa;IAWrB;;;OAGG;IACH,MAAM,CAAC,MAAM,IAAI,MAAM;CAIxB"}

package/dist/models/RTSeeCore.js

@@ -19,6 +19,10 @@ exports.RTSeeCore = void 0;
 var events_1 = require("events");
 var core_1 = require("@rtsee/core");
 var uuid_1 = require("uuid");
+/**
+ * Base abstract class for RTSEE client applications. Manages signaling connection,
+ * peer identity, language and labels.
+ */
 var RTSeeCore = /** @class */ (function (_super) {
     __extends(RTSeeCore, _super);
     function RTSeeCore(options) {
@@ -30,9 +34,18 @@ var RTSeeCore = /** @class */ (function (_super) {
         _this.attachSignalingClient(options);
         return _this;
     }
+    /**
+     * Registers an additional language option for the UI labels.
+     * @param option - Language option with key and labels map
+     */
     RTSeeCore.prototype.addLanguage = function (option) {
         this.languageOptions.push(option);
     };
+    /**
+     * Updates the current peer's profile (name, imageUrl).
+     * @param profileInfo - New profile data
+     * @param silent - If true, does not emit 'peerChanged'
+     */
     RTSeeCore.prototype.setPeerUpdates = function (profileInfo, silent) {
         if (silent === void 0) { silent = false; }
         this.myPeer.name = profileInfo.name;
@@ -41,6 +54,12 @@ var RTSeeCore = /** @class */ (function (_super) {
             this.emit('peerChanged', this.myPeer);
         }
     };
+    /**
+     * Sets the active UI language and updates peer language.
+     * @param languageKey - Language key (e.g. 'eng', 'ua')
+     * @param silent - If true, does not emit 'languageChanged'
+     * @throws Error if languageKey is not in languageOptions
+     */
     RTSeeCore.prototype.setLanguage = function (languageKey, silent) {
         if (silent === void 0) { silent = false; }
         var languageOption = this.languageOptions
@@ -55,12 +74,20 @@ var RTSeeCore = /** @class */ (function (_super) {
             this.emit('languageChanged', languageKey);
         }
     };
+    /**
+     * Overwrites specific UI labels with custom strings.
+     * @param overwriteLabels - Partial map of label keys to custom strings
+     */
     RTSeeCore.prototype.overwriteLabels = function (overwriteLabels) {
         for (var _i = 0, _a = Object.entries(overwriteLabels); _i < _a.length; _i++) {
             var key = _a[_i][0];
             this.labels[key] = overwriteLabels[key];
         }
     };
+    /**
+     * Attaches the given signaling client to this core and starts connection.
+     * @param options - Core options containing signalingClient and connection config
+     */
     RTSeeCore.prototype.attachSignalingClient = function (options) {
         var _this = this;
         var _a;
@@ -83,6 +110,10 @@ var RTSeeCore = /** @class */ (function (_super) {
         this.onReady(peer);
     };
     /* eslint-disable */
+    /**
+     * Generates a new UUID v4 string.
+     * @returns A new UUID string
+     */
     RTSeeCore.uuidv4 = function () {
         return (0, uuid_1.v4)();
     };

package/dist/models/RTSeeCore.js.map

@@ -1 +1 @@
-{"version":3,"file":"RTSeeCore.js","sourceRoot":"","sources":["../../src/models/RTSeeCore.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAAA,iCAAsC;AACtC,oCASqB;AACrB,6BAAkC;AAElC;IAAwC,6BAAY;IASlD,mBAAsB,OAA0B;QAC9C,YAAA,MAAK,WAAE,SAAC;QANV,aAAO,GAAY,KAAK,CAAC;QACzB,qBAAe,GAA2B,0BAAmB,CAAC;QAC9D,YAAM,GAA4C,oBAAa,CAAC;QAChE,qBAAe,GAAkB,KAAK,CAAC;QAKrC,KAAI,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC;;IACtC,CAAC;IAED,+BAAW,GAAX,UAAY,MAA4B;QACtC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACpC,CAAC;IAED,kCAAc,GAAd,UACE,WAAkB,EAClB,MAAuB;QAAvB,uBAAA,EAAA,cAAuB;QAEvB,IAAI,CAAC,MAAM,CAAC,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC;QACpC,IAAI,CAAC,MAAM,CAAC,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC;QAE5C,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,IAAI,CAAC,IAAI,CAAC,aAAa,EAAG,IAAI,CAAC,MAAM,CAAC,CAAC;QACzC,CAAC;IACH,CAAC;IAED,+BAAW,GAAX,UACE,WAA0B,EAC1B,MAAuB;QAAvB,uBAAA,EAAA,cAAuB;QAEvB,IAAM,cAAc,GAAgC,IAAI,CAAC,eAAe;aACrE,IAAI,CAAC,UAAC,EAAE,IAAK,OAAA,EAAE,CAAC,GAAG,KAAK,WAAW,EAAtB,CAAsB,CAAC,IAAI,IAAI,CAAC;QAEhD,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CAAC,oCAA6B,WAAW,CAAE,CAAC,CAAC;QAC9D,CAAC;QAED,IAAI,CAAC,MAAM,GAAG,cAAc,CAAC,MAAM,CAAC;QACpC,IAAI,CAAC,eAAe,GAAG,WAAW,CAAC;QACnC,IAAI,CAAC,MAAM,CAAC,QAAQ,GAAG,WAAW,CAAC;QAEnC,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,WAAW,CAAC,CAAC;QAC5C,CAAC;IACH,CAAC;IAED,mCAAe,GAAf,UACE,eAAyD;QAEzD,KAAoB,UAA+B,EAA/B,KAAA,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,EAA/B,cAA+B,EAA/B,IAA+B,EAAE,CAAC;YAA1C,IAAA,GAAG,YAAA;YACb,IAAI,CAAC,MAAM,CAAC,GAAyB,CAAC,GAAG,eAAe,CAAC,GAAyB,CAAC,CAAC;QACtF,CAAC;IACH,CAAC;IAID,yCAAqB,GAArB,UAAsB,OAA0B;QAAhD,iBASC;;QARC,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE,CAAC;YAC7B,OAAO;QACT,CAAC;QACD,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC;QAC/C,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACtC,KAAK,CAAA,MAAA,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,aAAa,0CAAE,IAAI,CAAC,UAAC,IAAI;YAC5D,OAAA,KAAI,CAAC,aAAa,CAAC,IAAI,CAAC;QAAxB,CAAwB,CACzB,CAAA,CAAC;IACJ,CAAC;IAEO,iCAAa,GAArB,UAAsB,IAAW;QAC/B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC9B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;QACnB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACpB,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;YACzB,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACzC,CAAC;QACD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACrB,CAAC;IAED,oBAAoB;IACb,gBAAM,GAAb;QACE,OAAO,IAAA,SAAI,GAAE,CAAC;IAChB,CAAC;IAEH,gBAAC;AAAD,CAAC,AAvFD,CAAwC,qBAAY,GAuFnD;AAvFqB,8BAAS"}
+{"version":3,"file":"RTSeeCore.js","sourceRoot":"","sources":["../../src/models/RTSeeCore.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAAA,iCAAsC;AACtC,oCASqB;AACrB,6BAAkC;AAElC;;;GAGG;AACH;IAAwC,6BAAY;IASlD,mBAAsB,OAA0B;QAC9C,YAAA,MAAK,WAAE,SAAC;QANV,aAAO,GAAY,KAAK,CAAC;QACzB,qBAAe,GAA2B,0BAAmB,CAAC;QAC9D,YAAM,GAA4C,oBAAa,CAAC;QAChE,qBAAe,GAAkB,KAAK,CAAC;QAKrC,KAAI,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC;;IACtC,CAAC;IAED;;;OAGG;IACH,+BAAW,GAAX,UAAY,MAA4B;QACtC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACpC,CAAC;IAED;;;;OAIG;IACH,kCAAc,GAAd,UACE,WAAkB,EAClB,MAAuB;QAAvB,uBAAA,EAAA,cAAuB;QAEvB,IAAI,CAAC,MAAM,CAAC,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC;QACpC,IAAI,CAAC,MAAM,CAAC,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC;QAE5C,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,IAAI,CAAC,IAAI,CAAC,aAAa,EAAG,IAAI,CAAC,MAAM,CAAC,CAAC;QACzC,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,+BAAW,GAAX,UACE,WAA0B,EAC1B,MAAuB;QAAvB,uBAAA,EAAA,cAAuB;QAEvB,IAAM,cAAc,GAAgC,IAAI,CAAC,eAAe;aACrE,IAAI,CAAC,UAAC,EAAE,IAAK,OAAA,EAAE,CAAC,GAAG,KAAK,WAAW,EAAtB,CAAsB,CAAC,IAAI,IAAI,CAAC;QAEhD,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CAAC,oCAA6B,WAAW,CAAE,CAAC,CAAC;QAC9D,CAAC;QAED,IAAI,CAAC,MAAM,GAAG,cAAc,CAAC,MAAM,CAAC;QACpC,IAAI,CAAC,eAAe,GAAG,WAAW,CAAC;QACnC,IAAI,CAAC,MAAM,CAAC,QAAQ,GAAG,WAAW,CAAC;QAEnC,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,WAAW,CAAC,CAAC;QAC5C,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,mCAAe,GAAf,UACE,eAAyD;QAEzD,KAAoB,UAA+B,EAA/B,KAAA,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,EAA/B,cAA+B,EAA/B,IAA+B,EAAE,CAAC;YAA1C,IAAA,GAAG,YAAA;YACb,IAAI,CAAC,MAAM,CAAC,GAAyB,CAAC,GAAG,eAAe,CAAC,GAAyB,CAAC,CAAC;QACtF,CAAC;IACH,CAAC;IAQD;;;OAGG;IACH,yCAAqB,GAArB,UAAsB,OAA0B;QAAhD,iBASC;;QARC,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE,CAAC;YAC7B,OAAO;QACT,CAAC;QACD,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC;QAC/C,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACtC,KAAK,CAAA,MAAA,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,aAAa,0CAAE,IAAI,CAAC,UAAC,IAAI;YAC5D,OAAA,KAAI,CAAC,aAAa,CAAC,IAAI,CAAC;QAAxB,CAAwB,CACzB,CAAA,CAAC;IACJ,CAAC;IAEO,iCAAa,GAArB,UAAsB,IAAW;QAC/B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC9B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;QACnB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACpB,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;YACzB,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACzC,CAAC;QACD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACrB,CAAC;IAED,oBAAoB;IACpB;;;OAGG;IACI,gBAAM,GAAb;QACE,OAAO,IAAA,SAAI,GAAE,CAAC;IAChB,CAAC;IAEH,gBAAC;AAAD,CAAC,AAtHD,CAAwC,qBAAY,GAsHnD;AAtHqB,8BAAS"}

package/dist/models/RTSeeSignalHandler.d.ts

@@ -1,10 +1,23 @@
 import { IRTSeeSignalHandlerOptions, IRTSeeSignalingError, IRTSeeSignalingHandlerErrorOptions, IRTSeeSignalingHandlerSuccessOptions, ISocketPeer } from "@rtsee/core";
+/**
+ * Handles a single signaling event: runs the processor and dispatches to onSuccess or onError.
+ * @typeParam P - Payload type for the handler
+ * @typeParam R - Result type returned by the processor
+ */
 export declare class RTSeeSignalHandler<P, R> {
     eventName: string;
     processor: (socketPeer: ISocketPeer, payload?: P) => Promise<R>;
     onSuccess: (options: IRTSeeSignalingHandlerSuccessOptions<R>) => void;
     onError: (options: IRTSeeSignalingHandlerErrorOptions<P>) => IRTSeeSignalingError;
+    /**
+     * @param options - Handler options (eventName, processor, onSuccess, onError)
+     */
     constructor(options: IRTSeeSignalHandlerOptions<P, R>);
+    /**
+     * Runs the handler: calls processor with socketPeer and payload, then onSuccess or onError.
+     * @param socketPeer - Socket peer context
+     * @param payload - Event payload
+     */
     run(socketPeer: ISocketPeer, payload: P): Promise<void>;
 }
 //# sourceMappingURL=RTSeeSignalHandler.d.ts.map

package/dist/models/RTSeeSignalHandler.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RTSeeSignalHandler.d.ts","sourceRoot":"","sources":["../../src/models/RTSeeSignalHandler.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,0BAA0B,EAC1B,oBAAoB,EACpB,kCAAkC,EAClC,oCAAoC,EACpC,WAAW,EAGZ,MAAM,aAAa,CAAC;AAErB,qBAAa,kBAAkB,CAAC,CAAC,EAAE,CAAC;IAClC,SAAS,EAAE,MAAM,CAAC;IAElB,SAAS,EAAE,CAAC,UAAU,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAChE,SAAS,EAAE,CAAC,OAAO,EAAE,oCAAoC,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;IACtE,OAAO,EAAE,CAAC,OAAO,EAAE,kCAAkC,CAAC,CAAC,CAAC,KAAK,oBAAoB,CAAC;gBAEtE,OAAO,EAAE,0BAA0B,CAAC,CAAC,EAAE,CAAC,CAAC;IAO/C,GAAG,CACP,UAAU,EAAE,WAAW,EACvB,OAAO,EAAE,CAAC,GACT,OAAO,CAAC,IAAI,CAAC;CAiBjB"}
+{"version":3,"file":"RTSeeSignalHandler.d.ts","sourceRoot":"","sources":["../../src/models/RTSeeSignalHandler.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,0BAA0B,EAC1B,oBAAoB,EACpB,kCAAkC,EAClC,oCAAoC,EACpC,WAAW,EAGZ,MAAM,aAAa,CAAC;AAErB;;;;GAIG;AACH,qBAAa,kBAAkB,CAAC,CAAC,EAAE,CAAC;IAClC,SAAS,EAAE,MAAM,CAAC;IAElB,SAAS,EAAE,CAAC,UAAU,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAChE,SAAS,EAAE,CAAC,OAAO,EAAE,oCAAoC,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;IACtE,OAAO,EAAE,CAAC,OAAO,EAAE,kCAAkC,CAAC,CAAC,CAAC,KAAK,oBAAoB,CAAC;IAElF;;OAEG;gBACS,OAAO,EAAE,0BAA0B,CAAC,CAAC,EAAE,CAAC,CAAC;IAOrD;;;;OAIG;IACG,GAAG,CACP,UAAU,EAAE,WAAW,EACvB,OAAO,EAAE,CAAC,GACT,OAAO,CAAC,IAAI,CAAC;CAiBjB"}

package/dist/models/RTSeeSignalHandler.js

@@ -38,13 +38,26 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RTSeeSignalHandler = void 0;
 var core_1 = require("@rtsee/core");
+/**
+ * Handles a single signaling event: runs the processor and dispatches to onSuccess or onError.
+ * @typeParam P - Payload type for the handler
+ * @typeParam R - Result type returned by the processor
+ */
 var RTSeeSignalHandler = /** @class */ (function () {
+    /**
+     * @param options - Handler options (eventName, processor, onSuccess, onError)
+     */
     function RTSeeSignalHandler(options) {
         this.eventName = options.eventName;
         this.processor = options.processor;
         this.onSuccess = options.onSuccess;
         this.onError = options.onError;
     }
+    /**
+     * Runs the handler: calls processor with socketPeer and payload, then onSuccess or onError.
+     * @param socketPeer - Socket peer context
+     * @param payload - Event payload
+     */
     RTSeeSignalHandler.prototype.run = function (socketPeer, payload) {
         return __awaiter(this, void 0, void 0, function () {
             var result, e_1;

package/dist/models/RTSeeSignalHandler.js.map

@@ -1 +1 @@
-{"version":3,"file":"RTSeeSignalHandler.js","sourceRoot":"","sources":["../../src/models/RTSeeSignalHandler.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,oCAQqB;AAErB;IAOE,4BAAY,OAAyC;QACnD,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QACnC,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QACnC,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QACnC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IACjC,CAAC;IAEK,gCAAG,GAAT,UACE,UAAuB,EACvB,OAAU;;;;;;;wBAGU,qBAAM,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE,OAAO,CAAC,EAAA;;wBAArD,MAAM,GAAM,SAAyC;wBAC3D,IAAI,CAAC,SAAS,CAAC;4BACb,UAAU,YAAA;4BACV,IAAI,EAAE,MAAM;4BACZ,SAAS,EAAE,UAAG,IAAI,CAAC,SAAS,cAAI,6BAAsB,CAAE;yBACzD,CAAC,CAAC;;;;wBAEH,IAAI,CAAC,OAAO,CAAC;4BACX,UAAU,YAAA;4BACV,OAAO,SAAA;4BACP,KAAK,EAAE,GAAC;4BACR,SAAS,EAAE,UAAG,IAAI,CAAC,SAAS,cAAI,6BAAsB,CAAE;yBACzD,CAAC,CAAC;;;;;;KAEN;IACH,yBAAC;AAAD,CAAC,AAlCD,IAkCC;AAlCY,gDAAkB"}
+{"version":3,"file":"RTSeeSignalHandler.js","sourceRoot":"","sources":["../../src/models/RTSeeSignalHandler.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,oCAQqB;AAErB;;;;GAIG;AACH;IAOE;;OAEG;IACH,4BAAY,OAAyC;QACnD,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QACnC,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QACnC,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QACnC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IACjC,CAAC;IAED;;;;OAIG;IACG,gCAAG,GAAT,UACE,UAAuB,EACvB,OAAU;;;;;;;wBAGU,qBAAM,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE,OAAO,CAAC,EAAA;;wBAArD,MAAM,GAAM,SAAyC;wBAC3D,IAAI,CAAC,SAAS,CAAC;4BACb,UAAU,YAAA;4BACV,IAAI,EAAE,MAAM;4BACZ,SAAS,EAAE,UAAG,IAAI,CAAC,SAAS,cAAI,6BAAsB,CAAE;yBACzD,CAAC,CAAC;;;;wBAEH,IAAI,CAAC,OAAO,CAAC;4BACX,UAAU,YAAA;4BACV,OAAO,SAAA;4BACP,KAAK,EAAE,GAAC;4BACR,SAAS,EAAE,UAAG,IAAI,CAAC,SAAS,cAAI,6BAAsB,CAAE;yBACzD,CAAC,CAAC;;;;;;KAEN;IACH,yBAAC;AAAD,CAAC,AA1CD,IA0CC;AA1CY,gDAAkB"}

package/dist/models/RTSeeSignalRequest.d.ts

@@ -1,4 +1,9 @@
 import { IRTSeeSignalingClientBase, IRTSeeSignalingError, IRTSeeSignalRequestOptions } from "@rtsee/core";
+/**
+ * Sends a request over the signaling client and resolves with the success response or rejects with signaling error.
+ * @typeParam T - Success response type
+ * @typeParam E - Payload type sent with the request
+ */
 export declare class RTSeeSignalRequest<T, E> {
     signalingClient: IRTSeeSignalingClientBase;
     maxWaitTime: number;
@@ -8,7 +13,15 @@ export declare class RTSeeSignalRequest<T, E> {
     promiseReject?: (value: IRTSeeSignalingError | PromiseLike<IRTSeeSignalingError>) => void;
     successHandler: (value: T) => void;
     failureHandler: (e: IRTSeeSignalingError) => void;
+    /**
+     * @param options - Request options (signalingClient, eventName, maxWaitTime)
+     */
     constructor(options: IRTSeeSignalRequestOptions);
+    /**
+     * Sends the request to the signaling server and returns a promise that resolves with the success response.
+     * @param payload - Optional payload to send with the request
+     * @returns Promise resolving to the success response of type T
+     */
     send(payload?: E): Promise<T>;
     private onSuccess;
     private onFailure;

package/dist/models/RTSeeSignalRequest.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RTSeeSignalRequest.d.ts","sourceRoot":"","sources":["../../src/models/RTSeeSignalRequest.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,yBAAyB,EACzB,oBAAoB,EACpB,0BAA0B,EAM3B,MAAM,aAAa,CAAC;AAErB,qBAAa,kBAAkB,CAAC,CAAC,EAAE,CAAC;IAClC,eAAe,EAAE,yBAAyB,CAAC;IAC3C,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B,cAAc,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;IACrD,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE,oBAAoB,GAAG,WAAW,CAAC,oBAAoB,CAAC,KAAK,IAAI,CAAC;IAC1F,cAAc,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,CAAC;IACnC,cAAc,EAAE,CAAC,CAAC,EAAE,oBAAoB,KAAK,IAAI,CAAC;gBAEtC,OAAO,EAAE,0BAA0B;IASlC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAwB1C,OAAO,CAAC,SAAS;IAQjB,OAAO,CAAC,SAAS;IAQjB,OAAO,CAAC,wBAAwB;IAShC,OAAO,CAAC,4BAA4B;IAKpC,OAAO,CAAC,aAAa;CAQtB"}
+{"version":3,"file":"RTSeeSignalRequest.d.ts","sourceRoot":"","sources":["../../src/models/RTSeeSignalRequest.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,yBAAyB,EACzB,oBAAoB,EACpB,0BAA0B,EAM3B,MAAM,aAAa,CAAC;AAErB;;;;GAIG;AACH,qBAAa,kBAAkB,CAAC,CAAC,EAAE,CAAC;IAClC,eAAe,EAAE,yBAAyB,CAAC;IAC3C,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B,cAAc,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;IACrD,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE,oBAAoB,GAAG,WAAW,CAAC,oBAAoB,CAAC,KAAK,IAAI,CAAC;IAC1F,cAAc,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,CAAC;IACnC,cAAc,EAAE,CAAC,CAAC,EAAE,oBAAoB,KAAK,IAAI,CAAC;IAElD;;OAEG;gBACS,OAAO,EAAE,0BAA0B;IAS/C;;;;OAIG;IACU,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAwB1C,OAAO,CAAC,SAAS;IAQjB,OAAO,CAAC,SAAS;IAQjB,OAAO,CAAC,wBAAwB;IAShC,OAAO,CAAC,4BAA4B;IAKpC,OAAO,CAAC,aAAa;CAQtB"}

package/dist/models/RTSeeSignalRequest.js

@@ -38,7 +38,15 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RTSeeSignalRequest = void 0;
 var core_1 = require("@rtsee/core");
+/**
+ * Sends a request over the signaling client and resolves with the success response or rejects with signaling error.
+ * @typeParam T - Success response type
+ * @typeParam E - Payload type sent with the request
+ */
 var RTSeeSignalRequest = /** @class */ (function () {
+    /**
+     * @param options - Request options (signalingClient, eventName, maxWaitTime)
+     */
     function RTSeeSignalRequest(options) {
         this.signalingClient = options.signalingClient;
         this.maxWaitTime = options.maxWaitTime || core_1.DEFAULT_MAX_WAIT_TIME_S;
@@ -46,6 +54,11 @@ var RTSeeSignalRequest = /** @class */ (function () {
         this.successHandler = this.onSuccess.bind(this);
         this.failureHandler = this.onFailure.bind(this);
     }
+    /**
+     * Sends the request to the signaling server and returns a promise that resolves with the success response.
+     * @param payload - Optional payload to send with the request
+     * @returns Promise resolving to the success response of type T
+     */
     RTSeeSignalRequest.prototype.send = function (payload) {
         return __awaiter(this, void 0, void 0, function () {
             var message, promise;

package/dist/models/RTSeeSignalRequest.js.map

@@ -1 +1 @@
-{"version":3,"file":"RTSeeSignalRequest.js","sourceRoot":"","sources":["../../src/models/RTSeeSignalRequest.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,oCASqB;AAErB;IAWE,4BAAY,OAAmC;QAC7C,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC;QAC/C,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,IAAI,8BAAuB,CAAC;QAClE,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QAEnC,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAmB,CAAC;QAClE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAsC,CAAC;IACvF,CAAC;IAEY,iCAAI,GAAjB,UAAkB,OAAW;;;;;gBAC3B,IAAI,CAAC,aAAa,EAAE,CAAC;gBACrB,IAAI,CAAC,qBAAqB,GAAG,gBAAS,CAAC,MAAM,EAAE,CAAC,CAAC,0DAA0D;gBAErG,OAAO,GAA0B;oBACrC,IAAI,EAAE,IAAI,CAAC,SAAS;oBACpB,SAAS,EAAE,IAAI,CAAC,qBAAqB;oBACrC,IAAI,EAAE,OAAO;iBACd,CAAC;gBAEI,OAAO,GAAe,IAAI,OAAO,CAAI,UAAC,OAAO,EAAE,MAAM;oBACzD,KAAI,CAAC,cAAc,GAAG,OAAO,CAAC;oBAC9B,KAAI,CAAC,aAAa,GAAG,MAAM,CAAC;gBAC9B,CAAC,CAAC,CAAC;gBAEH,IAAI,CAAC,wBAAwB,EAAE,CAAC;gBAEhC,IAAI,IAAI,CAAC,eAAe,IAAI,IAAI,CAAC,eAAe,CAAC,SAAS,EAAE,CAAC;oBAC3D,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;gBAC1C,CAAC;gBAED,sBAAO,OAAO,EAAC;;;KAChB;IAEO,sCAAS,GAAjB,UAAkB,MAAS;QACzB,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACxB,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QAC9B,CAAC;QAED,IAAI,CAAC,aAAa,EAAE,CAAC;IACvB,CAAC;IAEO,sCAAS,GAAjB,UAAkB,KAA2B;QAC3C,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YACvB,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAC5B,CAAC;QAED,IAAI,CAAC,aAAa,EAAE,CAAC;IACvB,CAAC;IAEO,qDAAwB,GAAhC;QACE,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;YAChD,MAAM,IAAI,KAAK,CAAC,UAAG,IAAI,CAAC,SAAS,gCAA6B,CAAC,CAAC;QAClE,CAAC;QAED,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC,UAAG,IAAI,CAAC,SAAS,cAAI,6BAAsB,CAAE,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;QAC5F,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC,UAAG,IAAI,CAAC,SAAS,cAAI,6BAAsB,CAAE,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;IAC9F,CAAC;IAAA,CAAC;IAEM,yDAA4B,GAApC;QACE,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,UAAG,IAAI,CAAC,SAAS,cAAI,6BAAsB,CAAE,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;QAC7F,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,UAAG,IAAI,CAAC,SAAS,cAAI,6BAAsB,CAAE,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;IAC/F,CAAC;IAEO,0CAAa,GAArB;QACE,IAAI,IAAI,CAAC,cAAc,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YAC9C,IAAI,CAAC,cAAc,GAAG,SAAS,CAAC;YAChC,IAAI,CAAC,aAAa,GAAG,SAAS,CAAC;YAC/B,IAAI,CAAC,4BAA4B,EAAE,CAAC;YACpC,IAAI,CAAC,qBAAqB,GAAG,SAAS,CAAC;QACzC,CAAC;IACH,CAAC;IACH,yBAAC;AAAD,CAAC,AAlFD,IAkFC;AAlFY,gDAAkB"}
+{"version":3,"file":"RTSeeSignalRequest.js","sourceRoot":"","sources":["../../src/models/RTSeeSignalRequest.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,oCASqB;AAErB;;;;GAIG;AACH;IAWE;;OAEG;IACH,4BAAY,OAAmC;QAC7C,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC;QAC/C,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,IAAI,8BAAuB,CAAC;QAClE,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QAEnC,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAmB,CAAC;QAClE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAsC,CAAC;IACvF,CAAC;IAED;;;;OAIG;IACU,iCAAI,GAAjB,UAAkB,OAAW;;;;;gBAC3B,IAAI,CAAC,aAAa,EAAE,CAAC;gBACrB,IAAI,CAAC,qBAAqB,GAAG,gBAAS,CAAC,MAAM,EAAE,CAAC,CAAC,0DAA0D;gBAErG,OAAO,GAA0B;oBACrC,IAAI,EAAE,IAAI,CAAC,SAAS;oBACpB,SAAS,EAAE,IAAI,CAAC,qBAAqB;oBACrC,IAAI,EAAE,OAAO;iBACd,CAAC;gBAEI,OAAO,GAAe,IAAI,OAAO,CAAI,UAAC,OAAO,EAAE,MAAM;oBACzD,KAAI,CAAC,cAAc,GAAG,OAAO,CAAC;oBAC9B,KAAI,CAAC,aAAa,GAAG,MAAM,CAAC;gBAC9B,CAAC,CAAC,CAAC;gBAEH,IAAI,CAAC,wBAAwB,EAAE,CAAC;gBAEhC,IAAI,IAAI,CAAC,eAAe,IAAI,IAAI,CAAC,eAAe,CAAC,SAAS,EAAE,CAAC;oBAC3D,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;gBAC1C,CAAC;gBAED,sBAAO,OAAO,EAAC;;;KAChB;IAEO,sCAAS,GAAjB,UAAkB,MAAS;QACzB,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACxB,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QAC9B,CAAC;QAED,IAAI,CAAC,aAAa,EAAE,CAAC;IACvB,CAAC;IAEO,sCAAS,GAAjB,UAAkB,KAA2B;QAC3C,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YACvB,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAC5B,CAAC;QAED,IAAI,CAAC,aAAa,EAAE,CAAC;IACvB,CAAC;IAEO,qDAAwB,GAAhC;QACE,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;YAChD,MAAM,IAAI,KAAK,CAAC,UAAG,IAAI,CAAC,SAAS,gCAA6B,CAAC,CAAC;QAClE,CAAC;QAED,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC,UAAG,IAAI,CAAC,SAAS,cAAI,6BAAsB,CAAE,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;QAC5F,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC,UAAG,IAAI,CAAC,SAAS,cAAI,6BAAsB,CAAE,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;IAC9F,CAAC;IAAA,CAAC;IAEM,yDAA4B,GAApC;QACE,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,UAAG,IAAI,CAAC,SAAS,cAAI,6BAAsB,CAAE,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;QAC7F,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,UAAG,IAAI,CAAC,SAAS,cAAI,6BAAsB,CAAE,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;IAC/F,CAAC;IAEO,0CAAa,GAArB;QACE,IAAI,IAAI,CAAC,cAAc,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YAC9C,IAAI,CAAC,cAAc,GAAG,SAAS,CAAC;YAChC,IAAI,CAAC,aAAa,GAAG,SAAS,CAAC;YAC/B,IAAI,CAAC,4BAA4B,EAAE,CAAC;YACpC,IAAI,CAAC,qBAAqB,GAAG,SAAS,CAAC;QACzC,CAAC;IACH,CAAC;IACH,yBAAC;AAAD,CAAC,AA1FD,IA0FC;AA1FY,gDAAkB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rtsee/core",
-  "version": "0.0.93",
+  "version": "0.0.94",
   "license": "ISC",
   "private": false,
   "main": "dist/index",
@@ -31,5 +31,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "5421f401d4a962b6f19d37727f3cb834f7cc4166"
+  "gitHead": "a267a11515165019e8b43d237c9132406c71d258"
 }