@crewdle/web-sdk-types 1.0.0

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

@@ -0,0 +1,11 @@
+import { IPeerConnectionHandshakeCandidate } from '.';
+/**
+ * The peer connection handshake candidate event interface.
+ * @category Core
+ */
+export interface IPeerConnectionHandshakeCandidateEvent {
+    /**
+     * The candidate received.
+     */
+    readonly candidate: IPeerConnectionHandshakeCandidate | null;
+}

package/dist/core/connection/PeerConnectionHandshakeCandidateEvent.js

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

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

@@ -0,0 +1,18 @@
+/**
+ * The peer connection handshake server interface.
+ * @category Core
+ */
+export interface IPeerConnectionHandshakeServer {
+    /**
+     * The credential for the handshake server.
+     */
+    credential?: string;
+    /**
+     * The urls for the handshake server.
+     */
+    urls: string | string[];
+    /**
+     * The username for the handshake server.
+     */
+    username?: string;
+}

package/dist/core/connection/PeerConnectionHandshakeServer.js

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

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

@@ -0,0 +1,10 @@
+/**
+ * The peer connection offer options interface.
+ * @category Core
+ */
+export interface IPeerConnectionOfferOptions {
+    /**
+     * Whether or not to restart the handshake.
+     */
+    handshakeRestart?: boolean;
+}

package/dist/core/connection/PeerConnectionOfferOptions.js

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

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

@@ -0,0 +1,11 @@
+/**
+ * The peer connection sender interface.
+ * @category Core
+ */
+export interface IPeerConnectionSender {
+    /**
+     * Replaces the current track with a new track.
+     * @param track - The track to replace the current track with.
+     */
+    replaceTrack(track: MediaStreamTrack): Promise<void>;
+}

package/dist/core/connection/PeerConnectionSender.js

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

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

@@ -0,0 +1,24 @@
+import { IPeerConnectionSender } from '.';
+/**
+ * The peer connection sender map interface.
+ * @category Core
+ */
+export interface IPeerConnectionSenderMap {
+    /**
+     * The stream associated with the sender.
+     */
+    stream: MediaStream;
+    /**
+     * The tracks associated with the sender.
+     */
+    tracks: {
+        video?: {
+            track?: MediaStreamTrack;
+            sender?: IPeerConnectionSender;
+        };
+        audio?: {
+            track?: MediaStreamTrack;
+            sender?: IPeerConnectionSender;
+        };
+    };
+}

package/dist/core/connection/PeerConnectionSenderMap.js

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

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

@@ -0,0 +1,14 @@
+/**
+ * The peer connection session description interface.
+ * @category Core
+ */
+export interface IPeerConnectionSessionDescription {
+    /**
+     * The SDP.
+     */
+    sdp?: string;
+    /**
+     * The type of the session description.
+     */
+    type: string;
+}

package/dist/core/connection/PeerConnectionSessionDescription.js

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

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

@@ -0,0 +1,6 @@
+import { IPeerConnectionStatsReportInbound, IPeerConnectionStatsReportOutbound, IPeerConnectionStatsReportRemoteInbound, IPeerConnectionStatsReportUnused } from '.';
+/**
+ * The peer connection stats report type.
+ * @category Core
+ */
+export type PeerConnectionStatsReport = IPeerConnectionStatsReportInbound | IPeerConnectionStatsReportOutbound | IPeerConnectionStatsReportRemoteInbound | IPeerConnectionStatsReportUnused;

package/dist/core/connection/PeerConnectionStatsReport.js

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

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

@@ -0,0 +1,38 @@
+/**
+ * The peer connection inbound stats report interface.
+ * @category Core
+ */
+export interface IPeerConnectionStatsReportInbound {
+    /**
+     * The type of the report.
+     */
+    type: 'inbound-rtp';
+    /**
+     * The kind of the report.
+     */
+    kind: 'audio' | 'video';
+    /**
+     * The bytes received.
+     */
+    bytesReceived: number;
+    /**
+     * The timestamp.
+     */
+    timestamp: number;
+    /**
+     * The packets received.
+     */
+    packetsReceived: number;
+    /**
+     * The packets lost.
+     */
+    packetsLost: number;
+    /**
+     * The jitter.
+     */
+    jitter?: number;
+    /**
+     * The estimated playout timestamp.
+     */
+    estimatedPlayoutTimestamp?: number;
+}

package/dist/core/connection/PeerConnectionStatsReportInbound.js

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

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

@@ -0,0 +1,26 @@
+/**
+ * The peer connection outbound stats report interface.
+ * @category Core
+ */
+export interface IPeerConnectionStatsReportOutbound {
+    /**
+     * The type of the report.
+     */
+    type: 'outbound-rtp';
+    /**
+     * The kind of the report.
+     */
+    kind: 'audio' | 'video';
+    /**
+     * The bytes sent.
+     */
+    bytesSent: number;
+    /**
+     * The timestamp.
+     */
+    timestamp: number;
+    /**
+     * The packets sent.
+     */
+    packetsSent: number;
+}

package/dist/core/connection/PeerConnectionStatsReportOutbound.js

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

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

@@ -0,0 +1,22 @@
+/**
+ * The peer connection remote inbound stats report interface.
+ * @category Core
+ */
+export interface IPeerConnectionStatsReportRemoteInbound {
+    /**
+     * The type of the report.
+     */
+    type: 'remote-inbound-rtp';
+    /**
+     * The kind of the report.
+     */
+    kind: 'audio' | 'video';
+    /**
+     * The round trip time.
+     */
+    roundTripTime: number;
+    /**
+     * The jitter.
+     */
+    jitter?: number;
+}

package/dist/core/connection/PeerConnectionStatsReportRemoteInbound.js

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

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

@@ -0,0 +1,14 @@
+/**
+ * The peer connection unused stats report interface.
+ * @category Core
+ */
+export interface IPeerConnectionStatsReportUnused {
+    /**
+     * The type of the report.
+     */
+    type: 'track' | 'media-source' | 'sender' | 'receiver' | 'transport' | 'candidate-pair' | 'local-candidate' | 'remote-candidate';
+    /**
+     * The kind of the report.
+     */
+    kind: 'audio' | 'video';
+}

package/dist/core/connection/PeerConnectionStatsReportUnused.js

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

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

@@ -0,0 +1,14 @@
+/**
+ * The peer connection track event interface.
+ * @category Core
+ */
+export interface IPeerConnectionTrackEvent {
+    /**
+     * The track received.
+     */
+    readonly track: MediaStreamTrack;
+    /**
+     * The streams associated with the track.
+     */
+    readonly streams: ReadonlyArray<MediaStream>;
+}

package/dist/core/connection/PeerConnectionTrackEvent.js

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

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

@@ -0,0 +1,18 @@
+export { IPeerConnectionConfiguration } from './PeerConnectionConfiguration';
+export { IPeerConnectionConnector } from './PeerConnectionConnector';
+export { PeerConnectionConnectorConstructor } from './PeerConnectionConnectorConstructor';
+export { IPeerConnectionDataChannelConnector } from './PeerConnectionDataChannelConnector';
+export { IPeerConnectionDataChannelEvent } from './PeerConnectionDataChannelEvent';
+export { IPeerConnectionHandshakeCandidate } from './PeerConnectionHandshakeCandidate';
+export { IPeerConnectionHandshakeCandidateEvent } from './PeerConnectionHandshakeCandidateEvent';
+export { IPeerConnectionHandshakeServer } from './PeerConnectionHandshakeServer';
+export { IPeerConnectionOfferOptions } from './PeerConnectionOfferOptions';
+export { IPeerConnectionSender } from './PeerConnectionSender';
+export { IPeerConnectionSenderMap } from './PeerConnectionSenderMap';
+export { IPeerConnectionSessionDescription } from './PeerConnectionSessionDescription';
+export { PeerConnectionStatsReport } from './PeerConnectionStatsReport';
+export { IPeerConnectionStatsReportInbound } from './PeerConnectionStatsReportInbound';
+export { IPeerConnectionStatsReportOutbound } from './PeerConnectionStatsReportOutbound';
+export { IPeerConnectionStatsReportRemoteInbound } from './PeerConnectionStatsReportRemoteInbound';
+export { IPeerConnectionStatsReportUnused } from './PeerConnectionStatsReportUnused';
+export { IPeerConnectionTrackEvent } from './PeerConnectionTrackEvent';

package/dist/core/connection/index.js

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

package/dist/core/index.d.ts

@@ -0,0 +1,5 @@
+export * from './cluster';
+export * from './connection';
+export * from './node';
+export * from './sdk';
+export * from './stream';

package/dist/core/index.js

@@ -0,0 +1,5 @@
+export * from './cluster';
+export * from './connection';
+export * from './node';
+export * from './sdk';
+export * from './stream';

package/dist/core/node/AuthNode.d.ts

@@ -0,0 +1,18 @@
+import { IAuthAgent } from './agent';
+import { IAuthUser } from './user';
+/**
+ * The authenticated node type.
+ * @category Core
+ */
+export type AuthNode = IAuthUser | IAuthAgent;
+/**
+ * The authenticated node interface.
+ * @category Core
+ */
+export interface IAuthNode {
+    /**
+     * Get the ID of the node.
+     * @returns The ID of the node.
+     */
+    getId(): string;
+}

package/dist/core/node/AuthNode.js

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

package/dist/core/node/LocalNode.d.ts

@@ -0,0 +1,7 @@
+import { ILocalAgent } from './agent';
+import { ILocalUser } from './user';
+/**
+ * The local node type.
+ * @category Core
+ */
+export type LocalNode = ILocalUser | ILocalAgent;

package/dist/core/node/LocalNode.js

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

package/dist/core/node/Node.d.ts

@@ -0,0 +1,23 @@
+import { IAgent } from './agent';
+import { IUser } from './user';
+/**
+ * The node interface.
+ * @category Core
+ */
+export interface INode {
+    /**
+     * Get the ID of the node.
+     * @returns The ID of the node.
+     */
+    getId(): string;
+    /**
+     * Get the remote connections.
+     * @returns The remote connections.
+     */
+    getRemoteConnections(): Set<string>;
+}
+/**
+ * The node type.
+ * @category Core
+ */
+export type Node = IUser | IAgent;

package/dist/core/node/Node.js

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

package/dist/core/node/NodeMetadata.d.ts

@@ -0,0 +1,7 @@
+import { IAgentMetadata } from './agent';
+import { IUserMetadata } from './user';
+/**
+ * The node meta data type.
+ * @category Core
+ */
+export type NodeMetadata = IUserMetadata | IAgentMetadata;

package/dist/core/node/NodeMetadata.js

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

package/dist/core/node/NodeType.d.ts

@@ -0,0 +1,14 @@
+/**
+ * The node type enum.
+ * @category Core
+ */
+export declare enum NodeType {
+    /**
+     * The user node type.
+     */
+    User = "user",
+    /**
+     * The agent node type.
+     */
+    Agent = "agent"
+}

package/dist/core/node/NodeType.js

@@ -0,0 +1,15 @@
+/**
+ * The node type enum.
+ * @category Core
+ */
+export var NodeType;
+(function (NodeType) {
+    /**
+     * The user node type.
+     */
+    NodeType["User"] = "user";
+    /**
+     * The agent node type.
+     */
+    NodeType["Agent"] = "agent";
+})(NodeType || (NodeType = {}));

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

@@ -0,0 +1,11 @@
+import { INode, NodeType } from '..';
+/**
+ * The agent interface.
+ * @category Core
+ */
+export interface IAgent extends INode {
+    /**
+     * The type of the node.
+     */
+    type: NodeType.Agent;
+}

package/dist/core/node/agent/Agent.js

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

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

@@ -0,0 +1,10 @@
+/**
+ * The agent credentials interface.
+ * @category Core
+ */
+export interface IAgentCredentials {
+    /**
+     * The agent group ID.
+     */
+    groupId: string;
+}

package/dist/core/node/agent/AgentCredentials.js

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

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

@@ -0,0 +1,11 @@
+import { NodeType } from '..';
+/**
+ * The agent meta data interface.
+ * @category Core
+ */
+export interface IAgentMetadata {
+    /**
+     * The type of the node.
+     */
+    type: NodeType.Agent;
+}

package/dist/core/node/agent/AgentMetadata.js

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

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

@@ -0,0 +1,11 @@
+import { IAuthNode, NodeType } from '..';
+/**
+ * The authenticated agent interface.
+ * @category Core
+ */
+export interface IAuthAgent extends IAuthNode {
+    /**
+     * The type of the node.
+     */
+    type: NodeType.Agent;
+}

package/dist/core/node/agent/AuthAgent.js

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

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

@@ -0,0 +1,7 @@
+import { IAgent } from '.';
+/**
+ * The local agent interface.
+ * @category Core
+ */
+export interface ILocalAgent extends IAgent {
+}

package/dist/core/node/agent/LocalAgent.js

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

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

@@ -0,0 +1,5 @@
+export { IAgent } from './Agent';
+export { IAgentCredentials } from './AgentCredentials';
+export { IAgentMetadata } from './AgentMetadata';
+export { IAuthAgent } from './AuthAgent';
+export { ILocalAgent } from './LocalAgent';

package/dist/core/node/agent/index.js

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

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

@@ -0,0 +1,7 @@
+export * from './agent';
+export * from './user';
+export { AuthNode, IAuthNode } from './AuthNode';
+export { LocalNode } from './LocalNode';
+export { INode, Node } from './Node';
+export { NodeMetadata } from './NodeMetadata';
+export { NodeType } from './NodeType';

package/dist/core/node/index.js

@@ -0,0 +1,3 @@
+export * from './agent';
+export * from './user';
+export { NodeType } from './NodeType';

package/dist/core/node/user/AuthUser.d.ts

@@ -0,0 +1,31 @@
+import { IAuthNode, NodeType } from '..';
+/**
+ * The authenticated user interface.
+ * @category Core
+ */
+export interface IAuthUser extends IAuthNode {
+    /**
+     * The type of the node.
+     */
+    type: NodeType.User;
+    /**
+     * Get the display name of the user.
+     * @returns The display name of the user.
+     */
+    getDisplayName(): string;
+    /**
+     * Get the email of the user.
+     * @returns The email of the user.
+     */
+    getEmail(): string;
+    /**
+     * Set the display name of the local user.
+     * @param displayName The display name to set.
+     */
+    setDisplayName(displayName: string): void;
+    /**
+     * Set the email of the local user.
+     * @param email The email to set.
+     */
+    setEmail(email: string): void;
+}

package/dist/core/node/user/AuthUser.js

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

package/dist/core/node/user/LocalUser.d.ts

@@ -0,0 +1,17 @@
+import { IUser } from '.';
+/**
+ * The local user interface.
+ * @category Core
+ */
+export interface ILocalUser extends IUser {
+    /**
+     * Set the display name of the local user.
+     * @param displayName The display name to set.
+     */
+    setDisplayName(displayName: string): void;
+    /**
+     * Set the email of the local user.
+     * @param email The email to set.
+     */
+    setEmail(email: string): void;
+}

package/dist/core/node/user/LocalUser.js

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

package/dist/core/node/user/User.d.ts

@@ -0,0 +1,21 @@
+import { INode, NodeType } from '..';
+/**
+ * The user interface.
+ * @category Core
+ */
+export interface IUser extends INode {
+    /**
+     * The type of the node.
+     */
+    type: NodeType.User;
+    /**
+     * Get the display name of the user.
+     * @returns The display name of the user.
+     */
+    getDisplayName(): string;
+    /**
+     * Get the email of the user.
+     * @returns The email of the user.
+     */
+    getEmail(): string;
+}

package/dist/core/node/user/User.js

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

package/dist/core/node/user/UserCredentials.d.ts

@@ -0,0 +1,18 @@
+/**
+ * The user credentials interface.
+ * @category Core
+ */
+export interface IUserCredentials {
+    /**
+     * The user ID.
+     */
+    id: string;
+    /**
+     * The user display name.
+     */
+    displayName: string;
+    /**
+     * The user email.
+     */
+    email: string;
+}

package/dist/core/node/user/UserCredentials.js

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

package/dist/core/node/user/UserMetadata.d.ts

@@ -0,0 +1,19 @@
+import { NodeType } from '..';
+/**
+ * The user meta data interface.
+ * @category Core
+ */
+export interface IUserMetadata {
+    /**
+     * The type of the node.
+     */
+    type: NodeType.User;
+    /**
+     * The display name of the user.
+     */
+    displayName: string;
+    /**
+     * The email of the user.
+     */
+    email: string;
+}

package/dist/core/node/user/UserMetadata.js

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

package/dist/core/node/user/index.d.ts

@@ -0,0 +1,5 @@
+export { IAuthUser } from './AuthUser';
+export { ILocalUser } from './LocalUser';
+export { IUser } from './User';
+export { IUserCredentials } from './UserCredentials';
+export { IUserMetadata } from './UserMetadata';

package/dist/core/node/user/index.js

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