jitsi_mod/react/features/invite/functions.js

// @flow

declare var $: Function;
declare var interfaceConfig: Object;

/**
 * Get the position of the invite option in the interfaceConfig.INVITE_OPTIONS
 * list.
 *
 * @param {string} name - The invite option name.
 * @private
 * @returns {number} - The position of the option in the list.
 */
export function getInviteOptionPosition(name: string): number {
    return interfaceConfig.INVITE_OPTIONS.indexOf(name);
}

/**
 * Sends a post request to an invite service.
 *
 * @param {string} inviteServiceUrl - The invite service that generates the
 * invitation.
 * @param {string} inviteUrl - The url to the conference.
 * @param {string} jwt - The jwt token to pass to the search service.
 * @param {Immutable.List} people - The list of the "user" type items to invite.
 * @returns {Promise} - The promise created by the request.
 */
export function invitePeople( // eslint-disable-line max-params
        inviteServiceUrl: string,
        inviteUrl: string,
        jwt: string,
        people: Object) {
    return new Promise((resolve, reject) => {
        $.post(
                `${inviteServiceUrl}?token=${jwt}`,
                JSON.stringify({
                    'invited': people,
                    'url': inviteUrl
                }),
                resolve,
                'json')
            .fail((jqxhr, textStatus, error) => reject(error));
    });
}

/**
 * Invites room participants to the conference through the SIP Jibri service.
 *
 * @param {JitsiMeetConference} conference - The conference to which the rooms
 * will be invited to.
 * @param {Immutable.List} rooms - The list of the "videosipgw" type items to
 * invite.
 * @returns {void}
 */
export function inviteRooms(
        conference: { createVideoSIPGWSession: Function },
        rooms: Object) {
    for (const room of rooms) {
        const { id: sipAddress, name: displayName } = room;

        if (sipAddress && displayName) {
            const newSession
                = conference.createVideoSIPGWSession(sipAddress, displayName);

            newSession.start();
        } else {
            console.error(
                `No display name or sip number for ${JSON.stringify(room)}`);
        }
    }
}

/**
 * Indicates if an invite option is enabled in the configuration.
 *
 * @param {string} name - The name of the option defined in
 * interfaceConfig.INVITE_OPTIONS.
 * @returns {boolean} - True to indicate that the given invite option is
 * enabled, false - otherwise.
 */
export function isInviteOptionEnabled(name: string) {
    return getInviteOptionPosition(name) !== -1;
}

/**
 * Sends an ajax request to a directory service.
 *
 * @param {string} serviceUrl - The service to query.
 * @param {string} jwt - The jwt token to pass to the search service.
 * @param {string} text - Text to search.
 * @param {Array<string>} queryTypes - Array with the query types that will be
 * executed - "conferenceRooms" | "user" | "room".
 * @returns {Promise} - The promise created by the request.
 */
export function searchPeople( // eslint-disable-line max-params
        serviceUrl: string,
        jwt: string,
        text: string,
        queryTypes: Array<string> = [ 'conferenceRooms', 'user', 'room' ]) {
    const queryTypesString = JSON.stringify(queryTypes);

    return new Promise((resolve, reject) => {
        $.getJSON(
                `${serviceUrl}?query=${encodeURIComponent(text)}&queryTypes=${
                    queryTypesString}&jwt=${jwt}`,
                resolve)
            .fail((jqxhr, textStatus, error) => reject(error));
    });
}