@magda/authentication-plugin-sdk 2.0.0-alpha.0 → 2.0.0-alpha.3

package/README.md

@@ -81,12 +81,13 @@ export declare function createOrGetUserToken(
 ): Promise<UserToken>;
 
 /**
- * Join `url` with `baseUrl` if `url` is not an absolute url
+ * Join `url` with `baseUrl` if `url` is not an absolute (full) url string
  *
  * @export
- * @param {string} url
- * @param {string} baseUrl
+ * @param {string} url A full url string or a url path string (/a/b/c).
+ * @param {string} baseUrl A baseUrl used to generate a full url when a url path string is supplied via the `url` parameter.
  * @param {{ [key: string]: string }} [optionalQueries]
+ * @param {string[]} [allowedUrlHosts] Optional; when specify, the host of `url` parameter will only be used if it is included by this list.
  * @returns
  */
 export declare function getAbsoluteUrl(
@@ -94,7 +95,8 @@ export declare function getAbsoluteUrl(
   baseUrl: string,
   optionalQueries?: {
     [key: string]: string;
-  }
+  },
+  allowedUrlHosts?: string[]
 ): string;
 
 export declare function redirectOnSuccess(

package/dist/index.d.ts

@@ -129,18 +129,18 @@ export declare const destroySession: typeof destroySession_2;
 declare function destroySession_2(req: express.Request): Promise<void>;
 
 /**
- * Join `url` with `baseUrl` if `url` is not an absolute url
+ * Join `url` with `baseUrl` if `url` is not an absolute (full) url string
  *
  * @export
- * @param {string} url
- * @param {string} baseUrl
- * @param {{ [key: string]: any }} [optionalQueries] optional extra query parameters to add to the result url.
- * All values supplied will be converted into string before encoded into the url.
+ * @param {string} url A full url string or a url path string (/a/b/c).
+ * @param {string} baseUrl A baseUrl used to generate a full url when a url path string is supplied via the `url` parameter.
+ * @param {{ [key: string]: string }} [optionalQueries]
+ * @param {string[]} [allowedUrlHosts] Optional; when specify, the host of `url` parameter will only be used if it is included by this list.
  * @returns
  */
 export declare function getAbsoluteUrl(url: string, baseUrl: string, optionalQueries?: {
-    [key: string]: any;
-}): string;
+    [key: string]: string;
+}, allowedUrlHosts?: string[]): string;
 
 export declare function getSessionId(req: express.Request, secret?: string): string;