Add typescript support for search results

.eslintignore

@@ -12,3 +12,7 @@ src/core/security/Role.js
 src/utils/interfaces.js
 src/core/searchResult/SearchResultBase.js
 src/core/searchResult/Document.js
+src/core/searchResult/Profile.js
+src/core/searchResult/Role.js
+src/core/searchResult/Specifications.js
+src/core/searchResult/User.js

.gitignore

@@ -40,3 +40,7 @@ src/core/security/Role.js
 src/utils/interfaces.js
 src/core/searchResult/SearchResultBase.js
 src/core/searchResult/Document.js
+src/core/searchResult/Profile.js
+src/core/searchResult/Role.js
+src/core/searchResult/Specifications.js
+src/core/searchResult/User.js

index.ts

@@ -18,7 +18,7 @@ import { SearchResultBase } from './src/core/searchResult/SearchResultBase';
 import { DocumentSearchResult } from './src/core/searchResult/Document';
 import { ProfileSearchResult } from './src/core/searchResult/Profile';
 import { RoleSearchResult } from './src/core/searchResult/Role';
-import { SpecificationSearchResult } from './src/core/searchResult/Specifications';
+import { SpecificationsSearchResult } from './src/core/searchResult/Specifications';
 import { UserSearchResult } from './src/core/searchResult/User';
 
 const exported = {
@@ -32,7 +32,7 @@ const exported = {
   DocumentSearchResult,
   ProfileSearchResult,
   RoleSearchResult,
-  SpecificationSearchResult,
+  SpecificationsSearchResult,
   UserSearchResult
 }
 

src/controllers/Auth.ts

@@ -495,7 +495,7 @@ export class AuthController extends BaseController {
      */
     _id: string;
     /**
-     * Expiration date in UNIX micro-timestamp format (-1 if the token never expires)
+     * Expiration date in Epoch-millis format (-1 if the token never expires)
      */
     expiresAt: number;
     /**

src/core/searchResult/Profile.ts

@@ -0,0 +1,29 @@
+import { Profile } from '../security/Profile';
+import { SearchResultBase } from './SearchResultBase';
+
+export class ProfileSearchResult extends SearchResultBase<Profile> {
+  constructor (kuzzle, request, options, response) {
+    super(kuzzle, request, options, response);
+
+    this._searchAction = 'searchProfiles';
+    this._scrollAction = 'scrollProfiles';
+    this.hits = response.hits.map(hit => (
+      new Profile(this._kuzzle, hit._id, hit._source)
+    ));
+  }
+
+  next () {
+    return super.next()
+      .then((nextSearchResult: ProfileSearchResult) => {
+        if (! nextSearchResult) {
+          return null;
+        }
+
+        nextSearchResult.hits = nextSearchResult._response.hits.map(hit => (
+          new Profile(nextSearchResult._kuzzle, hit._id, hit._source)
+        ));
+
+        return nextSearchResult;
+      });
+  }
+}

src/core/searchResult/Role.js → src/core/searchResult/Role.ts

@@ -1,15 +1,17 @@
-const { Role } = require('../security/Role');
-const { SearchResultBase } = require('./SearchResultBase');
+import { Role } from '../security/Role';
+import { SearchResultBase } from './SearchResultBase';
 
-class RoleSearchResult extends SearchResultBase {
+export class RoleSearchResult extends SearchResultBase<Role> {
 
   constructor (kuzzle, query, options, response) {
     super(kuzzle, query, options, response);
 
     this._searchAction = 'searchRoles';
     this._scrollAction = null; // scrollRoles action does not exists in Kuzzle API.
 
-    this.hits = this._response.hits.map(hit => new Role(this._kuzzle, hit._id, hit._source.controllers));
+    this.hits = this._response.hits.map(hit => (
+      new Role(this._kuzzle, hit._id, hit._source.controllers)
+    ));
   }
 
   next () {
@@ -20,16 +22,16 @@ class RoleSearchResult extends SearchResultBase {
     }
 
     return super.next()
-      .then(nextSearchResult => {
+      .then((nextSearchResult: RoleSearchResult) => {
         if (! nextSearchResult) {
           return null;
         }
 
-        nextSearchResult.hits = nextSearchResult._response.hits.map(hit => new Role(nextSearchResult._kuzzle, hit._id, hit._source.controllers));
+        nextSearchResult.hits = nextSearchResult._response.hits.map(hit => (
+          new Role(nextSearchResult._kuzzle, hit._id, hit._source.controllers)
+        ));
 
         return nextSearchResult;
       });
   }
 }
-
-module.exports = { RoleSearchResult };

src/core/searchResult/SearchResultBase.ts

@@ -55,17 +55,10 @@ export class SearchResultBase<T> implements SearchResult<T> {
 
   public fetched: number;
 
-  /**
-   *
-   * @param {Kuzzle} kuzzle
-   * @param {object} request
-   * @param {object} options
-   * @param {object} response
-   */
   constructor (
     kuzzle: Kuzzle,
     request: KuzzleRequest = {},
-    options: any = {},
+    options: JSONObject = {},
     response: any = {}
   ) {
     Reflect.defineProperty(this, '_kuzzle', {
@@ -80,10 +73,18 @@ export class SearchResultBase<T> implements SearchResult<T> {
     Reflect.defineProperty(this, '_response', {
       value: response
     });
-
-    this._controller = request.controller;
-    this._searchAction = 'search';
-    this._scrollAction = 'scroll';
+    Reflect.defineProperty(this, '_controller', {
+      value: request.controller,
+      writable: true
+    });
+    Reflect.defineProperty(this, '_searchAction', {
+      value: 'search',
+      writable: true
+    });
+    Reflect.defineProperty(this, '_scrollAction', {
+      value: 'scroll',
+      writable: true
+    });
 
     this.aggregations = response.aggregations;
     this.hits = response.hits || [];
@@ -166,7 +167,7 @@ export class SearchResultBase<T> implements SearchResult<T> {
     return Promise.reject(new Error('Unable to retrieve next results from search: missing scrollId, from/sort, or from/size params'));
   }
 
-  _get (object, path) {
+  protected _get (object, path) {
     if (!object) {
       return object;
     }
@@ -179,15 +180,14 @@ export class SearchResultBase<T> implements SearchResult<T> {
     return this._get(object[key], path);
   }
 
-  _buildNextSearchResult (response) {
+  protected _buildNextSearchResult (response) {
     const Constructor: any = this.constructor;
 
     const nextSearchResult = new Constructor(this._kuzzle, this._request, this._options, response.result);
     nextSearchResult.fetched += this.fetched;
 
     return nextSearchResult;
   }
-
 }
 
 

src/core/searchResult/Specifications.js → src/core/searchResult/Specifications.ts

@@ -1,6 +1,7 @@
-const { SearchResultBase } = require('./SearchResultBase');
+import { SearchResultBase } from './SearchResultBase';
+import { JSONObject } from '../../utils/interfaces';
 
-class SpecificationsSearchResult extends SearchResultBase {
+export class SpecificationsSearchResult extends SearchResultBase<JSONObject> {
 
   constructor (kuzzle, query, options, response) {
     super(kuzzle, query, options, response);
@@ -10,5 +11,3 @@ class SpecificationsSearchResult extends SearchResultBase {
     this._scrollAction = 'scrollSpecifications';
   }
 }
-
-module.exports = { SpecificationsSearchResult };

src/core/searchResult/User.ts

@@ -0,0 +1,30 @@
+import { SearchResultBase } from './SearchResultBase';
+import { User } from '../security/User';
+
+export class UserSearchResult extends SearchResultBase<User> {
+
+  constructor (kuzzle, query, options, response) {
+    super(kuzzle, query, options, response);
+
+    this._searchAction = 'searchUsers';
+    this._scrollAction = 'scrollUsers';
+    this.hits = this._response.hits.map(hit => (
+      new User(this._kuzzle, hit._id, hit._source)
+    ));
+  }
+
+  next () {
+    return super.next()
+      .then((nextSearchResult: UserSearchResult) => {
+        if (! nextSearchResult) {
+          return null;
+        }
+
+        nextSearchResult.hits = nextSearchResult._response.hits.map(hit => (
+          new User(nextSearchResult._kuzzle, hit._id, hit._source)
+        ));
+
+        return nextSearchResult;
+      });
+  }
+}

src/core/security/Profile.ts

@@ -52,6 +52,3 @@ export class Profile {
       options);
   }
 }
-
-module.exports = { Profile };
-

src/utils/interfaces.ts

@@ -21,6 +21,7 @@ export interface KuzzleRequest extends JSONObject {
   jwt?: string;
   volatile?: JSONObject;
   body?: JSONObject;
+  [key: string]: any;
 }
 
 /**
@@ -88,8 +89,14 @@ export interface ProfilePolicy {
  * @see https://docs.kuzzle.io/core/2/guides/essentials/security#defining-roles
  */
 export interface RoleRightsDefinition {
+  /**
+   * API controller name
+   */
   [key: string]: {
     actions: {
+      /**
+       * API action name
+       */
       [key: string]: boolean
     }
   }
@@ -112,7 +119,7 @@ export interface ApiKey {
      */
     userId: string;
     /**
-     * Expiration date in UNIX micro-timestamp format (-1 if the token never expires)
+     * Expiration date in Epoch-millis format (-1 if the token never expires)
      */
     expiresAt: number;
     /**
@@ -178,6 +185,11 @@ export interface Document {
 
 /**
  * Document retrieved from a search
+ *
+ * @property _id
+ * @property _version
+ * @property _source
+ * @property _score
  */
 export interface DocumentHit extends Document {
   /**