@orfeas126/box-ui-elements/es/api/Users.js

Box UI Elements

/**
 * 
 * @file Helper for the box Users API
 * @author Box
 */

import queryString from 'query-string';
import TokenService from '../utils/TokenService';
import { getTypedFileId } from '../utils/file';
import Base from './Base';
import { ERROR_CODE_FETCH_CURRENT_USER } from '../constants';
class Users extends Base {
  /**
   * API URL for Users
   *
   * @returns {string} base url for users
   */
  getUrl() {
    return `${this.getBaseApiUrl()}/users/me`;
  }

  /**
   * API URL for Users avatar
   *
   * @param {string} id - A box user id.
   * @returns {string} base url for users
   */
  getAvatarUrl(id) {
    if (!id) {
      throw new Error('Missing user id');
    }
    return `${this.getBaseApiUrl()}/users/${id}/avatar`;
  }

  /**
   * Gets authenticated user avatar URL from cache or by getting new token
   *
   * @param {string} userId the user id
   * @param {string} fileId the file id
   * @returns {string} the user avatar URL string for a given user with access token attached
   */
  async getAvatarUrlWithAccessToken(userId, fileId) {
    if (!userId) {
      return null;
    }

    // treat cache as key-value pairs of { userId: avatarUrl }
    const cache = this.getCache();
    if (cache.has(userId)) {
      return cache.get(userId);
    }
    const accessToken = await TokenService.getReadToken(getTypedFileId(fileId), this.options.token);
    if (typeof accessToken === 'string') {
      const options = {
        access_token: accessToken,
        pic_type: 'large'
      };
      const urlParams = queryString.stringify(options);
      const url = `${this.getAvatarUrl(userId)}?${urlParams}`;
      cache.set(userId, url);
      return url;
    }
    return null;
  }

  /**
   * API for fetching a user
   *
   * @param {string} id - a Box item id
   * @param {Function} successCallback - Success callback
   * @param {Function} errorCallback - Error callback
   * @param {Object} requestData - additional request data
   * @returns {Promise<void>}
   */
  getUser(id, successCallback, errorCallback, requestData = {}) {
    this.errorCode = ERROR_CODE_FETCH_CURRENT_USER;
    this.get({
      id,
      successCallback,
      errorCallback,
      requestData
    });
  }
}
export default Users;
//# sourceMappingURL=Users.js.map