Merge pull request #684 from kuzzleio/7.8.3-proposal

# [7.8.3](https://github.com/kuzzleio/sdk-javascript/releases/tag/7.8.3) (2022-01-27)


#### Bug fixes

- [ [#683](#683) ] Fix authenticator token verification   ([Shiranuit](https://github.com/Shiranuit))

#### Enhancements

- [ [#680](#680) ] Add debug mode   ([Aschen](https://github.com/Aschen))
- [ [#676](#676) ] Add HTTP protocol support for Observer   ([Aschen](https://github.com/Aschen))
- [ [#667](#667) ] Support entire query for security:searchProfiles   ([Aschen](https://github.com/Aschen))
- [ [#669](#669) ] Add more context to errors   ([clementbolin](https://github.com/clementbolin))

#### Others

- [ [#674](#674) ] Add types for mRequests and mResponses   ([Aschen](https://github.com/Aschen))
---

Author: Aschen

.eslintignore

@@ -32,3 +32,7 @@ src/core/searchResult/Specifications.js
 src/core/searchResult/User.js
 src/utils/Deprecation.js
 src/utils/interfaces.js
+src/controllers/Server.js
+src/core/Observer.js
+src/core/RealtimeDocument.js
+src/core/searchResult/RealtimeDocument.js

.gitignore

@@ -61,3 +61,7 @@ src/core/searchResult/Specifications.js
 src/core/searchResult/User.js
 src/utils/Deprecation.js
 src/utils/interfaces.js
+src/controllers/Server.js
+src/core/Observer.js
+src/core/RealtimeDocument.js
+src/core/searchResult/RealtimeDocument.js

doc/7/controllers/security/m-get-profiles/snippets/m-get-profiles.js

@@ -5,7 +5,7 @@ try {
     'profile3'
   ]);
 
-  console.log(response);
+  console.log(`Successfully retrieved ${response.length} profiles`);
   /*
   [ Profile {
       _id: 'profile1',

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

@@ -12,4 +12,4 @@ hooks:
       curl -XDELETE kuzzle:7512/profiles/profile${i}
     done
 template: default
-expected: '.*Profile.*_id.*rateLimit.*policies.*'
+expected: Successfully retrieved 3 profiles

doc/7/controllers/security/search-profiles/index.md

@@ -7,7 +7,15 @@ description: Searches security profiles, optionally returning only those linked
 
 # searchProfiles
 
-Searches security profiles, optionally returning only those linked to the provided list of security roles.
+Searches security profiles.
+
+<SinceBadge version="7.8.3" />
+<SinceBadge version="Kuzzle 2.14.1" />
+
+Support for search using a search query with the `query` property.
+
+This method also supports the [Koncorde Filters DSL](/core/2/api/koncorde-filters-syntax) to match documents by passing the `lang` argument with the value `koncorde`.  
+Koncorde filters will be translated into an Elasticsearch query.  
 
 <br />
 
@@ -19,21 +27,24 @@ searchProfiles([body], [options]);
 
 | Property | Type | Description |
 |--- |--- |--- |
-| `body` | <pre>object</pre> | Query including role identifiers to search for |
+| `body` | <pre>object</pre> | Search query |
 | `options` | <pre>object</pre> | Query options |
 
 ### body
-
 | Property | Type | Description |
 | --- | --- | --- |
-| `roles` | <pre>array&lt;string&gt;</pre> | Role identifiers |
+| `roles` | <pre>array&lt;string&gt;</pre> | Role identifiers <DeprecatedBadge version="7.8.3"/>|
+| `query` | <pre>object</pre> | Search query using the [ElasticSearch Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/7.4/query-dsl.html) or the [Koncorde Filters DSL](/core/2/api/koncorde-filters-syntax) syntax. <SinceBadge version="7.8.3"/>|
+
+If the body is left empty, the result will return all available profiles.
 
 ### options
 
 | Property   | Type<br/>(default)              | Description                                                                                                                                                                                                       |
 | ---------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | `queuable` | <pre>boolean</pre><br/>(`true`) | If true, queues the request during downtime, until connected to Kuzzle again                                                                                                                                      |
 | `from`     | <pre>number</pre><br/>(`0`)     | Offset of the first document to fetch                                                                                                                                                                             |
+| `lang`     | <pre>string</pre>               | Specify the query language to use. By default, it's `elasticsearch` but `koncorde` can also be used. |
 | `size`     | <pre>number</pre><br/>(`10`)    | Maximum number of documents to retrieve per page                                                                                                                                                                  |
 | `scroll`   | <pre>string</pre><br/>(`""`)    | When set, gets a forward-only cursor having its ttl set to the given value (ie `30s`; cf [elasticsearch time limits](https://www.elastic.co/guide/en/elasticsearch/reference/7.3/common-options.html#time-units)) |
 

doc/7/controllers/security/search-profiles/snippets/search-profiles.js

@@ -1,6 +1,8 @@
 try {
   const results = await kuzzle.security.searchProfiles({
-    roles: [ 'default' ]
+    query: {
+      term: { 'policies.roleId': 'default' }
+    }
   });
 
   console.log(results);

doc/7/controllers/security/search-profiles/snippets/search-profiles.test.yml

@@ -12,4 +12,4 @@ hooks:
       curl -XDELETE kuzzle:7512/profiles/profile${i}
     done
 template: default
-expected: ^Successfully retrieved 4 profiles$
+expected: ^Successfully retrieved \d+ profiles$

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

@@ -9,12 +9,19 @@ order: 10
 
 # Properties
 
-| 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                                                   |
-
+| 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                                                                                    |
+| `controller`  | <pre>string</pre> | API controller name                                                                                  |
+| `action`      | <pre>string</pre> | API action name                                                                                      |
+| `volatile`    | <pre>object</pre> | KuzzleRequest [volatile data](https://docs.kuzzle.io/core/2/guides/main-concepts/api/#volatile-data) |
+| `index`       | <pre>string</pre> | Index name                                                                                           |
+| `collection`  | <pre>string</pre> | Collection name name                                                                                 |
+| `requestId`   | <pre>string</pre> | request id name                                                                                      |
+| `_id`         | <pre>string</pre> | Document unique identifier                                                                           |
+| `count`       | <pre>number</pre> | Number of associated errors (PartialError only)                                                      |

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

@@ -14,6 +14,8 @@ order: 10
 | `connected`     | <pre>boolean</pre>  | Returns `true` if the SDK is currently connected to a Kuzzle server. |
 | `offlineQueue`  | <pre>object[]</pre> | Contains the queued requests during offline mode                     |
 | `protocol`      | <pre>Protocol</pre> | Protocol used by the SDK                                             |
+| `events`        | <pre>string[]</pre> | List of every events emitted by the SDK                              |
+
 
 ### connected
 
@@ -42,7 +44,7 @@ See the associated documentation:
 
 The `authenticator` property can be set to a function returning a promise.
 
-This function will be called after a successful reconnection if the current authentication token is not valid anymore.  
+This function will be called after a successful reconnection if the current authentication token is not valid anymore.
 
 This function has to authenticate the SDK. It can be a call to [auth.login](/sdk/js/7/controllers/auth/login) for example.
 

doc/7/core-classes/observer/constructor/index.md

@@ -0,0 +1,38 @@
+---
+code: true
+type: page
+title: constructor
+description: Creates a new Observer object
+order: 50
+---
+
+# Constructor
+
+Use this constructor to create a new Observer instance.
+
+## Arguments
+
+```js
+Observer(sdk, [options]);
+```
+
+<br/>
+
+| Argument  | Type              | Description                    |
+|-----------|-------------------|--------------------------------|
+| `sdk`     | <pre>Kuzzle</pre> | SDK instanciated and connected |
+| `options` | <pre>object</pre> | Additional options             |
+
+### options
+
+Observer options.
+
+| Property       | Type<br/>(default)             | Description                                                  |
+|----------------|--------------------------------|--------------------------------------------------------------|
+| `pullingDelay` | <pre>number</pre><br/>(`5000`) | Refresh delay in ms when the SDK is using the HTTP protocol. |
+
+## Usage
+
+```js
+const observer = new Observer(sdk);
+```