kuzzle-device-manager-types 2.1.0 → 2.1.2

package/dist/features/fixtures/application/assets/Container.d.ts

@@ -9,7 +9,9 @@ export interface ContainerMetadata extends Metadata {
 }
 export type ContainerMeasurements = {
     temperatureExt: TemperatureMeasurement;
+    temperatureInt: TemperatureMeasurement;
     position: PositionMeasurement;
+    temperatureWeather: TemperatureMeasurement;
 };
 export interface ContainerAssetContent extends AssetContent<ContainerMeasurements, ContainerMetadata> {
     model: "Container";

package/dist/features/fixtures/application/decoders/DummyTempDecoder.d.ts

@@ -1,4 +1,4 @@
-import { JSONObject } from "kuzzle";
+import { JSONObject } from "kuzzle-sdk";
 import { Decoder, DecodedPayload } from "../../../../index";
 export declare class DummyTempDecoder extends Decoder {
     measures: readonly [{

package/dist/features/fixtures/application/decoders/DummyTempPositionDecoder.d.ts

@@ -1,4 +1,4 @@
-import { JSONObject } from "kuzzle";
+import { JSONObject } from "kuzzle-sdk";
 import { Decoder, DecodedPayload } from "../../../../index";
 export declare class DummyTempPositionDecoder extends Decoder {
     measures: readonly [{

package/dist/lib/core/DeviceManagerConfiguration.d.ts

@@ -1,4 +1,4 @@
-import { JSONObject } from "kuzzle";
+import { JSONObject } from "kuzzle-sdk";
 export type DeviceManagerConfiguration = {
     /**
      * Ignore errors at startup such as wrong mappings update.

package/dist/lib/core/DeviceManagerPlugin.d.ts

@@ -1,4 +1,5 @@
-import { Plugin, PluginContext, JSONObject } from "kuzzle";
+import { Plugin, PluginContext } from "kuzzle";
+import { JSONObject } from "kuzzle-sdk";
 import { MeasureDefinition } from "../modules/measure";
 import { AssetModelDefinition, DeviceModelDefinition } from "../modules/model";
 import { DeviceManagerConfiguration } from "./DeviceManagerConfiguration";

package/dist/lib/core/registers/ModelsRegister.d.ts

@@ -1,4 +1,4 @@
-import { JSONObject } from "kuzzle";
+import { JSONObject } from "kuzzle-sdk";
 import { NamedMeasures } from "../../modules/decoder";
 import { MeasureDefinition } from "../../modules/measure";
 import { DeviceManagerPlugin } from "../DeviceManagerPlugin";

package/dist/lib/modules/asset/AssetHistoryService.d.ts

@@ -1,4 +1,4 @@
-import { KDocument } from "kuzzle";
+import { KDocument } from "kuzzle-sdk";
 import { DeviceManagerPlugin } from "../../core";
 import { AssetHistoryEvent } from "./types/AssetHistoryContent";
 import { AssetContent } from "./types/AssetContent";

package/dist/lib/modules/asset/AssetService.d.ts

@@ -1,4 +1,5 @@
-import { JSONObject, KDocument, KHit, SearchResult, User } from "kuzzle";
+import { User } from "kuzzle";
+import { JSONObject, KDocument, KHit, SearchResult } from "kuzzle-sdk";
 import { Metadata } from "../shared";
 import { DeviceManagerPlugin } from "../../core";
 import { AssetContent } from "./types/AssetContent";

package/dist/lib/modules/asset/model/AssetSerializer.d.ts

@@ -1,4 +1,4 @@
-import { KDocument } from "kuzzle";
+import { KDocument } from "kuzzle-sdk";
 import { AssetContent, AssetMeasureContext } from "../types/AssetContent";
 export declare class AssetSerializer {
     static id(model: string, reference: string): string;

package/dist/lib/modules/asset/types/AssetApi.d.ts

@@ -1,4 +1,4 @@
-import { JSONObject, KDocument, KHit, SearchResult } from "kuzzle";
+import { JSONObject, KDocument, KHit, SearchResult } from "kuzzle-sdk";
 import { MeasureContent } from "../../../modules/measure";
 import { Metadata } from "../../shared";
 import { AssetContent } from "./AssetContent";
@@ -42,6 +42,7 @@ export interface ApiAssetSearchRequest extends AssetsControllerRequest {
     from?: number;
     size?: number;
     scrollTTL?: string;
+    lang?: "koncorde" | "elasticsearch";
     body: JSONObject;
 }
 export type ApiAssetSearchResult = SearchResult<KHit<AssetContent>>;

package/dist/lib/modules/asset/types/AssetContent.d.ts

@@ -1,4 +1,4 @@
-import { JSONObject } from "kuzzle";
+import { JSONObject } from "kuzzle-sdk";
 import { DigitalTwinContent, Metadata } from "../../shared";
 /**
  * Asset document content

package/dist/lib/modules/asset/types/AssetEvents.d.ts

@@ -1,4 +1,4 @@
-import { KDocument } from "kuzzle";
+import { KDocument } from "kuzzle-sdk";
 import { Metadata } from "../../../modules/shared";
 import { AssetContent } from "./AssetContent";
 import { AssetHistoryEvent } from "./AssetHistoryContent";

package/dist/lib/modules/asset/types/AssetHistoryContent.d.ts

@@ -1,4 +1,4 @@
-import { JSONObject, KDocumentContent } from "kuzzle";
+import { JSONObject, KDocumentContent } from "kuzzle-sdk";
 import { Metadata } from "../../shared";
 import { AssetContent } from "./AssetContent";
 export type AssetHistoryEventMeasure = {

package/dist/lib/modules/decoder/DecodedPayload.d.ts

@@ -1,4 +1,4 @@
-import { JSONObject } from "kuzzle";
+import { JSONObject } from "kuzzle-sdk";
 import { DecodedMeasurement } from "../measure";
 import { Decoder } from "./Decoder";
 /**

package/dist/lib/modules/decoder/Decoder.d.ts

@@ -1,4 +1,5 @@
-import { HttpRoute, JSONObject, KuzzleRequest } from "kuzzle";
+import { HttpRoute, KuzzleRequest } from "kuzzle";
+import { JSONObject } from "kuzzle-sdk";
 import { DecodedPayload } from "./DecodedPayload";
 import { DecoderContent } from "./types/DecoderContent";
 /**

package/dist/lib/modules/decoder/PayloadService.d.ts

@@ -1,4 +1,5 @@
-import { JSONObject, KDocument, KuzzleRequest } from "kuzzle";
+import { KuzzleRequest } from "kuzzle";
+import { JSONObject, KDocument } from "kuzzle-sdk";
 import { DeviceManagerPlugin } from "../../core";
 import { DeviceContent } from "../device";
 import { DecodedMeasurement } from "../measure";

package/dist/lib/modules/decoder/types/PayloadApi.d.ts

@@ -1,4 +1,4 @@
-import { JSONObject } from "kuzzle";
+import { JSONObject } from "kuzzle-sdk";
 interface PayloadsControllerRequest {
     controller: "device-manager/payloads";
 }

package/dist/lib/modules/device/DeviceService.d.ts

@@ -1,4 +1,5 @@
-import { JSONObject, KDocument, KHit, Plugin, SearchResult, User } from "kuzzle";
+import { Plugin, User } from "kuzzle";
+import { JSONObject, KDocument, KHit, SearchResult } from "kuzzle-sdk";
 import { AssetContent } from "./../asset";
 import { Metadata } from "../shared";
 import { DecodedMeasurement } from "../measure";

package/dist/lib/modules/device/model/DeviceSerializer.d.ts

@@ -1,4 +1,4 @@
-import { KDocument } from "kuzzle";
+import { KDocument } from "kuzzle-sdk";
 import { DeviceContent } from "../types/DeviceContent";
 export declare class DeviceSerializer {
     static id(model: string, reference: string): string;

package/dist/lib/modules/device/types/DeviceApi.d.ts

@@ -1,4 +1,4 @@
-import { JSONObject, KDocument, KHit, SearchResult } from "kuzzle";
+import { JSONObject, KDocument, KHit, SearchResult } from "kuzzle-sdk";
 import { DecodedMeasurement, MeasureContent } from "../../measure";
 import { AssetContent } from "../../asset";
 import { Metadata } from "../../shared";

package/dist/lib/modules/device/types/DeviceContent.d.ts

@@ -1,4 +1,4 @@
-import { JSONObject } from "kuzzle";
+import { JSONObject } from "kuzzle-sdk";
 import { DigitalTwinContent, Metadata } from "../../shared";
 /**
  * Device document content
@@ -7,8 +7,8 @@ export interface DeviceContent<TMeasures extends JSONObject = any, TMetadata ext
     /**
      * Linked asset unique identifier
      */
-    assetId?: string;
+    assetId: string | null;
     /**
      */
-    engineId?: string;
+    engineId: string;
 }

package/dist/lib/modules/device/types/DeviceEvents.d.ts

@@ -1,4 +1,5 @@
-import { KDocument, User } from "kuzzle";
+import { User } from "kuzzle";
+import { KDocument } from "kuzzle-sdk";
 import { Metadata } from "../../../modules/shared";
 import { DeviceContent } from "./DeviceContent";
 export type EventDeviceUpdateBefore = {

package/dist/lib/modules/measure/MeasureService.d.ts

@@ -25,7 +25,6 @@ export declare class MeasureService {
      *  - trigger events to trigger business rules
      */
     ingest(device: KDocument<DeviceContent>, measurements: DecodedMeasurement<JSONObject>[], metadata: Metadata, payloadUuids: string[]): Promise<void>;
-    private compareMetadata;
     private updateDeviceMeasures;
     private updateAssetMeasures;
     /**

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

@@ -1,4 +1,4 @@
-import { JSONObject, KDocumentContent } from "kuzzle";
+import { JSONObject, KDocumentContent } from "kuzzle-sdk";
 import { Metadata } from "../../../modules/shared";
 import { AssetMeasureContext } from "../../../modules/asset";
 export type MeasureOriginDevice = {
@@ -30,6 +30,10 @@ export type MeasureOriginDevice = {
     _id: string;
 };
 export type MeasureOriginComputed = {
+    /**
+     * Computed measures are not automatically added into the asset and device
+     * documents at the end of the ingestion pipeline.
+     */
     type: "computed";
     /**
      * String that identify the rule used to compute the measure

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

@@ -1,4 +1,4 @@
-import { JSONObject } from "kuzzle";
+import { JSONObject } from "kuzzle-sdk";
 /**
  * Represents a measure definition registered by the Device Manager
  *

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

@@ -1,4 +1,4 @@
-import { JSONObject, KDocument } from "kuzzle";
+import { JSONObject, KDocument } from "kuzzle-sdk";
 import { DeviceContent } from "../../../modules/device";
 import { AssetContent } from "../../../modules/asset";
 import { Metadata } from "../../../modules/shared";

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

@@ -1,4 +1,4 @@
-import { JSONObject, KDocument } from "kuzzle";
+import { JSONObject, KDocument } from "kuzzle-sdk";
 import { DeviceManagerPlugin } from "../../core";
 import { AssetModelContent, DeviceModelContent, MeasureModelContent } from "./types/ModelContent";
 export declare class ModelService {

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

@@ -1,4 +1,4 @@
-import { JSONObject, KDocument } from "kuzzle";
+import { JSONObject, KDocument } from "kuzzle-sdk";
 import { AssetModelContent, DeviceModelContent, MeasureModelContent } from "./ModelContent";
 interface ModelsControllerRequest {
     controller: "device-manager/models";

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

@@ -1,4 +1,4 @@
-import { JSONObject, KDocumentContent } from "kuzzle";
+import { JSONObject, KDocumentContent } from "kuzzle-sdk";
 import { NamedMeasures } from "../../../modules/decoder";
 import { MeasureDefinition } from "../../measure";
 export interface MeasureModelContent extends KDocumentContent {

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

@@ -1,4 +1,4 @@
-import { JSONObject } from "kuzzle";
+import { JSONObject } from "kuzzle-sdk";
 import { Decoder, NamedMeasures } from "../../../modules/decoder";
 /**
  * Define an asset model

package/dist/lib/modules/shared/index.d.ts

@@ -1,3 +1,4 @@
+export * from "./Module";
 export * from "./types/DigitalTwinContent";
 export * from "./types/Metadata";
 export * from "./types/EmbeddedMeasure";
@@ -5,4 +6,5 @@ export * from "./types/KuzzleRole";
 export * from "./utils/lock";
 export * from "./utils/flattenObject";
 export * from "./utils/ask";
-export * from "./Module";
+export * from "./utils/keepStack";
+export * from "./utils/objectDiff";

package/dist/lib/modules/shared/types/DigitalTwinContent.d.ts

@@ -1,4 +1,4 @@
-import { JSONObject, KDocumentContent } from "kuzzle";
+import { JSONObject, KDocumentContent } from "kuzzle-sdk";
 import { EmbeddedMeasure } from "./EmbeddedMeasure";
 import { Metadata } from "./Metadata";
 export interface DigitalTwinContent<TMeasures extends JSONObject = JSONObject, TMetadata extends Metadata = Metadata> extends KDocumentContent {

package/dist/lib/modules/shared/types/EmbeddedMeasure.d.ts

@@ -1,4 +1,4 @@
-import { JSONObject } from "kuzzle";
+import { JSONObject } from "kuzzle-sdk";
 export type EmbeddedMeasure<TMeasureValue extends JSONObject = JSONObject> = {
     /**
      * Payloads that created this measure.

package/dist/lib/modules/shared/utils/flattenObject.d.ts

@@ -1,4 +1,4 @@
-import { JSONObject } from "kuzzle";
+import { JSONObject } from "kuzzle-sdk";
 /**
  * Flatten an object transform:
  *

package/dist/lib/modules/shared/utils/keepStack.d.ts

@@ -0,0 +1,2 @@
+import { KuzzleError } from "kuzzle";
+export declare function keepStack(original: Error, error: KuzzleError): KuzzleError;

package/dist/lib/modules/shared/utils/objectDiff.d.ts

@@ -0,0 +1,2 @@
+import { JSONObject } from "kuzzle-sdk";
+export declare function objectDiff(base: JSONObject, object: JSONObject): string[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kuzzle-device-manager-types",
-  "version": "2.1.0",
+  "version": "2.1.2",
   "description": "Shared types for Kuzzle Device Manager",
   "author": "The Kuzzle Team (support@kuzzle.io)",
   "types": "dist/index.d.ts",