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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/dist/lib/modules/model/types/ModelApi.d.ts +7 -3
  2. package/dist/lib/modules/model/types/ModelContent.d.ts +9 -4
  3. package/dist/lib/modules/model/types/ModelDefinition.d.ts +24 -21
  4. package/package.json +1 -1
package/dist/lib/modules/model/types/ModelApi.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  import { JSONObject, KDocument } from "kuzzle-sdk";
2
- import { AssetModelContent, DeviceModelContent, MeasureModelContent } from "./ModelContent";
2
+ import { AssetModelContent, DeviceModelContent, MeasureModelContent, MetadataDetails, MetadataGroups, MetadataMappings } from "./ModelContent";
3
3
  interface ModelsControllerRequest {
4
4
  controller: "device-manager/models";
5
5
  }
@@ -24,7 +24,9 @@ export interface ApiModelWriteAssetRequest extends ModelsControllerRequest {
24
24
  body: {
25
25
  engineGroup: string;
26
26
  model: string;
27
- metadataMappings?: JSONObject;
27
+ metadataDetails?: MetadataDetails;
28
+ metadataGroups?: MetadataGroups;
29
+ metadataMappings?: MetadataMappings;
28
30
  defaultValues?: JSONObject;
29
31
  measures?: AssetModelContent["asset"]["measures"];
30
32
  };
@@ -34,7 +36,9 @@ export interface ApiModelWriteDeviceRequest extends ModelsControllerRequest {
34
36
  action: "writeDevice";
35
37
  body: {
36
38
  model: string;
37
- metadataMappings?: JSONObject;
39
+ metadataDetails?: MetadataDetails;
40
+ metadataGroups?: MetadataGroups;
41
+ metadataMappings?: MetadataMappings;
38
42
  defaultValues?: JSONObject;
39
43
  measures: DeviceModelContent["device"]["measures"];
40
44
  };
package/dist/lib/modules/model/types/ModelContent.d.ts CHANGED
@@ -31,6 +31,7 @@ export interface MetadataDetails {
31
31
  }
32
32
  interface MetadataGroupLocale {
33
33
  groupFriendlyName: string;
34
+ description: string;
34
35
  }
35
36
  export interface MetadataGroups {
36
37
  [groupName: string]: {
@@ -94,10 +95,12 @@ export interface AssetModelContent extends KDocumentContent {
94
95
  * "buildingEnv": {
95
96
  * "locales": {
96
97
  * "en": {
97
- * "groupFriendlyName": "Building environment"
98
+ * "groupFriendlyName": "Building environment",
99
+ * "description": "The building environment"
98
100
  * },
99
101
  * "fr": {
100
- * "groupFriendlyName": "Environnement du bâtiment"
102
+ * "groupFriendlyName": "Environnement du bâtiment",
103
+ * "description": "L'environnement du bâtiment"
101
104
  * }
102
105
  * }
103
106
  * }
@@ -172,10 +175,12 @@ export interface DeviceModelContent extends KDocumentContent {
172
175
  * "sensorSpecs": {
173
176
  * "locales": {
174
177
  * "en": {
175
- * "groupFriendlyName": "Sensor specifications"
178
+ * "groupFriendlyName": "Sensor specifications",
179
+ * "description" : "All sensors specifications"
176
180
  * },
177
181
  * "fr": {
178
- * "groupFriendlyName": "Spécifications techniques"
182
+ * "groupFriendlyName": "Spécifications techniques",
183
+ * "description": "Toutes les spécifications techniques"
179
184
  * }
180
185
  * }
181
186
  * }
package/dist/lib/modules/model/types/ModelDefinition.d.ts CHANGED
@@ -34,14 +34,16 @@ import { MetadataDetails, MetadataGroups, MetadataMappings } from "./ModelConten
34
34
  * }
35
35
  * },
36
36
  * metadataGroups: {
37
- * "buildingEnv": {
38
- * "locales": {
39
- * "en": {
40
- * "groupFriendlyName": "Building environment"
41
- * },
42
- * "fr": {
43
- * "groupFriendlyName": "Environnement du bâtiment"
44
- * }
37
+ * buildingEnv: {
38
+ * locales: {
39
+ * en: {
40
+ * groupFriendlyName: "Building environment",
41
+ * description: "The building environment"
42
+ * },
43
+ * fr: {
44
+ * groupFriendlyName: "Environnement du bâtiment",
45
+ * description: "L'environnement du bâtiment"
46
+ * }
45
47
  * }
46
48
  * }
47
49
  * }
@@ -98,19 +100,20 @@ export type AssetModelDefinition = {
98
100
  * }
99
101
  * },
100
102
  * metadataGroups: {
101
- * sensorSpecs: {
102
- * locales: {
103
- * en: {
104
- * groupFriendlyName: "Sensors specifications"
105
- * },
106
- * fr: {
107
- * groupFriendlyName: "Spécifications des capteurs"
108
- * }
109
- * }
110
- * }
111
- * }
112
- * }
113
- *
103
+ * sensorSpecs: {
104
+ * locales: {
105
+ * en: {
106
+ * groupFriendlyName: "Sensor specifications",
107
+ * description : "All sensors specifications"
108
+ * },
109
+ * fr: {
110
+ * groupFriendlyName: "Spécifications techniques",
111
+ * description: "Toutes les spécifications techniques"
112
+ * }
113
+ * }
114
+ * }
115
+ * }
116
+ * }
114
117
  */
115
118
  export type DeviceModelDefinition = {
116
119
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "kuzzle-device-manager-types",
3
- "version": "2.4.0-beta.14",
3
+ "version": "2.4.0-beta.15",
4
4
  "description": "Shared types for Kuzzle Device Manager",
5
5
  "author": "The Kuzzle Team (support@kuzzle.io)",
6
6
  "main": "index.js",