astro-accelerator-utils 0.1.11 → 0.1.12

package/index.d.mts

@@ -1,13 +1,13 @@
+import { Cache } from "./lib/v1/cache.mjs";
 import { DateFormatter } from "./lib/v1/dates.mjs";
 import { Markdown } from "./lib/v1/markdown.mjs";
+import { Navigation } from "./lib/v1/navigation.mjs";
 import { Posts } from "./lib/v1/posts.mjs";
 import { UrlFormatter } from "./lib/v1/urls.mjs";
-import { Cache } from "./lib/v1/cache.mjs";
 import * as PostQueries from "./lib/postQueries.mjs";
 import * as PostFiltering from "./lib/postFiltering.mjs";
 import * as PostOrdering from "./lib/postOrdering.mjs";
 import * as PostPaging from "./lib/postPaging.mjs";
 import * as FooterMenu from "./lib/footerMenu.mjs";
-import * as Navigation from "./lib/navigation.mjs";
 import * as Taxonomy from "./lib/taxonomy.mjs";
-export { DateFormatter, Markdown, Posts, UrlFormatter, Cache, PostQueries, PostFiltering, PostOrdering, PostPaging, FooterMenu, Navigation, Taxonomy };
+export { Cache, DateFormatter, Markdown, Navigation, Posts, UrlFormatter, PostQueries, PostFiltering, PostOrdering, PostPaging, FooterMenu, Taxonomy };

package/index.mjs

@@ -1,6 +1,7 @@
 import { Cache } from './lib/v1/cache.mjs';
 import { DateFormatter } from './lib/v1/dates.mjs';
 import { Markdown } from './lib/v1/markdown.mjs';
+import { Navigation } from './lib/v1/navigation.mjs';
 import { Posts } from './lib/v1/posts.mjs';
 import { UrlFormatter } from './lib/v1/urls.mjs';
 
@@ -13,11 +14,12 @@ import * as Navigation from './lib/navigation.mjs';
 import * as Taxonomy from './lib/taxonomy.mjs';
 
 export {
+    Cache,
     DateFormatter,
     Markdown,
+    Navigation,
     Posts,
     UrlFormatter,
-    Cache,
     PostQueries,
     PostFiltering,
     PostOrdering,

package/lib/postQueries.d.mts

@@ -27,6 +27,7 @@ export function getAuthors(frontmatter: Frontmatter): Promise<AuthorList>;
 export function getAuthorInfo(slug: string): Promise<AuthorInfo>;
 /**
  * Returns a list of breadcrumbs
+ * @deprecated Use Navigation.breadcrumbs
  * @param {URL} currentUrl
  * @param {Site} site
  * @returns {Promise<NavPage[]>}
@@ -34,6 +35,7 @@ export function getAuthorInfo(slug: string): Promise<AuthorInfo>;
 export function getBreadcrumbs(currentUrl: URL, site: Site): Promise<NavPage[]>;
 /**
  * Converts a MarkdownInstance into a NavPage
+ * @deprecated Use Navigation.mapNavPage()
  * @param {MarkdownInstance} page
  * @param {Site}
  * @returns {NavPage}
@@ -41,12 +43,14 @@ export function getBreadcrumbs(currentUrl: URL, site: Site): Promise<NavPage[]>;
 export function mapNavPage(page: MarkdownInstance, site: any): NavPage;
 /**
  * Walks the tree to set current page
+ * @deprecated Use Navigation.setCurrentPage()
  * @param {NavPage[]} pages
  * @param {URL} currentUrl
  */
 export function setCurrentPage(pages: NavPage[], currentUrl: URL): void;
 /**
  * Pops matching page from array
+ * @deprecated Use Navigation.popMatchingPage()
  * @param {MarkdownInstance[]} allPages
  * @param {string} search
  * @returns

package/lib/postQueries.mjs

@@ -148,6 +148,7 @@ export async function getAuthorInfo (slug) {
 
 /**
  * Returns a list of breadcrumbs
+ * @deprecated Use Navigation.breadcrumbs
  * @param {URL} currentUrl 
  * @param {Site} site
  * @returns {Promise<NavPage[]>}
@@ -181,6 +182,7 @@ export async function getBreadcrumbs (currentUrl, site) {
 
 /**
  * Converts a MarkdownInstance into a NavPage
+ * @deprecated Use Navigation.mapNavPage()
  * @param {MarkdownInstance} page 
  * @param {Site}
  * @returns {NavPage}
@@ -222,6 +224,7 @@ export function mapNavPage (page, site) {
 
 /**
  * Walks the tree to set current page
+ * @deprecated Use Navigation.setCurrentPage()
  * @param {NavPage[]} pages 
  * @param {URL} currentUrl 
  */
@@ -235,6 +238,7 @@ export function setCurrentPage (pages, currentUrl) {
 
 /**
  * Pops matching page from array
+ * @deprecated Use Navigation.popMatchingPage()
  * @param {MarkdownInstance[]} allPages 
  * @param {string} search 
  * @returns 

package/lib/v1/navigation.d.mts

@@ -0,0 +1,42 @@
+/**
+ * @typedef { import("../../types/Astro").MarkdownInstance } MarkdownInstance
+ * @typedef { import("../../types/NavPage").NavPage } NavPage
+ */
+export class Navigation {
+    /**
+     * Constructor
+     * @param {Posts} posts
+     * @param {UrlFormatter} urlFormatter
+     */
+    constructor(posts: Posts, urlFormatter: UrlFormatter);
+    posts: Posts;
+    urlFormatter: UrlFormatter;
+    /**
+     * Returns a list of breadcrumbs
+     * @param {URL} currentUrl
+     * @param {string} subfolder
+     * @returns {NavPage[]}
+     */
+    breadcrumbs(currentUrl: URL, subfolder: string): NavPage[];
+    /**
+     * Walks a NavPage tree to set current page
+     * @param {NavPage[]} pages
+     * @param {URL} currentUrl
+     */
+    setCurrentPage(pages: NavPage[], currentUrl: URL): void;
+    /**
+     * Converts a MarkdownInstance into a NavPage
+     * @param {MarkdownInstance} page
+     * @returns {NavPage}
+     */
+    mapNavPage(page: MarkdownInstance): NavPage;
+    /**
+     * Pops matching page from array
+     * @param {MarkdownInstance[]} allPages
+     * @param {string} search
+     * @returns
+     */
+    popMatchingPage(allPages: MarkdownInstance[], search: string): import("../../types/Astro").MarkdownInstance;
+}
+export type MarkdownInstance = import("../../types/Astro").MarkdownInstance;
+export type NavPage = import("../../types/NavPage").NavPage;

package/lib/v1/navigation.mjs

@@ -0,0 +1,131 @@
+/**
+ * @typedef { import("../../types/Astro").MarkdownInstance } MarkdownInstance
+ * @typedef { import("../../types/NavPage").NavPage } NavPage
+ */
+
+export class Navigation {
+    /**
+     * Constructor
+     * @param {Posts} posts
+     * @param {UrlFormatter} urlFormatter
+     */
+    constructor(posts, urlFormatter) {
+        /* istanbul ignore next */
+        this.posts = posts;
+        this.urlFormatter = urlFormatter;
+    }
+
+    /**
+     * Returns a list of breadcrumbs
+     * @param {URL} currentUrl 
+     * @param {string} subfolder
+     * @returns {NavPage[]}
+     */
+    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;
+    }
+
+    /**
+     * Walks a NavPage tree to set current page
+     * @param {NavPage[]} pages 
+     * @param {URL} 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);
+            }
+        });
+    }
+
+    /**
+     * Converts a MarkdownInstance into a NavPage
+     * @param {MarkdownInstance} page 
+     * @returns {NavPage}
+     */
+    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,
+            title: page.frontmatter.navTitle ?? page.frontmatter.title,
+            url: url,
+            order: page.frontmatter.navOrder,
+            children: [],
+            // These are later set to the correct value, but not now as we want to cache
+            isOpen: false,
+            ariaCurrent: false
+        }
+    
+        return entry;
+    }
+
+    /**
+     * Pops matching page from array
+     * @param {MarkdownInstance[]} allPages 
+     * @param {string} search 
+     * @returns 
+     */
+    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.11",
+  "version": "0.1.12",
   "description": "Astro utilities for Astro Accelerator.",
   "main": "index.mjs",
   "type": "module",