Merge pull request #533 from kuzzleio/7.3.0-proposal

# [7.3.0](https://github.com/kuzzleio/sdk-javascript/releases/tag/7.3.0) (2020-07-23)


#### Bug fixes

- [ [#532](#532) ] Encode URI parameters when using the HTTTP protocol   ([scottinet](https://github.com/scottinet))
- [ [#516](#516) ] Fix query string construction   ([Yoann-Abbes](https://github.com/Yoann-Abbes))

#### New features

- [ [#526](#526) ] Add typescript definitions for Auth controller   ([Aschen](https://github.com/Aschen))
- [ [#524](#524) ] Support ms:mexecute   ([Leodau](https://github.com/Leodau))
- [ [#522](#522) ] Add bulk:deleteByQuery   ([Yoann-Abbes](https://github.com/Yoann-Abbes))
- [ [#519](#519) ] Add document:updateByQuery   ([Yoann-Abbes](https://github.com/Yoann-Abbes))

#### Enhancements

- [ [#517](#517) ] Add collection:update and deprecate collection:updateMapping   ([Yoann-Abbes](https://github.com/Yoann-Abbes))
- [ [#514](#514) ] Able to execute document search as GET http method   ([Yoann-Abbes](https://github.com/Yoann-Abbes))
---

Author: scottinet

.ci/doc/docker-compose.yml

@@ -49,7 +49,7 @@ services:
       ash -c '
         mkdir -p /var/snippets/node;
         apk add --no-cache curl;
-        npm install -g eslint;
+        npm install -g eslint@6.8.0;
         cd /var/snippets/node;
         npm install \
           bluebird \
@@ -76,7 +76,7 @@ services:
         apt-get update;
         apt-get install -y curl;
         npm install -g \
-          eslint;
+          eslint@6.8.0;
         cd /mnt;
         npm install;
         cd /var/snippets/web;
@@ -105,7 +105,7 @@ services:
         apt-get update;
         apt-get install -y curl;
         npm install -g \
-          eslint;
+          eslint@6.8.0;
         cd /var/snippets/webpack;
         cp /mnt/.ci/doc/puppeteer.js /var/snippets/webpack/;
         cp /mnt/.ci/doc/webpackBuild.js /var/snippets/webpack/;

.ci/doc/templates/print-result-successes.tpl.js

@@ -0,0 +1,31 @@
+// Loads the Kuzzle SDK module and the websocket protocol
+const {
+  Kuzzle,
+  WebSocket
+} = require('kuzzle-sdk');
+
+// Instantiates a Kuzzle client
+const
+  kuzzle = new Kuzzle(
+    new WebSocket('kuzzle', { autoReconnect: false })
+  );
+
+// Adds a listener to detect connection problems
+kuzzle.on('networkError', error => {
+  console.error(`Network Error: ${error.message}`);
+});
+
+(async () => {
+  let result;
+  try {
+    await kuzzle.connect();
+  } catch (error) {
+    console.log(`Cannot connect to Kuzzle: ${error.message}`);
+  }
+  [snippet-code] finally {
+    kuzzle.disconnect();
+  }
+  for (const elem of result.successes) {
+    console.log(elem);
+  }
+})();

.eslintc-ts.json

@@ -0,0 +1,16 @@
+{
+  "root": true,
+  "parser": "@typescript-eslint/parser",
+  "plugins": [
+    "@typescript-eslint"
+  ],
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:@typescript-eslint/recommended"
+  ],
+  "rules": {
+    "@typescript-eslint/no-explicit-any": 0,
+    "@typescript-eslint/explicit-module-boundary-types": 0
+  }
+}

.eslintignore

@@ -0,0 +1,14 @@
+# JS generated files from TS
+src/**/*.d.ts
+src/**/*.js.map
+
+src/Kuzzle.js
+src/controllers/Auth.js
+src/controllers/Document.js
+src/controllers/Base.js
+src/core/security/User.js
+src/core/security/Profile.js
+src/core/security/Role.js
+src/utils/interfaces.js
+src/core/searchResult/SearchResultBase.js
+src/core/searchResult/Document.js

.gitignore

@@ -24,4 +24,19 @@ doc/7/getting-started/.vuejs/cypress/screenshots
 doc/7/getting-started/.vuejs/cypress/videos
 
 # Debug snippets
-test-*.js
+test-*.js
+
+# Typescript related files
+*.d.ts
+*.js.map
+index.js
+src/Kuzzle.js
+src/controllers/Auth.js
+src/controllers/Document.js
+src/controllers/Base.js
+src/core/security/User.js
+src/core/security/Profile.js
+src/core/security/Role.js
+src/utils/interfaces.js
+src/core/searchResult/SearchResultBase.js
+src/core/searchResult/Document.js

.mocharc.json

@@ -3,5 +3,5 @@
   "recursive": true,
   "slow": 2000,
   "timeout": 10000,
-  "require": ["should-sinon"]
+  "require": ["should-sinon", "ts-node/register"]
 }

.travis.yml

@@ -34,8 +34,8 @@ jobs:
         - npm install
 
       script:
-        - npm run lint
-        - npm run unit-testing
+        - npm run test:lint
+        - npm run test:unit
 
       after_success:
         - cat ./coverage/lcov.info | ./node_modules/.bin/codecov
@@ -65,7 +65,7 @@ jobs:
         - npm run build
 
       script:
-        - npm run functional-testing
+        - npm run test:functional
 
     - stage: Tests
       name: Documentation Tests
@@ -103,6 +103,7 @@ jobs:
       env:
         - BRANCH=dev
         - NODE_ENV=production
+        - NODE_OPTIONS="--max_old_space_size=4096"
         - S3_BUCKET=docs-next.kuzzle.io
         - CLOUDFRONT_DISTRIBUTION_ID=E2ZCCEK9GRB49U
         - AWS_DEFAULT_REGION=us-west-2
@@ -140,6 +141,7 @@ jobs:
       node_js: 10
       env:
         - NODE_ENV=production
+        - NODE_OPTIONS="--max_old_space_size=4096"
         - S3_BUCKET=docs.kuzzle.io
         - CLOUDFRONT_DISTRIBUTION_ID=E3D6RP0POLCJMM
         - AWS_DEFAULT_REGION=us-west-2

doc/7/controllers/auth/check-token/index.md

@@ -31,7 +31,7 @@ An `object` representing the token validity status
 | ------------- | ------------------ | --------------------------------- |
 | `valid`       | <pre>boolean</pre> | Tell if the token is valid or not |
 | `state`       | <pre>string</pre>  | Explain why the token is invalid  |
-|  `expires_at` | <pre>number</pre>  | Token expiration timestamp        |
+|  `expiresAt` | <pre>number</pre>  | Token expiration timestamp        |
 
 ## Usage
 

doc/7/controllers/auth/create-api-key/index.md

@@ -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> | Aexpiration date in UNIX micro-timestamp format (`-1` if the token never expires) |
+| `expiresAt`  | <pre>number</pre> | Expiration date in UNIX micro-timestamp 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/get-my-rights/index.md

@@ -31,7 +31,9 @@ Additional query options
 
 ## Resolves
 
-An `object[]` containing:
+An array containing user rights objects.
+
+Each user right object has the following properties:
 
 | Property      | Type              | Description                                 |
 | ------------- | ----------------- | ------------------------------------------- |