astro-accelerator-utils 0.1.4 → 0.1.6

package/index.d.mts

@@ -2,7 +2,7 @@ import { DateFormatter } from "./lib/v1/dates.mjs";
 import { Markdown } from "./lib/v1/markdown.mjs";
 import { Posts } from "./lib/v1/posts.mjs";
 import { UrlFormatter } from "./lib/v1/urls.mjs";
-import * as Cache from "./lib/cache.mjs";
+import { Cache } from "./lib/v1/cache.mjs";
 import * as PostQueries from "./lib/postQueries.mjs";
 import * as PostFiltering from "./lib/postFiltering.mjs";
 import * as PostOrdering from "./lib/postOrdering.mjs";

package/index.mjs

@@ -1,9 +1,9 @@
+import { Cache } from './lib/v1/cache.mjs';
 import { DateFormatter } from './lib/v1/dates.mjs';
 import { Markdown } from './lib/v1/markdown.mjs';
 import { Posts } from './lib/v1/posts.mjs';
 import { UrlFormatter } from './lib/v1/urls.mjs';
 
-import * as Cache from './lib/cache.mjs';
 import * as PostQueries from './lib/postQueries.mjs';
 import * as PostFiltering from './lib/postFiltering.mjs';
 import * as PostOrdering from './lib/postOrdering.mjs';

package/lib/navigation.d.mts

@@ -1,7 +1,3 @@
-/**
- * @typedef { import("../types/Site").Site } Site
- * @typedef { import("../types/NavPage").NavPage } NavPage
- */
 /**
  *
  * @param {URL} currentUrl

package/lib/navigation.mjs

@@ -1,12 +1,15 @@
+import { Posts } from './v1/posts.mjs';
+import { Cache } from './v1/cache.mjs';
 import * as PostQueries from './postQueries.mjs';
 import * as PostFiltering from './postFiltering.mjs';
-import * as Cache from './cache.mjs';
 
 /**
  * @typedef { import("../types/Site").Site } Site
  * @typedef { import("../types/NavPage").NavPage } NavPage
  */
 
+const cache = new Cache(200);
+
 /**
  * 
  * @param {URL} currentUrl 
@@ -18,7 +21,7 @@ export async function getMenu (currentUrl, site, menu) {
     const key = 'Navigation__getMenu';
 
     /** @type {NavPage[]} */
-    let pages = await Cache.getItem(key);
+    let pages = cache.getItem(key);
 
     if (pages == null) {
         pages = [];
@@ -35,7 +38,7 @@ export async function getMenu (currentUrl, site, menu) {
         }
 
         // Cache the result
-        await Cache.setItem(key, pages);
+        cache.setItem(key, pages);
     }
 
     PostQueries.setCurrentPage(pages, currentUrl);
@@ -66,13 +69,14 @@ export function isNavPage (item) {
 export async function getNavigation (currentUrl, site) {
 
     const key = 'Navigation__getNavigation';
+    const posts = new Posts();
 
     /** @type {NavPage[]} */
-    let pageHierarchy = await Cache.getItem(key);
+    let pageHierarchy = cache.getItem(key);
 
     if (pageHierarchy == null) {
-        const topLevelPages = await PostQueries.getTopLevelPages(site, PostFiltering.showInMenu);
-        const allPages = await PostQueries.getPages(PostFiltering.showInMenu);
+        const topLevelPages = posts.root(site.subfolder).filter(PostFiltering.showInMenu);
+        const allPages = posts.all().filter(PostFiltering.showInMenu);
 
         pageHierarchy = topLevelPages
             .map(p => PostQueries.mapNavPage(p, site))
@@ -104,7 +108,7 @@ export async function getNavigation (currentUrl, site) {
         }
 
         // Cache the result
-        await Cache.setItem(key, pageHierarchy);
+        cache.setItem(key, pageHierarchy);
     }
 
     return pageHierarchy;

package/lib/postQueries.d.mts

@@ -5,14 +5,14 @@
 export function injectFetchAll(fetcher: () => MarkdownInstance[]): void;
 /**
  * Replaced by Posts.all()
- * Use Posts.all().filter(...) to filter results
+ * @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()
- * Use Posts.root().filter(...) to filter results
+ * @deprecated Use Posts.root().filter(...) to filter results
  * @param {Site} site
  * @param {PagePredicate} [filter]
  * @returns {Promise<MarkdownInstance[]>}

package/lib/postQueries.mjs

@@ -28,7 +28,7 @@ export function injectFetchAll (fetcher) {
 
 /**
  * Replaced by Posts.all()
- * Use Posts.all().filter(...) to filter results
+ * @deprecated Use Posts.all().filter(...) to filter results
  * @param {PagePredicate} [filter]
  * @returns {Promise<MarkdownInstance[]>}
  */
@@ -51,7 +51,7 @@ export async function getPages (filter) {
 
 /**
  * Replaced by Posts.root()
- * Use Posts.root().filter(...) to filter results
+ * @deprecated Use Posts.root().filter(...) to filter results
  * @param {Site} site
  * @param {PagePredicate} [filter] 
  * @returns {Promise<MarkdownInstance[]>}

package/lib/taxonomy.d.mts

@@ -1,10 +1,3 @@
-/**
- * @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
- */
 /**
  *
  * @param {TaxonomyEntry} a

package/lib/taxonomy.mjs

@@ -1,5 +1,5 @@
+import { Cache } from './v1/cache.mjs';
 import { UrlFormatter } from './v1/urls.mjs';
-import * as Cache from './cache.mjs';
 import * as PostQueries from './postQueries.mjs';
 import * as PostFiltering from './postFiltering.mjs';
 
@@ -11,6 +11,8 @@ import * as PostFiltering from './postFiltering.mjs';
  * @typedef { import("../types/Astro").MarkdownInstance } MarkdownInstance
  */
 
+const cache = new Cache(200);
+
 /**
  * 
  * @param {TaxonomyEntry} a 
@@ -64,7 +66,7 @@ export async function getTaxonomy () {
     const cacheKey = 'Global__taxonomy';
 
     /** @type {Taxonomy} */
-    let taxonomy = await Cache.getItem(cacheKey);
+    let taxonomy = cache.getItem(cacheKey);
 
     if (taxonomy == null) {
         /** @type {MarkdownInstance[]} */
@@ -119,7 +121,7 @@ export async function getTaxonomy () {
                 return 0;
              });
 
-        await Cache.setItem(cacheKey, taxonomy);
+        cache.setItem(cacheKey, taxonomy);
     }
 
     return taxonomy;

package/lib/v1/cache.d.mts

@@ -0,0 +1,43 @@
+export class Cache {
+    /**
+     * Constructor
+     * @param {number} maxAge
+     */
+    constructor(maxAge: number);
+    maxAge: number;
+    /**
+     * Gets an item from the cache, falls back to supplied function
+     * @param {string} key
+     * @param {() => any} func
+     */
+    get(key: string, func: () => any): any;
+    /**
+     * Gets an item from the cache
+     * @param {string} key
+     * @returns {Promise<any>}
+     */
+    getItem(key: string): Promise<any>;
+    /**
+     * Adds an item to the cache
+     * @param {string} key
+     * @param {any} value
+     * @returns {Promise<void>}
+     */
+    setItem(key: string, value: any): Promise<void>;
+    /**
+     * Clears the cache
+     * @returns {Promise<void>}
+     */
+    clear(): Promise<void>;
+    /**
+ * Get's the path of the cache files
+ * @returns {string}
+ */
+    getCachePath(): string;
+    /**
+     * Gets the file path for a cache item
+     * @param {string} key
+     * @returns {string}
+     */
+    getItemPath(key: string): string;
+}

package/lib/v1/cache.mjs

@@ -0,0 +1,100 @@
+import fs from 'fs';
+import path from 'path';
+import process from 'process';
+
+export class Cache {
+    /**
+     * Constructor
+     * @param {number} maxAge
+     */
+    constructor(maxAge) {
+        this.maxAge = maxAge;
+    }
+
+    /**
+     * Gets an item from the cache, falls back to supplied function
+     * @param {string} key 
+     * @param {() => any} func
+     */
+    get(key, func) {
+        const cached = this.getItem(key);
+
+        if (cached) {
+            return cached;
+        }
+
+        const fetched = func();
+
+        this.setItem(key, fetched);
+
+        return fetched;
+    }
+
+    /**
+     * Gets an item from the cache
+     * @param {string} key 
+     * @returns {Promise<any>}
+     */
+    getItem (key) {
+        const itemPath = this.getItemPath(key);
+        try {
+
+            const { mtime } = fs.statSync(itemPath);
+
+            var date_time = new Date();
+            let timeDifference = Math.abs((date_time.getTime() - mtime.getTime()) / 1000);
+            if (timeDifference < this.maxAge) {
+                console.log('Cache hit', key);
+                const content = fs.readFileSync(itemPath).toString();
+                return JSON.parse(content);
+            }
+        } catch{}
+
+        console.log('Cache miss', key);
+        return null;
+    }
+
+    /**
+     * Adds an item to the cache
+     * @param {string} key 
+     * @param {any} value
+     * @returns {Promise<void>} 
+     */
+    setItem (key, value) {
+        const itemPath = this.getItemPath(key);
+        fs.writeFileSync(itemPath, JSON.stringify(value));
+    }
+
+    /**
+     * Clears the cache
+     * @returns {Promise<void>}
+     */
+    clear() {
+        const folder = this.getCachePath();
+        const files = fs.readdirSync(folder);
+
+        for(const file of files) {
+            fs.unlinkSync(path.join(folder, file));
+        }
+    }
+
+        /**
+     * Get's the path of the cache files
+     * @returns {string}
+     */
+         getCachePath () {
+            const cachePath = path.join(process.cwd(), '.cache/');
+            fs.mkdirSync(cachePath, { recursive: true })
+            return cachePath;
+        }
+    
+        /**
+         * Gets the file path for a cache item
+         * @param {string} key 
+         * @returns {string}
+         */
+        getItemPath (key) {
+            const cachePath = this.getCachePath();
+            return path.join(cachePath, key + '.json');
+        }
+}

package/lib/v1/dates.d.mts

@@ -10,11 +10,10 @@ export class DateFormatter {
     dateOptions: Intl.DateTimeFormatOptions;
     /**
      * Returns the formatted pubDate
-     * @param {any} frontmatter
+     * @param {string | Date} date
      * @param {string} lang
-     * @param {Site} site
      * @returns {string}
      */
-    formatDate(date: any, lang: string): string;
+    formatDate(date: string | Date, lang: string): string;
 }
 export type Site = any;

package/lib/v1/dates.mjs

@@ -13,9 +13,8 @@ export class DateFormatter {
 
   /**
    * Returns the formatted pubDate
-   * @param {any} frontmatter 
+   * @param {string | Date} date
    * @param {string} lang 
-   * @param {Site} site 
    * @returns {string}
    */
   formatDate(date, lang) {

package/lib/v1/posts.d.mts

@@ -1,11 +1,27 @@
+/**
+ * @typedef { import("../../types/Astro").MarkdownInstance } MarkdownInstance
+ * @typedef { import("./cache.mjs").Cache } Cache
+ */
 export class Posts {
     /**
      * Constructor
-     * @param {() => MarkdownInstance[]} fetchAll
+     * @param {Cache} cache
+     * @param {() => MarkdownInstance[]} [fetchAll]
      */
-    constructor(fetchAll: () => MarkdownInstance[]);
+    constructor(cache: Cache, fetchAll?: () => MarkdownInstance[]);
+    cache: import("./cache.mjs").Cache;
     fetchAll: () => any;
     allPosts: any[];
-    all(): any[];
-    root(subfolder: any): any[];
+    /**
+     * Gets all markdown posts in the site
+     * @returns {MarkdownInstance[]}
+     */
+    all(): MarkdownInstance[];
+    /**
+     * Gets top-level markdown posts in the site
+     * @returns {MarkdownInstance[]}
+     */
+    root(subfolder: any): MarkdownInstance[];
 }
+export type MarkdownInstance = import("../../types/Astro").MarkdownInstance;
+export type Cache = import("./cache.mjs").Cache;

package/lib/v1/posts.mjs

@@ -1,23 +1,38 @@
+/**
+ * @typedef { import("../../types/Astro").MarkdownInstance } MarkdownInstance
+ * @typedef { import("./cache.mjs").Cache } Cache
+ */
+
 export class Posts {
     /**
      * Constructor
-     * @param {() => MarkdownInstance[]} fetchAll 
+     * @param {Cache} cache
+     * @param {() => MarkdownInstance[]} [fetchAll]
      */
-    constructor(fetchAll) {
+    constructor(cache, fetchAll) {
         /* istanbul ignore next */
+        this.cache = cache;
         this.fetchAll = fetchAll ?? function() { return import.meta.glob("/src/pages/**/*.md", { eager: true }); }
         this.allPosts = [];
     }
 
+    /**
+     * Gets all markdown posts in the site
+     * @returns {MarkdownInstance[]}
+     */
     all () {
-        if (this.allPosts.length === 0) {
-            const pageImportResult = this.fetchAll();
-            this.allPosts = Object.values(pageImportResult);
-        }
+        const key = 'cache-posts.all()';
 
-        return this.allPosts;
+        return this.cache.get(key, () => {
+            const pageImportResult = this.fetchAll();
+            return Object.values(pageImportResult);
+        });
     }
 
+    /**
+     * Gets top-level markdown posts in the site
+     * @returns {MarkdownInstance[]}
+     */
     root (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.4",
+  "version": "0.1.6",
   "description": "Astro utilities for Astro Accelerator.",
   "main": "index.mjs",
   "type": "module",

package/lib/cache.d.mts

@@ -1,30 +0,0 @@
-/**
- * Get's the path of the cache files
- * @returns {Promise<string>}
- */
-export function getCachePath(): Promise<string>;
-/**
- * Gets the file path for a cache item
- * @param {string} key
- * @returns {Promise<string>}
- */
-export function getItemPath(key: string): Promise<string>;
-/**
- * Gets an item from the cache
- * @param {string} key
- * @param {number} [maxAgeInSeconds]
- * @returns {Promise<any>}
- */
-export function getItem(key: string, maxAgeInSeconds?: number): Promise<any>;
-/**
- * Adds an item to the cache
- * @param {string} key
- * @param {any} value
- * @returns {Promise<void>}
- */
-export function setItem(key: string, value: any): Promise<void>;
-/**
- * Clears the cache
- * @returns {Promise<void>}
- */
-export function clear(): Promise<void>;

package/lib/cache.mjs

@@ -1,76 +0,0 @@
-import fs from 'fs';
-import path from 'path';
-import process from 'process';
-
-/**
- * Get's the path of the cache files
- * @returns {Promise<string>}
- */
-export async function getCachePath () {
-    const cachePath = path.join(process.cwd(), '.cache/');
-    await fs.promises.mkdir(cachePath, { recursive: true })
-    return cachePath;
-}
-
-/**
- * Gets the file path for a cache item
- * @param {string} key 
- * @returns {Promise<string>}
- */
-export async function getItemPath (key) {
-    const cachePath = await getCachePath();
-    return path.join(cachePath, key + '.json');
-}
-
-/**
- * Gets an item from the cache
- * @param {string} key 
- * @param {number} [maxAgeInSeconds]
- * @returns {Promise<any>}
- */
-export async function getItem (key, maxAgeInSeconds) {
-    if (maxAgeInSeconds == null) {
-        maxAgeInSeconds = 200;
-    }
-
-    const itemPath = await getItemPath(key);
-    try {
-
-        const { mtime } = await fs.promises.stat(itemPath);
-
-        var date_time = new Date();
-        let timeDifference = Math.abs((date_time.getTime() - mtime.getTime()) / 1000);
-        if (timeDifference < maxAgeInSeconds) {
-            console.log('Cache hit', key);
-            const content = fs.readFileSync(itemPath).toString();
-            return JSON.parse(content);
-        }
-    } catch{}
-
-    console.log('Cache miss', key);
-    return null;
-}
-
-/**
- * Adds an item to the cache
- * @param {string} key 
- * @param {any} value
- * @returns {Promise<void>} 
- */
-export async function setItem (key, value) {
-    const itemPath = await getItemPath(key);
-    await fs.promises.writeFile(itemPath, JSON.stringify(value));
-}
-
-/**
- * Clears the cache
- * @returns {Promise<void>}
- */
-export async function clear() {
-    const folder = await getCachePath();
-    const files = fs.readdirSync(folder);
-
-    for(const file of files) {
-        fs.unlinkSync(path.join(folder, file));
-    }
-}