kuzzle-device-manager-types 3.0.0-3-dev.17 → 3.0.0-3-dev.19

package/dist/lib/modules/asset/AssetService.d.ts

@@ -51,5 +51,11 @@ export declare class AssetService extends DigitalTwinService {
     updateModelLocales(request: KuzzleRequest, model: string): Promise<ApiAssetUpdateModelLocales[]>;
     addMeasureSlot(assetId: string, measureSlot: AssetContent["measureSlots"][0], engineId: string, request: KuzzleRequest): Promise<KDocument<AssetContent>>;
     removeMeasureSlot(assetId: string, measureSlotName: string, engineId: string, request: KuzzleRequest): Promise<KDocument<AssetContent>>;
+    /**
+     * Update the display name of a measure slot on an asset
+     */
+    updateMeasureSlotDisplayName(assetId: string, measureSlotName: string, displayName: {
+        [locale: string]: string;
+    }, engineId: string, request: KuzzleRequest): Promise<KDocument<AssetContent>>;
     private refreshModel;
 }

package/dist/lib/modules/asset/AssetsController.d.ts

@@ -3,7 +3,7 @@ import { MeasureExporter } from "../measure";
 import { DeviceManagerPlugin } from "../plugin";
 import { DigitalTwinExporter } from "../shared";
 import { AssetService } from "./AssetService";
-import { ApiAssetCreateResult, ApiAssetUpsertResult, ApiAssetDeleteResult, ApiAssetGetMeasuresResult, ApiAssetGetResult, ApiAssetSearchResult, ApiAssetUpdateResult, ApiAssetMigrateTenantResult, ApiAssetMetadataReplaceResult, ApiAssetGetLastMeasuresResult, ApiAssetMGetLastMeasuredAtResult, ApiAssetMGetLastMeasuresResult, ApiAssetGetLastMeasuredAtResult, ApiAssetUpdateModelLocales, ApiAssetLinkDevicesResult, ApiAssetUnlinkDevicesResult, ApiAssetAddMeasureSlotResult, ApiAssetRemoveMeasureSlotResult } from "./types/AssetApi";
+import { ApiAssetCreateResult, ApiAssetUpsertResult, ApiAssetDeleteResult, ApiAssetGetMeasuresResult, ApiAssetGetResult, ApiAssetSearchResult, ApiAssetUpdateResult, ApiAssetMigrateTenantResult, ApiAssetMetadataReplaceResult, ApiAssetGetLastMeasuresResult, ApiAssetMGetLastMeasuredAtResult, ApiAssetMGetLastMeasuresResult, ApiAssetGetLastMeasuredAtResult, ApiAssetUpdateModelLocales, ApiAssetLinkDevicesResult, ApiAssetUnlinkDevicesResult, ApiAssetAddMeasureSlotResult, ApiAssetRemoveMeasureSlotResult, ApiAssetUpdateMeasureSlotDisplayNameResult } from "./types/AssetApi";
 import { KuzzleLogger } from "kuzzle-logger";
 export declare class AssetsController {
     readonly plugin: DeviceManagerPlugin;
@@ -62,4 +62,8 @@ export declare class AssetsController {
      * Remove a measure slot from an asset
      */
     removeMeasureSlot(request: KuzzleRequest): Promise<ApiAssetRemoveMeasureSlotResult>;
+    /**
+     * Update the display name of a measure slot on an asset
+     */
+    updateMeasureSlotDisplayName(request: KuzzleRequest): Promise<ApiAssetUpdateMeasureSlotDisplayNameResult>;
 }

package/dist/lib/modules/asset/types/AssetApi.d.ts

@@ -256,17 +256,25 @@ export interface ApiAssetAddMeasureSlotRequest extends AssetsControllerRequest {
     _id: string;
     body: {
         /**
-         * Measure slot containing the name of the slot and it's type of measurement
+         * Measure slot containing the name of the slot, its type of measurement
+         * and an optional per-locale display name.
          *
-         * { name: string , type: string}
+         * { name: string, type: string, displayName?: { [locale: string]: string } }
          *
          * @example
          *
-         *   { name: "externalTemperature", type: "temperature" }
+         *   {
+         *     name: "externalTemperature",
+         *     type: "temperature",
+         *     displayName: { en: "External temperature", fr: "Température extérieure" }
+         *   }
          */
         measureSlot: {
             name: string;
             type: string;
+            displayName?: {
+                [locale: string]: string;
+            };
         };
     };
 }
@@ -287,4 +295,29 @@ export interface ApiAssetRemoveMeasureSlotRequest extends AssetsControllerReques
     };
 }
 export type ApiAssetRemoveMeasureSlotResult = KDocument<AssetContent>;
+export interface ApiAssetUpdateMeasureSlotDisplayNameRequest extends AssetsControllerRequest {
+    action: "updateMeasureSlotDisplayName";
+    _id: string;
+    body: {
+        /**
+         * Name of the measure slot to update.
+         *
+         * @example
+         *
+         *   measureSlot: "externalTemperature",
+         */
+        measureSlot: string;
+        /**
+         * Per-locale display name for the measure slot.
+         *
+         * @example
+         *
+         *   displayName: { en: "External temperature", fr: "Température extérieure" }
+         */
+        displayName: {
+            [locale: string]: string;
+        };
+    };
+}
+export type ApiAssetUpdateMeasureSlotDisplayNameResult = KDocument<AssetContent>;
 export {};

package/dist/lib/modules/decoder/Decoder.d.ts

@@ -12,11 +12,40 @@ import { DecoderContent } from "./types/DecoderContent";
 export type NamedMeasures = Array<{
     name: string;
     type: string;
+    /**
+     * Per-locale display name for this measure slot, keyed by locale.
+     *
+     * @example
+     * { en: "External temperature", fr: "Température extérieure" }
+     */
+    displayName?: {
+        [locale: string]: string;
+    };
 }>;
+/**
+ * Result of the payload validation made by a decoder.
+ *
+ * Stored alongside the raw payload in the "payloads" collection.
+ */
+export type DecoderValidationResult = {
+    /**
+     * "valid": the payload will be decoded
+     * "invalid": the payload will be skipped (status 400)
+     */
+    status: "valid" | "invalid";
+    /**
+     * Why the payload has been rejected
+     */
+    reason?: string;
+    /**
+     * Custom data stored with the payload
+     */
+    customData?: JSONObject;
+};
 /**
  * Base class to implement a decoder for a device model.
  * The device model must be passed to the parent constructor.
- * The abstract "decode" method must be implemented.
+ * The abstract "validate" and "decode" methods must be implemented.
  */
 export declare abstract class Decoder {
     private _http?;
@@ -76,16 +105,18 @@ export declare abstract class Decoder {
      * Validate the payload format before processing.
      *
      * If the method:
-     *   - return true: the payload will be processed (status 200)
-     *   - return false: the payload will be skipped (status 200)
+     *   - return status "valid": the payload will be processed (status 200)
+     *   - return status "invalid": the payload will be skipped (status 400)
      *   - throw an error: the payload will be skipped (status 4** or 5**)
      *
+     * The returned `reason` and `customData` are stored in the "payloads" collection.
+     *
      * @param payload Raw payload received in the API action body
      * @param request Original request
      *
-     * @return A boolean indicating if the payload is valid
+     * @return The validation result
      */
-    validate(payload: JSONObject, request: KuzzleRequest): Promise<boolean> | never;
+    validate(payload: JSONObject, request: KuzzleRequest): Promise<DecoderValidationResult> | DecoderValidationResult;
     /**
      * Decode the payload:
      *  - set "reference"
@@ -97,7 +128,7 @@ export declare abstract class Decoder {
      *
      * @returns DecodedPayload
      */
-    abstract decode(decodedPayload: DecodedPayload<any>, payload: JSONObject, request: KuzzleRequest): Promise<DecodedPayload<any>>;
+    abstract decode(decodedPayload: DecodedPayload<any>, payload: JSONObject, request: KuzzleRequest): Promise<DecodedPayload<any>> | DecodedPayload<any>;
     /**
      * Checks if the provided properties are present in the payload
      *

package/dist/lib/modules/decoder/PayloadService.d.ts

@@ -17,7 +17,7 @@ export declare class PayloadService extends BaseService {
      * - redirect measurements to MeasureService
      */
     receive(request: KuzzleRequest, decoder: Decoder, { refresh }?: any): Promise<{
-        valid: boolean;
+        valid: true;
     }>;
     receiveFormated(device: KDocument<DeviceContent>, measurements: DecodedMeasurement[], { payloadUuids }?: {
         payloadUuids?: string[];

package/dist/lib/modules/decoder/collections/payloadsMappings.d.ts

@@ -23,5 +23,9 @@ export declare const payloadsMappings: {
         reason: {
             type: string;
         };
+        customData: {
+            dynamic: string;
+            properties: {};
+        };
     };
 };

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

@@ -22,6 +22,12 @@ export declare class DeviceService extends DigitalTwinService {
      * Replace a device metadata
      */
     replaceMetadata(engineId: string, deviceId: string, metadata: Metadata, request: KuzzleRequest): Promise<KDocument<DeviceContent>>;
+    /**
+     * Update the display name of a measure slot on a device
+     */
+    updateMeasureSlotDisplayName(engineId: string, deviceId: string, measureSlotName: string, displayName: {
+        [locale: string]: string;
+    }, request: KuzzleRequest): Promise<KDocument<DeviceContent>>;
     /**
      * Update or Create an device metadata
      */

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

@@ -1,7 +1,7 @@
 import { ControllerDefinition, KuzzleRequest } from "kuzzle";
 import { DeviceManagerPlugin } from "../plugin";
 import { DeviceService } from "./DeviceService";
-import { ApiDeviceAttachEngineResult, ApiDeviceCreateResult, ApiDeviceDeleteResult, ApiDeviceDetachEngineResult, ApiDeviceGetResult, ApiDeviceLinkAssetsResult, ApiDeviceSearchResult, ApiDeviceUnlinkAssetsResult, ApiDeviceUpdateResult, ApiDeviceGetMeasuresResult, ApiDeviceUpsertResult, ApiDeviceGetLastMeasuresResult, ApiDeviceMGetLastMeasuresResult, ApiDeviceGetLastMeasuredAtResult, ApiDeviceMGetLastMeasuredAtResult, ApiDeviceMetadataReplaceResult } from "./types/DeviceApi";
+import { ApiDeviceAttachEngineResult, ApiDeviceCreateResult, ApiDeviceDeleteResult, ApiDeviceDetachEngineResult, ApiDeviceGetResult, ApiDeviceLinkAssetsResult, ApiDeviceSearchResult, ApiDeviceUnlinkAssetsResult, ApiDeviceUpdateResult, ApiDeviceGetMeasuresResult, ApiDeviceUpsertResult, ApiDeviceGetLastMeasuresResult, ApiDeviceMGetLastMeasuresResult, ApiDeviceGetLastMeasuredAtResult, ApiDeviceMGetLastMeasuredAtResult, ApiDeviceMetadataReplaceResult, ApiDeviceUpdateMeasureSlotDisplayNameResult } from "./types/DeviceApi";
 import { KuzzleLogger } from "kuzzle-logger";
 export declare class DevicesController {
     private plugin;
@@ -45,4 +45,8 @@ export declare class DevicesController {
     export(request: KuzzleRequest): Promise<any>;
     getLastMeasuredAt(request: KuzzleRequest): Promise<ApiDeviceGetLastMeasuredAtResult>;
     mGetLastMeasuredAt(request: KuzzleRequest): Promise<ApiDeviceMGetLastMeasuredAtResult>;
+    /**
+     * Update the display name of a measure slot on a device
+     */
+    updateMeasureSlotDisplayName(request: KuzzleRequest): Promise<ApiDeviceUpdateMeasureSlotDisplayNameResult>;
 }

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

@@ -23,6 +23,31 @@ export interface ApiDeviceUpdateRequest extends DevicesControllerRequest {
 }
 export type ApiDeviceUpdateResult = KDocument<DeviceContent>;
 export type ApiDeviceMetadataReplaceResult = KDocument<DeviceContent>;
+export interface ApiDeviceUpdateMeasureSlotDisplayNameRequest extends DevicesControllerRequest {
+    action: "updateMeasureSlotDisplayName";
+    _id: string;
+    body: {
+        /**
+         * Name of the measure slot to update.
+         *
+         * @example
+         *
+         *   measureSlot: "externalTemperature",
+         */
+        measureSlot: string;
+        /**
+         * Per-locale display name for the measure slot.
+         *
+         * @example
+         *
+         *   displayName: { en: "External temperature", fr: "Température extérieure" }
+         */
+        displayName: {
+            [locale: string]: string;
+        };
+    };
+}
+export type ApiDeviceUpdateMeasureSlotDisplayNameResult = KDocument<DeviceContent>;
 export interface ApiDeviceUpsertRequest extends DevicesControllerRequest {
     action: "upsert";
     refresh?: string;

package/dist/lib/modules/model/types/ModelContent.d.ts

@@ -241,12 +241,16 @@ export interface AssetModelContent extends KDocumentContent {
         /**
          * List of accepted measures for this model
          *
-         * Array<{ type: string, name: string }>
+         * Array<{ type: string, name: string, displayName?: { [locale: string]: string } }>
          *
          * @example
          *
          * [
-         *   { type: "temperature", name: "externalTemperature" }
+         *   {
+         *     type: "temperature",
+         *     name: "externalTemperature",
+         *     displayName: { en: "External temperature", fr: "Température extérieure" }
+         *   }
          * ]
          */
         measures: NamedMeasures;
@@ -387,12 +391,16 @@ export interface DeviceModelContent extends KDocumentContent {
         /**
          * List of decoded measures for this model
          *
-         * Array<{ type: string, name: string }>
+         * Array<{ type: string, name: string, displayName?: { [locale: string]: string } }>
          *
          * @example
          *
          * [
-         *   { type: "temperature", name: "externalTemperature" }
+         *   {
+         *     type: "temperature",
+         *     name: "externalTemperature",
+         *     displayName: { en: "External temperature", fr: "Température extérieure" }
+         *   }
          * ]
          */
         measures: NamedMeasures;

package/dist/tests/application/decoders/DummyTempDecoder.d.ts

@@ -1,5 +1,5 @@
 import { JSONObject } from "kuzzle-sdk";
-import { Decoder, DecodedPayload } from "../../../index";
+import { Decoder, DecodedPayload, DecoderValidationResult } from "../../../index";
 export declare const dummyTempDeviceMeasures: readonly [{
     readonly name: "temperature";
     readonly type: "temperature";
@@ -22,7 +22,7 @@ export declare class DummyTempDecoder extends Decoder {
         readonly type: "battery";
     }];
     constructor();
-    validate(rawPayload: JSONObject): Promise<boolean>;
+    validate(rawPayload: JSONObject): Promise<DecoderValidationResult>;
     decode(decodedPayload: DecodedPayload<DummyTempDecoder>, rawPayload: JSONObject): Promise<DecodedPayload<DummyTempDecoder>>;
     decodeSimplePayload(decodedPayload: DecodedPayload<DummyTempDecoder>, payload: JSONObject): void;
 }

package/dist/tests/application/decoders/DummyTempPositionDecoder.d.ts

@@ -22,6 +22,8 @@ export declare class DummyTempPositionDecoder extends Decoder {
         readonly type: "position";
     }];
     constructor();
-    validate(payload: JSONObject): Promise<boolean>;
+    validate(payload: JSONObject): Promise<{
+        status: "valid";
+    }>;
     decode(decodedPayload: DecodedPayload<DummyTempPositionDecoder>, payload: JSONObject): Promise<DecodedPayload<DummyTempPositionDecoder>>;
 }

package/dist/tests/application/decoders/EmptyTempDecoder.d.ts

@@ -1,8 +1,8 @@
 import { JSONObject } from "kuzzle-sdk";
-import { Decoder, DecodedPayload } from "../../../index";
+import { Decoder, DecodedPayload, DecoderValidationResult } from "../../../index";
 export declare class EmptyTempDecoder extends Decoder {
     measures: any[];
     constructor();
-    validate(rawPayload: JSONObject): Promise<boolean>;
+    validate(rawPayload: JSONObject): Promise<DecoderValidationResult>;
     decode(decodedPayload: DecodedPayload<EmptyTempDecoder>, rawPayload: JSONObject): Promise<DecodedPayload<EmptyTempDecoder>>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kuzzle-device-manager-types",
-  "version": "3.0.0-3-dev.17",
+  "version": "3.0.0-3-dev.19",
   "description": "Shared types for Kuzzle Device Manager",
   "author": "The Kuzzle Team (support@kuzzle.io)",
   "main": "index.js",

package/dist/lib/modules/decoder/SkipError.d.ts

@@ -1,3 +0,0 @@
-export declare class SkipError extends Error {
-    constructor(message: string);
-}