Add typescript support realtime

.eslintignore

@@ -5,6 +5,7 @@ src/**/*.js.map
 src/Kuzzle.js
 src/controllers/Auth.js
 src/controllers/Document.js
+src/controllers/Realtime.js
 src/controllers/Base.js
 src/core/security/User.js
 src/core/security/Profile.js

.gitignore

@@ -33,6 +33,7 @@ index.js
 src/Kuzzle.js
 src/controllers/Auth.js
 src/controllers/Document.js
+src/controllers/Realtime.js
 src/controllers/Base.js
 src/core/security/User.js
 src/core/security/Profile.js

.travis.yml

@@ -78,7 +78,7 @@ jobs:
         - npm install
         - npm run build
       script:
-        - npm run doc-testing
+        - travis_retry npm run doc-testing
 
     - stage: Tests
       name: Dead link check

doc/7/controllers/auth/create-api-key/index.md

@@ -56,7 +56,7 @@ The API key content has the following properties:
 | Name      | Type              | Description      |
 | --------- | ----------------- | ---------------- |
 | `userId`      | <pre>string</pre> | User kuid |
-| `expiresAt`  | <pre>number</pre> | Expiration date in UNIX micro-timestamp format (`-1` if the token never expires) |
+| `expiresAt`  | <pre>number</pre> | Expiration date in Epoch-millis format (`-1` if the token never expires) |
 | `ttl`  | <pre>number</pre> | Original TTL |
 | `description`  | <pre>string</pre> | API key description |
 | `token`  | <pre>string</pre> | Authentication token associated with this API key |

doc/7/controllers/realtime/count/index.md

@@ -32,7 +32,7 @@ Additional query options
 
 ## Resolves
 
-Resolves to a number represensting active connections using the same provided subscription room.
+Resolves to a number representing active connections using the same provided subscription room.
 
 ## Usage
 

doc/7/controllers/security/create-api-key/index.md

@@ -57,7 +57,7 @@ The API key content has the following properties:
 | Name      | Type              | Description      |
 | --------- | ----------------- | ---------------- |
 | `userId`      | <pre>string</pre> | User kuid |
-| `expiresAt`  | <pre>number</pre> | Aexpiration date in UNIX micro-timestamp format (`-1` if the token never expires) |
+| `expiresAt`  | <pre>number</pre> | Aexpiration date in Epoch-millis format (`-1` if the token never expires) |
 | `ttl`  | <pre>number</pre> | Original TTL |
 | `description`  | <pre>string</pre> | API key description |
 | `token`  | <pre>string</pre> | Authentication token associated with this API key |

doc/7/controllers/security/m-delete-profiles/snippets/m-delete-profiles.test.yml

@@ -8,4 +8,4 @@ hooks:
       }' kuzzle:7512/profiles/profile${i}/_create
     done
 template: default
-expected: '^\[ ''profile\d'', ''profile\d'', ''profile\d'', ''profile\d', ''profile\d'' \]$'
+expected: '^\[ ''profile\d'', ''profile\d'', ''profile\d'', ''profile\d'', ''profile\d'' \]$'

doc/7/controllers/security/m-delete-roles/snippets/m-delete-roles.test.yml

@@ -14,4 +14,4 @@ hooks:
       }' kuzzle:7512/roles/role${i}/_create
     done
 template: default
-expected: '^\[ ''role1'', ''role2'', ''role3'', ''role4'', ''role5'' \]$'
+expected: '^\[ ''role\d'', ''role\d'', ''role\d'', ''role\d'', ''role\d'' \]$'

doc/7/essentials/realtime-notifications/index.md

@@ -23,7 +23,7 @@ These notifications represent [documents changes & messages](/core/2/api/essenti
 | `protocol`   | <pre>string</pre> | Network protocol used to modify the document                                                          |
 | `result`     | <pre>object</pre> | Notification content                                                                                  |
 | `room`       | <pre>string</pre> | Subscription channel identifier. Can be used to link a notification to its corresponding subscription |
-| `scope`      | <pre>string</pre> | `in`: document enters (or stays) in the scope<br/out`: document leaves the scope                      |
+| `scope`      | <pre>string</pre> | `in`: document enters (or stays) in the scope<br/>`out`: document leaves the scope                      |
 | `timestamp`  | <pre>number</pre> | Timestamp of the event, in Epoch-millis format                                                        |
 | `type`       | <pre>string</pre> | `document`: Notification type                                                                         |
 | `volatile`   | <pre>object</pre> | Request [volatile data](/core/2/api/essentials/volatile-data)                                        |
@@ -50,7 +50,7 @@ These notifications represent [user events](/core/2/api/essentials/notifications
 | `room`       | <pre>string</pre> | Subscription channel identifier. Can be used to link a notification to its corresponding subscription |
 | `timestamp`  | <pre>number</pre> | Timestamp of the event, in Epoch-millis format                                                        |
 | `type`       | <pre>string</pre> | `user`: Notification type                                                                             |
-| `user`       | <pre>string</pre> | `in`: a new user has subscribed to the same filters<br/out`: a user cancelled a shared subscription   |
+| `user`       | <pre>string</pre> | `in`: a new user has subscribed to the same filters<br/>`out`: a user cancelled a shared subscription   |
 | `volatile`   | <pre>object</pre> | Request [volatile data](/core/2/api/essentials/volatile-data)                                        |
 
 The `result` object is the notification content, and it has the following structure:

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,10 +32,11 @@ const exported = {
   DocumentSearchResult,
   ProfileSearchResult,
   RoleSearchResult,
-  SpecificationSearchResult,
+  SpecificationsSearchResult,
   UserSearchResult
-}
+};
 
 export default exported;
 
+
 module.exports = exported;

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/controllers/Document.ts

@@ -27,7 +27,7 @@ export class DocumentController extends BaseController {
   count (
     index: string,
     collection: string,
-    body: JSONObject = null,
+    body?: JSONObject,
     options: { queuable?: boolean } = {}
   ): Promise<number> {
     const request = {