Merge pull request #582 from kuzzleio/7.4.8-proposal

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


#### Bug fixes

- [ [#573](#573) ] Fix types for Document and CollectionMappings   ([Aschen](https://github.com/Aschen))

#### Enhancements

- [ [#575](#575) ] Support "lang" parameter for Koncorde filters   ([Yoann-Abbes](https://github.com/Yoann-Abbes))
- [ [#579](#579) ] Add event type to document notification   ([Aschen](https://github.com/Aschen))
- [ [#578](#578) ] Convert bulk controller to TS   ([Aschen](https://github.com/Aschen))
- [ [#574](#574) ] Adds a specific error when the request is too big to use the GET verb    ([Aschen](https://github.com/Aschen))
---

Author: Aschen

.eslintignore

@@ -5,6 +5,7 @@ src/**/*.js.map
 src/Kuzzle.js
 src/KuzzleError.js
 src/controllers/Auth.js
+src/controllers/Bulk.js
 src/controllers/Document.js
 src/controllers/Realtime.js
 src/controllers/Index.js

.gitignore

@@ -33,6 +33,7 @@ index.js
 src/Kuzzle.js
 src/KuzzleError.js
 src/controllers/Auth.js
+src/controllers/Bulk.js
 src/controllers/Document.js
 src/controllers/Index.js
 src/controllers/Collection.js

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="7.4.8"/>
+
+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="7.4.8"/> |
 
 ## Resolves
 
@@ -60,4 +70,10 @@ Each object of the `hits` array has the following properties:
 
 ## Usage
 
-<<< ./snippets/search-api-keys.js
+With the [ElasticSearch Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/7.4/query-dsl.html) syntax.
+
+<<< ./snippets/search-api-keys-es.js
+
+With the [Koncorde Filters DSL](/core/2/api/koncorde-filters-syntax) syntax.
+
+<<< ./snippets/search-api-keys-koncorde.js

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

@@ -1,4 +1,4 @@
-name: auth#searchApiKeys
+name: auth#searchApiKeys-es
 description: Searches API keys for the currently loggued user.
 hooks:
   before: >

doc/7/controllers/auth/search-api-keys/snippets/search-api-keys.test.yml renamed to doc/7/controllers/auth/search-api-keys/snippets/search-api-keys-es.test.yml

@@ -0,0 +1,68 @@
+try {
+  const promises = [];
+
+  // Create some API keys for user "jared.doe"
+  promises.push(
+    kuzzle.security.createApiKey('jared.doe', 'Sigfox API key'));
+  promises.push(
+    kuzzle.security.createApiKey('jared.doe', 'LoRa 6 month API key', {
+      expiresIn: 36000
+    }));
+  promises.push(
+    kuzzle.security.createApiKey('jared.doe', 'LoRa permanent API key', {
+      expiresIn: 42000, refresh: 'wait_for'
+    }));
+
+  await Promise.all(promises);
+
+  // Log as "jared.doe"
+  await kuzzle.auth.login('local', { username: 'jared.doe', password: 'password' });
+
+  const results = await kuzzle.auth.searchApiKeys({
+    or: [
+      {
+        equals: {
+          ttl: 42000
+        }
+      },
+      {
+        equals: {
+          ttl: 36000
+        },
+      }
+    ]
+  }, { lang: 'koncorde' });
+
+  console.log(results);
+  /*
+  {
+    "total": 2,
+    "hits": [
+      {
+        "_id": "znEwbG8BJASM_0-bWU-q",
+        "_source": {
+          "description": "LoRa permanent API key",
+          "userId": "jared.doe",
+          "expiresAt": 31557600000,
+          "fingerprint": "4ee98cb8c614e99213e7695f822e42325d86c93cfaf39cb40e860939e784c8e6",
+          "ttl": 420000
+        }
+      },
+      {
+        "_id": "zXEwbG8BJASM_0-bWU-q",
+        "_source": {
+          "description": "LoRa 1 year API key",
+          "userId": "jared.doe",
+          "expiresAt": 31557600000,
+          "fingerprint": "f822e42325d86c93cfaf39cb40e860939e784c8e64ee98cb8c614e99213e7695",
+          "ttl": 420000
+        }
+      }
+    ]
+  }
+  */
+
+  console.log(`Found ${results.total} API keys.`);
+} catch (e) {
+  console.error(e);
+}

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

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

doc/7/controllers/auth/search-api-keys/snippets/search-api-keys-koncorde.test.yml

@@ -15,6 +15,6 @@ hooks:
     done
 
     curl -XPOST kuzzle:7512/nyc-open-data/yellow-taxi/_refresh
-  after:
+
 template: default
 expected: Successfully deleted 5 documents

doc/7/controllers/bulk/delete-by-query/snippets/delete-by-query.test.yml

@@ -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="7.4.8"/>
+
+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,11 +43,19 @@ 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="7.4.8"/> |
 
 ## Resolves
 
 Resolves to an array of strings containing the deleted document ids.
 
 ## Usage
 
-<<< ./snippets/delete-by-query.js
+With the [ElasticSearch Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/7.4/query-dsl.html) syntax.
+
+<<< ./snippets/delete-by-query-es.js
+
+With the [Koncorde Filters DSL](/core/2/api/koncorde-filters-syntax) syntax.
+
+<<< ./snippets/delete-by-query-koncorde.js

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

@@ -3,9 +3,7 @@ try {
     'nyc-open-data',
     'yellow-taxi',
     {
-      query: {
-        term: { capacity: 7 }
-      }
+      query: { term: { capacity: 7 } }
     }
   );