kuzzle-device-manager-types 2.4.0-beta.7 → 2.4.0-beta.8

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 (2) hide show
  1. package/dist/lib/modules/shared/services/BaseService.d.ts +9 -7
  2. package/package.json +1 -1
package/dist/lib/modules/shared/services/BaseService.d.ts CHANGED
@@ -12,6 +12,7 @@ export declare abstract class BaseService {
12
12
  protected get sdk(): EmbeddedSDK;
13
13
  protected get config(): DeviceManagerConfiguration;
14
14
  protected get impersonatedSdk(): (user: User) => EmbeddedSDK;
15
+ protected normalizeKuzzleRequest(request: KuzzleRequest, { collection, engineId }: PayloadRequest): KuzzleRequest;
15
16
  /**
16
17
  * Wrapper to SDK create method with trigger generic:document events
17
18
  *
@@ -21,7 +22,7 @@ export declare abstract class BaseService {
21
22
  * @param {ArgsDocumentControllerCreate} [options]
22
23
  * @returns {Promise<KDocument>}
23
24
  */
24
- protected getDocument<T extends KDocumentContent = KDocumentContent>(request: KuzzleRequest, documentId: string, { engineId, collection }: PayloadRequest, options?: ArgsDocumentControllerCreate): Promise<KDocument<T>>;
25
+ protected getDocument<T extends KDocumentContent = KDocumentContent>(request: KuzzleRequest, documentId: string, { collection, engineId }: PayloadRequest, options?: ArgsDocumentControllerCreate): Promise<KDocument<T>>;
25
26
  /**
26
27
  * Wrapper to SDK create method with trigger generic:document events
27
28
  *
@@ -31,7 +32,7 @@ export declare abstract class BaseService {
31
32
  * @param {ArgsDocumentControllerCreate} [options]
32
33
  * @returns {Promise<KDocument>}
33
34
  */
34
- protected createDocument<T extends KDocumentContent = KDocumentContent>(request: KuzzleRequest, document: KDocument<T>, { engineId, collection }: PayloadRequest, options?: ArgsDocumentControllerCreate): Promise<KDocument<T>>;
35
+ protected createDocument<T extends KDocumentContent = KDocumentContent>(request: KuzzleRequest, document: KDocument<T>, { collection, engineId }: PayloadRequest, options?: ArgsDocumentControllerCreate): Promise<KDocument<T>>;
35
36
  /**
36
37
  * Wrapper to SDK update method with trigger generic:document events
37
38
  *
@@ -41,16 +42,17 @@ export declare abstract class BaseService {
41
42
  * @param {ArgsDocumentControllerUpdate} [options]
42
43
  * @returns {Promise<KDocument>}
43
44
  */
44
- protected updateDocument<T extends KDocumentContent = KDocumentContent>(request: KuzzleRequest, document: KDocument<Partial<T>>, { engineId, collection }: PayloadRequest, options?: ArgsDocumentControllerUpdate): Promise<KDocument<T>>;
45
+ protected updateDocument<T extends KDocumentContent = KDocumentContent>(request: KuzzleRequest, document: KDocument<Partial<T>>, { collection, engineId }: PayloadRequest, options?: ArgsDocumentControllerUpdate): Promise<KDocument<T>>;
45
46
  /**
46
47
  * Wrapper to SDK delete method with trigger generic:document events
47
48
  *
48
49
  * @param {KuzzleRequest} request
49
50
  * @param {string} documentId
51
+ * @param {PayloadRequest} payload
50
52
  * @param {ArgsDocumentControllerUpdate} [options]
51
53
  * @returns {Promise<{ _id: string }>}
52
54
  */
53
- protected deleteDocument(request: KuzzleRequest, documentId: string, { engineId, collection }: PayloadRequest, options?: ArgsDocumentControllerDelete): Promise<{
55
+ protected deleteDocument(request: KuzzleRequest, documentId: string, { collection, engineId }: PayloadRequest, options?: ArgsDocumentControllerDelete): Promise<{
54
56
  _id: string;
55
57
  }>;
56
58
  /**
@@ -58,10 +60,10 @@ export declare abstract class BaseService {
58
60
  * ! Caution the pipes are not applied on next()
59
61
  *
60
62
  * @param {KuzzleRequest} request
61
- * @param {string} documentId
62
63
  * @param {ArgsDocumentControllerUpdate} [options]
63
- * @returns {Promise<{ _id: string }>}
64
+ * @param {PayloadRequest} payload
65
+ * @returns {Promise<SearchResult<KHit>>}
64
66
  */
65
- protected searchDocument<T extends KDocumentContent = KDocumentContent>(request: KuzzleRequest, { from, size, scrollTTL: scroll }: SearchParams, { engineId, collection }: PayloadRequest): Promise<SearchResult<KHit<T>>>;
67
+ protected searchDocument<T extends KDocumentContent = KDocumentContent>(request: KuzzleRequest, { from, size, scrollTTL: scroll }: SearchParams, { collection, engineId }: PayloadRequest): Promise<SearchResult<KHit<T>>>;
66
68
  }
67
69
  export {};
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "kuzzle-device-manager-types",
3
- "version": "2.4.0-beta.7",
3
+ "version": "2.4.0-beta.8",
4
4
  "description": "Shared types for Kuzzle Device Manager",
5
5
  "author": "The Kuzzle Team (support@kuzzle.io)",
6
6
  "main": "index.js",