astro-accelerator-utils 0.1.13 → 0.1.15

package/index.d.mts

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

package/index.mjs

@@ -1,3 +1,4 @@
+import { Author } from './lib/v1/authors.mjs';
 import { Cache } from './lib/v1/cache.mjs';
 import { DateFormatter } from './lib/v1/dates.mjs';
 import { Markdown } from './lib/v1/markdown.mjs';
@@ -5,7 +6,6 @@ import { Navigation } from './lib/v1/navigation.mjs';
 import { Posts } from './lib/v1/posts.mjs';
 import { UrlFormatter } from './lib/v1/urls.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';
@@ -14,13 +14,13 @@ import * as NavigationX from './lib/navigation.mjs';
 import * as Taxonomy from './lib/taxonomy.mjs';
 
 export {
+    Author,
     Cache,
     DateFormatter,
     Markdown,
     Navigation,
     Posts,
     UrlFormatter,
-    PostQueries,
     PostFiltering,
     PostOrdering,
     PostPaging,

package/lib/footerMenu.mjs

@@ -1,6 +1,9 @@
+import { Cache } from './v1/cache.mjs';
+import { Navigation } from './v1/navigation.mjs';
+import { Posts } from './v1/posts.mjs';
+import { UrlFormatter } from './v1/urls.mjs';
+
 import * as Taxonomy from './taxonomy.mjs';
-import * as Navigation from './navigation.mjs';
-import * as PostQueries from './postQueries.mjs';
 
 /**
  * @typedef { import("../types/NavPage").NavPage } NavPage
@@ -20,6 +23,11 @@ import * as PostQueries from './postQueries.mjs';
  * @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 navigation = new Navigation(posts, urlFormatter);
     const links = Taxonomy.taxonomyLinks(translations, _, site);
 
     /** @type {NavPage[]} */
@@ -27,7 +35,7 @@ export async function getMenu (currentUrl,  _, translations, site, menu) {
 
     for (let i = 0; i < menu.length; i++) {
         const item = menu[i];
-        if (Navigation.isNavPage(item)) {
+        if (navigation.isNavPage(item)) {
             pages.push(item);
         } else {
             switch (item) {
@@ -53,7 +61,7 @@ export async function getMenu (currentUrl,  _, translations, site, menu) {
         }
     }
 
-    PostQueries.setCurrentPage(pages, currentUrl);
+    navigation.setCurrentPage(pages, currentUrl);
 
     return pages;
 }

package/lib/taxonomy.d.mts

@@ -15,7 +15,7 @@ export function sortByTitle(a: TaxonomyEntry, b: TaxonomyEntry): 0 | 1 | -1;
 export function taxonomyLinks(translations: any, lang: (entry: any) => string, site: Site): TaxonomyLinks;
 /**
  *
- * @returns {Promise<Taxonomy}
+ * @returns {Promise<Taxonomy>}
  */
 export function getTaxonomy(): Promise<Taxonomy>;
 export type Site = import("../types/Site").Site;

package/lib/taxonomy.mjs

@@ -1,6 +1,6 @@
 import { Cache } from './v1/cache.mjs';
+import { Posts } from './v1/posts.mjs';
 import { UrlFormatter } from './v1/urls.mjs';
-import * as PostQueries from './postQueries.mjs';
 import * as PostFiltering from './postFiltering.mjs';
 
 /**
@@ -12,6 +12,7 @@ import * as PostFiltering from './postFiltering.mjs';
  */
 
 const cache = new Cache(200);
+const posts = new Posts(cache);
 
 /**
  * 
@@ -60,7 +61,7 @@ export function taxonomyLinks(translations, lang, site) {
 
 /**
  * 
- * @returns {Promise<Taxonomy}
+ * @returns {Promise<Taxonomy>}
  */
 export async function getTaxonomy () {
     const cacheKey = 'Global__taxonomy';
@@ -70,7 +71,7 @@ export async function getTaxonomy () {
 
     if (taxonomy == null) {
         /** @type {MarkdownInstance[]} */
-        const allPages = await PostQueries.getPages(PostFiltering.isListable);
+        const allPages = posts.all().filter(PostFiltering.isListable);
         
         /** @type {{ [key: string]: number }} */
         const tags = {};

package/lib/v1/authors.d.mts

@@ -0,0 +1,26 @@
+/**
+ * @typedef { import("../../types/AuthorList").AuthorList } AuthorList
+ * @typedef { import('../../types/Astro').MarkdownInstance } MarkdownInstance
+ */
+export class Authors {
+    /**
+     * Constructor
+     * @param {Posts} posts
+     */
+    constructor(posts: Posts);
+    posts: Posts;
+    /**
+     * Gets a list of authors, and exposes main author and contributors
+     * @param {Frontmatter} frontmatter
+     * @returns {AuthorList}
+     */
+    forPage(frontmatter: Frontmatter): AuthorList;
+    /**
+     * Get a single author by id/slug
+     * @param {string} slug
+     * @returns {MarkdownInstance}
+     */
+    info(slug: string): MarkdownInstance;
+}
+export type AuthorList = import("../../types/AuthorList").AuthorList;
+export type MarkdownInstance = import('../../types/Astro').MarkdownInstance;

package/lib/v1/authors.mjs

@@ -0,0 +1,71 @@
+import * as PostFiltering from '../postFiltering.mjs';
+
+/**
+ * @typedef { import("../../types/AuthorList").AuthorList } AuthorList
+ * @typedef { import('../../types/Astro').MarkdownInstance } MarkdownInstance
+ */
+
+export class Authors {
+    /**
+     * Constructor
+     * @param {Posts} posts
+     */
+    constructor(posts) {
+        this.posts = posts;
+    }
+
+    /**
+     * Gets a list of authors, and exposes main author and contributors
+     * @param {Frontmatter} frontmatter 
+     * @returns {AuthorList}
+     */
+    forPage (frontmatter) {
+        const authors = this.posts.all()
+            .filter(PostFiltering.isAuthor);
+
+        /** @type {AuthorList} */
+        const result = {
+            image: null,
+            writers: [],
+            mainAuthor: null,
+            contributors: []
+        };
+
+        (frontmatter.authors ?? []).forEach((a) => {
+            const matches = authors.filter((x) => x.frontmatter.id == a);
+
+            if (matches.length == 0) {
+                console.warn("Unknown author", a);
+            }
+
+            if (matches.length > 1) {
+                console.warn("Multiple authors with id", a);
+            }
+
+            if (matches.length == 1) {
+                result.writers.push(matches[0]);
+                if (result.image == null) {
+                    result.image = matches[0].frontmatter.bannerImage;
+                }
+            }
+        });
+
+        result.mainAuthor = result.writers.slice(0, 1)[0];
+        result.contributors = result.writers.slice(1);
+
+        return result;
+    }
+
+    /**
+     * Get a single author by id/slug
+     * @param {string} slug 
+     * @returns {MarkdownInstance}
+     */
+    info (slug) {
+        const author = this.posts.all()
+            .filter(PostFiltering.isAuthor)
+            .filter(x => x.url?.split('/')[2] == slug)[0];
+
+        return author;
+    }
+}

package/package.json

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

package/lib/navigation.d.mts

@@ -1,23 +0,0 @@
-/**
- * @deprecated Use Navigation.menu()
- * @param {URL} currentUrl
- * @param {Site} site
- * @param {NavPage | 'auto'} menu
- * @returns {Promise<NavPage[]}
- */
-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[]}
- */
-export function getNavigation(currentUrl: URL, site: Site): Promise<NavPage[]>;
-export type Site = import("../types/Site").Site;
-export type NavPage = import("../types/NavPage").NavPage;

package/lib/navigation.mjs

@@ -1,115 +0,0 @@
-import { Posts } from './v1/posts.mjs';
-import { Cache } from './v1/cache.mjs';
-import * as PostQueries from './postQueries.mjs';
-import * as PostFiltering from './postFiltering.mjs';
-
-/**
- * @typedef { import("../types/Site").Site } Site
- * @typedef { import("../types/NavPage").NavPage } NavPage
- */
-
-const cache = new Cache(200);
-
-/**
- * @deprecated Use Navigation.menu()
- * @param {URL} currentUrl 
- * @param {Site} site 
- * @param {NavPage | 'auto'} menu
- * @returns {Promise<NavPage[]}
- */
-export async function getMenu (currentUrl, site, menu) {
-    const key = 'Navigation__getMenu';
-
-    /** @type {NavPage[]} */
-    let pages = cache.getItem(key);
-
-    if (pages == null) {
-        pages = [];
-        for (let i = 0; i < menu.length; i++) {
-            const item = menu[i];
-            if (isNavPage(item)) {
-                pages.push(item);
-            } else {
-                const p = await getNavigation(currentUrl, site);
-                for (let j = 0; j < p.length; j++) {
-                    pages.push(p[j]);
-                }
-            }
-        }
-
-        // Cache the result
-        cache.setItem(key, pages);
-    }
-
-    PostQueries.setCurrentPage(pages, currentUrl);
-
-    return pages;
-}
-
-/**
- * @deprecated Use Navigation.isNavPage
- * @param {NavPage | 'auto' | 'tags' | 'toptags' | 'categories'} item 
- * @returns {item is NavPage}
- */
-export function isNavPage (item) {
-    if (typeof item === 'string' && ['auto', 'tags', 'toptags', 'categories'].includes(item)) {
-      return false;
-    }
-  
-    return true;
-  }
-  
-
-/**
- * @deprecated Use Navigation.autoMenu()
- * @param {URL} currentUrl 
- * @param {Site} site 
- * @returns {Promise<NavPage[]}
- */
-export async function getNavigation (currentUrl, site) {
-
-    const key = 'Navigation__getNavigation';
-    const posts = new Posts(cache);
-
-    /** @type {NavPage[]} */
-    let pageHierarchy = cache.getItem(key);
-
-    if (pageHierarchy == null) {
-        const topLevelPages = posts.root(site.subfolder).filter(PostFiltering.showInMenu);
-        const allPages = posts.all().filter(PostFiltering.showInMenu);
-
-        pageHierarchy = topLevelPages
-            .map(p => PostQueries.mapNavPage(p, site))
-            .sort((a, b) => a.order - b.order);
-            
-        /** @type {NavPage[]} */
-        const pageList = allPages.map(p => PostQueries.mapNavPage(p, site));
-
-        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);
-            }
-        }
-
-        // Cache the result
-        cache.setItem(key, pageHierarchy);
-    }
-
-    return pageHierarchy;
-}

package/lib/postQueries.d.mts

@@ -1,65 +0,0 @@
-/**
- * Replaced by Posts.all()
- * @deprecated Use Posts.all().filter(...) to filter results
- * @param {PagePredicate} [filter]
- * @returns {Promise<MarkdownInstance[]>}
- */
-export function getPages(filter?: PagePredicate): Promise<MarkdownInstance[]>;
-/**
- * Replaced by Posts.root()
- * @deprecated Use Posts.root().filter(...) to filter results
- * @param {Site} site
- * @param {PagePredicate} [filter]
- * @returns {Promise<MarkdownInstance[]>}
- */
-export function getTopLevelPages(site: Site, filter?: PagePredicate): Promise<MarkdownInstance[]>;
-/**
- * Gets a list of authors, and exposes main author and contributors
- * @param {Frontmatter} frontmatter
- * @returns {Promise<AuthorList>}
- */
-export function getAuthors(frontmatter: Frontmatter): Promise<AuthorList>;
-/**
- * Get a single author by id/slug
- * @param {string} slug
- * @returns {Promise<AuthorInfo>}
- */
-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[]>}
- */
-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}
- */
-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
- */
-export function popMatchingPage(allPages: MarkdownInstance[], search: string): import("../types/Astro").MarkdownInstance;
-export type PagePredicate = import("../types/PagePredicate").PagePredicate;
-export type Frontmatter = import("../types/Frontmatter").Frontmatter;
-export type MarkdownInstance = import("../types/Astro").MarkdownInstance;
-export type AuthorList = import("../types/AuthorList").AuthorList;
-export type AuthorInfo = import("../types/AuthorInfo").AuthorInfo;
-export type NavPage = import("../types/NavPage").NavPage;
-export type Site = import("../types/Site").Site;

package/lib/postQueries.mjs

@@ -1,263 +0,0 @@
-import { Cache } from './v1/cache.mjs';
-import { UrlFormatter } from './v1/urls.mjs';
-import * as PostFiltering from './postFiltering.mjs';
-
-/**
- * @typedef { import("../types/PagePredicate").PagePredicate } PagePredicate
- * @typedef { import("../types/Frontmatter").Frontmatter } Frontmatter
- * @typedef { import("../types/Astro").MarkdownInstance } MarkdownInstance
- * @typedef { import("../types/AuthorList").AuthorList } AuthorList
- * @typedef { import("../types/AuthorInfo").AuthorInfo } AuthorInfo
- * @typedef { import("../types/NavPage").NavPage } NavPage
- * @typedef { import("../types/Site").Site } Site
- */
-
-/* istanbul ignore next */
-/** @type {() => MarkdownInstance[]} */
-let fetchAll = () => {
-    return import.meta.glob("/src/pages/**/*.md", { eager: true });
-}
-
-const cache = new Cache(200);
-
-/**
- * Replaced by Posts.all()
- * @deprecated Use Posts.all().filter(...) to filter results
- * @param {PagePredicate} [filter]
- * @returns {Promise<MarkdownInstance[]>}
- */
-export async function getPages (filter) {
-    const key = 'PageQueries__getPages';
-    let allPages = cache.getItem(key);
-
-    if (allPages == null) {
-        const pageImportResult = fetchAll();
-        allPages = Object.values(pageImportResult);
-        cache.setItem(key, allPages);
-    }
-
-    if (filter == null) {
-        return allPages;
-    }
-
-    return allPages.filter(filter);
-}
-
-/**
- * Replaced by Posts.root()
- * @deprecated Use Posts.root().filter(...) to filter results
- * @param {Site} site
- * @param {PagePredicate} [filter] 
- * @returns {Promise<MarkdownInstance[]>}
- */
-export async function getTopLevelPages (site, filter) {
-    const key = 'PageQueries__getTopLevelPages';
-    
-    /** @type {MarkdownInstance[]} */
-    let allPages = cache.getItem(key);
-
-    if (allPages == null) {
-        allPages = await getPages();
-
-        const isRoot = site.subfolder.length == 0;
-        const expectedDepth = isRoot ? 1 : 2;
-        allPages = allPages.filter(p => {
-            const depth = (p.url ?? '/').split('/').length - 1;
-            return depth == expectedDepth
-                || (depth == (expectedDepth - 1) && p.file.includes(site.subfolder.toLowerCase() + '.md'));
-        });
-
-        cache.setItem(key, allPages);
-    }
-
-    if (filter == null) {
-        return allPages;
-    }
-
-    return allPages.filter(filter);
-}
-
-/**
- * Gets a list of authors, and exposes main author and contributors
- * @param {Frontmatter} frontmatter 
- * @returns {Promise<AuthorList>}
- */
-export async function getAuthors (frontmatter) {
-    const authors = await getPages(fetchAll, PostFiltering.isAuthor);
-
-    /** @type {AuthorList} */
-    const result = {
-        image: null,
-        writers: [],
-        mainAuthor: null,
-        contributors: []
-    };
-
-    (frontmatter.authors ?? []).forEach((a) => {
-        const matches = authors.filter((x) => x.frontmatter.id == a);
-
-        if (matches.length == 0) {
-            console.warn("Unknown author", a);
-        }
-
-        if (matches.length > 1) {
-            console.warn("Multiple authors with id", a);
-        }
-
-        if (matches.length == 1) {
-            result.writers.push(matches[0]);
-            if (result.image == null) {
-                result.image = matches[0].frontmatter.bannerImage;
-            }
-        }
-    });
-
-    result.mainAuthor = result.writers.slice(0, 1)[0];
-    result.contributors = result.writers.slice(1);
-
-    return result;
-}
-
-/**
- * Get a single author by id/slug
- * @param {string} slug 
- * @returns {Promise<AuthorInfo>}
- */
-export async function getAuthorInfo (slug) {
-    const cacheKey = 'Global__author_info';
-    
-    /** @type {AuthorInfo} */
-    let authorInfo = cache.getItem(cacheKey);
-
-    if (authorInfo == null) {
-        const allPages = await getPages();
-
-        const author = allPages
-            .filter(PostFiltering.isAuthor)
-            .filter(x => x.url?.split('/')[2] == slug)[0];
-
-        authorInfo = {
-            frontmatter: author.frontmatter
-        };
-  
-        cache.setItem(cacheKey, authorInfo);
-    }
-
-    return authorInfo;
-}
-
-/**
- * Returns a list of breadcrumbs
- * @deprecated Use Navigation.breadcrumbs
- * @param {URL} currentUrl 
- * @param {Site} site
- * @returns {Promise<NavPage[]>}
- */
-export async function getBreadcrumbs (currentUrl, site) {
-    const allPages = await getPages();
-
-    const pathParts = currentUrl.pathname.split('/');
-
-    if (site.subfolder.length > 0) {
-        pathParts.shift();
-    }
-    
-    /** @type {NavPage[]} */
-    const navPages = [];
-    let path = '';
-
-    pathParts.forEach((part) => {
-        path += part.length > 0 ? '/' + part : '';
-        const match = popMatchingPage(allPages, path);
-
-        if (match) {
-            navPages.push(mapNavPage(match, site));
-        }
-    });
-
-    setCurrentPage(navPages, currentUrl);
-
-    return navPages;
-}
-
-/**
- * Converts a MarkdownInstance into a NavPage
- * @deprecated Use Navigation.mapNavPage()
- * @param {MarkdownInstance} page 
- * @param {Site}
- * @returns {NavPage}
- */
-export function mapNavPage (page, site) {
-
-    const urlFormatter = new UrlFormatter(site.url);
-
-    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 = 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;
-};
-
-/**
- * Walks the tree to set current page
- * @deprecated Use Navigation.setCurrentPage()
- * @param {NavPage[]} pages 
- * @param {URL} currentUrl 
- */
-export function setCurrentPage (pages, currentUrl) {
-    pages.forEach(p => {
-        p.isOpen = currentUrl.pathname.startsWith(p.url);
-        p.ariaCurrent = p.url == currentUrl.pathname ? 'page': false;
-        if (p.children) setCurrentPage(p.children, currentUrl);
-    });
-}
-
-/**
- * Pops matching page from array
- * @deprecated Use Navigation.popMatchingPage()
- * @param {MarkdownInstance[]} allPages 
- * @param {string} search 
- * @returns 
- */
-export function 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/types/AuthorInfo.d.ts

@@ -1,4 +0,0 @@
-import { Frontmatter } from "./Frontmatter";
-export interface AuthorInfo {
-    frontmatter: Frontmatter;
-}