kuzzle-device-manager-types 3.0.0-3-dev.13 → 3.0.0-3-dev.14

package/dist/lib/modules/measure/types/MeasureDefinition.d.ts

@@ -48,6 +48,10 @@ export interface MeasureDefinition {
     locales?: {
         [valueName: string]: LocaleDetails;
     };
+    /**
+     * Icon representing the measure.
+     */
+    icon?: string;
     /**
      * Mappings for the measurement values in order to index the fields
      */

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

@@ -16,12 +16,12 @@ export declare class ModelService extends BaseService {
     private checkGroupAffinity;
     writeAsset(engineGroups: string[], model: string, metadataMappings: MetadataMappings, defaultMetadata: JSONObject, metadataDetails: MetadataDetails, metadataGroups: MetadataGroups, measures: NamedMeasures, tooltipModels: TooltipModels, locales: {
         [valueName: string]: LocaleDetails;
-    }, engineIds?: string[]): Promise<KDocument<AssetModelContent>>;
-    writeDevice(model: string, metadataMappings: MetadataMappings, defaultMetadata: JSONObject, metadataDetails: MetadataDetails, metadataGroups: MetadataGroups, measures: NamedMeasures): Promise<KDocument<DeviceModelContent>>;
-    writeGroup(engineGroups: string[], model: string, affinity: JSONObject, metadataMappings: MetadataMappings, defaultMetadata: JSONObject, metadataDetails: MetadataDetails, metadataGroups: MetadataGroups): Promise<KDocument<GroupModelContent>>;
+    }, engineIds?: string[], icon?: string): Promise<KDocument<AssetModelContent>>;
+    writeDevice(model: string, metadataMappings: MetadataMappings, defaultMetadata: JSONObject, metadataDetails: MetadataDetails, metadataGroups: MetadataGroups, measures: NamedMeasures, icon?: string): Promise<KDocument<DeviceModelContent>>;
+    writeGroup(engineGroups: string[], model: string, affinity: JSONObject, metadataMappings: MetadataMappings, defaultMetadata: JSONObject, metadataDetails: MetadataDetails, metadataGroups: MetadataGroups, icon?: string): Promise<KDocument<GroupModelContent>>;
     writeMeasure(type: string, valuesMappings: JSONObject, validationSchema?: SchemaObject, valuesDetails?: MeasureValuesDetails, locales?: {
         [valueName: string]: LocaleDetails;
-    }, engineIds?: string[]): Promise<KDocument<MeasureModelContent>>;
+    }, engineIds?: string[], icon?: string): Promise<KDocument<MeasureModelContent>>;
     deleteAsset(_id: string): Promise<void>;
     deleteDevice(_id: string): Promise<void>;
     deleteGroup(_id: string): Promise<void>;
@@ -67,5 +67,5 @@ export declare class ModelService extends BaseService {
      */
     updateAsset(engineGroups: string[], engineId: string | undefined, model: string, metadataMappings: MetadataMappings, defaultMetadata: JSONObject, metadataDetails: MetadataDetails, metadataGroups: MetadataGroups, measures: AssetModelContent["asset"]["measures"], tooltipModels: TooltipModels, locales: {
         [valueName: string]: LocaleDetails;
-    }, request: KuzzleRequest): Promise<KDocument<AssetModelContent>>;
+    }, icon: string | undefined, request: KuzzleRequest): Promise<KDocument<AssetModelContent>>;
 }

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

@@ -25,11 +25,12 @@ export declare class ModelsRegister {
      * @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.
+     * @param icon - Optional icon representing the model.
      * @throws PluginImplementationError if the model name is not in PascalCase.
      */
     registerAsset(engineGroups: string[], model: string, measures: NamedMeasures, metadataMappings?: MetadataMappings, defaultMetadata?: JSONObject, metadataDetails?: MetadataDetails, metadataGroups?: MetadataGroups, tooltipModels?: TooltipModels, locales?: {
         [valueName: string]: LocaleDetails;
-    }): void;
+    }, icon?: string): void;
     /**
      * Registers a device model.
      *
@@ -39,9 +40,10 @@ export declare class ModelsRegister {
      * @param defaultMetadata - The default metadata values for the model, defaults to an empty object.
      * @param metadataDetails - Optional detailed metadata descriptions, localizations and definition.
      * @param metadataGroups - Optional groups for organizing metadata, with localizations.
+     * @param icon - Optional icon representing the model.
      * @throws PluginImplementationError if the model name is not in PascalCase.
      */
-    registerDevice(model: string, measures: NamedMeasures, metadataMappings?: MetadataMappings, defaultMetadata?: JSONObject, metadataDetails?: MetadataDetails, metadataGroups?: MetadataGroups): void;
+    registerDevice(model: string, measures: NamedMeasures, metadataMappings?: MetadataMappings, defaultMetadata?: JSONObject, metadataDetails?: MetadataDetails, metadataGroups?: MetadataGroups, icon?: string): void;
     /**
      * Registers a group model.
      *
@@ -53,9 +55,10 @@ export declare class ModelsRegister {
      * @param defaultMetadata - The default metadata values for the model, defaults to an empty object.
      * @param metadataDetails - Optional detailed metadata descriptions, localizations and definition.
      * @param metadataGroups - Optional groups for organizing metadata, with localizations.
+     * @param icon - Optional icon representing the model.
      * @throws PluginImplementationError if the model name is not in PascalCase.
      */
-    registerGroup(engineGroups: string[], model: string, affinity: GroupAffinity, metadataMappings?: MetadataMappings, defaultMetadata?: JSONObject, metadataDetails?: MetadataDetails, metadataGroups?: MetadataGroups): void;
+    registerGroup(engineGroups: string[], model: string, affinity: GroupAffinity, metadataMappings?: MetadataMappings, defaultMetadata?: JSONObject, metadataDetails?: MetadataDetails, metadataGroups?: MetadataGroups, icon?: string): void;
     registerMeasure(type: string, measureDefinition: MeasureDefinition): void;
     private load;
 }

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

@@ -33,6 +33,7 @@ export interface ApiModelWriteAssetRequest extends ModelsControllerRequest {
         engineGroups: string[];
         engineIds?: string[];
         model: string;
+        icon?: string;
         metadataDetails?: MetadataDetails;
         metadataGroups?: MetadataGroups;
         metadataMappings?: MetadataMappings;
@@ -49,6 +50,7 @@ export interface ApiModelWriteDeviceRequest extends ModelsControllerRequest {
     action: "writeDevice";
     body: {
         model: string;
+        icon?: string;
         metadataDetails?: MetadataDetails;
         metadataGroups?: MetadataGroups;
         metadataMappings?: MetadataMappings;
@@ -63,6 +65,7 @@ export interface ApiModelWriteGroupRequest extends ModelsControllerRequest {
         affinity: GroupAffinity;
         engineGroups: string[];
         model: string;
+        icon?: string;
         metadataDetails?: MetadataDetails;
         metadataGroups?: MetadataGroups;
         metadataMappings?: MetadataMappings;
@@ -75,6 +78,7 @@ export interface ApiModelWriteMeasureRequest extends ModelsControllerRequest {
     body: {
         type: string;
         engineIds?: string[];
+        icon?: string;
         locales?: {
             [valueName: string]: LocaleDetails;
         };
@@ -89,6 +93,7 @@ export interface ApiModelUpdateAssetRequest extends ModelsControllerRequest {
     engineGroups: string[];
     model: string;
     body: {
+        icon?: string;
         metadataDetails?: MetadataDetails;
         metadataGroups?: MetadataGroups;
         metadataMappings?: MetadataMappings;

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

@@ -167,6 +167,10 @@ export interface AssetModelContent extends KDocumentContent {
          * Name of the model
          */
         model: string;
+        /**
+         * Icon representing the asset model.
+         */
+        icon?: string;
         /**
          * Metadata mappings.
          *
@@ -308,6 +312,10 @@ export interface DeviceModelContent extends KDocumentContent {
          * Name of the model
          */
         model: string;
+        /**
+         * Icon representing the device model.
+         */
+        icon?: string;
         /**
          * Metadata mappings.
          *
@@ -398,6 +406,10 @@ export interface GroupModelContent extends KDocumentContent {
          * Name of the model
          */
         model: string;
+        /**
+         * Icon representing the group model.
+         */
+        icon?: string;
         /**
          * Group types and model affinities
          */

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

@@ -113,6 +113,10 @@ export type AssetModelDefinition = {
      * Array describing measures names and types
      */
     measures: NamedMeasures;
+    /**
+     * Icon representing the asset model.
+     */
+    icon?: string;
     /**
      * Metadata mappings definition
      */
@@ -192,6 +196,10 @@ export type DeviceModelDefinition = {
      * Decoder used to decode payloads
      */
     decoder: Decoder;
+    /**
+     * Icon representing the device model.
+     */
+    icon?: string;
     /**
      * Metadata mappings definition
      */
@@ -283,6 +291,10 @@ export type GroupModelDefinition = {
      * Metadata mappings definition
      */
     affinity: GroupAffinity;
+    /**
+     * Icon representing the group model.
+     */
+    icon?: string;
     /**
      * Metadata mappings definition
      */

package/package.json

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