kuzzle-device-manager-types 2.4.0-beta.8 → 2.4.0-dev.1

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

@@ -1,5 +1,6 @@
-import { JSONObject, KDocument } from "kuzzle-sdk";
-import { AssetModelContent, DeviceModelContent, MeasureModelContent } from "./ModelContent";
+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 {
     controller: "device-manager/models";
 }
@@ -24,9 +25,12 @@ export interface ApiModelWriteAssetRequest extends ModelsControllerRequest {
     body: {
         engineGroup: string;
         model: string;
-        metadataMappings?: JSONObject;
+        metadataDetails?: MetadataDetails;
+        metadataGroups?: MetadataGroups;
+        metadataMappings?: MetadataMappings;
         defaultValues?: JSONObject;
         measures?: AssetModelContent["asset"]["measures"];
+        tooltipModels?: TooltipModels;
     };
 }
 export type ApiModelWriteAssetResult = KDocument<AssetModelContent>;
@@ -34,7 +38,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"];
     };
@@ -45,9 +51,24 @@ export interface ApiModelWriteMeasureRequest extends ModelsControllerRequest {
     body: {
         type: string;
         valuesMappings: JSONObject;
+        valuesDetails?: MeasureValuesDetails;
     };
 }
 export type ApiModelWriteMeasureResult = KDocument<MeasureModelContent>;
+export interface ApiModelUpdateAssetRequest extends ModelsControllerRequest {
+    action: "updateAsset";
+    engineGroup: string;
+    model: string;
+    body: {
+        metadataDetails?: MetadataDetails;
+        metadataGroups?: MetadataGroups;
+        metadataMappings?: MetadataMappings;
+        defaultValues?: JSONObject;
+        measures?: AssetModelContent["asset"]["measures"];
+        tooltipModels?: TooltipModels;
+    };
+}
+export type ApiModelUpdateAssetResult = KDocument<AssetModelContent>;
 export interface ApiModelDeleteAssetRequest extends ModelsControllerRequest {
     action: "deleteAsset";
     _id: string;
@@ -85,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,6 +7,129 @@ export interface MeasureModelContent extends KDocumentContent {
         type: string;
     };
 }
+export interface MetadataProperty {
+    type: string;
+    strategy?: string;
+    format?: string;
+}
+export interface MetadataObject {
+    properties: {
+        [key: string]: MetadataProperty | MetadataObject;
+    };
+}
+export interface MetadataMappings {
+    [key: string]: MetadataProperty | MetadataObject;
+}
+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;
+    };
+}
+export interface MetadataGroupLocale {
+    groupFriendlyName: string;
+    description: string;
+}
+export interface MetadataGroups {
+    [groupName: string]: {
+        locales: {
+            [locale: string]: MetadataGroupLocale;
+        };
+    };
+}
+export interface MetadataTooltipContent {
+    category: "metadata";
+    label?: {
+        locales: {
+            [locale: string]: LocaleDetails;
+        };
+    };
+    metadataPath: string;
+    suffix?: string;
+}
+export interface MeasureTooltipContent {
+    category: "measure";
+    label?: {
+        locales: {
+            [locale: string]: LocaleDetails;
+        };
+    };
+    measureSlot: string;
+    measureValuePath: string;
+    suffix?: string;
+}
+export interface StaticTooltipContent {
+    category: "static";
+    label?: {
+        locales: {
+            [locale: string]: LocaleDetails;
+        };
+    };
+    type: StaticTooltipContentType;
+    value: string;
+}
+export declare enum StaticTooltipContentType {
+    link = "link",
+    image = "image",
+    text = "text",
+    title = "title",
+    separator = "separator"
+}
+export interface TooltipModels {
+    [key: string]: {
+        tooltipLabel: string;
+        content: (MetadataTooltipContent | MeasureTooltipContent | StaticTooltipContent)[];
+    };
+}
 export interface AssetModelContent extends KDocumentContent {
     type: "asset";
     engineGroup: string;
@@ -27,7 +150,7 @@ export interface AssetModelContent extends KDocumentContent {
          *   }
          * }
          */
-        metadataMappings: JSONObject;
+        metadataMappings: MetadataMappings;
         /**
          * Default values for metadata.
          *
@@ -37,6 +160,51 @@ 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"
+         *       },
+         *     },
+         *     "editorHint": {
+         *       "readOnly": true,
+         *       "type": EditorHintEnum.OPTION_SELECTOR,
+         *       "values": ["red", "blue"],
+         *       "customValueAllowed": true,
+         *     },
+         *   },
+         * }
+         */
+        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
          *
@@ -49,6 +217,53 @@ export interface AssetModelContent extends KDocumentContent {
          * ]
          */
         measures: NamedMeasures;
+        /**
+         * List of tooltip models for this asset model
+         *
+         * @example
+         * [
+         *   "defaultTooltipKey": {
+         *     "tooltipLabel": "Default tooltip model",
+         *     "content": [
+         *       {
+         *         "metadataPath": "geolocation",
+         *         "label": {
+         *           "locales": {
+         *             "en": {
+         *               "description": "",
+         *               "friendlyName": "Container position"
+         *             },
+         *             "fr": {
+         *               "description": "",
+         *               "friendlyName": "Position du conteneur"
+         *             }
+         *           }
+         *         },
+         *         "category": "metadata"
+         *       },
+         *       {
+         *         "measureValuePath": "externalTemperature",
+         *         "measureSlot": "externalTemperature",
+         *         "label": {
+         *           "locales": {
+         *             "en": {
+         *               "description": "",
+         *               "friendlyName": "External temperature"
+         *             },
+         *             "fr": {
+         *               "description": "",
+         *               "friendlyName": "Température extérieure"
+         *             }
+         *           }
+         *         },
+         *         "category": "measure",
+         *         "suffix": "°C"
+         *       }
+         *     ]
+         *   }
+         * ]
+         */
+        tooltipModels?: TooltipModels;
     };
 }
 export interface DeviceModelContent extends KDocumentContent {
@@ -70,7 +285,7 @@ export interface DeviceModelContent extends KDocumentContent {
          *   }
          * }
          */
-        metadataMappings: JSONObject;
+        metadataMappings: MetadataMappings;
         /**
          * Default values for metadata.
          *
@@ -80,6 +295,52 @@ 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"
+         *       },
+         *     },
+         *     "editorHint": {
+         *       "readOnly": false,
+         *       "type": EditorHintEnum.DATETIME,
+         *       "date": true,
+         *       "time": true,
+         *       "customTimeZoneAllowed": true,
+         *     },
+         *   },
+         * }
+         */
+        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
          *

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, TooltipModels } from "./ModelContent";
 /**
  * Define an asset model
  *
@@ -16,6 +17,83 @@ 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"
+ *           }
+ *         },
+ *         "definition": {
+ *           "readOnly": false,
+ *           "type": MetadataDetailsEnum.DATETIME,
+ *           "date": true,
+ *           "time": true,
+ *           "customTimeZoneAllowed": true,
+ *        },
+ *       },
+ *     },
+ *     metadataGroups: {
+ *       buildingEnv: {
+ *         locales: {
+ *           en: {
+ *             groupFriendlyName: "Building environment",
+ *             description: "The building environment"
+ *           },
+ *           fr: {
+ *             groupFriendlyName: "Environnement du bâtiment",
+ *             description: "L'environnement du bâtiment"
+ *           }
+ *         }
+ *       }
+ *     },
+ *     tooltipModels: {
+ *       "defaultTooltipKey": {
+ *         "tooltipLabel": "Default Tooltip Model",
+ *         "content": [
+ *           {
+ *             "category": "metadata",
+ *             "label": {
+ *               "locales": {
+ *                 "en": {
+ *                   "friendlyName": "Container position",
+ *                   "description": ""
+ *                 },
+ *                 "fr": {
+ *                   "friendlyName": "Position du conteneur",
+ *                   "description": ""
+ *                 }
+ *               }
+ *             },
+ *             "metadataPath": "geolocation"
+ *           },
+ *           {
+ *             "category": "measure",
+ *             "label": {
+ *               "locales": {
+ *                 "en": {
+ *                   "friendlyName": "External temperature",
+ *                   "description": ""
+ *                 },
+ *                 "fr": {
+ *                   "friendlyName": "Température extérieure",
+ *                   "description": ""
+ *                 }
+ *               }
+ *             },
+ *             "measureSlot": "externalTemperature",
+ *             "measureValuePath": "externalTemperature",
+ *             "suffix": "°C"
+ *           }
+ *         ]
+ *       }
  *     }
  *   }
  *
@@ -28,11 +106,23 @@ 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;
+    /**
+     * Tooltip models
+     */
+    tooltipModels?: TooltipModels;
 };
 /**
  * Define a device model
@@ -42,9 +132,47 @@ 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"
+ *           }
+ *         },
+ *         definition: {
+ *           readOnly: false,
+ *           type: MetadataDetailsEnum.DATETIME,
+ *           date: true,
+ *           time: true,
+ *           customTimeZoneAllowed: true,
+ *        },
+ *       },
+ *     },
+ *     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 +182,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;
 };