astro-accelerator-utils 0.2.19 → 0.2.21

package/lib/v1/accelerator.d.mts

@@ -10,6 +10,7 @@ export class Accelerator {
     dateOptions: Intl.DateTimeFormatOptions;
     siteUrl: string;
     subfolder: string;
+    useTrailingUrlSlash: boolean;
     get authors(): Authors;
     get cache(): Cache;
     get dateFormatter(): DateFormatter;

package/lib/v1/accelerator.mjs

@@ -21,6 +21,7 @@ export class Accelerator {
         this.dateOptions = site.dateOptions;
         this.siteUrl = site.url;
         this.subfolder = site.subfolder;
+        this.useTrailingUrlSlash = site.useTrailingUrlSlash;
     }
 
     get authors() {
@@ -56,6 +57,6 @@ export class Accelerator {
     }
 
     get urlFormatter() {
-        return new UrlFormatter(this.siteUrl, this.subfolder)
+        return new UrlFormatter(this.siteUrl, this.subfolder, this.useTrailingUrlSlash)
     }
 }

package/lib/v1/urls.d.mts

@@ -3,10 +3,23 @@ export class UrlFormatter {
      * Constructor
      * @param {string} siteUrl
      * @param {string} subfolder
+     * @param {boolean} useTrailingUrlSlash
      */
-    constructor(siteUrl: string, subfolder: string);
+    constructor(siteUrl: string, subfolder: string, useTrailingUrlSlash: boolean);
     siteUrl: string;
     subfolder: string;
+    useTrailingUrlSlash: boolean;
+    /** Uses config to decide whether to add or remove trailing slashes
+     * @param {URL} url
+     * @returns {URL}
+     */
+    formatUrl(url: URL): URL;
+    /**
+     * Ensures trailing slash is used
+     * @param {string | undefined} address
+     * @returns {string}
+     */
+    formatAddress(address: string | undefined): string;
     /**
      * Ensures trailing slash is used
      * @param {URL} url

package/lib/v1/urls.mjs

@@ -3,10 +3,56 @@ export class UrlFormatter {
      * Constructor
      * @param {string} siteUrl 
      * @param {string} subfolder
+     * @param {boolean} useTrailingUrlSlash
      */
-    constructor(siteUrl, subfolder) {
+    constructor(siteUrl, subfolder, useTrailingUrlSlash) {
         this.siteUrl = siteUrl;
         this.subfolder = subfolder;
+        this.useTrailingUrlSlash = useTrailingUrlSlash;
+    }
+
+    /** Uses config to decide whether to add or remove trailing slashes
+     * @param {URL} url
+     * @returns {URL}
+     */
+    formatUrl(url) {
+        if (!url) {
+            return new URL(this.siteUrl);
+        }
+
+        if (this.useTrailingUrlSlash) {
+            // Add slash
+            url.pathname += url.pathname.endsWith('/')
+            ? ''
+            : '/';
+        } else {
+            // Remove slash
+            if (url.pathname.endsWith('/')) {
+                url.pathname = url.pathname.substring(0, url.pathname.length - 1);
+            }
+        }
+
+        return url;
+    }
+
+    /**
+     * Ensures trailing slash is used
+     * @param {string | undefined} address 
+     * @returns {string}
+     */
+    formatAddress(address) {
+        if (!address) {
+            // Handle null or empty addresses
+            address = '/';
+        }
+
+        if (address.indexOf('//') > -1) {
+            // Don't mess with absolute addresses
+            return address;
+        }
+
+        const url = this.formatUrl(new URL(address, this.siteUrl));
+        return url.pathname + url.search;
     }
 
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "astro-accelerator-utils",
-  "version": "0.2.19",
+  "version": "0.2.21",
   "description": "Astro utilities for Astro Accelerator.",
   "main": "index.mjs",
   "type": "module",

package/types/Site.d.ts

@@ -1,5 +1,6 @@
 export type Site = {
     url: string;
+    useTrailingUrlSlash?: boolean;
     dateOptions: Intl.DateTimeFormatOptions;
     subfolder: string;
     feedUrl: string;
@@ -30,6 +31,13 @@ export type Site = {
         figures: 'enlarge'[];
         youTubeLinks: 'embed'[];
     };
+    layouts: {
+        default: string;
+        category?: string;
+        tag?: string;
+        author?: string;
+        page?: string;
+    };
     images: {
         contentSize: string;
         listerSize: string;