astro-accelerator-utils 0.1.12 → 0.1.13

package/index.d.mts

@@ -9,5 +9,6 @@ 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 NavigationX from "./lib/navigation.mjs";
 import * as Taxonomy from "./lib/taxonomy.mjs";
-export { Cache, DateFormatter, Markdown, Navigation, Posts, UrlFormatter, PostQueries, PostFiltering, PostOrdering, PostPaging, FooterMenu, Taxonomy };
+export { Cache, DateFormatter, Markdown, Navigation, Posts, UrlFormatter, PostQueries, PostFiltering, PostOrdering, PostPaging, FooterMenu, NavigationX, Taxonomy };

package/index.mjs

@@ -10,7 +10,7 @@ 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 NavigationX from './lib/navigation.mjs';
 import * as Taxonomy from './lib/taxonomy.mjs';
 
 export {
@@ -25,6 +25,6 @@ export {
     PostOrdering,
     PostPaging,
     FooterMenu,
-    Navigation,
+    NavigationX,
     Taxonomy
 };

package/lib/navigation.d.mts

@@ -1,5 +1,5 @@
 /**
- *
+ * @deprecated Use Navigation.menu()
  * @param {URL} currentUrl
  * @param {Site} site
  * @param {NavPage | 'auto'} menu
@@ -7,13 +7,13 @@
  */
 export function getMenu(currentUrl: URL, site: Site, menu: NavPage | 'auto'): Promise<NavPage[]>;
 /**
- *
+ * @deprecated Use Navigation.isNavPage
  * @param {NavPage | 'auto' | 'tags' | 'toptags' | 'categories'} item
  * @returns {item is NavPage}
  */
 export function isNavPage(item: NavPage | 'auto' | 'tags' | 'toptags' | 'categories'): item is import("../types/NavPage").NavPage;
 /**
- *
+ * @deprecated Use Navigation.autoMenu()
  * @param {URL} currentUrl
  * @param {Site} site
  * @returns {Promise<NavPage[]}

package/lib/navigation.mjs

@@ -11,7 +11,7 @@ import * as PostFiltering from './postFiltering.mjs';
 const cache = new Cache(200);
 
 /**
- * 
+ * @deprecated Use Navigation.menu()
  * @param {URL} currentUrl 
  * @param {Site} site 
  * @param {NavPage | 'auto'} menu
@@ -47,7 +47,7 @@ export async function getMenu (currentUrl, site, menu) {
 }
 
 /**
- * 
+ * @deprecated Use Navigation.isNavPage
  * @param {NavPage | 'auto' | 'tags' | 'toptags' | 'categories'} item 
  * @returns {item is NavPage}
  */
@@ -61,7 +61,7 @@ export function isNavPage (item) {
   
 
 /**
- * 
+ * @deprecated Use Navigation.autoMenu()
  * @param {URL} currentUrl 
  * @param {Site} site 
  * @returns {Promise<NavPage[]}

package/lib/v1/navigation.d.mts

@@ -18,6 +18,20 @@ export class Navigation {
      * @returns {NavPage[]}
      */
     breadcrumbs(currentUrl: URL, subfolder: string): NavPage[];
+    /**
+     *
+     * @param {URL} currentUrl
+     * @param {string} subfolder
+     * @param {(NavPage | 'auto')[]} menu
+     * @returns {NavPage[]}
+     */
+    menu(currentUrl: URL, subfolder: string, menu: (NavPage | 'auto')[]): NavPage[];
+    /**
+     *
+     * @param {string} subfolder
+     * @returns {NavPage[]}
+     */
+    autoMenu(subfolder: string): NavPage[];
     /**
      * Walks a NavPage tree to set current page
      * @param {NavPage[]} pages
@@ -30,6 +44,12 @@ export class Navigation {
      * @returns {NavPage}
      */
     mapNavPage(page: MarkdownInstance): NavPage;
+    /**
+     * Checks whether the item is a NavPage
+     * @param {NavPage | 'auto' | 'tags' | 'toptags' | 'categories'} item
+     * @returns {item is NavPage}
+     */
+    isNavPage(item: NavPage | 'auto' | 'tags' | 'toptags' | 'categories'): item is import("../../types/NavPage").NavPage;
     /**
      * Pops matching page from array
      * @param {MarkdownInstance[]} allPages

package/lib/v1/navigation.mjs

@@ -1,3 +1,5 @@
+import * as PostFiltering from '../postFiltering.mjs';
+
 /**
  * @typedef { import("../../types/Astro").MarkdownInstance } MarkdownInstance
  * @typedef { import("../../types/NavPage").NavPage } NavPage
@@ -49,6 +51,79 @@ export class Navigation {
         return navPages;
     }
 
+    /**
+     * 
+     * @param {URL} currentUrl 
+     * @param {string} subfolder
+     * @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]);
+                    }
+                }
+            }
+
+        this.setCurrentPage(pages, currentUrl);
+
+        return pages;
+    }
+
+    /**
+     * 
+     * @param {string} subfolder 
+     * @returns {NavPage[]}
+     */
+    autoMenu (subfolder) {
+        const allPages = this.posts
+            .all()
+            .filter(PostFiltering.showInMenu);
+
+        const topLevelPages = this.posts
+            .root(subfolder)
+            .filter(PostFiltering.showInMenu);
+
+        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));
+
+        for (let i = 0; i < pageHierarchy.length; i++) {
+            const page = pageHierarchy[i];
+
+            if (i > 0) {
+                // Don't add children to first link (Home)
+                page.children = pageList
+                    .filter((mp) =>
+                        page.url != '/'
+                        && mp.url != page.url
+                        && mp.url.startsWith(page.url)
+                    )
+                    .sort((mp) => mp.order);
+            }
+
+            if (page.children.length > 0) {
+                const ownChild = structuredClone(page);
+                ownChild.order = -1;
+                ownChild.children = [];
+                page.children.push(ownChild);
+            }
+        }
+
+        return pageHierarchy;
+    }
+
+
     /**
      * Walks a NavPage tree to set current page
      * @param {NavPage[]} pages 
@@ -104,6 +179,20 @@ export class Navigation {
         return entry;
     }
 
+
+    /**
+     * Checks whether the item is a NavPage
+     * @param {NavPage | 'auto' | 'tags' | 'toptags' | 'categories'} item 
+     * @returns {item is NavPage}
+     */
+    isNavPage (item) {
+        if (typeof item === 'string' && ['auto', 'tags', 'toptags', 'categories'].includes(item)) {
+            return false;
+        }
+    
+        return true;
+    }
+
     /**
      * Pops matching page from array
      * @param {MarkdownInstance[]} allPages 

package/lib/v1/posts.mjs

@@ -35,6 +35,7 @@ export class Posts {
      * @returns {MarkdownInstance[]}
      */
     root (subfolder) {
+        console.log('SUBFOLDER IS', subfolder)
         const isRoot = subfolder.length == 0;
         const expectedDepth = isRoot ? 1 : 2;
 

package/package.json

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