docs/api/backend/contexts_users_Users.js.html



<!DOCTYPE html>
<html lang="en">

<head>
  
  <meta charset="utf-8">
  <meta name="viewport" content="width=device-width, initial-scale=1">
  <title>lea.online App-Backend Documentation contexts/users/Users.js</title>

  <script src="https://cdn.jsdelivr.net/gh/google/code-prettify@master/loader/run_prettify.js"></script>
  <script src="https://unpkg.com/@babel/standalone/babel.min.js"></script>
  <script src="./build/entry.js"></script>
  <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
  <!--[if lt IE 9]>
    <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
  <![endif]-->
  <link href="https://fonts.googleapis.com/css?family=Roboto:100,400,700|Inconsolata,700" rel="stylesheet">
  <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-UHRtZLI+pbxtHCWp1t77Bi1L4ZtiqrqD80Kn4Z8NTSRyMA2Fd33n5dQ8lWUE00s/" crossorigin="anonymous">
  <link type="text/css" rel="stylesheet" href="https://jmblog.github.io/color-themes-for-google-code-prettify/themes/tomorrow-night.min.css">
  <link type="text/css" rel="stylesheet" href="styles/app.min.css">
  <link type="text/css" rel="stylesheet" href="styles/iframe.css">
  <link type="text/css" rel="stylesheet" href="">
  <script async defer src="https://buttons.github.io/buttons.js"></script>

  
</head>


<body class="layout small-header">
    <div id="stickyNavbarOverlay"></div>
    

<div class="top-nav">
    <div class="inner">
        <a id="hamburger" role="button" class="navbar-burger" aria-label="menu" aria-expanded="false">
            <span aria-hidden="true"></span>
            <span aria-hidden="true"></span>
            <span aria-hidden="true"></span>
        </a>
        <div class="logo">
            
             
                <a href="index.html">
                    <h1 class="navbar-item">lea.online App-Backend Documentation</h1>
                </a>
            
        </div>
        <div class="menu">
            
            <div class="navigation">
                <a
                    href="index.html"
                    class="link"
                >
                    Documentation
                </a>
                
                 
                        <a
                            class="link user-link "
                            href="https://github.com/leaonline/leaonline-app"
                        >
                            Github
                        </a>
                    
                
            </div>
        </div>
    </div>
</div>
    <div id="main">
        <div
            class="sidebar "
            id="sidebarNav"
        >
            
                <div class="search-wrapper">
                    <input id="search" type="text" placeholder="Search docs..." class="input">
                </div>
            
            <nav>
                
                    <h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Modules</h3><ul><li><a href="module-onServerExec.html">onServerExec</a></li></ul><h3>Namespaces</h3><ul><li><a href="Session.methods.html">methods</a></li><li><a href="Session.schema.html">schema</a></li></ul><h3>Classes</h3><ul><li><a href="Repository.html">Repository</a></li></ul><h3>Global</h3><ul><li><a href="global.html#Achievements">Achievements</a></li><li><a href="global.html#Analytics">Analytics</a></li><li><a href="global.html#createLog">createLog</a></li><li><a href="global.html#createRepository">createRepository</a></li><li><a href="global.html#createSchema">createSchema</a></li><li><a href="global.html#cursorToMap">cursorToMap</a></li><li><a href="global.html#ensureCollectionExists">ensureCollectionExists</a></li><li><a href="global.html#ensureConnected">ensureConnected</a></li><li><a href="global.html#ensureContextExists">ensureContextExists</a></li><li><a href="global.html#ensureDocument">ensureDocument</a></li><li><a href="global.html#environmentExtensionMixin">environmentExtensionMixin</a></li><li><a href="global.html#expectAsyncError">expectAsyncError</a></li><li><a href="global.html#Feedback">Feedback</a></li><li><a href="global.html#Integer">Integer</a></li><li><a href="global.html#InteractionGraph">InteractionGraph</a></li><li><a href="global.html#oneOf">oneOf</a></li><li><a href="global.html#randomIntInclusive">randomIntInclusive</a></li><li><a href="global.html#RegEx">RegEx</a></li><li><a href="global.html#removeUser">removeUser</a></li><li><a href="global.html#runRemap">runRemap</a></li><li><a href="global.html#updateUserProfile">updateUserProfile</a></li></ul></div><div class="category"><h2>api</h2><h3>Modules</h3><ul><li><a href="module-asyncTimeout.html">asyncTimeout</a></li><li><a href="module-getCollection.html">getCollection</a></li><li><a href="module-getLocalCollection.html">getLocalCollection</a></li><li><a href="module-hasProp.html">hasProp</a></li><li><a href="module-isSchemaInstance.html">isSchemaInstance</a></li></ul><h3>Namespaces</h3><ul><li><a href="ContentConnection.html">ContentConnection</a></li><li><a href="LocalCollections.html">LocalCollections</a></li><li><a href="RestoreCodes.html">RestoreCodes</a></li><li><a href="SensitiveData.html">SensitiveData</a></li></ul><h3><a href="global.html">Global</a></h3></div><div class="category"><h2>contexts</h2><h3>Modules</h3><ul><li><a href="module-countUnitCompetencies.html">countUnitCompetencies</a></li></ul><h3>Namespaces</h3><ul><li><a href="Content.html">Content</a></li><li><a href="ContextRegistry.html">ContextRegistry</a></li><li><a href="MapData.html">MapData</a></li><li><a href="Progress.html">Progress</a></li><li><a href="Response.html">Response</a></li><li><a href="Session.html">Session</a></li><li><a href="SyncState.html">SyncState</a></li><li><a href="Users.html">Users</a></li><li><a href="Users.methods.html">methods</a></li><li><a href="Users.schema.html">schema</a></li></ul></div><div class="category"><h2>startup</h2><h3>Modules</h3><ul><li><a href="module-useFixtures.html">useFixtures</a></li></ul></div>
                
            </nav>
        </div>
        <div class="core" id="main-content-wrapper">
            <div class="content">
                <header class="page-title">
                    <p>Source</p>
                    <h1>contexts/users/Users.js</h1>
                </header>
                

    <section>
        <article>
            <pre class="prettyprint source linenums"><code>import { Meteor } from 'meteor/meteor'
import { Accounts } from 'meteor/accounts-base'
import { onServerExec } from '../../infrastructure/arch/onServerExec'
import { RestoreCodes } from '../../api/accounts/RestoreCodes'
import { updateUserProfile } from './updateUserProfile'
import { removeUser } from './removeUser'
import { getUsersCollection } from '../../api/collections/getUsersCollection'
import { createLog } from '../../infrastructure/log/createLog'
import { safeWhile } from '../../api/utils/safeWhile'

/**
 * Representation of users in the database.
 * @namespace
 * @category contexts
 */
const Users = {
  /**
   * Name, to be used as collection name.
   */
  name: 'users',
  label: 'users.title',
  icon: 'users',
  representative: '_id'
}

const debug = createLog({ name: Users.name, type: 'debug' })

/**
 * The db schema definitions.
 * @type {object}
 * @namespace
 * @category contexts
 */
Users.schema = {
  /**
   * Definition for valid usernames.
   */
  username: {
    type: String,
    min: 32,
    regEx: /[a-f0-9]{32}/i
  },

  /**
   * Determines when this user has been created
   */
  createdAt: Date,

  /**
   * Set when user successfully logs in
   */
  lastLogin: {
    type: Date,
    optional: true
  },

  /**
   * services schema can be a bit complex at times, since Meteor uses it
   * for multiple authentication and verification scenarios
   */
  services: {
    type: Object
  },
  'services.password': {
    type: Object
  },
  'services.password.bcrypt': {
    type: String,
    regEx: /^\$2b\$.{56}$/
  },
  'services.resume': {
    type: Object
  },
  'services.resume.loginTokens': {
    type: Array,
    optional: true
  },
  'services.resume.loginTokens.$': {
    type: Object
  },
  'services.resume.loginTokens.$.when': {
    type: Date
  },
  'services.resume.loginTokens.$.hashesToken': {
    type: String
  },

  /**
   * The restore code
   */
  restore: String,

  /**
   * The selected tts voice
   */
  voice: {
    type: String,
    optional: true
  },

  /**
   * The selected tts voice speed
   */
  speed: {
    type: Number,
    optional: true
  },

  /**
   * True if 2xoptin for research
   * has been completed
   */
  research: {
    type: Boolean,
    optional: true
  },

  isDev: {
    type: Boolean,
    optional: true
  },

  // adding Email schema from UserEmail
  // ...UserEmail.schema()

  /**
   * We save the current device info to associate
   * any client error with it by user-id.
   * Device info should contain no personal data
   */
  device: {
    type: Object,
    optional: true,
    blackbox: true
  }
}

/**
 * Meteor method endpoints.
 * @category contexts
 * @memberof Users
 * @type {object}
 * @namespace Users.methods
 */
Users.methods = {}

/**
 * Creates a new user and automatically authenticates them.
 * @method
 * @param options {object}
 * @param options.voice {string=} the current selected voice
 * @param options.speed {number=} the current selected speed for voices
 * @throws {Meteor.Error} if already authenticated
 */
Users.methods.create = {
  name: 'users.methods.create',
  isPublic: true,
  schema: {
    voice: {
      type: String,
      optional: true
    },
    speed: {
      type: Number,
      optional: true
    },
    isDev: Users.schema.isDev,
    device: Users.schema.device
  },
  run: onServerExec(function () {
    import { Random } from 'meteor/random'

    return function (options = {}) {
      const { userId } = this

      // creating a new user should either be possible
      // without an existing account
      // or if the caller is actually a backenduser
      if (userId) {
        throw new Meteor.Error(
          'createUser.error',
          'createUser.alreadyExist',
          { userId }
        )
      }

      const collection = getUsersCollection()
      const { voice, speed, isDev, device } = options
      const username = Random.hexString(32)
      const password = Random.secret()
      const restore = safeWhile((count) => {
        const codes = RestoreCodes.generate()
        const r = codes.join('-')
        const hasCodes = collection.find({ restore: r }).count() > 0
        if (!hasCodes) {
          return r
        }
      })
      const newUserId = Accounts.createUser({ username, password })
      const updateDoc = { restore, voice, speed, isDev, device }

      getUsersCollection().update(newUserId, { $set: updateDoc })

      // validate the new account with the created credentials
      const credentials = { user: { username }, password }
      Accounts._runLoginHandlers(this, credentials)

      // finally, login this user as they should not need
      // to manually authenticate
      return Accounts._loginUser(this, newUserId)
    }
  })
}

/**
 * Allows users to update certain parts of their profile, such as
 * selected voice and speed.
 *
 * @method
 * @param options {object}
 * @param options.voice {string=} the current selected voice
 * @param options.speed {number=} the current selected speed for voices
 * @return {number} 1 if updated, 0 if not
 * @throws {Meteor.Error} if not authenticated or no options passed
 */
Users.methods.updateProfile = {
  name: 'users.methods.updateProfile',
  schema: {
    voice: {
      type: String,
      optional: true
    },
    speed: {
      type: Number,
      optional: true
    }
  },
  run: function ({ voice, speed } = {}) {
    const { userId } = this
    const nothingToUpdate = typeof voice !== 'string' &amp;&amp; typeof speed !== 'number'

    if (nothingToUpdate) {
      throw new Meteor.Error(
        'permissionDenied',
        'updateProfile.failed',
        { userId, voice, speed }
      )
    }

    return updateUserProfile({ userId, speed, voice })
  }
}

/**
 * Restores a user with a given restore-code.
 */
Users.methods.restore = {
  name: 'users.methods.restore',
  isPublic: true,
  schema: {
    codes: Array,
    'codes.$': String,
    voice: {
      type: String,
      optional: true
    },
    speed: {
      type: Number,
      optional: true
    },
    device: Users.schema.device
  },
  run: function ({ codes, voice, speed, device }) {
    const restore = codes.join('-')
    const userCursor = getUsersCollection().find({ restore })
    const count = userCursor.count()
    debug('restore with code', restore, '=> found', count)

    if (count !== 1) {
      throw new Meteor.Error(
        'permissionDenied',
        'restore.failed',
        { codes, restore, count }
      )
    }

    const user = userCursor.fetch()[0]
    const userId = user._id
    const hasVoice = typeof voice === 'string'
    const hasSpeed = typeof speed === 'number'

    if (hasVoice || hasSpeed || device) {
      const updateDoc = { userId, voice, speed, device }
      updateUserProfile(updateDoc)
    }

    return Accounts._loginUser(this, user._id)
  }
}

/**
 * Returns the current user's restore codes
 * @type {{schema: {}, name: string, run: (function(): *)}}
 */
Users.methods.getCodes = {
  name: 'users.methods.getCodes',
  schema: {},
  run: function () {
    const { userId } = this
    const user = getUsersCollection().findOne(userId)
    return user.restore
  }
}

/**
 * Deletes the user's current account. It only deletes the account, if
 * the current logged-in user invokes this fn plus it matches the
 * given _id and username.
 *
 * Otherwise, it throws a permissionDenied error.
 *
 * @method
 * @param {string} _id
 * @param {string} username
 */
Users.methods.delete = {
  name: 'users.methods.delete',
  schema: {},
  run: onServerExec(function () {
    return function () {
      const { userId } = this
      return removeUser(userId, userId)
    }
  })
}

Users.methods.getAll = {
  name: 'users.methods.getAll',
  schema: {
    dependencies: {
      type: Array,
      optional: true
    },
    'dependencies.$': {
      type: Object,
      blackbox: true,
      optional: true
    }
  },
  backend: true,
  run: function () {
    const users = getUsersCollection().find({}, {
      fields: {
        services: 0,
        agents: 0
      },
      hint: {
        $natural: -1
      }
    }).fetch()

    return { users }
  }
}

Users.methods.remove = {
  name: 'users.methods.remove',
  schema: {
    _id: 1
  },
  backend: true,
  run: function ({ _id }) {
    const calledBy = this.userId
    try {
      return removeUser(_id, calledBy)?.userRemoved
    }
    catch (e) {
      return 0
    }
  }
}

export { Users }
</code></pre>
        </article>
    </section>


            </div>
            
            <footer class="footer">
                <div class="content has-text-centered">
                    <p>Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a></p>
                    <p class="sidebar-created-by">
                        <a href="https://github.com/SoftwareBrothers/better-docs" target="_blank">BetterDocs theme</a> provided with <i class="fas fa-heart"></i> by
                        <a href="http://softwarebrothers.co" target="_blank">SoftwareBrothers - JavaScript Development Agency</a>
                    </p>
                </div>
            </footer>
            
        </div>
        <div id="side-nav" class="side-nav">
        </div>
    </div>
<script src="scripts/app.min.js"></script>
<script>PR.prettyPrint();</script>
<script src="scripts/linenumber.js"> </script>

<script src="scripts/search.js"> </script>


</body>
</html>