kuzzle-device-manager 0.4.12 → 0.4.15

package/README.md

@@ -17,7 +17,7 @@ npm install kuzzle-device-manager
 
 ### Online
 
-Open [https://docs.kuzzle.io/kuzzle-iot-platform/device-manager/1](https://docs.kuzzle.io/kuzzle-iot-platform/device-manager/1)
+Open [https://docs.kuzzle.io/official-plugins/device-manager/1/guides/devices/](https://docs.kuzzle.io/official-plugins/device-manager/1/guides/devices/)
 
 ### Locally
 

package/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package/lib/DeviceManagerPlugin.d.ts

@@ -1,5 +1,5 @@
-import { Plugin, PluginContext, JSONObject } from 'kuzzle';
-import { Decoder, PayloadHandler, AssetMappingsManager, DeviceMappingsManager } from './core-classes';
+import { Plugin, PluginContext, JSONObject, EmbeddedSDK } from 'kuzzle';
+import { PayloadService, BatchWriter, Decoder, PayloadHandler, AssetMappingsManager, DeviceMappingsManager } from './core-classes';
 export declare type DeviceManagerConfig = {
     /**
      * Administration index name
@@ -36,12 +36,12 @@ export declare class DeviceManagerPlugin extends Plugin {
     private assetController;
     private deviceController;
     private engineController;
-    private payloadService;
+    protected payloadService: PayloadService;
     private deviceManagerEngine;
     private deviceService;
     private migrationService;
-    private batchWriter;
-    private get sdk();
+    protected batchWriter: BatchWriter;
+    protected get sdk(): EmbeddedSDK;
     /**
      * List of registered decoders.
      * Map<model, decoder>

package/lib/controllers/AssetController.d.ts

@@ -3,5 +3,7 @@ import { CRUDController } from './CRUDController';
 export declare class AssetController extends CRUDController {
     get sdk(): EmbeddedSDK;
     constructor(plugin: Plugin);
-    create(request: KuzzleRequest): Promise<import("kuzzle").Document>;
+    create(request: KuzzleRequest): Promise<import("kuzzle").KDocument<{
+        [x: string]: any;
+    }>>;
 }

package/lib/controllers/CRUDController.d.ts

@@ -12,13 +12,15 @@ export declare class CRUDController {
      *
      * @param request
      */
-    create(request: KuzzleRequest): Promise<import("kuzzle").Document>;
+    create(request: KuzzleRequest): Promise<import("kuzzle").KDocument<{
+        [x: string]: any;
+    }>>;
     /**
      * Delete an asset or a device depending on the collection.
      *
      * @param request
      */
-    delete(request: KuzzleRequest): Promise<number>;
+    delete(request: KuzzleRequest): Promise<string>;
     /**
      * search assets or devices depending on the collection.
      *
@@ -30,5 +32,7 @@ export declare class CRUDController {
      *
      * @param request
      */
-    update(request: KuzzleRequest): Promise<import("kuzzle").Document>;
+    update(request: KuzzleRequest): Promise<import("kuzzle").KDocument<{
+        [x: string]: any;
+    }>>;
 }

package/lib/controllers/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package/lib/core-classes/BatchProcessing/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package/lib/core-classes/DeviceService.js

@@ -34,8 +34,8 @@ class DeviceService {
             }
             const deviceDocuments = this.formatDevicesContent(devices, document);
             const { errors, successes } = await this.writeToDatabase(deviceDocuments, async (deviceDocuments) => {
-                const updated = await this.sdk.document.mUpdate(this.config.adminIndex, 'devices', deviceDocuments, { strict, ...options });
-                await this.sdk.document.mCreate(document.tenantId, 'devices', deviceDocuments, { strict, ...options });
+                const updated = await this.sdk.document.mUpdate(this.config.adminIndex, 'devices', deviceDocuments, { strict, refresh: options.refresh });
+                await this.sdk.document.mCreate(document.tenantId, 'devices', deviceDocuments, { strict, refresh: options.refresh });
                 return {
                     successes: results.successes.concat(updated.successes),
                     errors: results.errors.concat(updated.errors)
@@ -76,8 +76,8 @@ class DeviceService {
                 return { _id: device._id, body: { tenantId: null } };
             });
             const { errors, successes } = await this.writeToDatabase(deviceDocuments, async (deviceDocuments) => {
-                const updated = await this.sdk.document.mUpdate(this.config.adminIndex, 'devices', deviceDocuments, { strict, ...options });
-                await this.sdk.document.mDelete(document.tenantId, 'devices', deviceDocuments.map(device => device._id), { strict, ...options });
+                const updated = await this.sdk.document.mUpdate(this.config.adminIndex, 'devices', deviceDocuments, { strict, refresh: options.refresh });
+                await this.sdk.document.mDelete(document.tenantId, 'devices', deviceDocuments.map(device => device._id), { strict, refresh: options.refresh });
                 return {
                     successes: results.successes.concat(updated.successes),
                     errors: results.errors.concat(updated.errors)
@@ -123,15 +123,15 @@ class DeviceService {
                 assetDocuments.push({ _id: assetId, body: { measures } });
             }
             const updatedDevice = await this.writeToDatabase(deviceDocuments, async (deviceDocuments) => {
-                const updated = await this.sdk.document.mUpdate(this.config.adminIndex, 'devices', deviceDocuments, { strict, ...options });
-                await this.sdk.document.mUpdate(document.tenantId, 'devices', deviceDocuments, { strict, ...options });
+                const updated = await this.sdk.document.mUpdate(this.config.adminIndex, 'devices', deviceDocuments, { strict, refresh: options.refresh });
+                await this.sdk.document.mUpdate(document.tenantId, 'devices', deviceDocuments, { strict, refresh: options.refresh });
                 return {
                     successes: results.successes.concat(updated.successes),
                     errors: results.errors.concat(updated.errors)
                 };
             });
             const updatedAssets = await this.writeToDatabase(assetDocuments, async (assetDocuments) => {
-                const updated = await this.sdk.document.mUpdate(document.tenantId, 'assets', assetDocuments, { strict, ...options });
+                const updated = await this.sdk.document.mUpdate(document.tenantId, 'assets', assetDocuments, { strict, refresh: options.refresh });
                 return {
                     successes: results.successes.concat(updated.successes),
                     errors: results.errors.concat(updated.errors)
@@ -168,15 +168,15 @@ class DeviceService {
                 assetDocuments.push({ _id: device._source.assetId, body: { measures } });
             }
             const updatedDevice = await this.writeToDatabase(deviceDocuments, async (deviceDocuments) => {
-                const updated = await this.sdk.document.mUpdate(this.config.adminIndex, 'devices', deviceDocuments, { strict, ...options });
-                await this.sdk.document.mUpdate(document.tenantId, 'devices', deviceDocuments, { strict, ...options });
+                const updated = await this.sdk.document.mUpdate(this.config.adminIndex, 'devices', deviceDocuments, { strict, refresh: options.refresh });
+                await this.sdk.document.mUpdate(document.tenantId, 'devices', deviceDocuments, { strict, refresh: options.refresh });
                 return {
                     successes: results.successes.concat(updated.successes),
                     errors: results.errors.concat(updated.errors)
                 };
             });
             const updatedAssets = await this.writeToDatabase(assetDocuments, async (assetDocuments) => {
-                const updated = await this.sdk.document.mUpdate(document.tenantId, 'assets', assetDocuments, { strict, ...options });
+                const updated = await this.sdk.document.mUpdate(document.tenantId, 'assets', assetDocuments, { strict, refresh: options.refresh });
                 return {
                     successes: results.successes.concat(updated.successes),
                     errors: results.errors.concat(updated.errors)
@@ -191,7 +191,7 @@ class DeviceService {
         const { _source: { measures } } = await this.sdk.document.get(tenantId, 'assets', device._source.assetId);
         for (const [measureName] of Object.entries(device._source.measures)) {
             if (measures[measureName]) {
-                measures[measureName] = undefined;
+                measures[measureName] = null;
             }
         }
         return measures;

package/lib/core-classes/PayloadService.d.ts

@@ -1,11 +1,13 @@
-import { KuzzleRequest, EmbeddedSDK, Plugin } from 'kuzzle';
+import { KuzzleRequest, PluginContext, EmbeddedSDK, Plugin } from 'kuzzle';
 import { Decoder } from './Decoder';
-import { BatchWriter } from './BatchProcessing';
+import { Device, BaseAsset } from '../models';
+import { BatchController, BatchWriter } from './BatchProcessing';
+import { DeviceManagerConfig } from '../DeviceManagerPlugin';
 export declare type PayloadHandler = (request: KuzzleRequest, decoder: Decoder) => Promise<any>;
 export declare class PayloadService {
-    private config;
-    private context;
-    private batchController;
+    protected config: DeviceManagerConfig;
+    protected context: PluginContext;
+    protected batchController: BatchController;
     get sdk(): EmbeddedSDK;
     constructor(plugin: Plugin, batchWriter: BatchWriter);
     process(request: KuzzleRequest, decoder: Decoder, { refresh }?: {
@@ -31,13 +33,15 @@ export declare class PayloadService {
      * Get the device entry from the provisioning catalog in corresponding index
      */
     private getCatalogEntry;
-    private update;
+    protected update(device: Device, decoder: Decoder, request: KuzzleRequest, { refresh }: {
+        refresh: any;
+    }): Promise<any>;
     /**
      * Propagate the measures inside the asset document.
      */
-    private propagateToAsset;
+    protected propagateToAsset(tenantId: string, decoder: Decoder, updatedDevice: Device, assetId: string): Promise<BaseAsset>;
     /**
      * Creates an history entry for an asset
      */
-    private historizeAsset;
+    protected historizeAsset(tenantId: string, asset: BaseAsset): Promise<void>;
 }

package/lib/core-classes/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package/lib/models/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package/lib/types/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package/lib/utils/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kuzzle-device-manager",
-  "version": "0.4.12",
+  "version": "0.4.15",
   "description": "Manage your IoT devices and assets. Choose a provisionning strategy, receive and decode payload, handle your IoT business logic.",
   "author": "The Kuzzle Team (support@kuzzle.io)",
   "repository": {
@@ -25,29 +25,30 @@
   "license": "Apache-2.0",
   "dependencies": {
     "csvtojson": "~2.0.10",
+    "kuzzle": "^2.18.0",
     "kuzzle-plugin-commons": "https://github.com/kuzzleio/kuzzle-plugin-commons/archive/refs/tags/0.0.1.tar.gz",
     "uuid": "~8.3.2"
   },
   "devDependencies": {
-    "@types/node": "^16.11.11",
-    "@typescript-eslint/eslint-plugin": "^5.5.0",
-    "@typescript-eslint/parser": "^5.5.0",
-    "cucumber": "^6.0.5",
-    "ergol": "^1.0.1",
-    "eslint": "^8.4.0",
+    "@types/node": "^16.11.27",
+    "@typescript-eslint/eslint-plugin": "^5.20.0",
+    "@typescript-eslint/parser": "^5.20.0",
+    "cucumber": "^6.0.7",
+    "ergol": "^1.0.2",
+    "eslint": "^8.13.0",
     "eslint-friendly-formatter": "^4.0.1",
     "eslint-loader": "^4.0.2",
-    "kuzzle": "^2.15.2",
-    "kuzzle-sdk": "^7.7.6",
+    "kuzzle": "^2.18.0",
+    "kuzzle-sdk": "^7.10.0",
     "lodash": "^4.17.21",
-    "mocha": "^9.1.3",
+    "mocha": "^9.2.2",
     "mock-require": "^3.0.3",
     "rewire": "^5.0.0",
     "should": "^13.2.3",
     "should-sinon": "^0.0.6",
     "sinon": "^12.0.1",
-    "ts-node": "^10.4.0",
-    "typescript": "^4.5.2"
+    "ts-node": "^10.7.0",
+    "typescript": "^4.6.3"
   },
   "peerDependencies": {
     "kuzzle": "^2.15.2"