astro-accelerator-utils 0.1.21 → 0.1.22

package/index.d.mts

@@ -9,5 +9,4 @@ import { Taxonomy } from "./lib/v1/taxonomy.mjs";
 import { UrlFormatter } from "./lib/v1/urls.mjs";
 import * as PostFiltering from "./lib/postFiltering.mjs";
 import * as PostOrdering from "./lib/postOrdering.mjs";
-import * as FooterMenu from "./lib/footerMenu.mjs";
-export { Authors, Cache, DateFormatter, Markdown, Navigation, Paging, Posts, Taxonomy, UrlFormatter, PostFiltering, PostOrdering, FooterMenu };
+export { Authors, Cache, DateFormatter, Markdown, Navigation, Paging, Posts, Taxonomy, UrlFormatter, PostFiltering, PostOrdering };

package/index.mjs

@@ -10,7 +10,6 @@ import { UrlFormatter } from './lib/v1/urls.mjs';
 
 import * as PostFiltering from './lib/postFiltering.mjs';
 import * as PostOrdering from './lib/postOrdering.mjs';
-import * as FooterMenu from './lib/footerMenu.mjs';
 
 export {
     Authors,
@@ -23,6 +22,5 @@ export {
     Taxonomy,
     UrlFormatter,
     PostFiltering,
-    PostOrdering,
-    FooterMenu
+    PostOrdering
 };

package/lib/v1/navigation.d.mts

@@ -1,4 +1,7 @@
 /**
+ * @typedef { import("./posts.mjs").Posts } Posts
+ * @typedef { import("./taxonomy.mjs").Taxonomy } Taxonomy
+ * @typedef { import("./urls.mjs").UrlFormatter } UrlFormatter
  * @typedef { import("../../types/Astro").MarkdownInstance } MarkdownInstance
  * @typedef { import("../../types/NavPage").NavPage } NavPage
  */
@@ -7,10 +10,12 @@ export class Navigation {
      * Constructor
      * @param {Posts} posts
      * @param {UrlFormatter} urlFormatter
+     * @param {Taxonomy} taxonomy
      */
-    constructor(posts: Posts, urlFormatter: UrlFormatter);
-    posts: Posts;
-    urlFormatter: UrlFormatter;
+    constructor(posts: Posts, urlFormatter: UrlFormatter, taxonomy: Taxonomy);
+    posts: import("./posts.mjs").Posts;
+    urlFormatter: import("./urls.mjs").UrlFormatter;
+    taxonomy: import("./taxonomy.mjs").Taxonomy;
     /**
      * Returns a list of breadcrumbs
      * @param {URL} currentUrl
@@ -32,6 +37,46 @@ export class Navigation {
      * @returns {NavPage[]}
      */
     autoMenu(subfolder: string): NavPage[];
+    /**
+     *
+     * @param {URL} currentUrl
+     * @param {TranslationProvider} _
+     * @param {any} translations
+     * @param {string} subfolder
+     * @param {(NavPage | 'categories' | 'tags' | 'toptags')[]} menu
+     * @returns {NavPage[]}
+     */
+    footer(currentUrl: URL, _: TranslationProvider, translations: any, subfolder: string, menu: (NavPage | 'categories' | 'tags' | 'toptags')[]): NavPage[];
+    /**
+     *
+     * @param {TaxonomyLinks} links
+     * @param {TranslationProvider} _
+     * @param {any} translations
+     * @param {string} subfolder
+     * @param {TaxonomyList} entries
+     * @returns {NavPage[]}
+     */
+    getCategories(links: TaxonomyLinks, _: TranslationProvider, translations: any, subfolder: string, entries: TaxonomyList): NavPage[];
+    /**
+     *
+     * @param {TaxonomyLinks} links
+     * @param {TranslationProvider} _
+     * @param {any} translations
+     * @param {string} subfolder
+     * @param {TaxonomyList} entries
+     * @returns {NavPage[]}
+     */
+    getTags(links: TaxonomyLinks, _: TranslationProvider, translations: any, subfolder: string, entries: TaxonomyList): NavPage[];
+    /**
+     *
+     * @param {TaxonomyLinks} links
+     * @param {TranslationProvider} _
+     * @param {any} translations
+     * @param {string} subfolder
+     * @param {TaxonomyList} entries
+     * @returns {NavPage[]}
+     */
+    getTopTags(links: TaxonomyLinks, _: TranslationProvider, translations: any, subfolder: string, entries: TaxonomyList): NavPage[];
     /**
      * Walks a NavPage tree to set current page
      * @param {NavPage[]} pages
@@ -58,5 +103,8 @@ export class Navigation {
      */
     popMatchingPage(allPages: MarkdownInstance[], search: string): import("../../types/Astro").MarkdownInstance;
 }
+export type Posts = import("./posts.mjs").Posts;
+export type Taxonomy = import("./taxonomy.mjs").Taxonomy;
+export type UrlFormatter = import("./urls.mjs").UrlFormatter;
 export type MarkdownInstance = import("../../types/Astro").MarkdownInstance;
 export type NavPage = import("../../types/NavPage").NavPage;

package/lib/v1/navigation.mjs

@@ -1,6 +1,9 @@
 import * as PostFiltering from '../postFiltering.mjs';
 
 /**
+ * @typedef { import("./posts.mjs").Posts } Posts
+ * @typedef { import("./taxonomy.mjs").Taxonomy } Taxonomy
+ * @typedef { import("./urls.mjs").UrlFormatter } UrlFormatter
  * @typedef { import("../../types/Astro").MarkdownInstance } MarkdownInstance
  * @typedef { import("../../types/NavPage").NavPage } NavPage
  */
@@ -10,11 +13,12 @@ export class Navigation {
      * Constructor
      * @param {Posts} posts
      * @param {UrlFormatter} urlFormatter
+     * @param {Taxonomy} taxonomy
      */
-    constructor(posts, urlFormatter) {
-        /* istanbul ignore next */
+    constructor(posts, urlFormatter, taxonomy) {
         this.posts = posts;
         this.urlFormatter = urlFormatter;
+        this.taxonomy = taxonomy;
     }
 
     /**
@@ -23,31 +27,31 @@ export class Navigation {
      * @param {string} subfolder
      * @returns {NavPage[]}
      */
-    breadcrumbs (currentUrl, subfolder) {
+    breadcrumbs(currentUrl, subfolder) {
         const allPages = this.posts.all();
 
         const pathParts = currentUrl.pathname.split('/');
-    
+
         if (subfolder.length > 0) {
             // Running in a subfolder
             pathParts.shift();
         }
-        
+
         /** @type {NavPage[]} */
         const navPages = [];
         let path = '';
-    
+
         pathParts.forEach((part) => {
             path += part.length > 0 ? '/' + part : '';
             const match = this.popMatchingPage(allPages, path);
-    
+
             if (match) {
                 navPages.push(this.mapNavPage(match));
             }
         });
-    
+
         this.setCurrentPage(navPages, currentUrl);
-    
+
         return navPages;
     }
 
@@ -58,19 +62,19 @@ export class Navigation {
      * @param {(NavPage | 'auto')[]} menu
      * @returns {NavPage[]}
      */
-    menu (currentUrl, subfolder, menu) {
-            const pages = [];
-            for (let i = 0; i < menu.length; i++) {
-                const item = menu[i];
-                if (this.isNavPage(item)) {
-                    pages.push(item);
-                } else {
-                    const p = this.autoMenu(subfolder);
-                    for (let j = 0; j < p.length; j++) {
-                        pages.push(p[j]);
-                    }
+    menu(currentUrl, subfolder, menu) {
+        const pages = [];
+        for (let i = 0; i < menu.length; i++) {
+            const item = menu[i];
+            if (this.isNavPage(item)) {
+                pages.push(item);
+            } else {
+                const p = this.autoMenu(subfolder);
+                for (let j = 0; j < p.length; j++) {
+                    pages.push(p[j]);
                 }
             }
+        }
 
         this.setCurrentPage(pages, currentUrl);
 
@@ -82,7 +86,7 @@ export class Navigation {
      * @param {string} subfolder 
      * @returns {NavPage[]}
      */
-    autoMenu (subfolder) {
+    autoMenu(subfolder) {
         const allPages = this.posts
             .all()
             .filter(PostFiltering.showInMenu);
@@ -94,7 +98,7 @@ export class Navigation {
         const pageHierarchy = topLevelPages
             .map(p => this.mapNavPage(p))
             .sort((a, b) => a.order - b.order);
-            
+
         /** @type {NavPage[]} */
         const pageList = allPages.map(p => this.mapNavPage(p));
 
@@ -123,19 +127,191 @@ export class Navigation {
         return pageHierarchy;
     }
 
+    /**
+     * 
+     * @param {URL} currentUrl 
+     * @param {TranslationProvider} _ 
+     * @param {any} translations 
+     * @param {string} subfolder 
+     * @param {(NavPage | 'categories' | 'tags' | 'toptags')[]} menu 
+     * @returns {NavPage[]}
+     */
+    footer(currentUrl, _, translations, subfolder, menu) {
+
+        // const cache = new Cache(site.cacheMaxAge);
+        // const posts = new Posts(cache);
+        // const urlFormatter = new UrlFormatter(site.url);
+        // const taxonomy = new Taxonomy(cache, posts, urlFormatter);
+        // const navigation = new Navigation(posts, urlFormatter);
+        const links = this.taxonomy.links(translations, _, subfolder);
+        const entries = this.taxonomy.getTaxonomy();
+
+        /** @type {NavPage[]} */
+        let pages = [];
+
+        for (let i = 0; i < menu.length; i++) {
+            const item = menu[i];
+            if (this.isNavPage(item)) {
+                pages.push(item);
+            } else {
+                switch (item) {
+                    case 'tags':
+                        const tags = this.getTags(links, _, translations, subfolder, entries);
+                        for (let j = 0; j < tags.length; j++) {
+                            pages.push(tags[j]);
+                        }
+                        break;
+                    case 'toptags':
+                        const toptags = this.getTopTags(links, _, translations, subfolder, entries);
+                        for (let j = 0; j < toptags.length; j++) {
+                            pages.push(toptags[j]);
+                        }
+                        break;
+                    case 'categories':
+                        const categories = this.getCategories(links, _, translations, subfolder, entries);
+                        for (let j = 0; j < categories.length; j++) {
+                            pages.push(categories[j]);
+                        }
+                        break;
+                }
+            }
+        }
+
+        this.setCurrentPage(pages, currentUrl);
+
+        return pages;
+    }
+
+    /**
+     * 
+     * @param {TaxonomyLinks} links 
+     * @param {TranslationProvider} _ 
+     * @param {any} translations 
+     * @param {string} subfolder 
+     * @param {TaxonomyList} entries
+     * @returns {NavPage[]}
+     */
+    getCategories(links, _, translations, subfolder, entries) {
+
+        const category = _(translations.articles.category) ?? 'category';
+        const categoryTitle = _(translations.articles.category_title) ?? 'Categories';
+        const categoryLink = `${subfolder}/${category}/`;
+
+        let order = 0;
+
+        /** @type {NavPage[]} */
+        const pageHierarchy = [{
+            title: categoryTitle,
+            url: categoryLink,
+            ariaCurrent: false,
+            isOpen: false,
+            order: 1,
+            children: entries.categories.map(item => {
+                return {
+                    title: item.title,
+                    url: links.getCategoryLink(item.title),
+                    ariaCurrent: false,
+                    isOpen: false,
+                    order: ++order,
+                    children: []
+                };
+            })
+        }];
+
+        return pageHierarchy;
+    }
+
+    /**
+     * 
+     * @param {TaxonomyLinks} links 
+     * @param {TranslationProvider} _ 
+     * @param {any} translations 
+     * @param {string} subfolder 
+     * @param {TaxonomyList} entries
+     * @returns {NavPage[]}
+     */
+    getTags(links, _, translations, subfolder, entries) {
+
+        const tag = _(translations.articles.tag) ?? 'tag';
+        const tagTitle = _(translations.articles.tag_title) ?? 'Tags';
+        const tagLink = `${subfolder}/${tag}/`;
+
+        let order = 0;
+
+        /** @type {NavPage[]} */
+        const pageHierarchy = [{
+            title: tagTitle,
+            url: tagLink,
+            ariaCurrent: false,
+            isOpen: false,
+            order: 1,
+            children: entries.tags.map(item => {
+                return {
+                    title: item.title,
+                    url: links.getTagLink(item.title),
+                    ariaCurrent: false,
+                    isOpen: false,
+                    order: ++order,
+                    children: []
+                };
+            })
+        }];
+
+        return pageHierarchy;
+    }
+
+    /**
+     * 
+     * @param {TaxonomyLinks} links 
+     * @param {TranslationProvider} _ 
+     * @param {any} translations 
+     * @param {string} subfolder 
+     * @param {TaxonomyList} entries
+     * @returns {NavPage[]}
+     */
+    getTopTags(links, _, translations, subfolder, entries) {
+
+        const tag = _(translations.articles.tag) ?? 'tag';
+        const tagTitle = _(translations.articles.tag_title) ?? 'Tags';
+        const tagLink = `${subfolder}/${tag}/`;
+
+        let order = 0;
+
+        /** @type {NavPage[]} */
+        const pageHierarchy = [{
+            title: tagTitle,
+            url: tagLink,
+            ariaCurrent: false,
+            isOpen: false,
+            order: 1,
+            children: entries.topTags.map(item => {
+                return {
+                    title: item.title,
+                    url: links.getTagLink(item.title),
+                    ariaCurrent: false,
+                    isOpen: false,
+                    order: ++order,
+                    children: []
+                };
+            })
+        }];
+
+        return pageHierarchy;
+    }
+
 
     /**
      * Walks a NavPage tree to set current page
      * @param {NavPage[]} pages 
      * @param {URL} currentUrl 
      */
-    setCurrentPage (pages, currentUrl) {
+    setCurrentPage(pages, currentUrl) {
         pages.forEach(p => {
             p.isOpen = currentUrl.pathname.startsWith(p.url);
             p.ariaCurrent = p.url == currentUrl.pathname
                 ? 'page'
                 : false;
-            
+
             if (p.children) {
                 this.setCurrentPage(p.children, currentUrl);
             }
@@ -147,23 +323,23 @@ export class Navigation {
      * @param {MarkdownInstance} page 
      * @returns {NavPage}
      */
-    mapNavPage (page) {
-        let url = page.url == null || (page.url ?? '').length == 0 
+    mapNavPage(page) {
+        let url = page.url == null || (page.url ?? '').length == 0
             ? '/'
             : page.url;
-    
+
         // Send visitors straight to the first page
         if (page.frontmatter.paged) {
             url += '/1/';
         }
-    
+
         url = this.urlFormatter.addSlashToAddress(url);
-    
+
         if (page.frontmatter.layout == 'src/layouts/Redirect.astro') {
             // Skips past the redirect
             url = page.frontmatter.redirect;
         }
-    
+
         /** @type {NavPage} */
         const entry = {
             section: page.frontmatter.navSection ?? page.frontmatter.navTitle ?? page.frontmatter.title,
@@ -175,7 +351,7 @@ export class Navigation {
             isOpen: false,
             ariaCurrent: false
         }
-    
+
         return entry;
     }
 
@@ -185,11 +361,11 @@ export class Navigation {
      * @param {NavPage | 'auto' | 'tags' | 'toptags' | 'categories'} item 
      * @returns {item is NavPage}
      */
-    isNavPage (item) {
+    isNavPage(item) {
         if (typeof item === 'string' && ['auto', 'tags', 'toptags', 'categories'].includes(item)) {
             return false;
         }
-    
+
         return true;
     }
 
@@ -199,22 +375,22 @@ export class Navigation {
      * @param {string} search 
      * @returns 
      */
-    popMatchingPage (allPages, search) {
+    popMatchingPage(allPages, search) {
         const numberToRemove = 1;
         let indexToRemove = -1;
         let match = null;
-    
+
         for (let i = 0; i < allPages.length; i++) {
             if (allPages[i].url == search) {
                 indexToRemove = i;
                 match = allPages[i];
             }
         }
-    
+
         if (match) {
             allPages.splice(indexToRemove, numberToRemove);
         }
-    
+
         return match;
-  }
+    }
 }

package/package.json

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

package/lib/footerMenu.d.mts

@@ -1,52 +0,0 @@
-/**
- * @typedef { import("../types/NavPage").NavPage } NavPage
- * @typedef { import("../types/Astro").Site } Site
- * @typedef { import("../types/Translations").Entry } Entry
- * @typedef { import("../types/Translations").TranslationProvider } TranslationProvider
- * @typedef { import("../types/Taxonomy").TaxonomyLinks } TaxonomyLinks
- */
-/**
- *
- * @param {URL} currentUrl
- * @param {TranslationProvider} _
- * @param {any} translations
- * @param {Site} site
- * @param {(NavPage | 'categories' | 'tags' | 'toptags')[]} menu
- * @returns {Promise<NavPage[]>}
- */
-export function getMenu(currentUrl: URL, _: TranslationProvider, translations: any, site: any, menu: (NavPage | 'categories' | 'tags' | 'toptags')[]): Promise<NavPage[]>;
-/**
- *
- * @param {TaxonomyLinks} links
- * @param {TranslationProvider} _
- * @param {any} translations
- * @param {Site} site
- * @param {TaxonomyList} entries
- * @returns {Promise<NavPage[]>}
- */
-export function getCategories(links: TaxonomyLinks, _: TranslationProvider, translations: any, site: any, entries: TaxonomyList): Promise<NavPage[]>;
-/**
- *
- * @param {TaxonomyLinks} links
- * @param {TranslationProvider} _
- * @param {any} translations
- * @param {Site} site
- * @param {TaxonomyList} entries
- * @returns {Promise<NavPage[]>}
- */
-export function getTags(links: TaxonomyLinks, _: TranslationProvider, translations: any, site: any, entries: TaxonomyList): Promise<NavPage[]>;
-/**
- *
- * @param {TaxonomyLinks} links
- * @param {TranslationProvider} _
- * @param {any} translations
- * @param {Site} site
- * @param {TaxonomyList} entries
- * @returns {Promise<NavPage[]>}
- */
-export function getTopTags(links: TaxonomyLinks, _: TranslationProvider, translations: any, site: any, entries: TaxonomyList): Promise<NavPage[]>;
-export type NavPage = import("../types/NavPage").NavPage;
-export type Site = import("../types/Astro").Site;
-export type Entry = import("../types/Translations").Entry;
-export type TranslationProvider = import("../types/Translations").TranslationProvider;
-export type TaxonomyLinks = import("../types/Taxonomy").TaxonomyLinks;

package/lib/footerMenu.mjs

@@ -1,185 +0,0 @@
-import { Cache } from './v1/cache.mjs';
-import { Navigation } from './v1/navigation.mjs';
-import { Posts } from './v1/posts.mjs';
-import { Taxonomy } from './v1/taxonomy.mjs'
-import { UrlFormatter } from './v1/urls.mjs';
-
-/**
- * @typedef { import("../types/NavPage").NavPage } NavPage
- * @typedef { import("../types/Astro").Site } Site
- * @typedef { import("../types/Translations").Entry } Entry
- * @typedef { import("../types/Translations").TranslationProvider } TranslationProvider
- * @typedef { import("../types/Taxonomy").TaxonomyLinks } TaxonomyLinks
- */
-
-/**
- * 
- * @param {URL} currentUrl 
- * @param {TranslationProvider} _ 
- * @param {any} translations 
- * @param {Site} site 
- * @param {(NavPage | 'categories' | 'tags' | 'toptags')[]} menu 
- * @returns {Promise<NavPage[]>}
- */
-export async function getMenu (currentUrl,  _, translations, site, menu) {
-
-    const cache = new Cache(site.cacheMaxAge);
-    const posts = new Posts(cache);
-    const urlFormatter = new UrlFormatter(site.url);
-    const taxonomy = new Taxonomy(cache, posts, urlFormatter);
-    const navigation = new Navigation(posts, urlFormatter);
-    const links = taxonomy.links(translations, _, site.subfolder);
-    const entries = taxonomy.getTaxonomy();
-
-    /** @type {NavPage[]} */
-    let pages = [];
-
-    for (let i = 0; i < menu.length; i++) {
-        const item = menu[i];
-        if (navigation.isNavPage(item)) {
-            pages.push(item);
-        } else {
-            switch (item) {
-                case 'tags':
-                    const tags = await getTags(links, _, translations, site, entries);
-                    for (let j = 0; j < tags.length; j++) {
-                        pages.push(tags[j]);
-                    }
-                    break;
-                case 'toptags':
-                    const toptags = await getTopTags(links, _, translations, site, entries);
-                    for (let j = 0; j < toptags.length; j++) {
-                        pages.push(toptags[j]);
-                    }
-                    break;
-                case 'categories':
-                    const categories = await getCategories(links, _, translations, site, entries);
-                    for (let j = 0; j < categories.length; j++) {
-                        pages.push(categories[j]);
-                    }
-                    break;
-            }
-        }
-    }
-
-    navigation.setCurrentPage(pages, currentUrl);
-
-    return pages;
-}
-
-/**
- * 
- * @param {TaxonomyLinks} links 
- * @param {TranslationProvider} _ 
- * @param {any} translations 
- * @param {Site} site 
- * @param {TaxonomyList} entries
- * @returns {Promise<NavPage[]>}
- */
-export async function getCategories (links, _, translations, site, entries) {
-
-    const category = _(translations.articles.category) ?? 'category';
-    const categoryTitle = _(translations.articles.category_title) ?? 'Categories';
-    const categoryLink = `${site.subfolder}/${category}/`;
-
-    let order = 0;
-
-    /** @type {NavPage[]} */
-    const pageHierarchy = [{
-        title: categoryTitle,
-        url: categoryLink,
-        ariaCurrent: false,
-        isOpen: false,
-        order: 1,
-        children: entries.categories.map(item => {
-            return {
-                title: item.title,
-                url: links.getCategoryLink(item.title),
-                ariaCurrent: false,
-                isOpen: false,
-                order: ++order,
-                children: []
-            };
-        })
-    }];
-
-    return pageHierarchy;
-}
-
-/**
- * 
- * @param {TaxonomyLinks} links 
- * @param {TranslationProvider} _ 
- * @param {any} translations 
- * @param {Site} site 
- * @param {TaxonomyList} entries
- * @returns {Promise<NavPage[]>}
- */
-export async function getTags (links, _, translations, site, entries) {
-
-    const tag = _(translations.articles.tag) ?? 'tag';
-    const tagTitle = _(translations.articles.tag_title) ?? 'Tags';
-    const tagLink = `${site.subfolder}/${tag}/`;
-
-    let order = 0;
-
-    /** @type {NavPage[]} */
-    const pageHierarchy = [{
-        title: tagTitle,
-        url: tagLink,
-        ariaCurrent: false,
-        isOpen: false,
-        order: 1,
-        children: entries.tags.map(item => {
-            return {
-                title: item.title,
-                url: links.getTagLink(item.title),
-                ariaCurrent: false,
-                isOpen: false,
-                order: ++order,
-                children: []
-            };
-        })
-    }];
-
-    return pageHierarchy;
-}
-
-/**
- * 
- * @param {TaxonomyLinks} links 
- * @param {TranslationProvider} _ 
- * @param {any} translations 
- * @param {Site} site 
- * @param {TaxonomyList} entries
- * @returns {Promise<NavPage[]>}
- */
-export async function getTopTags (links, _, translations, site, entries) {
-
-    const tag = _(translations.articles.tag) ?? 'tag';
-    const tagTitle = _(translations.articles.tag_title) ?? 'Tags';
-    const tagLink = `${site.subfolder}/${tag}/`;
-
-    let order = 0;
-
-    /** @type {NavPage[]} */
-    const pageHierarchy = [{
-        title: tagTitle,
-        url: tagLink,
-        ariaCurrent: false,
-        isOpen: false,
-        order: 1,
-        children: entries.topTags.map(item => {
-            return {
-                title: item.title,
-                url: links.getTagLink(item.title),
-                ariaCurrent: false,
-                isOpen: false,
-                order: ++order,
-                children: []
-            };
-        })
-    }];
-
-    return pageHierarchy;
-}

package/types/Translations.d.ts

@@ -1,6 +0,0 @@
-export interface Entry {
-    [key: string]: string;
-}
-export interface TranslationProvider {
-    (entry: Entry): string;
-}