Merge pull request #624 from kuzzleio/7.6.0-proposal

# [7.6.0](https://github.com/kuzzleio/sdk-javascript/releases/tag/7.6.0) (2021-04-06)


#### Bug fixes

- [ [#622](#622) ] Pick first route when multiple non-GET routes of the same size are available   ([scottinet](https://github.com/scottinet))

#### New features

- [ [#621](#621) ] Secure WebSocket connection with cookie authentication   ([Shiranuit](https://github.com/Shiranuit))
- [ [#613](#613) ] Implement index:stats   ([Leodau](https://github.com/Leodau))
- [ [#612](#612) ] Implement security:getUserStrategies   ([Leodau](https://github.com/Leodau))

#### Enhancements

- [ [#620](#620) ] Add kuzzleStack property to KuzzleError   ([Aschen](https://github.com/Aschen))
- [ [#617](#617) ] Add suggest to search result   ([Aschen](https://github.com/Aschen))
- [ [#614](#614) ] Print deprecation warning from Kuzzle   ([MathieuVeber](https://github.com/MathieuVeber))
- [ [#606](#606) ] Add _source property to user objects   ([Aschen](https://github.com/Aschen))
---

Author: Aschen

.eslintignore

@@ -27,3 +27,5 @@ src/core/searchResult/Profile.js
 src/core/searchResult/Role.js
 src/core/searchResult/Specifications.js
 src/core/searchResult/User.js
+src/utils/Deprecation.js
+src/utils/interfaces.js

.gitignore

@@ -55,3 +55,5 @@ src/core/searchResult/Profile.js
 src/core/searchResult/Role.js
 src/core/searchResult/Specifications.js
 src/core/searchResult/User.js
+src/utils/Deprecation.js
+src/utils/interfaces.js

doc/7/controllers/index/stats/index.md

@@ -0,0 +1,41 @@
+---
+code: true
+type: page
+title: stats
+description: Gets detailed storage statistics
+---
+
+# stats
+
+<SinceBadge version="Kuzzle 2.10.0"/>
+<SinceBadge version="7.6.0"/>
+
+Gets detailed storage usage statistics.
+
+<br/>
+
+```js
+stats([options]);
+```
+
+<br/>
+
+| Arguments | Type              | Description   |
+| --------- | ----------------- | ------------- |
+| `options` | <pre>object</pre> | Query options |
+
+### options
+
+Additional query options
+
+| Property   | Type<br/>(default)              | Description                                                                  |
+| ---------- | ------------------------------- | ---------------------------------------------------------------------------- |
+| `queuable` | <pre>boolean</pre><br/>(`true`) | If true, queues the request during downtime, until connected to Kuzzle again |
+
+## Resolves
+
+Returns detailed storage usage statistics: overall index/collection sizes and the number of documents per collection.
+
+## Usage
+
+<<< ./snippets/stats.js

doc/7/controllers/index/stats/snippets/stats.js

@@ -0,0 +1,21 @@
+const stats = await kuzzle.index.stats();
+
+console.log(JSON.stringify(stats));
+/*
+  {
+    "indexes":[
+      {
+        "name":"nyc-open-data",
+        "size":42,
+        "collections":[
+          {
+            "name":"yellow-taxi",
+            "documentCount":42,
+            "size":42
+          }
+        ]
+      }
+    ],
+    "size":42
+  }
+*/

doc/7/controllers/index/stats/snippets/stats.test.yml

@@ -0,0 +1,10 @@
+---
+name: index#stats
+description: Gets detailed storage statistics
+hooks:
+  before: |
+    curl -X POST kuzzle:7512/nyc-open-data/_create
+    curl -XPUT kuzzle:7512/nyc-open-data/yellow-taxi
+  after: curl -X DELETE kuzzle:7512/nyc-open-data
+template: catch
+expected: ["documentCount":0]

doc/7/controllers/security/create-user/snippets/create-user.test.yml

@@ -6,5 +6,5 @@ template: default
 expected:
   - "User {"
   - "_id: 'jdoe',"
-  - "content: {"
+  - "_source: {"
   - "profileIds: \\[ \\'default\\' \\],"

doc/7/controllers/security/get-user-strategies/index.md

@@ -0,0 +1,40 @@
+---
+code: true
+type: page
+title: getUserStrategies
+description: Gets all the available authentication strategies of a user
+---
+
+# getUserStrategies
+
+<SinceBadge version="Kuzzle 2.9.0"/>
+<SinceBadge version="7.6.0"/>
+
+Gets all the available authentication strategies of a user.
+
+<br />
+
+```js
+getUserStrategies(kuid, [options]);
+```
+
+<br />
+
+| Property | Type | Description |
+|--- |--- |--- |
+| `kuid` | <pre>string</pre> | User [kuid](/core/2/guides/main-concepts/authentication#kuzzle-user-identifier-kuid) |
+| `options` | <pre>object</pre> | Query options |
+
+### options
+
+| Property | Type<br />(default) | Description |
+| --- | --- | --- |
+| `queuable` | <pre>boolean</pre><br />(`true`) | If true, queues the request during downtime, until connected to Kuzzle again |
+
+## Resolves
+
+Resolves to an array of strings containing all the authentication strategies available for the requested user.
+
+## Usage
+
+<<< ./snippets/get-user-strategies.js

doc/7/controllers/security/get-user-strategies/snippets/get-user-strategies.js

@@ -0,0 +1,4 @@
+const strategies = await kuzzle.security.getUserStrategies('john.doe');
+
+console.log(strategies);
+// [ 'local' ]

doc/7/controllers/security/get-user-strategies/snippets/get-user-strategies.test.yml

@@ -0,0 +1,20 @@
+name: security#getUserStrategies
+description: get user strategies
+hooks:
+  before: >
+    curl --fail -H "Content-type: application/json" -d '{
+      "content": {
+        "profileIds": [ "default" ],
+        "fullName": "John Doe"
+      },
+      "credentials": {
+        "local": {
+          "username": "jdoe",
+          "password": "password"
+        }
+      }
+    }' kuzzle:7512/users/john.doe/_create
+  after: curl -XDELETE kuzzle:7512/users/john.doe
+template: catch
+expected:
+  - "[ 'local' ]"

doc/7/core-classes/kuzzle-error/properties/index.md

@@ -9,11 +9,12 @@ order: 10
 
 # Properties
 
-| Property name        | Type     | Description          |
-| -------------------- | -------- | --------------------------------------- |
-| `message`            | <pre>string</pre> | Error message    |
-| `status`             | <pre>number</pre> | Error status code      |
-| `stack`              | <pre>string</pre> | Error stacktrace (only in development mode)   |
-| `id`  | <pre>string</pre> | Error unique identifier                    |
-| `code`  | <pre>string</pre> | Error unique code                    |
+| Property name | Type              | Description                                                         |
+|---------------|-------------------|---------------------------------------------------------------------|
+| `kuzzleStack` | <pre>string</pre> | Kuzzle stacktrace (only in development mode)                        |
+| `message`     | <pre>string</pre> | Error message                                                       |
+| `status`      | <pre>number</pre> | Error status code                                                   |
+| `stack`       | <pre>string</pre> | Complete error stacktrace (Kuzzle + SDK) (only in development mode) |
+| `id`          | <pre>string</pre> | Error unique identifier                                             |
+| `code`        | <pre>string</pre> | Error unique code                                                   |