astro-accelerator-utils 0.3.7 → 0.3.8

package/lib/v1/taxonomy.d.mts

@@ -1,62 +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;
+/**
+ * @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

@@ -1,145 +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;
-    }
+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/lib/v1/urls.d.mts

@@ -1,40 +1,40 @@
-export class UrlFormatter {
-    /**
-     * Constructor
-     * @param {string} siteUrl
-     * @param {string} subfolder
-     * @param {boolean} useTrailingUrlSlash
-     */
-    constructor(siteUrl: string, subfolder: string, useTrailingUrlSlash: boolean);
-    siteUrl: string;
-    subfolder: string;
-    useTrailingUrlSlash: boolean;
-    /** Uses config to decide whether to add or remove trailing slashes
-     * @param {URL} url
-     * @returns {URL}
-     */
-    formatUrl(url: URL): URL;
-    /**
-     * Ensures trailing slash is used
-     * @param {string | undefined} address
-     * @returns {string}
-     */
-    formatAddress(address: string | undefined): string;
-    /**
-     * Ensures trailing slash is used
-     * @param {URL} url
-     * @returns {URL}
-     */
-    addSlashToUrl(url: URL): URL;
-    /**
-     * Ensures trailing slash is used
-     * @param {string | undefined} address
-     * @returns {string}
-     */
-    addSlashToAddress(address: string | undefined): string;
-    /**
-     * Gets the author id from an address
-     * @param {URL} url
-     */
-    getAuthorId(url: URL): string;
-}
+export class UrlFormatter {
+    /**
+     * Constructor
+     * @param {string} siteUrl
+     * @param {string} subfolder
+     * @param {boolean} useTrailingUrlSlash
+     */
+    constructor(siteUrl: string, subfolder: string, useTrailingUrlSlash: boolean);
+    siteUrl: string;
+    subfolder: string;
+    useTrailingUrlSlash: boolean;
+    /** Uses config to decide whether to add or remove trailing slashes
+     * @param {URL} url
+     * @returns {URL}
+     */
+    formatUrl(url: URL): URL;
+    /**
+     * Ensures trailing slash is used
+     * @param {string | undefined} address
+     * @returns {string}
+     */
+    formatAddress(address: string | undefined): string;
+    /**
+     * Ensures trailing slash is used
+     * @param {URL} url
+     * @returns {URL}
+     */
+    addSlashToUrl(url: URL): URL;
+    /**
+     * Ensures trailing slash is used
+     * @param {string | undefined} address
+     * @returns {string}
+     */
+    addSlashToAddress(address: string | undefined): string;
+    /**
+     * Gets the author id from an address
+     * @param {URL} url
+     */
+    getAuthorId(url: URL): string;
+}