kuzzle-device-manager-types 2.0.0-rc29 → 2.0.0-rc35

package/README.md

@@ -0,0 +1,17 @@
+# Kuzzle Device Manager Types
+
+This package only contains types to work with in a frontend application.
+
+```
+
+import { DeviceContent } from 'kuzzle-device-manager-types';
+
+
+let device: DeviceContent;
+
+device.model = "Abeeway";
+```
+
+See main package for more informations:
+ - [Github](https://github.com/kuzzleio/kuzzle-device-manager)
+ - [NPM](https://www.npmjs.com/package/kuzzle-device-manager)

package/dist/features/fixtures/application/decoders/DummyTempDecoder.d.ts

@@ -7,5 +7,5 @@ export declare class DummyTempDecoder extends Decoder {
     }];
     constructor();
     validate(payload: JSONObject): Promise<boolean>;
-    decode(payload: JSONObject): Promise<DecodedPayload<Decoder>>;
+    decode(decodedPayload: DecodedPayload<DummyTempDecoder>, payload: JSONObject): Promise<DecodedPayload<DummyTempDecoder>>;
 }

package/dist/features/fixtures/application/decoders/DummyTempPositionDecoder.d.ts

@@ -12,5 +12,5 @@ export declare class DummyTempPositionDecoder extends Decoder {
         readonly type: "position";
     }];
     validate(payload: JSONObject): Promise<boolean>;
-    decode(payload: JSONObject): Promise<DecodedPayload<Decoder>>;
+    decode(decodedPayload: DecodedPayload<DummyTempPositionDecoder>, payload: JSONObject): Promise<DecodedPayload<DummyTempPositionDecoder>>;
 }

package/dist/index.d.ts

@@ -5,3 +5,4 @@ export * from './lib/modules/device';
 export * from './lib/modules/measure';
 export * from './lib/modules/decoder';
 export * from './lib/modules/shared';
+export * from './lib/modules/model';

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

@@ -1,5 +1,5 @@
 import { JSONObject } from "kuzzle";
-export declare type DeviceManagerConfiguration = {
+export type DeviceManagerConfiguration = {
     /**
      * Ignore errors at startup such as wrong mappings update.
      *

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

@@ -3,7 +3,7 @@ import { AbstractEngine, ConfigManager } from "kuzzle-plugin-commons";
 import { DeviceManagerConfiguration } from "./DeviceManagerConfiguration";
 import { DeviceManagerPlugin } from "./DeviceManagerPlugin";
 import { InternalCollection } from "./InternalCollection";
-export declare type AskEngineUpdateAll = {
+export type AskEngineUpdateAll = {
     name: "ask:device-manager:engine:updateAll";
     payload: void;
     result: void;

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

@@ -2,9 +2,10 @@ import { Plugin, PluginContext, JSONObject } from "kuzzle";
 import { MeasureDefinition } from "../modules/measure";
 import { AssetModelDefinition, DeviceModelDefinition } from "../modules/model";
 import { DeviceManagerConfiguration } from "./DeviceManagerConfiguration";
+import { KuzzleRole } from "lib/modules/shared/types/KuzzleRole";
 export declare class DeviceManagerPlugin extends Plugin {
     config: DeviceManagerConfiguration;
-    roles: {};
+    roles: KuzzleRole[];
     private deviceManagerEngine;
     private adminConfigManager;
     private engineConfigManager;

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

@@ -11,7 +11,7 @@ export declare class ModelsRegister {
     init(plugin: DeviceManagerPlugin): void;
     loadModels(): Promise<void>;
     registerAsset(engineGroup: string, model: string, metadataMappings: JSONObject, measures: Record<string, string>, defaultMetadata?: JSONObject): void;
-    registerDevice(model: string, metadataMappings: JSONObject, measures: Record<string, string>, defaultMetadata?: JSONObject): void;
+    registerDevice(model: string, measures: Record<string, string>, metadataMappings?: JSONObject, defaultMetadata?: JSONObject): void;
     registerMeasure(type: string, measureDefinition: MeasureDefinition): void;
     private load;
 }

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

@@ -4,3 +4,5 @@ export * from "./types/AssetEvents";
 export * from "./types/AssetApi";
 export * from "./model/AssetSerializer";
 export * from "./AssetModule";
+export * from "./roles/RoleAssetsAdmin";
+export * from "./roles/RoleAssetsReader";

package/dist/lib/modules/asset/roles/RoleAssetsAdmin.d.ts

@@ -0,0 +1,22 @@
+import { KuzzleRole } from "../../shared/types/KuzzleRole";
+/**
+ * This role allows to manage assets and their models.
+ *
+ * It's a tenant role.
+ *
+ * @example
+ *
+    "device-manager/assets": {
+      actions: {
+        "*": true,
+      },
+    },
+    "device-manager/models": {
+      actions: {
+        deleteAsset: true,
+        listAssets: true,
+        writeAsset: true,
+      },
+    },
+ */
+export declare const RoleAssetsAdmin: KuzzleRole;

package/dist/lib/modules/asset/roles/RoleAssetsReader.d.ts

@@ -0,0 +1,21 @@
+import { KuzzleRole } from "lib/modules/shared/types/KuzzleRole";
+/**
+ * This role only gives a read-only access to assets and their models.
+ *
+ * It's a tenant role.
+ *
+ * @example
+    "device-manager/assets": {
+      actions: {
+        get: true,
+        getMeasures: true,
+        search: true,
+      },
+    },
+    "device-manager/models": {
+      actions: {
+        listAssets: true,
+      },
+    },
+ */
+export declare const RoleAssetsReader: KuzzleRole;

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

@@ -10,7 +10,7 @@ export interface ApiAssetGetRequest extends AssetsControllerRequest {
     action: "get";
     _id: string;
 }
-export declare type ApiAssetGetResult = KDocument<AssetContent>;
+export type ApiAssetGetResult = KDocument<AssetContent>;
 export interface ApiAssetUpdateRequest extends AssetsControllerRequest {
     action: "update";
     _id: string;
@@ -19,7 +19,7 @@ export interface ApiAssetUpdateRequest extends AssetsControllerRequest {
         metadata: Metadata;
     };
 }
-export declare type ApiAssetUpdateResult = KDocument<AssetContent>;
+export type ApiAssetUpdateResult = KDocument<AssetContent>;
 export interface ApiAssetCreateRequest extends AssetsControllerRequest {
     action: "create";
     refresh?: string;
@@ -29,14 +29,14 @@ export interface ApiAssetCreateRequest extends AssetsControllerRequest {
         metadata?: Metadata;
     };
 }
-export declare type ApiAssetCreateResult = KDocument<AssetContent>;
+export type ApiAssetCreateResult = KDocument<AssetContent>;
 export interface ApiAssetDeleteRequest extends AssetsControllerRequest {
     action: "delete";
     _id: string;
     refresh?: string;
     strict?: boolean;
 }
-export declare type ApiAssetDeleteResult = void;
+export type ApiAssetDeleteResult = void;
 export interface ApiAssetSearchRequest extends AssetsControllerRequest {
     action: "search";
     from?: number;
@@ -44,7 +44,7 @@ export interface ApiAssetSearchRequest extends AssetsControllerRequest {
     scrollTTL?: string;
     body: JSONObject;
 }
-export declare type ApiAssetSearchResult = SearchResult<KHit<AssetContent>>;
+export type ApiAssetSearchResult = SearchResult<KHit<AssetContent>>;
 export interface ApiAssetGetMeasuresRequest extends AssetsControllerRequest {
     action: "getMeasures";
     _id: string;
@@ -52,7 +52,7 @@ export interface ApiAssetGetMeasuresRequest extends AssetsControllerRequest {
     startAt?: string;
     endAt?: string;
 }
-export declare type ApiAssetGetMeasuresResult = {
+export type ApiAssetGetMeasuresResult = {
     measures: Array<KDocument<MeasureContent<JSONObject>>>;
 };
 export {};

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

@@ -29,7 +29,7 @@ export interface AssetContent<TMeasures extends JSONObject = any, TMetadata exte
 /**
  * Asset description used to contextualize each measure data point
  */
-export declare type AssetMeasureContext<TMetadata extends Metadata = Metadata> = {
+export type AssetMeasureContext<TMetadata extends Metadata = Metadata> = {
     /**
      * ID of the asset
      */

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

@@ -1,14 +1,14 @@
 import { KDocument } from "kuzzle";
 import { Metadata } from "../../../modules/shared";
 import { AssetContent } from "./AssetContent";
-export declare type EventAssetUpdateBefore = {
+export type EventAssetUpdateBefore = {
     name: "device-manager:asset:update:before";
     args: [{
         asset: KDocument<AssetContent>;
         metadata: Metadata;
     }];
 };
-export declare type EventAssetUpdateAfter = {
+export type EventAssetUpdateAfter = {
     name: "device-manager:asset:update:after";
     args: [{
         asset: KDocument<AssetContent>;

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

@@ -43,4 +43,5 @@ export declare class DecodedPayload<TDecoder extends Decoder = Decoder> {
      * Get the metadata for a device
      */
     getMetadata(deviceReference: string): JSONObject;
+    private validateMeasurement;
 }

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

@@ -4,7 +4,7 @@ import { DecoderContent } from "./types/DecoderContent";
 /**
  * Array of measures declaration
  */
-export declare type NamedMeasures = ReadonlyArray<{
+export type NamedMeasures = ReadonlyArray<{
     name: string;
     type: string;
 }>;
@@ -82,12 +82,13 @@ export declare abstract class Decoder {
      *  - set "reference"
      *  - fetch measures
      *
+     * @param decodedPayload Decoded payload to store decoded measures
      * @param payload Raw payload received in the API action body
      * @param request Original request
      *
      * @returns DecodedPayload
      */
-    abstract decode(payload: JSONObject, request: KuzzleRequest): Promise<DecodedPayload<Decoder>>;
+    abstract decode(decodedPayload: DecodedPayload<any>, payload: JSONObject, request: KuzzleRequest): Promise<DecodedPayload<any>>;
     /**
      * Checks if the provided properties are present in the payload
      *

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

@@ -4,3 +4,5 @@ export * from "./types/DecoderContent";
 export * from "./DecodedPayload";
 export * from "./Decoder";
 export * from "./DecoderModule";
+export * from "./roles/RolePayloadsAll";
+export * from "./roles/RoleDecodersAdmin";

package/dist/lib/modules/decoder/roles/RoleDecodersAdmin.d.ts

@@ -0,0 +1,14 @@
+import { KuzzleRole } from "../../shared/types/KuzzleRole";
+/**
+ * Role used to manage decoders and their payloads.
+ *
+ * It's a platform role.
+ *
+ * @example
+    "device-manager/decoders": {
+      actions: {
+        "*": true,
+      },
+    },
+ */
+export declare const RoleDecodersAdmin: KuzzleRole;

package/dist/lib/modules/decoder/roles/RolePayloadsAll.d.ts

@@ -0,0 +1,12 @@
+import { KuzzleRole } from "../../shared/types/KuzzleRole";
+/**
+ * This role allows to receive any kind of payloads.
+ *
+@example
+    "device-manager/payloads": {
+      actions: {
+        "*": true,
+      },
+    },
+ */
+export declare const RolePayloadsAll: KuzzleRole;

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

@@ -6,14 +6,14 @@ export interface ApiDecoderListRequest extends DecodersControllerRequest {
     action: "list";
     _id: string;
 }
-export declare type ApiDecoderListResult = {
+export type ApiDecoderListResult = {
     decoders: DecoderContent[];
 };
 export interface ApiDecoderPrunePayloadsRequest extends DecodersControllerRequest {
     action: "prunePayloads";
     _id: string;
 }
-export declare type ApiDecoderPrunePayloadsResult = {
+export type ApiDecoderPrunePayloadsResult = {
     deleted: number;
 };
 export {};

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

@@ -7,5 +7,5 @@ export interface ApiPayloadReceiveUnkownRequest extends PayloadsControllerReques
     deviceModel: string;
     body: JSONObject;
 }
-export declare type ApiPayloadReceiveUnkownResult = void;
+export type ApiPayloadReceiveUnkownResult = void;
 export {};

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

@@ -4,3 +4,6 @@ export * from "./types/DeviceApi";
 export * from "./types/DeviceEvents";
 export * from "./model/DeviceSerializer";
 export * from "./DeviceModule";
+export * from "./roles/RoleDevicesAdmin";
+export * from "./roles/RoleDevicesPlatformAdmin";
+export * from "./roles/RoleDevicesReader";

package/dist/lib/modules/device/roles/RoleDevicesAdmin.d.ts

@@ -0,0 +1,27 @@
+import { KuzzleRole } from "../../shared/types/KuzzleRole";
+/**
+ * This role allows to manage devices.
+ *
+ * It's a tenant role.
+ *
+ * @example
+    "device-manager/devices": {
+      actions: {
+        create: true,
+        delete: true,
+        get: true,
+        linkAsset: true,
+        search: true,
+        unlinkAsset: true,
+        update: true,
+      },
+    },
+    "device-manager/models": {
+      actions: {
+        deleteDevice: true,
+        listDevices: true,
+        writeDevice: true,
+      },
+    },
+ */
+export declare const RoleDevicesAdmin: KuzzleRole;

package/dist/lib/modules/device/roles/RoleDevicesPlatformAdmin.d.ts

@@ -0,0 +1,21 @@
+import { KuzzleRole } from "../../shared/types/KuzzleRole";
+/**
+ * This role allows to manage devices and also assign them to tenants.
+ *
+ * It's a platform role.
+ *
+ * @example
+    "device-manager/devices": {
+      actions: {
+        "*": true,
+      },
+    },
+    "device-manager/models": {
+      actions: {
+        deleteDevice: true,
+        listDevices: true,
+        writeDevice: true,
+      },
+    },
+ */
+export declare const RoleDevicesPlatformAdmin: KuzzleRole;

package/dist/lib/modules/device/roles/RoleDevicesReader.d.ts

@@ -0,0 +1,21 @@
+import { KuzzleRole } from "../../shared/types/KuzzleRole";
+/**
+ * This role only gives a read-only access to devices and their models.
+ *
+ * It's a tenant role.
+ *
+ * @example
+    "device-manager/devices": {
+      actions: {
+        get: true,
+        search: true,
+      },
+    },
+    "device-manager/models": {
+      actions: {
+        listDevices: true,
+      },
+    },
+    }
+ */
+export declare const RoleDevicesReader: KuzzleRole;

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

@@ -10,7 +10,7 @@ export interface ApiDeviceGetRequest extends DevicesControllerRequest {
     action: "get";
     _id: string;
 }
-export declare type ApiDeviceGetResult = KDocument<DeviceContent>;
+export type ApiDeviceGetResult = KDocument<DeviceContent>;
 export interface ApiDeviceUpdateRequest extends DevicesControllerRequest {
     action: "update";
     _id: string;
@@ -19,7 +19,7 @@ export interface ApiDeviceUpdateRequest extends DevicesControllerRequest {
         metadata: Metadata;
     };
 }
-export declare type ApiDeviceUpdateResult = KDocument<DeviceContent>;
+export type ApiDeviceUpdateResult = KDocument<DeviceContent>;
 export interface ApiDeviceCreateRequest extends DevicesControllerRequest {
     action: "create";
     refresh?: string;
@@ -29,14 +29,14 @@ export interface ApiDeviceCreateRequest extends DevicesControllerRequest {
         metadata?: Metadata;
     };
 }
-export declare type ApiDeviceCreateResult = KDocument<DeviceContent>;
+export type ApiDeviceCreateResult = KDocument<DeviceContent>;
 export interface ApiDeviceDeleteRequest extends DevicesControllerRequest {
     action: "delete";
     _id: string;
     refresh?: string;
     strict?: boolean;
 }
-export declare type ApiDeviceDeleteResult = void;
+export type ApiDeviceDeleteResult = void;
 export interface ApiDeviceSearchRequest extends DevicesControllerRequest {
     action: "search";
     from?: number;
@@ -44,14 +44,14 @@ export interface ApiDeviceSearchRequest extends DevicesControllerRequest {
     scrollTTL?: string;
     body: JSONObject;
 }
-export declare type ApiDeviceSearchResult = SearchResult<KHit<DeviceContent>>;
+export type ApiDeviceSearchResult = SearchResult<KHit<DeviceContent>>;
 export interface ApiDeviceUnlinkAssetRequest extends DevicesControllerRequest {
     action: "unlinkAsset";
     _id: string;
     strict?: boolean;
     refresh?: string;
 }
-export declare type ApiDeviceUnlinkAssetResult = {
+export type ApiDeviceUnlinkAssetResult = {
     asset: KDocument<AssetContent>;
     device: KDocument<DeviceContent>;
 };
@@ -60,13 +60,13 @@ export interface ApiDeviceAttachEngineRequest extends DevicesControllerRequest {
     _id: string;
     refresh?: string;
 }
-export declare type ApiDeviceAttachEngineResult = void;
+export type ApiDeviceAttachEngineResult = void;
 export interface ApiDeviceDetachEngineRequest extends DevicesControllerRequest {
     action: "detachEngine";
     _id: string;
     refresh?: string;
 }
-export declare type ApiDeviceDetachEngineResult = void;
+export type ApiDeviceDetachEngineResult = void;
 export interface ApiDeviceLinkAssetRequest extends DevicesControllerRequest {
     action: "linkAsset";
     _id: string;
@@ -87,7 +87,7 @@ export interface ApiDeviceLinkAssetRequest extends DevicesControllerRequest {
         measureNames: Record<string, string>;
     };
 }
-export declare type ApiDeviceLinkAssetResult = {
+export type ApiDeviceLinkAssetResult = {
     asset: KDocument<AssetContent>;
     device: KDocument<DeviceContent>;
 };

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

@@ -1,14 +1,14 @@
 import { KDocument } from "kuzzle";
 import { Metadata } from "../../../modules/shared";
 import { DeviceContent } from "./DeviceContent";
-export declare type EventDeviceUpdateBefore = {
+export type EventDeviceUpdateBefore = {
     name: "device-manager:device:update:before";
     args: [{
         device: KDocument<DeviceContent>;
         metadata: Metadata;
     }];
 };
-export declare type EventDeviceUpdateAfter = {
+export type EventDeviceUpdateAfter = {
     name: "device-manager:device:update:after";
     args: [{
         device: KDocument<DeviceContent>;

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

@@ -5,3 +5,5 @@ export * from "./types/MeasureContent";
 export * from "./types/MeasureDefinition";
 export * from "./measures";
 export * from "./MeasureModule";
+export * from "./roles/RoleMeasuresAdmin";
+export * from "./roles/RoleMeasuresReader";

package/dist/lib/modules/measure/measures/BatteryMeasure.d.ts

@@ -1,5 +1,5 @@
 import { MeasureDefinition } from "./../types/MeasureDefinition";
-export declare type BatteryMeasurement = {
+export type BatteryMeasurement = {
     battery: number;
 };
-export declare const batteryMeasure: MeasureDefinition;
+export declare const batteryMeasureDefinition: MeasureDefinition;

package/dist/lib/modules/measure/measures/HumidityMeasure.d.ts

@@ -1,5 +1,5 @@
 import { MeasureDefinition } from "./../types/MeasureDefinition";
-export declare type HumidityMeasurement = {
+export type HumidityMeasurement = {
     humidity: number;
 };
-export declare const humidityMeasure: MeasureDefinition;
+export declare const humidityMeasureDefinition: MeasureDefinition;

package/dist/lib/modules/measure/measures/MovementMeasure.d.ts

@@ -1,5 +1,5 @@
 import { MeasureDefinition } from "./../types/MeasureDefinition";
-export declare type MovementMeasurement = {
+export type MovementMeasurement = {
     movement: boolean;
 };
-export declare const movementMeasure: MeasureDefinition;
+export declare const movementMeasureDefinition: MeasureDefinition;

package/dist/lib/modules/measure/measures/PositionMeasure.d.ts

@@ -1,5 +1,5 @@
 import { MeasureDefinition } from "./../types/MeasureDefinition";
-export declare type PositionMeasurement = {
+export type PositionMeasurement = {
     position: {
         lat: number;
         lon: number;
@@ -7,4 +7,4 @@ export declare type PositionMeasurement = {
     altitude?: number;
     accuracy?: number;
 };
-export declare const positionMeasure: MeasureDefinition;
+export declare const positionMeasureDefinition: MeasureDefinition;

package/dist/lib/modules/measure/measures/TemperatureMeasure.d.ts

@@ -1,5 +1,5 @@
 import { MeasureDefinition } from "./../types/MeasureDefinition";
-export declare type TemperatureMeasurement = {
+export type TemperatureMeasurement = {
     temperature: number;
 };
-export declare const temperatureMeasure: MeasureDefinition;
+export declare const temperatureMeasureDefinition: MeasureDefinition;

package/dist/lib/modules/measure/roles/RoleMeasuresAdmin.d.ts

@@ -0,0 +1,21 @@
+import { KuzzleRole } from "lib/modules/shared/types/KuzzleRole";
+/**
+ * This role allows to push measures and manage their models.
+ *
+ * It's a tenant role.
+ *
+ * @example
+    "device-manager/measures": {
+      actions: {
+        "*": true,
+      },
+    },
+    "device-manager/models": {
+      actions: {
+        deleteMeasure: true,
+        listMeasures: true,
+        writeMeasure: true,
+      },
+    },
+ */
+export declare const RoleMeasuresAdmin: KuzzleRole;

package/dist/lib/modules/measure/roles/RoleMeasuresReader.d.ts

@@ -0,0 +1,14 @@
+import { KuzzleRole } from "lib/modules/shared/types/KuzzleRole";
+/**
+ * This role allows to list measure models.
+ *
+ * It's a tenant role.
+ *
+ * @example
+    "device-manager/models": {
+      actions: {
+        listMeasures: true,
+      },
+    },
+ */
+export declare const RoleMeasuresReader: KuzzleRole;

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

@@ -17,7 +17,7 @@ export interface ApiMeasurePushRequest extends MeasuresControllerRequest {
         };
     };
 }
-export declare type ApiMeasurePushResult = {
+export type ApiMeasurePushResult = {
     asset: KDocument<AssetContent>;
 };
 export {};

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

@@ -43,7 +43,7 @@ export interface MeasureContent<TMeasureValues extends JSONObject = any, TMetada
         _id?: string;
     };
 }
-export declare type Measurement<TMeasureValues extends JSONObject = any> = {
+export type Measurement<TMeasureValues extends JSONObject = any> = {
     /**
      * Type of the measure. (e.g. "temperature")
      */
@@ -62,6 +62,6 @@ export declare type Measurement<TMeasureValues extends JSONObject = any> = {
 /**
  * Used in the DecodedPayload to store a decoded measure
  */
-export declare type DecodedMeasurement<TMeasureValues extends JSONObject = JSONObject> = {
+export type DecodedMeasurement<TMeasureValues extends JSONObject = JSONObject> = {
     measureName: string;
 } & Measurement<TMeasureValues>;

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

@@ -6,7 +6,7 @@ import { DecodedMeasurement, MeasureContent } from "./MeasureContent";
 /**
  * @internal
  */
-export declare type EventMeasureIngest = {
+export type EventMeasureIngest = {
     name: "device-manager:measures:ingest";
     args: [
         {
@@ -17,7 +17,7 @@ export declare type EventMeasureIngest = {
         }
     ];
 };
-export declare type EventMeasureProcessBefore = {
+export type EventMeasureProcessBefore = {
     name: "device-manager:measures:process:before";
     args: [
         {
@@ -27,7 +27,7 @@ export declare type EventMeasureProcessBefore = {
         }
     ];
 };
-export declare type TenantEventMeasureProcessBefore = {
+export type TenantEventMeasureProcessBefore = {
     name: `engine:${string}:device-manager:measures:process:before`;
     args: [
         {
@@ -37,7 +37,7 @@ export declare type TenantEventMeasureProcessBefore = {
         }
     ];
 };
-export declare type EventMeasureProcessAfter = {
+export type EventMeasureProcessAfter = {
     name: "device-manager:measures:process:after";
     args: [
         {
@@ -47,7 +47,7 @@ export declare type EventMeasureProcessAfter = {
         }
     ];
 };
-export declare type TenantEventMeasureProcessAfter = {
+export type TenantEventMeasureProcessAfter = {
     name: `engine:${string}:device-manager:measures:process:after`;
     args: [
         {

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

@@ -12,7 +12,7 @@ export interface ApiModelCreateAssetRequest extends ModelsControllerRequest {
         defaultValues: JSONObject;
     };
 }
-export declare type ApiModelCreateAssetResult = KDocument<AssetModelContent>;
+export type ApiModelCreateAssetResult = KDocument<AssetModelContent>;
 export interface ApiModelCreateDeviceRequest extends ModelsControllerRequest {
     action: "writeDevice";
     body: {
@@ -21,7 +21,7 @@ export interface ApiModelCreateDeviceRequest extends ModelsControllerRequest {
         defaultValues: JSONObject;
     };
 }
-export declare type ApiModelCreateDeviceResult = KDocument<DeviceModelContent>;
+export type ApiModelCreateDeviceResult = KDocument<DeviceModelContent>;
 export interface ApiModelCreateMeasureRequest extends ModelsControllerRequest {
     action: "writeMeasure";
     body: {
@@ -34,41 +34,41 @@ export interface ApiModelCreateMeasureRequest extends ModelsControllerRequest {
         valuesMappings: JSONObject;
     };
 }
-export declare type ApiModelCreateMeasureResult = KDocument<MeasureModelContent>;
+export type ApiModelCreateMeasureResult = KDocument<MeasureModelContent>;
 export interface ApiModelDeleteAssetRequest extends ModelsControllerRequest {
     action: "deleteAsset";
     _id: string;
 }
-export declare type ApiModelDeleteAssetResult = void;
+export type ApiModelDeleteAssetResult = void;
 export interface ApiModelDeleteDeviceRequest extends ModelsControllerRequest {
     action: "deleteDevice";
     _id: string;
 }
-export declare type ApiModelDeleteDeviceResult = void;
+export type ApiModelDeleteDeviceResult = void;
 export interface ApiModelDeleteMeasureRequest extends ModelsControllerRequest {
     action: "deleteMeasure";
     _id: string;
 }
-export declare type ApiModelDeleteMeasureResult = void;
+export type ApiModelDeleteMeasureResult = void;
 export interface ApiModelListAssetsRequest extends ModelsControllerRequest {
     action: "listAssets";
     engineGroup: string;
 }
-export declare type ApiModelListAssetsResult = {
+export type ApiModelListAssetsResult = {
     models: KDocument<AssetModelContent>[];
     total: number;
 };
 export interface ApiModelListDevicesRequest extends ModelsControllerRequest {
     action: "listDevices";
 }
-export declare type ApiModelListDevicesResult = {
+export type ApiModelListDevicesResult = {
     models: KDocument<DeviceModelContent>[];
     total: number;
 };
 export interface ApiModelListMeasuresRequest extends ModelsControllerRequest {
     action: "listMeasures";
 }
-export declare type ApiModelListMeasuresResult = {
+export type ApiModelListMeasuresResult = {
     models: KDocument<MeasureModelContent>[];
     total: number;
 };

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

@@ -93,4 +93,4 @@ export interface DeviceModelContent extends KDocumentContent {
         measures: Record<string, string>;
     };
 }
-export declare type ModelContent = MeasureModelContent | AssetModelContent | DeviceModelContent;
+export type ModelContent = MeasureModelContent | AssetModelContent | DeviceModelContent;

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

@@ -1,12 +1,62 @@
 import { JSONObject } from "kuzzle";
 import { Decoder, NamedMeasures } from "../../../modules/decoder";
-export declare type AssetModelDefinition = {
+/**
+ * Define an asset model
+ *
+ * @example
+ *   {
+ *     measuresNames: [
+ *       { name: "temperatureExt", type: "temperature" },
+ *       { name: "temperatureInt", type: "temperature" },
+ *       { name: "position", type: "position" },
+ *     ],
+ *     metadataMappings: {
+ *       weight: { type: "integer" },
+ *       height: { type: "integer" },
+ *     },
+ *     defaultMetadata: {
+ *       height: 20
+ *     }
+ *   }
+ *
+ */
+export type AssetModelDefinition = {
+    /**
+     * Array describing measures names and types
+     */
     measuresNames: NamedMeasures;
+    /**
+     * Metadata mappings definition
+     */
     metadataMappings: JSONObject;
+    /**
+     * Default metadata values
+     */
     defaultMetadata?: JSONObject;
 };
-export declare type DeviceModelDefinition = {
+/**
+ * Define a device model
+ *
+ * @example
+ *   {
+ *     decoder: new DummyTempPositionDecoder(),
+ *     metadataMappings: {
+ *       serial: { type: "keyword" },
+ *     }
+ *   }
+ *
+ */
+export type DeviceModelDefinition = {
+    /**
+     * Decoder used to decode payloads
+     */
     decoder: Decoder;
-    metadataMappings: JSONObject;
+    /**
+     * Metadata mappings definition
+     */
+    metadataMappings?: JSONObject;
+    /**
+     * Default metadata values
+     */
     defaultMetadata?: JSONObject;
 };

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

@@ -1,5 +1,5 @@
 import { AssetModelContent, DeviceModelContent } from "./ModelContent";
-export declare type AskModelAssetGet = {
+export type AskModelAssetGet = {
     name: "ask:device-manager:model:asset:get";
     payload: {
         engineGroup: string;
@@ -7,7 +7,7 @@ export declare type AskModelAssetGet = {
     };
     result: AssetModelContent;
 };
-export declare type AskModelDeviceGet = {
+export type AskModelDeviceGet = {
     name: "ask:device-manager:model:device:get";
     payload: {
         model: string;

package/dist/lib/modules/shared/types/EmbeddedMeasure.d.ts

@@ -1,5 +1,5 @@
 import { JSONObject } from "kuzzle";
-export declare type EmbeddedMeasure<TMeasureValue extends JSONObject = JSONObject> = {
+export type EmbeddedMeasure<TMeasureValue extends JSONObject = JSONObject> = {
     /**
      * Payloads that created this measure.
      * This can be used to retrieve the measure in the measures collection

package/dist/lib/modules/shared/types/KuzzleRole.d.ts

@@ -0,0 +1,5 @@
+import { RoleDefinition } from "kuzzle";
+export interface KuzzleRole {
+    name: string;
+    definition: RoleDefinition;
+}

package/dist/lib/modules/shared/types/Metadata.d.ts

@@ -1,5 +1,5 @@
-export declare type MetadataValue = boolean | number | string | {
+export type MetadataValue = boolean | number | string | {
     lat: number;
     lon: number;
 };
-export declare type Metadata = Record<string, MetadataValue | Record<string, MetadataValue>>;
+export type Metadata = Record<string, MetadataValue | Record<string, MetadataValue>>;

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

@@ -1,8 +1,8 @@
-export declare type AskEventDefinition = {
+export type AskEventDefinition = {
     name: string;
     payload: any;
     result: any;
 };
-export declare type AskEventHandler<TAskEventDefinition extends AskEventDefinition = AskEventDefinition> = (payload?: TAskEventDefinition["payload"]) => Promise<TAskEventDefinition["result"]>;
+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 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.0-rc29",
+  "version": "2.0.0-rc35",
   "description": "Shared types for Kuzzle Device Manager",
   "author": "The Kuzzle Team (support@kuzzle.io)",
   "types": "dist/index.d.ts",