@blinkmobile/bm-identity/index.js

'use strict';

const assumeRole = require('./lib/aws/assume-role.js');
const loginCommon = require('./lib/common/login.js');
const logoutCommon = require('./lib/common/logout.js');
const tenant = require('./lib/common/tenant.js');
const profile = require('./lib/auth0/profile.js');

const privateVars = new WeakMap();

/**
 * Class representing a Blink Mobile identity.
 */
class BlinkMobileIdentity {
  /**
   * Create a Blink Mobile identity.
   * @param {String} clientName - The name of the client.
   */
  constructor (clientName) {
    privateVars.set(this, {
      clientName
    });
  }

  /**
   * Login to a client using a Blink Mobile identity.
   * @param {Object} options - The login options.
   * @returns {String} The JWT generated after a successful login.
   */
  login (options) {
    return loginCommon.login(privateVars.get(this).clientName, options);
  }

  /**
   * Logout of the client.
   */
  logout () {
    return logoutCommon.logout(privateVars.get(this).clientName);
  }

  /**
   * Get temporary AWS role's credentials.
   * @param {Object} Additional parameters to pass to the delegation endpoint.
   * @returns {Object} The AWS credentials.
   */
  assumeAWSRole (additionalParameters) {
    return assumeRole(privateVars.get(this).clientName, additionalParameters);
  }

  /**
   * Get the Auth0 profile for the current user.
   * @returns {Object} The Auth0 profile.
   */
  getProfile () {
    return profile.getByClient(privateVars.get(this).clientName);
  }

  /**
   * Show the currently set and available tenants.
   * @param {String} clientName - The name of a Client.
   */
  getTenants () {
    return tenant.get();
  }

  /**
   * Change the currently set tenant, will then show the currently set and available tenants.
   * @param {String} tenantName - The name of a tenant to set.
   */
  setTenant (tenantName) {
    return tenant.set(tenantName);
  }

  /**
   * Remove a tenant from the available tenants, will then show the currently set and available tenants.
   * @param {String} tenantName - The name of a tenant to remove.
   */
  removeTenant (tenantName) {
    return tenant.remove(tenantName);
  }
}

module.exports = BlinkMobileIdentity;