@magda/utils 5.4.0-alpha.0 → 5.5.0-alpha.0

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import { Arguments } from 'yargs';
+import { QueryDataMap } from 'urijs';
 
 /**
  * Checks to see whether the passed argv has a jwtSecret object. If not,
@@ -107,6 +108,18 @@ declare interface Functor<T> {
     map<U>(f: (t: T) => U): Functor<U>;
 }
 
+/**
+ * Join `url` with `baseUrl` if `url` is not an absolute (full) url string
+ *
+ * @export
+ * @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 {QueryDataMap} [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?: QueryDataMap, allowedUrlHosts?: string[]): string;
+
 export declare function getDefaultRequestInitOptions(): RequestInit;
 
 export declare function getMinikubeIP(): string;

package/dist/index.js

@@ -15706,6 +15706,29 @@ function getStorageApiResourceAccessUrl(resourceUrl, storageApiBaseUrl, datasets
     return resourceUrl;
   }
 }
+
+// ../../magda-typescript-common/dist/getAbsoluteUrl.js
+init_cjs_shim();
+var import_urijs2 = __toESM(require_URI(), 1);
+function getAbsoluteUrl(url2, baseUrl, optionalQueries, allowedUrlHosts) {
+  const uri = (0, import_urijs2.default)(url2);
+  const urlHost = uri.host();
+  if (urlHost) {
+    if (!allowedUrlHosts || allowedUrlHosts.findIndex((item) => item === urlHost) !== -1) {
+      return url2;
+    }
+  }
+  if (typeof baseUrl !== "string") {
+    baseUrl = "";
+  }
+  const baseUri = (0, import_urijs2.default)(baseUrl);
+  const query = uri.search(true);
+  const mergedUri = baseUri.segmentCoded(baseUri.segmentCoded().concat(uri.segmentCoded()));
+  return mergedUri.search({
+    ...query ? query : {},
+    ...optionalQueries ? optionalQueries : {}
+  }).toString();
+}
 export {
   AsyncPage,
   BadRequestError,
@@ -15721,6 +15744,7 @@ export {
   fetchRequest,
   forEachAsync,
   formatServiceError,
+  getAbsoluteUrl,
   getDefaultRequestInitOptions,
   getMinikubeIP,
   getRequest,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@magda/utils",
   "description": "MAGDA Common Utils",
-  "version": "5.4.0-alpha.0",
+  "version": "5.5.0-alpha.0",
   "type": "module",
   "exports": {
     ".": {
@@ -26,7 +26,7 @@
   "module": "dist/index.js",
   "browser": "dist/index-web.js",
   "devDependencies": {
-    "@magda/typescript-common": "^5.4.0-alpha.0",
+    "@magda/typescript-common": "^5.5.0-alpha.0",
     "@microsoft/api-extractor": "~7.39.0",
     "esbuild": "^0.19.10",
     "ts-loader": "^9.5.1",