@ale-rainbow/web-sdk 5.1.0

package/lib/services/bot/bot.service.d.ts

@@ -0,0 +1,121 @@
+import type { Contact } from "../../models/contact.model";
+import { Service } from "../../services/service";
+export declare const BOT_SVC = "BotService";
+export declare class BotData {
+    id: string;
+    name: string;
+    jid: string;
+    avatarId: string;
+    avatarUrl: string;
+    lastAvatarUpdateDate: string;
+    capabilities: string[];
+    isRainbowSupportBot: boolean;
+    static createFromData(data: any): BotData;
+}
+export declare abstract class AbstractBotService extends Service {
+    abstract getBots(options: any): Promise<any[]>;
+    abstract getBotById(botId: string): Promise<any>;
+}
+export declare class BotService extends AbstractBotService {
+    private authService;
+    private logger;
+    private contactService;
+    private eventService;
+    private errorHelperService;
+    private profileService;
+    private portalURL;
+    private avatarChangeEventHandler;
+    botsList: BotData[];
+    static getInstance(): BotService;
+    static build(): BotService;
+    protected constructor();
+    /** ******************************************************/
+    /** LIFE CYCLE STUFF                                   */
+    /** ******************************************************/
+    start(): Promise<void>;
+    stop(): Promise<void>;
+    init(): void;
+    /** ******************************************************/
+    /** EVENT HANDLING                                     */
+    /** ******************************************************/
+    private startListeners;
+    private onSupportAvatarChange;
+    /** ******************************************************/
+    /** COMPANY BOTS                                       */
+    /** ******************************************************/
+    /**
+     * Get the  list of bot services.
+     * Used by SDK (public)
+     * Warning when modifying this method
+     *
+     * @param {object} options [optional] configuration object that may contain the following properties:
+     * @property {string} options.format [optional] Allows to retrieve more or less bot services details in response.
+     * - small: id, name, jid, capabilities
+     * - medium: id, name, jid, isRainbowSupportBot, capabilities
+     * - full: id, name, jid, isRainbowSupportBot, capabilities, createdByUserId, avatarId, lastAvatarUpdateDate
+     * Default value: full
+     * @property {number} options.limit [optional] Allows to specify the number of bot services to retrieve.
+     * Default value: 100
+     * @property {number} options.offset [optional] Allows to specify the position of first bot to retrieve (first bot if not specified).
+     * Warning: if offset > total, no results are returned.
+     * @property {string} options.sortField [optional] Sort bots list based on the given field.
+     * Default value: name
+     * @property {number} options.sortOrder [optional] Allows to specify order when sorting bots list.
+     * Default value: 1
+     * Allowed values: -1, 1
+     * }
+     * @returns Promise<any[]>  returns an Object
+     * {
+     * data :      {array}     // found bots informations with an array
+     * limit :     {number}    // limit given
+     * offset :    {number}    // offset given
+     * total :     {number}    // total returned
+     * }
+     */
+    getBots(options?: any): Promise<any[]>;
+    /**
+     * Get the data of a bot service from its id
+     * Used by SDK (public)
+     * Warning when modifying this method
+     *
+     * @param {string} botId Bot Service unique identifier
+     * @returns Promise<any>
+     */
+    getBotById(botId: string): Promise<any>;
+    /**
+     * Get the Contact associated to a bot service from its jid
+     * The bot service is retrieved first from internal data (botsList) and if not present, a request is sent to server
+     * to retrieve all data associated to this bot. This bot is also added in botsList cache.
+     *
+     * @param jid
+     * @param {string} botJid Bot service's jid, should be like 'emily.rainbow.com'.
+     * @returns Promise<Contact>
+     */
+    getBotContactByJid(jid: string): Promise<Contact>;
+    /** ******************************************************/
+    /** COMPANY E-SUPPORT BOT (EMILY)                      */
+    /** ******************************************************/
+    /**
+     * GET Emily bot data from server
+     *
+     * @returns {object} Emily bot Object (any)
+     */
+    private getEmilyBot;
+    private storeEmilyBot;
+    /**
+     * SEARCH Emily data in internal cache (and from server in case of shitty situation)
+     *
+     * @returns {object} Emily Bot Data Object (BotData)
+     */
+    getEmily(): Promise<BotData>;
+    /** ******************************************************/
+    /** COMPANY BOT AVATAR STUFF                           */
+    /**
+     * @param {string} avatarId Identifier of the Bot service's avatar.
+     * @param {string} lastAvatarUpdateDate Date of last bot avatar update
+     * @returns {Promise} Promise to get the  Avatar (Image format) of the specified Bot
+     */
+    getBotAvatarImage(avatarId: string, lastAvatarUpdateDate: string): Promise<any>;
+    private getBotAvatarUrl;
+}
+//# sourceMappingURL=bot.service.d.ts.map

package/lib/services/bot/bot.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bot.service.d.ts","sourceRoot":"","sources":["../../../src/services/bot/bot.service.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,2CAA2C,CAAC;AAEzE,OAAO,EAAE,OAAO,EAAE,MAAM,uCAAuC,CAAC;AAGhE,eAAO,MAAM,OAAO,eAAe,CAAC;AAEpC,qBAAa,OAAO;IACT,EAAE,EAAE,MAAM,CAAQ;IAClB,IAAI,EAAE,MAAM,CAAQ;IACpB,GAAG,EAAE,MAAM,CAAQ;IACnB,QAAQ,EAAE,MAAM,CAAQ;IACxB,SAAS,EAAE,MAAM,CAAQ;IACzB,oBAAoB,EAAE,MAAM,CAAQ;IACpC,YAAY,EAAE,MAAM,EAAE,CAAM;IAC5B,mBAAmB,EAAE,OAAO,CAAS;WAE9B,cAAc,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO;CAanD;AAED,8BAAsB,kBAAmB,SAAQ,OAAO;aACpC,OAAO,CAAC,OAAO,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;aACrC,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;CAC1D;AAED,qBAAa,UAAW,SAAQ,kBAAkB;IAC9C,OAAO,CAAC,WAAW,CAA0C;IAC7D,OAAO,CAAC,MAAM,CAA8C;IAC5D,OAAO,CAAC,cAAc,CAAgD;IACtE,OAAO,CAAC,YAAY,CAA4C;IAChE,OAAO,CAAC,kBAAkB,CAAwD;IAClF,OAAO,CAAC,cAAc,CAAgD;IAEtE,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,wBAAwB,CAAa;IAEtC,QAAQ,EAAE,OAAO,EAAE,CAAM;WAElB,WAAW;WAIX,KAAK;IAInB,SAAS;IAIT,2DAA2D;IAC3D,yDAAyD;IACzD,2DAA2D;IAC9C,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAoBtB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAM3B,IAAI,IAAI,IAAI;IAKnB,2DAA2D;IAC3D,yDAAyD;IACzD,2DAA2D;IAC3D,OAAO,CAAC,cAAc;YAKR,qBAAqB;IAcnC,2DAA2D;IAC3D,yDAAyD;IACzD,2DAA2D;IAE3D;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACU,OAAO,CAAC,OAAO,GAAE,GAAU,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IA4CzD;;;;;;;OAOG;IACU,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAyBpD;;;;;;;;OAQG;IACU,kBAAkB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IA+C9D,2DAA2D;IAC3D,yDAAyD;IACzD,2DAA2D;IAE3D;;;;OAIG;YACW,WAAW;IAmCzB,OAAO,CAAC,aAAa;IAuBrB;;;;OAIG;IACU,QAAQ,IAAI,OAAO,CAAC,OAAO,CAAC;IAqBzC,2DAA2D;IAC3D,yDAAyD;IACzD;;;;OAIG;IACI,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE,oBAAoB,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IA8BtF,OAAO,CAAC,eAAe;CAU1B"}