kuzzle-device-manager-types 3.0.0-next.6 → 3.0.0-next.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/dist/lib/modules/group/GroupsController.d.ts +5 -1
  2. package/dist/lib/modules/group/GroupsService.d.ts +29 -7
  3. package/dist/lib/modules/group/types/GroupsApi.d.ts +46 -1
  4. package/package.json +1 -1
package/dist/lib/modules/group/GroupsController.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  import { ControllerDefinition, KuzzleRequest } from "kuzzle";
2
2
  import { DeviceManagerPlugin } from "../plugin";
3
- import { ApiGroupAddAssetsResult, ApiGroupAddDevicesResult, ApiGroupCreateResult, ApiGroupDeleteResult, ApiGroupGetResult, ApiGroupListItemsResult, ApiGroupRemoveAssetsResult, ApiGroupRemoveDeviceResult, ApiGroupSearchResult, ApiGroupUpdateResult, GroupsBodyRequest } from "./types/GroupsApi";
3
+ import { ApiGroupAddAssetsResult, ApiGroupAddDevicesResult, ApiGroupCreateResult, ApiGroupDeleteResult, ApiGroupGetResult, ApiGroupListItemsResult, ApiGroupMCreateResult, ApiGroupMUpdateResult, ApiGroupMUpsertResult, ApiGroupRemoveAssetsResult, ApiGroupRemoveDeviceResult, ApiGroupSearchResult, ApiGroupUpdateResult, ApiGroupUpsertResult, GroupsBodyRequest } from "./types/GroupsApi";
4
4
  import { GroupsService } from "./GroupsService";
5
5
  export declare class GroupsController {
6
6
  private plugin;
@@ -20,6 +20,7 @@ export declare class GroupsController {
20
20
  checkGroupName(engineId: string, name: GroupsBodyRequest["name"], assetId?: string): Promise<void>;
21
21
  create(request: KuzzleRequest): Promise<ApiGroupCreateResult>;
22
22
  get(request: KuzzleRequest): Promise<ApiGroupGetResult>;
23
+ upsert(request: KuzzleRequest): Promise<ApiGroupUpsertResult>;
23
24
  update(request: KuzzleRequest): Promise<ApiGroupUpdateResult>;
24
25
  delete(request: KuzzleRequest): Promise<ApiGroupDeleteResult>;
25
26
  search(request: KuzzleRequest): Promise<ApiGroupSearchResult>;
@@ -28,4 +29,7 @@ export declare class GroupsController {
28
29
  removeAsset(request: KuzzleRequest): Promise<ApiGroupRemoveAssetsResult>;
29
30
  addDevice(request: KuzzleRequest): Promise<ApiGroupAddDevicesResult>;
30
31
  removeDevice(request: KuzzleRequest): Promise<ApiGroupRemoveDeviceResult>;
32
+ mCreate(request: KuzzleRequest): Promise<ApiGroupMCreateResult>;
33
+ mUpdate(request: KuzzleRequest): Promise<ApiGroupMUpdateResult>;
34
+ mUpsert(request: KuzzleRequest): Promise<ApiGroupMUpsertResult>;
31
35
  }
package/dist/lib/modules/group/GroupsService.d.ts CHANGED
@@ -1,15 +1,15 @@
1
1
  import { JSONObject, KDocument } from "kuzzle-sdk";
2
2
  import { DeviceManagerPlugin } from "../plugin";
3
- import { BaseService, SearchParams } from "../shared";
3
+ import { BaseService, Metadata, SearchParams } from "../shared";
4
4
  import { KuzzleRequest } from "kuzzle";
5
5
  import { AssetContent } from "../asset/types/AssetContent";
6
- import { GroupContent } from "./exports";
6
+ import { ApiGroupMCreateResult, ApiGroupMUpdateResult, ApiGroupMUpsertResult, GroupContent } from "./exports";
7
7
  import { DeviceContent } from "../device";
8
8
  export declare class GroupsService extends BaseService {
9
9
  constructor(plugin: DeviceManagerPlugin);
10
10
  create(_id: string, engineId: string, metadata: JSONObject, model: string, name: string, path: string, request: KuzzleRequest): Promise<KDocument<GroupContent>>;
11
11
  get(engineId: string, _id: string, request: KuzzleRequest): Promise<KDocument<GroupContent>>;
12
- update(request: KuzzleRequest, _id: string, engineId: string, updateContent: JSONObject): Promise<KDocument<GroupContent>>;
12
+ update(request: KuzzleRequest, _id: string, engineId: string, name?: string, path?: string, metadata?: Metadata): Promise<KDocument<GroupContent>>;
13
13
  delete(_id: string, engineId: string, request: KuzzleRequest): Promise<{
14
14
  _id: string;
15
15
  }>;
@@ -37,7 +37,7 @@ export declare class GroupsService extends BaseService {
37
37
  errors: {
38
38
  document: {
39
39
  _id: string;
40
- _source: JSONObject;
40
+ body: JSONObject;
41
41
  };
42
42
  status: number;
43
43
  reason: string;
@@ -53,7 +53,7 @@ export declare class GroupsService extends BaseService {
53
53
  errors: {
54
54
  document: {
55
55
  _id: string;
56
- _source: JSONObject;
56
+ body: JSONObject;
57
57
  };
58
58
  status: number;
59
59
  reason: string;
@@ -69,7 +69,7 @@ export declare class GroupsService extends BaseService {
69
69
  errors: {
70
70
  document: {
71
71
  _id: string;
72
- _source: JSONObject;
72
+ body: JSONObject;
73
73
  };
74
74
  status: number;
75
75
  reason: string;
@@ -85,10 +85,32 @@ export declare class GroupsService extends BaseService {
85
85
  errors: {
86
86
  document: {
87
87
  _id: string;
88
- _source: JSONObject;
88
+ body: JSONObject;
89
89
  };
90
90
  status: number;
91
91
  reason: string;
92
92
  }[];
93
93
  }>;
94
+ mCreate(engineId: string, groups: Array<{
95
+ _id: string;
96
+ metadata: Metadata;
97
+ model: string;
98
+ name: string;
99
+ path: string;
100
+ }>): Promise<ApiGroupMCreateResult>;
101
+ mUpdate(engineId: string, groups: Array<{
102
+ _id: string;
103
+ metadata: Metadata;
104
+ model: string;
105
+ name: string;
106
+ path: string;
107
+ }>, request: KuzzleRequest): Promise<ApiGroupMUpdateResult>;
108
+ mUpsert(engineId: string, groups: Array<{
109
+ _id: string;
110
+ metadata: Metadata;
111
+ model: string;
112
+ name: string;
113
+ path: string;
114
+ }>, request: KuzzleRequest): Promise<ApiGroupMUpsertResult>;
115
+ private _update;
94
116
  }
package/dist/lib/modules/group/types/GroupsApi.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { JSONObject, KDocument, KHit, SearchResult, mUpdateResponse } from "kuzzle-sdk";
1
+ import { JSONObject, KDocument, KHit, SearchResult, mCreateResponse, mUpdateResponse } from "kuzzle-sdk";
2
2
  import { GroupsBody, GroupContent } from "./GroupContent";
3
3
  import { DeviceContent } from "lib/modules/device";
4
4
  import { AssetContent } from "lib/modules/asset";
@@ -28,6 +28,12 @@ export interface ApiGroupUpdateRequest extends GroupControllerRequest {
28
28
  body: GroupsBodyRequest;
29
29
  }
30
30
  export type ApiGroupUpdateResult = KDocument<GroupContent>;
31
+ export interface ApiGroupUpsertRequest extends GroupControllerRequest {
32
+ action: "upsert";
33
+ _id?: string;
34
+ body: GroupsBodyRequest;
35
+ }
36
+ export type ApiGroupUpsertResult = KDocument<GroupContent>;
31
37
  export interface ApiGroupDeleteRequest extends GroupControllerRequest {
32
38
  action: "delete";
33
39
  _id: string;
@@ -93,4 +99,43 @@ export interface ApiGroupRemoveDeviceRequest extends GroupControllerRequest {
93
99
  };
94
100
  }
95
101
  export type ApiGroupRemoveDeviceResult = UpdateLinkResponse;
102
+ export interface ApiGroupMCreateRequest extends GroupControllerRequest {
103
+ action: "mCreate";
104
+ body: {
105
+ groups: Array<GroupsBodyRequest & {
106
+ _id?: string;
107
+ }>;
108
+ };
109
+ }
110
+ export type ApiGroupMCreateResult = mCreateResponse & {
111
+ successes: Array<{
112
+ _id: string;
113
+ _source: GroupContent;
114
+ created: boolean;
115
+ }>;
116
+ };
117
+ export interface ApiGroupMUpdateRequest extends GroupControllerRequest {
118
+ action: "mUpdate";
119
+ body: {
120
+ groups: Array<GroupsBody & {
121
+ _id: string;
122
+ }>;
123
+ };
124
+ }
125
+ export type ApiGroupMUpdateResult = {
126
+ errors: mUpdateResponse["errors"];
127
+ successes: KDocument<GroupContent>[];
128
+ };
129
+ export interface ApiGroupMUpsertRequest extends GroupControllerRequest {
130
+ action: "mUpsert";
131
+ body: {
132
+ groups: Array<GroupsBody & {
133
+ _id?: string;
134
+ }>;
135
+ };
136
+ }
137
+ export type ApiGroupMUpsertResult = {
138
+ errors: Array<ApiGroupMCreateResult["errors"][0] | ApiGroupMUpdateResult["errors"][0]>;
139
+ successes: Array<ApiGroupMCreateResult["successes"][0] | ApiGroupMUpdateResult["successes"][0]>;
140
+ };
96
141
  export {};
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "kuzzle-device-manager-types",
3
- "version": "3.0.0-next.6",
3
+ "version": "3.0.0-next.7",
4
4
  "description": "Shared types for Kuzzle Device Manager",
5
5
  "author": "The Kuzzle Team (support@kuzzle.io)",
6
6
  "main": "index.js",