kuzzle-device-manager-types 2.2.7 → 2.3.2

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

@@ -3,5 +3,6 @@ export declare class AssetModule extends Module {
     private assetService;
     private assetHistoryService;
     private assetController;
+    private assetGroupsController;
     init(): Promise<void>;
 }

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

@@ -0,0 +1,20 @@
+import { ControllerDefinition, KuzzleRequest } from "kuzzle";
+import { DeviceManagerPlugin } from "../plugin";
+import { ApiGroupAddAssetsResult, ApiGroupCreateResult, ApiGroupDeleteResult, ApiGroupGetResult, ApiGroupRemoveAssetsResult, ApiGroupSearchResult, ApiGroupUpdateResult, AssetsGroupsBodyRequest } from "./types/AssetGroupsApi";
+export declare class AssetsGroupsController {
+    private plugin;
+    definition: ControllerDefinition;
+    constructor(plugin: DeviceManagerPlugin);
+    private get sdk();
+    private get as();
+    checkParent(engineId: string, parent: AssetsGroupsBodyRequest["parent"]): Promise<void>;
+    checkChildren(engineId: string, children: AssetsGroupsBodyRequest["children"]): Promise<void>;
+    checkGroupName(engineId: string, name: AssetsGroupsBodyRequest["name"], assetId?: string): Promise<void>;
+    create(request: KuzzleRequest): Promise<ApiGroupCreateResult>;
+    get(request: KuzzleRequest): Promise<ApiGroupGetResult>;
+    update(request: KuzzleRequest): Promise<ApiGroupUpdateResult>;
+    delete(request: KuzzleRequest): Promise<ApiGroupDeleteResult>;
+    search(request: KuzzleRequest): Promise<ApiGroupSearchResult>;
+    addAsset(request: KuzzleRequest): Promise<ApiGroupAddAssetsResult>;
+    removeAsset(request: KuzzleRequest): Promise<ApiGroupRemoveAssetsResult>;
+}

package/dist/lib/modules/asset/collections/assetsGroupsMapping.d.ts

@@ -0,0 +1,2 @@
+import { CollectionMappings } from "kuzzle";
+export declare const assetGroupsMappings: CollectionMappings;

package/dist/lib/modules/asset/collections/assetsMappings.d.ts

@@ -1,52 +1,7 @@
+import { CollectionMappings } from "kuzzle";
 /**
  * Base mappings for the "assets" collection.
  *
  * Those mappings does not contains the `measures` and `metadata` mappings.
  */
-export declare const assetsMappings: {
-    dynamic: string;
-    properties: {
-        model: {
-            type: string;
-            fields: {
-                text: {
-                    type: string;
-                };
-            };
-        };
-        reference: {
-            type: string;
-            fields: {
-                text: {
-                    type: string;
-                };
-            };
-        };
-        metadata: {
-            properties: {};
-        };
-        measures: {
-            properties: {};
-        };
-        linkedDevices: {
-            properties: {
-                _id: {
-                    type: string;
-                };
-                measureNames: {
-                    properties: {
-                        asset: {
-                            type: string;
-                        };
-                        device: {
-                            type: string;
-                        };
-                        type: {
-                            type: string;
-                        };
-                    };
-                };
-            };
-        };
-    };
-};
+export declare const assetsMappings: CollectionMappings;

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

@@ -2,7 +2,11 @@ export * from "./types/AssetContent";
 export * from "./types/AssetHistoryContent";
 export * from "./types/AssetEvents";
 export * from "./types/AssetApi";
+export * from "./types/AssetGroupContent";
+export * from "./types/AssetGroupsApi";
 export * from "./roles/RoleAssetsAdmin";
 export * from "./roles/RoleAssetsReader";
+export * from "./roles/RoleAssetsGroupsAdmin";
+export * from "./roles/RoleAssetsGroupsReader";
 export * from "./collections/assetsMappings";
 export * from "./collections/assetsHistoryMappings";

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

@@ -1,5 +1,6 @@
 export * from "./collections/assetsMappings";
 export * from "./collections/assetsHistoryMappings";
+export * from "./collections/assetsGroupsMapping";
 export * from "./types/AssetContent";
 export * from "./types/AssetHistoryContent";
 export * from "./types/AssetEvents";
@@ -8,3 +9,5 @@ export * from "./model/AssetSerializer";
 export * from "./AssetModule";
 export * from "./roles/RoleAssetsAdmin";
 export * from "./roles/RoleAssetsReader";
+export * from "./roles/RoleAssetsGroupsAdmin";
+export * from "./roles/RoleAssetsGroupsReader";

package/dist/lib/modules/asset/roles/RoleAssetsGroupsAdmin.d.ts

@@ -0,0 +1,24 @@
+import { KuzzleRole } from "../../shared/types/KuzzleRole";
+/**
+ * This role allows to manage assets and their models.
+ *
+ * It's a tenant role.
+ *
+ * @example
+ *
+    "device-manager/assets": {
+      actions: {
+        "*": true,
+      },
+    },
+    "device-manager/models": {
+      actions: {
+        deleteAsset: true,
+        listAssets: true,
+        getAsset: true,
+        writeAsset: true,
+        listMeasures: true,
+      },
+    },
+ */
+export declare const RoleAssetsGroupsAdmin: KuzzleRole;

package/dist/lib/modules/asset/roles/RoleAssetsGroupsReader.d.ts

@@ -0,0 +1,24 @@
+import { KuzzleRole } from "../../shared/types/KuzzleRole";
+/**
+ * This role allows to manage assets and their models.
+ *
+ * It's a tenant role.
+ *
+ * @example
+ *
+    "device-manager/assets": {
+      actions: {
+        "*": true,
+      },
+    },
+    "device-manager/models": {
+      actions: {
+        deleteAsset: true,
+        listAssets: true,
+        getAsset: true,
+        writeAsset: true,
+        listMeasures: true,
+      },
+    },
+ */
+export declare const RoleAssetsGroupsReader: KuzzleRole;

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

@@ -29,6 +29,13 @@ export interface AssetContent<TMeasures extends JSONObject = any, TMetadata exte
             type: string;
         }>;
     }>;
+    /**
+     * Id's of asset groups
+     */
+    groups: Array<{
+        id: string;
+        date: number;
+    }>;
 }
 /**
  * Asset description used to contextualize each measure data point

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

@@ -0,0 +1,8 @@
+import { KDocumentContent } from "kuzzle-sdk";
+export interface AssetsGroupsBody {
+    name: string;
+    children: string[];
+    parent: string | null;
+    lastUpdate: number;
+}
+export type AssetsGroupContent = AssetsGroupsBody & KDocumentContent;

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

@@ -0,0 +1,59 @@
+import { JSONObject, KDocument, KHit, SearchResult, mUpdateResponse } from "kuzzle-sdk";
+import { AssetsGroupsBody, AssetsGroupContent } from "./AssetGroupContent";
+type AssetsGroupsRequest = Omit<AssetsGroupsBody, "lastUpdate">;
+export type AssetsGroupsBodyRequest = Partial<AssetsGroupsRequest> & Omit<AssetsGroupsRequest, "parent">;
+export type UpdateAssetLinkResponse = mUpdateResponse & {
+    assetsGroups: KDocument<AssetsGroupContent>;
+};
+interface GroupControllerRequest {
+    controller: "device-manager/assetsGroup";
+    engineId: string;
+}
+export interface ApiGroupCreateRequest extends GroupControllerRequest {
+    action: "create";
+    _id?: string;
+    body: Omit<AssetsGroupsBodyRequest, "children">;
+}
+export type ApiGroupCreateResult = KDocument<AssetsGroupContent>;
+export interface ApiGroupGetRequest extends GroupControllerRequest {
+    action: "get";
+    _id: string;
+}
+export type ApiGroupGetResult = KDocument<AssetsGroupContent>;
+export interface ApiGroupUpdateRequest extends GroupControllerRequest {
+    action: "update";
+    _id: string;
+    body: AssetsGroupsBodyRequest;
+}
+export type ApiGroupUpdateResult = KDocument<AssetsGroupContent>;
+export interface ApiGroupDeleteRequest extends GroupControllerRequest {
+    action: "delete";
+    _id: string;
+}
+export type ApiGroupDeleteResult = void;
+export interface ApiGroupSearchRequest extends GroupControllerRequest {
+    action: "search";
+    from?: number;
+    size?: number;
+    scrollTTL?: string;
+    lang?: "koncorde" | "elasticsearch";
+    body: JSONObject;
+}
+export type ApiGroupSearchResult = SearchResult<KHit<AssetsGroupContent>>;
+export interface ApiGroupAddAssetsRequest extends GroupControllerRequest {
+    action: "addAsset";
+    _id: string;
+    body: {
+        assetIds: string[];
+    };
+}
+export type ApiGroupAddAssetsResult = UpdateAssetLinkResponse;
+export interface ApiGroupRemoveAssetsRequest extends GroupControllerRequest {
+    action: "removeAsset";
+    _id: string;
+    body: {
+        assetIds: string[];
+    };
+}
+export type ApiGroupRemoveAssetsResult = UpdateAssetLinkResponse;
+export {};

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

@@ -53,6 +53,7 @@ export declare class MeasureExporter {
      * the stream.
      */
     sendExport(stream: PassThrough, exportId: string): Promise<void>;
+    private generateMeasureColumns;
     getExport(exportId: string): Promise<ExportParams>;
     private exportRedisKey;
     private prepareMeasureSearch;

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

@@ -1,4 +1,4 @@
-import { AssetModelContent, DeviceModelContent } from "./ModelContent";
+import { AssetModelContent, DeviceModelContent, MeasureModelContent } from "./ModelContent";
 export type AskModelAssetGet = {
     name: "ask:device-manager:model:asset:get";
     payload: {
@@ -14,3 +14,10 @@ export type AskModelDeviceGet = {
     };
     result: DeviceModelContent;
 };
+export type AskModelMeasureGet = {
+    name: "ask:device-manager:model:measure:get";
+    payload: {
+        type: string;
+    };
+    result: MeasureModelContent;
+};

package/dist/lib/modules/plugin/DeviceManagerEngine.d.ts

@@ -32,6 +32,7 @@ export declare class DeviceManagerEngine extends AbstractEngine<DeviceManagerPlu
     }>;
     createAssetsCollection(engineId: string, engineGroup: string): Promise<InternalCollection>;
     createAssetsHistoryCollection(engineId: string, engineGroup: string): Promise<InternalCollection>;
+    createAssetsGroupsCollection(engineId: string): Promise<InternalCollection>;
     private getDigitalTwinMappings;
     createDevicesCollection(engineId: string): Promise<InternalCollection>;
     createMeasuresCollection(engineId: string, engineGroup: string): Promise<InternalCollection>;

package/dist/lib/modules/plugin/types/InternalCollection.d.ts

@@ -1,6 +1,7 @@
 export declare enum InternalCollection {
     ASSETS = "assets",
     ASSETS_HISTORY = "assets-history",
+    ASSETS_GROUPS = "assets-groups",
     DEVICES = "devices",
     MEASURES = "measures",
     MODELS = "models",

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

@@ -4,6 +4,9 @@ export declare class DummyTempDecoder extends Decoder {
     measures: readonly [{
         readonly name: "temperature";
         readonly type: "temperature";
+    }, {
+        readonly name: "accelerationSensor";
+        readonly type: "acceleration";
     }, {
         readonly name: "battery";
         readonly type: "battery";

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

@@ -0,0 +1,10 @@
+import { MeasureDefinition } from "lib/modules/measure";
+export type AccelerationMeasurement = {
+    acceleration: {
+        x: number;
+        y: number;
+        z: number;
+    };
+    accuracy: number;
+};
+export declare const accelerationMeasureDefinition: MeasureDefinition;

package/index.js

@@ -0,0 +1,2 @@
+// noop
+//? empty file just to fix resolver strange behavior (CF: https://github.com/vitejs/vite/issues/12446)

package/package.json

@@ -1,20 +1,19 @@
 {
   "name": "kuzzle-device-manager-types",
-  "version": "2.2.7",
+  "version": "2.3.2",
   "description": "Shared types for Kuzzle Device Manager",
   "author": "The Kuzzle Team (support@kuzzle.io)",
+  "main": "index.js",
   "types": "dist/index.d.ts",
   "repository": {
     "type": "git",
-    "url": "https://github.com/kuzzleio/kuzzle-plugin-device-manager"
+    "url": "git+https://github.com/kuzzleio/kuzzle-plugin-device-manager.git"
   },
   "scripts": {
     "prepack": "npm run build",
-    "build": "npm --prefix ../ run build && cp -r ../dist/ . && node scripts/copy-version.js"
+    "build": "./copy-types.sh && node scripts/copy-version.js"
   },
   "license": "Apache-2.0",
-  "dependencies": {},
-  "devDependencies": {},
   "files": [
     "dist/**/*.d.ts"
   ]