@ale-rainbow/web-sdk 5.1.0

package/lib/services/core/logging.service.d.ts

@@ -0,0 +1,51 @@
+/**
+ * @internal
+ */
+export declare const LOGGING_SVC = "LoggingService";
+export type LogLevel = "error" | "warn" | "info" | "debug" | "trace";
+interface LoggingData {
+    metadata?: Record<string, unknown>;
+}
+export interface LoggingEntry extends LoggingData {
+    type: LogLevel;
+    message: string;
+}
+export interface LoggingEvent {
+    LOG: LoggingEntry;
+}
+export type LoggingService = LoggingServiceRB;
+declare const LoggingServiceRB_base: object & (abstract new (...args: any[]) => import("../event-mixin").EventsMixinTemplate<LoggingEvent>);
+/**
+ * @internal
+ */
+export declare class LoggingServiceRB extends LoggingServiceRB_base {
+    static getInstance(): LoggingServiceRB;
+    /**
+     * @internal
+     */
+    static build(): LoggingServiceRB;
+    private constructor();
+    /**
+     * @internal
+     */
+    error(msg: string, data?: LoggingData): void;
+    /**
+     * @internal
+     */
+    warn(msg: string, data?: LoggingData): void;
+    /**
+     * @internal
+     */
+    info(msg: string, data?: LoggingData): void;
+    /**
+     * @internal
+     */
+    debug(msg: string, data?: LoggingData): void;
+    /**
+     * @internal
+     */
+    trace(msg: string, data?: LoggingData): void;
+}
+export declare function createBasicLogger(): import("rxjs").Subscription;
+export {};
+//# sourceMappingURL=logging.service.d.ts.map

package/lib/services/core/logging.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logging.service.d.ts","sourceRoot":"","sources":["../../../src/services/core/logging.service.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,eAAO,MAAM,WAAW,mBAAmB,CAAC;AAE5C,MAAM,MAAM,QAAQ,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,CAAC;AAErE,UAAU,WAAW;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACtC;AAED,MAAM,WAAW,YAAa,SAAQ,WAAW;IAC7C,IAAI,EAAE,QAAQ,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,YAAY;IACzB,GAAG,EAAE,YAAY,CAAC;CACrB;AAED,MAAM,MAAM,cAAc,GAAG,gBAAgB,CAAC;;AAE9C;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,qBAAkC;WACtD,WAAW;IAIzB;;OAEG;WACW,KAAK;IAInB,OAAO;IAIP;;OAEG;IACI,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,WAAW;IAQ5C;;OAEG;IACI,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,WAAW;IAQ3C;;OAEG;IACI,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,WAAW;IAQ3C;;OAEG;IACI,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,WAAW;IAQ5C;;OAEG;IACI,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,WAAW;CAc/C;AAED,wBAAgB,iBAAiB,gCAqBhC"}

package/lib/services/core/main.service.d.ts

@@ -0,0 +1,124 @@
+import type { Subscription } from "rxjs";
+import { BehaviorSubject, Subject } from "rxjs";
+import { Service } from "../../services/service";
+export declare const MAIN_SVC = "MainService";
+/**
+ * WAN Access Control (Edge) -- body returned by the debug simulation, identical to the one the
+ * server answers when it denies a session connecting from a non-approved (WAN) network.
+ *
+ * See `MainService.consumeWanAccessDeniedSimulation`.
+ */
+export declare const WAN_ACCESS_DENIED_SIMULATED_BODY: {
+    errorCode: number;
+    errorMsg: string;
+    errorDetails: string;
+    errorDetailsCode: number;
+    errorDetailsData: {
+        allowUserFromWan: boolean;
+    };
+};
+export declare class MainService extends Service {
+    appVisible: BehaviorSubject<boolean>;
+    appActive: BehaviorSubject<boolean>;
+    appActiveAutoAway: boolean;
+    private appActiveDelay;
+    private appActiveTimeout;
+    private appActiveListener;
+    appConnected: BehaviorSubject<boolean>;
+    appConnectivity: BehaviorSubject<boolean>;
+    private appConnectivityValue;
+    private appConnectivityTimeout;
+    private broadcastChannel;
+    broadcastChannelSubject: Subject<any>;
+    globalPopupMessageSubject: Subject<any>;
+    globalSubPopupMessageSubject: Subject<any>;
+    wanAccessDeniedSubject: Subject<any>;
+    authenticationInProgress: boolean;
+    private wanAccessDeniedNotified;
+    isIEBrowser: boolean;
+    isSafari: boolean;
+    isFirefox: boolean;
+    isDesktop: boolean;
+    teamsAppPaired: boolean;
+    apiHeadersConfiguration: any[];
+    iFrameAppConfig: {
+        appId: string;
+        referrer: string;
+    };
+    private logger;
+    static getInstance(): MainService;
+    static build(): MainService;
+    private constructor();
+    configure(centralizedService?: any, sdkConfig?: any): void;
+    private startTimer;
+    isDesktopApp(): boolean;
+    /**
+     * WAN Access Control (Edge) -- debug facility: tells whether the next call must be answered
+     * with a simulated denial, and consumes one unit of the simulation counter.
+     *
+     * The feature is enforced by the server on a Rainbow Edge only, so this allows the client
+     * behaviour (session termination and the message on the login page) to be exercised on any
+     * environment. Arm it from the browser console, then do any action in the application:
+     *     window.simulateWanAccessDenied = 5     // deny the next 5 calls
+     *     window.simulateWanAccessDenied = true  // same, defaults to 5
+     *
+     * Shared by the `window.fetch` wrapper and the AngularJS `$http` interceptor, so a single
+     * arming covers both transports (`fetch` for the app, `$http` for the admin REST services).
+     * It disarms itself so the login page that follows the termination keeps working.
+     *
+     * @param url - Called URL, for the log line only.
+     * @returns `true` when this call must be answered with a WAN denial.
+     */
+    consumeWanAccessDeniedSimulation(url: string): boolean;
+    /**
+     * Formats a URL for the HTTP traces, hiding the query parameters.
+     *
+     * The parameters may carry personal data, so they are replaced by a placeholder unless the
+     * `fullDebugMode` local storage flag is set.
+     *
+     * @param url - URL of the request.
+     * @returns The URL with its query string hidden, or complete in full debug mode.
+     */
+    formatUrlForLog(url: string): string;
+    /**
+     * Injects the Rainbow identification headers into an outgoing request to a Rainbow server.
+     *
+     * Sets `x-rainbow-client`, `x-rainbow-client-version` and `x-rainbow-correlation-id` (plus
+     * `x-rainbow-client-id` for an SDK application), the iFrame application headers when relevant,
+     * and finally any extra header declared through `apiHeadersConfiguration` for that URL.
+     *
+     * Used by the `window.fetch` wrapper, and by the AngularJS `$http` interceptor so the legacy
+     * transport carries the same identification and correlation information.
+     *
+     * @param headers - Header map of the request, modified in place.
+     * @param url - Target URL, used to match the `apiHeadersConfiguration` entries.
+     * @param method - HTTP method, used to match those entries. Defaults to `GET`.
+     */
+    applyRainbowRequestHeaders(headers: Record<string, any>, url: string, method?: string): void;
+    /**
+     * WAN Access Control -- reports that the server denied the established session because it
+     * connects from a non-approved (WAN) network, so it can be terminated.
+     *
+     * Notifies at most once per session: every in-flight call of a denied session answers 403944,
+     * and the AngularJS `$http` interceptor reports the same denial for the legacy transport.
+     * Called by the `window.fetch` wrapper and by that interceptor.
+     *
+     * @param errorDetailsData - `errorDetailsData` returned by the server, telling which policy denied the access.
+     */
+    notifyWanAccessDenied(errorDetailsData: any): void;
+    /**
+     * WAN Access Control -- tells whether the URL belongs to the pre-login endpoints.
+     *
+     * Those return the same 403944 when the login itself is denied, but that case belongs to the
+     * login page: terminating a session that does not exist yet would fire a logout underneath it.
+     */
+    private isPreLoginUrl;
+    broadcastChannelSubscribe(handler: any): Subscription;
+    postBroadcastChannelMessage(message: string): void;
+    showGlobalPopupMessage(popupMessageData: any): void;
+    hideGlobalPopupMessage(): void;
+    showSubGlobalPopupMessage(popupMessageData: any): void;
+    hideSubGlobalPopupMessage(): void;
+    inject<T = any>(serviceName: string): T | undefined;
+}
+//# sourceMappingURL=main.service.d.ts.map

package/lib/services/core/main.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"main.service.d.ts","sourceRoot":"","sources":["../../../src/services/core/main.service.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AACzC,OAAO,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAGhD,OAAO,EAAE,OAAO,EAAE,MAAM,uCAAuC,CAAC;AAGhE,eAAO,MAAM,QAAQ,gBAAgB,CAAC;AAEtC;;;;;GAKG;AACH,eAAO,MAAM,gCAAgC;;;;;;;;CAM5C,CAAC;AASF,qBAAa,WAAY,SAAQ,OAAO;IAE7B,UAAU,EAAE,eAAe,CAAC,OAAO,CAAC,CAAsC;IAG1E,SAAS,EAAE,eAAe,CAAC,OAAO,CAAC,CAAsC;IACzE,iBAAiB,EAAE,OAAO,CAAQ;IACzC,OAAO,CAAC,cAAc,CAAe;IACrC,OAAO,CAAC,gBAAgB,CAAa;IACrC,OAAO,CAAC,iBAAiB,CAAa;IAG/B,YAAY,EAAE,eAAe,CAAC,OAAO,CAAC,CAAuC;IAG7E,eAAe,EAAE,eAAe,CAAC,OAAO,CAAC,CAAuC;IACvF,OAAO,CAAC,oBAAoB,CAAkB;IAC9C,OAAO,CAAC,sBAAsB,CAAa;IAE3C,OAAO,CAAC,gBAAgB,CAAmB;IACpC,uBAAuB,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;IACtC,yBAAyB,EAAE,OAAO,CAAC,GAAG,CAAC,CAAQ;IAC/C,4BAA4B,EAAE,OAAO,CAAC,GAAG,CAAC,CAAQ;IAIlD,sBAAsB,EAAE,OAAO,CAAC,GAAG,CAAC,CAAsB;IAI1D,wBAAwB,EAAE,OAAO,CAAS;IAGjD,OAAO,CAAC,uBAAuB,CAAkB;IAC1C,WAAW,EAAE,OAAO,CAAC;IACrB,QAAQ,EAAE,OAAO,CAAC;IAClB,SAAS,EAAE,OAAO,CAAC;IACnB,SAAS,EAAE,OAAO,CAAC;IACnB,cAAc,EAAE,OAAO,CAAS;IAChC,uBAAuB,QAAM;IAE7B,eAAe;;;MAGpB;IAEF,OAAO,CAAC,MAAM,CAA8C;WAE9C,WAAW;WAIX,KAAK;IAInB,OAAO;IA8NA,SAAS,CAAC,kBAAkB,GAAE,GAAU,EAAE,SAAS,GAAE,GAAU,GAAG,IAAI;IAe7E,OAAO,CAAC,UAAU;IAOX,YAAY;IAKnB;;;;;;;;;;;;;;;;OAgBG;IACI,gCAAgC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAU7D;;;;;;;;OAQG;IACI,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM;IAM3C;;;;;;;;;;;;;OAaG;IACI,0BAA0B,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI;IA2CnG;;;;;;;;;OASG;IACI,qBAAqB,CAAC,gBAAgB,EAAE,GAAG,GAAG,IAAI;IAOzD;;;;;OAKG;IACH,OAAO,CAAC,aAAa;IAKd,yBAAyB,CAAC,OAAO,EAAE,GAAG,GAAG,YAAY;IAIrD,2BAA2B,CAAC,OAAO,EAAE,MAAM;IAI3C,sBAAsB,CAAC,gBAAgB,EAAE,GAAG;IAI5C,sBAAsB;IAItB,yBAAyB,CAAC,gBAAgB,EAAE,GAAG;IAI/C,yBAAyB;IAIzB,MAAM,CAAC,CAAC,GAAG,GAAG,EAAE,WAAW,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS;CAQ7D"}

package/lib/services/core/presenceHelper.service.d.ts

@@ -0,0 +1,73 @@
+import { Service } from "../../services/service";
+import type { Subscription } from "rxjs";
+export declare const PRESENCE_HELPER_SVC = "PresenceHelperService";
+/**
+ * @public
+ * @description PresenceHelperService Events.
+ */
+export declare enum PresenceHelperServiceEvents {
+    /**
+     * @event RECONNECT_PRESENCE_SENT
+     * @description This RB event is send after reconnection, when the initial presence is being send to xmpp (we consider that the client is now fully connected)
+     */
+    RECONNECT_PRESENCE_SENT = "RECONNECT_PRESENCE_SENT",
+    /**
+     * @event ALL_CALLS_ENDED
+     * @description This RB event is send when all calls are ended
+     */
+    ALL_CALLS_ENDED = "ALL_CALLS_ENDED"
+}
+export declare class PresenceHelperService extends Service {
+    private mainService;
+    private logger;
+    private contactService;
+    private eventService;
+    private webinarService?;
+    private webrtcP2PService?;
+    private webConferenceService?;
+    private webrtcConfigAndUtils?;
+    private eventListeners;
+    private rxSubject;
+    static getInstance(): PresenceHelperService;
+    static build(): PresenceHelperService;
+    /**
+     * @public
+     * @function subscribe
+     * @instance
+     * @description
+     *    Subscribe to updates on the current calls sessions (all events are of RBEvent type {name: string, data:any});
+     *    All public events that are fired by this service are described in the documentation.
+     *    NB There might be some events that are not documented here, they should be ignored
+     * @param {any} handler The call-back function that will be subscribed to the RxJS subject
+     * @returns {Subscription} Returns RxJS Subscription
+     */
+    subscribe(handler: any): Subscription;
+    private constructor();
+    start(): Promise<void>;
+    stop(): void;
+    resendPresenceAfterReconnect(): void;
+    resetBusyStateIfNeeded(): void;
+    /**
+     * Checks whether the user is currently engaged in any active call session on this device.
+     *
+     * Covers WebRTC peer-to-peer calls, web conference (v2) sessions, and webinar sessions.
+     * Does **not** account for PBX calls in office mode.
+     *
+     * @param exception - Optional call type to exclude from the check. When provided, the
+     *   corresponding session type is ignored even if it is active:
+     *   - `'p2p'` — ignore active WebRTC P2P calls
+     *   - `'conference'` — ignore active web conference sessions
+     *   - `'webinar'` — ignore active webinar sessions
+     * @returns `true` if the user is in at least one active session (after applying the
+     *   exclusion), `false` otherwise.
+     *
+     * @example
+     * // Returns true if the user is in any kind of call
+     * if (presenceHelperService.isUserCurrentlyInCall()) \{ ... \}
+     *
+     * // Returns true even if the user is only in a webinar (conference is excluded)
+     * if (presenceHelperService.isUserCurrentlyInCall('conference')) \{ ... \}
+     */
+    isUserCurrentlyInCall(exception?: "p2p" | "conference" | "webinar"): boolean;
+}
+//# sourceMappingURL=presenceHelper.service.d.ts.map

package/lib/services/core/presenceHelper.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"presenceHelper.service.d.ts","sourceRoot":"","sources":["../../../src/services/core/presenceHelper.service.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,OAAO,EAAE,MAAM,uCAAuC,CAAC;AAWhE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAIzC,eAAO,MAAM,mBAAmB,0BAA0B,CAAC;AAE3D;;;GAGG;AACH,oBAAY,2BAA2B;IACnC;;;OAGG;IACH,uBAAuB,4BAA4B;IAEnD;;;OAGG;IACH,eAAe,oBAAoB;CACtC;AAED,qBAAa,qBAAsB,SAAQ,OAAO;IAC9C,OAAO,CAAC,WAAW,CAA6B;IAChD,OAAO,CAAC,MAAM,CAA8C;IAC5D,OAAO,CAAC,cAAc,CAAgD;IACtE,OAAO,CAAC,YAAY,CAA4C;IAChE,OAAO,CAAC,cAAc,CAAC,CAA+B;IACtD,OAAO,CAAC,gBAAgB,CAAC,CAA+B;IACxD,OAAO,CAAC,oBAAoB,CAAC,CAAwC;IACrE,OAAO,CAAC,oBAAoB,CAAC,CAAmC;IAChE,OAAO,CAAC,cAAc,CAAW;IACjC,OAAO,CAAC,SAAS,CAA4C;WAE/C,WAAW;WAIX,KAAK;IAInB;;;;;;;;;;OAUG;IACI,SAAS,CAAC,OAAO,EAAE,GAAG,GAAG,YAAY;IAI5C,OAAO;IAEM,KAAK;IAeX,IAAI;IAOJ,4BAA4B,IAAI,IAAI;IAepC,sBAAsB,IAAI,IAAI;IAiBrC;;;;;;;;;;;;;;;;;;;;OAoBG;IACI,qBAAqB,CAAC,SAAS,CAAC,EAAE,KAAK,GAAG,YAAY,GAAG,SAAS,GAAG,OAAO;CAWtF"}