feat(softTenants): add softTenant ids to assets measures documents

.vscode/settings.json

@@ -0,0 +1,8 @@
+{
+  "javascript.preferences.quoteStyle": "double",
+  "exportall.config.quote": "\"",
+  "exportall.config.relExclusion": [
+    "/lib/modules/shared/exports.ts",
+    "/lib/modules/shared/types/exports.ts"
+  ]
+}

doc/2/controllers/assets/upsert/index.md

@@ -15,8 +15,8 @@ The Upsert operation allows you to create a new asset or update an existing one
 ### HTTP
 
 ```http
-URL: http://kuzzle:7512/_/device-manager/:engineId/assets/:_id
-Method: POST
+URL: http://kuzzle:7512/_/device-manager/:engineId/assets
+Method: PUT
 ```
 
 ## Other protocols

doc/2/controllers/devices/upsert/index.md

@@ -15,8 +15,8 @@ The Upsert operation allows you to create a new device or update an existing one
 ### HTTP
 
 ```http
-URL: http://kuzzle:7512/_/device-manager/:engineId/devices/:_id
-Method: POST
+URL: http://kuzzle:7512/_/device-manager/:engineId/devices
+Method: PUT
 ```
 
 ## Other protocols

lib/modules/asset/AssetService.ts

@@ -302,6 +302,7 @@ export class AssetService extends DigitalTwinService {
             metadata: { ...assetMetadata, ...metadata },
             model,
             reference,
+            softTenant: [],
           },
         },
         {

lib/modules/asset/AssetsController.ts

@@ -62,9 +62,7 @@ export class AssetsController {
         },
         upsert: {
           handler: this.upsert.bind(this),
-          http: [
-            { path: "device-manager/:engineId/assets/:_id", verb: "post" },
-          ],
+          http: [{ path: "device-manager/:engineId/assets", verb: "put" }],
         },
         delete: {
           handler: this.delete.bind(this),

lib/modules/asset/collections/assetsMappings.ts

@@ -25,7 +25,10 @@ export const assetsMappings: CollectionMappings = {
         date: { type: "date" },
       },
     },
-
+    softTenant: {
+      type: "keyword",
+      fields: { text: { type: "text" } },
+    },
     metadata: {
       properties: {
         // populated with asset models

lib/modules/asset/model/AssetSerializer.ts

@@ -32,6 +32,7 @@ export class AssetSerializer {
       metadata: asset._source.metadata,
       model: asset._source.model,
       reference: asset._source.reference,
+      softTenant: asset._source.softTenant,
     };
   }
 }

lib/modules/asset/types/AssetApi.ts

@@ -22,6 +22,12 @@ interface AssetsControllerRequest {
   controller: AssetsControllerName;
 
   engineId: string;
+
+  /**
+   * ? Request parameter used by SoftTenant module
+   * ! Not used directly in this plugin
+   */
+  softTenantId?: string | string[] | null;
 }
 
 export interface ApiAssetGetRequest extends AssetsControllerRequest {
@@ -61,8 +67,6 @@ export type ApiAssetMetadataReplaceResult = KDocument<AssetContent>;
 export interface ApiAssetUpsertRequest extends AssetsControllerRequest {
   action: "upsert";
 
-  _id: string;
-
   refresh?: string;
 
   body: {

lib/modules/asset/types/AssetContent.ts

@@ -38,6 +38,11 @@ export interface AssetContent<
     id: string;
     date: number;
   }>;
+  /**
+   * Id's of soft tenants
+   * ! Not used directly in this plugin
+   */
+  softTenant?: Array<string>;
 }
 
 /**
@@ -55,5 +60,5 @@ export type AssetMeasureContext<TMetadata extends Metadata = Metadata> = {
   measureName: string;
 } & Pick<
   AssetContent<JSONObject, TMetadata>,
-  "model" | "reference" | "metadata" | "groups"
+  "model" | "reference" | "metadata" | "groups" | "softTenant"
 >;

lib/modules/decoder/types/DecoderApi.ts

@@ -6,8 +6,6 @@ interface DecodersControllerRequest {
 
 export interface ApiDecoderListRequest extends DecodersControllerRequest {
   action: "list";
-
-  _id: string;
 }
 export type ApiDecoderListResult = {
   decoders: DecoderContent[];

lib/modules/device/DevicesController.ts

@@ -64,9 +64,7 @@ export class DevicesController {
         },
         upsert: {
           handler: this.upsert.bind(this),
-          http: [
-            { path: "device-manager/:engineId/devices/:_id", verb: "post" },
-          ],
+          http: [{ path: "device-manager/:engineId/devices", verb: "put" }],
         },
         replaceMetadata: {
           handler: this.replaceMetadata.bind(this),

lib/modules/device/types/DeviceApi.ts

@@ -49,8 +49,6 @@ export type ApiDeviceMetadataReplaceResult = KDocument<DeviceContent>;
 export interface ApiDeviceUpsertRequest extends DevicesControllerRequest {
   action: "upsert";
 
-  _id: string;
-
   refresh?: string;
 
   body: {

lib/modules/measure/collections/measuresMappings.ts

@@ -39,6 +39,10 @@ export const measuresMappings = {
             date: { type: "date" },
           },
         },
+        softTenant: {
+          type: "keyword",
+          fields: { text: { type: "text" } },
+        },
       },
     },
 

lib/modules/shared/errors/index.ts

@@ -0,0 +1 @@
+export * from "./SchemaValidationError";

lib/modules/shared/exports.ts

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

lib/modules/shared/index.ts

@@ -1,13 +1,5 @@
 export * from "./Module";
+export * from "./errors";
 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";
-export * from "./utils/flattenObject";
-export * from "./utils/keepStack";
-export * from "./utils/lock";
-export * from "./utils/objectDiff";
+export * from "./types";
+export * from "./utils";

lib/modules/shared/types/Models.ts

@@ -0,0 +1,17 @@
+import { MeasureDefinition } from "../../measure";
+import { AssetModelDefinition, DeviceModelDefinition } from "../../model";
+
+interface ModelDefinition<Definition> {
+  /**
+   * Name of model
+   */
+  modelName: string;
+  /**
+   * Model definition used by the plugin to create associated ressources
+   * and updates mappings.
+   */
+  definition: Definition;
+}
+export type AssetModel = ModelDefinition<AssetModelDefinition>;
+export type DeviceModel = ModelDefinition<DeviceModelDefinition>;
+export type MeasureModel = ModelDefinition<MeasureDefinition>;

lib/modules/shared/types/exports.ts

@@ -0,0 +1,6 @@
+export * from "./DigitalTwinContent";
+export * from "./DigitalTwinEvents";
+export * from "./DigitalTwinMeasures";
+export * from "./EmbeddedMeasure";
+export * from "./Metadata";
+export * from "./Models";

lib/modules/shared/types/index.ts

@@ -0,0 +1,9 @@
+export * from "./DigitalTwinApi";
+export * from "./DigitalTwinContent";
+export * from "./DigitalTwinEvents";
+export * from "./DigitalTwinMeasures";
+export * from "./EmbeddedMeasure";
+export * from "./KuzzleRole";
+export * from "./Metadata";
+export * from "./Models";
+export * from "./exports";

lib/modules/shared/utils/index.ts

@@ -0,0 +1,5 @@
+export * from "./AJValidator";
+export * from "./flattenObject";
+export * from "./keepStack";
+export * from "./lock";
+export * from "./objectDiff";

tests/application/app.ts

@@ -3,94 +3,25 @@ import util from "node:util";
 import { Backend, KuzzleRequest } from "kuzzle";
 
 import { DeviceManagerPlugin } from "../../index";
-
-import { containerAssetDefinition } from "./assets/Container";
-import { roomAssetDefinition } from "./assets/Room";
-import { streetLampAssetDefinition } from "./assets/StreetLamp";
-import { warehouseAssetDefinition } from "./assets/Warehouse";
-import { DummyTempDecoder, DummyTempPositionDecoder } from "./decoders";
 import { TestsController } from "./tests/controller";
 import { registerTestPipes } from "./tests/pipes";
-import { accelerationMeasureDefinition } from "./measures/AccelerationMeasure";
-import { brightnessMeasureDefinition } from "./measures/BrightnessMeasure";
-import { co2MeasureDefinition } from "./measures/CO2Measure";
-import { illuminanceMeasureDefinition } from "./measures/IlluminanceMeasure";
-import { powerConsumptionMeasureDefinition } from "./measures/PowerConsumptionMeasure";
-import { magicHouseAssetDefinition } from "./assets/MagicHouse";
-import { magiculeMeasureDefinition } from "./measures/Magicule";
+import { registerModels } from "./models";
 
 const app = new Backend("kuzzle");
 
 const deviceManager = new DeviceManagerPlugin();
 
 //? Add custom mapping properties
-deviceManager.config.engineCollections.asset.mappings.properties["softTenant"] = {
+deviceManager.config.engineCollections.asset.mappings.properties["custom"] = {
   type: "keyword",
   fields: { text: { type: "text" } },
 };
-deviceManager.config.engineCollections.device.mappings.properties["softTenant"] = {
+deviceManager.config.engineCollections.device.mappings.properties["custom"] = {
   type: "keyword",
   fields: { text: { type: "text" } },
 };
 
-
-deviceManager.models.registerDevice("DummyTempPosition",
-  {
-    decoder: new DummyTempPositionDecoder(),
-    metadataMappings: {
-      serial: { type: "keyword" },
-    },
-  }
-);
-
-deviceManager.models.registerDevice("DummyTemp",
-  {
-    decoder: new DummyTempDecoder(),
-    metadataMappings: {
-      color: { type: "keyword" },
-    },
-  }
-);
-
-// Register assets for the "commons" group
-deviceManager.models.registerAsset(
-  "commons",
-  "Container",
-  containerAssetDefinition
-);
-
-deviceManager.models.registerAsset(
-  "commons",
-  "Warehouse",
-  warehouseAssetDefinition
-);
-
-// Register assets for specialized groups
-deviceManager.models.registerAsset(
-  "air_quality",
-  "Room",
-  roomAssetDefinition
-);
-
-deviceManager.models.registerAsset(
-  "public_lighting",
-  "StreetLamp",
-  streetLampAssetDefinition
-);
-
-deviceManager.models.registerAsset(
-  "commons",
-  "MagicHouse",
-  magicHouseAssetDefinition
-)
-
-deviceManager.models.registerMeasure("acceleration", accelerationMeasureDefinition);
-deviceManager.models.registerMeasure("magicule", magiculeMeasureDefinition)
-deviceManager.models.registerMeasure("brightness", brightnessMeasureDefinition);
-deviceManager.models.registerMeasure("co2", co2MeasureDefinition);
-deviceManager.models.registerMeasure("illuminance", illuminanceMeasureDefinition);
-deviceManager.models.registerMeasure("powerConsumption", powerConsumptionMeasureDefinition);
-
+registerModels(deviceManager);
 registerTestPipes(app);
 
 app.plugin.use(deviceManager);