@tryghost/url-utils 2.1.0 → 4.0.0

package/index.js

@@ -0,0 +1 @@
+module.exports = require('./lib/url-utils');

package/lib/{index.js → url-utils.js}

@@ -18,65 +18,30 @@ module.exports = class UrlUtils {
      * @param {Function} options.getSubdir
      * @param {Function} options.getSiteUrl
      * @param {Function} options.getAdminUrl Ghost instance admin URL
-     * @param {Object} options.apiVersions configuration object which has defined `all` property which is an array of keys for other available properties
-     * @param {('v2' | 'v3' | 'v4' | 'canary')} [options.defaultApiVersion='v4'] default API version which is one of the values from options.apiVersions
-     * @param {('content' | 'admin')} [options.defaultApiType='content'] default API type to be used and is one of the values from options.apiVersions
+    * @param {String} [options.baseApiPath='/ghost/api'] static prefix for serving API. Should not te passed in, unless the API is being run under custom URL
+    * @param {('content' | 'admin')} [options.defaultApiType='content'] default API type to be used
      * @param {Object} [options.slugs] object with 2 properties reserved and protected containing arrays of special case slugs
      * @param {Number} [options.redirectCacheMaxAge]
-     * @param {String} [options.baseApiPath='/ghost/api'] static prefix for serving API. Should not te passed in, unless the API is being run under custom URL
      * @param {String} [options.staticImageUrlPrefix='content/images'] static prefix for serving images. Should not be passed in, unless customizing ghost instance image storage
      */
     constructor(options = {}) {
         const defaultOptions = {
-            apiVersions: null,
             slugs: null,
             redirectCacheMaxAge: null,
             baseApiPath: '/ghost/api',
-            defaultApiVersion: 'v4',
             defaultApiType: 'content',
             staticImageUrlPrefix: 'content/images'
         };
 
         this._config = assignOptions({}, defaultOptions, options);
 
-        this._defaultApiPathOptions = {
-            baseApiPath: this._config.baseApiPath,
-            version: this._config.defaultApiVersion,
-            type: this._config.defaultApiType,
-            apiVersions: this._config.apiVersions
-        };
-
         this.getSubdir = options.getSubdir;
         this.getSiteUrl = options.getSiteUrl;
         this.getAdminUrl = options.getAdminUrl;
     }
 
-    /**
-     * Returns API path combining base path and path for specific version asked or deprecated by default
-     * @param {Object} options
-     * @param {string} [options.version="v4"] for which to get the path (v2, v3, canary, etc)
-     * @param {string} [options.type="content"] (admin, content, members)
-     * @return {string} API Path for version
-     */
-    getApiPath(options = {}) {
-        const _options = assignOptions({}, this._defaultApiPathOptions, options);
-        return utils.getApiPath(_options);
-    }
-
-    /**
-     * Returns path containing only the path for the specific version asked or deprecated by default
-     * @param {Object} options
-     * @param {string} [options.version="v4"] for which to get the path (v2, v3, canary, etc)
-     * @param {string} [options.type="content"] (admin, content)
-     * @return {string} API version path
-     */
-    getVersionPath(options = {}) {
-        const _options = assignOptions({}, this._defaultApiPathOptions, options);
-        return utils.getVersionPath(_options);
-    }
-
     getProtectedSlugs() {
-        var subDir = this.getSubdir();
+        let subDir = this.getSubdir();
 
         if (!_.isEmpty(subDir)) {
             return this._config.slugs.concat([subDir.split('/').pop()]);
@@ -105,15 +70,14 @@ module.exports = class UrlUtils {
     // Parameters:
     // - urlPath - string which must start and end with a slash
     // - absolute (optional, default:false) - boolean whether or not the url should be absolute
-    // - secure (optional, default:false) - boolean whether or not to force SSL
     // Returns:
     //  - a URL which always ends with a slash
-    createUrl(urlPath = '/', absolute = false, secure, trailingSlash) {
+    createUrl(urlPath = '/', absolute = false, trailingSlash) {
         let base;
 
         // create base of url, always ends without a slash
         if (absolute) {
-            base = this.getSiteUrl(secure);
+            base = this.getSiteUrl();
         } else {
             base = this.getSubdir();
         }
@@ -143,18 +107,17 @@ module.exports = class UrlUtils {
     // This is probably not the right place for this, but it's the best place for now
     // @TODO: rewrite, very hard to read, create private functions!
     urlFor(context, data, absolute) {
-        var urlPath = '/',
-            secure,
-            imagePathRe,
-            knownObjects = ['image', 'nav'],
-            baseUrl,
-            hostname,
-
-            // this will become really big
-            knownPaths = {
-                home: '/',
-                sitemap_xsl: '/sitemap.xsl'
-            };
+        let urlPath = '/';
+        let imagePathRe;
+        let knownObjects = ['image', 'nav'];
+        let baseUrl;
+        let hostname;
+
+        // this will become really big
+        let knownPaths = {
+            home: '/',
+            sitemap_xsl: '/sitemap.xsl'
+        };
 
         // Make data properly optional
         if (_.isBoolean(data)) {
@@ -162,9 +125,6 @@ module.exports = class UrlUtils {
             data = null;
         }
 
-        // Can pass 'secure' flag in either context or data arg
-        secure = (context && context.secure) || (data && data.secure);
-
         if (_.isObject(context) && context.relativeUrl) {
             urlPath = context.relativeUrl;
         } else if (_.isString(context) && _.indexOf(knownObjects, context) !== -1) {
@@ -176,15 +136,14 @@ module.exports = class UrlUtils {
                 if (absolute) {
                     // Remove the sub-directory from the URL because ghostConfig will add it back.
                     urlPath = urlPath.replace(new RegExp('^' + this.getSubdir()), '');
-                    baseUrl = this.getSiteUrl(secure).replace(/\/$/, '');
+                    baseUrl = this.getSiteUrl().replace(/\/$/, '');
                     urlPath = baseUrl + urlPath;
                 }
 
                 return urlPath;
             } else if (context === 'nav' && data.nav) {
                 urlPath = data.nav.url;
-                secure = data.nav.secure || secure;
-                baseUrl = this.getSiteUrl(secure);
+                baseUrl = this.getSiteUrl();
                 hostname = baseUrl.split('//')[1];
 
                 // If the hostname is present in the url
@@ -200,7 +159,7 @@ module.exports = class UrlUtils {
                 }
             }
         } else if (context === 'home' && absolute) {
-            urlPath = this.getSiteUrl(secure);
+            urlPath = this.getSiteUrl();
 
             // CASE: there are cases where urlFor('home') needs to be returned without trailing
             // slash e. g. the `{{@site.url}}` helper. See https://github.com/TryGhost/Ghost/issues/8569
@@ -208,32 +167,29 @@ module.exports = class UrlUtils {
                 urlPath = urlPath.replace(/\/$/, '');
             }
         } else if (context === 'admin') {
-            urlPath = this.getAdminUrl() || this.getSiteUrl();
+            let adminUrl = this.getAdminUrl() || this.getSiteUrl();
+            let adminPath = '/ghost/';
 
             if (absolute) {
-                urlPath += 'ghost/';
+                urlPath = this.urlJoin(adminUrl, adminPath);
             } else {
-                urlPath = '/ghost/';
+                urlPath = adminPath;
             }
         } else if (context === 'api') {
-            urlPath = this.getAdminUrl() || this.getSiteUrl();
-            let apiPath = this.getApiPath();
-
-            // CASE: with or without protocol? If your blog url (or admin url) is configured to http, it's still possible that e.g. nginx allows both https+http.
-            // So it depends how you serve your blog. The main focus here is to avoid cors problems.
-            // @TODO: rename cors
-            if (data && data.cors) {
-                if (!urlPath.match(/^https:/)) {
-                    urlPath = urlPath.replace(/^.*?:\/\//g, '//');
-                }
-            }
+            let adminUrl = this.getAdminUrl() || this.getSiteUrl();
+            let apiPath = this._config.baseApiPath + '/';
 
-            if (data && data.version) {
-                apiPath = this.getApiPath({version: data.version, type: data.versionType});
+            if (data.type && ['admin', 'content'].includes(data.type)) {
+                apiPath += data.type;
+            } else {
+                apiPath += this._config.defaultApiType;
             }
 
+            // Ensure we end with a trailing slash
+            apiPath += '/';
+
             if (absolute) {
-                urlPath = urlPath.replace(/\/$/, '') + apiPath;
+                urlPath = this.urlJoin(adminUrl, apiPath);
             } else {
                 urlPath = apiPath;
             }
@@ -248,7 +204,7 @@ module.exports = class UrlUtils {
             return urlPath;
         }
 
-        return this.createUrl(urlPath, absolute, secure);
+        return this.createUrl(urlPath, absolute);
     }
 
     redirect301(res, redirectUrl) {
@@ -257,7 +213,7 @@ module.exports = class UrlUtils {
     }
 
     redirectToAdmin(status, res, adminPath) {
-        var redirectUrl = this.urlJoin(this.urlFor('admin', true), adminPath, '/');
+        let redirectUrl = this.urlJoin(this.urlFor('admin', true), adminPath, '/');
 
         if (status === 301) {
             return this.redirect301(res, redirectUrl);

package/lib/utils/index.js

@@ -3,8 +3,6 @@ module.exports = {
     absoluteToTransformReady: require('./absolute-to-transform-ready'),
     deduplicateDoubleSlashes: require('./deduplicate-double-slashes'),
     deduplicateSubdirectory: require('./deduplicate-subdirectory'),
-    getApiPath: require('./get-api-path'),
-    getVersionPath: require('./get-version-path'),
     htmlAbsoluteToRelative: require('./html-absolute-to-relative'),
     htmlRelativeToAbsolute: require('./html-relative-to-absolute'),
     htmlAbsoluteToTransformReady: require('./html-absolute-to-transform-ready'),

package/package.json

@@ -1,29 +1,30 @@
 {
   "name": "@tryghost/url-utils",
-  "version": "2.1.0",
+  "version": "4.0.0",
   "repository": "https://github.com/TryGhost/SDK/tree/master/packages/url-utils",
   "author": "Ghost Foundation",
   "license": "MIT",
-  "main": "lib/index.js",
+  "main": "index.js",
   "scripts": {
     "dev": "echo \"Implement me!\"",
-    "test": "NODE_ENV=testing c8 --all --reporter text --reporter cobertura mocha './test/**/*.test.js'",
+    "test": "NODE_ENV=testing c8 --all --reporter text --reporter cobertura --reporter html mocha './test/**/*.test.js'",
     "lint": "eslint . --ext .js --cache",
     "posttest": "yarn lint"
   },
   "files": [
-    "lib/"
+    "lib/",
+    "index.js"
   ],
   "publishConfig": {
     "access": "public"
   },
   "devDependencies": {
-    "@tryghost/config-url-helpers": "0.1.5",
-    "c8": "7.11.0",
-    "mocha": "7.2.0",
-    "rewire": "5.0.0",
+    "@tryghost/config-url-helpers": "1.0.0",
+    "c8": "7.11.2",
+    "mocha": "10.0.0",
+    "rewire": "6.0.0",
     "should": "13.2.3",
-    "sinon": "9.2.4"
+    "sinon": "14.0.0"
   },
   "dependencies": {
     "cheerio": "^0.22.0",
@@ -33,5 +34,5 @@
     "remark-footnotes": "^1.0.0",
     "unist-util-visit": "^2.0.0"
   },
-  "gitHead": "8bfb11a7576f3a09aa2a4d633933bb8f341d9329"
+  "gitHead": "76ea47794eb7eb1e2b6e9d5b68d52653efc5b85a"
 }

package/lib/utils/get-api-path.js

@@ -1,18 +0,0 @@
-const getVersionPath = require('./get-version-path');
-
-/**
-* Returns API path combining base path and path for specific version/type
-* @param {Object} options
-* @param {string} options.version (v2, v3, v4, canary, etc)
-* @param {string} options.type (admin, content, members)
-* @param {string} options.baseApiPath
-* @param {Object} options.apiVersions
-* @return {string} API Path for version
-*/
-function getApiPath(options) {
-    const versionPath = getVersionPath(options);
-
-    return `${options.baseApiPath}${versionPath}`;
-}
-
-module.exports = getApiPath;

package/lib/utils/get-version-path.js

@@ -1,20 +0,0 @@
-/**
-* Returns API path combining base path and path for specific version/type
-* @param {Object} options
-* @param {string} options.version (v2, v3, canary, etc)
-* @param {string} options.type (admin, content, members)
-* @param {Object} options.apiVersions
-* @return {string} API Path for version
-*/
-function getVersionPath(options) {
-    let {version, type} = options;
-    let versionData = options.apiVersions[version];
-
-    if (typeof versionData === 'string') {
-        versionData = options.apiVersions[versionData];
-    }
-
-    return `/${versionData[type]}/`;
-}
-
-module.exports = getVersionPath;