astro-accelerator-utils 0.1.0 → 0.1.1

package/index.d.mts

@@ -1,5 +1,7 @@
 import { DateFormatter } from "./lib/v1/dates.mjs";
 import { UrlFormatter } from "./lib/v1/urls.mjs";
+import { Posts } from "./lib/v1/posts.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";
@@ -8,4 +10,4 @@ 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";
-export { DateFormatter, UrlFormatter, PostQueries, PostFiltering, PostOrdering, PostPaging, FooterMenu, Markdown, Navigation, Taxonomy };
+export { DateFormatter, UrlFormatter, Posts, Cache, PostQueries, PostFiltering, PostOrdering, PostPaging, FooterMenu, Markdown, Navigation, Taxonomy };

package/index.mjs

@@ -2,6 +2,7 @@ import { DateFormatter } from './lib/v1/dates.mjs';
 import { UrlFormatter } from './lib/v1/urls.mjs';
 import { Posts } from './lib/v1/posts.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';
@@ -14,6 +15,8 @@ import * as Taxonomy from './lib/taxonomy.mjs';
 export {
     DateFormatter,
     UrlFormatter,
+    Posts,
+    Cache,
     PostQueries,
     PostFiltering,
     PostOrdering,

package/lib/cache.d.mts

@@ -0,0 +1,30 @@
+/**
+ * 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

@@ -0,0 +1,76 @@
+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));
+    }
+}

package/lib/footerMenu.d.mts

@@ -12,9 +12,9 @@
  * @param {any} translations
  * @param {Site} site
  * @param {(NavPage | 'categories' | 'tags' | 'toptags')[]} menu
- * @returns {NavPage[]}
+ * @returns {Promise<NavPage[]>}
  */
-export function getMenu(currentUrl: URL, _: TranslationProvider, translations: any, site: any, menu: (NavPage | 'categories' | 'tags' | 'toptags')[]): NavPage[];
+export function getMenu(currentUrl: URL, _: TranslationProvider, translations: any, site: any, menu: (NavPage | 'categories' | 'tags' | 'toptags')[]): Promise<NavPage[]>;
 /**
  *
  * @param {TaxonomyLinks} links

package/lib/footerMenu.mjs

@@ -17,7 +17,7 @@ import * as PostQueries from './postQueries.mjs';
  * @param {any} translations 
  * @param {Site} site 
  * @param {(NavPage | 'categories' | 'tags' | 'toptags')[]} menu 
- * @returns {NavPage[]}
+ * @returns {Promise<NavPage[]>}
  */
 export async function getMenu (currentUrl,  _, translations, site, menu) {
     const links = Taxonomy.taxonomyLinks(translations, _, site);

package/lib/v1/urls.d.mts

@@ -13,8 +13,8 @@ export class UrlFormatter {
     addSlashToUrl(url: URL): URL;
     /**
      * Ensures trailing slash is used
-     * @param {string | null} address
+     * @param {string | undefined} address
      * @returns {string}
      */
-    addSlashToAddress(address: string | null): string;
+    addSlashToAddress(address: string | undefined): string;
 }

package/lib/v1/urls.mjs

@@ -19,7 +19,7 @@ export class UrlFormatter {
 
     /**
      * Ensures trailing slash is used
-     * @param {string | null} address 
+     * @param {string | undefined} address 
      * @returns {string}
      */
     addSlashToAddress(address) {

package/package.json

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