Support "lang" parameter for Koncorde filters

doc/7/controllers/auth/search-api-keys/index.md

@@ -30,6 +30,15 @@ searchApiKeys([query], [options]);
 
 The search query to apply to API keys content, using [ElasticSearch Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/7.3/query-dsl.html) syntax.
 
+<SinceBadge version="auto-version"/>
+
+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.  
+
+::: warning
+Koncorde `bool` operator and `regexp` clause are not supported for search queries.
+:::
+
 If left empty, the result will return all available API keys of the currently loggued user.
 
 ### options
@@ -40,6 +49,7 @@ Additional query options
 | ---------- | ------------------ | ------------ |
 | `from`     | <pre>number</pre><br/>(`0`)     | Offset of the first document to fetch   |
 | `size`     | <pre>number</pre><br/>(`10`)    | Maximum number of documents to retrieve per page     |
+| `lang`     | <pre>string</pre>               | Specify the query language to use. By default, it's `elasticsearch` but `koncorde` can also be used. <SinceBadge version="auto-version"/> |
 
 ## Resolves
 

doc/7/controllers/document/delete-by-query/index.md

@@ -11,6 +11,15 @@ Deletes documents matching the provided search query.
 
 Kuzzle uses the [ElasticSearch Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/7.3/query-dsl.html) syntax.
 
+<SinceBadge version="auto-version"/>
+
+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.  
+
+::: warning
+Koncorde `bool` operator and `regexp` clause are not supported for search queries.
+:::
+
 An empty or null query will match all documents in the collection.
 
 <br/>
@@ -34,6 +43,8 @@ Additional query options
 | ---------- | ------------------------------- | ---------------------------------------------------------------------------------- |
 | `queuable` | <pre>boolean</pre><br/>(`true`) | If true, queues the request during downtime, until connected to Kuzzle again       |
 | `refresh`  | <pre>string</pre><br/>(`""`)    | If set to `wait_for`, waits for the change to be reflected for `search` (up to 1s) |
+| `source`   | <pre>boolean</pre>              | if set to `true` Kuzzle will return each deleted document body in the response |
+| `lang`     | <pre>string</pre>               | Specify the query language to use. By default, it's `elasticsearch` but `koncorde` can also be used. <SinceBadge version="auto-version"/> |
 
 ## Resolves
 

doc/7/controllers/document/search/index.md

@@ -26,6 +26,14 @@ It can lead to memory leaks if a scroll duration too great is provided, or if to
 You can restrict the scroll session maximum duration under the `services.storage.maxScrollDuration` configuration key.
 :::
 
+<SinceBadge version="auto-version"/>
+
+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.  
+
+::: warning
+Koncorde `bool` operator and `regexp` clause are not supported for search queries.
+:::
 
 <br/>
 
@@ -50,6 +58,7 @@ Additional query options
 | `from`     | <pre>number</pre><br/>(`0`)     | Offset of the first document to fetch                                                                                                                                                                             |
 | `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)) |
+| `lang`     | <pre>string</pre>      | Specify the query language to use. By default, it's `elasticsearch` but `koncorde` can also be used. <SinceBadge version="auto-version"/> |
 | `verb`     | <pre>string</pre>      | (HTTP only) Forces the verb of the route |
 
 #### verb
@@ -61,7 +70,7 @@ You can set the `verb` option to `GET` to force the SDK to use the GET API inste
 
 ### Optional:
 
-- `query`: the search query itself, using the [ElasticSearch Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/7.3/query-dsl.html) syntax.
+- `query`: the search query itself, using the [ElasticSearch Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/7.3/query-dsl.html) or the [Koncorde Filters DSL](/core/2/api/koncorde-filters-syntax) syntax.
 - `aggregations`: control how the search results should be [aggregated](https://www.elastic.co/guide/en/elasticsearch/reference/7.3/search-aggregations.html)
 - `sort`: contains a list of fields, used to [sort search results](https://www.elastic.co/guide/en/elasticsearch/reference/7.3/search-request-sort.html), in order of importance.
 

doc/7/controllers/document/update-by-query/index.md

@@ -11,6 +11,15 @@ Updates documents matching the provided search query.
 
 Kuzzle uses the [ElasticSearch Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/7.4/query-dsl.html) syntax.
 
+<SinceBadge version="auto-version"/>
+
+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.  
+
+::: warning
+Koncorde `bool` operator and `regexp` clause are not supported for search queries.
+:::
+
 An empty or null query will match all documents in the collection.
 
 <br/>
@@ -37,7 +46,7 @@ Additional query options.
 | ----------------- | ------------------------------- | ---------------------------------------------------------------------------------- |
 | `refresh`         | <pre>string</pre><br/>(`""`)    | If set to `wait_for`, waits for the change to be reflected for `search` (up to 1s) |
 | `source`          | <pre>boolean</pre><br/>(`false`)| If true, returns the updated document inside the response
-
+| `lang`            | <pre>string</pre>               | Specify the query language to use. By default, it's `elasticsearch` but `koncorde` can also be used. <SinceBadge version="auto-version"/> |
 ## Resolves
 
 Returns an object containing 2 arrays: `successes` and `errors`

doc/7/controllers/security/create-first-admin/index.md

@@ -59,7 +59,7 @@ Example:
 
 ## Resolves
 
-A [`User`](sdk/js/6/core-classes/user/introduction) object containing information about the newly created administrator.
+A [`User`](sdk/js/7/core-classes/user/introduction) object containing information about the newly created administrator.
 
 ## Usage
 

doc/7/controllers/security/create-restricted-user/index.md

@@ -64,7 +64,7 @@ Example:
 
 ## Resolves
 
-A [`User`](sdk/js/6/core-classes/user/introduction) object containing information about the newly created user.
+A [`User`](sdk/js/7/core-classes/user/introduction) object containing information about the newly created user.
 
 ## Usage
 

doc/7/controllers/security/create-user/index.md

@@ -66,7 +66,7 @@ Example:
 
 ## Resolves
 
-A [`User`](sdk/js/6/core-classes/user/introduction) object containing information about the newly created user.
+A [`User`](sdk/js/7/core-classes/user/introduction) object containing information about the newly created user.
 
 ## Usage
 

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

@@ -30,7 +30,7 @@ getUser(kuid, [options]);
 
 ## Resolves
 
-The retrieved [`User`](sdk/js/6/core-classes/user/introduction) object.
+The retrieved [`User`](sdk/js/7/core-classes/user/introduction) object.
 
 ## Usage
 

doc/7/controllers/security/replace-user/index.md

@@ -55,7 +55,7 @@ example:
 
 ## Resolves
 
-An [`User`](sdk/js/6/core-classes/user/introduction) object containing information about the updated user.
+An [`User`](sdk/js/7/core-classes/user/introduction) object containing information about the updated user.
 
 ## Usage
 

doc/7/controllers/security/search-api-keys/index.md

@@ -31,6 +31,15 @@ searchApiKeys(userId, [query], [options]);
 
 The search query to apply to API keys content, using [ElasticSearch Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/7.3/query-dsl.html) syntax.
 
+<SinceBadge version="auto-version"/>
+
+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.  
+
+::: warning
+Koncorde `bool` operator and `regexp` clause are not supported for search queries.
+:::
+
 If left empty, the result will return all available API keys for the user.
 
 ### options
@@ -41,6 +50,7 @@ Additional query options
 | ---------- | ------------------ | ------------ |
 | `from`     | <pre>number</pre><br/>(`0`)     | Offset of the first document to fetch   |
 | `size`     | <pre>number</pre><br/>(`10`)    | Maximum number of documents to retrieve per page     |
+| `lang`     | <pre>string</pre>               | Specify the query language to use. By default, it's `elasticsearch` but `koncorde` can also be used. <SinceBadge version="auto-version"/> |
 
 ## Resolves
 

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

@@ -39,7 +39,7 @@ searchProfiles([body], [options]);
 
 ## Resolves
 
-A [`SearchResult`](sdk/js/6/core-classes/search-result) object containing the retrieved [`Profile`](/sdk/js/7/core-classes/profile) objects.
+A [`SearchResult`](sdk/js/7/core-classes/search-result) object containing the retrieved [`Profile`](/sdk/js/7/core-classes/profile) objects.
 
 ## Usage
 

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

@@ -38,7 +38,7 @@ searchRoles([body], [options]);
 
 ## Resolves
 
-A [`SearchResult`](sdk/js/6/core-classes/search-result) object containing the retrieved [`Role`](/sdk/js/7/core-classes/role) objects.
+A [`SearchResult`](sdk/js/7/core-classes/search-result) object containing the retrieved [`Role`](/sdk/js/7/core-classes/role) objects.
 
 ## Usage
 

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

@@ -24,7 +24,16 @@ searchUsers([query], [options]);
 
 ### query
 
-The search query to apply to users content, using [ElasticSearch Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/7.3/query-dsl.html) syntax.
+The search query to apply to users content, using [ElasticSearch Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/7.3/query-dsl.html) or the [Koncorde Filters DSL](/core/2/api/koncorde-filters-syntax) syntax.
+
+<SinceBadge version="auto-version"/>
+
+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.  
+
+::: warning
+Koncorde `bool` operator and `regexp` clause are not supported for search queries.
+:::
 
 If left empty, the result will return all available users.
 
@@ -36,10 +45,11 @@ If left empty, the result will return all available users.
 | `from`     | <pre>number</pre><br/>(`0`)     | Offset of the first document to fetch                                                                                                                                                                             |
 | `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)) |
+| `lang`     | <pre>string</pre>               | Specify the query language to use. By default, it's `elasticsearch` but `koncorde` can also be used. <SinceBadge version="auto-version"/> |
 
 ## Resolves
 
-A [`SearchResult`](sdk/js/6/core-classes/search-result) object containing the retrieved [`User`](/sdk/js/7/core-classes/user) objects.
+A [`SearchResult`](sdk/js/7/core-classes/search-result) object containing the retrieved [`User`](/sdk/js/7/core-classes/user) objects.
 
 ## Usage
 

doc/7/controllers/security/update-user/index.md

@@ -50,7 +50,7 @@ Example:
 
 ## Resolves
 
-A [`User`](sdk/js/6/core-classes/user/introduction) object containing information about the updated user.
+A [`User`](sdk/js/7/core-classes/user/introduction) object containing information about the updated user.
 
 ## Usage
 

src/controllers/Auth.ts

@@ -125,7 +125,7 @@ export class AuthController extends BaseController {
    */
   searchApiKeys(
     query: JSONObject = {},
-    options: { from?: number, size?: number } = {}
+    options: { from?: number, size?: number, lang?: string } = {}
   ): Promise<{
     /**
      * Array of found ApiKeys
@@ -140,6 +140,7 @@ export class AuthController extends BaseController {
       action: 'searchApiKeys',
       from: options.from,
       size: options.size,
+      lang: options.lang,
       body: query
     };
 

src/controllers/Document.ts

@@ -635,6 +635,7 @@ export class DocumentController extends BaseController {
       from?: number;
       size?: number;
       scroll?: string;
+      lang?: string;
       verb?: string;
     } = {}
   ): Promise<SearchResult<DocumentHit>> {
@@ -665,7 +666,7 @@ export class DocumentController extends BaseController {
     else {
       request.body = body;
     }
-    for (const opt of ['from', 'size', 'scroll']) {
+    for (const opt of ['from', 'size', 'scroll', 'lang']) {
       request[opt] = options[opt];
     }
 

src/controllers/Security.js

@@ -75,6 +75,7 @@ class SecurityController extends BaseController {
       action: 'searchApiKeys',
       from: options.from,
       size: options.size,
+      lang: options.lang,
       body: query
     };
 
@@ -423,7 +424,7 @@ class SecurityController extends BaseController {
       body,
       action: 'searchUsers'
     };
-    for (const opt of ['from', 'size', 'scroll']) {
+    for (const opt of ['from', 'size', 'scroll', 'lang']) {
       request[opt] = options[opt];
     }
 

test/controllers/security.test.js

@@ -87,7 +87,8 @@ describe('Security Controller', () => {
         userId: 'kuid',
         body: { match: {} },
         from: 1,
-        size: 2
+        size: 2,
+        lang: undefined
       });
 
       should(result).be.eql({ hits: [1, 2] });
@@ -1108,7 +1109,8 @@ describe('Security Controller', () => {
               body: {foo: 'bar'},
               from: undefined,
               size: undefined,
-              scroll: undefined
+              scroll: undefined,
+              lang: undefined
             }, options);
 
           should(res).be.an.instanceOf(UserSearchResult);
@@ -1139,7 +1141,8 @@ describe('Security Controller', () => {
               body: {foo: 'bar'},
               from: 1,
               size: 2,
-              scroll: '10s'
+              scroll: '10s',
+              lang: undefined
             }, { from: 1, scroll: '10s', size: 2 });
 
           should(res).be.an.instanceOf(UserSearchResult);