Merge pull request #544 from kuzzleio/7.4.0-proposal

# [7.4.0](https://github.com/kuzzleio/sdk-javascript/releases/tag/7.4.0) (2020-08-18)


#### New features

- [ [#542](#542) ] Finalize typescript support   ([Aschen](https://github.com/Aschen))
- [ [#529](#529) ] Add typescript support for protocols   ([Aschen](https://github.com/Aschen))

#### Enhancements

- [ [#541](#541) ] Add meaningful stacktrace   ([Aschen](https://github.com/Aschen))
- [ [#537](#537) ] Add typescript support realtime   ([Aschen](https://github.com/Aschen))
- [ [#531](#531) ] Add typescript support for Index and Collection controllers   ([Aschen](https://github.com/Aschen))
- [ [#530](#530) ] Add typescript support for search results   ([Aschen](https://github.com/Aschen))
- [ [#523](#523) ] Add support for the collection:delete API action   ([morgandruesne](https://github.com/morgandruesne))
---

Author: Aschen

.eslintignore

@@ -3,12 +3,26 @@ src/**/*.d.ts
 src/**/*.js.map
 
 src/Kuzzle.js
+src/KuzzleError.js
 src/controllers/Auth.js
 src/controllers/Document.js
+src/controllers/Realtime.js
+src/controllers/Index.js
+src/controllers/Collection.js
 src/controllers/Base.js
 src/core/security/User.js
 src/core/security/Profile.js
 src/core/security/Role.js
+src/protocols/abstract/Base.js
+src/protocols/abstract/Realtime.js
+src/protocols/Http.js
+src/protocols/WebSocket.js
+src/protocols/index.js
 src/utils/interfaces.js
+src/core/KuzzleEventEmitter.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

.eslintc-ts.json renamed to .eslintrc-ts.json

@@ -31,12 +31,26 @@ test-*.js
 *.js.map
 index.js
 src/Kuzzle.js
+src/KuzzleError.js
 src/controllers/Auth.js
 src/controllers/Document.js
+src/controllers/Index.js
+src/controllers/Collection.js
 src/controllers/Base.js
+src/controllers/Realtime.js
 src/core/security/User.js
 src/core/security/Profile.js
 src/core/security/Role.js
+src/protocols/abstract/Base.js
+src/protocols/abstract/Realtime.js
+src/protocols/Http.js
+src/protocols/WebSocket.js
+src/protocols/index.js
 src/utils/interfaces.js
+src/core/KuzzleEventEmitter.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

@@ -32,6 +32,7 @@ jobs:
 
       install:
         - npm install
+        - npm run build
 
       script:
         - npm run test:lint
@@ -78,7 +79,7 @@ jobs:
         - npm install
         - npm run build
       script:
-        - npm run doc-testing
+        - travis_retry npm run doc-testing
 
     - stage: Tests
       name: Dead link check
@@ -93,7 +94,7 @@ jobs:
         - $(npm bin)/kuzdoc framework:link -d /sdk/js/7/ -v 7
       script:
         - gem install typhoeus
-        - cd doc/framework/ && HYDRA_MAX_CONCURRENCY=20 ruby .ci/dead-links.rb -p src/sdk/js/7/
+        - cd doc/framework/ && HYDRA_MAX_CONCURRENCY=20 travis_retry ruby .ci/dead-links.rb -p src/sdk/js/7/
 
     - stage: Deployment Doc Dev
       name: Deploy next-docs.kuzzle.io

.travis.yml

@@ -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/auth/create-api-key/index.md

@@ -2,7 +2,7 @@ name: auth#createApiKey
 description: Creates a new API key for the currently loggued user.
 hooks:
   before: >
-    curl -H "Content-type: application/json" -d '{
+    curl --fail -H "Content-type: application/json" -d '{
       "content": {
         "profileIds": ["default"]
       },

doc/7/controllers/auth/create-api-key/snippets/create-api-key.test.yml

@@ -1,5 +1,5 @@
 try {
-  await kuzzle.auth.login('local', { username: 'john.doe', password: 'password' });
+  await kuzzle.auth.login('local', { username: 'jane.doe', password: 'password' });
 
   await kuzzle.auth.deleteApiKey('fQRa28BsidO6V_wmOcL');
 

doc/7/controllers/auth/delete-api-key/snippets/delete-api-key.js

@@ -2,23 +2,23 @@ name: auth#deleteApiKey
 description: Deletes an API key for the currently loggued user
 hooks:
   before: >
-    curl -H "Content-type: application/json" -d '{
+    curl --fail -H "Content-type: application/json" -d '{
       "content": {
         "profileIds": ["default"]
       },
       "credentials": {
         "local": {
-          "username": "john.doe",
+          "username": "jane.doe",
           "password": "password"
         }
       }
-    }' "kuzzle:7512/users/john.doe/_create?refresh=wait_for"
+    }' "kuzzle:7512/users/jane.doe/_create?refresh=wait_for"
     &&
     curl -XPOST -H "Content-type: application/json" -d '{
       "description": "Sigfox API key"
-    }' "kuzzle:7512/users/john.doe/api-keys/_create?_id=fQRa28BsidO6V_wmOcL&refresh=wait_for"
+    }' "kuzzle:7512/users/jane.doe/api-keys/_create?_id=fQRa28BsidO6V_wmOcL&refresh=wait_for"
   after:
-    curl -XDELETE kuzzle:7512/users/john.doe
+    curl -XDELETE kuzzle:7512/users/jane.doe
 template: default
 expected:
   - API key successfully deleted

doc/7/controllers/auth/delete-api-key/snippets/delete-api-key.test.yml

@@ -1,22 +1,22 @@
 try {
   const promises = [];
 
-  // Create some API keys for user "john.doe"
+  // Create some API keys for user "jared.doe"
   promises.push(
-    kuzzle.security.createApiKey('john.doe', 'Sigfox API key'));
+    kuzzle.security.createApiKey('jared.doe', 'Sigfox API key'));
   promises.push(
-    kuzzle.security.createApiKey('john.doe', 'LoRa 6 month API key', {
+    kuzzle.security.createApiKey('jared.doe', 'LoRa 6 month API key', {
       expiresIn: '6m'
     }));
   promises.push(
-    kuzzle.security.createApiKey('john.doe', 'LoRa permanent API key', {
+    kuzzle.security.createApiKey('jared.doe', 'LoRa permanent API key', {
       refresh: 'wait_for'
     }));
 
   await Promise.all(promises);
 
-  // Log as "john.doe"
-  await kuzzle.auth.login('local', { username: 'john.doe', password: 'password' });
+  // Log as "jared.doe"
+  await kuzzle.auth.login('local', { username: 'jared.doe', password: 'password' });
 
   const results = await kuzzle.auth.searchApiKeys({
     match: {
@@ -33,7 +33,7 @@ try {
         "_id": "znEwbG8BJASM_0-bWU-q",
         "_source": {
           "description": "LoRa permanent API key",
-          "userId": "john.doe",
+          "userId": "jared.doe",
           "expiresAt": -1,
           "ttl": -1
         }
@@ -42,7 +42,7 @@ try {
         "_id": "zXEwbG8BJASM_0-bWU-q",
         "_source": {
           "description": "LoRa 1 year API key",
-          "userId": "john.doe",
+          "userId": "jared.doe",
           "expiresAt": 31557600000,
           "ttl": 360000
         }

doc/7/controllers/auth/search-api-keys/snippets/search-api-keys.js

@@ -2,19 +2,19 @@ name: auth#searchApiKeys
 description: Searches API keys for the currently loggued user.
 hooks:
   before: >
-    curl -H "Content-type: application/json" -d '{
+    curl --fail -H "Content-type: application/json" -d '{
       "content": {
         "profileIds": ["default"]
       },
       "credentials": {
         "local": {
-          "username": "john.doe",
+          "username": "jared.doe",
           "password": "password"
         }
       }
-    }' "kuzzle:7512/users/john.doe/_create?refresh=wait_for"
+    }' "kuzzle:7512/users/jared.doe/_create?refresh=wait_for"
   after:
-    curl -XDELETE kuzzle:7512/users/john.doe
+    curl -XDELETE kuzzle:7512/users/jared.doe
 template: default
 expected:
   - Found 2 API keys matching "LoRa"