astro-accelerator-utils 0.1.18 → 0.1.19

package/index.d.mts

@@ -5,10 +5,9 @@ import { Markdown } from "./lib/v1/markdown.mjs";
 import { Navigation } from "./lib/v1/navigation.mjs";
 import { Paging } from "./lib/v1/paging.mjs";
 import { Posts } from "./lib/v1/posts.mjs";
+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 PostPaging from "./lib/postPaging.mjs";
 import * as FooterMenu from "./lib/footerMenu.mjs";
-import * as Taxonomy from "./lib/taxonomy.mjs";
-export { Authors, Cache, DateFormatter, Markdown, Navigation, Paging, Posts, UrlFormatter, PostFiltering, PostOrdering, PostPaging, FooterMenu, Taxonomy };
+export { Authors, Cache, DateFormatter, Markdown, Navigation, Paging, Posts, Taxonomy, UrlFormatter, PostFiltering, PostOrdering, FooterMenu };

package/index.mjs

@@ -5,13 +5,12 @@ import { Markdown } from './lib/v1/markdown.mjs';
 import { Navigation } from './lib/v1/navigation.mjs';
 import { Paging } from './lib/v1/paging.mjs';
 import { Posts } from './lib/v1/posts.mjs';
+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 PostPaging from './lib/postPaging.mjs';
 import * as FooterMenu from './lib/footerMenu.mjs';
-import * as Taxonomy from './lib/taxonomy.mjs';
 
 export {
     Authors,
@@ -21,10 +20,9 @@ export {
     Navigation,
     Paging,
     Posts,
+    Taxonomy,
     UrlFormatter,
     PostFiltering,
     PostOrdering,
-    PostPaging,
-    FooterMenu,
-    Taxonomy
+    FooterMenu
 };

package/lib/v1/taxonomy.d.mts

@@ -0,0 +1,62 @@
+/**
+ * @typedef { import("./cache.mjs").Cache } Cache
+ * @typedef { import("./posts.mjs").Posts } Posts
+ * @typedef { import("./urls.mjs").UrlFormatter } UrlFormatter
+ * @typedef { import("../../types/Site").Site } Site
+ * @typedef { import("../../types/Taxonomy").TaxonomyList } TaxonomyList
+ * @typedef { import("../../types/Taxonomy").TaxonomyEntry } TaxonomyEntry
+ * @typedef { import("../../types/Taxonomy").TaxonomyLinks } TaxonomyLinks
+ * @typedef { import("../../types/Astro").MarkdownInstance } MarkdownInstance
+ */
+export class Taxonomy {
+    /**
+     * Constructor
+     * @param {Cache} cache
+     * @param {Posts} posts
+     * @param {UrlFormatter} urlFormatter
+     */
+    constructor(cache: Cache, posts: Posts, urlFormatter: UrlFormatter);
+    cache: import("./cache.mjs").Cache;
+    posts: import("./posts.mjs").Posts;
+    urlFormatter: import("./urls.mjs").UrlFormatter;
+    /**
+     *
+     * @returns {TaxonomyList}
+     */
+    all(): TaxonomyList;
+    /**
+     *
+     * @param {any} translations
+     * @param {(entry: any) => string} lang
+     * @param {string} subfolder
+     * @returns {TaxonomyLinks}
+     */
+    links(translations: any, lang: (entry: any) => string, subfolder: string): TaxonomyLinks;
+    /**
+     *
+     * @returns {TaxonomyList}
+     */
+    getTaxonomy(): TaxonomyList;
+    /**
+     * Sorts taxonomy entries by title
+     * @param {TaxonomyEntry} a
+     * @param {TaxonomyEntry} b
+     * @returns
+     */
+    sortByTitle(a: TaxonomyEntry, b: TaxonomyEntry): 0 | 1 | -1;
+    /**
+     * Sorts taxonomy entries by title
+     * @param {TaxonomyEntry} a
+     * @param {TaxonomyEntry} b
+     * @returns
+     */
+    sortByVolume(a: TaxonomyEntry, b: TaxonomyEntry): number;
+}
+export type Cache = import("./cache.mjs").Cache;
+export type Posts = import("./posts.mjs").Posts;
+export type UrlFormatter = import("./urls.mjs").UrlFormatter;
+export type Site = import("../../types/Site").Site;
+export type TaxonomyList = import("../../types/Taxonomy").TaxonomyList;
+export type TaxonomyEntry = import("../../types/Taxonomy").TaxonomyEntry;
+export type TaxonomyLinks = import("../../types/Taxonomy").TaxonomyLinks;
+export type MarkdownInstance = import("../../types/Astro").MarkdownInstance;

package/lib/v1/taxonomy.mjs

@@ -0,0 +1,145 @@
+import * as PostFiltering from '../postFiltering.mjs';
+
+/**
+ * @typedef { import("./cache.mjs").Cache } Cache
+ * @typedef { import("./posts.mjs").Posts } Posts
+ * @typedef { import("./urls.mjs").UrlFormatter } UrlFormatter
+ * @typedef { import("../../types/Site").Site } Site
+ * @typedef { import("../../types/Taxonomy").TaxonomyList } TaxonomyList
+ * @typedef { import("../../types/Taxonomy").TaxonomyEntry } TaxonomyEntry
+ * @typedef { import("../../types/Taxonomy").TaxonomyLinks } TaxonomyLinks
+ * @typedef { import("../../types/Astro").MarkdownInstance } MarkdownInstance
+ */
+
+export class Taxonomy {
+
+    /**
+     * Constructor
+     * @param {Cache} cache 
+     * @param {Posts} posts 
+     * @param {UrlFormatter} urlFormatter
+     */
+    constructor(cache, posts, urlFormatter) {
+        this.cache = cache;
+        this.posts = posts;
+        this.urlFormatter = urlFormatter;
+    }
+
+    /**
+     * 
+     * @returns {TaxonomyList}
+     */
+    all() {
+        const taxonomy = this.cache.get('v1_taxonomy.all', () => this.getTaxonomy());
+        return taxonomy;
+    }
+
+    /**
+     * 
+     * @param {any} translations 
+     * @param {(entry: any) => string} lang 
+     * @param {string} subfolder 
+     * @returns {TaxonomyLinks}
+     */
+    links(translations, lang, subfolder) {
+        const category = lang(translations.articles.category) ?? 'category';
+        const categoryLink = `${subfolder}/${category}/`;
+
+        const tag = lang(translations.articles.tag) ?? 'tag';
+        const tagLink = `${subfolder}/${tag}/`;
+
+        return {
+            tag: tag,
+            category: category,
+            getCategoryLink: (category) => {
+                return this.urlFormatter.addSlashToAddress(categoryLink + category.toLowerCase().replace(/ /g, '-') + '/1/');
+            },
+            getTagLink: (tag) => {
+                return this.urlFormatter.addSlashToAddress(tagLink + tag.toLowerCase().replace(/ /g, '-') + '/1/');
+            }
+        };
+    }
+
+    /**
+     * 
+     * @returns {TaxonomyList}
+     */
+    getTaxonomy() {
+        /** @type {MarkdownInstance[]} */
+        const allPages = this.posts.all().filter(PostFiltering.isListable);
+
+        /** @type {{ [key: string]: number }} */
+        const tags = {};
+
+        /** @type {{ [key: string]: number }} */
+        const cats = {};
+
+        // Get taxonomy and counts
+        allPages.forEach((p) => {
+            p.frontmatter.tags && (p.frontmatter.tags).forEach(t => {
+                tags[t] = (tags[t] ?? 0) + 1;
+            });
+
+            p.frontmatter.categories && (p.frontmatter.categories).forEach(c => {
+                cats[c] = (cats[c] ?? 0) + 1;
+            });
+        });
+
+        // Map into the taxonomy
+        const taxonomy = {
+            tags: Object.keys(tags).sort().map(x => {
+                return {
+                    title: x,
+                    count: tags[x]
+                };
+            }),
+            topTags: [],
+            categories: Object.keys(cats).sort().map(x => {
+                return {
+                    title: x,
+                    count: cats[x]
+                };
+            })
+        };
+
+        // Get a list of "top tags" by usage count
+        const length = Math.min(taxonomy.categories.length, taxonomy.tags.length);
+        taxonomy.topTags = taxonomy.tags
+            .sort(this.sortByVolume)
+            .slice(0, length);
+
+        taxonomy.categories = taxonomy.categories.sort(this.sortByTitle);
+        taxonomy.tags = taxonomy.tags.sort(this.sortByTitle);
+        taxonomy.topTags = taxonomy.topTags.sort(this.sortByTitle);
+
+        return taxonomy;
+    }
+
+    /**
+     * Sorts taxonomy entries by title
+     * @param {TaxonomyEntry} a 
+     * @param {TaxonomyEntry} b 
+     * @returns 
+     */
+    sortByTitle(a, b) {
+        if (a.title < b.title) {
+            return -1;
+        }
+
+        if (a.title > b.title) {
+            return 1;
+        }
+
+        return 0;
+    }
+
+    /**
+     * Sorts taxonomy entries by title
+     * @param {TaxonomyEntry} a 
+     * @param {TaxonomyEntry} b 
+     * @returns 
+     */
+     sortByVolume(a, b) {
+        return b.count - a.count;
+    }
+}

package/package.json

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

package/types/Taxonomy.d.ts

@@ -2,7 +2,7 @@ export interface TaxonomyEntry {
     title: string;
     count: number;
 }
-export interface Taxonomy {
+export interface TaxonomyList {
     tags: TaxonomyEntry[];
     topTags: TaxonomyEntry[];
     categories: TaxonomyEntry[];

package/lib/postPaging.d.mts

@@ -1,13 +0,0 @@
-/**
- * @typedef { import("../types/Link").Link } Link
- */
-/**
- * Provides a list of paging links, 1 ... 3 4 5 ... 7
- * @param {number} limit
- * @param {number} numberOfPages
- * @param {number} currentPage
- * @param {string} url
- * @returns {Link[]}
- */
-export function getPageLinks(limit: number, numberOfPages: number, currentPage: number, url: string): Link[];
-export type Link = import("../types/Link").Link;

package/lib/postPaging.mjs

@@ -1,77 +0,0 @@
-/**
- * @typedef { import("../types/Link").Link } Link
- */
-
-/**
- * Provides a list of paging links, 1 ... 3 4 5 ... 7
- * @param {number} limit 
- * @param {number} numberOfPages 
- * @param {number} currentPage 
- * @param {string} url 
- * @returns {Link[]}
- */
-export function getPageLinks(limit, numberOfPages, currentPage, url) {
-    /** @type {Link[]} */
-    const pageLinks = [];
-  
-    let start = 0;
-    let end = numberOfPages;
-  
-    if (numberOfPages > limit) {
-      start = (currentPage - (limit - 1) / 2) - 1;
-      if (start < 0) {
-        start = 0;
-      }
-  
-      end = (start + limit);
-      if (end > numberOfPages) {
-        end = numberOfPages;
-        start = numberOfPages - limit;
-      }
-    }
-  
-    if (start == 1) {
-      pageLinks.push({
-        title: '1',
-        url: url.replace('/' + currentPage, '/' + 1),
-        ariaCurrent: false,
-        class: ''
-      });
-    } else if (start > 1) {
-      pageLinks.push({
-        title: '1',
-        url: url.replace('/' + currentPage, '/' + 1),
-        ariaCurrent: false,
-        class: 'paging-collapse-after'
-      });
-    }
-  
-    for (let i = start; i < end; i++) {
-      const userPage = i + 1;
-      pageLinks.push({
-        title: userPage.toString(),
-        url: url.replace('/' + currentPage, '/' + userPage),
-        ariaCurrent: userPage == currentPage ? 'page' : false,
-        class: ''
-      });
-    }
-  
-    if (end < (numberOfPages - 1)) {
-      pageLinks.push({
-        title: numberOfPages.toString(),
-        url: url.replace('/' + currentPage, '/' + numberOfPages),
-        ariaCurrent: false,
-        class: 'paging-collapse-before'
-      });
-    } else if (end < numberOfPages) {
-      pageLinks.push({
-        title: numberOfPages.toString(),
-        url: url.replace('/' + currentPage, '/' + numberOfPages),
-        ariaCurrent: false,
-        class: ''
-      });
-    }
-  
-    return pageLinks;
-}
-  

package/lib/taxonomy.d.mts

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

package/lib/taxonomy.mjs

@@ -1,129 +0,0 @@
-import { Cache } from './v1/cache.mjs';
-import { Posts } from './v1/posts.mjs';
-import { UrlFormatter } from './v1/urls.mjs';
-import * as PostFiltering from './postFiltering.mjs';
-
-/**
- * @typedef { import("../types/Site").Site } Site
- * @typedef { import("../types/Taxonomy").Taxonomy } Taxonomy
- * @typedef { import("../types/Taxonomy").TaxonomyEntry } TaxonomyEntry
- * @typedef { import("../types/Taxonomy").TaxonomyLinks } TaxonomyLinks
- * @typedef { import("../types/Astro").MarkdownInstance } MarkdownInstance
- */
-
-const cache = new Cache(200);
-const posts = new Posts(cache);
-
-/**
- * 
- * @param {TaxonomyEntry} a 
- * @param {TaxonomyEntry} b 
- * @returns 
- */
-export function sortByTitle (a, b) {
-    if ( a.title < b.title ){
-      return -1;
-    }
-  
-    if ( a.title > b.title ){
-      return 1;
-    }
-    
-    return 0;
-}
-
-/**
- * 
- * @param {any} translations 
- * @param {(entry: any) => string} lang 
- * @param {Site} site 
- * @returns {TaxonomyLinks}
- */
-export function taxonomyLinks(translations, lang, site) {
-    const urlFormatter = new UrlFormatter(site.url);
-    const category = lang(translations.articles.category) ?? 'category';
-    const categoryLink = `${site.subfolder}/${category}/`;
-
-    const tag = lang(translations.articles.tag) ?? 'category';
-    const tagLink = `${site.subfolder}/${tag}/`;
-
-    return {
-        tag: tag,
-        category: category,
-        getCategoryLink: (category) => {
-            return urlFormatter.addSlashToAddress(categoryLink + category.toLowerCase().replace(/ /g, '-') + '/1/');
-        },
-        getTagLink: (tag) => {
-            return urlFormatter.addSlashToAddress(tagLink + tag.toLowerCase().replace(/ /g, '-') + '/1/');
-        }
-    };
-}
-
-/**
- * 
- * @returns {Promise<Taxonomy>}
- */
-export async function getTaxonomy () {
-    const cacheKey = 'Global__taxonomy';
-
-    /** @type {Taxonomy} */
-    let taxonomy = cache.getItem(cacheKey);
-
-    if (taxonomy == null) {
-        /** @type {MarkdownInstance[]} */
-        const allPages = posts.all().filter(PostFiltering.isListable);
-        
-        /** @type {{ [key: string]: number }} */
-        const tags = {};
-
-        /** @type {{ [key: string]: number }} */
-        const cats = {};
-
-        // Get taxonomy and counts
-        allPages.forEach((p) => {
-            p.frontmatter.tags && (p.frontmatter.tags).forEach(t => {
-                tags[t] = (tags[t] ?? 0) + 1;
-            });
-
-            p.frontmatter.categories && (p.frontmatter.categories).forEach(c => {
-                cats[c] = (cats[c] ?? 0) + 1;
-            });
-        });
-
-        // Map into the taxonomy
-        taxonomy = {
-            tags: Object.keys(tags).sort().map(x => {
-                return {
-                    title: x,
-                    count: tags[x]
-                };
-            }),
-            topTags: [],
-            categories: Object.keys(cats).sort().map(x => {
-                return {
-                    title: x,
-                    count: cats[x]
-                };
-            })
-        };
-
-        // Get a list of "top tags" by usage count
-        const length = Math.min(taxonomy.categories.length, taxonomy.tags.length);
-        taxonomy.topTags = taxonomy.tags
-            .sort((a, b) => b.count - a.count)
-            .slice(0, length)
-            .sort((a, b) => {
-                if ( a.title < b.title ){
-                    return -1;
-                }
-                if ( a.title > b.title ){
-                    return 1;
-                }
-                return 0;
-             });
-
-        cache.setItem(cacheKey, taxonomy);
-    }
-
-    return taxonomy;
-}

package/types/Link.d.ts

@@ -1,6 +0,0 @@
-export interface Link {
-    title: string;
-    url: string;
-    ariaCurrent: 'page' | false;
-    class: string;
-}