uneeq-js 2.49.2 → 3.0.16-preview.6

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,90 +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;
-    /**
-     * 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 space separated list of phrases the speech recognition system should expect.
-     */
-    speechRecognitionHintPhrases?: string;
-    /**
-     * 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;
-}

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;
-}

package/dist/src/uneeq.d.ts

@@ -1,180 +0,0 @@
-import { BehaviorSubject } from 'rxjs';
-import { UneeqOptions } from './types/types';
-import { VoiceInputMode } from './types/VoiceInputMode';
-export declare class Uneeq {
-    /**
-     * The active session id as a string. If the session has not started yet value will be null
-     */
-    get sessionId(): string | null;
-    static onDataMessage: (msg: any) => void;
-    static onStatMessage: (stats: any) => void;
-    ready: BehaviorSubject<boolean>;
-    version: string;
-    private messages;
-    private internalMessages$;
-    private session;
-    private dhVideoPlayManager;
-    private api;
-    private messaging;
-    private sessionPaused;
-    private sessionStarted;
-    private deviceManager;
-    private messageHandler;
-    private voiceInputManager;
-    private unavailableAvatarMsgSent;
-    private speechHandler;
-    private readonly options;
-    private readonly messageCallback;
-    private readonly startSessionData;
-    private metricsService;
-    private sessionJwt;
-    private startSessionTime;
-    private availableResponseTime;
-    private streamManager;
-    private digitalHumanVideoElement;
-    private sessionWasResumed;
-    private uneeqLocalStorage;
-    private chatMetadata;
-    constructor(options: UneeqOptions);
-    setLoggerEnabled(enabled: boolean): void;
-    /**
-     * Initialise the session. ReadyMessage will be sent when init is ready.
-     */
-    init(): void;
-    /**
-     * Initialise the session. ReadyMessage will be sent when init is ready. initWithToken
-     * should be used instead of init() when a third party conversation service is used.
-     */
-    initWithToken(tokenId: string): Promise<void>;
-    /**
-     * Set a preferred camera to use in a live session. On success, SetCameraSuccessMessage
-     * will be sent. DeviceNotFoundErrorMessage will be sent when the requested device is not found.
-     * @param deviceId
-     */
-    setCamera(deviceId: string): void;
-    /**
-     * Set a preferred microphone to use in a live session. On success, SetMicSuccessMessage
-     * will be sent. DeviceNotFoundErrorMessage will be sent when the requested device is not found.
-     * @param deviceId
-     */
-    setMic(deviceId: string): void;
-    /**
-     * Set a preferred speaker to use in a live session. On success, SetSpeakerSuccessMessage
-     * will be sent. DeviceNotFoundErrorMessage will be sent when the requested device is not found.
-     * @param deviceId
-     */
-    setSpeaker(deviceId: string): void;
-    /**
-     * Set the microphone input mode to be used.
-     * @param mode PUSH_TO_TALK or VOICE_ACTIVITY
-     */
-    setVoiceInputMode(mode: VoiceInputMode): void;
-    /**
-     * Enable or disable the users microphone
-     * @param enable Defaults to true
-     */
-    enableMicrophone(enable?: boolean): void;
-    /**
-     * Enable or disable the users camera
-     * @param enable Defaults to true
-     */
-    enableCamera(enable?: boolean): void;
-    /**
-     * Enable or disable the users microphone and camera
-     * @param enable Defaults to true
-     */
-    enableMicrophoneAndCamera(enable?: boolean): void;
-    /**
-     * Set the custom field in chat metadata to a string value that will be sent
-     * to BYO NLPs with all chat calls like playWelcomeMessage and sendTranscript requests.
-     *
-     * @param customMetadata
-     */
-    setCustomChatMetadata(customMetadata: string): void;
-    /**
-     * Send a text based message to the avatar.
-     * @param text
-     */
-    sendTranscript(text: string): void;
-    getServerStats(): void;
-    /**
-     * Start Recording voice audio through microphone. Call this method before using voice to speak to avatar.
-     * stopRecording should be called when finished speaking.
-     */
-    startRecording(): void;
-    /**
-     * Stop Recording voice audio through microphone. Call this method after startRecording has been called.
-     */
-    stopRecording(): void;
-    /**
-     * Stop the avatar from speaking. This will stop avatar speaking even if interrupts are turned off.
-     * When successful a corresponding AvatarRequestCompleted should be received.
-     */
-    stopSpeaking(): Promise<void>;
-    /**
-     * Pause speech recognition. The users speech will not be processed, or sent off their device.
-     * This is the equivilent of muting the users microphone.
-     */
-    pauseSpeechRecognition(): boolean;
-    /**
-     * Resume speech recognition. The users speech will being being processed again.
-     * This is the equivilent of unmuting the users microphone.
-     */
-    resumeSpeechRecognition(): boolean;
-    /**
-     * Pauses a live session. Local video and audio will stop being sent and remote avatar video audio will be stopped.
-     * On success, SessionPausedMessage will be sent.
-     */
-    pauseSession(): boolean;
-    /**
-     * Resumes a live session. Local video and audio will start being sent again and remote avatar video audio will be
-     * restarted. On success, SessionResumedMessage will be sent.
-     */
-    resumeSession(): boolean;
-    /**
-     * Ends the session, releases the microphone and camera and ends the avatar process. On success,
-     * SessionEndedMessage will be sent. On error, ErrorEndingSessionMessage will be sent.
-     */
-    endSession(): void;
-    /**
-     * Show Avatar Debugging
-     * @param enabled
-     */
-    setAvatarDebug(enabled: boolean): Promise<any>;
-    /**
-     * Trigger this conversation's welcome message
-     */
-    playWelcomeMessage(): Promise<void>;
-    unmuteDigitalHuman(): void;
-    private initDigitalHumanVideoElement;
-    private gatherWebRtcMetrics;
-    /**
-     * Initializes the real time messaging service. On ready, ReadyMessage will be sent.
-     */
-    private initMessaging;
-    private initDeviceManager;
-    private sessionLiveHandler;
-    private initAvatar;
-    private startAvatarWhenAvailable;
-    /**
-     * Initialize the session. Starts avatar process on server and initializes messaging.
-     */
-    private initialize;
-    /**
-     * Sends a service unavailable message to the client. On success, ServiceUnavailableMessage will be sent.
-     */
-    private sendServiceUnavailableMessage;
-    private serviceReadyCheck;
-    private checkWebRTCSupport;
-    /**
-     * Initialise online status update messages
-     */
-    private initOnlineStatusUpdateMessages;
-    private initPromMetricsListener;
-    /**
-     * Check if resume session functionality is available (localStorage is available)
-     * Warn implementer if unavailable
-     */
-    private checkIfResumeSessionIsAvailable;
-    private initChatMetadata;
-}