feat: add tooltip model by asset model

doc/2/controllers/models/write-asset/index.md

@@ -52,20 +52,49 @@ Method: POST
           };
       */
     },
-    "metadataGroups"; {
-    /*
-      Metadata groups list and details.
-        {
-          [groupName: string]: {
-            locales: {
-              [locale: string]: {
-                groupFriendlyName: string;
-                description: string;
+    "metadataGroups": {
+      /*
+        Metadata groups list and details.
+          {
+            [groupName: string]: {
+              locales: {
+                [locale: string]: {
+                  groupFriendlyName: string;
+                  description: string;
+                };
               };
             };
           };
-        };
-    */
+      */
+    },
+    "tooltipModels": {
+      /*
+        Tooltip models for an asset model.
+          [key: string]: {
+            tooltipLabel: string;
+            content: [
+              {
+                category: "metadata";
+                label?: string;
+                metadataPath: string;
+                unit?: string;
+              },
+              {
+                category: "measure";
+                label?: string;
+                measureSlot: string;
+                measureValuePath: string;
+                unit?: string;
+              },
+              {
+                category: "standard";
+                label?: string;
+                type: "link" | "image" | "text" | "title";
+                value: string;
+              }
+            ];
+          };
+      */
     },
     "measures": [
       // Array of measure definition with type and name
@@ -84,6 +113,7 @@ Method: POST
 - `defaultValues`: Default values for the metadata
 - `metadataDetails`: Metadata group and translations
 - `metadataGroups`: Groups list with translations for group name 
+- `tooltipModels`: Tooltip model list, containing each labels and tooltip content to display
 - `measures`: Array of measure definition. Each item define a `type` and `name` properties for the measure.
 
 ---

lib/modules/model/ModelService.ts

@@ -1,4 +1,9 @@
-import { BadRequestError, Inflector, NotFoundError } from "kuzzle";
+import {
+  BadRequestError,
+  Inflector,
+  KuzzleRequest,
+  NotFoundError,
+} from "kuzzle";
 import { ask, onAsk } from "kuzzle-plugin-commons";
 import { JSONObject, KDocument } from "kuzzle-sdk";
 
@@ -18,6 +23,7 @@ import {
   MetadataDetails,
   MetadataGroups,
   MetadataMappings,
+  TooltipModels,
 } from "./types/ModelContent";
 import {
   AskModelAssetGet,
@@ -67,6 +73,7 @@ export class ModelService extends BaseService {
     metadataDetails: MetadataDetails,
     metadataGroups: MetadataGroups,
     measures: AssetModelContent["asset"]["measures"],
+    tooltipModels: TooltipModels,
   ): Promise<KDocument<AssetModelContent>> {
     if (Inflector.pascalCase(model) !== model) {
       throw new BadRequestError(`Asset model "${model}" must be PascalCase.`);
@@ -80,6 +87,7 @@ export class ModelService extends BaseService {
         metadataGroups,
         metadataMappings,
         model,
+        tooltipModels,
       },
       engineGroup,
       type: "asset",
@@ -377,4 +385,66 @@ export class ModelService extends BaseService {
 
     return result.hits[0];
   }
+
+  /**
+   * Update an asset model
+   */
+  async updateAsset(
+    _id: string,
+    engineGroup: string,
+    model: string,
+    metadataMappings: MetadataMappings,
+    defaultMetadata: JSONObject,
+    metadataDetails: MetadataDetails,
+    metadataGroups: MetadataGroups,
+    measures: AssetModelContent["asset"]["measures"],
+    tooltipModels: TooltipModels,
+    request: KuzzleRequest,
+  ): Promise<KDocument<AssetModelContent>> {
+    if (Inflector.pascalCase(model) !== model) {
+      throw new BadRequestError(`Asset model "${model}" must be PascalCase.`);
+    }
+
+    this.checkDefaultValues(metadataMappings, defaultMetadata);
+
+    // The field must be deleted if an element of the table is to be deleted
+    await this.sdk.document.deleteFields(
+      this.config.adminIndex,
+      InternalCollection.MODELS,
+      _id,
+      ["asset.tooltipModels"],
+      { source: true },
+    );
+
+    const existingAsset = await this.getAsset(engineGroup, model);
+    const measuresUpdated =
+      measures.length === 0 ? existingAsset._source.asset.measures : measures;
+
+    const assetModel = {
+      _id,
+      _source: {
+        asset: {
+          defaultMetadata,
+          measures: measuresUpdated,
+          metadataDetails,
+          metadataGroups,
+          metadataMappings,
+          model,
+          tooltipModels,
+        },
+      },
+    };
+
+    const endDocument = await this.updateDocument<AssetModelContent>(
+      request,
+      assetModel,
+      {
+        collection: InternalCollection.MODELS,
+        engineId: this.config.adminIndex,
+      },
+      { source: true },
+    );
+
+    return endDocument;
+  }
 }

lib/modules/model/ModelsController.ts

@@ -5,6 +5,7 @@ import {
   ApiModelWriteAssetResult,
   ApiModelWriteDeviceResult,
   ApiModelWriteMeasureResult,
+  ApiModelUpdateAssetResult,
   ApiModelDeleteAssetResult,
   ApiModelDeleteDeviceResult,
   ApiModelDeleteMeasureResult,
@@ -64,6 +65,10 @@ export class ModelsController {
           handler: this.listMeasures.bind(this),
           http: [{ path: "device-manager/models/measures", verb: "get" }],
         },
+        updateAsset: {
+          handler: this.updateAsset.bind(this),
+          http: [{ path: "device-manager/models/assets", verb: "put" }],
+        },
         writeAsset: {
           handler: this.writeAsset.bind(this),
           http: [{ path: "device-manager/models/assets", verb: "post" }],
@@ -113,6 +118,7 @@ export class ModelsController {
     const measures = request.getBodyArray("measures", []);
     const metadataDetails = request.getBodyObject("metadataDetails", {});
     const metadataGroups = request.getBodyObject("metadataGroups", {});
+    const tooltipModels = request.getBodyObject("tooltipModels", {});
 
     const assetModel = await this.modelService.writeAsset(
       engineGroup,
@@ -122,6 +128,7 @@ export class ModelsController {
       metadataDetails,
       metadataGroups,
       measures,
+      tooltipModels,
     );
 
     return assetModel;
@@ -215,4 +222,33 @@ export class ModelsController {
       total: models.length,
     };
   }
+
+  async updateAsset(
+    request: KuzzleRequest,
+  ): Promise<ApiModelUpdateAssetResult> {
+    const _id = request.getId();
+    const engineGroup = request.getString("engineGroup");
+    const model = request.getString("model");
+    const metadataMappings = request.getBodyObject("metadataMappings", {});
+    const defaultValues = request.getBodyObject("defaultValues", {});
+    const measures = request.getBodyArray("measures", []);
+    const metadataDetails = request.getBodyObject("metadataDetails", {});
+    const metadataGroups = request.getBodyObject("metadataGroups", {});
+    const tooltipModels = request.getBodyObject("tooltipModels", {});
+
+    const updatedAssetModel = await this.modelService.updateAsset(
+      _id,
+      engineGroup,
+      model,
+      metadataMappings,
+      defaultValues,
+      metadataDetails,
+      metadataGroups,
+      measures,
+      tooltipModels,
+      request,
+    );
+
+    return updatedAssetModel;
+  }
 }

lib/modules/model/ModelsRegister.ts

@@ -16,6 +16,7 @@ import {
   MetadataGroups,
   MetadataMappings,
   ModelContent,
+  TooltipModels,
 } from "./types/ModelContent";
 import { ModelSerializer } from "./ModelSerializer";
 import { JSONObject } from "kuzzle-sdk";
@@ -59,6 +60,7 @@ export class ModelsRegister {
    * @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.
+   * @param tooltipModels - Optional model list for tooltip, containing labels and tooltip content.
    * @throws PluginImplementationError if the model name is not in PascalCase.
    */
   registerAsset(
@@ -69,6 +71,7 @@ export class ModelsRegister {
     defaultMetadata: JSONObject = {},
     metadataDetails: MetadataDetails = {},
     metadataGroups: MetadataGroups = {},
+    tooltipModels: TooltipModels = {},
   ) {
     if (Inflector.pascalCase(model) !== model) {
       throw new PluginImplementationError(
@@ -85,6 +88,7 @@ export class ModelsRegister {
         metadataGroups,
         metadataMappings,
         model,
+        tooltipModels,
       },
       engineGroup,
       type: "asset",

lib/modules/model/collections/modelsMappings.ts

@@ -52,6 +52,10 @@ export const modelsMappings: CollectionMappings = {
             name: { type: "keyword" },
           },
         },
+        tooltipModels: {
+          dynamic: "false",
+          properties: {},
+        },
       },
     },
 

lib/modules/model/types/ModelApi.ts

@@ -7,6 +7,7 @@ import {
   MetadataDetails,
   MetadataGroups,
   MetadataMappings,
+  TooltipModels,
 } from "./ModelContent";
 
 interface ModelsControllerRequest {
@@ -43,6 +44,7 @@ export interface ApiModelWriteAssetRequest extends ModelsControllerRequest {
     metadataMappings?: MetadataMappings;
     defaultValues?: JSONObject;
     measures?: AssetModelContent["asset"]["measures"];
+    tooltipModels?: TooltipModels;
   };
 }
 export type ApiModelWriteAssetResult = KDocument<AssetModelContent>;
@@ -71,6 +73,24 @@ export interface ApiModelWriteMeasureRequest extends ModelsControllerRequest {
 }
 export type ApiModelWriteMeasureResult = KDocument<MeasureModelContent>;
 
+export interface ApiModelUpdateAssetRequest extends ModelsControllerRequest {
+  action: "updateAsset";
+
+  _id: string;
+  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";