kuzzle-device-manager-types 2.4.0-elasticsearch-8.1 → 2.4.1-dev.1

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

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

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

@@ -1,7 +1,7 @@
 import { ControllerDefinition, KuzzleRequest } from "kuzzle";
 import { DeviceManagerPlugin } from "../plugin";
 import { AssetService } from "./AssetService";
-import { ApiAssetCreateResult, ApiAssetUpsertResult, ApiAssetDeleteResult, ApiAssetGetMeasuresResult, ApiAssetGetResult, ApiAssetSearchResult, ApiAssetUpdateResult, ApiAssetMigrateTenantResult, ApiAssetMetadataReplaceResult } from "./types/AssetApi";
+import { ApiAssetCreateResult, ApiAssetUpsertResult, ApiAssetDeleteResult, ApiAssetGetMeasuresResult, ApiAssetGetResult, ApiAssetSearchResult, ApiAssetUpdateResult, ApiAssetMigrateTenantResult, ApiAssetMetadataReplaceResult, ApiAssetGetLastMeasuresResult, ApiAssetMGetLastMeasuredAtResult, ApiAssetMGetLastMeasuresResult, ApiAssetGetLastMeasuredAtResult } from "./types/AssetApi";
 export declare class AssetsController {
     private plugin;
     private assetService;
@@ -17,7 +17,11 @@ export declare class AssetsController {
     delete(request: KuzzleRequest): Promise<ApiAssetDeleteResult>;
     search(request: KuzzleRequest): Promise<ApiAssetSearchResult>;
     getMeasures(request: KuzzleRequest): Promise<ApiAssetGetMeasuresResult>;
+    getLastMeasures(request: KuzzleRequest): Promise<ApiAssetGetLastMeasuresResult>;
+    mGetLastMeasures(request: KuzzleRequest): Promise<ApiAssetMGetLastMeasuresResult>;
     exportMeasures(request: KuzzleRequest): Promise<any>;
     export(request: KuzzleRequest): Promise<any>;
     migrateTenant(request: KuzzleRequest): Promise<ApiAssetMigrateTenantResult>;
+    getLastMeasuredAt(request: KuzzleRequest): Promise<ApiAssetGetLastMeasuredAtResult>;
+    mGetLastMeasuredAt(request: KuzzleRequest): Promise<ApiAssetMGetLastMeasuredAtResult>;
 }

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

@@ -9,8 +9,12 @@ import { KuzzleRole } from "../../shared/types/KuzzleRole";
       actions: {
         get: true,
         getMeasures: true,
+        getLastMeasures: true,
+        mGetLastMeasures: true,
         exportMeasures: true,
         search: true,
+        getLastMeasuredAt: true,
+        mGetLastMeasuredAt: true,
       },
     },
     "device-manager/models": {

package/dist/lib/modules/asset/roles/specificRoles/RoleAssetsConfiguration.d.ts

@@ -0,0 +1,8 @@
+import { KuzzleRole } from "../../../shared/types/KuzzleRole";
+/**
+ * This role allows to configurate an asset metadata.
+ *
+ * It's a tenant role.
+ *
+ */
+export declare const RoleAssetsConfiguration: KuzzleRole;

package/dist/lib/modules/asset/roles/specificRoles/RoleAssetsCreation.d.ts

@@ -0,0 +1,8 @@
+import { KuzzleRole } from "../../../shared/types/KuzzleRole";
+/**
+ * This role allows to create, update and delete an asset.
+ *
+ * It's a tenant role.
+ *
+ */
+export declare const RoleAssetsCreation: KuzzleRole;

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

@@ -0,0 +1,2 @@
+export * from "./RoleAssetsConfiguration";
+export * from "./RoleAssetsCreation";

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

@@ -1,9 +1,10 @@
 import { JSONObject, KDocument, KHit, SearchResult } from "kuzzle-sdk";
 import { MeasureContent } from "../../../modules/measure";
-import { Metadata } from "../../shared";
+import { ApiDigitalTwinGetLastMeasuredAtRequest, ApiDigitalTwinGetLastMeasuredAtResult, ApiDigitalTwinGetLastMeasuresRequest, ApiDigitalTwinGetLastMeasuresResult, ApiDigitalTwinMGetLastMeasuredAtRequest, ApiDigitalTwinMGetLastMeasuredAtResult, ApiDigitalTwinMGetLastMeasuresRequest, ApiDigitalTwinMGetLastMeasuresResult, Metadata } from "../../shared";
 import { AssetContent } from "./AssetContent";
+type AssetsControllerName = "device-manager/assets";
 interface AssetsControllerRequest {
-    controller: "device-manager/assets";
+    controller: AssetsControllerName;
     engineId: string;
 }
 export interface ApiAssetGetRequest extends AssetsControllerRequest {
@@ -84,6 +85,10 @@ export type ApiAssetGetMeasuresResult = {
     measures: Array<KDocument<MeasureContent<JSONObject>>>;
     total: number;
 };
+export type ApiAssetGetLastMeasuresRequest = ApiDigitalTwinGetLastMeasuresRequest<AssetsControllerName>;
+export type ApiAssetGetLastMeasuresResult = ApiDigitalTwinGetLastMeasuresResult;
+export type ApiAssetMGetLastMeasuresRequest = ApiDigitalTwinMGetLastMeasuresRequest<AssetsControllerName>;
+export type ApiAssetMGetLastMeasuresResult = ApiDigitalTwinMGetLastMeasuresResult;
 /**
  * This action can be used only with WebSocket or POST
  *
@@ -128,4 +133,8 @@ export type ApiAssetMigrateTenantResult = {
     errors: string[];
     successes: string[];
 };
+export type ApiAssetGetLastMeasuredAtRequest = ApiDigitalTwinGetLastMeasuredAtRequest<AssetsControllerName>;
+export type ApiAssetGetLastMeasuredAtResult = ApiDigitalTwinGetLastMeasuredAtResult;
+export type ApiAssetMGetLastMeasuredAtRequest = ApiDigitalTwinMGetLastMeasuredAtRequest<AssetsControllerName>;
+export type ApiAssetMGetLastMeasuredAtResult = ApiDigitalTwinMGetLastMeasuredAtResult;
 export {};

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

@@ -2,11 +2,11 @@ import { KuzzleRequest } from "kuzzle";
 import { JSONObject, KDocument, KHit, SearchResult } from "kuzzle-sdk";
 import { DecodedMeasurement } from "../measure";
 import { DeviceManagerPlugin } from "../plugin";
-import { BaseService, Metadata, SearchParams } from "../shared";
+import { DigitalTwinService, Metadata, SearchParams } from "../shared";
 import { AssetContent } from "./../asset";
 import { ApiDeviceLinkAssetRequest } from "./types/DeviceApi";
 import { DeviceContent } from "./types/DeviceContent";
-export declare class DeviceService extends BaseService {
+export declare class DeviceService extends DigitalTwinService {
     constructor(plugin: DeviceManagerPlugin);
     registerAskEvents(): void;
     /**
@@ -19,6 +19,10 @@ export declare class DeviceService extends BaseService {
     create(model: string, reference: string, metadata: JSONObject, request: KuzzleRequest): Promise<KDocument<DeviceContent>>;
     get(engineId: string, deviceId: string, request: KuzzleRequest): Promise<KDocument<DeviceContent>>;
     private getInternalDevices;
+    /**
+     * Replace a device metadata
+     */
+    replaceMetadata(engineId: string, deviceId: string, metadata: Metadata, request: KuzzleRequest): Promise<KDocument<DeviceContent>>;
     /**
      * Update or Create an device metadata
      */

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

@@ -1,7 +1,7 @@
 import { ControllerDefinition, KuzzleRequest } from "kuzzle";
 import { DeviceManagerPlugin } from "../plugin";
 import { DeviceService } from "./DeviceService";
-import { ApiDeviceAttachEngineResult, ApiDeviceCreateResult, ApiDeviceDeleteResult, ApiDeviceDetachEngineResult, ApiDeviceGetResult, ApiDeviceLinkAssetResult, ApiDeviceSearchResult, ApiDeviceUnlinkAssetResult, ApiDeviceUpdateResult, ApiDeviceGetMeasuresResult, ApiDeviceUpsertResult } from "./types/DeviceApi";
+import { ApiDeviceAttachEngineResult, ApiDeviceCreateResult, ApiDeviceDeleteResult, ApiDeviceDetachEngineResult, ApiDeviceGetResult, ApiDeviceLinkAssetResult, ApiDeviceSearchResult, ApiDeviceUnlinkAssetResult, ApiDeviceUpdateResult, ApiDeviceGetMeasuresResult, ApiDeviceUpsertResult, ApiDeviceGetLastMeasuresResult, ApiDeviceMGetLastMeasuresResult, ApiDeviceGetLastMeasuredAtResult, ApiDeviceMGetLastMeasuredAtResult, ApiDeviceMetadataReplaceResult } from "./types/DeviceApi";
 export declare class DevicesController {
     private plugin;
     private deviceService;
@@ -11,6 +11,7 @@ export declare class DevicesController {
     constructor(plugin: DeviceManagerPlugin, deviceService: DeviceService);
     get(request: KuzzleRequest): Promise<ApiDeviceGetResult>;
     update(request: KuzzleRequest): Promise<ApiDeviceUpdateResult>;
+    replaceMetadata(request: KuzzleRequest): Promise<ApiDeviceMetadataReplaceResult>;
     delete(request: KuzzleRequest): Promise<ApiDeviceDeleteResult>;
     search(request: KuzzleRequest): Promise<ApiDeviceSearchResult>;
     upsert(request: KuzzleRequest): Promise<ApiDeviceUpsertResult>;
@@ -35,7 +36,11 @@ export declare class DevicesController {
      */
     unlinkAsset(request: KuzzleRequest): Promise<ApiDeviceUnlinkAssetResult>;
     getMeasures(request: KuzzleRequest): Promise<ApiDeviceGetMeasuresResult>;
+    getLastMeasures(request: KuzzleRequest): Promise<ApiDeviceGetLastMeasuresResult>;
+    mGetLastMeasures(request: KuzzleRequest): Promise<ApiDeviceMGetLastMeasuresResult>;
     exportMeasures(request: KuzzleRequest): Promise<any>;
     receiveMeasures(request: KuzzleRequest): Promise<void>;
     export(request: KuzzleRequest): Promise<any>;
+    getLastMeasuredAt(request: KuzzleRequest): Promise<ApiDeviceGetLastMeasuredAtResult>;
+    mGetLastMeasuredAt(request: KuzzleRequest): Promise<ApiDeviceMGetLastMeasuredAtResult>;
 }

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

@@ -10,7 +10,11 @@ import { KuzzleRole } from "../../shared/types/KuzzleRole";
         get: true,
         search: true,
         getMeasures: true,
+        getLastMeasures: true,
+        mGetLastMeasures: true,
         exportMeasures: true,
+        getLastMeasuredAt: true,
+        mGetLastMeasuredAt: true,
       },
     },
     "device-manager/models": {

package/dist/lib/modules/device/roles/specificRoles/RoleDevicesAssetAssociation.d.ts

@@ -0,0 +1,8 @@
+import { KuzzleRole } from "../../../shared/types/KuzzleRole";
+/**
+ * This role allows to associate assets and devices.
+ *
+ * It's a tenant role.
+ *
+ */
+export declare const RoleDevicesAssetAssociation: KuzzleRole;

package/dist/lib/modules/device/roles/specificRoles/RoleDevicesConfiguration.d.ts

@@ -0,0 +1,8 @@
+import { KuzzleRole } from "../../../shared/types/KuzzleRole";
+/**
+ * This role allows to configure a device metadata.
+ *
+ * It's a tenant role.
+ *
+ */
+export declare const RoleDevicesConfiguration: KuzzleRole;

package/dist/lib/modules/device/roles/specificRoles/RoleDevicesCreation.d.ts

@@ -0,0 +1,8 @@
+import { KuzzleRole } from "../../../shared/types/KuzzleRole";
+/**
+ * This role allows to create, update and delete a device.
+ *
+ * It's a tenant role.
+ *
+ */
+export declare const RoleDevicesCreation: KuzzleRole;

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

@@ -0,0 +1,3 @@
+export * from "./RoleDevicesAssetAssociation";
+export * from "./RoleDevicesConfiguration";
+export * from "./RoleDevicesCreation";

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

@@ -1,10 +1,11 @@
 import { JSONObject, KDocument, KHit, SearchResult } from "kuzzle-sdk";
 import { DecodedMeasurement, MeasureContent } from "../../measure";
 import { AssetContent } from "../../asset";
-import { Metadata } from "../../shared";
+import { ApiDigitalTwinGetLastMeasuredAtRequest, ApiDigitalTwinGetLastMeasuredAtResult, ApiDigitalTwinGetLastMeasuresRequest, ApiDigitalTwinGetLastMeasuresResult, ApiDigitalTwinMGetLastMeasuredAtRequest, ApiDigitalTwinMGetLastMeasuredAtResult, ApiDigitalTwinMGetLastMeasuresRequest, ApiDigitalTwinMGetLastMeasuresResult, Metadata } from "../../shared";
 import { DeviceContent } from "./DeviceContent";
+type DevicesControllerName = "device-manager/devices";
 interface DevicesControllerRequest {
-    controller: "device-manager/devices";
+    controller: DevicesControllerName;
     engineId: string;
 }
 export interface ApiDeviceGetRequest extends DevicesControllerRequest {
@@ -21,6 +22,7 @@ export interface ApiDeviceUpdateRequest extends DevicesControllerRequest {
     };
 }
 export type ApiDeviceUpdateResult = KDocument<DeviceContent>;
+export type ApiDeviceMetadataReplaceResult = KDocument<DeviceContent>;
 export interface ApiDeviceUpsertRequest extends DevicesControllerRequest {
     action: "upsert";
     _id: string;
@@ -142,6 +144,10 @@ export type ApiDeviceGetMeasuresResult = {
     measures: Array<KDocument<MeasureContent<JSONObject>>>;
     total: number;
 };
+export type ApiDeviceGetLastMeasuresRequest = ApiDigitalTwinGetLastMeasuresRequest<DevicesControllerName>;
+export type ApiDeviceGetLastMeasuresResult = ApiDigitalTwinGetLastMeasuresResult;
+export type ApiDeviceMGetLastMeasuresRequest = ApiDigitalTwinMGetLastMeasuresRequest<DevicesControllerName>;
+export type ApiDeviceMGetLastMeasuresResult = ApiDigitalTwinMGetLastMeasuresResult;
 /**
  * This action can be used only with WebSocket or POST
  *
@@ -188,4 +194,8 @@ export interface ApiDeviceExportRequest extends DevicesControllerRequest {
 export type ApiDeviceExportResult = {
     link: string;
 };
+export type ApiDeviceGetLastMeasuredAtRequest = ApiDigitalTwinGetLastMeasuredAtRequest<DevicesControllerName>;
+export type ApiDeviceGetLastMeasuredAtResult = ApiDigitalTwinGetLastMeasuredAtResult;
+export type ApiDeviceMGetLastMeasuredAtRequest = ApiDigitalTwinMGetLastMeasuredAtRequest<DevicesControllerName>;
+export type ApiDeviceMGetLastMeasuredAtResult = ApiDigitalTwinMGetLastMeasuredAtResult;
 export {};

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

@@ -1,5 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
 import { KHit, User } from "kuzzle";
 import { UUID } from "node:crypto";
 import { AbstractExporter, Column, ExportParams } from "../shared";

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

@@ -1,7 +1,7 @@
 import { KuzzleRequest } from "kuzzle";
-import { JSONObject, KDocument } from "kuzzle-sdk";
+import { JSONObject, KDocument, KHit, SearchResult } from "kuzzle-sdk";
 import { DeviceManagerPlugin } from "../plugin";
-import { BaseService } from "../shared";
+import { BaseService, SearchParams } from "../shared";
 import { AssetModelContent, DeviceModelContent, MeasureModelContent, MetadataDetails, MetadataGroups, MetadataMappings, TooltipModels } from "./types/ModelContent";
 import { MeasureValuesDetails } from "../measure";
 export declare class ModelService extends BaseService {
@@ -18,6 +18,9 @@ export declare class ModelService extends BaseService {
     listAsset(engineGroup: string): Promise<KDocument<AssetModelContent>[]>;
     listDevices(): Promise<KDocument<DeviceModelContent>[]>;
     listMeasures(): Promise<KDocument<MeasureModelContent>[]>;
+    searchAssets(engineGroup: string, searchParams: Partial<SearchParams>): Promise<SearchResult<KHit<AssetModelContent>>>;
+    searchDevices(searchParams: Partial<SearchParams>): Promise<SearchResult<KHit<DeviceModelContent>>>;
+    searchMeasures(searchParams: Partial<SearchParams>): Promise<SearchResult<KHit<MeasureModelContent>>>;
     assetExists(model: string): Promise<boolean>;
     deviceExists(model: string): Promise<boolean>;
     getAsset(engineGroup: string, model: string): Promise<KDocument<AssetModelContent>>;

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

@@ -1,6 +1,6 @@
 import { ControllerDefinition, KuzzleRequest } from "kuzzle";
 import { ModelService } from "./ModelService";
-import { ApiModelWriteAssetResult, ApiModelWriteDeviceResult, ApiModelWriteMeasureResult, ApiModelUpdateAssetResult, ApiModelDeleteAssetResult, ApiModelDeleteDeviceResult, ApiModelDeleteMeasureResult, ApiModelListAssetsResult, ApiModelListDevicesResult, ApiModelListMeasuresResult, ApiModelGetAssetResult, ApiModelGetDeviceResult, ApiModelGetMeasureResult } from "./types/ModelApi";
+import { ApiModelWriteAssetResult, ApiModelWriteDeviceResult, ApiModelWriteMeasureResult, ApiModelUpdateAssetResult, ApiModelDeleteAssetResult, ApiModelDeleteDeviceResult, ApiModelDeleteMeasureResult, ApiModelListAssetsResult, ApiModelListDevicesResult, ApiModelListMeasuresResult, ApiModelGetAssetResult, ApiModelGetDeviceResult, ApiModelGetMeasureResult, ApiModelSearchAssetsResult, ApiModelSearchDevicesResult, ApiModelSearchMeasuresResult } from "./types/ModelApi";
 export declare class ModelsController {
     private modelService;
     definition: ControllerDefinition;
@@ -17,5 +17,8 @@ export declare class ModelsController {
     listAssets(request: KuzzleRequest): Promise<ApiModelListAssetsResult>;
     listDevices(): Promise<ApiModelListDevicesResult>;
     listMeasures(): Promise<ApiModelListMeasuresResult>;
+    searchAssets(request: KuzzleRequest): Promise<ApiModelSearchAssetsResult>;
+    searchDevices(request: KuzzleRequest): Promise<ApiModelSearchDevicesResult>;
+    searchMeasures(request: KuzzleRequest): Promise<ApiModelSearchMeasuresResult>;
     updateAsset(request: KuzzleRequest): Promise<ApiModelUpdateAssetResult>;
 }

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

@@ -20,7 +20,7 @@ export declare class ModelsRegister {
      * @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 metadataDetails - Optional detailed metadata descriptions, localizations and definition.
      * @param metadataGroups - Optional groups for organizing metadata, with localizations.
      * @param tooltipModels - Optional model list for tooltip, containing labels and tooltip content.
      * @throws PluginImplementationError if the model name is not in PascalCase.
@@ -33,7 +33,7 @@ export declare class ModelsRegister {
      * @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 metadataDetails - Optional detailed metadata descriptions, localizations and definition.
      * @param metadataGroups - Optional groups for organizing metadata, with localizations.
      * @throws PluginImplementationError if the model name is not in PascalCase.
      */

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

@@ -1,4 +1,4 @@
-import { JSONObject, KDocument } from "kuzzle-sdk";
+import { JSONObject, KDocument, KHit, SearchResult } from "kuzzle-sdk";
 import { AssetModelContent, DeviceModelContent, MeasureModelContent, MetadataDetails, MetadataGroups, MetadataMappings, TooltipModels } from "./ModelContent";
 import { MeasureValuesDetails } from "../../measure/types/MeasureDefinition";
 interface ModelsControllerRequest {
@@ -106,4 +106,29 @@ export type ApiModelListMeasuresResult = {
     models: KDocument<MeasureModelContent>[];
     total: number;
 };
+export interface ApiModelSearchAssetsRequest extends ModelsControllerRequest {
+    action: "searchAssets";
+    engineGroup: string;
+    from?: number;
+    size?: number;
+    scrollTTL?: string;
+    body?: JSONObject;
+}
+export type ApiModelSearchAssetsResult = SearchResult<KHit<AssetModelContent>>;
+export interface ApiModelSearchDevicesRequest extends ModelsControllerRequest {
+    action: "searchDevices";
+    from?: number;
+    size?: number;
+    scrollTTL?: string;
+    body?: JSONObject;
+}
+export type ApiModelSearchDevicesResult = SearchResult<KHit<DeviceModelContent>>;
+export interface ApiModelSearchMeasuresRequest extends ModelsControllerRequest {
+    action: "searchMeasures";
+    from?: number;
+    size?: number;
+    scrollTTL?: string;
+    body?: JSONObject;
+}
+export type ApiModelSearchMeasuresResult = SearchResult<KHit<MeasureModelContent>>;
 export {};

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

@@ -7,12 +7,12 @@ export interface MeasureModelContent extends KDocumentContent {
         type: string;
     };
 }
-interface MetadataProperty {
+export interface MetadataProperty {
     type: string;
     strategy?: string;
     format?: string;
 }
-interface MetadataObject {
+export interface MetadataObject {
     properties: {
         [key: string]: MetadataProperty | MetadataObject;
     };
@@ -20,19 +20,62 @@ interface MetadataObject {
 export interface MetadataMappings {
     [key: string]: MetadataProperty | MetadataObject;
 }
-interface LocaleDetails {
+export interface LocaleDetails {
     friendlyName: string;
     description: string;
 }
+export interface BaseEditorHint {
+    readOnly?: boolean;
+    type: EditorHintEnum;
+}
+export declare enum EditorHintEnum {
+    BASE = "base",
+    OPTION_SELECTOR = "optionSelector",
+    DATETIME = "datetime"
+}
+/**
+ * Allows to display a list of values to choose in a dropdown, it has to be defined in the the editorHint property of the asset/device's metadataDetails.
+ */
+export interface OptionsSelectorEditorHint extends BaseEditorHint {
+    type: EditorHintEnum.OPTION_SELECTOR;
+    /**
+     * A list that contains all the values displayed in the dropdown.
+     */
+    values: string[] | number[] | boolean[];
+    /**
+     * Allow the user to add custom values.
+     */
+    customValueAllowed?: boolean;
+}
+/**
+ * Allows to display either a date picker with or without a time picker, or a clock picker, it has to be defined in the editorHint property of the asset/device's metadataDetails.
+ */
+export interface DatetimeEditorHint extends BaseEditorHint {
+    type: EditorHintEnum.DATETIME;
+    /**
+     * If true, displays a date picker, otherwise displays a clock picker.
+     */
+    date: boolean;
+    /**
+     * If `date` is true, setting this to true will add time picking to the date picker.
+     */
+    time?: boolean;
+}
 export interface MetadataDetails {
     [key: string]: {
         group?: string;
         locales: {
             [locale: string]: LocaleDetails;
         };
+        /**
+         * To add new editor hint, create an interface with the properties that extends BaseEditorHint.
+         * Then add a new field in EditorHintEnum to define the type of your hint.
+         * Finally add the new editor hint interface with a pipe to take in account the new type.
+         */
+        editorHint?: BaseEditorHint | OptionsSelectorEditorHint | DatetimeEditorHint;
     };
 }
-interface MetadataGroupLocale {
+export interface MetadataGroupLocale {
     groupFriendlyName: string;
     description: string;
 }
@@ -124,15 +167,23 @@ export interface AssetModelContent extends KDocumentContent {
          *   "extTemp": {
          *     "group": "buildingEnv",
          *     "locales": {
-         *     "en": {
-         *        "friendlyName": "External temperature",
-         *        "description": "Building external temperature"
+         *       "en": {
+         *          "friendlyName": "External temperature",
+         *          "description": "Building external temperature"
+         *       },
+         *       "fr": {
+         *         "friendlyName": "Température extérieure",
+         *         "description": "Température à l'exterieur du bâtiment"
+         *       },
          *     },
-         *     "fr": {
-         *       "friendlyName": "Température extérieure",
-         *       "description": "Température à l'exterieur du bâtiment"
+         *     "editorHint": {
+         *       "readOnly": true,
+         *       "type": EditorHintEnum.OPTION_SELECTOR,
+         *       "values": ["red", "blue"],
+         *       "customValueAllowed": true,
          *     },
-         *   }
+         *   },
+         * }
          */
         metadataDetails?: MetadataDetails;
         /**
@@ -251,15 +302,24 @@ export interface DeviceModelContent extends KDocumentContent {
          *   "sensorVersion": {
          *     "group": "sensorSpecs",
          *     "locales": {
-         *     "en": {
-         *        "friendlyName": "Sensor version",
-         *        "description": "Firmware version of the sensor"
+         *       "en": {
+         *          "friendlyName": "Sensor version",
+         *          "description": "Firmware version of the sensor"
+         *       },
+         *       "fr": {
+         *         "friendlyName": "Version du capteur",
+         *         "description": "Version du micrologiciel du capteur"
+         *       },
          *     },
-         *     "fr": {
-         *       "friendlyName": "Version du capteur",
-         *       "description": "Version du micrologiciel du capteur"
+         *     "editorHint": {
+         *       "readOnly": false,
+         *       "type": EditorHintEnum.DATETIME,
+         *       "date": true,
+         *       "time": true,
+         *       "customTimeZoneAllowed": true,
          *     },
-         *   }
+         *   },
+         * }
          */
         metadataDetails?: MetadataDetails;
         /**
@@ -275,7 +335,7 @@ export interface DeviceModelContent extends KDocumentContent {
          *       "fr": {
          *         "groupFriendlyName": "Spécifications techniques",
          *         "description": "Toutes les spécifications techniques"
-         *       }
+         *       },
          *     }
          *   }
          * }
@@ -296,4 +356,3 @@ export interface DeviceModelContent extends KDocumentContent {
     };
 }
 export type ModelContent = MeasureModelContent | AssetModelContent | DeviceModelContent;
-export {};

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

@@ -30,8 +30,15 @@ import { MetadataDetails, MetadataGroups, MetadataMappings, TooltipModels } from
  *             "friendlyName": "Température externe",
  *             "description": "Température externe du conteneur"
  *           }
- *         }
- *       }
+ *         },
+ *         "definition": {
+ *           "readOnly": false,
+ *           "type": MetadataDetailsEnum.DATETIME,
+ *           "date": true,
+ *           "time": true,
+ *           "customTimeZoneAllowed": true,
+ *        },
+ *       },
  *     },
  *     metadataGroups: {
  *       buildingEnv: {
@@ -141,8 +148,15 @@ export type AssetModelDefinition = {
  *             friendlyName: "Type de traceur",
  *             description: "Type du traceur"
  *           }
- *         }
- *       }
+ *         },
+ *         definition: {
+ *           readOnly: false,
+ *           type: MetadataDetailsEnum.DATETIME,
+ *           date: true,
+ *           time: true,
+ *           customTimeZoneAllowed: true,
+ *        },
+ *       },
  *     },
  *     metadataGroups: {
  *      sensorSpecs: {

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

@@ -27,7 +27,7 @@ export declare class DeviceManagerPlugin extends Plugin {
          *        - 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.
+         *        - metadataDetails: Optional detailed descriptions for each metadata, including localizations, group association and definition.
          *        - metadataGroups: Optional description of metadata groups, organizing metadata logically, with localizations for group names.
          *        - tooltipModels: Optional tooltip model list, containing each labels and tooltip content to display.
          *
@@ -130,7 +130,7 @@ export declare class DeviceManagerPlugin extends Plugin {
          *                   - decoder: Decoder used to decode payloads
          *                   - metadataMappings: Metadata mappings definition
          *                   - defaultMetadata: Default metadata values
-         *                   - metadataDetails: Detailed metadata descriptions and localizations
+         *                   - metadataDetails: Localizations, detailed metadata descriptions and definition
          *                   - metadataGroups: Groups for organizing metadata, with localizations
          *
          * @example

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

@@ -1,3 +1,5 @@
 export * from "./types/DigitalTwinContent";
+export * from "./types/DigitalTwinEvents";
+export * from "./types/DigitalTwinMeasures";
 export * from "./types/Metadata";
 export * from "./types/EmbeddedMeasure";

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

@@ -1,6 +1,9 @@
 export * from "./Module";
 export * from "./services";
+export * from "./types/DigitalTwinApi";
 export * from "./types/DigitalTwinContent";
+export * from "./types/DigitalTwinEvents";
+export * from "./types/DigitalTwinMeasures";
 export * from "./types/EmbeddedMeasure";
 export * from "./types/KuzzleRole";
 export * from "./types/Metadata";

package/dist/lib/modules/shared/services/AbstractExporter.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
 import { UUID } from "node:crypto";
 import { PassThrough, Readable } from "node:stream";
 import { JSONObject, KDocumentContentGeneric, KHit, SearchResult, User } from "kuzzle";

package/dist/lib/modules/shared/services/DigitalTwinExporter.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
 import { UUID } from "node:crypto";
 import { AbstractExporter } from "./AbstractExporter";
 export declare class DigitalTwinExporter extends AbstractExporter {

package/dist/lib/modules/shared/services/DigitalTwinService.d.ts

@@ -0,0 +1,21 @@
+import { MeasureContent } from "../../measure";
+import { DeviceManagerPlugin, InternalCollection } from "../../plugin";
+import { ApiDigitalTwinMGetLastMeasuredAtResult } from "../types/DigitalTwinApi";
+import { BaseService } from "./BaseService";
+export declare class DigitalTwinService extends BaseService {
+    private targetCollection;
+    private readonly digitalTwinType;
+    constructor(plugin: DeviceManagerPlugin, targetCollection: InternalCollection);
+    protected registerAskEvents(): void;
+    /**
+     * Gets the last measures of a digital twin
+     */
+    getLastMeasures(engineId: string, digitalTwinId: string, measureCount?: number): Promise<MeasureContent[]>;
+    /**
+     * Gets the last measures of multiple digital twins
+     */
+    mGetLastMeasures(engineId: string, digitalTwinIds: string[], measureCount?: number): Promise<Record<string, MeasureContent[]>>;
+    getLastMeasuredAt(engineId: string, digitalTwinId: string): Promise<number>;
+    mGetLastMeasuredAt(engineId: string, digitalTwinIds: string[]): Promise<ApiDigitalTwinMGetLastMeasuredAtResult>;
+    private getAggregationQueryParameters;
+}

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

@@ -1,3 +1,4 @@
 export * from "./AbstractExporter";
 export * from "./BaseService";
 export * from "./DigitalTwinExporter";
+export * from "./DigitalTwinService";

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

@@ -0,0 +1,34 @@
+import { DigitalTwinMeasures } from "./DigitalTwinMeasures";
+interface DigitalTwinControllerRequest<ControllerName extends string> {
+    controller: ControllerName;
+    engineId: string;
+}
+export interface ApiDigitalTwinGetLastMeasuresRequest<ControllerName extends string> extends DigitalTwinControllerRequest<ControllerName> {
+    action: "getLastMeasures";
+    _id: string;
+    measureCount?: number;
+}
+export type ApiDigitalTwinGetLastMeasuresResult = DigitalTwinMeasures;
+export interface ApiDigitalTwinMGetLastMeasuresRequest<ControllerName extends string> extends DigitalTwinControllerRequest<ControllerName> {
+    action: "mGetLastMeasures";
+    measureCount?: number;
+    body: {
+        ids: string[];
+    };
+}
+export type ApiDigitalTwinMGetLastMeasuresResult = Record<string, DigitalTwinMeasures>;
+export interface ApiDigitalTwinGetLastMeasuredAtRequest<ControllerName extends string> extends DigitalTwinControllerRequest<ControllerName> {
+    action: "getLastMeasuredAt";
+    _id: string;
+}
+export type ApiDigitalTwinGetLastMeasuredAtResult = {
+    lastMeasuredAt: number;
+};
+export interface ApiDigitalTwinMGetLastMeasuredAtRequest<ControllerName extends string> extends DigitalTwinControllerRequest<ControllerName> {
+    action: "mGetLastMeasuredAt";
+    body: {
+        ids: string[];
+    };
+}
+export type ApiDigitalTwinMGetLastMeasuredAtResult = Record<string, number>;
+export {};

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

@@ -1,12 +1,10 @@
 import { JSONObject, KDocumentContent } from "kuzzle-sdk";
-import { EmbeddedMeasure } from "./EmbeddedMeasure";
 import { Metadata } from "./Metadata";
+import { DigitalTwinMeasures } from "./DigitalTwinMeasures";
 export interface DigitalTwinContent<TMeasures extends JSONObject = JSONObject, TMetadata extends Metadata = Metadata> extends KDocumentContent {
     model: string;
     reference: string;
     metadata: TMetadata;
-    measures: {
-        [Property in keyof TMeasures]: EmbeddedMeasure<TMeasures[Property]> | null;
-    };
+    measures: DigitalTwinMeasures<TMeasures>;
     lastMeasuredAt: number;
 }

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

@@ -0,0 +1,9 @@
+import { MeasureContent } from "../../measure";
+export type AskDigitalTwinLastMeasuresGet = {
+    name: "ask:device-manager:asset:get-last-measures" | "ask:device-manager:device:get-last-measures";
+    payload: {
+        engineId: string;
+        digitalTwinId: string;
+    };
+    result: MeasureContent[];
+};

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

@@ -0,0 +1,5 @@
+import { JSONObject } from "kuzzle-sdk";
+import { EmbeddedMeasure } from "./EmbeddedMeasure";
+export type DigitalTwinMeasures<TMeasures extends JSONObject = JSONObject> = {
+    [Property in keyof TMeasures]: EmbeddedMeasure<TMeasures[Property]> | null;
+};

package/dist/tests/application/assets/Container.d.ts

@@ -6,6 +6,9 @@ export interface ContainerMetadata extends Metadata {
         weight: number;
         capacity: number;
     };
+    person: {
+        company: string;
+    };
 }
 export type ContainerMeasurements = {
     temperatureExt: TemperatureMeasurement;

package/dist/tests/application/assets/Room.d.ts

@@ -0,0 +1,2 @@
+import { AssetModelDefinition } from "../../../index";
+export declare const roomAssetDefinition: AssetModelDefinition;

package/dist/tests/application/assets/StreetLamp.d.ts

@@ -0,0 +1,2 @@
+import { AssetModelDefinition } from "../../../index";
+export declare const streetLampAssetDefinition: AssetModelDefinition;

package/dist/tests/application/measures/BrightnessMeasure.d.ts

@@ -0,0 +1,2 @@
+import { MeasureDefinition } from "lib/modules/measure";
+export declare const brightnessMeasureDefinition: MeasureDefinition;

package/dist/tests/application/measures/CO2Measure.d.ts

@@ -0,0 +1,2 @@
+import { MeasureDefinition } from "lib/modules/measure";
+export declare const co2MeasureDefinition: MeasureDefinition;

package/dist/tests/application/measures/IlluminanceMeasure.d.ts

@@ -0,0 +1,2 @@
+import { MeasureDefinition } from "lib/modules/measure";
+export declare const illuminanceMeasureDefinition: MeasureDefinition;

package/dist/tests/application/measures/PowerConsumptionMeasure.d.ts

@@ -0,0 +1,2 @@
+import { MeasureDefinition } from "lib/modules/measure";
+export declare const powerConsumptionMeasureDefinition: MeasureDefinition;

package/package.json

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