uneeq-js 2.55.0 → 3.0.16-preview.8

package/dist/src/service/digital-human-video-play-manager.d.ts

@@ -1,13 +0,0 @@
-import { Subject } from 'rxjs';
-export declare class DigitalHumanVideoPlayManager {
-    private messages;
-    private publicUnmuteDigitalHumanMethod;
-    private video;
-    private remoteVideoPlayCount;
-    constructor(messages: Subject<any>, publicUnmuteDigitalHumanMethod: () => void);
-    play(video: HTMLVideoElement): void;
-    unmuteVideo(): void;
-    private playRemoteVideo;
-    private digitalHumanFailedToPlayUnmuted;
-    private playRemoteVideoWithExponentialBackoff;
-}

package/dist/src/service/locale-detector.d.ts

@@ -1,14 +0,0 @@
-import { UneeqOptions } from '../types/types';
-export declare class LocaleDetector {
-    /**
-     * Validates that one or more colon-separated locales is supplied
-     * If none supplied, detects the user's browser language preferences
-     *
-     * @param UneeqOptions
-     * @returns a colon separated string of locales (language tags)
-     */
-    static validateOrDetectSpeechLocales(options: UneeqOptions): string;
-    private static defaultLocale;
-    private static localeMappings;
-    private static sttSupportedLocales;
-}

package/dist/src/service/logger.d.ts

@@ -1,23 +0,0 @@
-interface LoggerInterface {
-    debug(primaryMessage: string, ...supportingData: any[]): void;
-    warn(primaryMessage: string, ...supportingData: any[]): void;
-    error(primaryMessage: string, ...supportingData: any[]): void;
-    log(primaryMessage: string, ...supportingData: any[]): void;
-}
-export declare enum LogType {
-    debug = "debug",
-    log = "log",
-    warn = "warn",
-    error = "error"
-}
-export declare class Logger implements LoggerInterface {
-    enabled: boolean;
-    constructor();
-    log(msg: string, ...supportingDetails: any[]): void;
-    warn(msg: string, ...supportingDetails: any[]): void;
-    error(msg: string, ...supportingDetails: any[]): void;
-    debug(msg: string, ...supportingDetails: any[]): void;
-    private emitLogMessage;
-}
-export declare const logger: Logger;
-export {};

package/dist/src/service/media-handler.d.ts

@@ -1,26 +0,0 @@
-import { BehaviorSubject } from 'rxjs';
-import { PublishSubscribeState } from '../types/PublishSubscribeState';
-import { DeviceManagerOptions } from './device-manager';
-export declare class MediaHandler {
-    private options;
-    private remoteVideoReady;
-    remoteStream$: BehaviorSubject<any>;
-    avatarVideoElement: HTMLVideoElement;
-    localStream$: BehaviorSubject<any>;
-    publishState$: BehaviorSubject<PublishSubscribeState>;
-    localVideoElement: HTMLVideoElement;
-    publishingStream: boolean;
-    private webRTC?;
-    constructor(options: DeviceManagerOptions, remoteVideoReady: () => void);
-    setEdgeNodeId(edgeNodeId: string): void;
-    unpublishVideo(): void;
-    pause(): void;
-    resume(): void;
-    stopAllLocalStreams(): void;
-    endSession(): void;
-    sendDataMessage(msg: string): void;
-    gatherWebRTCStats(callback: any): void;
-    private publishVideo;
-    private performWebRTCConnection;
-    private initTransparentBackground;
-}

package/dist/src/service/message-handler.d.ts

@@ -1,14 +0,0 @@
-import { Subject } from 'rxjs';
-import { DeviceManager } from './device-manager';
-export declare class MessageHandler {
-    private internalMessages$;
-    private messages;
-    private deviceManager;
-    constructor(internalMessages$: Subject<any>, messages: Subject<any>);
-    setDeviceManager(deviceManager: DeviceManager): void;
-    /**
-     * Returns an observable you can subscribe to in order to handle messages
-     * @param faceMeMessageType The message type you want to handle
-     */
-    private getMessagesOfType;
-}

package/dist/src/service/messaging/index.d.ts

@@ -1,6 +0,0 @@
-import { Message } from './message';
-import { MessagingClient } from './messaging-client';
-import { MessagingOptions } from './messaging-options';
-import { MessagingService } from './messaging-service';
-import { MessagingState } from './messaging-state';
-export { MessagingService, MessagingClient, MessagingOptions, MessagingState, Message };

package/dist/src/service/messaging/message.d.ts

@@ -1,3 +0,0 @@
-export interface Message {
-    body: any;
-}

package/dist/src/service/messaging/messaging-client.d.ts

@@ -1,4 +0,0 @@
-export interface MessagingClient {
-    _subscribe: () => void;
-    dumpSubscriptions: () => void;
-}

package/dist/src/service/messaging/messaging-options.d.ts

@@ -1,22 +0,0 @@
-/**
- * MessagingOptions
- *  onDisconnect = Function to call on disconnect
- *  onConnect = Function to call on connect
- *  onReconnect = Function to call for each reconnect
- *  autoReconnect = Whether to automatically reconnect.
- *  reconnectTime = The time to wait before reconnecting
- *  maxReconnectAttempts = Maximum amount of reconnection attempts before manual reconnection required.
- *  maxReconnectLimitReached = Function to call when maximum automatic reconnect limit reached.
- *  connectionHeaders = Any additional headers for the connection.
- */
-interface MessagingOptions {
-    onDisconnect?: () => void;
-    onConnect?: () => void;
-    onReconnect?: () => void;
-    autoReconnect?: boolean;
-    reconnectTime?: number;
-    maxReconnectAttempts?: number;
-    connectionHeaders?: any;
-    maxReconnectLimitReached?: () => void;
-}
-export { MessagingOptions };

package/dist/src/service/messaging/messaging-service.d.ts

@@ -1,21 +0,0 @@
-import { BehaviorSubject, Subject } from 'rxjs';
-import { Message } from './message';
-import { MessagingOptions } from './messaging-options';
-import { MessagingState } from './messaging-state';
-export declare class MessagingService {
-    state$: BehaviorSubject<MessagingState>;
-    messages$: Subject<Message>;
-    private url;
-    private readonly options;
-    private stompClient;
-    private connectionAttempts;
-    private subscriptions;
-    constructor(url: string, _options: MessagingOptions);
-    connect(): void;
-    disconnect(): void;
-    send(endpoint: string, message: any): void;
-    getTopic(topic: string): Subject<any>;
-    private onStompConnected;
-    private onStompClientConnectionClosed;
-    private initMessagingSubscription;
-}

package/dist/src/service/messaging/messaging-state.d.ts

@@ -1,5 +0,0 @@
-export declare enum MessagingState {
-    DISCONNECTED = 0,
-    CONNECTING = 1,
-    CONNECTED = 2
-}

package/dist/src/service/metrics-service.d.ts

@@ -1,13 +0,0 @@
-import { Subject } from 'rxjs';
-import { UneeqOptions } from '..';
-export declare class MetricsService {
-    private uneeqOptions;
-    private internalMessages;
-    private messages;
-    private clientPerformanceStats;
-    private options;
-    private internalMessages$;
-    private messages$;
-    constructor(uneeqOptions: UneeqOptions, internalMessages: Subject<any>, messages: Subject<any>);
-    parseAndLogWebRtcStats(stats: any): void;
-}

package/dist/src/service/online-status-service.d.ts

@@ -1,12 +0,0 @@
-import { Subject } from 'rxjs';
-export declare class OnlineStatusService {
-    private messages;
-    private offlineTimeoutLimitHandler;
-    online: boolean;
-    private offlineDisconnectTimeLimitMS;
-    private disconnectTimer;
-    constructor(messages: Subject<any>, offlineTimeoutLimitHandler: () => void);
-    private handleOffline;
-    private handleOnline;
-    private sendStatusUpdate;
-}

package/dist/src/service/prom.d.ts

@@ -1,38 +0,0 @@
-import { Counter } from 'promjs/counter';
-import { Histogram } from 'promjs/histogram';
-import { Registry } from 'promjs/registry';
-export declare enum PromMessageType {
-    SessionStart = 0,
-    WebRtcPerformance = 1,
-    AvailabilityCheck = 2,
-    QuestionMessageReceived = 3,
-    AnswerMessageReceived = 4,
-    SessionEnded = 5
-}
-export interface PromMessage {
-    type: PromMessageType;
-    labels?: any;
-    value?: any;
-}
-export declare class Prom {
-    private apiUrl;
-    prom_prefix: string;
-    registry: Registry;
-    messageTimings: any;
-    metricsPushedCounter: Counter;
-    sessionStartTime: Histogram;
-    availabilityCheckTime: Histogram;
-    webRtcInboundRTT: Histogram;
-    webRtcInboundFramesPerSec: Histogram;
-    webRtcInboundPacketsLost: Histogram;
-    webRtcFramesDropped: Histogram;
-    webRtcFrameHeight: Histogram;
-    webRtcFrameWidth: Histogram;
-    conversationRoundTripTime: Histogram;
-    private metricsIntervalId;
-    constructor(apiUrl: string);
-    handleMessage(msg: PromMessage): void;
-    calculateConversationRtt(msg: PromMessage): number;
-    sendMetrics(): void;
-    private stopSendingMetrics;
-}

package/dist/src/service/resume-session-check.d.ts

@@ -1,6 +0,0 @@
-import { ResumeSessionCheckResponse } from '../types/ResumeSessionCheckResponse';
-import { UneeqOptions } from '../types/UneeqOptions';
-export declare class ResumeSessionCheck {
-    static validate(options: UneeqOptions): ResumeSessionCheckResponse;
-    static browserTabIsActive(): boolean;
-}

package/dist/src/service/stream-manager.d.ts

@@ -1,13 +0,0 @@
-export declare class StreamManager {
-    private readonly silentAudioTrack;
-    private readonly canvasVideoTrack;
-    private audioContextInstance?;
-    private audioSourceNode?;
-    private audioSourceDestination?;
-    constructor();
-    addCanvasVideoTrackToStream(stream: MediaStream): MediaStream;
-    addSilentAudioTrackToStream(stream: MediaStream): MediaStream;
-    resumeAudioContext(): void;
-    private generateCanvasVideoTrack;
-    private generateSilentAudioTrack;
-}

package/dist/src/service/uneeq-local-storage.d.ts

@@ -1,9 +0,0 @@
-export declare class UneeqLocalStorage {
-    private localStorageAvailable?;
-    constructor();
-    get available(): boolean;
-    setItemSafely(key: string, value: string): void;
-    getItemSafely(key: string): any;
-    removeItemSafely(key: string): void;
-    private checkIfLocalStorageAvailable;
-}

package/dist/src/service/uneeq-webrtc.d.ts

@@ -1,66 +0,0 @@
-import { Subject } from 'rxjs';
-import { UneeqMessage } from '..';
-import { MessagingService } from './messaging';
-/**
- * Uneeq WebRTC implementation which hides the complexity of making a WebRTC call.
- */
-export declare class UneeqWebRTC {
-    private client;
-    private readonly uniqueId;
-    private readonly options;
-    private readonly fakeDataChannel;
-    private statTimer?;
-    private readonly MESSAGING_ENDPOINT;
-    constructor(options: UneeqWebRTCOptions);
-    /**
-     * Start a connection with the given streams.
-     */
-    connect(stream: MediaStream): void;
-    /**
-     * Close the connection.
-     */
-    close(): void;
-    /**
-     * Handle the WebRTC answer message
-     * @return boolean true if we handled this
-     */
-    handleAnswerMessage(msg: any): boolean;
-    /**
-     * Handle the ice candidate message.
-     * @return boolean true if we handled this
-     */
-    handleIceCandidate(msg: any): boolean;
-    sendDataMessage(message: string): void;
-    getStats(callback: any): any;
-    updateStreamTracks(stream: MediaStream): void;
-    private onStats;
-    private enableDiagnostics;
-    private isMessageForUs;
-    /**
-     * Log a message to the console. This will prepend our UneeqWebRTC prefix.
-     */
-    private log;
-    /**
-     * Log a message to the console as a warning. This will prepend our UneeqWebRTC prefix.
-     */
-    private warn;
-}
-/**
- * The options for the WebRTC class.
- * Note: this isn't an interface so that we can have default values.
- */
-export interface UneeqWebRTCOptions {
-    messaging: MessagingService;
-    userMessages: Subject<UneeqMessage>;
-    edgeNodeId: string;
-    publishStreamName: string;
-    subscribeStreamName: string;
-    iceServers?: RTCIceServer[];
-    forceTurnServerUse?: boolean;
-    diagnostics?: boolean;
-    onAddStream?: (stream: any) => void;
-    onConnect?: () => void;
-    onData?: (data: any) => void;
-    onClose?: () => void;
-    onError?: (error: any) => void;
-}

package/dist/src/service/voice-input-manager.d.ts

@@ -1,35 +0,0 @@
-import { Subject } from 'rxjs';
-import { UneeqOptions } from '../types/UneeqOptions';
-import { VoiceInputMode } from '../types/VoiceInputMode';
-import { API } from './api';
-export declare class VoiceInputManager {
-    private options;
-    private api;
-    private messages;
-    private enableMicrophone;
-    private readonly microphoneEngageVolume;
-    private readonly microphoneDisengageVolume;
-    private readonly voiceActivityNotSpeakingTimeoutMS;
-    private readonly voiceActivityAllowInterruptions;
-    private soundMeter;
-    private audioContext;
-    private digitalHumanSpeaking;
-    private recording;
-    private silenceTimeout?;
-    private stream?;
-    constructor(options: UneeqOptions, api: API, messages: Subject<any>, enableMicrophone: (enabled: boolean) => void);
-    setVoiceInputMode(mode: VoiceInputMode | string): void;
-    startRecording(): void;
-    stopRecording(): void;
-    handleSessionEnd(): void;
-    resumeAudioContext(): void;
-    initMicActivity(stream: MediaStream): void;
-    private audioContextNotSupported;
-    private handleAppMessages;
-    private requestNotSupportedInVoiceActivityMode;
-    private apiStartRecording;
-    private apiStopRecording;
-    private micActivityConnected;
-    private handleVoiceActivity;
-    private clearSilenceTimeout;
-}

package/dist/src/types/AvatarAvailableCountResponse.d.ts

@@ -1,3 +0,0 @@
-export interface AvatarAvailableCountResponse {
-    available: number;
-}

package/dist/src/types/ChatMetadata.d.ts

@@ -1,9 +0,0 @@
-export interface ChatMetadata {
-    userSpokenLocale?: string;
-    browserDetectedLocales?: string;
-    userTimezone?: string;
-    userScreenWidth?: number;
-    userScreenHeight?: number;
-    userAgent?: string;
-    custom?: string;
-}

package/dist/src/types/ClientPerformanceStats.d.ts

@@ -1,16 +0,0 @@
-export interface ClientPerformanceStats {
-    inboundRoundTripTime?: ClientPerformanceStat;
-    inboundNewPacketsLost?: ClientPerformanceStat;
-    inboundTotalPacketsLost?: ClientPerformanceStat;
-    outboundQualityLimitationReason?: ClientPerformanceStat;
-    newFramesDropped?: ClientPerformanceStat;
-    totalFramesDropped?: ClientPerformanceStat;
-    framesPerSec?: ClientPerformanceStat;
-    frameHeight?: ClientPerformanceStat;
-    frameWidth?: ClientPerformanceStat;
-}
-export declare class ClientPerformanceStat {
-    readonly label: string;
-    readonly value: any;
-    constructor(label?: string, value?: any);
-}

package/dist/src/types/Devices.d.ts

@@ -1,5 +0,0 @@
-export interface Devices {
-    audioInput: MediaDeviceInfo[];
-    audioOutput: MediaDeviceInfo[];
-    videoInput: MediaDeviceInfo[];
-}

package/dist/src/types/FaceMeMessage.d.ts

@@ -1,3 +0,0 @@
-export interface FaceMeMessage {
-    faceMeMessageType: string;
-}

package/dist/src/types/LogoDimensions.d.ts

@@ -1,6 +0,0 @@
-export interface LogoDimensions {
-    width: number;
-    height: number;
-    dx: number;
-    dy: number;
-}

package/dist/src/types/LogoMargin.d.ts

@@ -1,5 +0,0 @@
-export interface LogoMargin {
-    left: number;
-    top: number;
-    bottom: number;
-}

package/dist/src/types/MediaUnavailableRequest.d.ts

@@ -1,5 +0,0 @@
-export interface MediaUnavailableRequest {
-    audioInputs: number;
-    videoInputs: number;
-    hasUserDeniedPermission: boolean;
-}

package/dist/src/types/NewSessionRequest.d.ts

@@ -1,19 +0,0 @@
-export interface NewSessionRequest {
-    sessionType: SessionType;
-    workspaceName: string;
-    customData?: NewSessionCustomData;
-    sdkVersion: string;
-    tokenId?: string;
-    clientWidth?: number;
-    clientHeight?: number;
-    resumeSessionId?: string;
-}
-interface NewSessionCustomData {
-    additionalProp1: string;
-    additionalProp2: string;
-    additionalProp3: string;
-}
-export declare enum SessionType {
-    WEB = 0
-}
-export {};

package/dist/src/types/NewSessionResponse.d.ts

@@ -1,15 +0,0 @@
-export interface NewSessionResponse {
-    avatarStreamId: string;
-    enableWebRTC: true;
-    forceTurnServerUse: true;
-    id: string;
-    name: string;
-    sensitiveData: true;
-    streamId: string;
-    turnServerAddresses: string[];
-    turnUsername: string;
-    turnPassword: string;
-    edgeNodeId?: string;
-    sourceApp?: string;
-    showUneeqLogo: boolean;
-}

package/dist/src/types/PersonaStartRequest.d.ts

@@ -1,7 +0,0 @@
-export interface PersonaStartRequest {
-    enableTransparentBackground?: boolean;
-    resumeSession?: boolean;
-    backgroundImageUrl?: string;
-    nameTagImageUrl?: string;
-    speechToTextLocales?: string;
-}

package/dist/src/types/PublishSubscribeState.d.ts

@@ -1,6 +0,0 @@
-export declare enum PublishSubscribeState {
-    DISCONNECTED = "DISCONNECTED",
-    CONNECTING = "CONNECTING",
-    CONNECTED = "CONNECTED",
-    FAILED = "FAILED"
-}

package/dist/src/types/ResumeSessionCheckResponse.d.ts

@@ -1,4 +0,0 @@
-export interface ResumeSessionCheckResponse {
-    resumeSession: boolean;
-    resumeSessionId?: string;
-}

package/dist/src/types/SourceApp.d.ts

@@ -1,7 +0,0 @@
-export declare enum SourceApp {
-    HOSTED_EXPERIENCE = "HOSTED_EXPERIENCE",
-    SHOWCASE = "SHOWCASE",
-    SPLIT_SCREEN = "SPLIT_SCREEN",
-    INTERACTIONS = "INTERACTIONS",
-    UNKNOWN = "UNKNOWN"
-}

package/dist/src/types/UneeqOptions.d.ts

@@ -1,108 +0,0 @@
-import { VoiceInputMode } from './VoiceInputMode';
-export interface UneeqOptions {
-    /** Server URL to connect to. */
-    url: string;
-    /** The API Key to access the Uneeq service. */
-    apiKey?: string;
-    /** The div element that the avatars video should be placed inside. */
-    avatarVideoContainerElement: HTMLDivElement;
-    /** The div element that the local video should be placed inside. */
-    localVideoContainerElement: HTMLDivElement;
-    /** Uneeq conversation ID to use for the session. */
-    conversationId: string;
-    /**
-     * @ignore
-     */
-    customData?: any;
-    /** Provide a function to be used for message handler call backs. */
-    messageHandler?: (msg: any) => void;
-    /** Whether you want to receive mic activity messages or not. Default value is false. */
-    micActivityMessages?: boolean;
-    /** Device ID of the preferred microphone to start the session with. */
-    preferredMicrophoneId?: string;
-    /** Device ID of the preferred camera to start the session with. */
-    preferredCameraId?: string;
-    /** Device ID of the preferred speaker to start the session with. */
-    preferredSpeakerId?: string;
-    /** Enable Logging. Default value is false. */
-    logging?: boolean;
-    /** Play Welcome Message. Default value is false. */
-    playWelcome?: boolean;
-    /** Enable diagnostic callbacks. Default value is false. */
-    diagnostics?: boolean;
-    /** Whether the users local video stream (camera) should be sent on session start. Default value is true. */
-    sendLocalVideo?: boolean;
-    /** Whether the users local audio stream (microphone) should be sent on session start. Default value is true. */
-    sendLocalAudio?: boolean;
-    /**
-     * This option controls the visibility of client-side network performance messages in the developer console.
-     * These WebRTC statistics (eg packetsLost, framesDropped, framesPerSec) help identify if session quality is being
-     * impacted by client-side conditions.
-     * Irrespective of this visibility setting, UneeQ's servers receive these messages to help measure platform
-     * performance and stability for end users.
-     */
-    enableClientPerformanceMessage?: boolean;
-    /**
-     * This option controls whether the Digital Human is rendered with a transparent background,
-     * allowing them to be overlaid on top of your experience.
-     * If true, the digital human's configured background image will be replaced with a transparent background.
-     * If false, your configured background image will be displayed. Defaults to false.
-     */
-    enableTransparentBackground?: boolean;
-    /**
-     * This option specifies what the default voice input mode will be.
-     */
-    voiceInputMode: VoiceInputMode | string;
-    /**
-     * This option specifies whether VAD should be used when voiceInputMode is set to SPEECH_RECOGNITION.
-     * If set to false, then pauseSpeechRecognition and resumeSpeechRecognition must be called to capture the users audio.
-     * If set to true, or omitted, then the users audio will be captured automatically.
-     */
-    enableVad?: boolean;
-    /**
-     * Resume user session if available.
-     */
-    resumeSession?: boolean;
-    /**
-     * This option specifies the URL of the background image to be used when the digital human is rendered.
-     */
-    backgroundImageUrl?: string;
-    /**
-     * This option specifies the URL of the name tag image to be used when the digital human is rendered.
-     */
-    nameTagImageUrl?: string;
-    /**
-     * This option specifies up to four locales that the Digital Human should understand a person speaking (speech recognition)
-     * The locales are specified in the BCP-47 format e.g "en-US".
-     * The first locale is considered the primary locale.
-     * Locales should be separated with a colon e.g "en-US:en-GB:en-AU".
-     */
-    speechToTextLocales?: string;
-    /**
-     * Override the asset base path.
-     */
-    assetBasePath?: string;
-    /**
-     * Speech Recognition Hint Phrases
-     * A comma separated list of phrases the speech recognition system should expect.
-     */
-    speechRecognitionHintPhrases?: string;
-    /**
-     * Speech Recognition Hint Phrases Boost
-     * An integer number between 0 and 20 that can be used to boost the hint phrases likely hood to match.
-     */
-    speechRecognitionHintPhrasesBoost?: number;
-    /**
-     * Custom Metadata
-     * A stringified value that will be sent to BYO NLPs with all chat calls like playWelcomeMessage and sendTranscript requests.
-     * This can be set to any stringified value.
-     */
-    customMetadata?: string;
-    /**
-     * Enable Interrupt By Speech
-     * When using SPEECH_RECOGNITION mode, this option will allow the user to interrupt the Digital Human by speaking over them.
-     * If this value is false, the Digital Human will not be interrupted by the user. The default value is false - users cannot
-     * interrupt the Digital Human. Note: Sending a text message will interrupt the digital human irrespective of this setting.
-     */
-    enableInterruptBySpeech?: boolean;
-}

package/dist/src/types/VoiceInputMode.d.ts

@@ -1,5 +0,0 @@
-export declare enum VoiceInputMode {
-    PUSH_TO_TALK = "PUSH_TO_TALK",
-    VOICE_ACTIVITY = "VOICE_ACTIVITY",
-    SPEECH_RECOGNITION = "SPEECH_RECOGNITION"
-}

package/dist/src/types/types.d.ts

@@ -1,2 +0,0 @@
-export { UneeqOptions } from './UneeqOptions';
-export { Devices } from './Devices';

package/dist/src/typings.d.ts

@@ -1,4 +0,0 @@
-import * as _Uneeq from './index';
-declare global {
-    const Uneeq: typeof _Uneeq;
-}