Merge pull request #95 from kuzzleio/0.3.0-proposal

# [0.3.0](https://github.com/kuzzleio/kuzzle-plugin-device-manager/releases/tag/0.3.0) (2021-09-06)


#### Breaking changes

- [ [#90](#90) ] [breaking] Allows to skip payloads   ([Aschen](https://github.com/Aschen))
- [ [#84](#84) ] Returning standard response on device-manager/device:search   ([xbill82](https://github.com/xbill82))

#### Bug fixes

- [ [#79](#79) ] Fix registering of multiple mappings for the same tenantGroup   ([Aschen](https://github.com/Aschen))

#### New features

- [ [#92](#92) ] Add provisionning catalog   ([Aschen](https://github.com/Aschen))

#### Enhancements

- [ [#89](#89) ] Rename tenantGroup to group   ([Aschen](https://github.com/Aschen))
- [ [#88](#88) ] Trigger tenant events after payload processing   ([Aschen](https://github.com/Aschen))

#### Others

- [ [#81](#81) ] Update deps   ([rolljee](https://github.com/rolljee))
- [ [#73](#73) ] Fix some typing issues in documentation   ([rolljee](https://github.com/rolljee))
---

Author: Aschen

.github/actions/dead-links/action.yml

@@ -0,0 +1,26 @@
+name: Dead Links
+description: Run Dead Links Tests
+runs:
+  using: "composite"
+  steps:
+    - name: Install deps
+      run: npm ci
+      shell: bash
+    - name: Install Kuzdoc (latest minor)
+      run: npm i kuzdoc
+      shell: bash
+    - name: Prepare documentation
+      run: npm run doc:prepare
+      shell: bash
+    - name: Install docs repositories
+      run: npx kuzdoc iterate-repos:install --repos_path doc/framework/.repos/
+      shell: bash
+    - name: Link kuzdoc
+      run: npx kuzdoc framework:link -d /official-plugins/device-manager/1/ -v 1
+      shell: bash
+    - name: Install typhoeus
+      run: sudo gem install typhoeus
+      shell: bash
+    - name: Run dead links tests
+      run: cd doc/framework/ && HYDRA_MAX_CONCURRENCY=20 ruby .ci/dead-links.rb -p src/official-plugins/device-manager/1/
+      shell: bash

.github/actions/doc-deploy/action.yml

@@ -0,0 +1,54 @@
+name: Deploy Documentation
+description: Build doc, upload it to S3 and invalidate Cloudfront cache
+
+inputs:
+  AWS_ACCESS_KEY_ID:
+    description: AWS Access key ID
+    required: true
+  AWS_SECRET_ACCESS_KEY:
+    description: AWS secret key
+    required: true
+  S3_BUCKET:
+    description: S3 bucket name
+    required: true
+  CLOUDFRONT_ID:
+    description: Cloudfront distribution ID
+    required: true
+  REGION:
+    description: AWS default region
+    required: true
+  FRAMEWORK_BRANCH:
+    description: Documentation framework branch to use
+    required: true
+
+runs:
+  using: "composite"
+  steps:
+    - name: Install AWS CLI
+      run: |
+        sudo apt-get update
+        sudo apt-get install python python-pip
+        pip install awscli --upgrade --user
+      shell: bash
+    - name: Build documentation
+      run: |
+        rm -rf doc/framework
+        npm ci
+        npm install kuzdoc
+        npm run doc:prepare
+        npm run doc:build
+      env:
+        NODE_ENV: production
+        FRAMEWORK_BRANCH: ${{ inputs.FRAMEWORK_BRANCH }}
+      shell: bash
+    - name: Deploy documentation
+      run: |
+        npm run doc:upload
+        npm run doc:cloudfront
+      env:
+        AWS_DEFAULT_REGION: ${{ inputs.REGION }}
+        AWS_ACCESS_KEY_ID: ${{ inputs.AWS_ACCESS_KEY_ID }}
+        AWS_SECRET_ACCESS_KEY: ${{ inputs.AWS_SECRET_ACCESS_KEY }}
+        S3_BUCKET: ${{ inputs.S3_BUCKET }}
+        CLOUDFRONT_DISTRIBUTION_ID: ${{ inputs.CLOUDFRONT_ID }}
+      shell: bash

doc/1/classes/assets-custom-properties/index.md

@@ -2,5 +2,5 @@
 code: true
 type: branch
 title: AssetsCustomProperties
-description: Kuzzle IoT Platform - AssetsCustomProperties class
+description: Kuzzle IoT - AssetsCustomProperties class
 ---

doc/1/classes/assets-custom-properties/register-metadata/index.md

@@ -11,21 +11,21 @@ Add properties definition to the `metadata` field of the `assets` collection.
 
 
 ```ts
-registerMetadata (mapping: JSONObject, options: JSONObject);
+registerMetadata (mappings: JSONObject, options: JSONObject);
 ```
 
 <br/>
 
 | Arguments | Type                  | Description                                 |
 |-----------|-----------------------|---------------------------------------------|
-| `mapping` | <pre>JSONObject</pre> | Mapping definiton of the `metadata` property |
+| `mappings` | <pre>JSONObject</pre> | Mappings definiton of the `metadata` property |
 | `options` | <pre>JSONObject</pre> | Additional options |
 
 ### options
 
 | Properties | Type                  | Description                                 |
 |-----------|-----------------------|---------------------------------------------|
-| `tenantGroup` | <pre>string</pre> | Name of the group for which the mapping should apply. If unspecified, mappings will apply to every group who does not have specific definition. |
+| `group` | <pre>string</pre> | Name of the group for which the mappings should apply. If unspecified, mappings will apply to every group who does not have specific definition. |
 
 ## Usage
 
@@ -40,5 +40,5 @@ deviceManagerPlugin.assets.registerMetadata({
     fields: {
       text: { type: 'text' } }
   }
-}, { tenantGroup: 'water_management' });
+}, { group: 'water_management' });
 ```

doc/1/classes/decoder/index.md

@@ -2,5 +2,5 @@
 code: true
 type: branch
 title: Decoder
-description: Kuzzle IoT Platform - Device Manager Decoder abstract class
+description: Kuzzle IoT - Device Manager Decoder abstract class
 ---

doc/1/classes/devices-custom-properties/index.md

@@ -2,5 +2,5 @@
 code: true
 type: branch
 title: DevicesCustomProperties
-description: Kuzzle IoT Platform - DevicesCustomProperties class
+description: Kuzzle IoT - DevicesCustomProperties class
 ---

doc/1/classes/devices-custom-properties/register-measure/index.md

@@ -11,22 +11,22 @@ Add properties definition to the `measures` field of the `devices` collection.
 
 
 ```ts
-registerMeasure (measureName: string, mapping: JSONObject, options: JSONObject);
+registerMeasure (measureName: string, mappings: JSONObject, options: JSONObject);
 ```
 
 <br/>
 
 | Arguments | Type                  | Description                                 |
 |-----------|-----------------------|---------------------------------------------|
 | `measureName` | <pre>string</pre> | Name of the measure you are willing to add to the `measures` field |
-| `mapping` | <pre>JSONObject</pre> | Mapping definiton of the custom measure property |
+| `mappings` | <pre>JSONObject</pre> | Mappings definiton of the custom measure property |
 | `options` | <pre>JSONObject</pre> | Additional options |
 
 ### options
 
 | Properties | Type                  | Description                                 |
 |-----------|-----------------------|---------------------------------------------|
-| `tenantGroup` | <pre>string</pre> | Name of the group for which the mapping should apply. If unspecified, mappings will apply to every group who does not have specific definition |
+| `group` | <pre>string</pre> | Name of the group for which the mappings should apply. If unspecified, mappings will apply to every group who does not have specific definition |
 
 ## Usage
 
@@ -44,7 +44,7 @@ deviceManagerPlugin.devices.registerMeasure(
       celsius: { type: 'float' }
     }
   },
-  { tenantGroup: 'water_management' });
+  { group: 'water_management' });
 
 deviceManagerPlugin.devices.registerMeasure(
   'humidity',
@@ -58,5 +58,5 @@ deviceManagerPlugin.devices.registerMeasure(
       }
     }
   },
-  { tenantGroup: 'air_quality' });
+  { group: 'air_quality' });
 ```

doc/1/classes/devices-custom-properties/register-metadata/index.md

@@ -11,21 +11,21 @@ Add properties definition to the `metadata` field of the `devices` collection.
 
 
 ```ts
-registerMetadata (mapping: JSONObject, options: JSONObject);
+registerMetadata (mappings: JSONObject, options: JSONObject);
 ```
 
 <br/>
 
 | Arguments | Type                  | Description                                 |
 |-----------|-----------------------|---------------------------------------------|
-| `mapping` | <pre>JSONObject</pre> | Mapping definiton of the `metadata` property |
+| `mappings` | <pre>JSONObject</pre> | Mappings definiton of the `metadata` property |
 | `options` | <pre>JSONObject</pre> | Additional options |
 
 ### options
 
 | Properties | Type                  | Description                                 |
 |-----------|-----------------------|---------------------------------------------|
-| `tenantGroup` | <pre>string</pre> | Name of the group for which the mapping should apply. If unspecified, mappings will apply to every group who does not have specific definition. |
+| `group` | <pre>string</pre> | Name of the group for which the mappings should apply. If unspecified, mappings will apply to every group who does not have specific definition. |
 
 ## Usage
 
@@ -40,5 +40,5 @@ deviceManagerPlugin.devices.registerMetadata({
     fields: {
       text: { type: 'text' } }
   }
-}, { tenantGroup: 'water_management' });
+}, { group: 'water_management' });
 ```

doc/1/classes/devices-custom-properties/register-qos/index.md

@@ -11,21 +11,21 @@ Add properties definition to the `qos` field of the `devices` collection.
 
 
 ```ts
-registerQos (mapping: JSONObject, options: JSONObject);
+registerQos (mappings: JSONObject, options: JSONObject);
 ```
 
 <br/>
 
 | Arguments | Type                  | Description                                 |
 |-----------|-----------------------|---------------------------------------------|
-| `mapping` | <pre>JSONObject</pre> | Mapping definiton of the `qos` property |
+| `mappings` | <pre>JSONObject</pre> | Mappings definiton of the `qos` property |
 | `options` | <pre>JSONObject</pre> | Additional options |
 
 ### options
 
 | Properties | Type                  | Description                                 |
 |-----------|-----------------------|---------------------------------------------|
-| `tenantGroup` | <pre>string</pre> | Name of the group for which the mapping should apply. If unspecified, mappings will apply to every group who does not have specific definition. |
+| `group` | <pre>string</pre> | Name of the group for which the mappings should apply. If unspecified, mappings will apply to every group who does not have specific definition. |
 
 ## Usage
 
@@ -36,5 +36,5 @@ const deviceManagerPlugin = new DeviceManagerPlugin();
 
 deviceManagerPlugin.devices.registerQos({
   battery: { type: 'integer' }
-}, { tenantGroup: 'water_management' });
+}, { group: 'water_management' });
 ```

doc/1/classes/index.md

@@ -2,6 +2,6 @@
 code: false
 type: branch
 title: Classes
-description: Kuzzle IoT Platform - Device Manager Classes
+description: Kuzzle IoT - Device Manager Classes
 order: 300
 ---