kuzzle-device-manager-types 2.0.8 → 2.1.0

package/dist/lib/core/DeviceManagerPlugin.d.ts

@@ -1,11 +1,9 @@
 import { Plugin, PluginContext, JSONObject } from "kuzzle";
 import { MeasureDefinition } from "../modules/measure";
 import { AssetModelDefinition, DeviceModelDefinition } from "../modules/model";
-import { KuzzleRole } from "../modules/shared";
 import { DeviceManagerConfiguration } from "./DeviceManagerConfiguration";
 export declare class DeviceManagerPlugin extends Plugin {
     config: DeviceManagerConfiguration;
-    roles: KuzzleRole[];
     private deviceManagerEngine;
     private adminConfigManager;
     private engineConfigManager;
@@ -95,7 +93,6 @@ export declare class DeviceManagerPlugin extends Plugin {
      * Init the plugin
      */
     init(config: JSONObject, context: PluginContext): Promise<void>;
-    private createDefaultRoles;
     /**
      * Initialize the administration index of the plugin
      */

package/dist/lib/core/registers/DecodersRegister.d.ts

@@ -1,14 +1,16 @@
 import { PluginContext } from "kuzzle";
 import { Decoder, DecoderContent } from "../../modules/decoder";
+import { DeviceManagerPlugin } from "..";
 export declare class DecodersRegister {
     private context;
+    private plugin;
     /**
      * Map<deviceModel, Decoder>
      */
     private _decoders;
     private get sdk();
     get decoders(): Decoder[];
-    init(context: PluginContext): void;
+    init(plugin: DeviceManagerPlugin, context: PluginContext): void;
     get(deviceModel: string): Decoder;
     list(): DecoderContent[];
     /**
@@ -29,13 +31,11 @@ export declare class DecodersRegister {
     };
     printDecoders(): void;
     /**
-     * Creates default roles, profiles and users associated to the generated actions
+     * Register default role, profile and user associated to the generated actions
      * in the Payload controller.
-     *
-     * This method never returns a rejected promise.
      */
-    createDefaultRights(): Promise<void>;
-    private createDefaultUsers;
-    private createDefaultProfiles;
-    private createDefaultRoles;
+    registerDefaultRights(): void;
+    private registerDefaultUser;
+    private registerDefaultProfile;
+    private registerDefaultRole;
 }

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

@@ -1,5 +1,7 @@
-import { JSONObject, KuzzleRequest } from "kuzzle";
+import { JSONObject, KDocument, KuzzleRequest } from "kuzzle";
 import { DeviceManagerPlugin } from "../../core";
+import { DeviceContent } from "../device";
+import { DecodedMeasurement } from "../measure";
 import { Decoder } from "./Decoder";
 export declare class PayloadService {
     private config;
@@ -16,6 +18,9 @@ export declare class PayloadService {
     receive(request: KuzzleRequest, decoder: Decoder, { refresh }?: any): Promise<{
         valid: boolean;
     }>;
+    receiveFormated(device: KDocument<DeviceContent>, measurements: DecodedMeasurement[], { payloadUuids }?: {
+        payloadUuids?: string[];
+    }): Promise<void>;
     /**
      * Method used to save the payload and catch + log the error if any.
      *
@@ -30,5 +35,5 @@ export declare class PayloadService {
     prune(days: number, onlyValid: boolean, { deviceModel }?: {
         deviceModel?: string;
     }): Promise<number>;
-    receiveUnknown(deviceModel: string, payload: JSONObject): Promise<void>;
+    receiveUnknown(deviceModel: string, payload: JSONObject, apiAction: string): Promise<void>;
 }

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

@@ -14,5 +14,8 @@ export declare const payloadsMappings: {
         valid: {
             type: string;
         };
+        apiAction: {
+            type: string;
+        };
     };
 };

package/dist/lib/modules/decoder/types/PayloadEvents.d.ts

@@ -0,0 +1,15 @@
+import { KDocument } from "kuzzle-sdk";
+import { DeviceContent } from "../../device";
+import { DecodedMeasurement } from "../../measure";
+/**
+ * @internal
+ */
+export type AskPayloadReceiveFormated = {
+    name: "ask:device-manager:payload:receive-formated";
+    payload: {
+        device: KDocument<DeviceContent>;
+        measures: DecodedMeasurement[];
+        payloadUuids: string[];
+    };
+    result: void;
+};

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

@@ -1,6 +1,7 @@
 import { JSONObject, KDocument, KHit, Plugin, SearchResult, User } from "kuzzle";
 import { AssetContent } from "./../asset";
 import { Metadata } from "../shared";
+import { DecodedMeasurement } from "../measure";
 import { DeviceContent } from "./types/DeviceContent";
 import { ApiDeviceLinkAssetRequest, ApiDeviceGetMeasuresResult } from "./types/DeviceApi";
 export declare class DeviceService {
@@ -64,6 +65,7 @@ export declare class DeviceService {
         asset: KDocument<AssetContent>;
         device: KDocument<DeviceContent>;
     }>;
+    receiveMeasures(engineId: string, deviceId: string, measures: DecodedMeasurement[], payloadUuids: string[]): Promise<void>;
     /**
      * Checks if the asset does not already have a linked device using one of the
      * requested measure names.
@@ -100,4 +102,6 @@ export declare class DeviceService {
     private checkEngineExists;
     private checkAttachedToEngine;
     private getEngine;
+    private getDeviceModel;
+    private getAssetModel;
 }

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

@@ -30,4 +30,5 @@ export declare class DevicesController {
      */
     unlinkAsset(request: KuzzleRequest): Promise<ApiDeviceUnlinkAssetResult>;
     getMeasures(request: KuzzleRequest): Promise<ApiDeviceGetMeasuresResult>;
+    receiveMeasures(request: KuzzleRequest): Promise<void>;
 }

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

@@ -1,5 +1,5 @@
 import { JSONObject, KDocument, KHit, SearchResult } from "kuzzle";
-import { MeasureContent } from "../../measure";
+import { DecodedMeasurement, MeasureContent } from "../../measure";
 import { AssetContent } from "../../asset";
 import { Metadata } from "../../shared";
 import { DeviceContent } from "./DeviceContent";
@@ -43,6 +43,7 @@ export interface ApiDeviceSearchRequest extends DevicesControllerRequest {
     from?: number;
     size?: number;
     scrollTTL?: string;
+    lang?: "koncorde" | "elasticsearch";
     body: JSONObject;
 }
 export type ApiDeviceSearchResult = SearchResult<KHit<DeviceContent>>;
@@ -129,4 +130,18 @@ export type ApiDeviceGetMeasuresResult = {
     measures: Array<KDocument<MeasureContent<JSONObject>>>;
     total: number;
 };
+export interface ApiDeviceReceiveMeasuresRequest<TMeasureValues extends JSONObject = JSONObject> extends DevicesControllerRequest {
+    action: "receiveMeasures";
+    _id: string;
+    body: {
+        payloadUuids?: string[];
+        measures: Array<{
+            measureName: DecodedMeasurement<TMeasureValues>["measureName"];
+            measuredAt?: DecodedMeasurement<TMeasureValues>["measuredAt"];
+            type: DecodedMeasurement<TMeasureValues>["type"];
+            values: DecodedMeasurement<TMeasureValues>["values"];
+        }>;
+    };
+}
+export type ApiDeviceReceiveMeasuresResult = void;
 export {};

package/dist/lib/modules/measure/types/MeasureEvents.d.ts

@@ -6,16 +6,15 @@ import { DecodedMeasurement, MeasureContent } from "./MeasureContent";
 /**
  * @internal
  */
-export type EventMeasureIngest = {
+export type AskMeasureIngest = {
     name: "device-manager:measures:ingest";
-    args: [
-        {
-            device: KDocument<DeviceContent>;
-            measurements: DecodedMeasurement<JSONObject>[];
-            metadata: Metadata;
-            payloadUuids: string[];
-        }
-    ];
+    payload: {
+        device: KDocument<DeviceContent>;
+        measurements: DecodedMeasurement<JSONObject>[];
+        metadata: Metadata;
+        payloadUuids: string[];
+    };
+    result: void;
 };
 /**
  * Event before starting to process new measures.

package/dist/lib/modules/shared/index.d.ts

@@ -5,5 +5,4 @@ export * from "./types/KuzzleRole";
 export * from "./utils/lock";
 export * from "./utils/flattenObject";
 export * from "./utils/ask";
-export * from "./utils/snakeCase";
 export * from "./Module";

package/dist/lib/modules/shared/utils/ask.d.ts

@@ -4,5 +4,5 @@ export type AskEventDefinition = {
     result: any;
 };
 export type AskEventHandler<TAskEventDefinition extends AskEventDefinition = AskEventDefinition> = (payload?: TAskEventDefinition["payload"]) => Promise<TAskEventDefinition["result"]>;
-export declare function onAsk<TAskEventDefinition extends AskEventDefinition = AskEventDefinition>(event: TAskEventDefinition["name"], handler: AskEventHandler<TAskEventDefinition>): Promise<any>;
+export declare function onAsk<TAskEventDefinition extends AskEventDefinition = AskEventDefinition>(event: TAskEventDefinition["name"], handler: AskEventHandler<TAskEventDefinition>): any;
 export declare function ask<TAskEventDefinition extends AskEventDefinition = AskEventDefinition>(event: TAskEventDefinition["name"], payload?: TAskEventDefinition["payload"]): Promise<TAskEventDefinition["result"]>;

package/package.json

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

package/dist/lib/modules/shared/utils/snakeCase.d.ts

@@ -1,7 +0,0 @@
-/**
- * Convert a string to snake_case
- *
- * @todo use Inflector.snakeCase when
- * https://github.com/kuzzleio/kuzzle/pull/2415 is released
- */
-export declare function snakeCase(str: string): string;