@tryghost/express-test 0.9.0 → 0.10.0

package/lib/agent.js

@@ -3,14 +3,19 @@ const ExpectRequest = require('./expect-request');
 const {RequestOptions} = require('./request');
 const {normalizeURL} = require('./utils');
 
+/**
+ * @typedef AgentOptions
+ * @param {string} [baseUrl] - the base URL path for the API query
+ * @param {Object} [queryParams] - custom query params to append to each request
+ * @param {Object} [headers] - any default headers to append to each request
+ * @param {Object} [body] - a default body to append to each request
+ * */
+
 class Agent {
     /**
      *
      * @param {Object} app instance of Express app
-     * @param {Object} [defaults]
-     * @param {string} [defaults.baseUrl]
-     * @param {Object} [defaults.headers]
-     * @param {Object} [defaults.queryParams] - custom query params to append to each request
+     * @param {AgentOptions} [defaults]
      */
     constructor(app, defaults = {}) {
         this.app = app;
@@ -19,20 +24,31 @@ class Agent {
         this.jar = new CookieJar();
     }
 
-    _makeUrl(url) {
+    /**
+     *
+     * @param {String} url
+     * @param {object} [urlOptions]
+     * @param {string} [urlOptions.baseUrl] - the base URL path for the API query
+     * @param {Object} [urlOptions.queryParams] - custom query params to append to each request
+     * @returns
+     */
+    _makeUrl(url, urlOptions = {}) {
         let processedURL = url;
+        const baseUrl = urlOptions.baseUrl || this.defaults.baseUrl || null;
 
-        if (this.defaults.baseUrl) {
-            processedURL = `/${this.defaults.baseUrl}/${processedURL}`.replace(/(^|[^:])\/\/+/g, '$1/');
+        if (baseUrl) {
+            processedURL = `/${baseUrl}/${processedURL}`.replace(/(^|[^:])\/\/+/g, '$1/');
         }
 
         processedURL = normalizeURL(processedURL);
 
-        if (this.defaults.queryParams) {
+        const queryParams = Object.assign({}, this.defaults.queryParams, urlOptions.queryParams);
+
+        if (Object.keys(queryParams).length > 0) {
             const searchParams = new URLSearchParams();
 
-            for (const key in this.defaults.queryParams) {
-                searchParams.append(key, this.defaults.queryParams[key]);
+            for (const key in queryParams) {
+                searchParams.append(key, queryParams[key]);
             }
 
             if (processedURL.includes('?')) {
@@ -45,6 +61,13 @@ class Agent {
         return processedURL;
     }
 
+    /**
+     *
+     * @param {string}} method - HTTP method
+     * @param {string} url - url to request
+     * @param {AgentOptions} options
+     * @returns
+     */
     _mergeOptions(method, url, options = {}) {
         // It doesn't make sense to call this method without these properties
         if (!method) {
@@ -55,9 +78,12 @@ class Agent {
             throw new Error('_mergeOptions cannot be called without a url'); /* eslint-disable-line no-restricted-syntax */
         }
 
+        // urlOptions
+        const {baseUrl, queryParams} = options;
+
         return new RequestOptions({
             method,
-            url: this._makeUrl(url),
+            url: this._makeUrl(url, Object.assign({}, {baseUrl, queryParams})),
             headers: Object.assign({}, this.defaults.headers, options.headers),
             // Set this to an empty object for ease, as express.json will do this anyway
             body: Object.assign({}, this.defaults.body, options.body)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tryghost/express-test",
-  "version": "0.9.0",
+  "version": "0.10.0",
   "repository": "https://github.com/TryGhost/framework/tree/main/packages/express-test",
   "author": "Ghost Foundation",
   "license": "MIT",
@@ -19,16 +19,16 @@
     "access": "public"
   },
   "devDependencies": {
-    "c8": "7.11.0",
-    "express": "4.17.3",
+    "c8": "7.11.2",
+    "express": "4.18.0",
     "express-session": "1.17.2",
     "mocha": "9.2.2",
     "sinon": "13.0.2"
   },
   "dependencies": {
-    "@tryghost/jest-snapshot": "^0.3.12",
+    "@tryghost/jest-snapshot": "^0.3.13",
     "cookiejar": "^2.1.3",
     "reqresnext": "^1.7.0"
   },
-  "gitHead": "9799b440419e56125eabc4ddd34290d3f40733f9"
+  "gitHead": "944b81c690bc66f703c8cf36a310e51ce5393b9f"
 }