@magda/typescript-common 1.2.2-alpha.0 → 1.3.1-rc.0

package/dist/ServerError.d.ts

@@ -0,0 +1,9 @@
+export default class ServerError extends Error {
+    statusCode: number;
+    constructor(message?: string, statusCode?: number);
+    toData(): {
+        isError: boolean;
+        errorCode: number;
+        errorMessage: string;
+    };
+}

package/dist/ServerError.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class ServerError extends Error {
+    constructor(message = "Unknown Error", statusCode = 500) {
+        super(message);
+        this.statusCode = statusCode;
+    }
+    toData() {
+        return {
+            isError: true,
+            errorCode: this.statusCode,
+            errorMessage: this.message
+        };
+    }
+}
+exports.default = ServerError;
+//# sourceMappingURL=ServerError.js.map

package/dist/ServerError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ServerError.js","sourceRoot":"","sources":["../src/ServerError.ts"],"names":[],"mappings":";;AAAA,MAAqB,WAAY,SAAQ,KAAK;IAG1C,YAAY,UAAkB,eAAe,EAAE,aAAqB,GAAG;QACnE,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IACjC,CAAC;IAED,MAAM;QACF,OAAO;YACH,OAAO,EAAE,IAAI;YACb,SAAS,EAAE,IAAI,CAAC,UAAU;YAC1B,YAAY,EAAE,IAAI,CAAC,OAAO;SAC7B,CAAC;IACN,CAAC;CACJ;AAfD,8BAeC"}

package/dist/getAbsoluteUrl.d.ts

@@ -1,12 +1,13 @@
 /**
- * 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 default function getAbsoluteUrl(url: string, baseUrl: string, optionalQueries?: {
     [key: string]: string;
-}): string;
+}, allowedUrlHosts?: string[]): string;

package/dist/getAbsoluteUrl.js

@@ -5,31 +5,35 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const urijs_1 = __importDefault(require("urijs"));
 /**
- * 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
  */
-function getAbsoluteUrl(url, baseUrl, optionalQueries) {
+function getAbsoluteUrl(url, baseUrl, optionalQueries, allowedUrlHosts) {
     const uri = urijs_1.default(url);
-    if (uri.hostname()) {
-        // --- absolute url, return directly
-        return url;
-    }
-    else {
-        if (typeof baseUrl !== "string") {
-            baseUrl = "";
+    const urlHost = uri.host();
+    if (urlHost) {
+        // --- absolute url, return directly only if the urlHost is included by `allowedUrlHosts` (unless `allowedUrlHosts` is not supplied)
+        if (!allowedUrlHosts ||
+            allowedUrlHosts.findIndex((item) => item === urlHost) !== -1) {
+            return url;
         }
-        const baseUri = urijs_1.default(baseUrl);
-        const query = uri.search(true);
-        const mergedUri = baseUri.segmentCoded(baseUri.segmentCoded().concat(uri.segmentCoded()));
-        return mergedUri
-            .search(Object.assign(Object.assign({}, (query ? query : {})), (optionalQueries ? optionalQueries : {})))
-            .toString();
     }
+    // ignore url host of `host` if any and use `baseUrl` to create the final full url string
+    if (typeof baseUrl !== "string") {
+        baseUrl = "";
+    }
+    const baseUri = urijs_1.default(baseUrl);
+    const query = uri.search(true);
+    const mergedUri = baseUri.segmentCoded(baseUri.segmentCoded().concat(uri.segmentCoded()));
+    return mergedUri
+        .search(Object.assign(Object.assign({}, (query ? query : {})), (optionalQueries ? optionalQueries : {})))
+        .toString();
 }
 exports.default = getAbsoluteUrl;
 //# sourceMappingURL=getAbsoluteUrl.js.map

package/dist/getAbsoluteUrl.js.map

@@ -1 +1 @@
-{"version":3,"file":"getAbsoluteUrl.js","sourceRoot":"","sources":["../src/getAbsoluteUrl.ts"],"names":[],"mappings":";;;;;AAAA,kDAA0B;AAE1B;;;;;;;;GAQG;AACH,SAAwB,cAAc,CAClC,GAAW,EACX,OAAe,EACf,eAA2C;IAE3C,MAAM,GAAG,GAAG,eAAK,CAAC,GAAG,CAAC,CAAC;IACvB,IAAI,GAAG,CAAC,QAAQ,EAAE,EAAE;QAChB,oCAAoC;QACpC,OAAO,GAAG,CAAC;KACd;SAAM;QACH,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;YAC7B,OAAO,GAAG,EAAE,CAAC;SAChB;QACD,MAAM,OAAO,GAAG,eAAK,CAAC,OAAO,CAAC,CAAC;QAC/B,MAAM,KAAK,GAAG,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAC/B,MAAM,SAAS,GAAG,OAAO,CAAC,YAAY,CAClC,OAAO,CAAC,YAAY,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,YAAY,EAAE,CAAC,CACpD,CAAC;QAEF,OAAO,SAAS;aACX,MAAM,iCACA,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,GACpB,CAAC,eAAe,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC,EAC7C;aACD,QAAQ,EAAE,CAAC;KACnB;AACL,CAAC;AA1BD,iCA0BC"}
+{"version":3,"file":"getAbsoluteUrl.js","sourceRoot":"","sources":["../src/getAbsoluteUrl.ts"],"names":[],"mappings":";;;;;AAAA,kDAA0B;AAE1B;;;;;;;;;GASG;AACH,SAAwB,cAAc,CAClC,GAAW,EACX,OAAe,EACf,eAA2C,EAC3C,eAA0B;IAE1B,MAAM,GAAG,GAAG,eAAK,CAAC,GAAG,CAAC,CAAC;IACvB,MAAM,OAAO,GAAG,GAAG,CAAC,IAAI,EAAE,CAAC;IAC3B,IAAI,OAAO,EAAE;QACT,oIAAoI;QACpI,IACI,CAAC,eAAe;YAChB,eAAe,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,OAAO,CAAC,KAAK,CAAC,CAAC,EAC9D;YACE,OAAO,GAAG,CAAC;SACd;KACJ;IACD,yFAAyF;IACzF,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;QAC7B,OAAO,GAAG,EAAE,CAAC;KAChB;IACD,MAAM,OAAO,GAAG,eAAK,CAAC,OAAO,CAAC,CAAC;IAC/B,MAAM,KAAK,GAAG,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC/B,MAAM,SAAS,GAAG,OAAO,CAAC,YAAY,CAClC,OAAO,CAAC,YAAY,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,YAAY,EAAE,CAAC,CACpD,CAAC;IAEF,OAAO,SAAS;SACX,MAAM,iCACA,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,GACpB,CAAC,eAAe,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC,EAC7C;SACD,QAAQ,EAAE,CAAC;AACpB,CAAC;AAjCD,iCAiCC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@magda/typescript-common",
   "description": "Common TypeScript code shared between components.",
-  "version": "1.2.2-alpha.0",
+  "version": "1.3.1-rc.0",
   "license": "Apache-2.0",
   "scripts": {
     "prebuild": "rimraf dist tsconfig.tsbuildinfo",
@@ -17,8 +17,8 @@
     "release": "npm publish || echo \"Skip releasing npm package @magda/typescript-common.\""
   },
   "devDependencies": {
-    "@magda/registry-aspects": "^1.2.2-alpha.0",
-    "@magda/scripts": "^1.2.2-alpha.0",
+    "@magda/registry-aspects": "^1.3.1-rc.0",
+    "@magda/scripts": "^1.3.1-rc.0",
     "@types/chai": "^4.0.0",
     "@types/chai-as-promised": "^7.1.0",
     "@types/cross-spawn": "^6.0.1",
@@ -31,7 +31,7 @@
     "@types/sinon": "^4.1.3",
     "@types/superagent": "^3.5.5",
     "@types/supertest": "^2.0.3",
-    "@types/urijs": "1.19.13",
+    "@types/urijs": "^1.19.19",
     "@types/uuid": "^8.0.0",
     "@types/yargs": "^12.0.8",
     "chai": "^4.1.2",
@@ -63,7 +63,7 @@
     "request": "^2.88.0",
     "resolve": "^1.15.0",
     "tsmonad": "^0.7.2",
-    "urijs": "^1.19.4",
+    "urijs": "^1.19.11",
     "uuid": "^8.2.0",
     "yargs": "^12.0.5"
   },