kuzzle-device-manager-types 2.5.0-next.1 → 2.5.0

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

@@ -7,6 +7,11 @@ import { ApiMeasureSource } from "../../measure/types/MeasureSources";
 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 {
     action: "get";
@@ -33,7 +38,6 @@ export interface ApiAssetMetadataReplaceRequest extends AssetsControllerRequest
 export type ApiAssetMetadataReplaceResult = KDocument<AssetContent>;
 export interface ApiAssetUpsertRequest extends AssetsControllerRequest {
     action: "upsert";
-    _id: string;
     refresh?: string;
     body: {
         model: string;

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

@@ -36,6 +36,11 @@ export interface AssetContent<TMeasures extends JSONObject = any, TMetadata exte
         id: string;
         date: number;
     }>;
+    /**
+     * Id's of soft tenants
+     * ! Not used directly in this plugin
+     */
+    softTenant?: Array<string>;
 }
 /**
  * Asset description used to contextualize each measure data point
@@ -49,4 +54,4 @@ export type AssetMeasureContext<TMetadata extends Metadata = Metadata> = {
      * Name of the measure for the Asset
      */
     measureName: string;
-} & Pick<AssetContent<JSONObject, TMetadata>, "model" | "reference" | "metadata" | "groups">;
+} & Pick<AssetContent<JSONObject, TMetadata>, "model" | "reference" | "metadata" | "groups" | "softTenant">;

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

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

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

@@ -81,5 +81,4 @@ export declare class DeviceService extends DigitalTwinService {
     private getEngine;
     private getDeviceModel;
     private getAssetModel;
-    private refreshModel;
 }

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

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

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

@@ -1,6 +1,5 @@
 import { User } from "kuzzle";
 import { KDocument } from "kuzzle-sdk";
-import { DeviceModelContent } from "../../../modules/model";
 import { Metadata } from "../../../modules/shared";
 import { DeviceContent } from "./DeviceContent";
 import { ApiDeviceLinkAssetRequest } from "./DeviceApi";
@@ -57,10 +56,3 @@ export type AskDeviceAttachEngine = {
     };
     result: void;
 };
-export type AskDeviceRefreshModel = {
-    name: "ask:device-manager:device:refresh-model";
-    payload: {
-        deviceModel: DeviceModelContent;
-    };
-    result: void;
-};

package/dist/lib/modules/measure/collections/measuresMappings.d.ts

@@ -50,6 +50,14 @@ export declare const measuresMappings: {
                         };
                     };
                 };
+                softTenant: {
+                    type: string;
+                    fields: {
+                        text: {
+                            type: string;
+                        };
+                    };
+                };
             };
         };
         /**

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

@@ -26,7 +26,8 @@ export interface LocaleDetails {
 }
 export interface BaseEditorHint {
     readOnly?: boolean;
-    type: EditorHintEnum;
+    isModal?: boolean;
+    type: EditorHintEnum | string;
 }
 export declare enum EditorHintEnum {
     BASE = "base",

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

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

package/dist/lib/modules/shared/exports.d.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";

package/dist/lib/modules/shared/index.d.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";

package/dist/lib/modules/shared/services/AbstractExporter.d.ts

@@ -20,12 +20,10 @@ export interface Column {
     isMeasure?: boolean;
     isIsoDate?: boolean;
 }
-export type ExportStreamAugmenter = (result: SearchResult<KHit<KDocumentContentGeneric>>, columns: Column[], engineId: string) => Promise<void>;
 export declare abstract class AbstractExporter<P extends ExportParams = ExportParams> {
     protected plugin: DeviceManagerPlugin;
     protected target: InternalCollection;
     protected config: ExporterOption;
-    protected exportStreamAugmenters: ExportStreamAugmenter[];
     constructor(plugin: DeviceManagerPlugin, target: InternalCollection, config?: Partial<ExporterOption>);
     protected get sdk(): import("kuzzle").EmbeddedSDK;
     protected get ms(): any;
@@ -50,5 +48,5 @@ export declare abstract class AbstractExporter<P extends ExportParams = ExportPa
     prepareExport(engineId: string, user: User, params: P): Promise<string>;
     protected formatHit(columns: Column[], hit: KHit<KDocumentContentGeneric>): string[];
     getExport(engineId: string, exportId: string): Promise<P>;
-    getExportStream(request: SearchResult<KHit<KDocumentContentGeneric>>, columns: Column[], engineId: string): Promise<PassThrough>;
+    getExportStream(request: SearchResult<KHit<KDocumentContentGeneric>>, columns: Column[]): Promise<PassThrough>;
 }

package/dist/lib/modules/shared/services/DigitalTwinExporter.d.ts

@@ -1,10 +1,6 @@
 import { UUID } from "node:crypto";
-import { DeviceManagerPlugin, InternalCollection } from "../../plugin";
-import { AbstractExporter, ExporterOption } from "./AbstractExporter";
+import { AbstractExporter } from "./AbstractExporter";
 export declare class DigitalTwinExporter extends AbstractExporter {
-    protected plugin: DeviceManagerPlugin;
-    protected target: InternalCollection;
-    constructor(plugin: DeviceManagerPlugin, target: InternalCollection, config?: Partial<ExporterOption>);
     protected exportRedisKey(engineId: string, exportId: string): string;
     protected getLink(engineId: string, exportId: UUID): string;
     sendExport(engineId: string, exportId: string): Promise<import("stream").PassThrough>;
@@ -13,5 +9,4 @@ export declare class DigitalTwinExporter extends AbstractExporter {
      */
     private getNamedMeasures;
     private generateMeasureColumns;
-    private addMeasuresToExportStream;
 }

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

@@ -1,5 +1,4 @@
 import { JSONObject, KDocumentContent } from "kuzzle-sdk";
-import { NamedMeasures } from "../../decoder";
 import { Metadata } from "./Metadata";
 import { DigitalTwinMeasures } from "./DigitalTwinMeasures";
 export interface DigitalTwinContent<TMeasures extends JSONObject = JSONObject, TMetadata extends Metadata = Metadata> extends KDocumentContent {
@@ -8,5 +7,4 @@ export interface DigitalTwinContent<TMeasures extends JSONObject = JSONObject, T
     metadata: TMetadata;
     measures: DigitalTwinMeasures<TMeasures>;
     lastMeasuredAt: number;
-    measureSlots: NamedMeasures;
 }

package/dist/lib/modules/shared/types/Models.d.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>;
+export {};

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

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

package/dist/lib/modules/shared/types/index.d.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";

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

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

package/dist/tests/application/assets/Container.d.ts

@@ -1,4 +1,5 @@
-import { Metadata, AssetContent, TemperatureMeasurement, PositionMeasurement, AssetModelDefinition } from "../../../index";
+import { Metadata, AssetContent, TemperatureMeasurement, PositionMeasurement, AssetModel } from "../../../index";
+declare const modelName = "Container";
 export interface ContainerMetadata extends Metadata {
     height: number;
     width: number;
@@ -17,6 +18,7 @@ export type ContainerMeasurements = {
     temperatureWeather: TemperatureMeasurement;
 };
 export interface ContainerAssetContent extends AssetContent<ContainerMeasurements, ContainerMetadata> {
-    model: "Container";
+    model: typeof modelName;
 }
-export declare const containerAssetDefinition: AssetModelDefinition;
+export declare const Container: AssetModel;
+export {};

package/dist/tests/application/assets/MagicHouse.d.ts

@@ -1,2 +1,2 @@
-import { AssetModelDefinition } from "../../../index";
-export declare const magicHouseAssetDefinition: AssetModelDefinition;
+import { AssetModel } from "../../../index";
+export declare const MagicHouse: AssetModel;

package/dist/tests/application/assets/Room.d.ts

@@ -1,2 +1,2 @@
-import { AssetModelDefinition } from "../../../index";
-export declare const roomAssetDefinition: AssetModelDefinition;
+import { AssetModel } from "../../../index";
+export declare const Room: AssetModel;

package/dist/tests/application/assets/StreetLamp.d.ts

@@ -1,2 +1,2 @@
-import { AssetModelDefinition } from "../../../index";
-export declare const streetLampAssetDefinition: AssetModelDefinition;
+import { AssetModel } from "../../../index";
+export declare const StreetLamp: AssetModel;

package/dist/tests/application/assets/Warehouse.d.ts

@@ -1,2 +1,2 @@
-import { AssetModelDefinition } from "../../../index";
-export declare const warehouseAssetDefinition: AssetModelDefinition;
+import { AssetModel } from "../../../index";
+export declare const Warehouse: AssetModel;

package/dist/tests/application/assets/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./Container";
+export * from "./MagicHouse";
 export * from "./Room";
 export * from "./StreetLamp";
 export * from "./Warehouse";

package/dist/tests/application/decoders/DummyTempDecoder.d.ts

@@ -1,15 +1,5 @@
 import { JSONObject } from "kuzzle-sdk";
 import { Decoder, DecodedPayload } from "../../../index";
-export declare const dummyTempDeviceMeasures: readonly [{
-    readonly name: "temperature";
-    readonly type: "temperature";
-}, {
-    readonly name: "accelerationSensor";
-    readonly type: "acceleration";
-}, {
-    readonly name: "battery";
-    readonly type: "battery";
-}];
 export declare class DummyTempDecoder extends Decoder {
     measures: readonly [{
         readonly name: "temperature";

package/dist/tests/application/decoders/DummyTempPositionDecoder.d.ts

@@ -1,15 +1,5 @@
 import { JSONObject } from "kuzzle-sdk";
 import { Decoder, DecodedPayload } from "../../../index";
-export declare const dummyTempPositionDeviceMeasures: readonly [{
-    readonly name: "temperature";
-    readonly type: "temperature";
-}, {
-    readonly name: "battery";
-    readonly type: "battery";
-}, {
-    readonly name: "position";
-    readonly type: "position";
-}];
 export declare class DummyTempPositionDecoder extends Decoder {
     measures: readonly [{
         readonly name: "temperature";

package/dist/tests/application/devices/DummyTemp.d.ts

@@ -0,0 +1,2 @@
+import { DeviceModel } from "../../../index";
+export declare const DummyTemp: DeviceModel;

package/dist/tests/application/devices/DummyTempPosition.d.ts

@@ -0,0 +1,2 @@
+import { DeviceModel } from "../../../index";
+export declare const DummyTempPosition: DeviceModel;

package/dist/tests/application/devices/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./DummyTemp";
+export * from "./DummyTempPosition";

package/dist/tests/application/measures/{AccelerationMeasure.d.ts → Acceleration.d.ts}

@@ -1,4 +1,4 @@
-import { MeasureDefinition } from "lib/modules/measure";
+import { MeasureModel } from "../../../index";
 export type AccelerationMeasurement = {
     acceleration: {
         x: number;
@@ -7,4 +7,4 @@ export type AccelerationMeasurement = {
     };
     accuracy: number;
 };
-export declare const accelerationMeasureDefinition: MeasureDefinition;
+export declare const Acceleration: MeasureModel;

package/dist/tests/application/measures/Brightness.d.ts

@@ -0,0 +1,2 @@
+import { MeasureModel } from "../../../index";
+export declare const Brightness: MeasureModel;

package/dist/tests/application/measures/CO2.d.ts

@@ -0,0 +1,2 @@
+import { MeasureModel } from "../../../index";
+export declare const CO2: MeasureModel;

package/dist/tests/application/measures/Illuminance.d.ts

@@ -0,0 +1,2 @@
+import { MeasureModel } from "../../../index";
+export declare const Illuminance: MeasureModel;

package/dist/tests/application/measures/Magicule.d.ts

@@ -1,5 +1,5 @@
-import { MeasureDefinition } from "lib/modules/measure";
+import { MeasureModel } from "../../../index";
 export type MagiculeMeasurement = {
     magicule: number;
 };
-export declare const magiculeMeasureDefinition: MeasureDefinition;
+export declare const Magicule: MeasureModel;

package/dist/tests/application/measures/PowerConsumption.d.ts

@@ -0,0 +1,2 @@
+import { MeasureModel } from "../../../index";
+export declare const PowerConsumption: MeasureModel;

package/dist/tests/application/measures/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./Acceleration";
+export * from "./Brightness";
+export * from "./CO2";
+export * from "./Illuminance";
+export * from "./Magicule";
+export * from "./PowerConsumption";

package/dist/tests/application/models.d.ts

@@ -0,0 +1,2 @@
+import { DeviceManagerPlugin } from "../../index";
+export declare function registerModels(deviceManager: DeviceManagerPlugin): void;

package/package.json

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

package/dist/tests/application/decoders/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./DummyTempDecoder";
-export * from "./DummyTempPositionDecoder";

package/dist/tests/application/measures/BrightnessMeasure.d.ts

@@ -1,2 +0,0 @@
-import { MeasureDefinition } from "lib/modules/measure";
-export declare const brightnessMeasureDefinition: MeasureDefinition;

package/dist/tests/application/measures/CO2Measure.d.ts

@@ -1,2 +0,0 @@
-import { MeasureDefinition } from "lib/modules/measure";
-export declare const co2MeasureDefinition: MeasureDefinition;

package/dist/tests/application/measures/IlluminanceMeasure.d.ts

@@ -1,2 +0,0 @@
-import { MeasureDefinition } from "lib/modules/measure";
-export declare const illuminanceMeasureDefinition: MeasureDefinition;

package/dist/tests/application/measures/PowerConsumptionMeasure.d.ts

@@ -1,2 +0,0 @@
-import { MeasureDefinition } from "lib/modules/measure";
-export declare const powerConsumptionMeasureDefinition: MeasureDefinition;