@ale-rainbow/web-sdk 5.1.0

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

@@ -0,0 +1,209 @@
+/**
+ * Connection service
+ * @module Connection
+ */
+import { RBEvent } from "../../models/event.model";
+import type { Subscription } from "rxjs";
+import { Service } from "../../services/service";
+import type { ConnectedUser } from "../../models";
+import type { MaybeArray } from "date-fns";
+import type { Builder } from "strophe.js";
+/** @internal */
+export declare const CONNECTION_SVC = "ConnectionService";
+export declare enum ConnectionStateEnum {
+    NONE = "NONE",
+    CONNECTING = "CONNECTING",
+    CONNECTED = "CONNECTED",
+    RECONNECTING = "RECONNECTING",
+    DISCONNECTED = "DISCONNECTED"
+}
+export declare enum DisconnectionReasonEnum {
+    UNLOGGED = "UNLOGGED",
+    NO_NETWORK = "NO_NETWORK",
+    CHANGE_PWD_ERROR = "CHANGE_PWD_ERROR",
+    THIRD_PARTY_CHANGE_PWD = "3RD_PARTY_CHANGE_PWD",
+    AUTH_TOKEN_EXPIRE = "TOKEN_EXPIRE"
+}
+export declare enum ConnectionTokenState {
+    AUTH_TOKEN_WILL_EXPIRE = "AUTH_TOKEN_WILL_EXPIRE",
+    AUTH_TOKEN_RENEW = "AUTH_TOKEN_RENEW"
+}
+export declare class ConnectionProgress {
+    index: number;
+    length: number;
+    label: string;
+    private constructor();
+    static create(index: number, length: number, label: string): ConnectionProgress;
+}
+export declare class ConnectionState {
+    state: ConnectionStateEnum;
+    reason?: DisconnectionReasonEnum;
+    progress?: ConnectionProgress;
+    private constructor();
+    static create<T extends ConnectionStateEnum>(state: T, reason?: T extends ConnectionStateEnum.DISCONNECTED ? DisconnectionReasonEnum : never, progress?: ConnectionProgress): ConnectionState;
+}
+export type ConnectionServiceEventHandler = (event: RBEvent) => any;
+/**
+ * ConnectionService service events
+ * Can be listened via connectionService.subscribe() API
+ */
+export declare enum ConnectionServiceEvents {
+    /**
+     * @eventProperty RAINBOW_ON_CONNECTION_STATE_CHANGE
+     * This RB event is send when the connectionService state change.
+     */
+    RAINBOW_ON_CONNECTION_STATE_CHANGE = "RAINBOW_ON_CONNECTION_STATE_CHANGE",
+    /**
+     * @eventProperty RAINBOW_ON_TOKEN_STATE_CHANGE
+     * This RB event is send when the connectionService token state change.
+     */
+    RAINBOW_ON_TOKEN_STATE_CHANGE = "RAINBOW_ON_TOKEN_STATE_CHANGE"
+}
+export interface ConnectionService {
+    /**
+     * Register a evenbt handler function for when the connectionService state change.
+     * @param handler - The handler function to register.
+     * @param eventName - (optional) the name of the event to subscribe on.
+     */
+    subscribe: (handler: ConnectionServiceEventHandler, eventName?: string) => Subscription;
+    attachCustomHandler: (handler: any, namespace: string, name: string, type: string) => void;
+    sendCustomMessage: (stanza: MaybeArray<Builder> | MaybeArray<Element>) => void;
+    sendCustomIq: (stanza: MaybeArray<Builder> | MaybeArray<Element>) => void;
+    /**
+     * Allow to start the RainbowSDK.
+     * @returns a promise that resolve when RainbowSDK is started and ready to use.
+     * Return the authenticated contact if the autolog success.
+     */
+    start: () => Promise<ConnectedUser | undefined>;
+    /**
+     * Allow to stop the RainbowSDK.
+     * @returns a promise that resolve when RainbowSDK is stopped.
+     */
+    stop: () => Promise<void>;
+    /**
+     * Allow to sign-on to Rainbow from a user account that already exists.
+     * @param login - Rainbow hosted user login.
+     * @param password - Rainbow hosted user password.
+     * @param rememberMe - (default: false) When set to true, user token will be stored in local storage for further connections.
+     */
+    logon: (login: string, password: string, rememberMe: boolean) => Promise<ConnectedUser>;
+    /**
+     * Allow to sign-on with JWT token to Rainbow from a user account that already exists.
+     * @param token - Rainbow user existing JWT token.
+     */
+    logonWithToken: (token: string) => Promise<ConnectedUser>;
+    /**
+     * Permits to log-on as "guest" in a bubble
+     * @param bubblelink - The bubble link.
+     * @param rememberMe - when set to true, the auth token will be stored in localStorage for further connections.
+     */
+    logonWithBubbleLink: (bubblelink: string, rememberMe?: boolean) => Promise<ConnectedUser>;
+    /**
+     * Use this method to update the OAuth token which is being used. It is
+     * obligatory to update the token after each renewing. If the token is not
+     * renewed, an event AUTH_TOKEN_EXPIRE will be emitted and the user will be disconnected
+     * @param token - String representing the new AuthToken received after the renewing
+     * @returns A promise that resolve when token is renewed.
+     */
+    setRenewedToken: (token: string) => Promise<void>;
+    /**
+     * Allow to sign-on with JWT token to Rainbow from a user account that already exists.
+     * @returns A promise that resolve when user is log-out.
+     */
+    logout: () => Promise<void>;
+    /**
+     * Get the current connection state with the Rainbow Cloud Services
+     * @returns The connection state
+     */
+    getState: () => ConnectionState;
+    /**
+     * Get the current token associated with the connection
+     * @returns The token
+     */
+    getToken: () => string;
+    /**
+     * Get the splatform server connection
+     * @returns The server
+     */
+    getServer: () => string;
+    /**
+     * Sends a password-reset email to the given address.
+     * @param email - Email of the user requesting a password reset.
+     */
+    sendResetPasswordEmail: (email: string) => Promise<void>;
+    /**
+     * Sets a new password using the temporary token received by email.
+     * @param email - Email of the user.
+     * @param newPassword - New password to set.
+     * @param temporaryToken - Token received in the reset email.
+     */
+    sendNewPassword: (email: string, newPassword: string, temporaryToken: string) => Promise<void>;
+}
+/**
+ * @internal
+ */
+export declare class ConnectionServiceRB extends Service implements ConnectionService {
+    private eventSubject;
+    private connectionState;
+    private authService;
+    private loggerService;
+    private xmppService;
+    private contactService;
+    private accountService;
+    private launchConfiguration;
+    private servicesStarted;
+    private servicesStarting;
+    private subscriptions;
+    autoLogin: boolean;
+    progressEvents: boolean;
+    static getInstance(): ConnectionServiceRB;
+    static build(): ConnectionServiceRB;
+    private constructor();
+    subscribe(handler: ConnectionServiceEventHandler, eventNames?: string | string[]): Subscription;
+    start(): Promise<ConnectedUser | undefined>;
+    stop(): Promise<void>;
+    logon(login: string, password: string, rememberMe?: boolean): Promise<ConnectedUser>;
+    logonWithToken(token: string): Promise<ConnectedUser>;
+    logonWithBubbleLink(bubbleLink: string, rememberMe?: boolean): Promise<ConnectedUser>;
+    setRenewedToken(token: string): Promise<void>;
+    logout(): Promise<void>;
+    attachCustomHandler(handler: any, namespace: string, name?: string, type?: any): void;
+    sendCustomMessage(stanza: MaybeArray<Builder> | MaybeArray<Element>): void;
+    sendCustomIq(iq: Builder | Element): void;
+    getState(): ConnectionState;
+    getToken(): string;
+    getServer(): string;
+    private startServices;
+    private stopServices;
+    private servicesEventListeners;
+    private onXmppConnectionEvent;
+    private onAuthServiceEvent;
+    private sendTokenEvent;
+    private reconnectServices;
+    /**
+     * Method executeActions
+     * @param actionsList - an array of action to executes\
+     * - actionsList contains several parameters \{ name, action, deps, notBlocking \}\
+     * - "name" : the name of the targeted service (ex : 'webinarService') (mandatory)\
+     * - "action" : the name of the method to call on the service (ex: 'start') (mandatory)\
+     * - "deps" : an array of parameters (used by the "action" methods) (optional)\
+     * - "notBlocking" : when set to true, even if this "action" call fails the process continue (optional, default = false)\
+     * - "noWait" : when set to true asyn "actions" are not "awaited"
+     * @returns a promise that resolve when all actions are executed
+     */
+    private executeActions;
+    /**
+     * Sends a password-reset email to the given address.
+     * @param email - Email of the user requesting a password reset.
+     */
+    sendResetPasswordEmail(email: string): Promise<void>;
+    /**
+     * Sets a new password using the temporary token received by email.
+     * @param email - Email of the user.
+     * @param newPassword - New password to set.
+     * @param temporaryToken - Token received in the reset email.
+     */
+    sendNewPassword(email: string, newPassword: string, temporaryToken: string): Promise<void>;
+    private updateConnectionState;
+}
+//# sourceMappingURL=connection.service.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"connection.service.d.ts","sourceRoot":"","sources":["../../../src/services/core/connection.service.ts"],"names":[],"mappings":"AAGA;;;GAGG;AAGH,OAAO,EAAE,OAAO,EAAE,MAAM,yCAAyC,CAAC;AAClE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAGzC,OAAO,EAAE,OAAO,EAAE,MAAM,uCAAuC,CAAC;AAOhE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAMjE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAC3C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAE1C,gBAAgB;AAChB,eAAO,MAAM,cAAc,sBAAsB,CAAC;AAElD,oBAAY,mBAAmB;IAC3B,IAAI,SAAS;IACb,UAAU,eAAe;IACzB,SAAS,cAAc;IACvB,YAAY,iBAAiB;IAC7B,YAAY,iBAAiB;CAChC;AAED,oBAAY,uBAAuB;IAC/B,QAAQ,aAAa;IACrB,UAAU,eAAe;IACzB,gBAAgB,qBAAqB;IACrC,sBAAsB,yBAAyB;IAC/C,iBAAiB,iBAAiB;CACrC;AAED,oBAAY,oBAAoB;IAC5B,sBAAsB,2BAA2B;IACjD,gBAAgB,qBAAqB;CACxC;AAED,qBAAa,kBAAkB;IACA,KAAK,EAAE,MAAM;IAAS,MAAM,EAAE,MAAM;IAAS,KAAK,EAAE,MAAM;IAArF,OAAO;WACO,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,kBAAkB;CACzF;AAED,qBAAa,eAAe;IACG,KAAK,EAAE,mBAAmB;IAAS,MAAM,CAAC,EAAE,uBAAuB;IAAS,QAAQ,CAAC,EAAE,kBAAkB;IAApI,OAAO;WACO,MAAM,CAAC,CAAC,SAAS,mBAAmB,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,CAAC,EAAE,CAAC,SAAS,mBAAmB,CAAC,YAAY,GAAG,uBAAuB,GAAG,KAAK,EAAE,QAAQ,CAAC,EAAE,kBAAkB,GAAG,eAAe;CACvM;AAED,MAAM,MAAM,6BAA6B,GAAG,CAAC,KAAK,EAAE,OAAO,KAAK,GAAG,CAAC;AAEpE;;;GAGG;AACH,oBAAY,uBAAuB;IAE/B;;;OAGG;IACH,kCAAkC,uCAAuC;IAEzE;;;OAGG;IACH,6BAA6B,kCAAkC;CAClE;AAED,MAAM,WAAW,iBAAiB;IAE9B;;;;OAIG;IACH,SAAS,EAAE,CAAC,OAAO,EAAE,6BAA6B,EAAE,SAAS,CAAC,EAAE,MAAM,KAAK,YAAY,CAAC;IAExF,mBAAmB,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IAC3F,iBAAiB,EAAE,CAAC,MAAM,EAAE,UAAU,CAAC,OAAO,CAAC,GAAG,UAAU,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC;IAC/E,YAAY,EAAE,CAAC,MAAM,EAAE,UAAU,CAAC,OAAO,CAAC,GAAG,UAAU,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC;IAE1E;;;;OAIG;IACH,KAAK,EAAE,MAAM,OAAO,CAAC,aAAa,GAAG,SAAS,CAAC,CAAC;IAEhD;;;OAGG;IACH,IAAI,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAE1B;;;;;OAKG;IACH,KAAK,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,KAAK,OAAO,CAAC,aAAa,CAAC,CAAC;IAExF;;;OAGG;IACH,cAAc,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,aAAa,CAAC,CAAC;IAE1D;;;;OAIG;IACH,mBAAmB,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,OAAO,KAAK,OAAO,CAAC,aAAa,CAAC,CAAC;IAE1F;;;;;;OAMG;IACH,eAAe,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAElD;;;OAGG;IACH,MAAM,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAE5B;;;OAGG;IACH,QAAQ,EAAE,MAAM,eAAe,CAAC;IAEhC;;;OAGG;IACH,QAAQ,EAAE,MAAM,MAAM,CAAC;IAEvB;;;OAGG;IACH,SAAS,EAAE,MAAM,MAAM,CAAC;IAExB;;;OAGG;IACH,sBAAsB,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzD;;;;;OAKG;IACH,eAAe,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CAClG;AACD;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,OAAQ,YAAW,iBAAiB;IACzE,OAAO,CAAC,YAAY,CAAmB;IACvC,OAAO,CAAC,eAAe,CAAkB;IAEzC,OAAO,CAAC,WAAW,CAA0C;IAC7D,OAAO,CAAC,aAAa,CAA8C;IACnE,OAAO,CAAC,WAAW,CAA0C;IAC7D,OAAO,CAAC,cAAc,CAAgD;IACtE,OAAO,CAAC,cAAc,CAAgD;IACtE,OAAO,CAAC,mBAAmB,CAA6C;IACxE,OAAO,CAAC,eAAe,CAAkB;IACzC,OAAO,CAAC,gBAAgB,CAAkB;IAC1C,OAAO,CAAC,aAAa,CAAsB;IAEpC,SAAS,EAAE,OAAO,CAAS;IAC3B,cAAc,EAAE,OAAO,CAAS;WAEzB,WAAW,IAAI,mBAAmB;WAClC,KAAK,IAAI,mBAAmB;IAE1C,OAAO;IAMA,SAAS,CAAC,OAAO,EAAE,6BAA6B,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,YAAY;IAkBzF,KAAK,IAAI,OAAO,CAAC,aAAa,GAAG,SAAS,CAAC;IAuB3C,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IASrB,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,GAAE,OAAe,GAAG,OAAO,CAAC,aAAa,CAAC;IAe3F,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAarD,mBAAmB,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,GAAE,OAAe,GAAG,OAAO,CAAC,aAAa,CAAC;IA4B5F,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI7C,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IAW7B,mBAAmB,CAAC,OAAO,EAAE,GAAG,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,GAAE,MAAa,EAAE,IAAI,GAAE,GAAU,GAAG,IAAI;IAIjG,iBAAiB,CAAC,MAAM,EAAE,UAAU,CAAC,OAAO,CAAC,GAAG,UAAU,CAAC,OAAO,CAAC,GAAG,IAAI;IAI1E,YAAY,CAAC,EAAE,EAAE,OAAO,GAAG,OAAO,GAAG,IAAI;IAIzC,QAAQ,IAAI,eAAe;IAI3B,QAAQ,IAAI,MAAM;IAIlB,SAAS,IAAI,MAAM;YAIZ,aAAa;YAkBb,YAAY;IAkB1B,OAAO,CAAC,sBAAsB;IAM9B,OAAO,CAAC,qBAAqB;IAiB7B,OAAO,CAAC,kBAAkB;IAW1B,OAAO,CAAC,cAAc;YAKR,iBAAiB;IAsB/B;;;;;;;;;;OAUG;YACW,cAAc;IAuD5B;;;OAGG;IACU,sBAAsB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIjE;;;;;OAKG;IACU,eAAe,CAAC,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIvG,OAAO,CAAC,qBAAqB;CAShC"}