kuzzle-device-manager-types 2.0.5 → 2.0.6

package/dist/lib/modules/device/DeviceService.d.ts

@@ -57,8 +57,9 @@ export declare class DeviceService {
     /**
      * Link a device to an asset.
      */
-    linkAsset(user: User, engineId: string, deviceId: string, assetId: string, measureNames: ApiDeviceLinkAssetRequest["body"]["measureNames"], { refresh }?: {
+    linkAsset(user: User, engineId: string, deviceId: string, assetId: string, measureNames: ApiDeviceLinkAssetRequest["body"]["measureNames"], { refresh, implicitMeasuresLinking, }?: {
         refresh?: any;
+        implicitMeasuresLinking?: boolean;
     }): Promise<{
         asset: KDocument<AssetContent>;
         device: KDocument<DeviceContent>;
@@ -67,7 +68,14 @@ export declare class DeviceService {
      * Checks if the asset does not already have a linked device using one of the
      * requested measure names.
      */
-    private checkAssetMeasureNamesAvailability;
+    private checkAlreadyProvidedMeasures;
+    /**
+     * Goes through the device available measures and add them into the link if:
+     *  - they are not already provided by another device
+     *  - they are not already present in the link request
+     *  - they are declared in the asset model
+     */
+    private generateMissingAssetMeasureNames;
     /**
      * Unlink a device of an asset
      *
@@ -91,4 +99,5 @@ export declare class DeviceService {
     }): Promise<ApiDeviceGetMeasuresResult>;
     private checkEngineExists;
     private checkAttachedToEngine;
+    private getEngine;
 }

package/dist/lib/modules/device/types/DeviceApi.d.ts

@@ -73,9 +73,26 @@ export interface ApiDeviceLinkAssetRequest extends DevicesControllerRequest {
     _id: string;
     refresh?: string;
     assetId: string;
+    /**
+     * This option allows to not specify the names of all the measures that should
+     * be linked to the asset.
+     *
+     * The algorithm will go through all the measures names provided by the device
+     * and add the one who are present with the same name in the asset.
+     *
+     * It will not add the measure if:
+     *   - it has been specified in the link request
+     *   - it was already present in the asset
+     *
+     * @example
+     *   if the device provide a measure of type "temperature" with the name "temp"
+     *   if the asset has declared a measure of type "temperature" with the name "temp"
+     *   then the measure will be automatically added in the link and will later be propagated to the asset
+     */
+    implicitMeasuresLinking?: boolean;
     body?: {
         /**
-         * Names of the linked measures
+         * Names of the linked measures.
          *
          * Array<{ asset: string, device: string }>
          *
@@ -85,7 +102,7 @@ export interface ApiDeviceLinkAssetRequest extends DevicesControllerRequest {
          *   { asset: "externalTemperature", device: "temperature" }
          * ]
          */
-        measureNames: Array<{
+        measureNames?: Array<{
             asset: string;
             device: string;
         }>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kuzzle-device-manager-types",
-  "version": "2.0.5",
+  "version": "2.0.6",
   "description": "Shared types for Kuzzle Device Manager",
   "author": "The Kuzzle Team (support@kuzzle.io)",
   "types": "dist/index.d.ts",