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

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

@@ -22,10 +22,30 @@ export type NamedMeasures = Array<{
         [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?;
@@ -85,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"
@@ -106,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/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.18",
+  "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);
-}