kuzzle-device-manager-types 3.0.0-next.4 → 3.0.0-next.5

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

@@ -30,7 +30,7 @@ export interface AssetContent<TMeasures extends JSONObject = any, TMetadata exte
         }>;
     }>;
     /**
-     * Id's of asset groups
+     * Path's of asset groups
      */
     groups: Array<{
         path: string;

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

@@ -11,4 +11,11 @@ export interface DeviceContent<TMeasures extends JSONObject = any, TMetadata ext
     /**
      */
     engineId: string;
+    /**
+     * Path's of device's groups
+     */
+    groups: Array<{
+        path: string;
+        date: number;
+    }>;
 }

package/dist/lib/modules/group/GroupsController.d.ts

@@ -1,6 +1,6 @@
 import { ControllerDefinition, KuzzleRequest } from "kuzzle";
 import { DeviceManagerPlugin } from "../plugin";
-import { ApiGroupAddAssetsResult, ApiGroupCreateResult, ApiGroupDeleteResult, ApiGroupGetResult, ApiGroupRemoveAssetsResult, ApiGroupSearchResult, ApiGroupUpdateResult, GroupsBodyRequest } from "./types/GroupsApi";
+import { ApiGroupAddAssetsResult, ApiGroupAddDevicesResult, ApiGroupCreateResult, ApiGroupDeleteResult, ApiGroupGetResult, ApiGroupListItemsResult, ApiGroupRemoveAssetsResult, ApiGroupRemoveDeviceResult, ApiGroupSearchResult, ApiGroupUpdateResult, GroupsBodyRequest } from "./types/GroupsApi";
 import { GroupsService } from "./GroupsService";
 export declare class GroupsController {
     private plugin;
@@ -23,6 +23,9 @@ export declare class GroupsController {
     update(request: KuzzleRequest): Promise<ApiGroupUpdateResult>;
     delete(request: KuzzleRequest): Promise<ApiGroupDeleteResult>;
     search(request: KuzzleRequest): Promise<ApiGroupSearchResult>;
+    listItems(request: KuzzleRequest): Promise<ApiGroupListItemsResult>;
     addAsset(request: KuzzleRequest): Promise<ApiGroupAddAssetsResult>;
     removeAsset(request: KuzzleRequest): Promise<ApiGroupRemoveAssetsResult>;
+    addDevice(request: KuzzleRequest): Promise<ApiGroupAddDevicesResult>;
+    removeDevice(request: KuzzleRequest): Promise<ApiGroupRemoveDeviceResult>;
 }

package/dist/lib/modules/group/GroupsService.d.ts

@@ -2,7 +2,9 @@ import { JSONObject, KDocument } from "kuzzle-sdk";
 import { DeviceManagerPlugin } from "../plugin";
 import { BaseService, SearchParams } from "../shared";
 import { KuzzleRequest } from "kuzzle";
+import { AssetContent } from "../asset/types/AssetContent";
 import { GroupContent } from "./exports";
+import { DeviceContent } from "../device";
 export declare class GroupsService extends BaseService {
     constructor(plugin: DeviceManagerPlugin);
     create(_id: string, engineId: string, metadata: JSONObject, model: string, name: string, path: string, request: KuzzleRequest): Promise<KDocument<GroupContent>>;
@@ -12,6 +14,19 @@ export declare class GroupsService extends BaseService {
         _id: string;
     }>;
     search(engineId: string, searchParams: SearchParams, request: KuzzleRequest): Promise<import("kuzzle-sdk").SearchResult<import("kuzzle-sdk").KHit<GroupContent>>>;
+    listItems(engineId: string, _id: string, includeChildren: boolean, options: {
+        from?: number;
+        size?: number;
+    }, request: KuzzleRequest): Promise<{
+        assets: {
+            hits: import("kuzzle-sdk").KHit<AssetContent<any, any>>[];
+            total: number;
+        };
+        devices: {
+            hits: import("kuzzle-sdk").KHit<DeviceContent<any, any>>[];
+            total: number;
+        };
+    }>;
     addAsset(engineId: string, path: string, assetIds: string[], request: KuzzleRequest): Promise<{
         group: KDocument<GroupContent>;
         successes: {
@@ -44,4 +59,36 @@ export declare class GroupsService extends BaseService {
             reason: string;
         }[];
     }>;
+    addDevice(engineId: string, path: string, deviceIds: string[], request: KuzzleRequest): Promise<{
+        group: KDocument<GroupContent>;
+        successes: {
+            _id: string;
+            _source: JSONObject;
+            _version: number;
+        }[];
+        errors: {
+            document: {
+                _id: string;
+                _source: JSONObject;
+            };
+            status: number;
+            reason: string;
+        }[];
+    }>;
+    removeDevice(engineId: string, path: string, deviceIds: string[], request: KuzzleRequest): Promise<{
+        group: KDocument<GroupContent>;
+        successes: {
+            _id: string;
+            _source: JSONObject;
+            _version: number;
+        }[];
+        errors: {
+            document: {
+                _id: string;
+                _source: JSONObject;
+            };
+            status: number;
+            reason: string;
+        }[];
+    }>;
 }

package/dist/lib/modules/group/types/GroupsApi.d.ts

@@ -1,8 +1,10 @@
 import { JSONObject, KDocument, KHit, SearchResult, mUpdateResponse } from "kuzzle-sdk";
 import { GroupsBody, GroupContent } from "./GroupContent";
+import { DeviceContent } from "lib/modules/device";
+import { AssetContent } from "lib/modules/asset";
 type GroupsRequest = Omit<GroupsBody, "lastUpdate">;
 export type GroupsBodyRequest = Partial<GroupsRequest>;
-export type UpdateAssetLinkResponse = mUpdateResponse & {
+export type UpdateLinkResponse = mUpdateResponse & {
     group: KDocument<GroupContent>;
 };
 interface GroupControllerRequest {
@@ -40,6 +42,25 @@ export interface ApiGroupSearchRequest extends GroupControllerRequest {
     body: JSONObject;
 }
 export type ApiGroupSearchResult = SearchResult<KHit<GroupContent>>;
+export interface ApiGroupListItemsRequest extends GroupControllerRequest {
+    action: "listItems";
+    from?: number;
+    size?: number;
+    body: {
+        includeChildren?: boolean;
+    };
+    _id: string;
+}
+export type ApiGroupListItemsResult = {
+    assets: {
+        hits: Array<KHit<AssetContent>>;
+        total: number;
+    };
+    devices: {
+        hits: Array<KHit<DeviceContent>>;
+        total: number;
+    };
+};
 export interface ApiGroupAddAssetsRequest extends GroupControllerRequest {
     action: "addAsset";
     body: {
@@ -47,7 +68,7 @@ export interface ApiGroupAddAssetsRequest extends GroupControllerRequest {
         assetIds: string[];
     };
 }
-export type ApiGroupAddAssetsResult = UpdateAssetLinkResponse;
+export type ApiGroupAddAssetsResult = UpdateLinkResponse;
 export interface ApiGroupRemoveAssetsRequest extends GroupControllerRequest {
     action: "removeAsset";
     body: {
@@ -55,5 +76,21 @@ export interface ApiGroupRemoveAssetsRequest extends GroupControllerRequest {
         assetIds: string[];
     };
 }
-export type ApiGroupRemoveAssetsResult = UpdateAssetLinkResponse;
+export type ApiGroupRemoveAssetsResult = UpdateLinkResponse;
+export interface ApiGroupAddDeviceRequest extends GroupControllerRequest {
+    action: "addDevice";
+    body: {
+        path: string;
+        deviceIds: string[];
+    };
+}
+export type ApiGroupAddDevicesResult = UpdateLinkResponse;
+export interface ApiGroupRemoveDeviceRequest extends GroupControllerRequest {
+    action: "removeDevice";
+    body: {
+        path: string;
+        deviceIds: string[];
+    };
+}
+export type ApiGroupRemoveDeviceResult = UpdateLinkResponse;
 export {};

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

@@ -10,12 +10,13 @@ export declare class ModelService extends BaseService {
     constructor(plugin: DeviceManagerPlugin);
     registerAskEvents(): void;
     private checkModelsConflicts;
+    private checkDefaultValues;
+    private checkGroupAffinity;
     writeAsset(engineGroup: string, model: string, metadataMappings: MetadataMappings, defaultMetadata: JSONObject, metadataDetails: MetadataDetails, metadataGroups: MetadataGroups, measures: NamedMeasures, tooltipModels: TooltipModels, locales: {
         [valueName: string]: LocaleDetails;
     }): Promise<KDocument<AssetModelContent>>;
-    private checkDefaultValues;
     writeDevice(model: string, metadataMappings: MetadataMappings, defaultMetadata: JSONObject, metadataDetails: MetadataDetails, metadataGroups: MetadataGroups, measures: NamedMeasures): Promise<KDocument<DeviceModelContent>>;
-    writeGroup(engineGroup: string, model: string, metadataMappings: MetadataMappings, defaultMetadata: JSONObject, metadataDetails: MetadataDetails, metadataGroups: MetadataGroups): Promise<KDocument<GroupModelContent>>;
+    writeGroup(engineGroup: string, model: string, affinity: JSONObject, metadataMappings: MetadataMappings, defaultMetadata: JSONObject, metadataDetails: MetadataDetails, metadataGroups: MetadataGroups): Promise<KDocument<GroupModelContent>>;
     writeMeasure(type: string, valuesMappings: JSONObject, validationSchema?: SchemaObject, valuesDetails?: MeasureValuesDetails, locales?: {
         [valueName: string]: LocaleDetails;
     }): Promise<KDocument<MeasureModelContent>>;

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

@@ -1,7 +1,7 @@
 import { DeviceManagerPlugin } from "../plugin";
 import { NamedMeasures } from "../decoder";
 import { MeasureDefinition } from "../measure";
-import { LocaleDetails, MetadataDetails, MetadataGroups, MetadataMappings, TooltipModels } from "./types/ModelContent";
+import { GroupAffinity, LocaleDetails, MetadataDetails, MetadataGroups, MetadataMappings, TooltipModels } from "./types/ModelContent";
 import { JSONObject } from "kuzzle-sdk";
 export declare class ModelsRegister {
     private config;
@@ -47,13 +47,14 @@ export declare class ModelsRegister {
      *
      * @param engineGroup - The engine group name.
      * @param model - The name of the group model, which must be in PascalCase.
+     * @param affinity - The type of object accepted and their model affinity.
      * @param metadataMappings - The metadata mappings for the model, defaults to an empty object.
      * @param defaultMetadata - The default metadata values for the model, defaults to an empty object.
      * @param metadataDetails - Optional detailed metadata descriptions, localizations and definition.
      * @param metadataGroups - Optional groups for organizing metadata, with localizations.
      * @throws PluginImplementationError if the model name is not in PascalCase.
      */
-    registerGroup(engineGroup: string, model: string, metadataMappings?: MetadataMappings, defaultMetadata?: JSONObject, metadataDetails?: MetadataDetails, metadataGroups?: MetadataGroups): void;
+    registerGroup(engineGroup: string, model: string, affinity: GroupAffinity, metadataMappings?: MetadataMappings, defaultMetadata?: JSONObject, metadataDetails?: MetadataDetails, metadataGroups?: MetadataGroups): void;
     registerMeasure(type: string, measureDefinition: MeasureDefinition): void;
     private load;
 }

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

@@ -1,5 +1,5 @@
 import { JSONObject, KDocument, KHit, SearchResult } from "kuzzle-sdk";
-import { AssetModelContent, DeviceModelContent, GroupModelContent, LocaleDetails, MeasureModelContent, MetadataDetails, MetadataGroups, MetadataMappings, TooltipModels } from "./ModelContent";
+import { AssetModelContent, DeviceModelContent, GroupAffinity, GroupModelContent, LocaleDetails, MeasureModelContent, MetadataDetails, MetadataGroups, MetadataMappings, TooltipModels } from "./ModelContent";
 import { SchemaObject } from "ajv";
 import { MeasureValuesDetails } from "../../measure/types/MeasureDefinition";
 interface ModelsControllerRequest {
@@ -58,6 +58,7 @@ export type ApiModelWriteDeviceResult = KDocument<DeviceModelContent>;
 export interface ApiModelWriteGroupRequest extends ModelsControllerRequest {
     action: "writeGroup";
     body: {
+        affinity: GroupAffinity;
         engineGroup: string;
         model: string;
         metadataDetails?: MetadataDetails;

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

@@ -23,6 +23,23 @@ export interface MetadataObject {
 export interface MetadataMappings {
     [key: string]: MetadataProperty | MetadataObject;
 }
+export interface GroupAffinity {
+    /**
+     * Type of elements accepted in the group
+     */
+    type: Array<"assets" | "devices">;
+    /**
+     * Models accepted in the group
+     */
+    models: {
+        assets?: string[];
+        devices?: string[];
+    };
+    /**
+     * Weather the affinities are a strict restriction or not
+     */
+    strict: boolean;
+}
 export interface LocaleDetails {
     friendlyName: string;
     description: string;
@@ -370,6 +387,10 @@ export interface GroupModelContent extends KDocumentContent {
          * Name of the model
          */
         model: string;
+        /**
+         * Group types and model affinities
+         */
+        affinity: GroupAffinity;
         /**
          * Metadata mappings.
          *

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

@@ -1,6 +1,6 @@
 import { JSONObject } from "kuzzle-sdk";
 import { Decoder, NamedMeasures } from "../../../modules/decoder";
-import { LocaleDetails, MetadataDetails, MetadataGroups, MetadataMappings, TooltipModels } from "./ModelContent";
+import { GroupAffinity, LocaleDetails, MetadataDetails, MetadataGroups, MetadataMappings, TooltipModels } from "./ModelContent";
 /**
  * Define an asset model
  *
@@ -279,6 +279,10 @@ export type DeviceModelDefinition = {
  *
  */
 export type GroupModelDefinition = {
+    /**
+     * Metadata mappings definition
+     */
+    affinity: GroupAffinity;
     /**
      * Metadata mappings definition
      */

package/dist/tests/application/groups/AssetRestricted.d.ts

@@ -0,0 +1,8 @@
+import { GroupContent } from "lib/modules/group/exports";
+import { GroupModel } from "lib/modules/shared";
+declare const modelName = "AssetRestricted";
+export interface AssetRestrictedContent extends GroupContent {
+    model: typeof modelName;
+}
+export declare const AssetRestricted: GroupModel;
+export {};

package/dist/tests/application/groups/DeviceRestricted.d.ts

@@ -0,0 +1,8 @@
+import { GroupContent } from "lib/modules/group/exports";
+import { GroupModel } from "lib/modules/shared";
+declare const modelName = "DeviceRestricted";
+export interface DeviceRestrictedContent extends GroupContent {
+    model: typeof modelName;
+}
+export declare const DeviceRestricted: GroupModel;
+export {};

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

@@ -1 +1,3 @@
 export * from "./Parking";
+export * from "./AssetRestricted";
+export * from "./DeviceRestricted";

package/package.json

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