kuzzle-device-manager-types 2.4.0-beta.13 → 2.4.0-beta.15

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

@@ -17,7 +17,7 @@ export declare class AssetService extends BaseService {
     /**
      * Update or Create an asset metadata
      */
-    upsert(engineId: string, assetId: string, model: string, reference: string, metadata: Metadata, request: KuzzleRequest): Promise<KDocument<AssetContent>>;
+    upsert(engineId: string, model: string, reference: string, metadata: Metadata, request: KuzzleRequest): Promise<KDocument<AssetContent>>;
     /**
      * Create an asset metadata
      */

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

@@ -1,5 +1,6 @@
 import { NamedMeasures } from "../Decoder";
 export interface DecoderContent {
     deviceModel: string;
+    action?: string;
     measures: NamedMeasures;
 }

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

@@ -38,7 +38,10 @@ export declare class MeasureExporter extends AbstractExporter<MeasureExportParam
      * Never return a rejected promise and write potential error on the stream
      */
     prepareExport(engineId: string, user: User, params: MeasureSearchParams): Promise<string>;
-    protected formatHit(columns: Column[], hit: KHit<MeasureContent>): any[];
+    protected formatHit(columns: Array<Column & {
+        shouldCheckName: boolean;
+        name: string;
+    }>, hit: KHit<MeasureContent>): any[];
     /**
      * Retrieve a prepared export and write each document as a CSV in the stream
      *

package/dist/lib/modules/model/ModelService.d.ts

@@ -1,13 +1,13 @@
 import { JSONObject, KDocument } from "kuzzle-sdk";
 import { DeviceManagerPlugin } from "../plugin";
 import { BaseService } from "../shared";
-import { AssetModelContent, DeviceModelContent, MeasureModelContent } from "./types/ModelContent";
+import { AssetModelContent, DeviceModelContent, MeasureModelContent, MetadataDetails, MetadataGroups, MetadataMappings } from "./types/ModelContent";
 export declare class ModelService extends BaseService {
     constructor(plugin: DeviceManagerPlugin);
     registerAskEvents(): void;
-    writeAsset(engineGroup: string, model: string, metadataMappings: JSONObject, defaultMetadata: JSONObject, measures: AssetModelContent["asset"]["measures"]): Promise<KDocument<AssetModelContent>>;
+    writeAsset(engineGroup: string, model: string, metadataMappings: MetadataMappings, defaultMetadata: JSONObject, metadataDetails: MetadataDetails, metadataGroups: MetadataGroups, measures: AssetModelContent["asset"]["measures"]): Promise<KDocument<AssetModelContent>>;
     private checkDefaultValues;
-    writeDevice(model: string, metadataMappings: JSONObject, defaultMetadata: JSONObject, measures: DeviceModelContent["device"]["measures"]): Promise<KDocument<DeviceModelContent>>;
+    writeDevice(model: string, metadataMappings: MetadataMappings, defaultMetadata: JSONObject, metadataDetails: MetadataDetails, metadataGroups: MetadataGroups, measures: DeviceModelContent["device"]["measures"]): Promise<KDocument<DeviceModelContent>>;
     writeMeasure(type: string, valuesMappings: JSONObject): Promise<KDocument<MeasureModelContent>>;
     deleteAsset(_id: string): Promise<void>;
     deleteDevice(_id: string): Promise<void>;

package/dist/lib/modules/model/ModelsRegister.d.ts

@@ -1,7 +1,8 @@
-import { JSONObject } from "kuzzle-sdk";
 import { DeviceManagerPlugin } from "../plugin";
 import { NamedMeasures } from "../decoder";
 import { MeasureDefinition } from "../measure";
+import { MetadataDetails, MetadataGroups, MetadataMappings } from "./types/ModelContent";
+import { JSONObject } from "kuzzle-sdk";
 export declare class ModelsRegister {
     private config;
     private context;
@@ -11,8 +12,31 @@ export declare class ModelsRegister {
     private get sdk();
     init(plugin: DeviceManagerPlugin): void;
     loadModels(): Promise<void>;
-    registerAsset(engineGroup: string, model: string, measures: NamedMeasures, metadataMappings?: JSONObject, defaultMetadata?: JSONObject): void;
-    registerDevice(model: string, measures: NamedMeasures, metadataMappings?: JSONObject, defaultMetadata?: JSONObject): void;
+    /**
+     * Registers an asset model.
+     *
+     * @param engineGroup - The engine group name.
+     * @param model - The name of the asset model, which must be in PascalCase.
+     * @param measures - The measures associated with this asset model.
+     * @param metadataMappings - The metadata mappings for the model, defaults to an empty object.
+     * @param defaultMetadata - The default metadata values for the model, defaults to an empty object.
+     * @param metadataDetails - Optional detailed metadata descriptions and localizations.
+     * @param metadataGroups - Optional groups for organizing metadata, with localizations.
+     * @throws PluginImplementationError if the model name is not in PascalCase.
+     */
+    registerAsset(engineGroup: string, model: string, measures: NamedMeasures, metadataMappings?: MetadataMappings, defaultMetadata?: JSONObject, metadataDetails?: MetadataDetails, metadataGroups?: MetadataGroups): void;
+    /**
+     * Registers a device model.
+     *
+     * @param model - The name of the device model, which must be in PascalCase.
+     * @param measures - The measures associated with this device model.
+     * @param metadataMappings - The metadata mappings for the model, defaults to an empty object.
+     * @param defaultMetadata - The default metadata values for the model, defaults to an empty object.
+     * @param metadataDetails - Optional detailed metadata descriptions and localizations.
+     * @param metadataGroups - Optional groups for organizing metadata, with localizations.
+     * @throws PluginImplementationError if the model name is not in PascalCase.
+     */
+    registerDevice(model: string, measures: NamedMeasures, metadataMappings?: MetadataMappings, defaultMetadata?: JSONObject, metadataDetails?: MetadataDetails, metadataGroups?: MetadataGroups): void;
     registerMeasure(type: string, measureDefinition: MeasureDefinition): void;
     private load;
 }

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

@@ -7,6 +7,39 @@ export interface MeasureModelContent extends KDocumentContent {
         type: string;
     };
 }
+interface MetadataProperty {
+    type: string;
+}
+export interface MetadataMappings {
+    [key: string]: MetadataProperty | {
+        properties: {
+            [key: string]: MetadataProperty;
+        };
+    };
+}
+interface LocaleDetails {
+    friendlyName: string;
+    description: string;
+}
+export interface MetadataDetails {
+    [key: string]: {
+        group?: string;
+        locales: {
+            [locale: string]: LocaleDetails;
+        };
+    };
+}
+interface MetadataGroupLocale {
+    groupFriendlyName: string;
+    description: string;
+}
+export interface MetadataGroups {
+    [groupName: string]: {
+        locales: {
+            [locale: string]: MetadataGroupLocale;
+        };
+    };
+}
 export interface AssetModelContent extends KDocumentContent {
     type: "asset";
     engineGroup: string;
@@ -27,7 +60,7 @@ export interface AssetModelContent extends KDocumentContent {
          *   }
          * }
          */
-        metadataMappings: JSONObject;
+        metadataMappings: MetadataMappings;
         /**
          * Default values for metadata.
          *
@@ -37,6 +70,43 @@ export interface AssetModelContent extends KDocumentContent {
          * }
          */
         defaultMetadata: JSONObject;
+        /**
+         * Metadata details
+         * @example
+         * {
+         *   "extTemp": {
+         *     "group": "buildingEnv",
+         *     "locales": {
+         *     "en": {
+         *        "friendlyName": "External temperature",
+         *        "description": "Building external temperature"
+         *     },
+         *     "fr": {
+         *       "friendlyName": "Température extérieure",
+         *       "description": "Température à l'exterieur du bâtiment"
+         *     },
+         *   }
+         */
+        metadataDetails?: MetadataDetails;
+        /**
+         * Metadata groups list
+         * @example
+         * {
+         *   "buildingEnv": {
+         *     "locales": {
+         *       "en": {
+         *         "groupFriendlyName": "Building environment",
+         *         "description": "The building environment"
+         *       },
+         *       "fr": {
+         *         "groupFriendlyName": "Environnement du bâtiment",
+         *         "description": "L'environnement du bâtiment"
+         *       }
+         *     }
+         *   }
+         * }
+         */
+        metadataGroups?: MetadataGroups;
         /**
          * List of accepted measures for this model
          *
@@ -70,7 +140,7 @@ export interface DeviceModelContent extends KDocumentContent {
          *   }
          * }
          */
-        metadataMappings: JSONObject;
+        metadataMappings: MetadataMappings;
         /**
          * Default values for metadata.
          *
@@ -80,6 +150,43 @@ export interface DeviceModelContent extends KDocumentContent {
          * }
          */
         defaultMetadata: JSONObject;
+        /**
+         * Metadata details
+         * @example
+         * {
+         *   "sensorVersion": {
+         *     "group": "sensorSpecs",
+         *     "locales": {
+         *     "en": {
+         *        "friendlyName": "Sensor version",
+         *        "description": "Firmware version of the sensor"
+         *     },
+         *     "fr": {
+         *       "friendlyName": "Version du capteur",
+         *       "description": "Version du micrologiciel du capteur"
+         *     },
+         *   }
+         */
+        metadataDetails?: MetadataDetails;
+        /**
+         * Metadata groups list
+         * @example
+         * {
+         *   "sensorSpecs": {
+         *     "locales": {
+         *       "en": {
+         *         "groupFriendlyName": "Sensor specifications",
+         *         "description" : "All sensors specifications"
+         *       },
+         *       "fr": {
+         *         "groupFriendlyName": "Spécifications techniques",
+         *         "description": "Toutes les spécifications techniques"
+         *       }
+         *     }
+         *   }
+         * }
+         */
+        metadataGroups?: MetadataGroups;
         /**
          * List of decoded measures for this model
          *
@@ -95,3 +202,4 @@ export interface DeviceModelContent extends KDocumentContent {
     };
 }
 export type ModelContent = MeasureModelContent | AssetModelContent | DeviceModelContent;
+export {};

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

@@ -1,5 +1,6 @@
 import { JSONObject } from "kuzzle-sdk";
 import { Decoder, NamedMeasures } from "../../../modules/decoder";
+import { MetadataDetails, MetadataGroups, MetadataMappings } from "./ModelContent";
 /**
  * Define an asset model
  *
@@ -16,6 +17,35 @@ import { Decoder, NamedMeasures } from "../../../modules/decoder";
  *     },
  *     defaultMetadata: {
  *       height: 20
+ *     },
+ *     metadataDetails: {
+ *       "extTemp": {
+ *         "group": "buildingEnv",
+ *         "locales": {
+ *           "en": {
+ *             "friendlyName": "External temperature",
+ *             "description": "Container external temperature"
+ *           },
+ *           "fr": {
+ *             "friendlyName": "Température externe",
+ *             "description": "Température externe du conteneur"
+ *           }
+ *         }
+ *       }
+ *     },
+ *     metadataGroups: {
+ *       buildingEnv: {
+ *         locales: {
+ *          en: {
+ *            groupFriendlyName: "Building environment",
+ *            description: "The building environment"
+ *          },
+ *          fr: {
+ *            groupFriendlyName: "Environnement du bâtiment",
+ *            description: "L'environnement du bâtiment"
+ *          }
+ *         }
+ *       }
  *     }
  *   }
  *
@@ -28,11 +58,19 @@ export type AssetModelDefinition = {
     /**
      * Metadata mappings definition
      */
-    metadataMappings?: JSONObject;
+    metadataMappings?: MetadataMappings;
     /**
      * Default metadata values
      */
     defaultMetadata?: JSONObject;
+    /**
+     * Metadata details including tanslations and group.
+     */
+    metadataDetails?: MetadataDetails;
+    /**
+     * Metadata groups
+     */
+    metadataGroups?: MetadataGroups;
 };
 /**
  * Define a device model
@@ -42,9 +80,40 @@ export type AssetModelDefinition = {
  *     decoder: new DummyTempPositionDecoder(),
  *     metadataMappings: {
  *       serial: { type: "keyword" },
- *     }
- *   }
- *
+ *     },
+ *     defaultMetadata: {
+ *       company: "Firebird"
+ *     },
+ *     metadataDetails: {
+ *       sensorType: {
+ *         group: "sensorSpecs",
+ *         locales: {
+ *           en: {
+ *             friendlyName: "Sensor type",
+ *             description: "Type of the sensor"
+ *           },
+ *           fr: {
+ *             friendlyName: "Type de traceur",
+ *             description: "Type du traceur"
+ *           }
+ *         }
+ *       }
+ *     },
+ *     metadataGroups: {
+ *      sensorSpecs: {
+ *        locales: {
+ *          en: {
+ *            groupFriendlyName: "Sensor specifications",
+ *            description : "All sensors specifications"
+ *          },
+ *          fr: {
+ *            groupFriendlyName: "Spécifications techniques",
+ *            description: "Toutes les spécifications techniques"
+ *          }
+ *        }
+ *      }
+ *    }
+ *  }
  */
 export type DeviceModelDefinition = {
     /**
@@ -54,9 +123,17 @@ export type DeviceModelDefinition = {
     /**
      * Metadata mappings definition
      */
-    metadataMappings?: JSONObject;
+    metadataMappings?: MetadataMappings;
     /**
      * Default metadata values
      */
     defaultMetadata?: JSONObject;
+    /**
+     * Metadata details including tanslations and group.
+     */
+    metadataDetails?: MetadataDetails;
+    /**
+     * Metadata groups list and details.
+     */
+    metadataGroups?: MetadataGroups;
 };

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

@@ -22,10 +22,13 @@ export declare class DeviceManagerPlugin extends Plugin {
          * Register an asset model
          *
          * @param engineGroup Engine group name
-         * @param model Name of the asset model
-         * @param definition.measures Array describing measures names and types
-         * @param definition.metadataMappings Metadata mappings definition
-         * @param definition.defaultMetadata Default metadata values
+         * @param model Name of the asset model. Must follow a naming convention in PascalCase.
+         * @param definition Object containing the asset model definition, including:
+         *        - measures: Array describing measure names and their types.
+         *        - metadataMappings: Definition of metadata mappings, specifying types for each metadata field.
+         *        - defaultMetadata: Default values for metadata fields, applied when actual data is not provided.
+         *        - metadataDetails: Optional detailed descriptions for each metadata, including group association and localizations.
+         *        - metadataGroups: Optional description of metadata groups, organizing metadata logically, with localizations for group names.
          *
          * @example
          * ```
@@ -44,6 +47,33 @@ export declare class DeviceManagerPlugin extends Plugin {
          *     },
          *     defaultMetadata: {
          *       height: 20
+         *     },
+         *     metadataDetails: {
+         *       "extTemp": {
+         *         "group": "environment",
+         *         "locales": {
+         *           "en": {
+         *             "friendlyName": "External Temperature",
+         *             "description": "The temperature outside the container"
+         *           },
+         *           "fr": {
+         *             "friendlyName": "Température Externe",
+         *             "description": "La température à l'extérieur du conteneur"
+         *           }
+         *         }
+         *       }
+         *     },
+         *     metadataGroups: {
+         *       "environment": {
+         *         "locales": {
+         *           "en": {
+         *             "groupFriendlyName": "Environment"
+         *           },
+         *           "fr": {
+         *             "groupFriendlyName": "Environnement"
+         *           }
+         *         }
+         *       }
          *     }
          *   }
          * );
@@ -51,12 +81,15 @@ export declare class DeviceManagerPlugin extends Plugin {
          */
         registerAsset: (engineGroup: string, model: string, definition: AssetModelDefinition) => void;
         /**
-         * Register a device model
+         * Register a device.
          *
          * @param model Name of the device model
-         * @param definition.decoded Decoder used to decode payloads
-         * @param definition.metadataMappings Metadata mappings definition
-         * @param definition.defaultMetadata Default metadata values
+         * @param definition Object containing the device model definition, including:
+         *                   - decoder: Decoder used to decode payloads
+         *                   - metadataMappings: Metadata mappings definition
+         *                   - defaultMetadata: Default metadata values
+         *                   - metadataDetails: Detailed metadata descriptions and localizations
+         *                   - metadataGroups: Groups for organizing metadata, with localizations
          *
          * @example
          * ```
@@ -66,6 +99,36 @@ export declare class DeviceManagerPlugin extends Plugin {
          *     decoder: new DummyTempPositionDecoder(),
          *     metadataMappings: {
          *       serial: { type: "keyword" },
+         *     },
+         *     defaultMetadata: {
+         *       company: "Acme Inc"
+         *     },
+         *     metadataDetails: {
+         *       sensorVersion: {
+         *         group: "sensorSpecs",
+         *         locales: {
+         *           en: {
+         *             friendlyName: "Sensor version",
+         *             description: "Firmware version of the sensor"
+         *           },
+         *           fr: {
+         *             friendlyName: "Version du capteur",
+         *             description: "Version du micrologiciel du capteur"
+         *           }
+         *         }
+         *       }
+         *     },
+         *     metadataGroups: {
+         *       sensorSpecs: {
+         *         locales: {
+         *           en: {
+         *             groupFriendlyName: "Sensors specifications"
+         *           },
+         *           fr: {
+         *             groupFriendlyName: "Spécifications des capteurs"
+         *           }
+         *         }
+         *       }
          *     }
          *   }
          * );

package/package.json

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