kuzzle-device-manager-types 2.4.0-beta.14 → 2.4.0-beta.16

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

@@ -1,10 +1,10 @@
 import { KuzzleRequest, User } from "kuzzle";
 import { JSONObject, KDocument, KHit, SearchResult, mReplaceResponse } from "kuzzle-sdk";
 import { DeviceManagerPlugin } from "../plugin";
-import { Metadata, BaseService, SearchParams } from "../shared";
+import { BaseService, Metadata, SearchParams } from "../shared";
 import { AssetHistoryService } from "./AssetHistoryService";
-import { AssetContent } from "./types/AssetContent";
 import { ApiAssetMigrateTenantResult } from "./types/AssetApi";
+import { AssetContent } from "./types/AssetContent";
 export declare class AssetService extends BaseService {
     private assetHistoryService;
     constructor(plugin: DeviceManagerPlugin, assetHistoryService: AssetHistoryService);

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

@@ -1,8 +1,8 @@
 import { KuzzleRequest } from "kuzzle";
 import { JSONObject, KDocument } from "kuzzle-sdk";
-import { DeviceManagerPlugin } from "../plugin";
 import { DeviceContent } from "../device";
 import { DecodedMeasurement } from "../measure";
+import { DeviceManagerPlugin } from "../plugin";
 import { BaseService } from "../shared";
 import { Decoder } from "./Decoder";
 export declare class PayloadService extends BaseService {

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

@@ -1,11 +1,11 @@
 import { KuzzleRequest } from "kuzzle";
 import { JSONObject, KDocument, KHit, SearchResult } from "kuzzle-sdk";
-import { AssetContent } from "./../asset";
-import { DeviceManagerPlugin } from "../plugin";
-import { Metadata, BaseService, SearchParams } from "../shared";
 import { DecodedMeasurement } from "../measure";
-import { DeviceContent } from "./types/DeviceContent";
+import { DeviceManagerPlugin } from "../plugin";
+import { BaseService, Metadata, SearchParams } from "../shared";
+import { AssetContent } from "./../asset";
 import { ApiDeviceLinkAssetRequest } from "./types/DeviceApi";
+import { DeviceContent } from "./types/DeviceContent";
 export declare class DeviceService extends BaseService {
     constructor(plugin: DeviceManagerPlugin);
     registerAskEvents(): void;

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

@@ -1,7 +1,7 @@
 /// <reference types="node" />
 /// <reference types="node" />
-import { UUID } from "node:crypto";
 import { KHit, User } from "kuzzle";
+import { UUID } from "node:crypto";
 import { AbstractExporter, Column, ExportParams } from "../shared";
 import { MeasureContent } from "./exports";
 interface MeasureSearchParams extends ExportParams {

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

@@ -1,5 +1,5 @@
 import { JSONObject, KDocument } from "kuzzle-sdk";
-import { AssetModelContent, DeviceModelContent, MeasureModelContent } from "./ModelContent";
+import { AssetModelContent, DeviceModelContent, MeasureModelContent, MetadataDetails, MetadataGroups, MetadataMappings } from "./ModelContent";
 interface ModelsControllerRequest {
     controller: "device-manager/models";
 }
@@ -24,7 +24,9 @@ export interface ApiModelWriteAssetRequest extends ModelsControllerRequest {
     body: {
         engineGroup: string;
         model: string;
-        metadataMappings?: JSONObject;
+        metadataDetails?: MetadataDetails;
+        metadataGroups?: MetadataGroups;
+        metadataMappings?: MetadataMappings;
         defaultValues?: JSONObject;
         measures?: AssetModelContent["asset"]["measures"];
     };
@@ -34,7 +36,9 @@ export interface ApiModelWriteDeviceRequest extends ModelsControllerRequest {
     action: "writeDevice";
     body: {
         model: string;
-        metadataMappings?: JSONObject;
+        metadataDetails?: MetadataDetails;
+        metadataGroups?: MetadataGroups;
+        metadataMappings?: MetadataMappings;
         defaultValues?: JSONObject;
         measures: DeviceModelContent["device"]["measures"];
     };

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

@@ -31,6 +31,7 @@ export interface MetadataDetails {
 }
 interface MetadataGroupLocale {
     groupFriendlyName: string;
+    description: string;
 }
 export interface MetadataGroups {
     [groupName: string]: {
@@ -94,10 +95,12 @@ export interface AssetModelContent extends KDocumentContent {
          *   "buildingEnv": {
          *     "locales": {
          *       "en": {
-         *         "groupFriendlyName": "Building environment"
+         *         "groupFriendlyName": "Building environment",
+         *         "description": "The building environment"
          *       },
          *       "fr": {
-         *         "groupFriendlyName": "Environnement du bâtiment"
+         *         "groupFriendlyName": "Environnement du bâtiment",
+         *         "description": "L'environnement du bâtiment"
          *       }
          *     }
          *   }
@@ -172,10 +175,12 @@ export interface DeviceModelContent extends KDocumentContent {
          *   "sensorSpecs": {
          *     "locales": {
          *       "en": {
-         *         "groupFriendlyName": "Sensor specifications"
+         *         "groupFriendlyName": "Sensor specifications",
+         *         "description" : "All sensors specifications"
          *       },
          *       "fr": {
-         *         "groupFriendlyName": "Spécifications techniques"
+         *         "groupFriendlyName": "Spécifications techniques",
+         *         "description": "Toutes les spécifications techniques"
          *       }
          *     }
          *   }

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

@@ -34,14 +34,16 @@ import { MetadataDetails, MetadataGroups, MetadataMappings } from "./ModelConten
  *       }
  *     },
  *     metadataGroups: {
- *       "buildingEnv": {
- *         "locales": {
- *           "en": {
- *             "groupFriendlyName": "Building environment"
- *           },
- *           "fr": {
- *             "groupFriendlyName": "Environnement du bâtiment"
- *           }
+ *       buildingEnv: {
+ *         locales: {
+ *          en: {
+ *            groupFriendlyName: "Building environment",
+ *            description: "The building environment"
+ *          },
+ *          fr: {
+ *            groupFriendlyName: "Environnement du bâtiment",
+ *            description: "L'environnement du bâtiment"
+ *          }
  *         }
  *       }
  *     }
@@ -98,19 +100,20 @@ export type AssetModelDefinition = {
  *       }
  *     },
  *     metadataGroups: {
- *       sensorSpecs: {
- *         locales: {
- *           en: {
- *             groupFriendlyName: "Sensors specifications"
- *           },
- *           fr: {
- *             groupFriendlyName: "Spécifications des capteurs"
- *           }
- *         }
- *       }
- *     }
- *   }
- *
+ *      sensorSpecs: {
+ *        locales: {
+ *          en: {
+ *            groupFriendlyName: "Sensor specifications",
+ *            description : "All sensors specifications"
+ *          },
+ *          fr: {
+ *            groupFriendlyName: "Spécifications techniques",
+ *            description: "Toutes les spécifications techniques"
+ *          }
+ *        }
+ *      }
+ *    }
+ *  }
  */
 export type DeviceModelDefinition = {
     /**

package/dist/lib/modules/plugin/DeviceManagerEngine.d.ts

@@ -1,8 +1,7 @@
 import { Backend, Plugin } from "kuzzle";
-import { AbstractEngine, ConfigManager } from "kuzzle-plugin-commons";
-import { EngineContent } from "kuzzle-plugin-commons";
-import { DeviceManagerConfiguration } from "./types/DeviceManagerConfiguration";
+import { AbstractEngine, ConfigManager, EngineContent } from "kuzzle-plugin-commons";
 import { DeviceManagerPlugin } from "./DeviceManagerPlugin";
+import { DeviceManagerConfiguration } from "./types/DeviceManagerConfiguration";
 import { InternalCollection } from "./types/InternalCollection";
 export type AskEngineList = {
     name: "ask:device-manager:engine:list";

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

@@ -1,11 +1,10 @@
-export * from "./services";
 export * from "./Module";
+export * from "./services";
 export * from "./types/DigitalTwinContent";
-export * from "./types/Metadata";
 export * from "./types/EmbeddedMeasure";
 export * from "./types/KuzzleRole";
-export * from "./utils/lock";
+export * from "./types/Metadata";
 export * from "./utils/flattenObject";
-export * from "./utils/ask";
 export * from "./utils/keepStack";
+export * from "./utils/lock";
 export * from "./utils/objectDiff";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kuzzle-device-manager-types",
-  "version": "2.4.0-beta.14",
+  "version": "2.4.0-beta.16",
   "description": "Shared types for Kuzzle Device Manager",
   "author": "The Kuzzle Team (support@kuzzle.io)",
   "main": "index.js",

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

@@ -1,8 +0,0 @@
-export type AskEventDefinition = {
-    name: string;
-    payload: any;
-    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>): any;
-export declare function ask<TAskEventDefinition extends AskEventDefinition = AskEventDefinition>(event: TAskEventDefinition["name"], payload?: TAskEventDefinition["payload"]): Promise<TAskEventDefinition["result"]>;