feat(client:auth): add types to async functions, update documentation

Author: Koslun

Diff for: templates/app/client/components/auth(auth)/auth.service.js

@@ -32,10 +32,10 @@ export function AuthService($location, $http, $cookies, $q, appConfig, Util, Use
      * Authenticate user and save token
      *
      * @param  {Object}   user     - login info
-     * @param  {Function} callback - optional, function(error, user)
+     * @param  {Function} callback - function(error, user)
      * @return {Promise}
      */
-    login({email, password}, callback: Function) {
+    login({email, password}, callback?: Function) {
       return $http.post('/auth/local', { email, password })
         .then(res => {
           $cookies.put('token', res.data.token);
@@ -65,10 +65,10 @@ export function AuthService($location, $http, $cookies, $q, appConfig, Util, Use
      * Create a new user
      *
      * @param  {Object}   user     - user info
-     * @param  {Function} callback - optional, function(error, user)
+     * @param  {Function} callback - function(error, user)
      * @return {Promise}
      */
-    createUser(user, callback) {
+    createUser(user, callback?: Function) {
       return User.save(user,
         function(data) {
           $cookies.put('token', data.token);
@@ -86,10 +86,10 @@ export function AuthService($location, $http, $cookies, $q, appConfig, Util, Use
      *
      * @param  {String}   oldPassword
      * @param  {String}   newPassword
-     * @param  {Function} callback    - optional, function(error, user)
+     * @param  {Function} callback    - function(error, user)
      * @return {Promise}
      */
-    changePassword(oldPassword, newPassword, callback) {
+    changePassword(oldPassword, newPassword, callback?: Function) {
       return User.changePassword({ id: currentUser._id }, { oldPassword, newPassword }, function() {
         return safeCb(callback)(null);
       }, function(err) {
@@ -100,10 +100,10 @@ export function AuthService($location, $http, $cookies, $q, appConfig, Util, Use
     /**
      * Gets all available info on a user
      *
-     * @param  {Function} [callback] - optional, function(user)
+     * @param  {Function} [callback] - function(user)
      * @return {Promise}
      */
-    getCurrentUser(callback) {
+    getCurrentUser(callback?: Function) {
       var value = currentUser.hasOwnProperty('$promise')
         ? currentUser.$promise
         : currentUser;
@@ -131,9 +131,9 @@ export function AuthService($location, $http, $cookies, $q, appConfig, Util, Use
      * Check if a user is logged in
      *
      * @param  {Function} [callback] - function(is)
-     * @return {Bool|Promise}
+     * @return {Promise}
      */
-    isLoggedIn(callback) {
+    isLoggedIn(callback?: Function) {
       return Auth.getCurrentUser(undefined)
         .then(user => {
           var is = user.hasOwnProperty('role');
@@ -156,9 +156,9 @@ export function AuthService($location, $http, $cookies, $q, appConfig, Util, Use
       *
       * @param  {String}     role     - the role to check against
       * @param  {Function} [callback] - function(has)
-      * @return {Bool|Promise}
+      * @return {Promise}
       */
-    hasRole(role, callback) {
+    hasRole(role, callback?: Function) {
       return Auth.getCurrentUser(undefined)
         .then(user => {
           var has = user.hasOwnProperty('role')