astro-accelerator-utils 0.0.36 → 0.0.38

package/index.d.mts

@@ -4,8 +4,9 @@ import * as PostOrdering from "./lib/postOrdering.mjs";
 import * as PostPaging from "./lib/postPaging.mjs";
 import * as Cache from "./lib/cache.mjs";
 import * as Dates from "./lib/dates.mjs";
+import * as FooterMenu from "./lib/footerMenu.mjs";
 import * as Markdown from "./lib/markdown.mjs";
 import * as Navigation from "./lib/navigation.mjs";
 import * as Taxonomy from "./lib/taxonomy.mjs";
 import * as Urls from "./lib/urls.mjs";
-export { PostQueries, PostFiltering, PostOrdering, PostPaging, Cache, Dates, Markdown, Navigation, Taxonomy, Urls };
+export { PostQueries, PostFiltering, PostOrdering, PostPaging, Cache, Dates, FooterMenu, Markdown, Navigation, Taxonomy, Urls };

package/index.mjs

@@ -4,6 +4,7 @@ import * as PostOrdering from './lib/postOrdering.mjs';
 import * as PostPaging from './lib/postPaging.mjs';
 import * as Cache from './lib/cache.mjs';
 import * as Dates from './lib/dates.mjs';
+import * as FooterMenu from './lib/footerMenu.mjs';
 import * as Markdown from './lib/markdown.mjs';
 import * as Navigation from './lib/navigation.mjs';
 import * as Taxonomy from './lib/taxonomy.mjs';
@@ -16,6 +17,7 @@ export {
     PostPaging,
     Cache,
     Dates,
+    FooterMenu,
     Markdown,
     Navigation,
     Taxonomy,

package/lib/footerMenu.d.mts

@@ -0,0 +1,49 @@
+/**
+ * @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
+ */
+export function getMenu(currentUrl: URL, _: TranslationProvider, translations: any, site: any, menu: (NavPage | 'categories' | 'tags' | 'toptags')[]): Promise<import("../types/NavPage").NavPage[]>;
+/**
+ *
+ * @param {TaxonomyLinks} links
+ * @param {TranslationProvider} _
+ * @param {any} translations
+ * @param {Site} site
+ * @returns {Promise<NavPage[]>}
+ */
+export function getCategories(links: TaxonomyLinks, _: TranslationProvider, translations: any, site: any): Promise<NavPage[]>;
+/**
+ *
+ * @param {TaxonomyLinks} links
+ * @param {TranslationProvider} _
+ * @param {any} translations
+ * @param {Site} site
+ * @returns {Promise<NavPage[]>}
+ */
+export function getTags(links: TaxonomyLinks, _: TranslationProvider, translations: any, site: any): Promise<NavPage[]>;
+/**
+ *
+ * @param {TaxonomyLinks} links
+ * @param {TranslationProvider} _
+ * @param {any} translations
+ * @param {Site} site
+ * @returns {Promise<NavPage[]>}
+ */
+export function getTopTags(links: TaxonomyLinks, _: TranslationProvider, translations: any, site: any): 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

@@ -0,0 +1,178 @@
+import * as Taxonomy from './taxonomy.mjs';
+import * as Navigation from './navigation.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 
+ */
+export async function getMenu (currentUrl,  _, translations, site, menu) {
+    const links = Taxonomy.taxonomyLinks(translations, _, site);
+
+    /** @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);
+                    for (let j = 0; j < tags.length; j++) {
+                        pages.push(tags[j]);
+                    }
+                    break;
+                case 'toptags':
+                    const toptags = await getTopTags(links, _, translations, site);
+                    for (let j = 0; j < toptags.length; j++) {
+                        pages.push(toptags[j]);
+                    }
+                    break;
+                case 'categories':
+                    const categories = await getCategories(links, _, translations, site);
+                    for (let j = 0; j < categories.length; j++) {
+                        pages.push(categories[j]);
+                    }
+                    break;
+            }
+        }
+    }
+
+    PostQueries.setCurrentPage(pages, currentUrl);
+
+    return pages;
+}
+
+/**
+ * 
+ * @param {TaxonomyLinks} links 
+ * @param {TranslationProvider} _ 
+ * @param {any} translations 
+ * @param {Site} site 
+ * @returns {Promise<NavPage[]>}
+ */
+export async function getCategories (links, _, translations, site) {
+
+    const category = _(translations.articles.category) ?? 'category';
+    const categoryTitle = _(translations.articles.category_title) ?? 'Categories';
+    const categoryLink = `${site.subfolder}/${category}/`;
+
+    let order = 0;
+
+    const taxonomy = await Taxonomy.getTaxonomy();
+
+    /** @type {NavPage[]} */
+    const pageHierarchy = [{
+        title: categoryTitle,
+        url: categoryLink,
+        ariaCurrent: false,
+        isOpen: false,
+        order: 1,
+        children: taxonomy.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 
+ * @returns {Promise<NavPage[]>}
+ */
+export async function getTags (links, _, translations, site) {
+
+    const tag = _(translations.articles.tag) ?? 'tag';
+    const tagTitle = _(translations.articles.tag_title) ?? 'Tags';
+    const tagLink = `${site.subfolder}/${tag}/`;
+
+    let order = 0;
+
+    const taxonomy = await Taxonomy.getTaxonomy();
+
+    /** @type {NavPage[]} */
+    const pageHierarchy = [{
+        title: tagTitle,
+        url: tagLink,
+        ariaCurrent: false,
+        isOpen: false,
+        order: 1,
+        children: taxonomy.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 
+ * @returns {Promise<NavPage[]>}
+ */
+export async function getTopTags (links, _, translations, site) {
+
+    const tag = _(translations.articles.tag) ?? 'tag';
+    const tagTitle = _(translations.articles.tag_title) ?? 'Tags';
+    const tagLink = `${site.subfolder}/${tag}/`;
+
+    let order = 0;
+
+    const taxonomy = await Taxonomy.getTaxonomy();
+
+    /** @type {NavPage[]} */
+    const pageHierarchy = [{
+        title: tagTitle,
+        url: tagLink,
+        ariaCurrent: false,
+        isOpen: false,
+        order: 1,
+        children: taxonomy.topTags.map(item => {
+            return {
+                title: item.title,
+                url: links.getTagLink(item.title),
+                ariaCurrent: false,
+                isOpen: false,
+                order: ++order,
+                children: []
+            };
+        })
+    }];
+
+    return pageHierarchy;
+}

package/lib/navigation.d.mts

@@ -6,9 +6,10 @@
  *
  * @param {URL} currentUrl
  * @param {Site} site
+ * @param {NavPage | 'auto'} menu
  * @returns {Promise<NavPage[]}
  */
-export function getMenu(currentUrl: URL, site: Site): Promise<NavPage[]>;
+export function getMenu(currentUrl: URL, site: Site, menu: NavPage | 'auto'): Promise<NavPage[]>;
 /**
  *
  * @param {NavPage | 'auto' | 'tags' | 'toptags' | 'categories'} item

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "astro-accelerator-utils",
-  "version": "0.0.36",
+  "version": "0.0.38",
   "description": "Astro utilities for Astro Accelerator.",
   "main": "index.mjs",
   "files": [

package/types/Translations.d.ts

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