astro-accelerator-utils 0.3.6 → 0.3.8

package/lib/v1/urls.mjs

@@ -1,105 +1,105 @@
-export class UrlFormatter {
-    /**
-     * Constructor
-     * @param {string} siteUrl 
-     * @param {string} subfolder
-     * @param {boolean} useTrailingUrlSlash
-     */
-    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;
-    }
-
-    /**
-     * Ensures trailing slash is used
-     * @param {URL} url 
-     * @returns {URL}
-     */
-    addSlashToUrl(url) {
-        if (!url) {
-            return new URL(this.siteUrl);
-        }
-
-        url.pathname += url.pathname.endsWith('/')
-            ? ''
-            : '/';
-
-        return url;
-    }
-
-    /**
-     * Ensures trailing slash is used
-     * @param {string | undefined} address 
-     * @returns {string}
-     */
-    addSlashToAddress(address) {
-        if (!address) {
-            // Handle null or empty addresses
-            address = '/';
-        }
-
-        if (address.indexOf('//') > -1) {
-            // Don't mess with absolute addresses
-            return address;
-        }
-
-        const url = this.addSlashToUrl(new URL(address, this.siteUrl));
-        return url.pathname + url.search;
-    }
-
-    /**
-     * Gets the author id from an address
-     * @param {URL} url 
-     */
-    getAuthorId(url) {
-        const index = (this.subfolder.length === 0)
-            ? 2 // i.e. /authors/steve-fenton/
-            : 3 // i.e. /subfolder/authors/steve-fenton/
-        return url.pathname.split('/')[index];
-    }
+export class UrlFormatter {
+    /**
+     * Constructor
+     * @param {string} siteUrl 
+     * @param {string} subfolder
+     * @param {boolean} useTrailingUrlSlash
+     */
+    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;
+    }
+
+    /**
+     * Ensures trailing slash is used
+     * @param {URL} url 
+     * @returns {URL}
+     */
+    addSlashToUrl(url) {
+        if (!url) {
+            return new URL(this.siteUrl);
+        }
+
+        url.pathname += url.pathname.endsWith('/')
+            ? ''
+            : '/';
+
+        return url;
+    }
+
+    /**
+     * Ensures trailing slash is used
+     * @param {string | undefined} address 
+     * @returns {string}
+     */
+    addSlashToAddress(address) {
+        if (!address) {
+            // Handle null or empty addresses
+            address = '/';
+        }
+
+        if (address.indexOf('//') > -1) {
+            // Don't mess with absolute addresses
+            return address;
+        }
+
+        const url = this.addSlashToUrl(new URL(address, this.siteUrl));
+        return url.pathname + url.search;
+    }
+
+    /**
+     * Gets the author id from an address
+     * @param {URL} url 
+     */
+    getAuthorId(url) {
+        const index = (this.subfolder.length === 0)
+            ? 2 // i.e. /authors/steve-fenton/
+            : 3 // i.e. /subfolder/authors/steve-fenton/
+        return url.pathname.split('/')[index];
+    }
 }

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "astro-accelerator-utils",
-  "version": "0.3.6",
+  "version": "0.3.8",
   "description": "Astro utilities for Astro Accelerator.",
   "main": "index.mjs",
   "type": "module",
-  "packageManager": "pnpm@8.7.0",
+  "packageManager": "pnpm@9.1.4",
   "files": [
     "index.mjs",
     "index.d.mts",
@@ -32,7 +32,7 @@
   },
   "homepage": "https://astro.stevefenton.co.uk/",
   "devDependencies": {
-    "@types/node": "^18.19.7",
+    "@types/node": "^18.19.39",
     "jest": "^29.7.0",
     "jest-spec": "^0.0.3",
     "rehype-stringify": "^9.0.4",

package/types/Astro.d.ts

@@ -1,19 +1,19 @@
-import { Frontmatter } from "./Frontmatter";
-export type MarkdownInstance = {
-    frontmatter: Frontmatter;
-    /** Absolute file path (e.g. `/home/user/projects/.../file.md`) */
-    file: string;
-    /** Browser URL for files under `/src/pages` (e.g. `/en/guides/markdown-content`) */
-    url: string | undefined;
-    /** Component to render content in `.astro` files. Usage: `<Content />` */
-    Content: any;
-    /** raw Markdown file content, excluding layout HTML and YAML frontmatter */
-    rawContent(): string;
-    /** Markdown file compiled to HTML, excluding layout HTML */
-    compiledContent(): string;
-    /** List of headings (h1 -> h6) with associated metadata */
-    getHeadings(): any[];
-    /** @deprecated Renamed to `getHeadings()` */
-    getHeaders(): void;
-    default: any;
-};
+import { Frontmatter } from "./Frontmatter";
+export type MarkdownInstance = {
+    frontmatter: Frontmatter;
+    /** Absolute file path (e.g. `/home/user/projects/.../file.md`) */
+    file: string;
+    /** Browser URL for files under `/src/pages` (e.g. `/en/guides/markdown-content`) */
+    url: string | undefined;
+    /** Component to render content in `.astro` files. Usage: `<Content />` */
+    Content: any;
+    /** raw Markdown file content, excluding layout HTML and YAML frontmatter */
+    rawContent(): string;
+    /** Markdown file compiled to HTML, excluding layout HTML */
+    compiledContent(): string;
+    /** List of headings (h1 -> h6) with associated metadata */
+    getHeadings(): any[];
+    /** @deprecated Renamed to `getHeadings()` */
+    getHeaders(): void;
+    default: any;
+};

package/types/AuthorList.d.ts

@@ -1,8 +1,8 @@
-import type { MarkdownInstance } from "./Astro";
-import type { BannerImage } from "./BannerImage";
-export interface AuthorList {
-    image: BannerImage | null;
-    writers: MarkdownInstance[];
-    mainAuthor: MarkdownInstance | null;
-    contributors: MarkdownInstance[];
-}
+import type { MarkdownInstance } from "./Astro";
+import type { BannerImage } from "./BannerImage";
+export interface AuthorList {
+    image: BannerImage | null;
+    writers: MarkdownInstance[];
+    mainAuthor: MarkdownInstance | null;
+    contributors: MarkdownInstance[];
+}

package/types/BannerImage.d.ts

@@ -1,4 +1,4 @@
-export interface BannerImage {
-    src: string;
-    alt: string;
-}
+export interface BannerImage {
+    src: string;
+    alt: string;
+}

package/types/Frontmatter.d.ts

@@ -1,30 +1,30 @@
-export interface Frontmatter {
-    layout: string;
-    title: string;
-    titleAdditional?: string;
-    subtitle?: string;
-    pubDate: Date;
-    modDate?: Date;
-    tags?: string[];
-    id?: string;
-    authors?: string[];
-    keywords?: string;
-    description?: string;
-    summary?: string;
-    categories?: string[];
-    navTitle?: string;
-    navSection?: string;
-    navOrder?: number;
-    bannerImage?: {
-        src: string;
-        alt: string;
-    };
-    dir?: 'ltr' | 'rtl';
-    lang?: string;
-    paged?: boolean;
-    navSearch?: boolean;
-    navSitemap?: boolean;
-    navMenu?: boolean;
-    robots?: string;
-    redirect?: string;
-}
+export interface Frontmatter {
+    layout: string;
+    title: string;
+    titleAdditional?: string;
+    subtitle?: string;
+    pubDate: Date;
+    modDate?: Date;
+    tags?: string[];
+    id?: string;
+    authors?: string[];
+    keywords?: string;
+    description?: string;
+    summary?: string;
+    categories?: string[];
+    navTitle?: string;
+    navSection?: string;
+    navOrder?: number;
+    bannerImage?: {
+        src: string;
+        alt: string;
+    };
+    dir?: 'ltr' | 'rtl';
+    lang?: string;
+    paged?: boolean;
+    navSearch?: boolean;
+    navSitemap?: boolean;
+    navMenu?: boolean;
+    robots?: string;
+    redirect?: string;
+}

package/types/Link.d.ts

@@ -1,6 +1,6 @@
-export interface Link {
-    title: string;
-    url: string;
-    ariaCurrent: 'page' | false;
-    class: string;
-}
+export interface Link {
+    title: string;
+    url: string;
+    ariaCurrent: 'page' | false;
+    class: string;
+}

package/types/NavPage.d.ts

@@ -1,22 +1,22 @@
-export interface NavPage {
-    section?: string;
-    fullTitle: string;
-    title: string;
-    url: string;
-    order: number;
-    isOpen: boolean;
-    ariaCurrent: 'page' | false;
-    children: NavPage[];
-    rel?: string;
-}
-export interface MenuItem {
-    title: string;
-    order: number;
-    isOpen?: boolean;
-    ariaCurrent?: 'page' | false;
-    fullTitle?: string;
-    children?: MenuItem[];
-    section?: string;
-    url?: string;
-    rel?: string;
-}
+export interface NavPage {
+    section?: string;
+    fullTitle: string;
+    title: string;
+    url: string;
+    order: number;
+    isOpen: boolean;
+    ariaCurrent: 'page' | false;
+    children: NavPage[];
+    rel?: string;
+}
+export interface MenuItem {
+    title: string;
+    order: number;
+    isOpen?: boolean;
+    ariaCurrent?: 'page' | false;
+    fullTitle?: string;
+    children?: MenuItem[];
+    section?: string;
+    url?: string;
+    rel?: string;
+}

package/types/PagePredicate.d.ts

@@ -1,2 +1,2 @@
-import { MarkdownInstance } from "./Astro";
-export type PagePredicate = (value: MarkdownInstance, index: number, array: MarkdownInstance[]) => boolean;
+import { MarkdownInstance } from "./Astro";
+export type PagePredicate = (value: MarkdownInstance, index: number, array: MarkdownInstance[]) => boolean;

package/types/Site.d.ts

@@ -1,43 +1,43 @@
-export type Site = {
-    url: string;
-    useTrailingUrlSlash?: boolean;
-    captureStatistics: boolean;
-    dateOptions: Intl.DateTimeFormatOptions;
-    subfolder: string;
-    feedUrl: string;
-    title: string;
-    description: string;
-    defaultLanguage: string;
-    themeColor: string;
-    owner: string;
-    default: {
-        lang: string;
-        locale: string;
-        dir: string;
-    };
-    search: {
-        fallbackUrl: 'https://www.google.com/search' | string;
-        fallbackSite: 'q' | string;
-        fallbackQuery: 'q' | string;
-    };
-    pageSize: number;
-    pageLinks: number;
-    rssLimit: number;
-    cacheMaxAge: number;
-    featureFlags: {
-        stickyNav: {
-            top: number;
-        };
-        codeBlocks: 'copy'[];
-        figures: 'enlarge'[];
-        youTubeLinks: 'embed'[];
-        headers: 'link'[];
-        details: 'tabs'[];
-        search: 'dialog'[];
-    };
-    images: {
-        contentSize: string;
-        listerSize: string;
-        authorSize: string;
-    };
-};
+export type Site = {
+    url: string;
+    useTrailingUrlSlash?: boolean;
+    captureStatistics: boolean;
+    dateOptions: Intl.DateTimeFormatOptions;
+    subfolder: string;
+    feedUrl: string;
+    title: string;
+    description: string;
+    defaultLanguage: string;
+    themeColor: string;
+    owner: string;
+    default: {
+        lang: string;
+        locale: string;
+        dir: string;
+    };
+    search: {
+        fallbackUrl: 'https://www.google.com/search' | string;
+        fallbackSite: 'q' | string;
+        fallbackQuery: 'q' | string;
+    };
+    pageSize: number;
+    pageLinks: number;
+    rssLimit: number;
+    cacheMaxAge: number;
+    featureFlags: {
+        stickyNav: {
+            top: number;
+        };
+        codeBlocks: 'copy'[];
+        figures: 'enlarge'[];
+        youTubeLinks: 'embed'[];
+        headers: 'link'[];
+        details: 'tabs'[];
+        search: 'dialog' | 'headings'[];
+    };
+    images: {
+        contentSize: string;
+        listerSize: string;
+        authorSize: string;
+    };
+};

package/types/Taxonomy.d.ts

@@ -1,15 +1,15 @@
-export interface TaxonomyEntry {
-    title: string;
-    count: number;
-}
-export interface TaxonomyList {
-    tags: TaxonomyEntry[];
-    topTags: TaxonomyEntry[];
-    categories: TaxonomyEntry[];
-}
-export interface TaxonomyLinks {
-    tag: string;
-    category: string;
-    getCategoryLink: (category: string) => string;
-    getTagLink: (tag: string) => string;
-}
+export interface TaxonomyEntry {
+    title: string;
+    count: number;
+}
+export interface TaxonomyList {
+    tags: TaxonomyEntry[];
+    topTags: TaxonomyEntry[];
+    categories: TaxonomyEntry[];
+}
+export interface TaxonomyLinks {
+    tag: string;
+    category: string;
+    getCategoryLink: (category: string) => string;
+    getTagLink: (tag: string) => string;
+}