feat: add options parameter to controller functions containing a query

Author: cyrng

src/controllers/Auth.ts

@@ -437,7 +437,8 @@ export class AuthController extends BaseController {
   login(
     strategy: string,
     credentials: JSONObject,
-    expiresIn?: string | number
+    expiresIn?: string | number,
+    options: ArgsAuthControllerLogin = {}
   ): Promise<string> {
     const request = {
       action: "login",
@@ -448,7 +449,7 @@ export class AuthController extends BaseController {
     };
 
     this.kuzzle.emit("beforeLogin");
-    return this.query(request, { queuable: false, timeout: -1, verb: "POST" })
+    return this.query(request, { queuable: false, timeout: -1, verb: "POST", ...options })
       .then((response) => {
         if (this.kuzzle.cookieAuthentication) {
           if (response.result.jwt) {
@@ -497,13 +498,14 @@ export class AuthController extends BaseController {
    *
    * @see https://docs.kuzzle.io/sdk/js/7/controllers/auth/logout
    */
-  async logout(): Promise<void> {
+  async logout(options: ArgsAuthControllerLogin = {}): Promise<void> {
     this.kuzzle.emit("beforeLogout");
     try {
       await this.query(
         {
           action: "logout",
           cookieAuth: this.kuzzle.cookieAuthentication,
+          ...options
         },
         { queuable: false, timeout: -1 }
       );
@@ -700,6 +702,10 @@ export type ArgsAuthControllerUpdateSelf = ArgsDefault;
 
 export type ArgsAuthControllerValidateMyCredentials = ArgsDefault;
 
+export type ArgsAuthControllerLogin = ArgsDefault;
+
+export type ArgsAuthControllerLogout = ArgsDefault;
+
 export interface ArgsAuthControllerRefreshToken extends ArgsDefault {
   expiresIn?: number | string;
 }

src/controllers/Security.ts

@@ -515,11 +515,11 @@ export class SecurityController extends BaseController {
     );
   }
 
-  refresh(collection) {
+  refresh(collection, options: ArgsSecurityControllerRefresh = {}) {
     return this.query({
       action: "refresh",
       collection,
-    });
+    }, options);
   }
 
   replaceUser(_id, body, options: ArgsSecurityControllerReplaceUser = {}) {
@@ -809,3 +809,5 @@ export type ArgsSecurityControllerUpdateUser = ArgsDefault;
 export type ArgsSecurityControllerUpdateUserMapping = ArgsDefault;
 
 export type ArgsSecurityControllerValidateCredentials = ArgsDefault;
+
+export type ArgsSecurityControllerRefresh = ArgsDefault;